...
Description | Cancels the specified task instance.
See Cancelling a Task Instance for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-cancel global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name]
|
|---|
Parameter |
|---|
Description | Clears all dependencies of a task instance. |
|---|
Syntax | uagcmd ops-task-clear-dependencies global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name]
|
|---|
Parameters | task-instance-id=
Required if task| Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | |
|---|
...
| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on. |
<li><code>task-instance-name= |
Required if task</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If |
<code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.) |
<li><code>instance-criteria= |
Optional, if task</code> <br> Optional if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): |
<b>oldest_instance</b>, <b>newest_active_ |
instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name= |
For a task instance in a workflow, optional; Name of the workflow instance. | Example | panel</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul> | |
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-cancel |
-c config.cfg | Html bobswift |
|---|
task-instance-name=Task A </pre> |
|
|
|---|
...
| dependencies | | ops-task-clear- |
|---|
|
...
Clear ...
All Dependencies
Description | Clears all virtual resource dependencies of a task instance. |
|---|
Syntax | uagcmd ops-task-clear-resourcesdependencies global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name] resource-name=name
|
|---|
Parameters | task-instance-id=
Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.task-instance-name=
Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)instance-criteria=
Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.workflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance.resource-name=
Required; One of the following:- Name of the virtual resource dependency to clear.
- An asterisk ( * ) to clear all virtual resource dependencies.
|
|---|
Example | panelExample | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-clear-dependencies |
-c config.cfg | Html bobswift |
|---|
task-instance-name=Task A </pre> |
|
|
|---|
...
...
Clear ...
Virtual Resource Dependencies
...
Description | Clears all exclusive virtual resource dependencies of a task instance. |
|---|
Syntax | uagcmd ops-task-clear-exclusiveresources global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name] resource-name=name
|
|---|
Parameters | task-instance-id=
Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.task-instance-name=
Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)instance-criteria=
Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.workflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance.
|
|---|
Example | |
|---|
...
resource-name=
Required; One of the following:- Name of the virtual resource dependency to clear.
- An asterisk ( * ) to clear all virtual resource dependencies.
|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-clear-resources |
-c config.cfg | Html bobswift |
|---|
task-instance-name=Task A resource-name=Resource A</pre> |
|
|
|---|
...
...
Clear ...
Exclusive Dependencies
Description | Clears the time dependency all exclusive dependencies of a task instance. |
|---|
Syntax | uagcmd ops-task-clear-timewaitexclusive global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name]
|
|---|
Parameters | task-instance-id=
Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.task-instance-name=
Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)instance-criteria=
Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.workflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance.
|
|---|
Example | |
|---|
...
| bobswift |
|---|
<pre>uagcmd ops-task-clear-exclusive |
-c config.cfg | Html bobswift |
|---|
task-instance-name=Task A </pre> |
|
|
...
...
Clear Time DependencyDescription | Displays all specified tasksClears the time dependency of a task instance. |
|---|
Syntax | uagcmd ops-task-
listclear-timewait global parameters {task-instance-id=ID | task-instance-name=name} [
taskinstance-
typecriteria=
type]
| Parameters | task-name=
Optional; Name or partial name of one or more tasks. Wildcards are supported.task-type=
Optional; criteria] [workflow-instance-name=name]
|
|---|
Parameters | task-instance-id=
Required if task-instance-name= is not specified; sys_id of the task instance to run the command on.task-instance-name=
Required if task-instance-id= is not specified; Name of the task instance to run the command on. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)instance-criteria=
Optional, if task-instance-name= is specified; One of the following (not case-sensitive): application_control, email, email_monitor, agent_file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, peoplesoft, sql, stored_procedure, system_monitor, task_monitor, timer, unix, variable_monitor, web_service, windows, workflow, zos oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.workflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance.
|
|---|
Example | |
|---|
...
| bobswift |
|---|
<pre>uagcmd ops-task-clear- |
|
|
...
...
| Anchor |
|---|
| ops-task-list |
|---|
| ops-task-list |
|---|
|
Display All TasksDescription | Displays the status of all task instance(s) associated with the specified taskspecified tasks. |
|---|
Syntax | uagcmd ops-task-statuslist global parameters task-instance-name=name [agent-name=name] [task-type=type] [task-status=status] [{workflow-instance-id=id] | [workflow-instance-name=name}] [workflow-instance-criteria=criteria] [options=v]
| Note |
|---|
| For backward-compatibility, you can exclude uagcmd
|
|---|
Parameters | task-name=
Optional; Name or partial name of one or more tasks. Wildcards are supported.
| Warning |
|---|
| title | DeprecatedReplaced by instance-name= parameter; the command first will check for task-name=; if it is not specified, the command will check for task-instance-name=.Wildcards
task status codes and/or names
|---|
Example | |
|---|
...
The following table describes all possible task instance statuses for all task types.
| Note |
|---|
|
The format of multi-word task status names specified in the Task Instance Status CLI function differs from the format of task status names used in the Controller user interface. In Task Instance Status, the words are separated by an underscore character; in the user interface, they are separated by a space. |
...
Status Name
...
Status Code
...
Task Type
...
Description
...
Action_Required
...
60
...
Manual
...
When a manual task launches, it goes into Action Required status, meaning a user must perform some manual activity. For details, see Manual task.
...
Cancel_Pending
...
99
...
Agent-based
...
A process running on the Agent needs to be terminated. When the Cancel command is issued, the task instance will go into a Cancel Pending status until the Agent reports back that the process has been cancelled. At that point, the task instance will transition into the Cancelled status.
...
Cancelled
...
130
...
All
...
The task was cancelled by a user.
...
Confirmation_Required
...
125
...
z/OS
...
If you make JCL changes and restart a z/OS task, Universal Controller will put the task into Confirmation Required status and prompt you for a confirmation. For detailed processing steps, see Rerunning a z/OS Task.
...
0
...
All
...
The new task instance has been created (the task has been launched).
...
Exclusive_Requested
...
22
...
All
...
All tasks with a mutually exclusive task defined go immediately to a status of Exclusive Requested. If the task is available to run exclusively, the task then moves to the next appropriate processing status.
...
Exclusive_Wait
...
23
...
All
...
The task is mutually exclusive with one or more other tasks, and it is waiting for those tasks to finish before it will run.
...
Execution_Wait
...
33
...
Agent-based
...
The task must wait to be completed; either the Agent/Agent Cluster running the task has reached its Task Execution Limit, or the ability of the Agent/Agent Cluster to run tasks has been suspended.
...
Failed
...
140
...
All*
...
The task ran to a failure status.
...
190
...
All
...
The task was forced by the user to finish. The user may do this in cases where the task had a Cancelled or Failed status, and the user needed to release other task instances depending on the successful completion of this task instance in a workflow. For more information, see Force Finishing a Task.
...
20
...
All
...
The task has been put on hold by a user.
...
In_Doubt
...
110
...
Agent-based
...
The Agent is "in doubt" about the current status of the task instance. This may occur if an Agent or Agent connection goes down. In this case, the Agent restarts and reviews its data about tasks in progress. If the Agent finds a task still running, it resumes normal monitoring. If the Agent cannot find the task, this usually indicates that the task completed, but the Agent considers the task status to be "in doubt."
...
Queued
...
40
...
Agent-based
...
The task has been queued on a resource.
...
Resource_Requested
...
25
...
All
...
All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is available, the task then moves to the next appropriate processing status.
...
Resource_Wait
...
30
...
All
...
All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is not available, the task goes to a status of Resource Wait. When the resource becomes available, the task moves to the next appropriate processing status
...
80
...
All
...
The task is running. For Agent-based tasks, the Agent has started running the program.
...
81
...
Workflow
...
One or more tasks within the workflow has one of the following statuses:
- Cancelled
- Confirmation Required
- Failure
- In Doubt
- Running/Problems (for sub-workflows)
- Start Failure
- Undeliverable
...
Skipped
...
180
...
All
...
The task was skipped by a user.
...
120
...
All
...
The task was unable to start.
...
70
...
Agent-based, Manual
...
The task has started. For Agent-based tasks, this means the Agent has received the task.
...
Submitted
...
43
...
z/OS
...
The task has been submitted to the z/OS Job Entry subsystem and scheduled by the z/OS Job Scheduler.
...
200
...
All
...
The task has completed successfully. Workflows will transition to Success status when all of its tasks have transitioned to Success, Finished, or Skipped status.
...
15
...
All (except Timer)
...
The task is waiting to start based on a Wait To Start and/or Delay On Start specification.
...
Undeliverable
...
35
...
Agent-based
...
The Agent is unavailable.
...
Waiting
...
10
...
All
...
The task has been loaded by a workflow and is waiting on a predecessor.
* Workflows cannot go to Failed status.
...
Description
...
Force finishes the specified task instance.
See Force Finishing a Task Instance for a description of behavior and restrictions.
...
Syntax
...
uagcmd ops-task-forcefinish global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name]
...
Parameter
...
internal Universal Controller identifier
| Warning |
|---|
|
Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
...
Example
...
...
Description
...
Launches the specified task(s).
...
Syntax
...
uagcmd ops-task-launch global parameters [task-type=type] task-name=name {time-zone=Australia/Sydney] [hold=option] [task-variables=variables] [virtual-resource-priority=priority] [virtual-resources=resources]
...
Parameters
...
...
Example
...
(All variable=value pairs must be specified within one set of braces.)
...
Description | Puts the specified task instance on hold.
See Putting a Task Instance on Hold for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-hold type=
Optional; One of the following (not case sensitive): application_control, email, email_monitor, agent_file_monitor, ftp, remote_file_monitor, indesca / universal_command / ucmd, manual, sap, peoplesoft, sql, stored_procedure, system_monitor, task_monitor, timer, unix, variable_monitor, web_service, windows, workflow, zos.
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-list |
-c config.cfg | Html bobswift |
|---|
task-name=Task A task-type=timer </pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-status |
|---|
| ops-task-status |
|---|
|
Display Task Instance StatusDescription | Displays the status of all task instance(s) associated with the specified task. |
|---|
Syntax | uagcmd ops-task-status global parameters task-instance-name=name [agent-name=name] [task-type=type] [task-status=status] [{workflow-instance-id=id] | [workflow-instance-name=name}] [workflow-instance-criteria=criteria] [options=v]
|
|---|
Parameters | | Html bobswift |
|---|
<ul>
<li> <code>task-name=</code> <br>Required; Name or partial name of one or more tasks. |
Wildcards are supported.
| Warning |
|---|
| Replaced by task-instance-name= parameter; the command first will check for task-name=; if it is not specified, the command will check for task-instance-name=. |
| Html bobswift |
|---|
<li> <code>task-instance-name=</code> <br>Optional; Name of the task instance(s) to be listed. |
Wildcards | Html bobswift |
|---|
are supported.
<li> <code>agent-name=</code> <br>Optional; Name of the agent the task instance(s) are running on.
<li> <code>task-type=</code> <br>Optional; One of the following (not case sensitive): <b>application_control</b>, <b>email</b>, <b>email_monitor</b>, <b>agent file_monitor</b>, <b>ftp</b>, <b>remote_file_monitor</b>, <b>indesca</b> / <b>universal_command</b> / <b>ucmd</b>, <b>manual</b>, <b>sap</b>, <b>peoplesoft</b>, <b>sql</b>, <b>stored_procedure</b>, <b>system_monitor</b>, <b>task_monitor</b>, <b>timer</b>, <b>unix</b>, <b>variable_monitor</b>, <b>web_service</b>, <b>windows</b>, <b>workflow</b>, <b>zos</b>.
<li> <code>task-status=</code> <br>Optional; List of comma-separated |
task status codes and/or names | Html bobswift |
|---|
(not case sensitive): <i>status code or name</i>,<i>status code or name</i>,...,<i>status code or name</i>. An exclamation mark (!) preceding a task status code or name excludes task instances with that status.
<li> <code>workflow-instance-id=</code> <br>For a task instance in a workflow, optional if <code>workflow-instance-name=</code> is not specified; sys_id of the workflow instance.
<li> <code>workflow-instance-name=</code> <br>For a task instance in a workflow, optional if <code>workflow-instance-id=</code> is not specified; Name of the workflow instance. (If <code>workflow-instance-criteria=</code> is not specified, the oldest active Workflow instance with the matching name will apply.)
<li> <code>workflow-instance-criteria=</code> <br>Optional, if <code>workflow-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>.
<li> <code>options=</code> <br>Optional; <b>v</b> (Return verbose results.)
</ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-status |
-c config.cfg | Html bobswift |
|---|
task-instance-name=mantask agent-name=managent task-type=manual</pre> |
|
|
|---|
The following table describes all possible task instance statuses for all task types.
| Note |
|---|
|
The format of multi-word task status names specified in the Task Instance Status CLI function differs from the format of task status names used in the Controller user interface. In Task Instance Status, the words are separated by an underscore character; in the user interface, they are separated by a space. |
Status Name | Status Code | Task Type | Description |
|---|
Action_Required | 60 | Manual | When a manual task launches, it goes into Action Required status, meaning a user must perform some manual activity. For details, see Manual task. |
Cancel_Pending | 99 | Agent-based | A process running on the Agent needs to be terminated. When the Cancel command is issued, the task instance will go into a Cancel Pending status until the Agent reports back that the process has been cancelled. At that point, the task instance will transition into the Cancelled status. |
Cancelled | 130 | All | The task was cancelled by a user. |
Confirmation_Required | 125 | z/OS | If you make JCL changes and restart a z/OS task, Universal Controller will put the task into Confirmation Required status and prompt you for a confirmation. For detailed processing steps, see Rerunning a z/OS Task. |
| 0 | All | The new task instance has been created (the task has been launched). |
Exclusive_Requested | 22 | All | All tasks with a mutually exclusive task defined go immediately to a status of Exclusive Requested. If the task is available to run exclusively, the task then moves to the next appropriate processing status. |
Exclusive_Wait | 23 | All | The task is mutually exclusive with one or more other tasks, and it is waiting for those tasks to finish before it will run. |
Execution_Wait | 33 | Agent-based | The task must wait to be completed; either the Agent/Agent Cluster running the task has reached its Task Execution Limit, or the ability of the Agent/Agent Cluster to run tasks has been suspended. |
Failed | 140 | All* | The task ran to a failure status. |
| 190 | All | The task was forced by the user to finish. The user may do this in cases where the task had a Cancelled or Failed status, and the user needed to release other task instances depending on the successful completion of this task instance in a workflow. For more information, see Force Finishing a Task. |
| 20 | All | The task has been put on hold by a user. |
In_Doubt | 110 | Agent-based | The Agent is "in doubt" about the current status of the task instance. This may occur if an Agent or Agent connection goes down. In this case, the Agent restarts and reviews its data about tasks in progress. If the Agent finds a task still running, it resumes normal monitoring. If the Agent cannot find the task, this usually indicates that the task completed, but the Agent considers the task status to be "in doubt." |
Queued | 40 | Agent-based | The task has been queued on a resource. |
Resource_Requested | 25 | All | All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is available, the task then moves to the next appropriate processing status. |
Resource_Wait | 30 | All | All tasks with a virtual resource defined go immediately to a status of Resource Requested. If the resource is not available, the task goes to a status of Resource Wait. When the resource becomes available, the task moves to the next appropriate processing status |
| 80 | All | The task is running. For Agent-based tasks, the Agent has started running the program. |
| Anchor |
|---|
| Running/Problems |
|---|
| Running/Problems |
|---|
|
Running/Problems | 81 | Workflow | One or more tasks within the workflow has one of the following statuses: - Cancelled
- Confirmation Required
- Failure
- In Doubt
- Running/Problems (for sub-workflows)
- Start Failure
- Undeliverable
|
Skipped | 180 | All | The task was skipped by a user. |
| Anchor |
|---|
| Start Failure |
|---|
| Start Failure |
|---|
|
Start Failure | 120 | All | The task was unable to start. |
| 70 | Agent-based, Manual | The task has started. For Agent-based tasks, this means the Agent has received the task. |
Submitted | 43 | z/OS | The task has been submitted to the z/OS Job Entry subsystem and scheduled by the z/OS Job Scheduler. |
| 200 | All | The task has completed successfully. Workflows will transition to Success status when all of its tasks have transitioned to Success, Finished, or Skipped status. |
| 15 | All (except Timer) | The task is waiting to start based on a Wait To Start and/or Delay On Start specification. |
Undeliverable | 35 | Agent-based | The Agent is unavailable. |
Waiting | 10 | All | The task has been loaded by a workflow and is waiting on a predecessor. |
* Workflows cannot go to Failed status.
| Anchor |
|---|
| ops-task-forcefinish |
|---|
| ops-task-forcefinish |
|---|
|
Force Finish a TaskDescription | Force finishes the specified task instance.
See Force Finishing a Task Instance for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-forcefinish global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name]
|
|---|
Parameter | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-forcefinish |
-c config.cfg | Html bobswift |
|---|
task-instance-id=90079020d861e5e40128cbb3cdbe1cf3</pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-launch |
|---|
| ops-task-launch |
|---|
|
Launch a TaskDescription | Launches the specified task(s). |
|---|
Syntax | uagcmd ops-task-launch global parameters [task-type=type] task-name=name {time-zone=Australia/Sydney] [hold=option] [task-variables=variables] [virtual-resource-priority=priority] [virtual-resources=resources]
|
|---|
Parameters | | Html bobswift |
|---|
<ul>
<li> <code>task-type</code>= <br>Optional; One of the following (not case sensitive): <b>timer</b>, <b>windows</b>, <b>unix</b>, <b>zos</b>, <b>agent_file_monitor</b>, <b>manual</b>, <b>email</b>, <b>email_monitor</b>, <b>ftp</b>, <b>sql</b>, <b>remote_file_monitor</b>, <b>task_monitor</b>, <b>stored_procedure</b>, <b>workflow</b>, <b>sap</b>, <b>peoplesoft</b>, <b>system_monitor</b>, <b>indesca</b> / <b>universal_command</b> / <b>ucmd</b>, <b>web_service</b>, <b>application_control</b>.
<li> <code>task-name=</code> <br>Required; Valid task name. |
Wildcards | Html bobswift |
|---|
are supported.
<li> <code>time-zone=</code> <br>Optional; Time zone in which the task is launched.
<li> <code>hold=</code> <br>Optional; Specification for whether to place the task in |
Held | Html bobswift |
|---|
status when it is launched. Valid values are (not case sensitive): yes/y/true.
<li> <code>task-variables=</code> <br>Optional; Any variables specified in the task that need a value to run properly.
<li> <code>virtual-resource-priority=</code> <br>Optional;
Virtual resource priority of the task instance. Valid values are any integer between 1 and 20. Defaults to the virtual resource priority defined in the task Details.
<li> <code>virtual-resources=</code> <br>Optional;
Comma-separated list of <resource-name>:<amount> pairs. For example, <b>VR1:10,VR2:20,...,VRN:N</b>. An amount of <b>0</b> indicates the virtual resource should be dropped. Defaults to virtual resources defined in the task Details.
<br><br>
The virtual resource dependencies specified in <code>virtual-resources=</code> are merged with the default virtual resource dependencies.
<ul>
<li>If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
<li> Any virtual resource specified with an amount of <b>0</b> is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
<li> If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added.
</ul></ul> |
|
|---|
Example | (All variable=value pairs must be specified within one set of braces.)
| Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-launch |
-c config.cfg | Html bobswift |
|---|
task-name=Windows Task A task-variables={variable1=first value variable2=second value} </pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-hold |
|---|
| ops-task-hold |
|---|
|
Put Task on HoldDescription | Puts the specified task instance on hold.
See Putting a Task Instance on Hold for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-hold global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name]
|
|---|
Parameter | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-hold |
-c config.cfg | Html bobswift |
|---|
task-instance=90079020d861e5e40128cbb3cdbe1cf3</pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-release |
|---|
| ops-task-release |
|---|
|
Release a Task from HoldDescription | Releases the specified task instance from hold.
See Releasing a Task Instance from Hold for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-release global parameters {task-instance-id=ID | task-instance-id=name} [instance-criteria=criteria] [workflow-instance-name] [recursive=option]
|
|---|
Parameter | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
<li><code>recursive=</code> <br> Optional; Specification (yes or no), if the task instance specified in <code>task-instance-id=</code> or <code>task-instance-name=</code> is a workflow, for whether or not to release the held workflow recursively. (Default is no.) If the task instance is not a workflow, <code>recursive=</code> is ignored.
</ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-release |
-c config.cfg | Html bobswift |
|---|
task-instance-id=90079020d861e5e40128cbb3cdbe1cf3 </pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-rerun |
|---|
| ops-task-rerun |
|---|
|
Rerun a TaskDescription | Reruns the specified Task instance.
See Re-running a Task Instance for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-rerun global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name] {[task-status=status [recursive=option]]}
|
|---|
Parameter | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br> Optional; Name of the workflow instance.
<li><code>task-status=</code> <br> Optional; list of comma-separated status codes or case-insensitive status names (see below). Format: <:status-code-or-name>,<status-code-or-name>,...,<status-code-or-name>. Applicable only if matched task instance is workflow type; command will fail otherwise.
<br><br>
All tasks within the matching workflow with a matching status will be queued for re-run. Sub-workflows do not support re-run directly; the <code>recursive=</code> parameter controls whether or not tasks within sub-workflows matching the status will be queued for re-run.
<ul>
<li> Start_Failure (120)
<li> Cancelled (130)
<li> Failed (140)
<li> Finished (190)
<li> Success (200)
</ul>
<li><code>recursive=</code> <br> Optional if <code>task-status=</code> is specified; One of the following (not case-sensitive): Yes|Y|true or No|N|false (default). Indicates whether or not tasks within sub-workflows will qualify for re-run. </ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-rerun |
-c config.cfg | Html bobswift |
|---|
task-instance=8fda93dcd861e5e4005bf48e2cad6206 task-status=140</pre> |
|
|
|---|
| Anchor |
|---|
| ops-manual-setstarted |
|---|
| ops-manual-setstarted |
|---|
|
Set Manual Task to StartedDescription | For a Manual task, changes its status from Action Required to Started. This allows you to acknowledge the Manual task and indicate that the manual procedures have been started. |
|---|
Syntax | uagcmd ops-manual-setstarted global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name]
|
|---|
Parameter | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-manual-setstarted |
-c config.cfg | Html bobswift |
|---|
task-instance=8fda93dcd861e5e4005bf48e2cad6206 </pre> |
|
|
|---|
| Anchor |
|---|
| ops-manual-setcompleted |
|---|
| ops-manual-setcompleted |
|---|
|
Set Manual Task to SuccessDescription | For a Manual task, sets its status to Success. |
|---|
Syntax | uagcmd ops-manual-setcompleted global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name]
| Parameter |
|---|
Parameter | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | |
|---|
...
Description | Releases the specified task instance from hold.
See Releasing a Task Instance from Hold for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-release global parameters {task-instance-id=ID | task-instance-id=name} [instance-criteria=criteria] [workflow-instance-name] [recursive=option]
|
|---|
Parameter | internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | |
|---|
...
Description | Reruns the specified Task instance.
See Re-running a Task Instance for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-rerun | Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=<code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-manual-setcompleted |
-c config.cfg | Html bobswift |
|---|
task-instance=8fda93dcd861e5e4005bf48e2cad6206 </pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-set-time |
|---|
| ops-task-set-time |
|---|
|
Set or Modify Wait Time for a Task InstanceDescription | Sets or modifies the Wait time for a task instance that specifies how long it will wait to run after it has become eligible to run. |
|---|
Syntax |
|---|
Description | Sets or modifies the Wait time for a task instance that specifies how long it will wait to run after it has become eligible to run. |
|---|
Syntax | uagcmd ops-task-set-timewait global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name] {wait-type=type [wait-day-constraint=constraint] {wait-time=wait time | wait-duration=duration | wait-seconds=duration in seconds} | delay-type=type {delay-duration=duration | delay-seconds=duration in seconds}}
|
|---|
Parameters | task-instance-id=
Required if task-instance-name= is not specified; sys_id of the task instance.task-instance-name=
Required if task-instance-id= is not specified; Name of the time task instance. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)instance-criteria=
Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.workflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance. (The most recently created workflow instance with the matching name will apply.)wait-type=
Required if delay-type= is not specified; one of the following (not case sensitive): none, time, relative_time, duration, seconds.wait-time=
Required if wait-type=time or relative_time; Wait time in format HH:MM. Variables are supported.wait-day-constraint=
Optional if wait-type=time or relative_time; One of the following (not case sensitive): none, same day/same_day, next day/next_day, next business day/next_business_day, sunday, monday, tuesday, wednesday, thursday, friday, saturday.wait-duration=
Required if wait-type=duration; Wait duration in format DD:HH:MM:SS.wait-seconds=
Required if wait-type=seconds; Wait duration in format SS. Variables are supported.delay-type=
Required if wait-type= is not specified; One of the following (not case sensitive): none, duration, seconds.delay-duration=
Required if delay_type=duration; Specific delay duration in format DD:HH:MM:SS.delay-seconds=
Required if delay_type=seconds; Specific delay duration in format SS. Variables are supported.
|
|---|
Example | |
|---|
...
Description | uagcmd ops-task-set-timewait global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name=name] {
[taskwait-
status | For Agent-based tasks (Linux/Unix, Universal, Windows, and z/OS), changes the priority on the specified task instance.
See Changing the Priority of type= status [recursive=option]]}
|
|---|
Parameter | internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | |
|---|
...
Description | For a Manual task, changes its status from Action Required to Started. This allows you to acknowledge the Manual task and indicate that the manual procedures have been started. |
|---|
Syntax | uagcmd ops-manual-setstarted global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name]
|
|---|
Parameter | internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | |
|---|
...
Description | For a Manual task, sets its status to Success. |
|---|
Syntax | uagcmd ops-manual-setcompleted global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name]
|
|---|
Parameter | internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | |
|---|
...
type [wait-day-constraint=constraint] {wait-time=wait time | wait-duration=duration | wait-seconds=duration in seconds} | delay-type=type {delay-duration=duration | delay-seconds=duration in seconds}}
|
Parameters | task-instance-id=
Required if task-instance-name= is not specified; sys_id of the task instance.task-instance-name=
Required if task-instance-id= is not specified; Name of the time task instance. (If instance-criteria= is not specified, the oldest active task instance with the matching name will apply.)instance-criteria=
Optional, if task-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.workflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance. (The most recently created workflow instance with the matching name will apply.)wait-type=
Required if delay-type= is not specified; one of the following (not case sensitive): none, time, relative_time, duration, seconds.wait-time=
Required if wait-type=time or relative_time; Wait time in format HH:MM. Variables are supported.wait-day-constraint=
Optional if wait-type=time or relative_time; One of the following (not case sensitive): none, same day/same_day, next day/next_day, next business day/next_business_day, sunday, monday, tuesday, wednesday, thursday, friday, saturday.wait-duration=
Required if wait-type=duration; Wait duration in format DD:HH:MM:SS.wait-seconds=
Required if wait-type=seconds; Wait duration in format SS. Variables are supported.delay-type=
Required if wait-type= is not specified; One of the following (not case sensitive): none, duration, seconds.delay-duration=
Required if delay_type=duration; Specific delay duration in format DD:HH:MM:SS.delay-seconds=
Required if delay_type=seconds; Specific delay duration in format SS. Variables are supported.
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-set-timewait |
-c config.cfg | Html bobswift |
|---|
task-instance-name=Task 5A workflow-instance-name=Workflow A wait-type=time wait-time=18:00 </pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-setpriority |
|---|
| ops-task-setpriority |
|---|
|
Set Task PriorityDescription | For Agent-based tasks (Linux/Unix, Universal, Windows, and z/OS), changes the priority on the specified task instance.
See Changing the Priority of a Task Instance for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-setpriority global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name] priority=priority
|
|---|
Parameters | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br>For a task instance in a workflow, optional; Name of the workflow instance.
<li><code>priority=</code> <br> Required; One of the following (not case sensitive): <b>high</b>, <b>medium</b>, <b>low</b>.
</ul> |
|
|---|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-setpriority |
-c config.cfg | Html bobswift |
|---|
task-instance=90079026d861e5e400bba81913a4fdd0 priority=high</pre> |
|
|
|---|
| Anchor |
|---|
| ops-task-skip |
|---|
| ops-task-skip |
|---|
|
Skip a TaskDescription | Skips the specified task instance.
See Skipping a Task Instance for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-setpriorityskip global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name] priority=priority
| Parameters |
|---|
Parameter |
|---|
Description | Skips the specified task instance.
See Skipping a Task Instance for a description of behavior and restrictions. |
|---|
Syntax | uagcmd ops-task-skip global parameters {task-instance-id=ID | task-instance-name=name} [instance-criteria=criteria] [workflow-instance-name]
|
|---|
Parameter | internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | | Html bobswift |
|---|
<ul>
<li> <code>task-instance=</code> <br>Required; An |
internal Universal Controller identifier
| Warning |
|---|
| Replaced by task-instance-id= parameter; the command first will check for task-instance=; if it is not specified, the command will check for task-instance-id=. |
|
|---|
Example | |
|---|
...
| Panel |
|---|
-c config.cfg| Html bobswift |
|---|
.
<li><code>task-instance-id=</code> <br> Required if <code>task-instance-name=</code> is not specified; sys_id of the task instance to run the command on.
<li><code>task-instance-name=</code> <br> Required if <code>task-instance-id=</code> is not specified; Name of the task instance to run the command on. (If <code>instance-criteria=</code> is not specified, the oldest active task instance with the matching name will apply.)
<li><code>instance-criteria=</code> <br> Optional, if <code>task-instance-name=</code> is specified; One of the following (not case-sensitive): <b>oldest_active_instance</b> (default), <b>oldest_instance</b>, <b>newest_active_instance</b>, <b>newest_instance</b>
<li><code>workflow-instance-name=</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul> |
|
Example | | Panel |
|---|
| Html bobswift |
|---|
<pre>uagcmd ops-task-skip |
-c config.cfg | Html bobswift |
|---|
task-instance=90079026d861e5e400bba81913a4fdd0 </pre> |
|
|
|---|