Windows command syntax and parameters

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.

Parameters

-u

Shows the command usage.

Parameters

-new

Performs a new installation.

-uname user_name

User for which the product is installed. Do not confuse this name with the user performing the installation logged on as administrator.

-password password

The password of the user for which you are installing the agent. Password may include alphanumeric, dash (-), and underscore (_) characters, and the following symbols: ()!?=ˆ*/˜ [] $`+;:.,@. Follow your company rules for the password characters and length.

-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 when using Workload Automation on Cloud. 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:

[@ " , + ` * ) ( ' '' & $ # ! / [ . ? > = < ; : } { | ~ ] [^

. The default is this computer host name prefixed with the Environment ID you received by email. If you customize it, the name of the computer is set to the agent_name prefixed by the Environment ID.

-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. The default is %ProgramFiles%\IBM\TWA_user_name where user_name is the name of the user that you specify in the -uname user_name option. If you specify an installation directory that contains blanks, enclose it within double quotation marks. 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] [-gweifport gateway_eif_port_number

Specifying this parameter, you install the agent on a computer that can connect directly with the Workload Automation on Cloud site 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 install.bat file provided, 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 Workload Automation on Cloud site . 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.