Agent installation parameters - twsinst script

Agent installation parameters that can be passed to the twsinst script.

About this task

This section lists and describes the parameters that are used when running a twsinst script to install the fault-tolerant or dynamic agent.

To see some sample agent installation scenarios see Example installations and Dynamic agent gateway installation examples.

-acceptlicense yes|no

Specify whether to accept the License Agreement.

-addjruntime true|false

Adds the Java™ run time to run job types with advanced options, both those types that are supplied with the product and the additional types that are implemented through the custom plug-ins. Valid values are true and false. The default for a fresh installation is true. Set this parameter to true if you use the sslkeysfolder and sslpassword parameters to define custom certificates in .PEM format.

If you decided not to install Java™ run time at installation time, you can still add this feature later as it is described in Adding a feature.

-agent dynamic|fta|both\zcentric

The type of agent that you want to install. Valid values are:

dynamic: To install a HCL Workload Automation dynamic agent. Use this value with the -tdwbhostname host_name and the -tdwbport tdwbport_number parameters.
fta: To install a HCL Workload Automation fault-tolerant agent.
both: To install the dynamic agent that is used with the -tdwbhostname host_name and the -tdwbport tdwbport_number parameters, and a fault-tolerant agent.
zcentric: To install an HCL Workload Automation Agent (also known as the agent with z-centric capabilities).

The default is dynamic.

-agentid agentid

The unique identifier of the agent that you want to install. The parameter is optional. If not specified, the installation process assigns to the agent a string of alphanumeric characters, as in the following example:


893164748CCA4FC6820F12685AECBB07

It might be useful to specify an agentid when you want to reinstall an agent after it was uninstalled, and you want to use the same agentid. This prevents that two different agentid values are registered on the server for the same agent installation.

-company company_name

The name of the company. The company name cannot contain blank characters. The name is shown in program headers and reports. If not specified, the default name is COMPANY.

-create_link

UNIX™ systems only. Create the symlink between /usr/bin/at and install_dir/TWS/bin/at. For more information, see Symbolic link options.

data_dir

This argument applies to UNIX operating systems only. Specify a path for product data, such as log and configuration files, if you want to install the product binaries separated from the product data. This argument is optional. The default value is INSTALL_DIR/TWSDATA.

-displayname name

The name to assign to the agent. The name cannot start with a number. The default is the host name of this computer.

If the host name starts with a number, -displayname parameter must be specified.

-domain user_domain

Windows™ systems only. The domain name of the HCL Workload Automation user. The default is the name of the workstation on which you are installing the product. Ensure you use USERDOMAIN instead of USERDNSDOMAIN.

-gateway local|remote|none

Specifies whether to configure a gateway to communicate with the dynamic workload broker or not, and how it is configured. Specify local if the gateway is local to the dynamic agent workstation. Specify remote if the dynamic agent communicates through a gateway that is installed on a different dynamic agent workstation from the dynamic agent being installed. Only for version 9.5 Fix Pack 4, if you set -gateway to remote and want to install the agent in SSL mode, ensure that the agent can connect directly to the MDM at installation time. This is required only for the time interval necessary for downloading the certificates. (After the download has completed, you can return the agent to communicating through the gateway). The default value is none, no gateway is configured.

-gweifport gateway_eif_port

Specifies the Job Manager Event Integration Facility (EIF) port number. The default value is 31132. The valid range is 1 to 65535.

-gwid gateway_id

The unique identifier for the gateway. This parameter is required when you specify -gateway local. The default gateway identifier that is assigned is GW1. The gateway identifier must start with either an alphabetic character or an underscore character (_), and it can contain only the following types of characters: alphabetic, numeric, underscores (_), hyphens (-), and periods (.).

Gateways can also work in parallel to mutually take over in routing communications to the agents connected to them. To enable gateways to work in parallel, all gateways must have the same gateway_id assigned. This information is stored in the JobManagerGW.ini file, by setting the JobManagerGWURIs property.

-hostname host_name

The fully qualified hostname or IP address on which the agent is contacted by the dynamic workload broker. The default is the hostname of this computer. If the hostname is a localhost, the hostname parameter must be specified.

-inst_dir installation_dir

The directory of the HCL Workload Automation installation.

On Windows™ operating systems:

If you specify a path that contains blanks, enclose it in double quotation marks. Specify an absolute path. If you do not manually specify a path, the path is set to %ProgramFiles%\HCL\TWA_TWS_USER, where TWS_USER is the user for which you are installing the HCL Workload Automation that you specify in the -uname option.

On UNIX™ and Linux™ operating systems:

If you specify a path that contains blanks, enclose it in double quotation marks. Specify an absolute path. If you do not manually specify a path, the path is set to:

