Agent installation parameters on IBM i systems

Specifies whether to accept the License Agreement.

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.

If you are installing, upgrading, or uninstalling with a user different from the default QSECOFR user, this parameter specifies that the user has the required ALLOBJ authority. Ensure the user is existing and has ALLOBJ authority because the product does not verify that the correct authority is assigned. The same user must be specified when installing, upgrading or uninstalling the agent. If you are using the QSECOFR user, this parameter does not apply.

Specifies the API key for authentication with the master domain manager. This key enables downloading certificates or JWT for communication between dynamic agent and dynamic domain manager. A random password in base64 encoding is automatically created for generating stash files. The password stored in the tls.sth file. If needed, you can decrypt this password using any base64 decoder.

Obtain the string to be provided with this parameter from the Dynamic Workload Console before running the command. For more information, see Authenticating the command line client using API Keys.

This parameter is mutually exclusive with:

#agentparamsibmi__d1520e1774
#agentparamsibmi__d1520e1715
#agentparamsibmi__d1520e1297
#agentparamsibmi__d1520e1411

and it is required with:

#agentparamsibmi__d1520e1471
#agentparamsibmi__d1520e1528

For a comprehensive list of supported combinations for this parameter and related ones, see #agentparamsibmi__d1520e1990.

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.

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

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

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. The default value is none, which means no gateway is configured. For information about installing with a local and remote gateway, see Example installation commands.

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

The unique identifier for the gateway. This parameter is required when you specify -gateway local and must be unique across all agents. 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.

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.

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.

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

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.

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.

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

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.

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.

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

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

The fully qualified host name of the dynamic workload broker. It is used together with the -agent dynamic and the -tdwbport tdwbport_number parameters. This value is registered in the ResourceAdvisorUrl property in the JobManager.ini file. This parameter is required if you use the wauser and wapassword or the apikey parameters.

If you set the -gateway parameter to remote, this is the host name of the dynamic agent hosting the gateway and to which the agent you are installing will connect. This information is stored in the JobManager.ini file. For information about installing with a local and remote gateway, see Example installation commands.

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, 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. This parameter is required if you use the wauser and wapassword or the apikey parameters.

If you set the -gateway parameter to remote, this is the HTTP or HTTPS port number of the dynamic agent hosting the gateway and to which the agent you are installing will connect. You have specified this port with the jmport parameter when installing the agent hosting the gateway. For information about installing with a local and remote gateway, see Example installation commands.

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.

Displays command usage information and exits.

The name of the user for which HCL Workload Automation is installed.

If you are using the QSECOFR user or a user with ALLOBJ authority, this user name is not the same as the user performing the installation. If you are using a user different from QSECOFR, the user performing the installation and the user for which the agent is installed are the same.

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.

One of the following users, defined on the master domain manager:

The user for which you have installed the master domain manager the agent is connecting to.
The user with the DISPLAY permission on the FILE named AGENT_CERTIFICATE. This permission allows the user to download certificates or JWT. For more information about this scenario, see Downloading certificates or JWT using a different user.

Always specify the user defined on the master domain manager, also if you are installing a dynamic agent and want it to register to a dynamic domain manager. This is because the dynamic domain manager simply forwards data to and from the master domain manager.

By providing the wauser and wapassword parameters or the apikey parameter, you enable HCL Workload Automation to download and install either the certificates or the JWT already available on the master domain manager:

To download certificates, set the jwt parameter to false
To download JWT, set the jwt parameter to true. For more information, see #agentparamsibmi__d1520e872.

Key details about this parameter:

It is mutually exclusive with the #agentparamsibmi__d1520e334 parameter, which provides authentication using an API Key and the #agentparamsibmi__d1520e1297 and #agentparamsibmi__d1520e1411 parameters.
It always requires the tdwbport and #agentparamsibmi__d1520e1471 parameters.
It is not supported on the HCL Workload Automation Agent (also known as the agent with z-centric capabilities). To generate certificates for the HCL Workload Automation Agent, use the sslkeysfolder and sslpassword parameters.

For further information about how to automatically download and deploy certificates in PEM format from the master domain manager to dynamic agents and fault-tolerant agents, see Certificates download to dynamic agents and fault-tolerant agents - AgentCertificateDownloader script.

For a comprehensive list of supported combinations for this parameter and related ones, see #agentparamsibmi__d1520e1990.

One of the following passwords, defined on the master domain manager:

The password of the user for which you have installed the master domain manager the agent is connecting to.
The password of the user with the DISPLAY permission on the FILE named AGENT_CERTIFICATE. This permission allows the user to download certificates or JWT. For more information about this scenario, see Downloading certificates or JWT using a different user.

Always specify the user defined on the master domain manager, also if you are installing a dynamic agent and want it to register to a dynamic domain manager. This is because the dynamic domain manager simply forwards data to and from the master domain manager.

By providing the wauser and wapassword parameters or the apikey parameter, you enable HCL Workload Automation to download and install either the certificates or the JWT already available on the master domain manager:

Agent installation parameters on IBM i systems

About this task