Connection parameters

About this task

The connection parameters can be provided in one of three ways:
Define them as local options in the localopts file
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
Store some or all of them as user options in the useropts file
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.
The minimum set of properties you would find in useropts is as follows: 
username=user_ID
password=password

You can also add the JWT in the useropts file. See Setting user options for a full description of the file and the properties.

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>]
[-port <port_number>]
[-protocol {http|https}] 
[-proxy <proxy_name>]
[-proxyport <proxy_port_number>] 
[-jwt JSON Web Token]
[-username <username>]
[-password <user_password>] 
[-timeout <timeout>]
-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.
-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).
[-jwt JSON Web Token]
Specify the JWT to be used for authentication between the master domain manager and agents. You can retrieve the token from the Dynamic Workload Console. This parameter is mutually exclusive with the username and password parameters. The JWT authentication applies to the commands you launch in the shell where you specify the JWT.
You can use JWT when running the following commands:
  • composer
  • conman
  • wappman
[-username user_name]
An HCL Workload Automation user with sufficient privileges to perform the operation. This parameter is mutually exclusive with the jwt parameter.
[-password password]
The password of the HCL Workload Automation user. This parameter is mutually exclusive with the jwt parameter.
-timeout <timeout>
The number of seconds the command line client is to wait to make the connection before giving a timeout error.
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:
  1. First it looks for values supplied as parameters to the command
  2. Then, for any parameters it still requires, it looks for parameters supplied in the file identified by the -file parameter
  3. Then, for any parameters it still requires, it looks in the useropts file for the user
  4. 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.