Agent installation parameters
About this task
This section lists and describes the parameters 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 or not to accept the License Agreement.
- -addjruntime true|false
- Adds the Java™ run time to
run job types with advanced options, both those types supplied with
the product and the additional types implemented through the custom
plug-ins. Valid values are true and false. The default
for a fresh installation is true.
If you decided not to install Java run time at installation time, you can still add this feature at a later time as it is described in Adding a feature.
- -agent dynamic|fta|both
- The type of agent that you want to install. Valid values are:
- dynamic
- To install a Tivoli® Workload Scheduler dynamic agent. Use this value with the -tdwbhostname host_name and the -tdwbport tdwbport_number parameters.
- fta
- To install a Tivoli Workload Scheduler 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.
- -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 Table 1.
- -displayname
- The name to assign to the agent. The default is the host name of this computer.
- -domain user_domain
- Windows systems only. The domain name of the Tivoli Workload Scheduler user. The default is the name of the workstation on which you are installing the product.
- -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 will communicate through a gateway installed on a different dynamic agent workstation from the dynamic agent being installed. The default value is none, no gateway is configured.
- -gwid gateway_id
- The unique identifier for the gateway. This parameter is required
when you specify -gateway local.
The default gateway identifier 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 host name or IP address on which the agent is contacted by the dynamic workload broker. The default is the host name of this computer.
- -inst_dir installation_dir
- The directory of the Tivoli Workload Scheduler installation. Always
specify an absolute path.
- On Windows operating systems:
- If you do not manually specify a path, the path is set to %ProgramFiles%\IBM\TWA_<TWS_USER>, where <TWS_USER> is the user for which you are installing the Tivoli Workload Scheduler 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. If you do not manually specify a path, the path is
set to /opt/IBM/TWA_<TWS_USER>,
where <TWS_USER> is the user for which you are
installing the Tivoli Workload Scheduler that
you specify in the -uname option.Note: The Tivoli Workload Scheduler 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.
- -jmport port_number
-
The JobManager port number used by the dynamic workload broker to connect to the Tivoli Workload Scheduler 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 Tivoli Workload Scheduler 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 Tivoli Workload Scheduler.
- -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/Tivoli directory.
- -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.
- -stoponcheckprereq
- Stop the installation whenever a problem occurs during the prerequisite check. For more information on the prerequisite check, see Scanning system prerequisites for Tivoli Workload Scheduler.
- -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 -gateway local or remote is specified, then this is the host name of the dynamic agent workstation where the gateway resides and to which the agent connects. 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 -gatewayremote is specified, then this is the HTTP or HTTPS port number of the dynamic agent workstation where the gateway resides and to which the agent connects. 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 Tivoli Workload Scheduler workstation of this installation. The name cannot exceed 16 characters, 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.
- -u
- Displays command usage information and exits.
- -uname username
- The name of the user for which Tivoli Workload Scheduler agent
is being installed. This user name is not to be confused with the
user performing the installation logged on as root on UNIX and Linux systems and as administrator on Windows systems. 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. Create a user with a home directory. Tivoli Workload Scheduler is installed by default under the home directory of the specified user.
- -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\tws92, 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/tws92.
- -v
- Displays the command version and exits.