Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Installing the JobScheduler Agent

  • Prerequisites
    • A Java Runtime Environment starting from version 1.8 is required.
    • Choose the JobScheduler Agent for your platform from the Downloads section.
  • Installation
    • Unzip the downloaded file to an arbitrary directory.
    • Directory Structure
      • bin
        • jobscheduler_agent.cmd
          • The start script for Windows platforms.
        • jobscheduler_agent.sh
          • The start script for Unix platforms.
      • lib
        • The directory for Java libraries.
        • Consider the settings in logback.xml should you want to adjust the log output format. 
      • logs
        • An empty directory that is used to store log files of the JobScheduler Agent.

Running the JobScheduler Agent

Usage

Running the start script without parameters shows the usage clause:

Usage: jobscheduler_agent.cmd|sh command [options]
  command:
    start [options]
    stop [options]
    restart [options]
    status [options]
  options:
    -http-port=<number> | default: 4445

Start the Agent

jobscheduler_agent.cmd|sh start [options]

Stop the Agent

jobscheduler_agent.cmd|sh stop [options]

Restart the Agent

jobscheduler_agent.cmd|sh restart [options]

Query the Agent Status

jobscheduler_agent.cmd|sh status [options]

Should the Agent be up and running then this command will result in some output such as:

...JobScheduler Agent(4445) is running with pid=12112!

Should the Agent not be running then some output is provided such as:

...JobScheduler Agent(4445) is down!

Using Options

  • The only available option is the http port that the Agent is listening to in order to receive requests from a JobScheduler Master:
    • jobscheduler_agent.cmd|sh command -http-port=####
    • where #### is the numeric port.
  • Without this option being used the port defaults to 4445.
  • Should you want to specify a port then the following precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable
    • Third precedence: use of default value

Using Environment Variables

The following environment variables can be used:

  • SCHEDULER_HTTP_PORT
    • sets the numeric port that the JobScheduler Agent is listening to.
    • Without setting this environment variable the port defaults to 4445.
  • SCHEDULER_HOME
    • points to the directory where the JobScheduler Agent has been installed.
    • Without setting this environment variable the default value is the parent directory of the start script.
    • Should you want to start the Agent from a directory different to the Agent installation directory, e.g. by copying the start script to some other location, then this environment variable has to be set in order to locate the JobScheduler Agent installation directory.

 

  • No labels