HCL Workload Automation on Amazon Web Services

UNIX, Linux, and IBM i command syntax and parameters

The syntax and parameters description of the command to install the agent on UNIX and Linux operating systems.

Agent installation command and parameters

This section shows the agent installation command usage and describes the parameters you can specify to install the agent. The optional parameters are indicated between parentheses. If you do not specify a value for a parameter, the command uses its default value.

Syntax

./installWAAgent.sh -u

Parameters

-u
Shows the command usage.

Syntax

./installWAAgent.sh -new [-uname user_name] -acceptlicense yes|no [ -displayname agent_name] [-hostname host_name ] [-inst_dir install_directory] [ -jmport port_number] [-gateway local [-gwid gateway_site_label] [ -gweifport gateway_eif_port_number | -gateway remote -gwhostname host_name -gwport port_number]][-skipcheckprereq][-work_dir working_directory]

Parameters

-new
Performs a new installation.
-uname user_name
The user for which the product is installed:
  • If you logged in as the root user, it is the name of the user for which the agent is installed. This user must have been created in a previous step, unless you want root to be also the product user. Do not confuse this name with the user performing the installation logged on as root, or with the user name you received by email when you requested your subscription.
  • If you logged in as another user, you do not need to specify this keyword as it automatically takes the login name.
-acceptlicense yes|no
Specify whether or not to accept the License Agreement. If you specify no the installation exits without performing any action.
-displayname agent_name
The name of the computer on which you run your workload. The name cannot exceed 14 characters and must start with a letter. If you use more than 14 characters the name is truncated. The following characters are not supported: [@ " , + ` * ) ( ' '' & $ # ! / [ . ? > = < ; : } { | ~ ] [^.
-hostname host_name
The fully qualified host name on which the agent is contacted. The default is the host name of the computer on which you install the agent.
-inst_dir install_directory
The installation directory where the agent is installed. Ensure that the directory permission is set to 755 if it already exists. The default is:
/opt/HCL/WA_user_name
if the installer logs in as root. user_name is the name of the user that is specified in the -uname user_name option.
home_dir/WA
if the installer logs in with a different login.
Always specify an absolute path.
-jmport port_number
This is the port through which this agent is contacted. The default is 31114. The valid range is from 1 to 65535.
-gateway local[-gwid gateway_site_label]
Specifying this parameter, you install the agent on a computer that can connect directly with the master domain manager and that routes communications for other computers that cannot communicate directly. This is the default.
-gwid gateway_site_label
Specify a name that identifies your gateway site. This parameter is required when you specify -gateway local. The default is GW1. If you install your agents using the default installation settings, then all of your agents are assigned GW1 as the gateway site label. Agents can have the same gateway site label as long as they are all in the same network and can connect to the master domain manager. The name must start with an alphabetic character or an underscore character (_), and it can contain only the following types of characters: alphabetic, numeric, underscores (_), hyphens (-), and periods (.) Gateways that have the same gateway_site_label can mutually take over routing communications to the agents connected to them. All the gateways belonging to the same zone must have the same gateway_site_label and must communicate with each other. In the example shown in Scenario 3, when you install Agent 4, you must ensure that you specify a gateway_site_label different from the one for Agent 1 in the other network zone. So, for example, -gwid Rome. If the -gwid option was not specified at the time of installation of Agent 1, then its gateway_site_label assumes the default value GW1.
-gweifport gateway_eif_port_number
Specify this parameter to submit your workload through events. The gateway_eif_port_number is the port through which the gateway dispatches events. The default is 31132. The valid range is from 1 to 65535.
-gateway remote -gwhostname host_name -gwport port_number
Specify -gateway remote if the computer on which you are installing the agent can communicate with the internet through a gateway installed on an agent different from the agent you are installing here.
Specify in -gwhostname host_name the fully qualified host name or IP address of the remote gateway you want to use.
Specify in -gwport port_number the remote gateway port number.
-skipcheckprereq
Specify this parameter to skip the check prerequisites step during the installation process.
-work_dir working_directory
The working directory where the agent installation process saves the packages to install.