Connection parameters

About this task

The connection parameters can be provided in one of three ways:

Define them in localopts

All fields except username and password, can be defined by editing the TWA_home/TWS/localopts properties file on the computer from which the access is required. See Setting local options for a full description of the file and the properties.

In localopts there is a section for the general connection properties, which contains the following:

host = host_name
protocol = protocol
port = port number
proxy = proxy server
proxyport = proxy server port number
timeout = seconds
defaultws = master_workstation
useropts = useropts_file

In addition, there are separate groups of SSL parameters which differ depending on whether your network is FIPS-compliant, and thus uses GSKit for SSL, or is not, and uses OpenSSL (see FIPS compliance for more details):

FIPS-compliant (GSKit)

CLI SSL keystore file = keystore_file_name
CLI SSL certificate keystore label = label
CLI SSL keystore pwd = password_file_name

Not FIPS-compliant (OpenSSL)

CLI SSL server auth = yes|no
CLI SSL cipher = cipher_class
CLI SSL server certificate =certificate_file_name
CLI SSL trusted dir =trusted_directory

Store some or all of them in useropts

As a minimum, the username and password parameters can be defined in the user_home/.TWS/useropts file for the user who needs to make the connection. Also, if you need to personalize for a user any of the properties normally found in the localopts file, add the properties to the useropts file. The values in the useropts file always take precedence over those in the localopts file. See Setting user options for a full description of the file and the properties.

The minimum set of properties you would find in useropts is as follows:

username=user_ID
password=password

Supply them when you use the command

When you use any of the commands you can add one or more of the connection parameters to the command string. These parameters take precedence over the parameters in localopts and useropts. This allows you, for example, to keep the parameters in the localopts file and just get users to supply the username and password parameters when they use one of the commands, avoiding the necessity to store this data in the useropts file for each user..

The parameters can either be supplied fully or partially in a file, to which you refer in the command string, or typed directly as part of the command string. The full syntax is as follows:

[-file <parameter_file> 
| 
[-host <host_name>]
 [-password <user_password>] 
 [-port <port_number>] 
 [-protocol {http|https}]
 [-proxy <proxy_name>]
 [-proxyport <proxy_port_number>] 
 [-timeout <timeout>]
 [-username <username>]

-file <parameter_file>: A file containing one or more of the connection parameters. Parameters in the file are superseded if the corresponding parameter is explicitly typed in the command.
-host <host_name>: The host name or IP address of the master domain manager to which you want to connect.
-password <user_password>: The password of the user supplied in the -username parameter.
-port <port_number>: The listening port of the master domain manager to which you want to connect.
-protocol {http|https}: Enter either http or https, depending on whether you want to make a secure connection.
-proxy <proxy_name>: The host name or IP address of the proxy server involved in the connection (if any).
-proxyport <proxy_port_number>: The listening port of the proxy server involved in the connection (if any).
-timeout <timeout>: The number of seconds the command line client is to wait to make the connection before giving a timeout error.
-username <username>: The user ID of the user making the connection.

Note:

From the command line, neither the default workstation, nor the command line client SSL parameters can be supplied. These must always be supplied in either the localopts (see Setting local options) or the useropts file for the user (see Setting user options).

For monitoring commands, such as conman showjobs, conman showresorces, and so on, HCL Workload Automation uses the connection parameters of the user logged on to the computer

The command line client needs to assemble a full set of parameters, and it does so as follows:

First it looks for values supplied as parameters to the command
Then, for any parameters it still requires, it looks for parameters supplied in the file identified by the -file parameter
Then, for any parameters it still requires, it looks in the useropts file for the user
Finally, for any parameters it still requires, it looks in the localopts file

If a setting for a parameter is not specified in any of these places an error is displayed.