Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • --http-port=<[hostname or ip address:]number>
    • Specifies the HTTP port that the Agent is listening to in order to receive requests from a JS7 Controller:
      • agent.sh|cmd --http-port=####

      • where #### is the numeric port.
      • This option can be used to indicate which network 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 order applies:
      • First precedence: command line option
      • Second precedence: environment variable JS7_AGENT_HTTP_PORT (see below)
      • Third precedence: use of default value
  • --https-port=<[hostname or ip address:]number>
    • Specifies the HTTPS port that the Agent is listening to in order to receive requests from a Controller:
      • agent.sh|cmd command --https-port=####

      • where #### is the numeric port.
      • This option can be 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.
    • When using the HTTPS protocol for connections from a Controller instance consider additionally allowing the HTTP protocol for local connections as with --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 to be started, stopped, etc. by its Start Script.
    • 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
  • --data-directory=<location of data directory>
    • Specifies the location of the data directory that usually includes the config, logs, tmp and state directories.
    • This location has to be unique for any Agent instances
    • Should you want to specify a data directory then the following precedence order 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>
  • --config-directory=<location of config directory>
    • Specifies the location of the config directory for configuration data.
    • This location has to be unique for any Agent instances.
    • Should you want to specify a configuration directory then the following precedence order 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 and restart commands this option kills any running processes of jobs by use of a SIGKILL signal.

  • --kill-script=<location of kill script>
    • The kill script provides the functionality to kill tasks and any child processes of jobs.

    • Kill scripts are by default provided from the following locations:
      • JS7_AGENT_DATA/work/kill_task.sh for Unix.

      • JS7_AGENT_DATA\work\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 order 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. for memory settings.

    • Without this option being used the Java options default to '-Xms100m'.

    • In order to specify a number of Java options use quotes like this:
      • --java-options="-Xms100m -Xmx1g"
    • When specifying Should you want to specify the Java options then the following order of precedence order 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 This option being can be used the to specify Java options for Shell jobs that load a JVM. This option does not apply to jobs derived from JS7 - Job Templates that are executed in the Agent's JVM.
    • In order to specify a number of Java options use quotes like this:
      • --job-java-options="-Xms100m -Xmx1g"
    • When specifying Java options for execution with Shell jobs then the following order of precedence apply for each job which is started by the Agent.Should you want to specify the Java options for execution of JITL and JVM jobs then the following precedence order applies:

      • First precedence: command line option
      • Second precedence: environment variable JS7_AGENT_JOB_JAVA_OPTIONS (see below)

...