...
Syntax, parameters, and examples for each function are provided.
Anchor |
---|
| ops-task-cancel |
---|
| ops-task-cancel |
---|
|
Cancel Task
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 |
|
---|
Anchor |
---|
| ops-task-clear-dependencies |
---|
| ops-task-clear-dependencies |
---|
|
Clear All Dependencies
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-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 |
Panel |
---|
uagcmd ops-task-clear-dependencies -c config.cfg task-instance-name=Task A |
|
---|
Anchor |
---|
| ops-task-clear-resources |
---|
| ops-task-clear-resources |
---|
|
Clear Virtual Resource Dependencies
Description | Clears all virtual resource dependencies of a task instance. |
---|
Syntax | uagcmd ops-task-clear-resources 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 |
Panel |
---|
uagcmd ops-task-clear-resources -c config.cfg task-instance-name=Task A resource-name=Resource A |
|
---|
Anchor |
---|
| ops-task-clear-exclusive |
---|
| ops-task-clear-exclusive |
---|
|
Clear Exclusive Dependencies
Description | Clears all exclusive dependencies of a task instance. |
---|
Syntax | uagcmd ops-task-clear-exclusive 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 |
Panel |
---|
uagcmd ops-task-clear-exclusive -c config.cfg task-instance-name=Task A |
|
---|
Anchor |
---|
| ops-task-clear-time |
---|
| ops-task-clear-time |
---|
|
Clear Time Dependency
Description | Clears the time dependency of a task instance. |
---|
Syntax | uagcmd ops-task-clear-timewait 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 |
Panel |
---|
uagcmd ops-task-clear-timewait -c config.cfg task-instance-name=Task A |
|
---|
Anchor |
---|
| ops-task-list |
---|
| ops-task-list |
---|
|
Display All Tasks
Description | Displays all specified tasks. |
---|
Syntax | uagcmd ops-task-list global parameters task-name=name [task-type=type]
|
---|
Parameters | task-name= Optional; Name or partial name of one or more tasks. Wildcards are supported.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.
|
---|
Example |
Panel |
---|
uagcmd ops-task-list -c config.cfg task-name=Task A task-type=timer |
|
---|
Anchor |
---|
| ops-task-status |
---|
| ops-task-status |
---|
|
Display Task Instance Status
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 |
|
---|
Task Instance Status Types
The following table describes all possible task instance statuses for all task types.
...
* Workflows cannot go to Failed status.
Anchor |
---|
| ops-task-forcefinish |
---|
| ops-task-forcefinish |
---|
|
Force Finish a Task
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 | 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-forcefinish -c config.cfg task-instance-id=90079020d861e5e40128cbb3cdbe1cf3 |
|
---|
Anchor |
---|
| ops-task-launch |
---|
| ops-task-launch |
---|
|
Launch a Task
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 | task-type = Optional; One of the following (not case sensitive): timer, windows, unix, zos, agent_file_monitor, manual, email, email_monitor, ftp, sql, remote_file_monitor, task_monitor, stored_procedure, workflow, sap, peoplesoft, system_monitor, indesca / universal_command / ucmd, web_service, application_control.task-name= Required; Valid task name. Wildcards are supported.time-zone= Optional; Time zone in which the task is launched.hold= Optional; Specification for whether to place the task in Held status when it is launched. Valid values are (not case sensitive): yes/y/true.task-variables= Optional; Any variables specified in the task that need a value to run properly.virtual-resource-priority= 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.virtual-resources= Optional; Comma-separated list of <resource-name>:<amount> pairs. For example, VR1:10,VR2:20,...,VRN:N. An amount of 0 indicates the virtual resource should be dropped. Defaults to virtual resources defined in the task Details.
The virtual resource dependencies specified in virtual-resources= are merged with the default virtual resource dependencies.- If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
- Any virtual resource specified with an amount of 0 is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
- If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added.
|
---|
Example | (All variable=value pairs must be specified within one set of braces.) Panel |
---|
uagcmd ops-task-launch -c config.cfg task-name=Windows Task A task-variables={variable1=first value variable2=second value} |
|
---|
Anchor |
---|
| ops-task-hold |
---|
| ops-task-hold |
---|
|
Put Task on Hold
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 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-hold -c config.cfg task-instance=90079020d861e5e40128cbb3cdbe1cf3 |
|
---|
Anchor |
---|
| ops-task-release |
---|
| ops-task-release |
---|
|
Release a Task from Hold
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 | 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.recursive= Optional; Specification (yes or no), if the task instance specified in task-instance-id= or task-instance-name= is a workflow, for whether or not to release the held workflow recursively. (Default is no.) If the task instance is not a workflow, recursive= is ignored.
|
---|
Example |
Panel |
---|
uagcmd ops-task-release -c config.cfg task-instance-id=90079020d861e5e40128cbb3cdbe1cf3 |
|
---|
Anchor |
---|
| ops-task-rerun |
---|
| ops-task-rerun |
---|
|
Rerun a Task
Description | 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 | 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= Optional; Name of the workflow instance.task-status= 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.
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 recursive= parameter controls whether or not tasks within sub-workflows matching the status will be queued for re-run.- Start_Failure (120)
- Cancelled (130)
- Failed (140)
- Finished (190)
- Success (200)
recursive= Optional if task-status= 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.
|
---|
Example |
Panel |
---|
uagcmd ops-task-rerun -c config.cfg task-instance=8fda93dcd861e5e4005bf48e2cad6206 task-status=140 |
|
---|
Anchor |
---|
| ops-manual-setstarted |
---|
| ops-manual-setstarted |
---|
|
Set Manual Task to Started
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 | 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-manual-setstarted -c config.cfg task-instance=8fda93dcd861e5e4005bf48e2cad6206 |
|
---|
Anchor |
---|
| ops-manual-setcompleted |
---|
| ops-manual-setcompleted |
---|
|
Set Manual Task to Success
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 | 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_instance
workflow-instance-name= For a task instance in a workflow, optional; Name of the workflow instance.
|
---|
Example |
Panel |
---|
uagcmd ops-manual-setcompleted -c config.cfg task-instance=8fda93dcd861e5e4005bf48e2cad6206 |
|
---|
Anchor |
---|
| ops-task-set-time |
---|
| ops-task-set-time |
---|
|
Set or Modify Wait Time for a Task Instance
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 |
Panel |
---|
uagcmd ops-task-set-timewait -c config.cfg task-instance-name=Task 5A workflow-instance-name=Workflow A wait-type=time wait-time=18:00 |
|
---|
Anchor |
---|
| ops-task-setpriority |
---|
| ops-task-setpriority |
---|
|
Set Task Priority
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 |
|
---|
Anchor |
---|
| ops-task-skip |
---|
| ops-task-skip |
---|
|
Skip a Task
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 | 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-skip -c config.cfg task-instance=90079026d861e5e400bba81913a4fdd0 |
|
---|
...