Page History
...
Start Script: agent.sh, agent.cmd
Usage
Running the Agent start script Start Script without parameters displays the usage clause:
...
--http-port=<[hostname or ip address:]number>
- is specifies the HTTP port that the Agent is listening to in order to receive requests from a JS7 Controller:
agent.cmd|sh --http-port=####
- where
####
is the numeric port. - This option can be used to indicate which network interfaces interface the JS7 Agent should listen to if in addition you specify a hostname or IP address for example with
--http-port=myhost:4445
.
- Without this option being used the port defaults to 4445 and the Agent listens to all available network interfaces.
- Should you want to specify a port then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_HTTP_PORT
(see below) - Third precedence: use of default value
- is specifies the HTTP port that the Agent is listening to in order to receive requests from a JS7 Controller:
--https-port=<[hostname or ip address:]number>
- is specifies the HTTPS port that the Agent is listening to in order to receive requests from a Controller:
agent.cmd|sh command --https-port=####
- where
####
is the numeric port. - This option can be also used to indicate which network interfaces the Agent should listen to if in addition you specify a hostname or IP address for example with
--https-port=myhost:4445
.
- Without this option being used the port defaults to 4445 and the Agent listens to all available network interfaces.
- Should you want to specify a port then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
SJS7_AGENT_HTTPS_PORT
(see below) - Third precedence: use of default value
- is specifies the HTTPS port that the Agent is listening to in order to receive requests from a Controller:
--data-directory=<location of data directory>
- Location specifies the location of the data directory that usually includes the
config
,logs, tmp
andstate
directories. - It This location has to be unique for any Agent instances
- Should you want to specify a data directory then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_DATA
(see below) - Third precedence: use of default value (=
JS7_AGENT_HOME/var_<JS7_AGENT_PORT>
)
- Location specifies the location of the data directory that usually includes the
--config-directory=<location of config directory>
- Location specifies the location of the config directory.
- It This location has to be unique for any Agent instances
- Should you want to specify a config directory then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_CONFIG_DIR
(see below) - Third precedence: use of default value (=
JS7_AGENT_HOME/var_<JS7_AGENT_PORT>
)
--sigkill
With the
stop
andrestart
commands this option kills any running processes of a job by use of a SIGKILL signal.
--kill-script=<location of kill script>
The kill script provides the functionality to kill a task tasks and any child processes of jobs.
- Kill scripts are by default provided from the following locations:
JS7_AGENT_DATA/tmp/kill_task.sh
for Unix.JS7_AGENT_DATA\tmp\kill_task.cmd
for Windows.
This option can be used to specify the location of an individual "kill script" if required.
Should you want to specify an individual "kill script" then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_KILL_SCRIPT
(see below) - Third precedence: use of default value
--java-options=<java options>
With Java 1.8 the initial memory allocation has changed, for details see How to manage the Java heap space.
This option can be used to apply Java options for the Agent, e.g. the for memory settings.
Without this option being used the Java options default to '-Xms100m'.
Should you want to specify the Java options then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JAVA_OPTIONS
(see below) - Third precedence: use of default value
--job-java-options=<java options>
Without this option being used the Java options for each job which is started by the Agent.
Should you want to specify the Java options for execution of JITL jobs and JVM jobs then the following precedence applies:
- First precedence: command line option
- Second precedence: environment variable
JS7_AGENT_JOB_JAVA_OPTIONS
(see below)
...
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 thebin/java
executable resides.
JAVA_OPTIONS
- sets Java options, e.g. the Java memory settings for the Agent.
- Without setting this environment variable the Java options default to
'-Xms100m'
.
JS7_AGENT_JOB_JAVA_OPTIONS
- sets Java options for each job that is started by the Agent.
JS7_AGENT_HOME
- points to the directory where the JS7 Agent has been installed.
- Without setting this environment variable the default value is the parent directory of the Agent Start Script.
- Should you want to start the Agent from a directory different to from the Agent installation directory, e.g. by copying the start script Start Script to some other location, then this environment variable has to be set in order to locate the JobScheduler JS7 Agent installation directory.
JS7_AGENT_DATA
- points to the location where the Agent finds its data directory.
- Without setting this environment variable the default value is
JS7_AGENT_HOME/var_<JS7_AGENT_HTTP_PORT>
.
JS7_AGENT_CONFIG_DIR
- points to the directory where the Agent finds its configuration.
- Without setting this environment variable the default value is
JS7_AGENT_DATA/config
.
JS7_AGENT_HTTP_PORT
- sets the HTTP port that the Agent is listening to.
- indicates which network interfaces the Agent should listen to if a hostname or IP address is specified.
- if only a port number is specified then the Agent listens to all available network interfaces via HTTP.
- Without setting this environment variable the port defaults to
4445
.
JS7_AGENT_HTTPS_PORT
- sets the HTTPS port that the Agent is listening to.
- indicates which network interfaces the Agent should listen to if a hostname or IP address is specified.
- if only a port number is specified then the Agent listens to all available network interfaces via HTTPS.
- Without setting this environment variable the HTTPS protocol is not used.
JS7_AGENT_USER
- sets the user account that the Agent is operated for. This includes running jobs with the permissions of the specified user account.
- This setting is available for Unix systems only. For Windows systems, the user account that runs the Windows Service is used.
- Without setting this environment variable the user account that runs the Start Script is used.
- This setting can be used when running the Agent Start Script on system startup and shutdown configurations that are executed by
root
, e.g. in/etc/init.d
and corresponding locations or withsystemd
.
JS7_AGENT_LOG_DIR
- sets the directory where the Agent log file is created.
- This setting defaults to the sub-directory
logs
in theJS7_AGENT_DATA
directory.
JS7_AGENT_WORK_DIR
- sets the working directory for the jobs started by the Agent, e.g.
${HOME}
or%USERPROFILE%
. - This setting defaults to
JS7_AGENT_HOME
.
- sets the working directory for the jobs started by the Agent, e.g.
JS7_AGENT_KILL_SCRIPT
- sets the location of a "kill script" if an individual script is required.
The kill script provides the functionality to kill a task and any child processes of a job.
- Kill scripts are by default provided from the following locations:
JS7_AGENT_DATA/tmp/kill_task.sh
for Unix.JS7_AGENT_DATA\tmp\kill_task.cmd
for Windows.
JS7_AGENT_PID_FILE_DIR
- sets the directory where the Agent PID file is created.
- This setting defaults to the directory that is specified with the
JS7_AGENT_LOG_DIR
environment variable or the log directory default value.
...
This command starts the Windows Service with the name SOS JS7 Agent -port=<number>.
Info |
---|
The |
...
This command removes the Windows Service. After executing this command you will should not find the Windows Service with the name SOS JS7 Agent -port=<number>
in the Services Manager Console any longer.
...
For example go to the "Startup" tab |