Versions Compared

Old Version 2

changes.mady.by.user IT Stonebranch

Saved on

compared with

New Version 3

changes.mady.by.user Stonebranch

Saved on

Key

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

...

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]
 

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.


Parameter


Html bobswift
<ul>
<li> <code>task-instance=</code> <br>Required; An

task-instance=
Required; An internal Universal Controller identifier
 

. <li><code>task
Warning
titleDeprecated

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
  • task-instance-id=
</code> <br> Required if <code>task

  • Required if task-instance-name=
</code>
  • is
  • not
  • specified;
  • sys_id
  • of
  • the
  • task
  • instance
  • to
  • run
  • the
  • command
  • on.
<li><code>task
  • task-instance-name=
</code> <br> Required if <code>task

  • Required if task-instance-id=
</code>
  • is
  • not
  • specified;
  • Name
  • of
  • the
  • task
  • instance
  • to
  • run
  • the
  • command
  • on.
  • (If
<code>instance
  • instance-criteria=
</code>
  • is
  • not
  • specified,
  • the
  • oldest
  • active
  • task
  • instance
  • with
  • the
  • matching
  • name
  • will
  • apply.)
<li><code>instance
  • instance-criteria=
</code> <br> Optional if <code>task

  • Optional if task-instance-name=
</code>
  • is
  • specified;
  • One
  • of
  • the
  • following
  • (not
  • case-sensitive):
<b>oldest
  • oldest_active_
instance</b>
  • instance (default),
<b>oldest_instance</b>, <b>newest
  • oldest_instance, newest_active_
instance</b>, <b>newest_instance</b> <li><code>workflow
  • instance, newest_instance
  • workflow-instance-name=
</code> <br> For a task instance in a workflow, optional; Name of the workflow instance. </ul>

  • For a task instance in a workflow, optional; Name of the workflow instance.

Example


<pre>uagcmd
uagcmd ops-task-cancel 
-c config.cfg
 task-instance-name=Task A
</pre>
 Panel
 Html bobswift
 Html bobswift

 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

<pre>uagcmd
uagcmd ops-task-clear-dependencies 
-c config.cfg
 task-instance-name=Task A 
</pre>
 Panel
 Html bobswift
 Html bobswift

 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

<pre>uagcmd
uagcmd ops-task-clear-resources 
-c config.cfg
 task-instance-name=Task A resource-name=Resource 
A</pre>
A
 Panel
 Html bobswift
 Html bobswift

 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

<pre>uagcmd
uagcmd ops-task-clear-exclusive 
-c config.cfg
 task-instance-name=Task A 
</pre>
 Panel
 Html bobswift
 Html bobswift

 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

<pre>uagcmd
uagcmd ops-task-clear-timewait 
-c config.cfg
 task-instance-name=Task A 
</pre>
 Panel
 Html bobswift
 Html bobswift

 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]
 
 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= 
    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

<pre>uagcmd
uagcmd ops-task-list 
-c config.cfg
 task-name=Task A task-type=timer 
</pre>
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-task-status
ops-task-status
Display Task Instance Status
<ul>
<li> <code>task
task-name=
</code> <br>Required; Name or partial name of one or more tasks. 

Required; Name or partial name of one or more tasks. Wildcards are supported. 
 
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

 Html bobswift
<li> <code>task
 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=.
 Html bobswift
  • task-instance-name=
</code> <br>Optional; Name of the task 

  • Optional; Name of the task instance(s) 
 
  •  to 
 
  •  be 
 
  •  listed. 
  Html bobswift 
  •  are 
 
  •  supported.

<li> <code>agent
  • agent-name=
</code> <br>Optional; Name of the agent the task 

  • Optional; Name of the agent the task instance(s) 
 
  •  are 
 
  •  running 
 
  •  on.

<li> <code>task
  • task-type=
