Universal Command Manager Configuration Options

Owned by Former user (Deleted)
Last updated: Jan 05, 2023 by Stonebranch
5 min read

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

ACTIVITY_MONITORING

Specification for whether or not product activity monitoring events are generated.

ASSIGN_PROCESS_TO_JOB

Specification for whether or not UCMD Server assigns child processes to a single Windows job object.

BIF_DIRECTORY

Broker Interface Directory that specifies the location of the Universal Broker interface file

CA_CERTIFICATES

File name / ddname of the PEM-formatted trusted CA X.509 certificates.

CERTIFICATE

File name / ddname of UCMD Manager's PEM-formatted X.509 certificate.

CERTIFICATE_EXPIRATION_NOTICE

Number of days prior to certificate expiration to begin issuing informational messages about the expiration.

CERTIFICATE_REVOCATION_LIST

File name / ddname of the PEM-formatted CRL.

CODE_PAGE

Code page used for text translation.

COMMAND

Remote command to execute.

COMMAND_FILE_ENCRYPTED

Encrypted command file.

COMMAND_FILE_PLAIN

Plain text command file.

COMMAND_ID

Unique command ID associated the unit of work.

COMMAND_TYPE

Type of command specified with option COMMAND.

COMMENT

User-defined string.

CONNECT_RETRY_COUNT

Number of times a UCMD Manager will attempt to establish a connection with a remote Universal Broker.

CONNECT_RETRY_INTERVAL

Number of seconds between failed attempts to establish a connection with a remote Universal Broker.

CONNECT_TIMEOUT

Amount of time that a UCMD Manager will wait for a connection to a remote Universal Broker to complete.

CTL_SSL_CIPHER_LIST

SSL/TLS cipher list for the control session.

DATA_AUTHENTICATION

Specification for whether or not data integrity checks are performed on all standard I/O files.

DATA_COMPRESSION

Specification for whether or not data is compressed on all standard I/O files.

DATA_ENCRYPTION

Specification for whether or not data is encrypted on all standard I/O files.

DATA_SSL_CIPHER_LIST

SSL/TLS cipher list for the data sessions.

DEFAULT_CIPHER

Default SSL/TLS cipher used for data sessions.

DNS_EXPAND

Number of IP addresses returned to UCMD Manager following a DNS query issued to resolve a host name.

ELEVATE_USER_TOKEN

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

Encryption key used to decrypt an encrypted command file specified by option COMMAND_FILE_ENCRYPTED.

EVENT_GENERATION

Events to be generated as persistent events.

EXIT_CODE_MAP

Translates (maps) exit codes from user process to exit codes for UCMD Manager.

FORCE_COMPLETE

Specification to force a manager fault tolerant server in a PENDING communication state to COMPLETED state without retrieving the spooled data.

HELP

Displays a description of the command line options and their format.

HOST_SELECTION

Host in the REMOTE_HOST list that the UCMD Manager will choose to begin its attempts to connect to a remote Universal Broker.

HOSTNAME_RETRY_COUNT

Number of times that UCMD will attempt to resolve the host name of a specified Universal Broker before it ends with a connect error.

INSTALLATION_DIRECTORY

Base directory in which UCMD Manager is installed.

JOB_RETENTION

Specification of how long a restartable Server waits for a reconnect after the user process completes.

LOGIN

Specification for whether or not the command runs in a login environment.

MANAGER_FAULT_TOLERANT

Specification for whether or not the manager fault tolerant feature is used.

MESSAGE_LANGUAGE

Language of messages written.

MESSAGE_LEVEL

Level of messages written.

MFT_SAFE_MODE

Situations in which more than one host may be specified in the REMOTE_HOST list when manager fault tolerance (MFT) is enabled.

MIN_SSL_PROTOCOL

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.

MSG_SUPPRESSION_LIST

List of message IDs representing Universal messages to be suppressed.

NETWORK_DELAY

Maximum number of seconds considered acceptable to wait for data communications.

NETWORK_FAULT_TOLERANT

Specification for whether or not the network fault tolerant protocol is used.

NLS_DIRECTORY

Location of UMC and UTT files.

OUTBOUND_IP

Host or IP address to use for all outgoing IP connections.

PLF_DIRECTORY

Program Lock File directory that specifies the location of the UCMD Manager program lock file.

PRIVATE_KEY

ddname of Manager's PEM formatted RSA private key.

PRIVATE_KEY_PWD

Password for the Manager's PRIVATE_KEY.

RECONNECT_RETRY_COUNT

Maximum number of network fault tolerant reconnect attempts.

RECONNECT_RETRY_INTERVAL

Number of seconds between network fault tolerant reconnect attempts.

REMOTE_HOST

List of one or more hosts upon which a command may run.

REMOTE_PORT

TCP/IP port number of the remote computer on which Universal Broker is running and accepting connections.

RESTART

Specification for whether or not the manager is requesting restart.

SAF_KEY_RING

SAF certificate key ring name.

SAF_KEY_RING_LABEL

SAF key ring certificate label.

SCRIPT_FILE

Local script file to execute on the remote system.

SCRIPT_LINE_IGNORE_MASK

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.

SCRIPT_OPTIONS

Command line options passed to the script file.

SCRIPT_TYPE

Type of script file specified by option SCRIPT_FILE.

SERVER_OPTIONS

Universal Command Server options that can be overridden by Managers.

SERVER_STOP_CONDITIONS

Exit codes that cause Universal Broker to cancel the corresponding UCMD Server of the exited UCMD Manager.

SIO_DATA_AUTHENTICATION

Specification for whether or not data integrity checks are performed on a standard file.

SIO_DATA_COMPRESSION

Specification for whether or not data is compressed on a standard file, and if so, the method used.

SIO_DATA_ENCRYPTION

Specification for whether or not data is encrypted on a standard file.

SIO_LOCAL_CODE_PAGE

Code page used for local text translation on a standard file.

SIO_LOCAL_FILE

Local file used for a standard file instead of the default.

SIO_MODE

Translation mode of a standard file.

SIO_REMOTE_CODE_PAGE

Code page used for remote text translation on a standard file.

SIO_TRAILING_SPACES

Specification for whether not to read trailing spaces of z/OS fixed format records.

SSL_IMPLEMENTATION

SSL/TLS implementation.

STDERR_FILE_SPEC

Start of standard error file specification options.

STDIN_FILE_SPEC

Start of standard input file specification options.

STDOUT_FILE_SPEC

Start of standard output file specification options.

SYSTEM_ID

Local Universal Broker with which the UCMD Manager must register.

TRACE_FILE_LINES

Maximum number of lines written to a trace file before it wraps around.

TRACE_TABLE

Memory trace table specification.

UENCRYPTED_CODEPAGE

Character code page that Universal Command Manager uses to translate characters within a command file that has been encrypted with the Universal Encrypt utility.

UENCRYPTED_CODEPAGE_PATH

Location of the code page specified by the UENCRYPTED_CODEPAGE option.

USER_ID

User ID or account with which to execute the remote command.

USER_PASSWORD

Password associated with USER_ID.

VERIFY_HOST_NAME

Specification for whether or not the Broker's X.509 certificate host name field must be verified.

VERIFY_SERIAL_NUMBER

Specification for whether or not the Broker's X.509 certificate serial number field must be verified.

VERSION

Write program version.