Setting global options
Authorization
You must have the following
security permissions for the global options file in the HCL Workload Automation security
file to work with this command:
- For
optman ls
oroptman show
:FILE NAME=GLOBALOPTS ACCESS=DISPLAY
- For
optman chg
:FILE NAME=GLOBALOPTS ACCESS=MODIFY
Syntax
optman [-u | -v]
optman [connectionParams] chg {option | shortName} = value
optman [connectionParams] ls
optman [connectionParams] show {option | shortName}
Arguments
- connectionParams
- If you are using optman from the master domain manager,
the connection parameters were configured at installation and do not
need to be supplied, unless you do not want to use the default values.
If you are using optman from the command line client on another workstation, the connection parameters might be supplied by one or more of these methods:
- Stored in the
localopts
file - Stored in the
useropts
file - Supplied to the command in a parameter file
- Supplied to the command as part of the command string
- Stored in the
- chg {option | shortName} = value
- Change the value of an option to the new value supplied. The option can either be identified by its full or its short name. See Global options - summary for a table showing all of the options with their full and short names, value ranges and default values. See Global options - detailed description for a full description of each option.
- ls
- Lists the current values of all global options.
- show {option | shortName}
- Displays the current value of the indicated option. The option can either be identified by its full or its short name. See Global options - summary for a table showing all of the options with their full and short names, value ranges and default values. See Global options - detailed description for a full description of each option.
Comments
Some of the changes are effective immediately, but others require a specific action, such as running JnextPlan, restarting the WebSphere Application Server Liberty Base. These actions are indicated in the option descriptions. See User's Guide and Reference for more information on the JnextPlan command.
Users can decide to maintain an audit trail recording any changes they
perform and the related justifications. To enable the justification option, set up in a system shell
the HCL Workload Automation environment variables
listed below before running any optman commands:
- IWS_DESCRIPTION
- Specify the description to be recorded for each change performed by commands in the shell. The maximum length for this value is 512 characters. A warning message displays if you exceed the maximum and excess characters are truncated.
- IWS_CATEGORY
- Specify the category to be recorded for each change performed by commands in the shell. The maximum length for this value is 128 characters. A warning message displays if you exceed the maximum and excess characters are truncated.
- IWS_TICKET
- Specify the ticket to be recorded for each change performed by commands in the shell. The maximum length for this value is 128 characters. A warning message displays if you exceed the maximum and excess characters are truncated.
Examples
- Example 1: list the global options
- To list all of the global options, when your connection parameters
are supplied via the
localopts
anduseropts
files, give the following command:optman ls
- Example 2: show the value of a global option
- To show the current value of the
enCarryForward
global option, identifying it by its short name, give the following command:optman show cf
- Example 3: change the value of a global option
- To change the current value of the
enCarryForward
global option, identifying it by its full name, give the following command:optman chg enCarryForward no