...
Universal Controller supports the following CLI functions for Tasks, which are listed alphabetically on this page.
- Cancel Task
- Clear All Dependencies
- Clear Virtual Resource Dependencies
- Clear Exclusive Dependencies
- Clear Time Dependency
- Display All Tasks
- Display Task Instance Status
- Force Finish a Task
- Launch a Task
- Put Task on Hold
- Release a Task from Hold
- Rerun a Task
- Set Manual Task to Started
- Set Manual Task to Success
- Set or Modify Wait Time for a Task Instance
- Set Task Priority
- Skip a Task
Syntax, parameters, and examples for each function are provided.
...
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 | task-instance=
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=. |
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_instanceworkflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance.
|
|---|
Example |
| Panel |
|---|
uagcmd ops-task-cancel -c config.cfg task-instance-name=Task A |
|
|---|
...
Description | 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 | task-name=
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=. |
task-instance-name=
Optional; Name of the task instance(s) to be listed. Wildcards are supported.agent-name=
Optional; Name of the agent the task instance(s) are running on.task-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.task-status=
Optional; List of comma-separated task status codes and/or names (not case sensitive): status code or name,status code or name,...,status code or name. An exclamation mark (!) preceding a task status code or name excludes task instances with that status.workflow-instance-id=
For a task instance in a workflow, optional if workflow-instance-name= is not specified; sys_id of the workflow instance.workflow-instance-name=
For a task instance in a workflow, optional if workflow-instance-id= is not specified; Name of the workflow instance. (If workflow-instance-criteria= is not specified, the oldest active Workflow instance with the matching name will apply.)workflow-instance-criteria=
Optional, if workflow-instance-name= is specified; One of the following (not case-sensitive): oldest_active_instance (default), oldest_instance, newest_active_instance, newest_instance.options=
Optional; v (Return verbose results.)
|
|---|
Example |
| Panel |
|---|
uagcmd ops-task-status -c config.cfg task-instance-name=mantask agent-name=managent task-type=manual |
|
|---|
...
Description | 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 | task-instance=
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=. |
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_instanceworkflow-instance-name=
For a task instance in a workflow, optional; Name of the workflow instance.priority=
Required; One of the following (not case sensitive): high, medium, low.
|
|---|
Example |
| Panel |
|---|
uagcmd ops-task-setpriority -c config.cfg task-instance=90079026d861e5e400bba81913a4fdd0 priority=high |
|
|---|
...
