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.
      • The pid file is created in this directory.

Running the JobScheduler Agent

• SOS does not recommend to run the JobScheduler Agent as root (for Unix) or as Administrator (for Windows).
• Instead the user account should be used that jobs are executed for. Should jobs be executed for a number of user accounts then consider the chapter Running multiple instances of 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!

Command Line 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

Environment Variables

The following environment variables can be used:

• JAVA_HOME
  • points to the location of the Java Runtime Environment (JRE).
  • Without setting this environment variable Java will be used from the location specified by the system path.
  • Please consider that JAVA_HOME does not point to the location of a JDK but to a JRE directory where the bin/java executable resides.
• 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.
• 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_USER
  • sets the user account that the JobScheduler Agent is operated for. This includes running jobs with the permissions of the specified user.
  • This setting is available for Unix systems only. For Windows systems the user account that runs the start script is used.
  • Without setting this environment variable the user acount that runs the start script is used.
  • This setting can be used when running the Agent start script in system start-up and shutdown configurations that are executed by root, e.g. in /etc/init.d or corresponding locations.

Usage Examples

Running the JobScheduler Agent on Mac OS X  

For Mac® OS X the location of the Java Runtime Environment can be specified like this:

JAVA_HOME=/Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home
export JAVA_HOME

/Users/ap/Documents/agent/bin/jobscheduler_agent.sh $@

Running multiple instances of JobScheduler Agent

• Multiple instances of the JobScheduler Agent can be operated, e.g. for different accounts that jobs should be executed for.
• Any number of Agent instances can be started from the same installation, however, different ports have to be used that the Agent is listening to for requests of a JobScheduler Master.
• Use the option -http-port=#### to start the Agent for an additional port:
  • Example: 

    jobscheduler_agent.cmd|sh start -http-port=4446