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.
Syntax, parameters, and examples for each function are provided.
Delete Agent
Description | Deletes an Agent record. |
|---|---|
Syntax |
|
Parameters |
|
Example |
|
List Agents Status
Description | Lists the status of one or more Agents. |
|---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
|
Resume Agent
Description | Resumes the ability of the identified Agent to run tasks. |
|---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
|
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 |
|
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 |
|
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 |
|
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 |
|
Suspend Agent
Description | Suspends the ability of the identified Agent to run tasks. |
|---|---|
Syntax |
Note For backward-compatibility, you can exclude |
Parameters |
|
Example |
|
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 |
|
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 |
|