Page History
...
--deploy-dir
- Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the
<config>
folder. A deployment directory allows to manage central copies of configuration files such asagent.conf
,private.conf
,log4j2.xml
etc. - Use of a deployment directory has lower precedence as files can be overwritten by individual options such as
--agent.-conf
,--private-conf
etc.
- Specifies the path to a deployment directory that holds configuration files and sub-directories that will be copied to the
--agent-conf
- Specifies the path to a configuration file for global JS7 - Agent Configuration Items. The file will be copied to the
<config>/agent.conf
file. - Any path to a file name can be used as a value of this option, however, the target file name
agent.conf
will be used.
- Specifies the path to a configuration file for global JS7 - Agent Configuration Items. The file will be copied to the
--private-conf
- Specifies the path to a configuration file for private JS7 - Agent Configuration Items. The file will be copied to the
<config>/private/private.conf
file. - Any path to a file name can be used as a value of this option, however, the target file name
private.conf
will be used.
- Specifies the path to a configuration file for private JS7 - Agent Configuration Items. The file will be copied to the
--controller-id
- Specifies the Controller ID, a unique identifier of the Controller installation. Agents will be dedicated to the Controller with the given Controller ID.
- The Controller ID is used in the Agent's
private.conf
file to specify which Controller can access a given Agent.
--controller-primary-cert
- Specifies the path to the SSL/TLS certificate of the Primary Controller Instance. The Agent Installer Script extracts the distinguished name from the given certificate and adds it to the Agent's
private.conf
file to allow HTTPS connections from the given Controller using mutual authentication without the need for passwords.
- Specifies the path to the SSL/TLS certificate of the Primary Controller Instance. The Agent Installer Script extracts the distinguished name from the given certificate and adds it to the Agent's
--controller-secondary-cert
- Corresponds to the
--controller-primary-cert
setting option and is used for the Secondary Controller Instance.
- Corresponds to the
--http-port
- Specifies the HTTP port that the Agent is operated for. The default value is
4445
. The Agent by default makes use of a configuration directory./var_<http-port>
that will be excluded from a backup taken with the--backup-dir
option. In addition the HTTP port is used to identify the Agent Instance Start Script typically available from the./bin/agent_<http-port>.sh
. script and to specify the value of theJS7_AGENT_HTTP_PORT
environment variable in the script. - The port can be prefixed by the network interface, for example
localhost:4445
. - When used with the
--restart
switch the HTTP port is used to identify whether if the Agent is running.
- Specifies the HTTP port that the Agent is operated for. The default value is
--https-port
- Specifies the HTTPS port that the Agent is operated for. The HTTPS port is specified in the Agent Instance Start Script typically available from the
./bin/agent_<http-port>.sh
. script with the environment variableJS7_AGENT_HTTPS_PORT
. Use of HTTPS requires a keystore and truststore to be present, see--keystore
and--truststore
options. - The port can be prefixed by the network interface, for example
batch.example.com:4445
.
- Specifies the HTTPS port that the Agent is operated for. The HTTPS port is specified in the Agent Instance Start Script typically available from the
--pid-file-dir
- Specifies the directory to which the Agent stores its PID file. By default the
<data>/logs
directory is used. - When using SELinux then it is recommended to specify the
/var/run
directory, see JS7 - How to install for SELinux.
- Specifies the directory to which the Agent stores its PID file. By default the
--pid-file-name
- Specifies the name of the PID file. By default the file name
agent.pid
is used. - The PID file is created in the directory specified by the
--pid-file-dir
option.
- Specifies the name of the PID file. By default the file name
--keystore
- Specifies the path to a PKCS12 keystore file that holds the private key and certificate for HTTPS connections to the Agent.
- Users are free to specify any file name, typically the name
https-keystore.p12
is used. The keystore file will be copied to the<config>/private
directory. - If a keystore file is made available then the Agent's
<config>/private/private.conf
file has to hold a reference to the keystore location and optionally the keystore password. It is therefore recommended to use the--private-conf
option to deploy an individualprivate.conf
file that holds settings related to a keystore. - For automating the creation of keystores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.
--keystore-password
- Specifies the password for access to the keystore. Use of a keystore password is required.
--keystore-alias
- If a keystore holds more than one private key, for example if separate pairs of private keys/certificates for server authentication and client authentication exist, then it is not determined which private key/certificate will be used. The alias name of a given private key/certificate is specified when the entry is added to the keystore. The alias name allows to indicate a specific private key/certificate to be used.
--truststore
- Specifies the path to a PKCS12 truststore file that holds the certificate(s) for HTTPS connections to the Agent using mutual authentication .
- Users are free to specify any file name, typically the name
https-truststore.p12
is used. The truststore file will be copied to the<config>/private
directory. - If a truststore file is made available then the Agent's
<config>/private/private.conf
file has to hold a reference to the truststore location and optionally the truststore password. It is therefore recommended to use the--private-conf
option to deploy an individualprivate.conf
file that holds settings related to a truststore. - For automating the creation of truststores see JS7 - How to add SSL TLS Certificates to Keystore and Truststore.
--truststore-password
- Specifies the password for access to the truststore. Use of a password is recommended as it is not primarily intended to protect access to the truststore. The password is intended to allow verification that truststore entries have been added using the same password.
--java-home
- Specifies the Java home directory that will be made available to the Agent from the
JAVA_HOME
environment variable specified with the Agent the Agent Instance Start Script typically available from the./bin/agent_<http-port>.sh
script.
- Specifies the Java home directory that will be made available to the Agent from the
--java-options
- Specifies the Java options that will be made available to the Agent from the
JAVA_OPTIONS
environment variable specified with the Agent the Agent Instance Start Script typically available from the./bin/agent_<http-port>.sh
script. - Java options can be used for example to specify Java heap space settings for the Agent.
- If more than one Java option is used then the value has to be quoted, for example
--java-options="-Xms256m -Xmx512m"
.
- Specifies the Java options that will be made available to the Agent from the
--service-dir
- Specifies the systemd service directory to which the Agent's service file will be copied if the
--make-service
switch is used. - By default the
a/usr/lib/systemd/system
will be used. Users can specify an alternative location.
- Specifies the systemd service directory to which the Agent's service file will be copied if the
--service-file
- Specifies the path to a systemd service file that acts as a template and that will be copied to the Agent's
<home>/bin
directory. Users are free to choose any file name as a template for the service file. The resulting service file name will beagent_<http-port>.service
. - The Agent Installer Script will perform replacements in the service file to update paths and the port to be used, for details see
./bin/agent.service-example
.
- Specifies the path to a systemd service file that acts as a template and that will be copied to the Agent's
--service-name
- Specifies the name of the systemd service that will be created if the
--make-service
switch is used. - By default the service name
js7_agent_<http-port>
will be used.
- Specifies the name of the systemd service that will be created if the
...
-h | --help
- Displays usage.
--show-logs
- Displays the log output created by the script if the
--log-dir
option is used.
- Displays the log output created by the script if the
--make-dirs
- If directories are missing that are indicated with the
--home
,--backup-dir
or--log-dir
options then they will be created.
- If directories are missing that are indicated with the
--make-service
- Specifies that a systemd service should be created for the Agent. The service will be created from the
--service-name
option or its default value.
- Specifies that a systemd service should be created for the Agent. The service will be created from the
--move-libs
- For an existing Agent installation the
lib
sub-directory includes .jar files that carry the release number in their file names. If replaced by a newer version thelib
directory has to be moved or removed. This switch tries to move the directory to a previous version number as indicated from the.version
file in the Agent's home directory, for example to renamelib
tolib.2.3.1
. - Files in the
lib/user_lib
sub-directory are preserved.
- For an existing Agent installation the
--remove-journal
- If Agents have been installed for the wrong operating mode (standalone, clustered) then the Agent's journal in the
JS7_AGENT_DATA/state
directory can be removed. This operation removes any orders submitted to an Agent and requires the Agent to be re-registered to a Controller.
- If Agents have been installed for the wrong operating mode (standalone, clustered) then the Agent's journal in the
--restart
- Stops a running Agent before installation and starts the Agent after installation using the Agent's Instance Start Script. This switch can be used with the
--abort
and--kill
switches to control the way how the Agent is terminated. This switch is ignored if the--exec-start
and or--exec-stop
options are used.
- Stops a running Agent before installation and starts the Agent after installation using the Agent's Instance Start Script. This switch can be used with the
--abort
- Aborts a running Agent and kills any running tasks including child processes if used with the
--restart
switch. Aborting an Agent includes to terminate the Agent in an orderly manner that allows to close files consistently.
- Aborts a running Agent and kills any running tasks including child processes if used with the
--kill
- Kills a running Agent and any running tasks if used with the
--restart
switch. This includes killing child processes of running tasks.
- Kills a running Agent and any running tasks if used with the
...
Overview
Content Tools