Page History

...

Usage: jobscheduler_agent.sh command [options]
  command:
    start           [options]
    start_docker    [options]
    stop            [options]
    abort           [options]
    restart         [options]
    status          [options]
    start           [options]
 options:
    -http-port=<number> | default: 4445
    -timeout=<number> | in seconds; only for stop and restart

Usage: jobscheduler_agent.cmd command [options]
 | commanddefault: 4445
    start-timeout=<number>           [options]
    stop      | in seconds; only for  [options]stop and restart
    abort   -ip-address=<hostname or ip address>  | to listen to a specific [options]
host name or ip address

Usage: jobscheduler_agent.cmd command [options]
  command:
    start  restart         [options]
    status          [options]
    debugstop            [options]
    killabort            [options]
    install-servicerestart         [options]
    status  remove-service        [options]
    debug    start-service       [options]
 options:
    -http-port=<number> | default: 4445
kill      -timeout=<number> | in seconds; only for stop and restart

Command Line Options

 [options]
    install-service [options]
    remove-service  [options]
    start-service   [options]
 options:
    -http-port=<number>                   | default: 4445
    -timeout=<number>                     | in seconds; only for stop and restart
    -ip-address=<hostname or ip address>  | to listen to a specific host name or ip address

Command Line Options

• -http-port=<number>
  •  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 SCHEDULER_HTTP_PORT (see below)
    • Third precedence: use of default value
• -timeout=<number>
  • This option can be used to specify the number of seconds that the Agent will wait for tasks to stop. 
  • This option can be applied for stop and restart commands.
  • The Agent sends a SIGTERM signal to the taksk and having reached the timeout a SIGKILL signal will be sent to stop any tasks immediately.
• -ip-address=<hostname or ip address>

  • This option can be used for indicating which network interfaces the JobScheduler Agent should listen to

  -http-port=<number>
  •  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 an ip address then the following precedence applies:
    • First precedence: command line option
    • Second precedence: environment variable SCHEDULER_HTTPIP_PORT ADDRESS (see below)
    • Third precedence: use of default value
  -timeout=<number>
  • This option can be used to specify the number of seconds that the Agent will wait for tasks to stop. If this command line option and the environment variable SCHEDULER_IP_ADDRESS are undefined then the JobScheduler Agent listens to all available network interfaces.
  • This option can be applied for stop and restart start, debug and install-service commands.
  • The Agent sends a SIGTERM signal to the taksk and having reached the timeout a SIGKILL signal will be sent to stop any tasks immediately.

Start the Agent

jobscheduler_agent.cmd|sh start [options]

...

jobscheduler_agent.cmd install-service [-http-port=<number>] [-ip-address=<hostname or ip address>]

This command installs the Windows Serviceservice. After the installation you find the Windows Service with the name SOS JobScheduler Agent -port=<number> in the Services Manager Console. The Windows service uses the "local system" account.

...

This command starts the Windows Service service with the name SOS JobScheduler Agent -port=<number>.

...

This command uninstalls the Windows Serviceservice. After executing this command you will not find the Windows Service service with the name SOS JobScheduler Agent -port=<number> in the Services Manager Console any longer.

Configure the Windows Service

After the installation of the Windows service you find the .\service\sos_jobscheduler_agent_<http-port>w.exe. Start this application to configure the Windows service.

Logging

• Log File
  • On startup the Agent creates a log file in the directory that is pointed to by the environment variable SCHEDULER_LOG_DIR or in the logs subdirectory of the Agent installation directory.
  • Log file names are created from a prefix and the port used by the Agent like this:
    • jobscheduler_agent_4445.log
  • Log files are rotated for each day and are kept for one week (see ./lib/log4j.xml).
  • Rotated log files get the name of the form jobscheduler_agent_4445.log.<yyyy-MM-dd>
• PID File
  • On startup the Agent creates a PID file in the directory that is pointed to by the environment variable SCHEDULER_PID_FILE_DIR or in the log directory. The PID file contains the Process ID of the system process that the Agent is running in.
  • The PID file is used in order to prevent the Agent to be started twice with the same settings and it can be used for shutdown scripts that require the PID to terminate the process.
  • PID file names are created from a prefix and from the port used by the Agent like this:
    • jobscheduler_agent_4445.pid

...

• 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 port that the JobScheduler Agent is listening to.
  • Without setting this environment variable the port defaults to 4445.
• SCHEDULER_IP_ADDRESS

  • indicates which network interfaces the JobScheduler Agent should listen to.

  • The JobScheduler Agent listens to all available network interfaces if this environment variable and the command line option -ip-address are undefined.
• 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.
• SCHEDULER_LOG_DIR
  • sets the directory where the JobScheduler Agent log file is created.
  • This setting defaults to the directory logs in the Agent installation directory.
  • For Windows systems for which the Agent is installed in the program directory that is pointed to by the %ProgramFiles% environment variable it is recommended not to use the default setting. Instead specify a different path via the SCHEDULER_LOG_DIR environment variable, e.g. some location in the data directory that is pointed to by the %ProgramData% environment variable.
• SCHEDULER_PID_FILE_DIR
  • sets the directory where the JobScheduler Agent pid file is created.
  • This setting defaults to the directory that is specified with the SCHEDULER_LOG_DIR environment variable or the log directory default value.

...