Universal Command Manager Configuration Options
Overview
This page provides links to detailed information on the configuration options available for use with the Universal Command Manager.
The options are listed alphabetically, without regard to any specific operating system.
Configuration Options Information
For each configuration option, the following information is provided.
Description
Describes the option and how it is used.
Usage
Provides a table of the following information:
Method | Syntax | IBM i | UNIX | Windows | z/OS |
Command Line, Short Form | <Format / Value> | ||||
Command Line, Long Form | <Format / Value> | ||||
Environment Variable | <Format / Value> | ||||
Configuration File Keyword | <Format / Value> | ||||
STRUCM Parameter | <Format / Value> |
Method
Identifies the different methods used to specify Universal Command Manager configuration options:
- Command Line Option, Short Form
- Command Line Option, Long Form
- Environment Variable
- Configuration File Keyword
- STRUCM Parameter
Note
Each option can be specified using one or more methods.
Syntax
Identifies the syntax of each method that can be used to specify the option:
- Format: Specific characters that identify the option.
- Value: Type of value(s) to be supplied for this method.
Note
If a Method is not valid for specifying the option, the Syntax field contains n/a.
(Operating System)
Identifies the operating systems for which each method of specifying the option is valid:
- IBM i
- UNIX
- Windows
- z/OS
Values
Identifies all possible values for the specified value type.
Defaults are identified in [bracketed bold type].
<Additional Information>
Identifies any additional information specific to the option.
Configuration Options List
The following table identifies all Universal Command Manager configuration options.
Option | Description |
---|---|
Specification for whether or not product activity monitoring events are generated. | |
Specification for whether or not UCMD Server assigns child processes to a single Windows job object. | |
Broker Interface Directory that specifies the location of the Universal Broker interface file | |
File name / ddname of the PEM-formatted trusted CA X.509 certificates. | |
File name / ddname of UCMD Manager's PEM-formatted X.509 certificate. | |
Number of days prior to certificate expiration to begin issuing informational messages about the expiration. | |
File name / ddname of the PEM-formatted CRL. | |
Code page used for text translation. | |
Remote command to execute. | |
Encrypted command file. | |
Plain text command file. | |
Unique command ID associated the unit of work. | |
Type of command specified with option COMMAND. | |
User-defined string. | |
Number of times a UCMD Manager will attempt to establish a connection with a remote Universal Broker. | |
Number of seconds between failed attempts to establish a connection with a remote Universal Broker. | |
Amount of time that a UCMD Manager will wait for a connection to a remote Universal Broker to complete. | |
SSL/TLS cipher list for the control session. | |
CTL_SSL_CIPHER_SUITES | SSL/TLS 1.3 specific cipher suites that are acceptable to use for network communications on the control session, which is used for component internal communication. |
Specification for whether or not data integrity checks are performed on all standard I/O files. | |
Specification for whether or not data is compressed on all standard I/O files. | |
Specification for whether or not data is encrypted on all standard I/O files. | |
SSL/TLS cipher list for the data sessions. | |
DATA_SSL_CIPHER_SUITES | SSL/TLS 1.3 specific cipher suites that are acceptable to use for network communications on the data session, which is used for standard I/O file transmission. |
Default SSL/TLS cipher used for data sessions. | |
Number of IP addresses returned to UCMD Manager following a DNS query issued to resolve a host name. | |
Overrides the UCMD Server ELEVATE_USER_TOKEN configuration option that determines whether a Windows process executes with highest available privileges. This option allows a process to obtain a user access token that is not subject to User Account Control (UAC) restrictions. | |
Encryption key used to decrypt an encrypted command file specified by option COMMAND_FILE_ENCRYPTED. | |
Events to be generated as persistent events. | |
Translates (maps) exit codes from user process to exit codes for UCMD Manager. | |
Specification to force a manager fault tolerant server in a PENDING communication state to COMPLETED state without retrieving the spooled data. | |
Displays a description of the command line options and their format. | |
Host in the REMOTE_HOST list that the UCMD Manager will choose to begin its attempts to connect to a remote Universal Broker. | |
Number of times that UCMD will attempt to resolve the host name of a specified Universal Broker before it ends with a connect error. | |
Base directory in which UCMD Manager is installed. | |
Specification of how long a restartable Server waits for a reconnect after the user process completes. | |
Specification for whether or not the command runs in a login environment. | |
Specification for whether or not the manager fault tolerant feature is used. | |
MAX_SSL_PROTOCOL | Maximum SSL/TLS protocol level that will be negotiated and used for communications channels. |
Language of messages written. | |
Level of messages written. | |
Situations in which more than one host may be specified in the REMOTE_HOST list when manager fault tolerance (MFT) is enabled. | |
Minimum SSL/TLS protocol level that will be negotiated and used for communications channels. Note This option was introduced to IBM i in version 5.1.1.0. | |
List of message IDs representing Universal messages to be suppressed. | |
Maximum number of seconds considered acceptable to wait for data communications. | |
Specification for whether or not the network fault tolerant protocol is used. | |
Location of UMC and UTT files. | |
Host or IP address to use for all outgoing IP connections. | |
Program Lock File directory that specifies the location of the UCMD Manager program lock file. | |
ddname of Manager's PEM formatted RSA private key. | |
Password for the Manager's PRIVATE_KEY. | |
Maximum number of network fault tolerant reconnect attempts. | |
Number of seconds between network fault tolerant reconnect attempts. | |
List of one or more hosts upon which a command may run. | |
TCP/IP port number of the remote computer on which Universal Broker is running and accepting connections. | |
Specification for whether or not the manager is requesting restart. | |
SAF certificate key ring name. | |
SAF key ring certificate label. | |
Local script file to execute on the remote system. | |
Regular expression that is matched against each line of the script being sent to the remote system. Any line that matches the mask will be ignored and not sent to the remote system as part of the script. | |
Command line options passed to the script file. | |
Type of script file specified by option SCRIPT_FILE. | |
Universal Command Server options that can be overridden by Managers. | |
Exit codes that cause Universal Broker to cancel the corresponding UCMD Server of the exited UCMD Manager. | |
Specification for whether or not data integrity checks are performed on a standard file. | |
Specification for whether or not data is compressed on a standard file, and if so, the method used. | |
Specification for whether or not data is encrypted on a standard file. | |
Code page used for local text translation on a standard file. | |
Local file used for a standard file instead of the default. | |
Translation mode of a standard file. | |
Code page used for remote text translation on a standard file. | |
Specification for whether not to read trailing spaces of z/OS fixed format records. | |
SSL/TLS implementation. | |
Start of standard error file specification options. | |
Start of standard input file specification options. | |
Start of standard output file specification options. | |
Local Universal Broker with which the UCMD Manager must register. | |
Maximum number of lines written to a trace file before it wraps around. | |
Memory trace table specification. | |
Character code page that Universal Command Manager uses to translate characters within a command file that has been encrypted with the Universal Encrypt utility. | |
Location of the code page specified by the UENCRYPTED_CODEPAGE option. | |
User ID or account with which to execute the remote command. | |
Password associated with USER_ID. | |
Specification for whether or not the Broker's X.509 certificate host name field must be verified. | |
Specification for whether or not the Broker's X.509 certificate serial number field must be verified. | |
Write program version. |