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.

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.

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

Dynamic Workload Console installation syntax (on Windows)
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]
Configuration information for the data source

    [--rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | DERBY]
    [--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]
Configuration options when --dbsslconnection=true or customized certificates are used for SSL connections

   [--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]
Dynamic Workload Console installation syntax (on UNIX)
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]
Configuration information for the data source

    [--rdbmstype|-r DB2 | DB2Z | ORACLE | MSSQL | IDS | ONEDB | DERBY]
    [--dbname db_name]
    [--dbuser db_user]
    [--dbpassword db_password]
    [--dbport db_port]
    [--dbhostname db_hostname]
    [--dbdriverpath db_driver_path]
    [--dbsslconnection true | false]
    --dbserver db_server
DB2 for z/OS-only configuration options
[--zlocationname  zOS_location_containing_db]
Configuration options when --dbsslconnection=true or customized certificates are used for SSL connections

   [--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]
Dynamic Workload Console installation syntax (on z/OS)
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]
Configuration information for the data source

    [--rdbmstype|-r DERBY | DB2Z]
    [--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]
Configuration options when --dbsslconnection=true or customized certificates are used for SSL connections

   [--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]

Dynamic Workload Console installation 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.
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 HCL 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
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 HCL Workload Automation.
Configuration information for the data source
--rdbmstype | -r rdbms_type
The database type. Supported databases are:
  • DB2
  • DB2Z
  • ORACLE
  • MSSQL This value applies to MSSQL,Azure SQL and Google Cloud SQL for SQL server.
  • IDS This value is supported only on UNIX operating systems. and applies to Informix.
  • ONEDB
  • DERBY
This parameter is optional. The default value is DERBY.
Note:

Supported configurations: HCL Workload Automation supports direct customer use of the Apache Derby database in test environments only. The product does not support direct customer use of Apache Derby database in production environments. The product supports the use of Apache Derby only by internal application server components in production environments.

For more information about creating the Dynamic Workload Console database, see Creating and populating the database.
--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 unless you are using Derby.
--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. 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 unless you are using Derby.
--dbhostname db_hostname
The host name or IP address of database server. This parameter is required unless you are using Derby.
--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. This value must always be false when --rdbmstype is DB2Z.

The default value is false.

--dbserver
Specifies the name of the Informix or OneDB database server. This parameter is required only if --rdbmstype is set to IDS or ONEDB and is supported only on UNIX operating systems.
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) , the key database (TWSClientKeyStore.kdb), and the truststore (TWSServerTrustFile.jks, TWSClientKeyStoreJKS.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, key database, 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. You can optionally encrypt the password using the secure script. For more information, see Optional password encryption - secure script.
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 alphanumeric, dash (-), underscore (_) characters, and ()|?=*~+.
Configuration information for the application server
--wlpdir
Specify the path where Open Liberty 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.

For a typical installation scenario, see Installing the Dynamic Workload Console servers.