/opt/HCL/TWA_TWS_USER, if you logged in as the root user to install the agent. TWS_USER is the user that you specify in the -uname option and for which you are installing the agent (can omit if TWS_USER is root).
Note: The HCL Workload Automation user that you specify in the -uname username parameter must have read and run privileges for the installation_dir installation path; otherwise the installation fails.
home_dir/TWA, if you logged in with a login other than root. Ensure that the directory permission is set to 755 for home_dir, the home directory for your login, and that you are the home_dir owner.

-jmport port_number

The JobManager port number used by the dynamic workload broker to connect to the HCL Workload Automation dynamic agent. The default value is 31114. The valid range is from 1 to 65535.

-jmportssl true|false

The JobManager port used by the dynamic workload broker to connect to the HCL Workload Automation dynamic agent. The port value is the value of the ssl_port parameter in the ita.ini file if -jmportssl is set to true. If set to false, it corresponds to the value of the tcp_port parameter in the ita.ini file. The ita.ini file is located in ITA\cpa\ita on Windows™ systems and ITA/cpa/ita on UNIX™, Linux™, and IBM i systems.

Set the value to "true" if - gateway is set to local.

For communication using SSL or HTTPS: Set jmportssl = true. To communicate with the dynamic workload broker, it is recommended that you set the value to true. In this case, the port specified in jmport communicates in HTTPS.
For communication without using SSL or through HTTP: Set jmportssl = false. In this case the port specified in jmport communicates in HTTP.

-lang lang_id

The language in which the twsinst messages are displayed. If not specified, the system LANG is used. If the related catalog is missing, the default C language catalog is used. If neither -lang nor LANG are used, the default codepage is set to SBCS. For a list of valid values for these variables, see the following table:

Table 1. Valid values for -lang and LANG parameter
Language	Value
Brazilian portuguese	pt_BR
Chinese (traditional and simplified)	zh_CN, zh_TW
English	en
French	fr
German	de
Italian	it
Japanese	ja
Korean	ko
Russian	ru
Spanish	es

Note: This is the language in which the installation log is recorded and not the language of the installed engine instance. twsinst installs all languages as default.

-master workstation

The workstation name of the master domain manager. This name cannot exceed 16 characters, cannot contain spaces, and cannot be the same as the workstation name that you entered in the thiscpu parameter. If not specified, the default value is MASTER.

-new

A fresh installation of the agent. Installs an agent and all supported language packs.

-password user_password

