Agent installation parameters on IBM i systems

The parameters set when using the twsinst script to install the dynamic agent on IBM i systems.

-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.

-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.

-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.

-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. Specify an absolute path. The path cannot contain blanks. If you do not manually specify a path, the path is set to the default home directory, that is, the home/username directory, where username is the value specified in the -uname option.

-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.

-new

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

-skip_usercheck

Enable this option if the authentication process within your organization is not standard, thereby disabling the default authentication option. If you specify this parameter, you must create the user manually before running the script.

-skipcheckprereq

If you specify this parameter, HCL Workload Automation does not scan system prerequisites before installing the agent.

For a detailed list of supported operating systems and product prerequisites, see HCL Workload Automation Detailed System Requirements.

-sslkeysfolder

The name and path of the 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. 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).

-sslpassword

Specify the password for the certificates 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 dynamic and the -tdwbport tdwbport_number parameters. If not specified, you cannot run your workload dynamically and this parameter uses 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 dynamic workload broker HTTP or HTTPS transport port number. It is used together with the -agent dynamic and the -tdwbhostname host_name parameters. 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. This number is registered in the ResourceAdvisorUrl property in the JobManager.ini file. The default value is 41114.

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 HCL Workload Automation is installed.

Note: This user name is not the same as the user performing the installation logged on as QSECOFR.

If username is longer than 8 characters, after installation the agent (and the JobManager component) erroneously run under the QSECOFR user, instead of under the authority of the installation user. To prevent this, set the PASE_USRGRP_LIMITED environment variable to N.

-work_dir working_dir

The temporary directory used for the HCL Workload Automation installation process files deployment. The path cannot contain blanks. If you do not manually specify a path, the path is set to /tmp/TWA/twsversion_number>.

-v

Displays the command version and exits.