Dynamic Workload Console installation - dwcinst script

This script installs the Dynamic Workload Console

This section lists and describes the parameters that are used when running a dwcinst script to install the Dynamic Workload Console. For a typical installation scenario, see Installing the Dynamic Workload Console servers. If you are installing in a z/OS environment, see Installing the Dynamic Workload Console.

Certificates are now required when installing or upgrading IBM® Workload Scheduler. You can no longer install nor upgrade IBM Workload Scheduler without securing your environment with certificates. The required certificates are:
  • ca.crt
  • tls.key
  • tls.crt
For UNIX systems, ensure that all the files have the ownership of the user who installed the master domain manager and the correct permissions (644).

You can specify values in the properties file, type them in the command line, or use both methods. If a parameter is specified both in the properties file and in the command line, the command line value takes precedence.

Note: To avoid installation failure, ensure that the inst_dir parameter is different from the directory of the installation image.
The log files generated from this command are located in the following path:
On Windows operating systems
DWC_home\logs
On UNIX operating systems
DWC_DATA_dir/installation/logs
On z/OS operating system
DWC_DATA_dir/installation/logs

Syntax for Windows operating systems

Show command usage
dwcinst -? | --usage | --help
Retrieve the command parameters and values from a properties file
dwcinst --file | -f  [properties_file]
General information

    dwcinst
    --acceptlicense yes|no
   [--lang lang_id]
   [--inst_dir install_dir]
   [--skipcheckprereq true|false]
   [--componenttype DWC | FED]
Configuration information for the data source

    --rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | POSTGRESQL
    [--dbname db_name]
    [--dbuser db_user]
    [--dbpassword db_password]
    [--dbport db_port]
    [--dbhostname db_hostname]
    [--dbdriverpath db_driver_path]
    [--dbsslconnection true | false]
DB2 for z/OS-only configuration options
[--zlocationname  zOS_location_containing_db]
SSL configuration options 

   --sslkeysfolder  keystore_truststore_folder
   --sslpassword ssl_password
User information

     --user | -u dwc_user
     --password | -p dwc_password
Configuration information for the application server

    --wlpdir|-w wlp_directory
Security configuration

    [--httpsport https_port]
    [--bootstrapport bootstrap_port]
    [--bootsecpport bootstrap_sec_port]

Syntax for UNIX operating systems

Show command usage
dwcinst -? | --usage | --help
Retrieve the command parameters and values from a properties file
dwcinst --file | -f  [properties_file]
General information

    dwcinst
    --acceptlicense yes|no
   [--lang lang_id]
   [--inst_dir install_dir]
   [--data_dir dwc_datadir]
   [--skipcheckprereq true|false]
   [--componenttype DWC | FED]
