Agent Functions
Overview
The command line syntax for each execution of the CLI command, uagcmd, must specify a single CLI function, required / optional Global parameters, and required / optional function-specific parameters. You must use the required Global parameters to connect to OMS Servers and to log on to a Controller (User ID and Password).
Universal Controller supports the following CLI functions for Agents, which are listed alphabetically on this page.
- Delete Agent
- List Agents Status
- Resume Agent
- Resume Agent Cluster
- Resume Agent Cluster Membership
- Set Agent Cluster Task Execution Limit
- Set Agent Task Execution Limit
- Suspend Agent
- Suspend Agent Cluster
- Suspend Agent Cluster Membership
Syntax, parameters, and examples for each function are provided.
Delete Agent
Description |
Deletes an Agent record. |
---|---|
Syntax |
|
Parameters |
|
Example |
uagcmd ops-delete-agent -c config.cfg agent-name=agent A |
List Agents Status
Description |
Lists the status of one or more Agents. |
---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
uagcmd ops-agent-status -c config.cfg agent-type=windows |
Resume Agent
Description |
Resumes the ability of the identified Agent to run tasks. |
---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
uagcmd ops-resume-agent -c config.cfg agent-name=agent A |
Resume Agent Cluster
Description |
Resumes the ability of the identified Agent Cluster to run tasks. |
---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameter |
|
Example |
uagcmd ops-resume-agent-cluster -c config.cfg agent-cluster-name=cluster A |
Resume Agent Cluster Membership
Description |
Resumes the membership of the identified Agent in the identified Agent Cluster. |
---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
uagcmd ops-resume-agent-cluster-membership -c config.cfg agent-name=agent A agent-cluster-name=cluster A |
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 |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
uagcmd ops-set-agent-cluster-task-execution-limit -c config.cfg agent-cluster-name=cluster A limit-type=limit limit-amount=500 |
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 |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
uagcmd ops-set-agent-task-execution-limit -c config.cfg agent-name=agent A limit-type=limit limit-amount=500 |
Suspend Agent
Description |
Suspends the ability of the identified Agent to run tasks. |
---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
uagcmd ops-suspend-agent -c config.cfg agent-name=agent A |
Suspend Agent Cluster
Description |
Suspends the ability of the identified Agent Cluster to run tasks. |
---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameter |
|
Example |
uagcmd ops-suspend-agent-cluster -c config.cfg agent-cluster-name=cluster A |
Suspend Agent Cluster Membership
Description |
Suspends the membership of the identified Agent in the identified Agent Cluster. |
---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
uagcmd ops-suspend-agent-cluster-membership -c config.cfg agent-name=agent A agent-cluster-name=cluster A |