Master components installation - serverinst script

The master domain manager, backup domain manager, dynamic domain manager, backup dynamic domain manager, and installation parameters that can be defined for the serverinst script.

This section lists and describes the parameters that are used when running a serverinst script to install the master domain manager and backup domain manager, dynamic domain manager, and backup dynamic domain manager.

When running the command, you can type parameters and values from a properties file, type them in the command line, or use a combination of both properties file and command line. If a parameter is specified both in the properties file and in the command line, the command line value is used.

The log files generated from this command are located in the following path:
On Windows operating systems
TWA_home\logs
On UNIX operating systems
TWA_DATA_DIR/installation/logs

Syntax

On Windows operating systems:
Show command usage
cscript serverinst.vbs -? | --usage | --help
Retrieve the command parameters and values from a properties file
cscript serverinst.vbs --propfile|-f  [properties_file]
General information

    cscript serverinst.vbs
    --acceptlicense yes|no
   [--lang lang_id]
   [--inst_dir install_dir]
   [--work_dir working_dir]
   [--skipcheckprereq true|false]
   [--skipcheckemptydir true|false]
   [--skipusercheck true|false]
      
Configuration information for the data source

    [--rdbmstype|-r DB2® | ORACLE | MSSQL]
    [--dbname db_name]
    [--dbuser db_user]
    --dbpassword db_password
    [--dbport db_port]
     --dbhostname db_hostname
    [--dbdriverpath db_driver_path]
    [--dbsslconnection true | false]
    
