Universal Control Manager for Windows
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 |
|---|---|
X.509 certificate related options. | |
Control command to execute. | |
Options used to define event generation. | |
Options that specify installation requirements, such as directory locations. | |
Universal Control message options. | |
Options use to display command help and program versions. | |
Options used to control the process of network data. | |
Alternative methods to specify command options. | |
Network address of the remote system. | |
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 |
|---|---|
Location of the PEM-formatted trusted CA X.509 certificates. | |
Location of Manager's PEM-formatted X.509 certificate. | |
Number of days prior to certificate expiration to begin issuing informational messages about the expiration. | |
Location of Manager's PEM-formatted CRL. | |
Location of Manager's PEM-formatted RSA private key. | |
Password for the Manager's PRIVATE_KEY. | |
Specification that the Universal Broker's X.509 certificate host name field must be verified. | |
Specification that the Universal Broker's X.509 certificate serial number field must be verified. |
Command Category Options
Option Name | Description |
|---|---|
Identity of the started component. | |
Instruction to a Broker to refresh configuration data. | |
Instruction to a Universal Broker to start a component. | |
Instruction to stop a component being executed by a Broker. |
Events Category Options
Option Name | Description |
|---|---|
Specification for whether or not product activity monitoring events are generated. | |
Events to be generated as persistent events. |
Installation Category Options
Option Name | Description |
|---|---|
Directory in which Universal Control Server is installed. |
Messages Category Options
Option Name | Description |
|---|---|
Language of messages written. | |
Level of messages written. | |
List of message IDs representing Universal messages to be suppressed. | |
Location of UMC and UTT files |
Miscellaneous Category Options
Network Category Options
Option Name | Description |
|---|---|
Code page used to translate text data to and from the network. | |
SSL/TLS cipher list for the control session. | |
Minimum SSL/TLS protocol level that will be negotiated and used for communications channels. | |
Maximum number of seconds considered acceptable to wait for data communications. |
Options Category Options
Option Name | Description |
|---|---|
Encrypted command file. | |
Plain text command file. | |
Encryption key used to decrypt an encrypted command file specified by option COMMAND_FILE_ENCRYPTED. |
Remote Category Options
Option Name | Description |
|---|---|
Number of host connection attempts before ending with an error. | |
Host or IP address to use for all outgoing IP connections. | |
TCP/IP host name of the remote Broker. | |
TCP/IP port number of the remote Broker. |
User Category Options
Option Name | Description |
|---|---|
User ID or account with which to execute the Control command. | |
Password associated with USER_ID. |
Command Line Syntax
The following figure illustrates the command options syntax — using the command line, long form of the configuration options — of Universal Control Manager for Windows.
uctl{ -start compname [-cmdid id] | -stop compID [-userid user [-pwd password] ] |-refresh [compname] }-host hostaddress[-file filename | -encryptedfile filename [-key key] ] *[-port port][-cmdid id][-hostname_retry_count count][-outboundip host][-lang language][-level {trace|audit|info|warn|error}][-msg_suppression_list list ][-ca_certs filename [-verify_host_name {yes|no|hostname}][-verify_serial_number number] ][-cert filename -private_key filename [-private_key_pwd password] ][-days number][-crl filename][-codepage codepage][-ctl_ssl_cipher_list cipherlist][-min_ssl_protocol option][-delay seconds]
uctl{ -help | -version }
* The command file (-file or -encryptedfile) can contain some or all required and/or optional configuration options, including a control request and -host. If a command file is specified on the command line, and it contains the required control request and -host options, those options do not have to be specified additionally on the command line.