Page History

...

• -h | --help
  • Displays usage.
• --force-sudo
  • Specifies that sudo is used when performing operations on directories. This switch is required if the home or data directory is not owned by the user account running the Agent Installation Script.
• --active
  • This setting is used for Director Agents only. It specifies that the Director Agent instance should act as the active node in a Director Agent Cluster during initial operation.
  • This setting is not required for installation of a Primary Director Agent in an Agent Cluster. It can be used to revert a Secondary Director Agent to a Primary Director Agent.
• --standby
  • This setting is used for Director Agents only. It specifies that the Director Agent instance should act as the standby node in a Director Agent Cluster during initial operation.
  • This setting is required when installing a Secondary Director Agent instance in an Agent Cluster.
• --no-yade
  • Excludes the YADE file transfer utility from the Agent installation.
  • YADE is available from the yade sub-directory of the Agent's <home> directory. If this switch is used then an existing yade sub-directory will be removed and YADE will not be copied from the installation tarball to the Agent's <home> directory.
• --no-install
  • Specifies if the Installation Script should be used to update configuration items without changes to the binary files of the installation.
    In fact no installation is performed but configuration changes as for example specified with the --keystore option will be applied.
• --use-install

  • Resuses an existing Agent installation. No installation files are specified as with the --release or --tarball parameters. Instead, the new Agent's data directory and the respective service will be created.

• --uninstall
  • Uninstalls the Agent including the steps to stop and to remove a running Agent service and to remove the <home> and <data> directories.
• --uninstall-home
  • Uninstalls the Agent including the steps to stop and to remove a running Agent service and removes the <home> directory only.
• --uninstall-data
  • Uninstalls the Agent including the steps to stop and to remove a running Agent service and preserves the <data> directory only.

• --service-selinux
  • Updates the systemd service file for compliance with SELinux, see JS7 - How to install for SELinux.
• --show-logs
  • Displays the log output created by the script if the --log-dir option is used.
• --make-dirs
  • If directories are missing that are indicated with the --home, --backup-dir or --log-dir options then they will be created.
• --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.
• --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 the lib 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 rename lib to lib.2.3.1.
  • Files in the lib/user_lib sub-directory are preserved.
• --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.
• --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 or --exec-stop options are used.
• --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.
• --kill
  • Kills a running Agent and any running tasks if used with the --restart switch. This includes killing child processes of running tasks.

...

The Agent Installation Script performs replacements of placeholders in installation files and configuration files by option values, for details see chapter Replacements.

Common Options

...

In an Agent Cluster users find the following roles:

...

The following option groups are provided for frequent use cases. Options are qualified like this:

• n/a: the setting is not applicable and must not be used
• not used: the setting is ignored
• optional: the setting can be specified
• required: the setting must be specified

Common Options for use with HTTPS Connections

...

The following matrix shows applicable and required options for roles in an Agent Cluster as opposed to use of Standalone HTTPS connections to Agents:

Option/Switch	Standalone Agent	Primary Director Agent	Secondary Director Agent	Subagent
--activehttp-port	requiredn/a	required	n/a	required	requiredn/a
--standby	n/a	https-port	required	requiredn/a	required	n/arequired
--director-primary-cert	n/a	not used	required for HTTPS mutual authentication	required for HTTPS mutual authentication
--director-secondary-cert	n/a	required for HTTPS mutual authentication	not used	required for HTTPS mutual authentication
keystore	required	required	required	required
--keystore-password	required	required	required	required
--keystore-alias	optional	optional	optional	optional
--client-keystore	optional	optional	optional	optional
--client-keystore-password	optional	optional	optional	optional
--client-keystore-alias	optional	optional	optional	optional
--truststore	required	required	required	required
--truststore-password	required	required	required	required
--controller-primary-cert	required	--agent-cluster-id	n/a	required	required	n/a

...

--controller-primary-subject	required	required	required	n/a
--controller-secondary-cert	required	required	required	n/a
--controller-secondary-subject	required	required	required	n/a
--director-primary-cert	n/a	not used	required	required
--director-primary-subject	n/a

...

	not used	required	required
--director-secondary-cert	n/a	required	not used	required
--director-secondary-subject	n/a	required	not used	required
--private-conf	required	required	required	required

Common Options for use with Agent Clusters

In an Agent Cluster users find the following roles:

• Primary Director Agent: first Director Agent that orchestrates Subagents. By default this is the active instance in a Director Agent Cluster.
• Secondary Director Agent: second Director Agent that orchestrates Subagents. By default this is the standby instance in a Director Agent Cluster.
• Subagent: a worker node in an Agent Cluster that executes jobs.

The following matrix shows applicable and required options for roles in an Agent Cluster as opposed to use of Standalone Agents:

Common Options for use with systemd

The following matrix shows applicable and required options for use with systemd:

...

Examples

The following examples illustrate typical use cases. Users should consider to specify current releases, see JS7 - Download.

...