Licensing information

     --licenseserverid license_server_ID
     [--licenseserverurl https://hclsoftware.compliance.flexnetoperations.com/]
Configuration options when dbsslconnection=true or customized certificates are used for SSL connections

   [--sslkeysfolder  keystore_truststore_folder]
   [--sslpassword ssl_password]
User information

    [--wadomain]
    [--wauser wa_user]
    [--wapassword wa_password]
    
Configuration information for the application server

     --wlpdir|-w wlp_directory  
    [--httpport http_port] 
    [--httpsport https_port]
    [--bootstrapport bootstrap_port]
    [--bootsecport bootstrap_sec_port]
    [--startserver true | false]
Configuration information for dynamic scheduling

    [--displayname agent_name]
    [--jmport port_number]
Configuration information for the master domain manager

    [--componenttype MDM | DDM]
    
Configuration options when component type is MDM

    [--company company_name]
    [--hostname hostname]
    [--thiscpu workstation]
    
    [--eifport eif_port]
    [--brwksname broker_workstation_name]
    [--brnetmanport broker_netman_port]
    [--netmanport netman_port_number]
    
    
Configuration options when component type is DDM

    [--domain domain_name]
     --master domain_name
     --mdmhttpsport
     --mdmbrokerhostname
    [--eifport eif_port]
    [--brwksname broker_workstation_name]
    [--brnetmanport broker_netman_port]
    [--netmanport netman_port_number]
    
    [--isforzos yes|no]
On UNIX® operating systems
Show command usage
./serverinst.sh -? | --usage | --help
Retrieve the command parameters and values from a properties file
./serverinst.sh --propfile|-f  [properties_file]
General information

    ./serverinst.sh
    --acceptlicense yes|no
   [--lang lang_id]
   [--inst_dir install_dir]
   [--work_dir working_dir]
   [--data_dir wa_datadir]
   [--skipcheckprereq true|false]
   [--skipcheckemptydir true|false] 
Configuration information for the data source

    [--rdbmstype|-r DB2® | ORACLE | MSSQL | IDS]
    [--dbname db_name]
    [--dbuser db_user]
     --dbpassword db_password
    [--dbport db_port]
     --dbhostname db_hostname
    [--dbdriverpath db_driver_path]
    [--dbsslconnection true | false]
    --informixserver db_server
    
Licensing information

     --licenseserverid license_server_ID
     [--licenseserverurl https://hclsoftware.compliance.flexnetoperations.com/]
Configuration options when dbsslconnection=true or customized certificates are used for SSL connections

   [--sslkeysfolder  keystore_truststore_folder]
   [--sslpassword ssl_password]
   
User information

     --wauser wa_user
     --wapassword wa_password
    
Configuration information for the application server

     --wlpdir|-w wlp_directory  
    [--httpport http_port] 
    [--httpsport https_port]
    [--bootstrapport bootstrap_port]
    [--bootsecport bootstrap_sec_port]
    [--startserver true | false]
Configuration information for dynamic scheduling

    [--displayname agent_name]
    [--jmport port_number]
Configuration information for the master domain manager

    [--componenttype MDM | DDM]
    
Configuration options when component type is MDM

    [--company company_name]
    [--hostname hostname]
    [--thiscpu workstation

    [--eifport eif_port]
    [--brwksname broker_workstation_name]
    [--brnetmanport broker_netman_port]
    [--netmanport netman_port_number]
    
    
Configuration options when component type is DDM

    [--domain domain_name]
     --master domain_name
     --mdmhttpsport
     --mdmbrokerhostname
     --eifport eif_port]
    [--brwksname broker_workstation_name]
    [--brnetmanport broker_netman_port]
    [--netmanport netman_port_number]
    
    [--isforzos yes|no]

Arguments

? | --usage | --help
Displays the command usage and exits.
--propfile|-f [properties_file]
Optionally specify a properties file containing custom values for serverinst parameters. The default file is
On Windows systems
image_dir>\TWS95_WIN_X86_64_SERVER\TWS\WINDOWS_X86_64\serverinst.properties
On UNIX® systems
image_dir>/TWS/interp>/serverinst.properties
Specifying a properties file is suggested if you have a high number of parameters which require custom values. You can also reuse the file with minimal modification for several installations. If you create a custom properties file, specify its name and path with the -f parameter.

General information

--acceptlicense yes|no
Specify whether to accept the License Agreement.
--lang lang_id
The language in which the messages returned by the command 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 component instance. The command installs all languages as default.
--inst_dir installation_dir
The directory of the HCL Workload Automation installation. This parameter is optional. The default value is:
On Windows operating systems
C:\Program Files\wa
On UNIX® operating systems
/opt/wa
--work_dir working_dir
The temporary directory used by the program to deploy the installation process files. This parameter is optional. The default value is:
On Windows operating systems
C:\TMP
On UNIX® operating systems
/tmp/waversion_number
This parameter can also function as a backup directory during product upgrade with path WORKING_DIR/backup.
--data_dir wa_datadir
UNIX operating systems only. Specify the path to a directory where you want to store the logs and configuration files produced by HCL Workload Automation. This parameter is optional. If you do not specify this parameter, all data files generated by HCL Workload Automation are stored in the TWA_home/TWSDATA directory. This path is called, in the publications, TWA_DATA_DIR.
--skipcheckprereq
If you set this parameter to false, HCL Workload Automation does not scan system prerequisites before starting the installation. This parameter is optional. The default value is true. For more information about the prerequisite check, see Scanning system prerequisites for HCL Workload Automation.
-skipcheckemptydir
Set this parameter to true to avoid checking whether the installation directory is empty. By default, this parameter is false, because starting from version 9.5 the installation directory must be empty. If you set this parameter to true and the installation directory is not empty, the installation process might fail.
--skipusercheck
If you set this parameter to true, HCL Workload Automation, performs no checks on the user. This parameter is optional. The default value is false. By default, the following checks are performed:
local user
The script checks if the specified user is existing, has the correct access rights, and the password specified with the wapassword parameter is correct. If the user does not exist, the script creates it and grants it the correct access rights. If the specified password is incorrect, the script returns an error and the installation process stops.
domain user
The script checks if the specified user is existing, has the correct access rights, and the password specified with the wapassword parameter is correct. If the user does not exist, the script cannot create it and the installation process ends in error. If the user exists but does not have the correct access rights, the script assigns it the required rights. If the specified password is incorrect, the script returns an error and the installation process stops.

Configuration information for the data source

The values for these parameters must match the values defined by the database administrator when creating the database. For more information, see Creating and populating the database and browse to the topic for the database you are using.

--rdbmstype|-r rdbms_type
The database type. Supported databases are:
  • DB2
  • ORACLE
  • MSSQL This value applies to MSSQL,Azure SQL.
  • IDS This value applies to both Informix and OneDB.
This parameter is optional. The default value is DB2.
--dbname db_name
The name of the HCL Workload Automation database. This parameter is optional. The default value is TWS.
--dbuser db_user
The user that has been granted access to the HCL Workload Automation tables on the database server. This parameter is optional. The default value is db2tws.
--dbpassword db_password
The password for the user that has been granted access to the HCL Workload Automation or Dynamic Workload Console tables on the database server. This parameter is required. The default value is password.You can optionally encrypt the password. For more information, see Encrypting passwords (optional).
--dbport db_port
The port of the database server. This parameter is optional. The default value is 5000.
--dbhostname db_hostname
The host name or IP address of database server. This parameter is required.
--dbdriverpath db_driver_path
The path where the database drivers are stored. This parameter is optional. By default, the configuration script references the JDBC drivers supplied with the product images. If your database server is not compatible with the supplied drivers, then contact your database administrator for the correct version to use with your database server and specify the driver path using this parameter. Ensure you provide the same path in the configureDb, serverinst, and dwcinst commands. For more information, see What if my database server does not support the drivers supplied with the product images?.
--dbsslconnection true | false
Enables or disables the SSL connection to the database. The default value is false. This parameter applies only to DB2.
--informixserver
Specifies the name of the Informix or OneDB database server. This parameter is required only if --rdbmstype is set to IDS and is supported only on UNIX operating systems.
Licensing information
--licenseserverid
The ID of the license server which processes license usage information. This parameter is required. Instructions about how to obtain the ID of the license server which processes license usage information are provided with the mail confirming your license. For more information, see License computation model and Enabling product license management
--licenseserverurl
The URL of the license server which processes license usage information. This parameter is optional. The default value is https://hclsoftware.compliance.flexnetoperations.com/.
Configuration options when dbsslconnection=true or customized certificates are used for SSL connections
--sslkeysfolder
The name and path of the folder containing either the keystore (TWSServerKeyFile.jks) and/or truststore (TWSServerTrustFile.jks) files you need to provide when supplying custom certificates (only on UNIX operating systems), or certificates in .PEM format:
  • Only on UNIX operating systems, if you provide the keystore and truststore files, these files are used to configure SSL communication using the passwords you provide with the --keystorepassword and --truststorepassword respectively.
    Note: When installing using the keystore and truststore files, you are required to manually configure these files prior the installation setup. If providing custom .jks files, it is your responsibility to provide such .jks files equipped with all the CA certificates they need in the truststore. For these reasons, this procedure is not recommended.
  • If you provide .PEM certificates, the installation program automatically generates the keystore and truststore files using the password you specify with the --sslpassword parameter. The folder must contain the following files:
    • 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.

This parameter is required if you set the --dbsslconnection parameter to true.
--sslpassword
If you provide .PEM certificates with the --sslkeysfolder parameter, this is the password for the certificates automatically generated by the installation program. This parameter is mutually exclusive with the keystorepassword and truststorepassword parameters, which apply when you provide the keystore and truststore files using the sslkeysfolder parameter.

User information

--wauser user_name
The user for which you are installing HCL Workload Automation. This parameter is optional. The default value is the user performing the installation.
--wapassword wauser_password
The password for the user for which you are installing HCL Workload Automation.
On Windows operating systems
Supported characters for the password are alphanumeric, dash (-), underscore (_) characters, and ()|?*~+.
On UNIX operating systems
Supported characters for the password are alphanumeric, dash (-), underscore (_) characters, and ()|?=*~+.
. This parameter is required. You can optionally encrypt the password. For more information, see Encrypting passwords (optional).

Configuration information for the application server

The values for these parameters must match the values defined when installing WebSphere Application Server Liberty Base. For more information, see Installing WebSphere Application Server Liberty Base.

--wlpdir | w wlp_directory
WebSphere Application Server Liberty Base profile installation directory. This parameter is required.
--httpport http_port
The HTTP port. This parameter is optional. The default value is 31115.
--httpsport https_port
The HTTPS port. This parameter is optional. The default value is 31116.
--startserver true | false
Specifies whether the WebSphere Application Server Liberty Base server must be started after installation. This parameter is optional. The default value is true.

Configuration information for dynamic scheduling

displayname
The name to be assigned to the agent. The name cannot start with a number. If the host name starts with a number, this parameter is required, otherwise it is optional. The default value is the host name of the workstation followed by _1.
jmport port_number

The JobManager port number on which the dynamic domain manager is contacted by the dynamic agent. This parameter is optional. The default value is 31114. The valid range is from 1 to 65535.

Configuration information for the master domain manager

--componenttype MDM | DDM
The workstation type being installed. Supported workstation types are:
MDM
master domain manager
DDM
dynamic domain manager

To install a backup domain manager, run the serverinst command on the workstation where you plan to install the backup domain manager. The serverinst command connects to the database you specify, discovers that a master domain manager is already installed, and proceeds to install a backup domain manager. The same procedure applies when installing a backup dynamic domain manager.

Configuration options when component type is MDM

--company company_name
The name of the company. The company name cannot contain blank characters. The name is shown in program headers and reports. This parameter is optional. The default name is COMPANY.
--hostname host_name
The fully qualified host name or IP address on which the installation is performed. The default value is calculated at installation time.
--thiscpu workstation
The name of the HCL Workload Automation workstation for this installation. The name cannot exceed 16 characters, cannot start with a number, cannot contain spaces. If the host name starts with a number, this parameter is required, otherwise it is optional. This name is registered in the localopts file. The default name is the host name of the workstation.
--eifport eif_port
Specifies the Job Manager Event Integration Facility (EIF) port number. The default value is 31131. The valid range is 1 to 65535.
--brwksname
The broker workstation name. This parameter is optional. The default value is the workstation host name followed by _DWB. It cannot start with a number.
--brnetmanport port_number
The TCP/IP port number used by the netman process to listen for communication from the dynamic domain manager. This parameter is optional. The default value is 41114. 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. For more information about the localopts file, see Setting local options
--netmanport netman_port_number
The TCP/IP port number used by the netman process to listen for communication from the master domain manager. This parameter is optional. The default value is 31111. The valid range is from 1 to 65535. This port number is registered in the localopts file, in the nm port attribute. For each installation you must specify a different number.

Configuration options when componenttype is DDM

--domain domain_name
Windows systems only. The domain name of the HCL Workload Automation user. This parameter is optional. The default value is MASTERDM when you install a master domain manager, and DYNAMICDM when you install a dynamic domain manager.
--master
The master domain manager name. It cannot start with a number. This parameter is required for the dynamic domain manager only. Do not specify when installing the master domain manager.
--mdmhttpsport
The port of the master domain manager host used by the broker to contact master domain manager. This parameter is required. This parameter applies to the dynamic domain manager only. Do not specify when installing the master domain manager.
--mdmbrokerhostname
The fully qualified host name or IP address of the master domain manager contacted by the dynamic domain manager. This parameter is required for the dynamic domain manager only. Do not specify when installing the master domain manager.
--eifport eif_port
Specifies the Job Manager Event Integration Facility (EIF) port number. The default value is 31131. The valid range is 1 to 65535.
--brwksname
The broker workstation name. This parameter is optional. The default value is the workstation host name followed by _DWB. It cannot start with a number.
--brnetmanport port_number
The TCP/IP port number used by the netman process to listen for communication from the dynamic domain manager. This parameter is optional. The default value is 41114. 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. For more information about the localopts file, see Setting local options
--netmanport netman_port_number
The TCP/IP port number used by the netman process to listen for communication from the master domain manager. This parameter is optional. The default value is 31111. The valid range is from 1 to 65535. This port number is registered in the localopts file, in the nm port attribute. For each installation you must specify a different number.
--isforzos yes|no

Set to yes if you want to connect the dynamic domain manager to only the Z controller. Set to no if you want to connect the dynamic domain manager to a master domain manager or, to both a master domain manager and a Z controller. This parameter is optional. The default value is no.

Comments

Note: The values for the following parameters must match the values you provided when creating and populating the database:
  • --rdbmstype
  • --dbhostname
  • --dbport
  • --dbname
  • --dbuser
  • --dbpassword
See Creating and populating the database, then follow the link to the database vendor you are using for more information about command parameters.