</code> <br>Optional; One of the following (not case 

  • 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 
  •  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
 Html bobswift 
  •  (not 
 
  •  case 
 
  •  sensitive): 
 <i>status 
  • status code 
 
  •  or 
 name</i>,<i>status code or name</i>
  • name,status code or name,...,
<i>status 
  • status code 
 
  •  or 
 name</i>
  • name. 
 
  •  An 
 
  •  exclamation 
 
  •  mark 
 
  •  (!) 
 
  •  preceding 
 
  •  a 
 
  •  task 
 
  •  status 
 
  •  code 
 
  •  or 
 
  •  name 
 
  •  excludes 
 
  •  task 
 
  •  instances 
 
  •  with 
 
  •  that 
 
  •  status.

<li> <code>workflow
  • workflow-instance-id=
</code> <br>For a task instance in a workflow, optional if <code>workflow

  • For a task instance in a workflow, optional if workflow-instance-name=
</code> 
  •  is 
 
  •  not 
 
  •  specified; 
 
  •  sys_id 
 
  •  of 
 
  •  the 
 
  •  workflow 
 
  •  instance.

<li> <code>workflow
  • workflow-instance-name=
</code> <br>For a task instance in a workflow, optional if <code>workflow

  • For a task instance in a workflow, optional if workflow-instance-id=
</code> 
  •  is 
 
  •  not 
 
  •  specified; 
 
  •  Name 
 
  •  of 
 
  •  the 
 
  •  workflow 
 
  •  instance. 
 
  •  (If 
 <code>workflow
  • workflow-instance-criteria=
</code> 
  •  is 
 
  •  not 
 
  •  specified, 
 
  •  the 
 
  •  oldest 
 
  •  active 
 
  •  Workflow 
 
  •  instance 
 
  •  with 
 
  •  the 
 
  •  matching 
 
  •  name 
 
  •  will 
 
  •  apply.)

<li> <code>workflow
  • workflow-instance-criteria=
</code> <br>Optional, if <code>workflow

  • Optional, if workflow-instance-name=
</code> 
  •  is 
 
  •  specified; 
 
  •  One 
 
  •  of 
 
  •  the 
 
  •  following 
 
  •  (not 
 
  •  case-sensitive): 
 <b>oldest
  • oldest_active_
instance</b> 
  • instance (default), 
 <b>oldest_instance</b>, <b>newest
  •  oldest_instance, newest_active_
instance</b>, <b>newest_instance</b>.
<li> <code>options=</code> <br>Optional; <b>v</b> (Return verbose results.)
</ul>
  • instance, newest_instance.
  • options= 
    Optional; v (Return verbose results.)
Example

<pre>uagcmd
uagcmd ops-task-status 
-c config.cfg
 task-instance-name=mantask agent-name=managent task-type=
manual</pre>
manual
 Panel
 Html bobswift
 Html bobswift

 Anchor
Status Types
Status Types
Task Instance Status Types
...
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]
 
 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.

Parameter
 Html bobswift
<ul>
<li> <code>task-instance=</code> <br>Required; An 
task-instance=
Required; An internal Universal Controller 
 identifier
Identifier 
.
<li><code>task
 Warning
titleDeprecated
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
  • task-instance-id=
</code> <br> Required if <code>task

  • Required if task-instance-name=
</code> 
  •  is 
 
  •  not 
 
  •  specified; 
 
  •  sys_id 
 
  •  of 
 
  •  the 
 
  •  task 
 
  •  instance 
 
  •  to 
 
  •  run 
 
  •  the 
 
  •  command 
 
  •  on.

<li><code>task
  • task-instance-name=
</code> <br> Required if <code>task

  • Required if task-instance-id=
</code> 
  •  is 
 
  •  not 
 
  •  specified; 
 
  •  Name 
 
  •  of 
 
  •  the 
 
  •  task 
 
  •  instance 
 
  •  to 
 
  •  run 
 
  •  the 
 
  •  command 
 
  •  on. 
 
  •  (If 
 <code>instance
  • instance-criteria=
</code> 
  •  is 
 
  •  not 
 
  •  specified, 
 
  •  the 
 
  •  oldest 
 
  •  active 
 
  •  task 
 
  •  instance 
 
  •  with 
 
  •  the 
 
  •  matching 
 
  •  name 
 
  •  will 
 
  •  apply.)

<li><code>instance
  • instance-criteria=
</code> <br> 

  • Optional, 
 
  •  if 
 <code>task
  • task-instance-name=
</code> 
  •  is 
 
  •  specified; 
 
  •  One 
 
  •  of 
 
  •  the 
 
  •  following 
 
  •  (not 
 
  •  case-sensitive): 
 <b>oldest
  • oldest_active_
instance</b> 
  • instance (default), 
 <b>oldest_instance</b>, <b>newest
  •  oldest_instance, newest_active_
instance</b>, <b>newest_instance</b> 
<li><code>workflow
  • instance, newest_instance
  • workflow-instance-name=
</code> <br> For a task instance in a workflow, optional; Name of the workflow instance.
</ul>

  • For a task instance in a workflow, optional; Name of the workflow instance.
Example

<pre>uagcmd
uagcmd ops-task-forcefinish 
-c config.cfg
 task-instance-id=
90079020d861e5e40128cbb3cdbe1cf3</pre>
90079020d861e5e40128cbb3cdbe1cf3
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-task-launch
ops-task-launch
Launch a Task
Wildcards
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
html
  • task-
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. 
 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 &lt;resource-name&gt;:&lt;amount&gt; pairs. For example, <b>VR1
  • 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</b>
  • N. 
 
  •  An 
 
  •  amount 
 
  •  of 
 <b>0</b> 
  •  0 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
  • 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>
    • 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.)
 
<pre>uagcmd
uagcmd ops-task-launch 
-c config.cfg
 task-name=Windows Task A task-variables={variable1=first value variable2=second value}
 </pre>
 Panel
 Html bobswift
 Html bobswift

 Anchor
ops-task-hold
ops-task-hold
Put Task on Hold
...