Configuration information for the data source

    --rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | POSTGRESQL
    [--dbname db_name
    [--dbuser db_user]
    [--dbpassword db_password]
    [--dbport db_port]
    [--dbhostname db_hostname]
    [--dbdriverpath db_driver_path]
    [--dbsslconnection true | false]
DB2 for z/OS-only configuration options
[--zlocationname  zOS_location_containing_db]
SSL configuration options 

   --sslkeysfolder  keystore_truststore_folder
   --sslpassword ssl_password
User information

     --user | -u dwc_user
     --password | -p dwc_password
Configuration information for the application server

    --wlpdir|-w wlp_directory
Security configuration

    [--httpsport https_port]
    [--bootstrapport bootstrap_port]
    [--bootsecpport bootstrap_sec_port]

Syntax for z/OS operating systems

Show command usage
dwcinst -? | --usage | --help
Retrieve the command parameters and values from a properties file
dwcinst --file | -f  [properties_file]
General information

    dwcinst
    --acceptlicense yes|no
   [--lang lang_id]
   [--inst_dir install_dir]
   [--data_dir dwc_datadir]
   [--componenttype DWC | FED]
Configuration information for the data source

    --rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | POSTGRESQL
    [--dbname db_name]
    [--dbuser db_user]
    [--dbpassword db_password]
    [--dbport db_port]
    [--dbhostname db_hostname]
    [--dbdriverpath db_driver_path]
DB2 for z/OS-only configuration options

    [--zlocationname  zOS_location_containing_db]
SSL configuration options 

   --sslkeysfolder  keystore_truststore_folder
   --sslpassword ssl_password
User information

     --user | -u dwc_user
     --password | -p dwc_password
Configuration information for the application server

    --wlpdir|-w wlp_directory
Security configuration

    [--httpsport https_port]
    [--bootstrapport bootstrap_port]
    [--bootsecpport bootstrap_sec_port]

Parameters

-? | -usage | -help
Displays the command usage and exits.
--propfile | -f [properties_file]
Optionally specify a properties file containing custom values for dwcinst parameters. The default file is located in the root directory of the installation image.
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
Specify the directory where the Dynamic Workload Console is to be installed. This parameter is optional. The default values varies based on the operating system, as follows:
On Windows operating systems
%ProgramFiles%\wa\DWC
On UNIX operating systems
/opt/wa/DWC
On z/OS operating system
/opt/wa/DWC
After installing, you can find this value in the twainstance<instance_number>.TWA.properties file, by checking the DWC_basePath parameter. For more information, see Finding out what has been installed in which IBM Workload Automation instances.
--data_dir dwc_datadir
Specify the path to a directory where you want to store the logs and configuration files produced by Dynamic Workload Console. This parameter is optional. If you do not specify this parameter, all data files generated by the Dynamic Workload Console are stored in DWC_home/DWC_DATA. This path is called, in the publications, DWC_DATA_dir.
--skipcheckprereq true | false
If you set this parameter to false, Dynamic Workload Console 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 IBM Workload Scheduler.
Configuration information for the data source
--rdbmstype|-r rdbms_type
The database type. Supported databases are:
  • DB2
  • ORACLE
  • MSSQL This value applies to MSSQL and supported MSSQL cloud-based databases.
  • POSTGRESQL
This parameter is required and has no default value.
--dbname db_name
The name of the Dynamic Workload Console database. This parameter is optional. The default value is DWC.
--dbuser db_user
The user that has been granted access to the Dynamic Workload Console tables on the database server. This parameter is required.
--dbpassword db_password
The password for the user that has been granted access to the Dynamic Workload Console tables on the database server. This parameter is required. Special characters are not supported. 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 required.
--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.
--dbsslconnection true | false
Enables or disables the SSL connection to the database. This value must always be false when --rdbmstype is DB2Z.

The default value is false.

SSL configuration options
--sslkeysfolder keystore_truststore_folder
The name and path of the folder containing certificates in .PEM format. The installation program automatically processes 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. Note that if certificates being installed are part of a chain consisting of 3 or more certificates (one Root CA, followed by one or more Intermediate CAs, followed by the end user certificate), then this file must contain the Root CA certificate only. Any Intermediate CA certificates must be stored in the additionalCAs subfolder, which therefore becomes a mandatory subfolder. Each Intermediate CA must be stored in the additionalCAs subfolder in its own file.
    Note: From V10.2.3, if certificates being installed are part of a chain, the ca.crt can contain also the intermediate CAs. In this case, it must begin with one or more intermediate CA certificates and end with the Root ca.
  • tls.key
    The private key of the end user certificate for the instance to be installed.
  • tls.crt
    The public part of the previous key, that is the end user certificate.

For UNIX systems, ensure that all the files have the ownership of the user who installed the master domain manager and the correct permissions (644).

You can optionally create a subfolder to contain one or more *.crt files to be added to the server truststore as trusted CA, whose name must be additionalCAs. 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. Note that if the end user certificate being installed in the instance is part of a chain consisting of 3 or more certificates (one Root CA, followed by one or more Intermediate CAs, followed by the end user certificate), then the Intermediate CAs certificates must be stored in the additionalCAs subfolder, which therefore becomes a mandatory subfolder. Each Intermediate CA must be stored in the additionalCAs subfolder in its own file.

For further information about how to generate custom certificates, see Managing certificates using Certman.

--sslpassword ssl_password

The password for the custom certificates and the path to the folder containing certificates in .PEM format with the sslkeysfolder parameter.

For more information, see sslkeysfolder.

You can optionally encrypt the password using the secure script. For more information, see Optional password encryption - secure script.
--enablefips false
Specify whether you want to enable FIPS. In the current product version, you can only specify false because FIPS is not supported. In a fresh installation, the default is false. In upgrade, there is no default value, so you have to set it explicitly and be aware that FIPS is being disabled when you upgrade. This parameter is optional. If you are upgrading from an environment where FIPS is supported, see Q: My environment is FIPS compliant. What happens if I upgrade to version 10.2.3?.
DB2 for z/OS-only configuration syntax
--zlocationname zos_location_containing_db
The name of an already existing location in the z/OS environment that will contain the new database. The default value is LOC1.
User information
--user
Specify the administrator of the Dynamic Workload Console. You can use this account to log in to the Dynamic Workload Console and manage your environment. This parameter is optional. The default value is dwcadmin.
--password
Specify the password for the Dynamic Workload Console user. This parameter is required. You can optionally encrypt the password. For more information, see Encrypting passwords (optional).
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 any alphanumeric, dash (-), underscore (_) characters, and ()|?=*~+.
Configuration information for the application server
--wlpdir
Specify the path where WebSphere Application Server Liberty Base is installed. This parameter is required.
On z/OS operating system
Specify the path where WebSphere Application Server for z/OS Liberty is installed. This parameter is required.
Security configuration
--httpsport
Specify the HTTPS port, to be used in the Dynamic Workload Console URL. This parameter is optional. The default value is 9443.
--bootstrapport
Specify the bootstrap port. This parameter is optional. The default value is 12809.
--bootsecport
Specify the bootstrap security port, to be used for connecting to the Z connector. This parameter is optional. The default value is 19402.