Windows™ systems only. The password of the user for which you are installing HCL Workload Automation. The password can include alphanumeric, dash (-), and underscore (_) characters, and the following symbols: ()!?=ˆ*/˜ [] $`+;:.@. The -password parameter is used for fresh installations only, it is not required for fix packs or upgrades.

-port port_number

The TCP/IP port number used by the Netman process to listen for communication from the master. The default value is 31111. The valid range is from 1 to 65535. This port number is registered in the localopts file. For each installation you must specify a different number.

-reset_perm

UNIX™ and IBM i systems only. Reset the permission of the libraries in the /usr/hcl directory.

-restore

Run this command from the folder to where you copied the eImage (a folder other than the home directory of TWS_USER, where TWS_USER is the user that installed the HCL Workload Automation instance), and not from the installation path, to restore the version in the eImage.

-skip_usercheck

Enable this option if the authentication process within your organization is not standard, thereby disabling the default authentication option.

On Windows™ systems if you specify this parameter, the program does not create the user you specified in the -uname username parameter. If you specify this parameter you must create the user manually before running the script.

On UNIX™ and Linux™ systems if you specify this parameter, the program skips the check of the user in the /etc/passwd file or the check you perform using the su command.

-skipcheckprereq

If you specify this parameter, HCL Workload Automation does not scan system prerequisites before installing the agent. For more information on the prerequisite check, see Scanning system prerequisites for HCL Workload Automation.

-sslkeysfolder path

The name and path of the local folder containing the certificates in .PEM format. The installation program generates the keystore and truststore files using the password you specify with the -sslpassword parameter.

tls.sth: The file storing your encoded password.
tls.rnd: The file containing the random seed to be used by OpenSSL.
ca.crt: The Certificate Authority (CA) public certificate.
tls.key: The private key for the instance to be installed.
tls.crt: The public part of the previous key.

You can optionally create a subfolder to contain one or more *.crt files to be added to the server truststore as trusted CA. This can be used for example to add to the list of trusted CAs the certificate of the LDAP server or DB2 server. Additionally, you can store here any intermediate CA certificate to be added to the truststore. The subfolder must be named additionalCAs.

If you use this parameter, ensure that the addjruntime parameter is set to true, because Java™ run time is required for defining custom certificates in .PEM format. This parameter is not supported on HCL Workload Automation Agent (also known as the agent with z-centric capabilities).

This parameter is mutually exclusive with the wauser and wapassword parameters, which are used to download and deploy the certificates already available on the master domain manager.

-sslpassword password

Specify the password for the certificates in .PEM format automatically generated by the installation program. If you use this parameter, ensure that the addjruntime parameter is set to true, because Java™ run time is required for defining custom certificates. This parameter is not supported on HCL Workload Automation Agent (also known as the agent with z-centric capabilities).

-tdwbhostname host_name

The fully qualified host name of the dynamic workload broker. It is used together with the -agent parameter set to either dynamic or both and the -tdwbport tdwbport_number parameter. It is necessary to install the dynamic agent. If not specified, you cannot run your workload dynamically and this parameter assumes the localhost default value. This value is registered in the ResourceAdvisorUrl property in the JobManager.ini file.

If you set the -gateway parameter to remote, this is the host name of the dynamic agent where the gateway resides and to which the agent connects. In this case, the tdwbport parameter must match the value of the jmport parameter specified when installing the agent with the local gateway. This information is stored in the JobManager.ini file.

-tdwbport tdwbport_number

The HTTP or HTTPS transport port number of the dynamic workload broker. It is used together with the -agent parameter set to either dynamic or both and the -tdwbhostname host_name parameter. It is required if you install the dynamic agent so that the agent can connect to the dynamic workload broker. This number is registered in the ResourceAdvisorUrl property in the JobManager.ini file. The default value is 31116. For each installation you must specify a different port number. The valid range is from 0 to 65535. If you specify 0 or do not specify this parameter, you cannot run workload dynamically. Do not specify 0 if the -agent value is dynamic or both. The default is "0" for an upgrade, which means that this connection is not configured, otherwise, specify 31116 for a fresh installation.

If gateway remote is specified, then this is the HTTP or HTTPS port number of the dynamic agent where the gateway resides and to which the agent connects. You have specified this port with the jmport parameter when installing the agent with the local gateway.. If you are performing a fresh installation, then the value to use is 31114. This information is stored in the JobManager.ini file.

-thiscpu workstation

The name of the HCL Workload Automation workstation of this installation. The name cannot exceed 16 characters, cannot start with a number, cannot contain spaces, and cannot be the same as the workstation name of the master domain manager. This name is registered in the localopts file. If not specified, the default value is the host name of the workstation.

If the host name starts with a number, -thiscpu parameter must be specified.

-u

Displays command usage information and exits.

-uname username

The name of the user for which the HCL Workload Automation agent is being installed. This user owns the HCL Workload Automation instance and by default, jobs are run with its name. This user name is not to be confused with the user performing the installation. The user name cannot contain periods (.).

On UNIX™ and Linux™ systems, for a new installation, this user account must be created manually before running the installation and must be enabled to login to the machine where the agent is going to be installed. Create a user with a home directory. HCL Workload Automation is installed by default under the home directory of the specified user.

Dynamic agents can be installed on UNIX™ and Linux™ systems also by installers without root privileges. When this is the case:

username takes by default the login name of the installer and uname can be omitted. If uname is specified with a different value than the login of the installer, an error message is returned.
As a consequence, the agent can run jobs uniquely with the user name of the installer.
Event Management triggers on files work only if the selected files are accessible to the user that was used for the installation.
The user must be enabled to login to the machine where the agent is going to be installed

-wauser wauser_name

The user for which you have installed the master domain manager to which the agent is connecting. By providing this information, you enable HCL Workload Automation to download and deploy the certificates in .PEM format already available on the master domain manager in the TWA_DATA_DIR/ssl/depot path to enable secure communication. This parameter is mutually exclusive with the sslkeysfolder parameter, which is used to specify a folder on the agent where you store the certificates. This parameter applies to dynamic agents. To manage certificates for fault-tolerant agents, use the sslkeysfolder parameter.

-wapassword wauser_password

The password for the user for which you have installed the master domain manager to which the agent is connecting. By providing this information, you enable HCL Workload Automation to download and install the certificates in .PEM format already available on the master domain manager TWA_DATA_DIR/ssl/depot path to enable secure communication. This parameter is mutually exclusive with the sslkeysfolder parameter, which is used to specify a folder on the agent where you store the certificates. This parameter applies to dynamic agents. To manage certificates for fault-tolerant agents, use the sslkeysfolder parameter.

-work_dir working_dir

The temporary directory used by the program to deploy the installation process files.

On Windows™ operating systems:: If you specify a path that contains blanks, enclose it in double quotation marks. If you do not manually specify a path, the path is set to %temp%\TWA\twsversion_number, where %temp% is the temporary directory of the operating system.
On UNIX™ and Linux™ operating systems:: The path cannot contain blanks. If you do not manually specify a path, the path is set to /tmp/TWA/twsversion_number.

This parameter can also function as a backup directory during product upgrade with path WORKING_DIR/backup if you do not set the -skipbackup parameter to true.

-v

Displays the command version and exits.