Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

Field

Description

Server Override Options

Override the default Universal Command Server command type and set to
When this option is checked, the Univeral Command Manager will send the specified command type to a Universal Command Server, overriding the Server's configured value.
Leave this option unchecked to cause the remote Universal Command Server to use its configured default.
The command type specified here will depend on the platform and version of the remote Universal Command Server. Not all command types are available on all platforms. Also, the version of the remote Universal Command Server may not offer support for command types, or may only provide support for a subset of command types recognized by the installed version of Universal Command Manager.
The command types recognized by this version of Universal Command Manager for Windows includes (but is not limited to):

Html bobswift
<ul>
<li> cmdref <br>
Command reference 
<li> shell <br>
Shell 
<li> stc <br>
Started task </ul>

If the default command type you wish to use is not shown in this, you may still enter it here. The value will not be validated until it is sent to the Universal Command Server.
See the Universal Command Consolidated Documentation for a complete list of command types supported by a Universal Command Server on a particular platform.
 
Override the configured behavior of the Universal Command Server on windows and:
Check this option to set a flag within the Universal Command Manager's configuration file that overrides how the relationship among user processes is managed for a specified Universal Command Server on Windows. The Universal Command Server normally defines this relationship, but enabling this option allows the local Universal Command Manager to override the Server's configured default.
Leave this option unchecked to remove the value from the local Universal Command Manager's configuration, which causes the specified Universal Command Server to use its configured default.
Note: Checking this option does not set the configuration value itself; it only controls whether or not the Universal Configuration Manager sets the override in the Univeral Comand Manager's configuration file.
 
Assign all Server child processes to a single job object
Check this option to instruct a specified Windows Universal Command Server to assign the child process it creates – along with any descendants – to a single entity known as a job. Assigning a process to a job simplifies process management on Windows, by causing all child processes (that is, the requested user process and any of its child processes) to terminate whenever their parent is cancelled (that is, Universal Command Server).
When this option is unchecked, cancelling a Universal Command Server on Windows will only result in the termination of its immediate child processes. Any processes that child spawns will continue to run after the Server component is cancelled.
Note: Setting this option in the Universal Command Manager's configuration file overrides the configured value for any Windows Universal Command Server specified by the local Manager. This option is only recognized by Universal Command Servers 3.2.0.0 and later, running on Windows. It is ignored for all other platforms and versions.

Command ID

The command ID helps associate a Universal Command Server component with the Universal Command Manager that started it.
Any value may be specified for this option, but a UCMD Manager will fail when Manager fault tolerance is enabled, if another UCMD Manager with a matching command ID is active or awaiting restart. Set this option to an asterisk ( * ) to instruct UCMD to automatically generate a unique command ID each time it runs.

Exit code translation map

Field

Description

Event Generation Options

The exit_code_map option is used to translate the exit code issued by a user process (executed by UCMD Server) to a UCMD Manager exit code. The exit code map has the following format:
 
[exitStatus]range:exitCode[,...[exitStatusN]rangeN:exitCodeN]
 
exitStatus:
optional, may be 'a' or 'n'. Used to indicate whether the mapping applies to processes that end (a)bnormally or (n)ormally. If this parameter is not specified, the process's termination status is ignored.
 
Range:
The range of exit codes to be mapped. 'range' may be a single value, an series of values separated by a hyphen (for example, 1-5), or an upper or lower limit of values, preceded by the less than ('<') or the greater than ('>') symbol, respectively (for example, <20 or >20). An asterisk ('*') can be used to indicate all process exit codes.
 
exitCode:
The value UCMD Manager will return when the user process ends with a matching exit status and exit code.
Examples:

If the exit code from a user process matches more than one entry in the list, the first matching entry is applied.

Universal Command Manager: Event Subsystem Options

Image Removed

Generate activity monitoring events
When this option is selected, the Universal Command Manager will generate events that monitor product activity. This option is selected by default.
 
Persistent event list
Specifies which events are to be generated and processed as persistent events. A persistent event is saved in a Universal Enterprise Controller (UEC) event database for long-term storage.
 
Enter a list and/or range of numeric event types, separated by a comma. To exclude an event or range of events, precede the entry with an upper- or lower-case 'X'. Use an asterisk (star) to specify all event types.
 
For example:

Html bobswift
<ul>
<li> n*:1,a*:16  <br>
Map all normal terminations to exit code 1 and all abnormal terminations to exit code 16. 
<li> 1-5:1,>5:2 <br>
Map exit codes 1 thru 5 (inclusive) to exit code 1 and exit codes greater than 5 to exit code 2. 
<li> <0:64,>1:1 <br>
Map exit codes less than 0 to exit code 64 and exit codes greater than 1 to 1 
</ul>

If the exit code from a user process matches more than one entry in the list, the first matching entry is applied.

Universal Command Manager: Event Subsystem Options

Image Added

Field

Description

Event Generation Options

Generate activity monitoring events
When this option is selected, the Universal Command Manager will generate events that monitor product activity. This option is selected by default.
 
Persistent event list
Specifies which events are to be generated and processed as persistent events. A persistent event is saved in a Universal Enterprise Controller (UEC) event database for long-term storage.
 
Enter a list and/or range of numeric event types, separated by a comma. To exclude an event or range of events, precede the entry with an upper- or lower-case 'X'. Use an asterisk (star) to specify all event types.
 
For example:

Html bobswift
<ul>
<li>x*<br>
Do not generate any events (this is the default)
<li>*<br>
Generate all event types 
<li>100<br>
Generate all event types except 100 
<li>100,200-205<br>
Generate event type 100 and 200 through 205
<li>100,200-205,x202<br>
Generate event types 100 and 200 thru 205, excluding event type 202 
</ul>

Entries are processed from left to right, and the list is order dependent. For example, an entry of x*,100 prevents generation of all event types except 100, while an entry of 100,x* prevents generation of all event types (the right-most entry takes precedence).

...