Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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]
 

Note
titleNote

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.


Parameters

  • task-name=
    Required; Name or partial name of one or more tasks. Wildcards are supported. 
Warning
titleDeprecated

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

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]
 

Note
titleNote

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.


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}


...