Task Properties: Universal Command Task
Property |
UI Field Name |
Description |
Specifications |
Required |
Mutually Exclusive With |
---|---|---|---|---|---|
|
UCMD Agent |
If
|
|
N |
|
|
UCMD Agent Option |
Specification for how the name of the UCMD Agent is being specified in |
Valid values: Default is Agent (1). |
N |
|
|
UCMD Credentials |
Login credentials that Controller will use to access the remote machine where the UCMD Agent is running. |
|
N |
|
|
UCMD Credentials Variable |
Name of a variable that will be resolved at run time to the name of the UCMD Credentials to use. |
|
N |
|
|
UCMD Agent |
If |
|
N |
|
|
Command |
If |
Variables are supported. |
Y |
|
|
UCMD Options |
Any UCMD options needed by the program to execute properly. |
Variables are supported. |
N |
|
|
Command or Script |
Specification for whether a single command or a script is being executed. |
Valid values: Default is Command (1). |
N |
|
|
Output File |
Path and file name of the output file that should be scanned for the text in |
|
N |
|
|
Exit Code Processing |
Specification for how the Controller should determine whether the executed command failed or completed successfully. |
Valid values: Default is Success Exitcode (1). |
N |
|
|
Exit Codes |
If |
Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30. |
Y |
|
|
Scan Output For |
If exitCodeProcessing = Success Output Contains (3) or Failure Output Contains (4); text for which the Controller should scan the output file. |
The Controller will process this field as a regular expression. |
Y |
|
|
Failure Only |
If |
Boolean; Valid values: true/false. Default is false. |
N |
|
|
Output File |
If |
|
N |
|
|
Number of Lines |
If |
Default is the value of the Retrieve Output Default Maximum Lines Universal Controller system property. |
N |
|
|
Start Line |
If |
Default is 1. |
N |
|
|
Scan Text |
If |
The Controller will process this field as a regular expression. |
N |
|
|
Automatic Output Retrieval |
Specification for whether you want the Controller to automatically retrieve any output from the job and attach it to the task instance record. |
Valid values: Default is OUTERR (6). Note If |
N |
|
|
Output Type |
If |
Valid values: Default is STDOUT (1). |
N |
|
|
Retry Exit Codes |
Exit code range for which an auto-retry of the task in FAILED status will occur. Exit code ranges must be in the same format as ranges specified in |
Format = 1,5,22-30 |
N |
|
|
Retry Interval (Seconds) |
Number of seconds between each retry. |
Integer; Default is 60. |
N |
|
|
Maximum Retries |
Maximum number of times that the Controller should retry this task after it has started and gone to a failed state. |
Integer; Default is 0. |
N |
|
|
Suppress Intermediate Failures |
If the task instance is in the Failed status; Specification for whether or not the following will be suppressed until all scheduled retry attempts (a Maximum Retries value has been entered or Retry Indefinitely has been enabled) have been made:
|
Boolean; Valid values: true/false. Default is false. |
N |
|
|
Runtime Directory |
Directory from which the application should be executed. |
Variables are supported. |
N |
|
|
Script File |
If |
|
Y |
|
|
Script Options |
If |
|
N |
|
|
Wait For Output |
If |
Boolean; Valid values: true/false. Default is false. |
N |