twsinst

Before you begin

Ensure that you have the required authorization requirements, as described in Authorization roles for running the twsinst script.

Note: On HP-UX and Solaris SPARC operating systems, install Java and specify the path to Java before running the twsinst command using the following syntax:

JAVA_HOME=path_to_JAVA;export JAVA_HOME; twsinst_directory/twsinst

This is because Java on these operating systems is not installed with IBM® Workload Scheduler.

About this task

During the installation process, if you do not specify the installation directory in the command, twsinst creates files in the following directories for each of the installation steps:

On Windows™ operating systems: %ProgramFiles%\IBM\TWA_TWS_USER
On UNIX™ and Linux™ operating systems: /opt/HCL/TWA_TWS_USER

Where TWS_USER is the user for which you are installing the IBM Workload Scheduler instance that you specify in the command. If you stop and restart the installation, the installation process starts from the installation step where it was stopped.

To install the IBM Z Workload Scheduler Agent and all the supported language packs, perform the following steps:

On Windows operating systems

Download the IBM Z Workload Scheduler Agent eImage related to your operating system.
Log in as administrator on the workstation where you want to install the product.
From image_directory\TWS\operating_system, run twsinst using the syntax described in the following section.
Note: twsinst for Windows operating systems is a Visual Basic Script (VBS) that you can run in CScript and WScript mode.
The IBM Z Workload Scheduler user is automatically created. The software is installed by default in the IBM Z Workload Scheduler installation directory. The default value is %ProgramFiles%\IBM\TWA.

On UNIX and Linux operating systems

Download the IBM Z Workload Scheduler Agent eImage related to your operating system.
Create the IBM Z Workload Scheduler user. The software is installed by default in the user's home directory, referred to as /installation_dir/TWS

User:

TWS_user

Home:

/installation_dir/TWS (for example: /home/user1/TWS where user1 is the name of the IBM Z Workload Scheduler user.)
Log in as root on the workstation where you want to install the product.
From the image_directory/TWS/operating_system directory, run twsinst using the syntax described in the following section.

A successful installation using the twsinst script issues the return code RC = 0. If the installation fails to understand the cause of the error, see Analyzing return codes for agent installation, upgrade, restore, and uninstallation.

Synopsis

On Windows operating systems

Show command usage and version

twsinst.vbs -u | -v

Install a new instance

