...
The following table categorizes the configuration options 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. | |
Command or script to execute on the remote system. If a script is being executed, the script may reside on the local host on which the Manager is running or the remote host on which the Server is running. It also includes options to control the process environment in which the command executes. | |
Options used to define event generation. | |
Options that specify installation requirements, such as directory locations. | |
Options required for local broker registration. | |
Universal Command message options. | |
Options use to display command help and program versions. | |
Processing options for all the data transferred between the remote and local systems. | |
Alternative methods to specify command options. | |
Network address of the remote system and connection options. | |
Processing options for the standard files transferred between the remote and local systems. The STDFILE options are specified differently then the other options. There are three types of standard files: stderr, stdin, and stdout. Each standard file can have a different set of options applied. In order to distinguish between the standard files, the options must start with a standard file specification option (STDERR_SPEC, STDIN_SPEC, or STDOUT_SPEC). The standard file options (names starting with SIO_) follow the standard file specification option. | |
User account the command executes with on the remote system. |
Certificate Category Options
Option Name | Description |
Location of 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 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. |
Command Category Options
Option Name | Description |
Remote command to execute. | |
Unique command ID associated the unit of work. | |
Type of command specified with option COMMAND. | |
Allows exit codes from the user process executed by UCMD Server to be translated (mapped) to a corresponding exit code for UCMD Manager. | |
Specification for whether or not the command runs in a login environment. | |
Specification for whether or not manager fault tolerance is used. | |
Local script file to execute on the remote system. | |
Command line options passed to the script file. | |
Type of script file specified by option SCRIPT_FILE. |
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 UCMD Manager is installed. |
Local Category Options
Option Name | Description |
Broker Interface File (BIF) directory where the Universal Broker interface file is located. | |
Program Lock File (PLF) directory where the program lock files are located. |
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 | |
Maximum number of lines written to a trace file before it wraps around. | |
Memory trace table specification. |
Miscellaneous Category Options
Option Name | Description |
User-defined string. | |
Write command option help. | |
Write program version. |
Network Category Options
Option Name | Description |
Code page used for text translation. | |
SSL/TLS cipher list for the control session. | |
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. | |
Default SSL/TLS cipher used for data sessions. | |
Forces a manager fault tolerant server in a PENDING communication state to COMPLETED state without retrieving the spooled data. | |
Length of time that a Server waits for a reconnect after the user process completes. | |
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. | |
Specification for whether or not the network fault tolerant protocol is used. | |
Maximum number of network fault tolerant reconnect attempts. | |
Number of seconds between network fault tolerant reconnect attempts. | |
Specification for whether or not the manager is requesting restart. |
Options Category Options
Option Name | Description |
Specification for whether or not UCMD Server assigns child processes to a single Windows job object. | |
Encrypted command file. | |
Plain text command file. | |
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. | |
UCMD Server options that can be overridden by UCMD Managers. | |
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. |
Remote Category Options
Option Name | Description |
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. | |
Number of IP addresses returned to UCMD Manager following a DNS query issued to resolve a host name. | |
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. | |
Situations in which more than one host may be specified in the REMOTE_HOST list when manager fault tolerance (MFT) is enabled. | |
Host or IP address to use for all outgoing IP connections. | |
List of one or more hosts upon which a command may run. | |
TCP/IP port number of the remote Broker. |
Standard File Category Options
Option Name | Description |
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, how). | |
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. | |
Start of standard error file specification options. | |
Start of standard input file specification options. | |
Start of standard output file specification options. |
User Category Options
Option Name | Description |
User ID or account with which to execute the remote command. | |
Password associated with USER_ID. |
...
The following figure illustrates the command line syntax – using the command line, long form of the configuration options – of UCMD Manager for UNIX.
| Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Html bobswift | ucmd
{ -cmd Html bobswift | command [ -cmd_type Html bobswift | {<b>cmdref</b>|<b>shell</b>|<b>stc</b>cmdref|shell|stc} ] | -script Html bobswift | file [ -options Html bobswift | options] [ -script_type Html bobswift | type] } [ -host Html bobswift | hostlist [ -connect_retry_count Html bobswift | number] [ -connect_retry_interval Html bobswift | seconds] [ -connect_timeout Html bobswift | seconds] [ -dns_expand Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -host_selection Html bobswift | {<b>sequential</b>|<b>random</b>sequential|random} ] [ -mft_safe_mode Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -file Html bobswift | file | -encryptedfile Html bobswift | ddname [ -key Html bobswift | key] ] * [ -port Html bobswift | port] [ -userid Html bobswift | user [ -pwd Html bobswift | pwd] ] [ -hostname_retry_count Html bobswift | count] [ -outboundip
host] Html bobswift | <i>directory</i>]
-plf_directory Html bobswift | directory ] [ -server Html bobswift | options] [ -uencrypted_codepage
codepage] Html bobswift | codepage] [ -elevate_user_token Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -assign_process_to_job Html bobswift | option] [ -managerft Html bobswift | {yes|no} ] [ -cmdid Html bobswift | id] [ -login Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -lang Html bobswift | language ] [ -level Html bobswift | {<b>trace</b>|<b>audit</b>|<b>info</b>|<b>warn</b>|<b>error</b>trace|audit|info|warn|error}[,{<b>time</b>|<b>notime</b> time|notime} ] [ -msg_suppression_list Html bobswift | list ] [ -tracefilelines Html bobswift | lines] [ -trace_table Html bobswift | size,{error|always|never} ] [-ssl_implementation {openssl|system} ] [ -ca_certs Html bobswift | file [ -verify_host_name Html bobswift | {<b>yes</b>|<b>no</b>|<b>hostname</b>yes|no|hostname} ] [ -verify_serial_number Html bobswift | number] ] [ -cert
file -private_key Html bobswift | ddname [ -private_key_pwd Html bobswift | password] ] [ -days Html bobswift | Html bobswift | number] [ -crl file] [ -ctl_ssl_cipher_list Html bobswift | cipherlist] [ -data_ssl_cipher_list Html bobswift | cipherlist] [ -default_cipher Html bobswift | cipher] [ -forcecomplete Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -job_retention
Html bobswift | seconds] -min_ssl_protocol Html bobswift | option] [ -networkft Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -retry_count Html bobswift | number] [ -retry_interval Html bobswift | seconds] [ -restart Html bobswift | {<b>yes</b>|<b>no</b>|<b>auto</b>yes|no|auto} [ -managerft Html bobswift | {<b>yes</b>|<b>no</b>yes|no} [ -cmdid Html bobswift | id] ] ] [ -codepage Html bobswift | codepage] [ -compress Html bobswift | {<b>yes</b>|<b>no</b>yes|no}[,{<b>zlib</b>|<b>hasp</b> zlib|hasp} ] ] [ -encrypt Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -authenticate Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -stdin Html bobswift | | -stdout Html bobswift | | -stderr Html bobswift | ]
[-codepage Html bobswift | codepage] [ Html bobswift | -compress {<b>yes</b>|<b>no</b> yes|no}[,{<b>zlib</b>|<b>hasp</b> zlib|hasp} ] ] [ -encrypt Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -authenticate Html bobswift | {<b>yes</b>|<b>no</b>yes|no} ] [ -localfile Html bobswift | ddname] [ -mode Html bobswift | {<b>text</b>|<b>binary</b>text|binary}[,{<b>ucs</b>|<b>direct</b> ucs|direct} ] [ -remotecodepage Html bobswift | codepage] [ -exit_code_map Html bobswift | map] [ -comment Html bobswift | text] ucmd { -help Html bobswift | | -version Html bobswift | }
</pre>
|
* The command file (-file or -encryptedfile) can contain some or all required and/or optional configuration options, including -cmd (or -script) and -host.
If a command file is specified on the command line, and it contains the required -cmd (or -script) and -host options, those options do not have to be specified additionally on the command line.