Panel | ||||
---|---|---|---|---|
|
...
Universal Controller supports the following RESTful-based web services for Agent Cluster operations, which are listed alphabetically on this page.
- Create an Agent Cluster
- Delete an Agent Cluster
- List Agent Clusters
- Modify an Agent Cluster
- Read an Agent Cluster
- Resolve an Agent Cluster
- Resume an Agent Cluster
- Resume an Agent Cluster Membership
- Return an Agent from an Agent Cluster
- Set an Agent Cluster Task Execution Limit
- Suspend an Agent Cluster
- Suspend an Agent Cluster Membership
Formatting specifications for each web service, including details about property requirements, are provided.
...
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| currentCount
| currentCount
| Current Task Count | If
| Agent Limit Amount | If agentLimitType = Limited; Limit of number of agents in this agent cluster. | Integer; Read onlyDefault is 10. | N | ||||||||||||||
| description
| description
|
| Description | User-defined; description of this record. | N | ||||||||||||||||
Anchor | distribution - CAC | distribution - CAC | Distribution | Method used to select an Agent in the Agent Cluster. | Agent Limit | Specification for whether the agent cluster has a Limited or Unlimited number of agents. | Valid Values:
Default is Unlimited (1). | N | ||||||||||||||
read only
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. |
| Current Task Count | If | Integer; Read only. | N | |||||||||||||||
exportTable description | n/a | Record table information. | read only | Description | User-defined; description of this record. | N | ||||||||||||||||
ignoreInactiveAgents distribution | Ignore Inactive Agents | Specification for whether or not inactive (offline) Agents should be ignored when the agent cluster is used for broadcasting. | Optional; Valid values: true/false (default is falseDistribution | Method used to select an Agent in the Agent Cluster. | Valid Values:
Default is Any (1). | N | ||||||||||||||||
Optional; Valid values: true/false (default is false).
ignoreSuspendedAgents | Ignore Suspended Agents | Specification for whether or not suspended Agents should be ignored when the agent cluster is used for broadcasting. |
| n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||||||
Read only.
lastAgentUsed | Last Agent Used | Agent that was selected the last time a task was sent to this Agent Cluster. |
| n/a | Record table information. | read only | N | |||||||||||||||
Read only
lastResolution | Last Resolution | If |
| Ignore Inactive Agents | Specification for whether or not inactive (offline) Agents should be ignored when the agent cluster is used for broadcasting. | Optional; Valid values: true/false (default is false). | N | |||||||||||||||
limitAmount | Limit Amount | If | N | |||||||||||||||||||
Anchor | limitType - CAC | limitType - CAC | Task Execution Limit | Specification for whether a Limited or Unlimited number of task instances can be run concurrently by the Agents in this Agent Cluster. | Valid Values: Default is Unlimited (1 | Ignore Suspended Agents | Specification for whether or not suspended Agents should be ignored when the agent cluster is used for broadcasting. | Optional; Valid values: true/false (default is false). | N | |||||||||||||
Name of
name | Cluster Name |
| Last Agent Used | Agent that was selected the last time a task was sent to this Agent Cluster. | YRead only. | N | ||||||||||||||||
networkAlias lastResolution | Network AliasLast Resolution | If | Read only. | N | ||||||||||||||||||
networkAliasPort limitAmount | Agent PortLimit Amount | If | N | |||||||||||||||||||
List of Business Services that this Agent Cluster belongs to. Panel |
opswiseGroups | Member of Business Services |
| Task Execution Limit | Specification for whether a Limited or Unlimited number of task instances can be run concurrently by the Agents in this Agent Cluster. | Valid Values:
Default is Unlimited (1). | N | |||||||||||||||
resolutionDescription name | Resolution Description | If | Read only. | N | Anchor | | resolutionStatus - CAC | resolutionStatus - CAC | Name of this Agent Cluster. | Y | ||||||||||||
networkAlias | Network Alias | If | N | |||||||||||||||||||
resumedOn networkAliasPort | Resumed On | Date and time when a suspended Agent Cluster was resumed. | Read only. | Agent Port | If | N | ||||||||||||||||
Specification for whether or not the Create an Agent Cluster web service will persist the sysId property.
retainSysIds | n/a |
| Member of Business Services | List of Business Services that this Agent Cluster belongs to.
| N | |||||||||||||||||
resolutionDescription | Resolution Description | If | Read only. | N | ||||||||||||||||||
resolutionStatus | Resolution Status | If | Read only. | N | ||||||||||||||||||
resumedOn | Resumed On | Date and time when a suspended Agent Cluster was resumed. | Read only. | N | ||||||||||||||||||
retainSysIds | n/a | Specification for whether or not the Create an Agent Cluster web service will persist the sysId - CAC property.
| Optional; Valid values: true/false (default is true). | N | ||||||||||||||||||
| Strict Business Services Membership | Specifies whether to only allow Agent to Cluster Associations where the Business Service matches.If true, only agents with matched Member of Business Services can be added to the cluster. | Boolean; Valid values: true/false | (default is true). Default is false. | N | |||||||||||||||||
suspended | Suspended | Indication of whether or not the ability for this cluster of Agents to run tasks has been suspended. | Read only; Boolean; Valid Values: true/false. | N | ||||||||||||||||||
suspendedOn | Suspended On | Date and time when the Agent Cluster was suspended. | Read only. | N | ||||||||||||||||||
sysId | n/a | sys_id used within the Controller to identify this Agent Cluster. | N | |||||||||||||||||||
type | n/a | Type of Agent Cluster. | For List Agent Clusters: Read only; Valid values:
For Create/Modify/Read Agent Clusters: Applicable to JSON only; Specifies agent cluster type to create/modify. Valid values: | N |
...
Property | UI Field Name | Description | Specifications | ||||||
---|---|---|---|---|---|---|---|---|---|
bcc | Bcc | Email address of the party being sent a blind (hidden) copy of the email, if any. | Use commas to separate multiple recipients. Variables and Functions are supported. | ||||||
body | Body | Text of the email message. | Variables and Functions are supported. If the | ||||||
cc | Cc | Email address of the party being sent a copy of the email, if any. | Use commas to separate multiple recipients. Variables and Functions are supported. | ||||||
emailConnection | Email Connection | Name of an Email Connection. | If you specify both an | ||||||
emailTemplate | Email Template | Name of an Email Template. | If you specify both an | ||||||
replyTo | Reply-To | Email address of the sender of the email. | Use commas to separate multiple recipients. Variables and Functions are supported. | ||||||
state | Notification State | Comma-separated list of Notification states | Valid values:
| ||||||
subject | Subject | Subject line of the email. | Variables and Functions are supported. | ||||||
sysId | n/a | sys_id used within the Controller to identify this Email Notification. | |||||||
to | To | Email address of the recipient. | Use commas to separate multiple recipients Variables and Functions are supported. |
...
Property | UI Field Name | Description | Specifications | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
severity | Notification Severity | Severity level of this notification. | Valid values: severity | Notification Severity | Severity level of this notification. | Valid values:
Default is Normal (1). | ||||||||
snmpManager | SNMP Manager | SNMP Manager that will receive this notification. | ||||||||||||
state | Notification State | Comma-separated list of Notification states | Valid values:
| |||||||||||
sysId | n/a | sys_id used within the Controller to identify this SNMP Notification. |
...
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/agentcluster/listadv |
HTTP Method | GET |
Description | Retrieves Agent Clusters details using specific query parameters. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | application/xml, application/json |
Consumes Content-Type | n/a |
Example Responses | See See List Agent Cluster - Advanced: XML and JSON Examples |
URI Properties |
Anchor | ||||
---|---|---|---|---|
|
...
Properties
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
agentclustername | Name | Name or partial name of one or more agent clusters. | Wildcards are supported. | N | |
businessServices | Member of Business Services | Business Services that one or more agent clusters belong to. | String value of comma-separated Business Services. | N | |
type | n/a | Agent Cluster Type of agent clusters to list. | Valid values: One of the following (not case sensitive):
If type is not specified, defaults to all types. | N |
Anchor | ||||
---|---|---|---|---|
|
XML | JSON | ||||
---|---|---|---|---|---|
|
|
|
|
|
Anchor | ||||
---|---|---|---|---|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/agentcluster |
HTTP Method | GET |
Description | Retrieves information on a specific Agent cluster. |
URI Parameters | |
Example URI | http://localhost:8080/uc/resources/agentcluster?agentclustername=cluster1 |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | |
Agent Cluster Properties | |
Agent Properties | See Agent Properties. |
Agent Cluster: Email Notification Properties | |
Agent Cluster: SNMP Notification Properties |
...
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
agentClusterName | Cluster Name | Name used within the Controller to identify this agent cluster. | Y | |||||||
limitAmount | Limit Amount | Number of tasks that can be running at the same time by the Agents in this agent cluster. | Set only if | N | ||||||
limitType | Task Execution Limit | Specification for whether a Limited or Unlimited number of task instances can be run concurrently by the Agents in this agent cluster. | Valid values:
| Y |
Anchor | ||||
---|---|---|---|---|
|
...