twsinst.vbs -new -uname user_name
    -password user_password
    
    [-addjruntime true|false]
    [-displayname agentname]
    [-domain user_domain]
    [-hostname hostname]
    [-inst_dir install_directory]
    [-jmport port_number]
    [-jmportssl true|false]
    [-lang lang_id]
    -sslkeysfolder
    -sslpassword
    [-skip_usercheck]
    [-stoponcheckprereq]
    [-tdwbport tdwbport_number]
    [-tdwbhostname hostname]
    [-work_dir working_directory]
    [-zhostname zconn_hostname
    [-zport zconn_portnumber]

On UNIX and Linux operating systems

Show command usage and version

twsinst -u | -v

Install a new instance

twsinst -new -uname user_name
    
    [-addjruntime true|false]
    [-displayname agentname]
    [-hostname hostname]
    [-inst_dir install_directory]
    [-jmport port_number]
    [-jmportssl true|false]
    [-lang lang_id]
    -sslkeysfolder
    -sslpassword
    [-reset_perm]
    [-skip_usercheck]
    [-stoponcheckprereq]
    [-tdwbport tdwbport_number]
    [-tdwbhostname hostname]
    [-work_dir working_directory]
    [-zhostname zconn_hostname
    [-zport zconn_portnumber]

Parameters

-addjruntime true|false

Adds the Java™ runtime to run job types with advanced options, both those supplied with the product and the additional types implemented through the custom plug-ins. Valid values are true and false. The default is true.

Note: Only for version 10.1 and subsequent fix packs, the addjruntime parameter is ignored and Java runtime is always installed automatically.

-domain user_domain

Windows operating systems only. The domain name of the IBM Workload Scheduler user. The default is the name of the workstation on which you are installing the IBM Z Workload Scheduler Agent.

-displayname agentname

The name to be assigned to the IBM Z Workload Scheduler Agent. The default is the host name.

-hostname hostname

The fully qualified host name or IP address on which the agent will be contacted by the dynamic workload broker.

-inst_dir install_directory

The directory where to install the IBM Z Workload Scheduler Agent. On UNIX and Linux, this path cannot contain blanks. On Windows operating systems, if you specify a path that contains blanks, enclose it in double quotes. On any operating system, specify an absolute path. If you do not manually specify a path, the path is set to the default home directory. On UNIX and Linux, the path is set to the user_name home directory, and on Windows operating systems it is set to %ProgramFiles%\IBM\TWA%ProgramFiles%\HCL\TWA.

-jmport port_number

The port used by the IBM Z Workload Scheduler controller or the dynamic workload broker to connect to the IBM Z Workload Scheduler Agent. The default value is 31114. The valid range is from 1 to 65535.

-jmportssl true|false

The port used by the IBM Z Workload Scheduler controller, or by the dynamic workload broker to connect to the IBM Z Workload Scheduler Agent. This number is registered in the ita.ini file, located in ITA\cpa\ita on Windows operating systems and ITA/cpa/ita on UNIX and Linux.

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. If you specify true, ensure that you also configure the HTTPS communication on the z/OS® master.
For communication without using SSL, or through HTTP: Set jmportssl = false. In this case the port specified in jmport communicates in HTTP.

The default value is true.

To increase the performance of the IBM Z Workload Scheduler server, it is recommended that you set this value to false.

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

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.

-password user_password

Windows operating systems only. The password of the user for which you are installing IBM Z Workload Scheduler Agent. The password can include alphanumeric, dash (-), and underscore (_) characters, and the following symbols: ()!?=ˆ*/˜ [] $`+;:.,@.

-reset_perm

UNIX and Linux only. Reset the permissions of the libatrc library.

-skip_usercheck

Enable this option if the authentication process within your organization is not standard, thereby disabling the default authentication option. On UNIX and Linux operating 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. On Windows operating 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.

-stoponcheckprereq

Stop the installation whenever a problem occurs during the prerequisite check. For more information about the prerequisites, see IBM Workload Scheduler download document.

-tdwbhostname hostname

The fully qualified host name of the dynamic domain manager of backup dynamic domain manager used to connect to the IBM Z Workload Scheduler Agent. It is used together with the -tdwbport tdwbport_number parameter. It adds the capability to run dynamic workload to the IBM Z Workload Scheduler Agent. If not specified, the default value is localhost. This value is registered in the ResourceAdvisorUrl property in the JobManager.ini file.

-tdwbport tdwbport_number

The dynamic domain manager of backup dynamic domain manager HTTP or HTTPS port number used to connect to the IBM Z Workload Scheduler Agent. It is used together with the -tdwbhostname host_name parameter to add the capability to run dynamic workload to the IBM Z Workload Scheduler Agent. This number is registered in the ResourceAdvisorUrl property in the JobManager.ini file. The default value is 0, meaning that the capability to run dynamic workload to the agent is not added. The valid range is from 0 to 65535.

-u

Displays command usage information and exits.

-uname user_name

The name of the user for which the IBM Z Workload Scheduler Agent is installed. This user name is not to be confused with the user performing the installation logged on as root on UNIX and Linux and as administrator on Windows operating systems.

On UNIX and Linux, this user account must be created manually before running the installation. Create a user with a home directory. By default, IBM Z Workload Scheduler Agent is installed in the home directory of the specified user.

-work_dir working_directory

The temporary directory used for theIBM Workload Scheduler installation process files deployment.

On Windows operating systems: If you specify a path that contains blanks, enclose it in double quotes. If you do not manually specify a path, the path is set to %temp%\TWA\tws95, 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/tws95.

-v

Displays the command version and exits.

-zhostname zconn_hostname

The fully qualified host name of the Z connector (this is coincident with the Dynamic Workload Console host name). It is used together with the -zport zconn_port parameter. It adds the capability to download the plug-ins from the Z connector.

This value is registered in the ResourceAdvisorAgent property of the JobManager.ini file.

-zport zconn_portnumber

The HTTP or HTTPS port number of the Z connector (this is coincident with the Dynamic Workload Console port number). It is used together with the -zhostname zconn_hostname parameter to add the capability to download the plug-ins from the Z connector. The valid range is from 1 to 65535.

This value is registered in the ResourceAdvisorAgent property in the JobManager.ini file.

Examples

This example describes how to install the IBM Z Workload Scheduler Agent for the user ZWS_user and accept the default value to add the runtime environment for Java. The runtime environment is used to run jobs supplied with the product or implemented through the custom plug-ins, it also enables the capability to remotely run, from the agent, the dynamic workload broker resource command on the server.

On Windows operating systems

twsinst.vbs -new
-uname ZWS_user
-password qaz12qaz
-jmportssl false
-jmport 31114 
-inst_dir "c:\Program Files\IBM\TWA\TWS_user"

On UNIX and Linux operating systems

./twsinst -new
-uname ZWS_user
-jmportssl false
-jmport 31114
-inst_dir /home/ZWS_user/TWA