1 Introduction
2 Command Prompt
3 Universal Configuration Manager
4 Control Requests
5 Configuration
- 5.1 Configuration Sources
  - 5.1.1 Configuration File
- 5.2 Configuration Options Categories
  - 5.2.1 Certificate Category Options
  - 5.2.2 Command Category Options
  - 5.2.3 Events Category Options
  - 5.2.4 Installation Category Options
  - 5.2.5 Messages Category Options
  - 5.2.6 Miscellaneous Category Options
  - 5.2.7 Network Category Options
  - 5.2.8 Options Category Options
  - 5.2.9 Remote Category Options
  - 5.2.10 User Category Options
6 Command Line Syntax

Introduction

This Universal Control (UCTL) Manager information is specific to the Windows operating system.

UCTL Manager for Windows is a console application that can be run either from:

Command prompt
Universal Configuration Manager

Command Prompt

UCTL Manager runs as a command line program. It provides a command line interface to remote computers running the UCTL Server. On the command line, you must specify the control request that you want the UCTL Manager to execute.

Universal Configuration Manager

The Universal Configuration Manager provides a single interface from which active components can be listed and selected for termination. A list of active components can be obtained from any machine that is running Universal Broker.

Control Requests

UCTL Manager for Windows supports all three Universal Control control requests:

Start (START_CMD option)
Stop (STOP_CMD option)
Refresh (REFRESH_CMD option)

One of these control request options must be specified on the command line (or in a command file) for each execution of Universal Control Manager.

Configuration

Configuration consists of:

Setting default options and preferences for all executions of UCTL Manager.
Setting options and preferences for a single execution of UCTL Manager.

Configuration Sources

Configuration options are read from the following sources:

Command line
Command file
Environment variables
Configuration file

The order of precedence is the same as the list above; command line being the highest, and configuration file being the lowest. That is, options specified via a command line override options specified via a command file, and so on. The UCTL Manager configuration file is provided to the manager by the local Universal Broker with which it registers.

Detailed information on these methods of configuration can be found in Configuration Management.

Configuration File

The configuration file, uctl.conf, provides the simplest method of specifying configuration options whose values will not change with each command invocation. These default values are used if the options are not read from one or more other sources.

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.

Some options only can be specified in the configuration file; they have no corresponding command line equivalent. Other options cannot be specified in the configuration file; they must be specified via one or more other sources for a single execution of UCTL Manager.

Note

For any changes made directly to the UCTL Manager 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 Categories

The following table categorizes configuration options used to execute Universal Control Manager for Windows into logical areas of application. Each Category name is a link to a table of options in that category. Each Option Name in those tables is a link to detailed information about that option.

Category	Description

Category	Description
Certificates	X.509 certificate related options.
Command	Control command to execute.
Events	Options used to define event generation.
Installation	Options that specify installation requirements, such as directory locations.
Messages	Universal Control message options.
Miscellaneous	Options use to display command help and program versions.
Network	Options used to control the process of network data.
Options	Alternative methods to specify command options.
Remote	Network address of the remote system.
User	User account the Control command executes with on the remote system.

The Universal Control Manager command options for each of the categories listed above are summarized in the following tables.

Certificate Category Options

Option Name	Description

Option Name	Description
CA_CERTIFICATES	Location of the PEM-formatted trusted CA X.509 certificates.
CERTIFICATE	Location of 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	Location of Manager's PEM-formatted CRL.
PRIVATE_KEY	Location of Manager's PEM-formatted RSA private key.
PRIVATE_KEY_PWD	Password for the Manager's PRIVATE_KEY.
VERIFY_HOST_NAME	Specification that the Universal Broker's X.509 certificate host name field must be verified.
VERIFY_SERIAL_NUMBER	Specification that the Universal Broker's X.509 certificate serial number field must be verified.