Page History
...
JS7_AGENT_HOME
- Points to the directory where the JS7 Agent has been installed.
- If this environment variable is not set then the default value will be used, which is the parent directory of the Agent Start Script.
- If the Agent is started from a directory other than the Agent installation directory, for example by copying the Start Script to some other location, then this environment variable has to be set in order to locate the JS7 Agent installation directory.
- There is no corresponding command line option.
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 start-up and shutdown that are executed by
root
, for example in/etc/init.d
and corresponding locations or withsystemd
. - There is no corresponding command line option.
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, for example with
JS7_AGENT_HTTP_PORT=myHost:4444
. - If only a port number is specified then the Agent will listen to all available network interfaces via HTTP.
- Without setting this environment variable the default port of
4445
will be used. - Corresponding command line option:
--http-port
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, for example with
JS7_AGENT_HTTPS_PORT=myHost:4443
. - If a port number only is specified then the Agent listens to all available network interfaces via HTTPS.
- When using the HTTPS protocol for connections from a Controller users should consider to allow the HTTP protocol for local connections as with
JS7_AGENT_HTTP_PORT=localhost:4445
. As the Agent Start Script makes use of an HTTP connection, this protocol has to be in place to allow the Agent instance to be started, stopped etc. by its Start Script. - Without setting this environment variable the HTTPS protocol is not used.
- Corresponding command line option:
--https-port
JS7_AGENT_DATA
- Points to the location where the Agent finds its configuration data, log data and journals.
- Without setting this environment variable the default value is
JS7_AGENT_HOME/var_<JS7_AGENT_HTTP_PORT>
. - Corresponding command line option:
--data-directory
JS7_AGENT_CONFIG_DIR
- Points to the directory where the Agent finds its configuration data.
- Without setting this environment variable the default value is
JS7_AGENT_DATA/config
. - Corresponding command line option:
--config-directory
JS7_AGENT_LOG_DIR
- Specifies the directory where the Agent log files are created.
- This setting defaults to the sub-directory
logs
in theJS7_AGENT_DATA
directory. - There is no corresponding command line option.
JS7_AGENT_PID_FILE_DIR
- Specifies 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. - There is no corresponding command line option.
JS7_AGENT_PID_FILE_NAME
- Sets the file name to which the JS7 Agent stores its PID.
- The default value is
agent.pid
. - There is no corresponding command line option.
Display feature availability StartingFromRelease 2.5.1
JS7_AGENT_WORK_DIR
- Specifies the working directory for the jobs started by the Agent, e.g.
${HOME}
or%USERPROFILE%
. - This setting defaults to
JS7_AGENT_DATA
. - There is no corresponding command line option.
- Specifies the working directory for the jobs started by the Agent, e.g.
JS7_AGENT_KILL_SCRIPT
- Specifies the location of a kill script if an individual script is required.
The kill script allows the task and any child processes of a job to be killed.
- Kill scripts are by default provided at the following locations:
JS7_AGENT_DATA/tmp/kill_task.sh
for Unix.JS7_AGENT_DATA\tmp\kill_task.cmd
for Windows.
- Corresponding command line option:
--kill-script
JAVA_HOME
- Points to the location of the JVM, either a JRE (Java Runtime Environment) or JDK (Java Development Kit).
- When this environment variable is not set, Java will be used from the location specified by the system path.
- The
JAVA_HOME
environment variable does not necessarily point to the location of a JDK but to a JRE directory where thebin/java
executable resides. For example, if the location of the Java executable is/opt/java/jdk8u202-b08/jre/bin/java
thenJAVA_HOME=/opt/java/jdk8u202-b08/jre
. - There is no corresponding command line option.
JAVA_OPTIONS
- Sets Java options, e.g. the Java memory settings for the Agent.
- When this environment variable is not set, the Java options will default to
-Xms100m
. - Corresponding command line option:
--java-options
JS7_AGENT_JOB_JAVA_OPTIONS
- Sets Java options for shell jobs that start a JVM.
- Corresponding command line option:
--job-java-options
...
Overview
Content Tools