Universal Command Server for Windows - Configuration

Configuration

UCMD Server configuration consists of defining runtime and default values. This section describes the UCMD Server configuration options.

Manager Override

A UCMD Manager can specify certain UCMD Server configuration options when it makes its request for command execution to the UCMD Server. The UCMD Manager command line option -server (SERVER_OPTIONS) is used to specify UCMD Server options.

Which options are available for manager override depend on the UCMD Server platform and release. UCMD Server configuration options specify a manager override option (see Universal Command Server Configuration Options) only if applicable. If override is not specified, no UCMD Manager override is available.

The UCMD Manager is not notified of override errors. The UCMD Server logs the error and continues processing the request.

Configuration File

The configuration file provides the simplest method of specifying configuration options whose values you do not want changed with each command invocation.

The UCMD Server configuration file name is specified in the UCMD Server component definition. The default name is ucmds.conf.

Although configuration files can be edited with any text editor (for example, Notepad), the Universal Configuration Manager application, accessible via the Control Panel, is the recommended way to set configuration options.

The Universal Configuration Manager provides a graphical interface and context-sensitive help, and helps protect the integrity of the configuration file by validating all changes to configuration option values.

Note

For any changes made directly to the UCMD Server configuration file to become active, a Universal Broker refresh is required, or the Universal Broker service must be restarted. Changes made by the Universal Configuration Manager do not require any additional action for the options to become active.

Configuration Options

The following table identifies all UCMD Server for Windows configuration options. Each Option Name is a link to detailed information about that option.

Option Name

Description

ACTIVITY_MONITORING

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

ALLOW_SPOOLING

Specification for whether or not spooling in permitted.

ASSIGN_PROCESS_TO_JOB

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

CMD_REFERENCE_DIRECTORY

Command reference directory.

CODE_PAGE

Code page used for text translation.

COMMAND_TYPE

Default command type.

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 control sessions.

ELEVATE_USER_TOKEN

Specification for whether or not the UCMD Server assigns an elevated user token to the child process that it executes. An elevated user token is one that is not subject to User Account Control (UAC) restrictions.

EVENT_GENERATION

Events to be generated and processed as persistent events.

INSTALLATION_DIRECTORY

Base directory in which UCMD Server is installed.

INTERACT_WITH_DESKTOP

Specification for whether or not the desktop of the current interactive logon session is accessible to the user process.

JOB_RETENTION

Number of seconds a disconnected server remains active after user process completes.

KEEPALIVE_INTERVAL

Specification for if and how often a keepalive message is sent.

LOGIN

Login information.

LOGON_METHOD

Method of how users are logged onto the system.

MESSAGE_LEVEL

Level of messages written.

MIN_SSL_PROTOCOL

Minimum SSL/TLS protocol level that will be negotiated and used for communications channels.

MSG_SUPPRESSION_LIST

List of message IDs representing Universal messages to be suppressed.

NLS_DIRECTORY

Location of UMC and UTT files.

SCRIPT_TYPE

Script type of the user job being run.

SPOOL_DIRECTORY

Location of spool files.

STDIO_TIMEOUT

Specifies the time in seconds to wait for Standard I/O to close before the server process exits.

TMP_DIRECTORY

Name of the directory used for temporary files.

TRACE_DIRECTORY

Location of trace files.

TRACE_FILE_LINES

Maximum number of lines to write to a trace file.

TRACE_TABLE

Memory trace table specification.

USER_SECURITY

Specification for whether or not user authentication is active.