Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

Description

Deletes an Agent record.

Syntax

uagcmd ops-delete-agent global parameters {agent-name=name | agent-id=ID}

Parameters

Html bobswift
<ul>
<li> <code>agent-name</code>= <br>Required if <code>agent-id=</code> is not specified; Agent name of the Agent to be deleted (<code>agent-name=</code> and <code>agent-id=</code> are mutually exclusive).
<li> <code>agent-id</code>= <br>Required if <code>agent-name=</code> is not specified; Agent ID of the Agent to be deleted (<code>agent-id=</code> and <code>agent-name=</code> are mutually exclusive).</ul>

Example

Panel
html-bobswift
<pre>uagcmd ops-delete-agent 

-c config.cfg

Html bobswift
 agent-name=agent A</pre>

Anchor
ops-agent-status
ops-agent-status
List Agents Status

Description

Lists the status of one or more Agents.

Syntax

uagcmd ops-agent-status global parameters [agent-name=name] agent-type=type [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
<ul>
<li> <code>agent-name=</code> <br>Optional; Name or partial name of one or more 

Agents. Wildcards

Html bobswift
 are supported.
<li> <code>agent-type=</code> <br>Optional; One of the following (not case sensitive): <b>windows</b>, <b>unix</b>, <b>linux</b>, <b>linux/unix</b>, <b>zos</b>, <b>z/os</b>. (If not specified, status of all Agents are listed.)
<li> <code>options=</code> <br>Optional; <b>v</b> (Return verbose results.)</ul>

Example

Panel
Html bobswift
<pre>uagcmd ops-agent-status 

-c config.cfg

Html bobswift
 agent-type=windows </pre>

Anchor
ops-resume-agent
ops-resume-agent
Resume Agent

Description

Resumes the ability of the identified Agent to run tasks.

Syntax

uagcmd ops-resume-agent global parameters {agent-name=name | agent-id=id}
 

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
<ul>
<li> <code>agent-name</code>= <br>Required if <code>agent-id=</code> is not specified; Agent name of the Agent whose ability to run tasks is to be resumed (<code>agent-name=</code> and <code>agent-id=</code> are mutually exclusive).
<li> <code>agent-id</code>= <br>Required if <code>agent-name=</code> is not specified; Agent ID of the Agent whose ability to run tasks is to be resumed (<code>agent-id=</code> and <code>agent-name=</code> are mutually exclusive).</ul>

Example

Panel
html-bobswift
<pre>uagcmd ops-resume-agent 

-c config.cfg

Html bobswift
 agent-name=agent A</pre>

Anchor
ops-resume-agent-cluster
ops-resume-agent-cluster
Resume Agent Cluster

Description

Resumes the ability of the identified Agent Cluster to run tasks.

Syntax

uagcmd ops-resume-agent-cluster global parameters agent-cluster-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>agent-cluster-name</code>= <br>Required; Agent cluster name of the Agent Cluster whose ability to run tasks is to be resumed.</ul>

Example

Panel
html-bobswift
<pre>uagcmd ops-resume-agent-cluster 

-c config.cfg

Html bobswift
 agent-cluster-name=cluster A</pre>

Anchor
ops-resume-agent-cluster-membership
ops-resume-agent-cluster-membership
Resume Agent Cluster Membership

Description

Resumes the membership of the identified Agent in the identified Agent Cluster.

Syntax

uagcmd ops-resume-agent-cluster-membership global parameters {agent-name=name | agent-id=ID} agent-cluster-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.

Parameters

Html bobswift
<ul>
<li> <code>agent-name</code>= <br>Required if <code>agent-id=</code> is not specified; Agent name of the Agent whose membership in the Agent Cluster is to be resumed (<code>agent-name=</code> and <code>agent-id=</code> are mutually exclusive).
<li> <code>agent-id</code>= <br>Required if <code>agent-name=</code> is not specified; Agent ID of the Agent whose membership in the Agent Cluster is to be resumed (<code>agent-id=</code> and <code>agent-name=</code> are mutually exclusive). 
<li> <code>agent-cluster-name</code>= <br>Required; Agent cluster name of the Agent Cluster in whose membership the identified Agent is to be resumed.</ul>

Example

Panel
Html bobswift
<pre>uagcmd ops-resume-agent-cluster-membership 

-c config.cfg

Html bobswift
 agent-name=agent A agent-cluster-name=cluster A</pre>

Anchor
ops-set-agent-cluster-task-execution-limit
ops-set-agent-cluster-task-execution-limit
Set Agent Cluster Task Execution Limit

Description

Specifies whether or not an Agent Cluster has a task execution limit and, if so, sets the task execution limit.

Syntax

uagcmd ops-set-agent-cluster-task-execution-limit global parameters agent-cluster-name=name limit-type=type limit-amount=number
 

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

  • agent-cluster-name=
    Required; Name of the Agent Cluster.
  • limit-type=
    Required; Specification for whether or not there is a limit to the number of tasks that can be run at the same time by the Agent Cluster. Allowable values (not case sensitive) are: limited, unlimited.
  • limit-amount=
    Required if limit-type=limited; Maximum number of tasks that can be run at the same time by the Agent Cluster.

Example

Panel
html-bobswift
<pre>uagcmd ops-set-agent-cluster-task-execution-limit 

-c config.cfg

Html bobswift
 agent-cluster-name=cluster A limit-type=limit limit-amount=500</pre>

Anchor
ops-set-agent-task-execution-limit
ops-set-agent-task-execution-limit
Set Agent Task Execution Limit

Description

Specifies whether or not an Agent has a task execution limit and, if so, sets the task execution limit.

Syntax

uagcmd ops-set-agent-task-execution-limit global parameters {agent-name=name | agent-id=ID} limit-type=type limit-amount=number
 

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

  • agent-name=
    Required if agent-id= is not specified; Name of the Agent (agent-name= and agent-id= are mutually exclusive).
  • agent-id=
    Required if agent-name= is not specified; ID of the Agent (agent-id= and agent-name= are mutually exclusive).
  • limit-type=
    Required; Specification for whether or not there is a limit to the number of tasks that can be run concurrently by the Agent. Allowable values (not case sensitive) are limited, unlimited.
  • limit-amount=
    Required if limit-type=limited; Maximum number of tasks that can be run at the same time by the Agent.

Example

Panel
Html bobswift
<pre>uagcmd ops-set-agent-task-execution-limit 

-c config.cfg

Html bobswift
 agent-name=agent A limit-type=limit limit-amount=500</pre>

Anchor
ops-suspend-agent
ops-suspend-agent
Suspend Agent

Description

Suspends the ability of the identified Agent to run tasks.

Syntax

uagcmd ops-suspend-agent global parameters {agent-name=name | agent-id=ID}
 

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
<ul>
<li> <code>agent-name</code>= <br>Required if <code>agent-id=</code> is not specified; Agent name of the Agent whose ability to run tasks is to be suspended (<code>agent-name=</code> and <code>agent-id=</code> are mutually exclusive).
<li> <code>agent-id</code>= <br>Required if <code>agent-name=</code> is not specified; Agent ID of the Agent whose ability to run tasks is to be suspended (<code>agent-id=</code> and <code>agent-name=</code> are mutually exclusive).</ul>

Example

Panel
html-bobswift
<pre>uagcmd ops-suspend-agent 

-c config.cfg

Html bobswift
 agent-name=agent A</pre>

Anchor
ops-suspend-agent-cluster
ops-suspend-agent-cluster
Suspend Agent Cluster

Description

Suspends the ability of the identified Agent Cluster to run tasks.

Syntax

uagcmd ops-suspend-agent-cluster global parameters agent-cluster-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>agent-cluster-name</code>= <br>Required; Agent cluster name of the Agent Cluster whose ability to run tasks is to be suspended. </ul>

Example

Panel
Html bobswift
<pre>uagcmd ops-suspend-agent-cluster 

-c config.cfg

Html bobswift
 agent-cluster-name=cluster A</pre>

Anchor
ops-suspend-agent-cluster-membership
ops-suspend-agent-cluster-membership
Suspend Agent Cluster Membership

Description

Suspends the membership of the identified Agent in the identified Agent Cluster.

Syntax

uagcmd ops-suspend-agent-cluster-membership global parameters {agent-name=name | agent-id=ID} agent-cluster-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.

Parameters

Html bobswift
<ul>
<li> <code>agent-name</code>= <br>Required if <code>agent-id=</code> is not specified; Agent name of the Agent whose membership in the Agent Cluster is to be suspended (<code>agent-name=</code> and <code>agent-id=</code> are mutually exclusive).
<li> <code>agent-id</code>= <br>Required if <code>agent-name=</code> is not specified; Agent ID of the Agent whose membership in the Agent Cluster is to be suspended (<code>agent-id=</code> and <code>agent-name=</code> are mutually exclusive).
<li> <code>agent-cluster-name</code>= <br>Required; Agent cluster name of the Agent Cluster in whose membership the identified Agent is to be suspended.</ul>

Example

Panel
html-bobswift
<pre>uagcmd ops-suspend-agent-cluster-membership 

-c config.cfg

Html bobswift
 agent-name=agent A agent-cluster-name=cluster A </pre>