Overview

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.

Create an Agent Cluster

	Description
URI	http://host_name/uc/resources/agentcluster
HTTP Method	POST
Description	Creates a new Agent Cluster.
Example URI	http://localhost:8080/uc/resources/agentcluster
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Read an Agent Cluster: XML and JSON Examples.
Agent Cluster Properties	See Agent Cluster Properties.
Agent Properties	See Agent Properties.
Agent Cluster: Email Notification Properties	See Agent Cluster Email Notification Properties.
Agent Cluster: SNMP Notification Properties	See Agent Cluster SNMP Notification Properties.
Example Response	Status 200 /OK Successfully created the agent cluster with sysId {sysId}.

Agent Cluster Properties

Property	UI Field Name	Description	Specifications	Required
`currentCount`	Current Task Count	If `limitType` is Limited (2); Current number of tasks currently being run by the Agents in this agent cluster.	Integer; Read only.	N
`description`	Description	User-defined; description of this record.		N
`distribution`	Distribution	Method used to select an Agent in the Agent Cluster.	Valid Values: As String = Any, As Value = 1 As String = Round Robin, As Value = 2 As String = Lowest CPU Utilization, As Value = 3 As String = Network Alias, As Value = 4 Default is Any (1).	N
`exportReleaseLevel`	n/a	Universal Controller release that the record was exported from.	read only	N
`exportTable`	n/a	Record table information.	read only	N
`ignoreInactiveAgents`	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
`ignoreSuspendedAgents`	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
`lastAgentUsed`	Last Agent Used	Agent that was selected the last time a task was sent to this Agent Cluster.	Read only.	N
`lastResolution`	Last Resolution	If `distribution` is Network Alias (4); Last attempted time of Network Alias resolution.	Read only.	N
`limitAmount`	Limit Amount	If `limitType` is Limited (2); Number of tasks that can be running at the same time by the Agents in this agent cluster.		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: As String = Unlimited, As Value = 1 As String = Limited, As Value = 2 Default is Unlimited (1).	N
`name`	Cluster Name	Name of this Agent Cluster.		Y
`networkAlias`	Network Alias	If `distribution` is Network Alias (4); Network alias (or VIP).		N
`networkAliasPort`	Agent Port	If `distribution` is Network Alias (4); Network alias (or VIP) port that the Agent's Universal Broker is listening on.		N
`opswiseGroups`	Member of Business Services	List of Business Services that this Agent Cluster belongs to. Format: XML <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> JSON "opswiseGroups": ["test"]		N
`resolutionDescription`	Resolution Description	If `distribution` is Network Alias (4); Description of the last attempted resolution.	Read only.	N
`resolutionStatus`	Resolution Status	If `distribution` is Network Alias (4); Status of the last resolution of the Network Alias.	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. If retainSysIds="true" and `sysId` is included in the request, `sysId` will be persisted to the database. If retainSysIds="false" and `sysId` is included in the request, `sysId` will be ignored; it will be autogenerated by the Controller. Note In XML web services, `retainSysIds` is specified as an attribute in the <agentCluster> element.	Optional; Valid values: true/false (default is true).	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: Windows Linux/Unix For Create/Modify/Read Agent Clusters: Applicable to JSON only; Specifies agent cluster type to create/modify. Valid values: `windowsAgentCluster` and `unixAgentCluster`	N

Agent Properties

Property	UI Field Name	Description	Specifications	Required
`agentName`	Agent	Name of an Agent in the Agent Cluster.		Y
`membershipDecommissioned`	Membership Decommissioned	Indication of whether or not the Agent has been temporarily decommissioned from the Agent Cluster; the Agent will not be available as a selection from the Agent Cluster while it is decommissioned.		N
`membershipResumedOn`	Membership Resumed On	Date and time that an Agent temporarily suspended from the Agent Cluster has been resumed.	Read only; Boolean; Valid Values: true/false.	N
`membershipSuspended`	Membership Suspended	Indication of whether or not the Agent has been temporarily suspended from the Agent Cluster; the Agent will not be available as a selection from the Agent Cluster while it is suspended.	Read only; Boolean; Valid Values: true/false.	N
`membershipSuspendedOn`	Membership Suspended On	Date and time that the Agent has been temporarily suspended from the Agent Cluster.	Read only; Boolean; Valid Values: true/false.	N
`type`	n/a	Type of Agent	Read only; Valid values: Windows Linux/Unix	N
`sysId`	n/a	sys_id used within the Controller to identify the Agent Cluster membership of this Agent.		N

Agent Cluster: Email Notification Properties

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 `emailTemplate` contains text in the body, this text is appended.
`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 `emailConnection` and an `emailTemplate`, the Controller uses the `emailConnection`.
`emailTemplate`	Email Template	Name of an Email Template.	If you specify both an `emailConnection` and an `emailTemplate`, the Controller uses the `emailConnection`.
`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: As String = Agents Unavailable, As Value = 1 As String = Agent Available, As Value = 2 As String = Suspended, As Value = 4 As String = Resumed, As Value = 8
`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.

Agent Cluster: SNMP Notification Properties

Property	UI Field Name	Description	Specifications
`severity`	Notification Severity	Severity level of this notification.	Valid values: As String = Normal, As Value = 1 As String = Warning, As Value = 2 As String = Minor, As Value = 3 As String = Major, As Value = 4 As String = Critical, As Value = 5 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: As String = Agents Unavailable, As Value = 1 As String = Agent Available, As Value = 2 As String = Suspended, As Value = 4 As String = Resumed, As Value = 8
`sysId`	n/a	sys_id used within the Controller to identify this SNMP Notification.

Delete an Agent Cluster

	Description
URI	http://host_name/uc/resources/agentcluster
HTTP Method	DELETE
Description	Deletes a specific Agent Cluster.
URI Parameters	See Delete an Agent Cluster: URI Parameters.
Example URI	http://localhost:8080/uc/resources/agentcluster?agentclusterid=35dc94a7a8834d28b51e03b5780cd90c
Authentication	HTTP Basic
Example Response	Status 200 /OK Agent cluster deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify agentclustername and agentclusterid at the same time. Status 404 /Not Found A custom day with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

Delete an Agent Cluster: URI Parameters

Name	Description	Specifications	Required	Mutually Exclusive With
`agentclusterid`	Unique ID for this Agent Cluster.		Y (unless `agentclustername` is specified)	`agentclustername`
`agentclustername`	Name used within the Controller to identify this Agent Cluster.		Y (unless `agentclusterid` is specified)	`agentclusterid`

List Agent Clusters

	Description
URI	http://host_name/uc/resources/agentcluster/list
HTTP Method	GET
Description	Retrieves information on all Agent Clusters.
Example URI	http://localhost:8080/uc/resources/agentcluster/list
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Response Examples	See List Agent Clusters: XML and JSON Examples.
Agent Cluster Properties	See Agent Cluster Properties.
Agent Properties	See Agent Properties.
Agent Cluster: Email Notification Properties	See Agent Cluster Email Notification Properties.
Agent Cluster: SNMP Notification Properties	See Agent Cluster SNMP Notification Properties.

List Agent Clusters: XML and JSON Examples

XML

JSON

XML

<agentClusters>
      <agentCluster version="1">
            <agents>
                  <agent>
                        <agentName>pc - SS0001</agentName>
                        <membershipDecommissioned>true</membershipDecommissioned>
                        <membershipResumedOn />
                        <membershipSuspended>true</membershipSuspended>
                        <membershipSuspendedOn>2021-06-29 19:18:30 -400</membershipSuspendedOn>
                        <sysId>af1984d3481b4bccb9bea0e4e1d6fbf2</sysId>
                        <type>Linux/Unix</type>
                  </agent>
            </agents>
            <currentCount>0</currentCount>
            <description>Cluster of Linux Agents</description>
            <distribution>Network Alias</distribution>
            <ignoreInactiveAgents>true</ignoreInactiveAgents>
            <ignoreSuspendedAgents>true0</ignoreSuspendedAgents>
            <lastAgentUsed>sb-qa-123</lastAgentUsed>
            <lastResolution>2018-09-12 09:52:03.410 -0500</lastResolution>
            <limitAmount>5</limitAmount>
            <limitType>Unlimited</limitType>
            <name>Cluster 1</name>
            <networkAlias>qa-123</networkAlias>
            <networkAliasPort />
            <notifications>
		<emailNotification>
			<sysId>2b7286b87a7048399fbd95c01a380002</sysId>
			<bcc />
			<body />
			<cc />
			<emailConnection>uc - Gmail Account</emailConnection>
			<emailTemplate>uc - Template</emailTemplate>
			<replyTo />
			<state>Agents Unavailable<[/state]>
			<subject />
			<to />
		</emailNotification>
		<snmpNotification>
			<state>Agents Unavailable</state>
			<sysId>21d992c72be44b159aac91c4ee9f40c6</sysId>
			<severity>Minor</severity>
			<snmpManager>SNMP Manager</snmpManager>
		</snmpNotification>
            </notifications>
            <opswiseGroups /> 
            <resolutionDescription>Agent in Use:'sb-qa-123'</resolutionDescription>
            <resolutionStatus>Success</resolutionStatus>
            <resumedOn>2021-06-29 19:18:30 -400</resumedOn>
            <suspended>false</suspended>
            <suspendedOn />
            <sysId>cb5b876aa9fec69f0032b55e0391d693</sysId>
            <type>Windows</type>
      </agentCluster>
      <agentCluster version="1">
            <agents>
                  <agent>
                        <agentName>pc - SS0002</agentName>
                        <membershipDecommissioned>false</membershipDecommissioned>
                        <membershipResumedOn />
                        <membershipSuspended>true</membershipSuspended>
                        <membershipSuspendedOn>2021-06-29 19:18:30 -400</membershipSuspendedOn>
                        <sysId>af1984d3481b4bccb9bea0e4e1d6fbf3</sysId>
                        <type>Windows</type>
                  </agent>
            </agents>
            <currentCount>0</currentCount>
            <description>Cluster of Windows Agents</description>
            <distribution>Network Alias</distribution>
            <ignoreInactiveAgents>true</ignoreInactiveAgents>
            <ignoreSuspendedAgents>true0</ignoreSuspendedAgents>
            <lastAgentUsed>sb-qa-123</lastAgentUsed>
            <lastResolution>2018-09-13 10:52:03.410 -0500</lastResolution>
            <limitAmount>5</limitAmount>
            <limitType>Unlimited</limitType>
            <name>Cluster 2</name>
            <networkAlias>qa-123</networkAlias>
            <networkAliasPort />
            <notifications>
		<emailNotification>
			<sysId>2b7286b87a7048399fbd95c01a380002</sysId>
			<bcc />
			<body />
			<cc />
			<emailConnection>uc - Gmail Account</emailConnection>
			<emailTemplate>uc - Template</emailTemplate>
			<replyTo />
			<state>Agents Unavailable</state>
			<subject />
			<to />
		</emailNotification>
		<snmpNotification>
			<state>Agents Unavailable</state>
			<sysId>21d992c72be44b159aac91c4ee9f40c6</sysId>
			<severity>Minor</severity>
			<snmpManager>SNMP Manager</snmpManager>
		</snmpNotification>
            </notifications>
            <opswiseGroups /> 
            <resolutionDescription>Agent in Use:'sb-qa-123'</resolutionDescription>
            <resolutionStatus>Success</resolutionStatus>
            <resumedOn />
            <suspended>true</suspended>
            <suspendedOn>2021-06-29 19:18:30 -400</suspendedOn>
            <sysId>cb5b876aa9fec69f0032b55e0391d694</sysId>
            <type>Windows</type>
      </agentCluster>
</agentClusters>

JSON

[
  {
  "agents": [ {
    "agentName": "Mark-4 - AGNT001",
    "membershipDecommissioned": true,
    "membershipResumedOn": null,
    "membershipSuspended": true,
    "membershipSuspendedOn": "2021-06-29 19:18:30 -400",
    "sysId": "941e558d6f2b4656bdb870e2551fa85e",
    "type": "Linux/Unix"
  } ],
  "currentCount": 0,
  "description": "Cluster of Linux Agents",
  "distribution": "Network Alias",
  "ignoreInactiveAgents": true,
  "ignoreSuspendedAgents": true,
  "lastAgentUsed": "sb-qa-123",
  "lastResolution": "2018-09-12 09:52:03.410 -0500",
  "limitAmount": 5,
  "limitType": "Unlimited",
  "name": "Cluster 1",
  "networkAlias": "qa-123",
  "networkAliasPort": null,
  "notifications": {
    "emailNotifications": [ {
      "bcc": null,
      "body": "${ops_system_identifier}",
      "cc": null,
      "emailConnection": "ecu-office-365",
      "emailTemplate": "agent-built-variables",
      "replyTo": null,
      "state": "Agents Unavailable",
      "subject": null,
      "sysId": "e120f05abd104e2e952c6b9e693891ab",
      "to": "support@stonebranch.com"
    } ],
    "snmpNotifications": [ {
      "severity": "Minor",
      "snmpManager": "test_manager",
      "state": "Agents Unavailable",
      "sysId": "fc4f4e8b0dea4b51a77a3c20f7e62b2a"
    } ]
  },
  "opswiseGroups": [],
  "resolutionDescription": "Agent in Use:'sb-qa-123'",
  "resolutionStatus": "Success",
  "resumedOn": "2021-06-29 19:18:30 -400",
  "suspended": false,
  "suspendedOn": null,
  "sysId": "35dc94a7a8834d28b51e03b5780cd90c",
  "type": "Windows"
  "version": 1
  },
  {
  "agents": [ {
    "agentName": "Mark-4 - AGNT002",
    "membershipDecommissioned": false,
    "membershipResumedOn": null,
    "membershipSuspended": true, 
    "membershipSuspendedOn": "2021-06-29 19:18:30 -400",
    "sysId": "941e558d6f2b4656bdb870e2551fa85f",
    "type": "Windows"
  } ],
  "currentCount": 0,
  "description": "Cluster of Windows Agents",
  "distribution": "Network Alias",
  "ignoreInactiveAgents": true,
  "ignoreSuspendedAgents": true,
  "lastAgentUsed": "sb-qa-123",
  "lastResolution": "2018-09-13 10:52:03.410 -0500",
  "limitAmount": 5,
  "limitType": "Unlimited",
  "name": "Cluster 2",
  "networkAlias": "qa-123",
  "networkAliasPort": null,
  "notifications": {
    "emailNotifications": [ {
      "bcc": null,
      "body": "${ops_system_identifier}",
      "cc": null,
      "emailConnection": "ecu-office-365",
      "emailTemplate": "agent-built-variables",
      "replyTo": null,
      "state": "Agents Unavailable",
      "subject": null,
      "sysId": "e120f05abd104e2e952c6b9e693891ab",
      "to": "support@stonebranch.com"
    } ],
    "snmpNotifications": [ {
      "severity": "Minor",
      "snmpManager": "test_manager",
      "state": "Agents Unavailable",
      "sysId": "fc4f4e8b0dea4b51a77a3c20f7e62b2a"
    } ]
  },
  "opswiseGroups": [],
  "resolutionDescription": "Agent in Use:'sb-qa-123'",
  "resolutionStatus": "Success",
  "resumedOn": null,
  "suspended": true,
  "suspendedOn": 2021-06-29 19:18:30 -400,
  "sysId": "35dc94a7a8834d28b51e03b5780cd90d",
  "type": "Windows"
  "version": 1
  }
]

Modify an Agent Cluster

	Description
URI	http://host_name/uc/resources/agentcluster
HTTP Method	PUT
Description	Modifies the Agent Cluster specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/agentcluster
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Modify an Agent Cluster: XML and JSON Examples.
Agent Cluster Properties	See Agent Cluster Properties.
Agent Properties	See Agent Properties.
Agent Cluster: Email Notification Properties	See Agent Cluster Email Notification Properties.
Agent Cluster: SNMP Notification Properties	See Agent Cluster SNMP Notification Properties.
Example Response	Status 200 /OK Successfully updated the agent cluster with sysId {sysId}.

Modify an Agent Cluster: XML and JSON Examples

XML

JSON

XML

<windowsAgentCluster>
      <description>Cluster of Windows Agents</description>
      <distribution>Any</distribution>
      <ignoreInactiveAgents>true</ignoreInactiveAgents>
      <ignoreSuspendedAgents>true0</ignoreSuspendedAgents>
      <limitAmount>5</limitAmount>
      <limitType>Limited</limitType>
      <name>cluster1</name>
      <networkAlias />
      <networkAliasPort />
      <notifications>
		<emailNotification>
			<sysId>2b7286b87a7048399fbd95c01a380002</sysId>
			<bcc />
			<body />
			<cc />
			<emailConnection>uc - Gmail Account</emailConnection>
			<emailTemplate>uc - Template</emailTemplate>
			<replyTo />
			<state>Agents Unavailable</state>
			<subject />
			<to />
		</emailNotification>
		<snmpNotification>
			<state>Agents Unavailable</state>
			<sysId>21d992c72be44b159aac91c4ee9f40c6</sysId>
			<severity>Minor</severity>
			<snmpManager>SNMP Manager</snmpManager>
		</snmpNotification>
      </notifications>
      <sysId>35dc94a7a8834d28b51e03b5780cd90c</sysId>
</windowsAgentCluster>

JSON

{
  "type": "windowsAgentCluster",
  "description": "Cluster of Windows Agents",
  "distribution": "Any",
  "ignoreInactiveAgents": true,
  "ignoreSuspendedAgents": true,
  "limitAmount": 5,
  "limitType": "Unlimited",
  "name": "cluster1",
  "networkAlias": null,
  "networkAliasPort": null,
  "notifications": {
    "emailNotifications": [ {
      "bcc": null,
      "body": "${ops_system_identifier}",
      "cc": null,
      "emailConnection": "ecu-office-365",
      "emailTemplate": "agent-built-variables",
      "replyTo": null,
      "state": "Agents Unavailable",
      "subject": null,
      "sysId": "e120f05abd104e2e952c6b9e693891ab",
      "to": "support@stonebranch.com"
    } ],
    "snmpNotifications": [ {
      "severity": "Minor",
      "snmpManager": "test_manager",
      "state": "Agents Unavailable",
      "sysId": "fc4f4e8b0dea4b51a77a3c20f7e62b2a"
    } ]
  },
  "sysId": "35dc94a7a8834d28b51e03b5780cd90c",
}

Read an Agent Cluster

	Description
URI	http://host_name/uc/resources/agentcluster
HTTP Method	GET
Description	Retrieves information on a specific Agent cluster.
URI Parameters	See Read an 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	See Read an Agent Cluster: XML and JSON Examples.
Agent Cluster Properties	See Agent Cluster Properties.
Agent Properties	See Agent Properties.
Agent Cluster: Email Notification Properties	See Agent Cluster Email Notification Properties.
Agent Cluster: SNMP Notification Properties	See Agent Cluster SNMP Notification Properties.

Read an Agent Cluster: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`agentclusterid`	ID used within the Controller to identify this Agent cluster.	String; URI parameter.	Y (unless `agentclustername` is specified)	`agentclustername`
`agentclustername`	Name used within the Controller to identify this Agent cluster.	String; URI parameter.	Y (unless `agentclusterid` is specified)	`agentclusterid`

Read an Agent Cluster: XML and JSON Examples

The retainSysIds and version properties are specified as attributes in XML.

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

XML

JSON

XML

<windowsAgentCluster exportReleaseLevel="7.2.0.0" exportTable="ops_windows_agent_cluster" retainsSysIds="true" version="1">
      <agents>
            <agent>
                  <agentName>pc - SS0001</agentName>
                  <membershipResumedOn />
                  <membershipSuspended>true</membershipSuspended>
                  <membershipSuspendedOn>2021-06-29 19:18:30 -400</membershipSuspendedOn>
                  <sysId>af1984d3481b4bccb9bea0e4e1d6fbf2</sysId>
                  <type>Windows</type>
            </agent>
      </agents>
      <currentCount>0</currentCount>
      <description>Cluster of Windows Agents</description>
      <distribution>Network Alias</distribution>
      <ignoreInactiveAgents>true</ignoreInactiveAgents>
      <ignoreSuspendedAgents>true0</ignoreSuspendedAgents>
      <lastAgentUsed>sb-qa-123</lastAgentUsed>
      <lastResolution>2018-09-12 09:52:03.410 -0500</lastResolution>
      <limitAmount>5</limitAmount>
      <limitType>Unlimited</limitType>
      <name>Cluster 1</name>
      <networkAlias>qa-123</networkAlias>
      <networkAliasPort />
      <notifications>
		<emailNotification>
			<sysId>2b7286b87a7048399fbd95c01a380002</sysId>
			<bcc />
			<body />
			<cc />
			<emailConnection>uc - Gmail Account</emailConnection>
			<emailTemplate>uc - Template</emailTemplate>
			<replyTo />
			<state>Agents Unavailable</state>
			<subject />
			<to />
		</emailNotification>
		<snmpNotification>
			<state>Agents Unavailable</state>
			<sysId>21d992c72be44b159aac91c4ee9f40c6</sysId>
			<severity>Minor</severity>
			<snmpManager>SNMP Manager</snmpManager>
		</snmpNotification>
      </notifications>
      <opswiseGroups /> 
      <resolutionDescription>Agent in Use:'sb-qa-123'</resolutionDescription>
      <resolutionStatus>Success</resolutionStatus>
      <resumedOn>2021-06-29 19:18:30 -400</resumedOn>
      <suspended>false</suspended>
      <suspendedOn /
      <sysId>35dc94a7a8834d28b51e03b5780cd90c</sysId>
</windowsAgentCluster>

JSON

{
  "type": "windowsAgentCluster",
  "agents": [ {
    "agentName": "Mark-4 - AGNT001",
    "membershipResumedOn": null,
    "membershipSuspended": true, 
    "membershipSuspendedOn": "2021-06-29 19:18:30 -400",
    "sysId": "941e558d6f2b4656bdb870e2551fa85e",
    "type": "Windows"
  } ],
  "currentCount": 0,
  "description": "Cluster of Windows Agents",
  "distribution": "Network Alias",
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_windows_agent_cluster",
  "ignoreInactiveAgents": true,
  "ignoreSuspendedAgents": true,
  "lastAgentUsed": "sb-qa-123",
  "lastResolution": "2018-09-12 09:52:03.410 -0500",
  "limitAmount": 5,
  "limitType": "Unlimited",
  "name": "Cluster 1",
  "networkAlias": "qa-123",
  "networkAliasPort": null,
  "notifications": {
    "emailNotifications": [ {
      "bcc": null,
      "body": "${ops_system_identifier}",
      "cc": null,
      "emailConnection": "ecu-office-365",
      "emailTemplate": "agent-built-variables",
      "replyTo": null,
      "state": "Agents Unavailable",
      "subject": null,
      "sysId": "e120f05abd104e2e952c6b9e693891ab",
      "to": "support@stonebranch.com"
    } ],
    "snmpNotifications": [ {
      "severity": "Minor",
      "snmpManager": "test_manager",
      "state": "Agents Unavailable",
      "sysId": "fc4f4e8b0dea4b51a77a3c20f7e62b2a"
    } ]
  },
  "opswiseGroups": [],
  "resolutionDescription": "Agent in Use:'sb-qa-123'",
  "resolutionStatus": "Success",
  "retainSysIds": true,
  "resumedOn": "2021-06-29 19:18:30 -400",
  "suspended": false,
  "suspendedOn": null,
  "sysId": "35dc94a7a8834d28b51e03b5780cd90c",
  "version": 1
}

Resolve an Agent Cluster

	Description
URI	http://host_name/uc/resources/agentcluster/resolve
HTTP Method	POST
Description	Resolves the Network Alias for the specified agent cluster.
Example URI	http://localhost:8080/uc/resources/agentcluster/resolve
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Resolve an Agent Cluster: XML and JSON Examples.
Request Properties	See Resolve an Agent Cluster: Request Properties.
Example Response	See Resolve an Agent Cluster: XML and JSON Examples.

Resolve an Agent Cluster: XML and JSON Examples

Example

XML

JSON

Example Request

XML

<resolve-agent-cluster>
  <agentClusterName>Agent_Cluster_Alias_Production</agentClusterName>
</resolve-agent-cluster>

JSON

{
  "agentClusterName": "Agent_Cluster_Alias_Production"
}

Example Response

XML

<command-response>
  <type>resolve_agent_cluster</type>
  <success>true</success>
  <info>Successfully resolved network alias for agent cluster "Agent_Cluster_Alias_Production".</info>
  <errors></errors>
</command-response>

JSON

{
    "type": "resolve_agent_cluster",
    "success": true,
    "info": "Successfully resolved agent cluster\"Agent_Cluster_Alias_Production\".",
    "errors": ""
}

Resolve an Agent Cluster: Request Properties

Property	UI Field Name	Description	Specifications	Required
`agentClusterName`	Cluster Name	Name used within the Controller to identify this agent cluster.		Y

Resume an Agent Cluster

	Description
URI	http://host_name/uc/resources/agentcluster/resume
HTTP Method	POST
Description	Resumes the specified agent cluster.
Example URI	http://localhost:8080/uc/resources/agentcluster/resume
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Resume an Agent Cluster: XML and JSON Examples.
Request Properties	See Resume an Agent Cluster: Request Properties.
Example Response	See Resume an Agent Cluster: XML and JSON Examples.

Resume an Agent Cluster: XML and JSON Examples

Example

XML

JSON

Example Request

XML

<resume-agent-cluster>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
</resume-agent-cluster>

JSON

{
  "agentClusterNameagentClusterName": "uc - Default Windows Cluster"
}

Example Response

XML

<command-response>
  <type>resume_agent_cluster</type>
  <success>true</success>
  <info>Successfully resumed agent cluster "uc - Default Windows Cluster".</info>
  <errors />
</command-response>

JSON

{
    "type": "resume_agent_cluster",
    "success": true,
    "info": " Successfully resumed agent cluster "uc - Default Windows Cluster".",
    "errors": ""
}

Resume an Agent Cluster: Request Properties

Property	UI Field Name	Description	Specifications	Required
`agentClusterName`	Cluster Name	Name used within the Controller to identify this agent cluster.		Y

Resume an Agent Cluster Membership

	Description
URI	http://host_name/uc/resources/agent/ops-resume-agent-cluster-membership
HTTP Method	POST
Description	Resumes the specified agent cluster membership.
Example URI	http://localhost:8080/uc/resources/agent/ops-resume-agent-cluster-membership
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Resume an Agent Cluster Membership: XML and JSON Examples.
Request Properties	See Resume an Agent Cluster Membership: Request Properties.
Example Response	See Resume an Agent Cluster Membership: XML and JSON Examples.

Resume an Agent Cluster Membership: XML and JSON Examples

Example

XML

JSON

Example Request

XML

By Agent Name

<resume-agent-cluster-membership>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
  <agentName>XPS-8300 - AGNT0001</agentName>
</resume-agent-cluster-membership>

By Agent ID

<resume-agent-cluster-membership>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
  <agentID>AGNT0001</agentID>
</resume-agent-cluster-membership>

JSON

By Agent Name

{
  "agentClusterName": "uc - Default Windows Cluster",
  "agentName": "XPS-8300 - AGNT0001"
}

By Agent ID

{
  "agentClusterName": "uc - Default Windows Cluster",
  "agentID": "AGNT0001"
}

Example Response

XML

<command-response>
  <type>resume_agent_cluster_membership</type>
  <success>true</success>
  <info>Successfully resumed agent cluster membership.</info>
  <errors />
</command-response>

JSON

{
    "type": "resume_agent_cluster_membership",
    "success": true,
    "info": " Successfully resumed agent cluster membership.",
    "errors": ""
}

Resume an Agent Cluster Membership: Request Properties

Property	UI Field Name	Description	Required	Mutually Exclusive With
`agentClusterName`	Cluster Name	Name used within the Controller to identify this agent cluster.	Y
`agentID`	Agent ID	Defined by the user when installing the Agent; name used within the Controller to identify this resource.	Y (unless `agentName` is specified)	`agentName`
`agentName`	Agent Name	Unique ID for this Agent, created during installation. The name of the communications server message queue. The Controller uses the communications server for communications between the Controller scheduler and Agents.	Y (unless `agentId` is specified)	`agentId`

Return an Agent from an Agent Cluster

	Description
URI	http://hostName:port/uc/resources/agentcluster/agent
HTTP Method	GET
Description	Retrieves information on a specific Agent from an Agent Cluster for which a Distribution method of Any or Lowest CPU Utilization is specified.
URI Parameters	See Return an Agent from an Agent Cluster: URI Parameters.
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Request URI	http://localhost:8080/uc/resources/agentcluster/agent?agentclustername=testCluster&ignoreexecutionlimit=true
Example Response	See Return an Agent from an Agent Cluster: Example Response.

Return an Agent from an Agent Cluster: URI Parameters

Parameter	Description	Specifications	Required
`agentclustername`	Name used within the Controller to identify this agent cluster.	Type = String; URI property.	Y
`ignoreexecutionlimit`	Specification to use or ignore the task execution limit.	Type = Boolean (true/false), Default is false; URI property.	N

Return an Agent from an Agent Cluster: Example Response

XML Response

JSON Response

XML Response

<agent>
  <hostName>Mark-4</hostName>
  <ipAddress>192.168.1.21</ipAddress>
  <name>Mark-4 - AGNT0002</name>
  <outputProhibited>false</outputProhibited>      
  <queueName>AGNT0002</queueName>
  <status>Active</status>
  <suspended>false</suspended>
  <sysID>4425b28449574bb181d78e47c02867ac</sysID>
  <type>Windows</type>
  <version>6.4.1.0</version>
</agent>

JSON Response

{
  "hostName": "Mark-4",
  "ipAddress": "192.168.1.21",
  "name": "Mark-4 - AGNT0002",
  "outputProhibited": false,
  "queueName": "AGNT0002",
  "status": "Active",
  "suspended": false,
  "sysID": "b4784b52bf0e453db37dc0c5e9bd441a",
  "type": "Windows",
  "version": "6.4.1.0"
}

Set an Agent Cluster Task Execution Limit

	Description
URI	http://host_name/uc/resources/agentcluster/taskexecutionlimit
HTTP Method	POST
Description	Sets the task execution limit for the specified agent cluster.
Example URI	http://localhost:8080/uc/resources/agentcluster/taskexecutionlimit
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Set an Agent Cluster Task Execution Limit: XML and JSON Examples.
Request Properties	See Set an Agent Cluster Task Execution Limit: Request Properties.
Example Response	See Set an Agent Cluster Task Execution Limit: XML and JSON Examples.

Set an Agent Cluster Task Execution Limit: XML and JSON Examples

Example

XML

JSON

Example Request

XML

Limit Type: Limited

<set-agent-cluster-task-execution-limit>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
  <limitAmount>15</limitAmount>
  <limitType>Limited</limitType>
</set-agent-cluster-task-execution-limit>

Limit Type: Unlimited

<set-agent-cluster-task-execution-limit>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
  <limitType>Unlimited</limitType>
</set-agent-cluster-tas

JSON

Limit Type: Limited

{
  "agentClusterName": "uc - Default Windows Cluster",
  "limitAmount": 15,
  "limitType": "Limited"
}

Limit Type: Unlimited

{
  "agentClusterName": "uc - Default Windows Cluster",
  "limitType": "Unlimited"
}

Example Response

XML

<command-response>
  <type>set_agent_cluster_task_execution_limit</type>
  <success>true</success>
  <info>Successfully updated agent cluster"uc - Default Windows Cluster" with task limit type: "Limited", amount: "15".</info>
  <errors />
</command-response>

JSON

{
    "type": "set_agent_cluster_task_execution_limit",
    "success": true,
    "info": " Successfully updated agent cluster"uc - Default Windows Cluster" with task limit type: "Limited", amount: "15".",
    "errors": ""
}

Set an Agent Cluster Task Execution Limit: Request Properties

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 `limitType` is Limited (2).	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. For purposes of imposing this task execution limit, running task instances are those in any of these statuses: Cancel Pending, Queued, Received, Running, Submitted, and Started.	Valid values: As String = Unlimited, As Value = 1 As String = Limited, As Value = 2	Y

Suspend an Agent Cluster

	Description
URI	http://host_name/uc/resources/agentcluster/suspend
HTTP Method	POST
Description	Suspends the specified agent cluster.
Example URI	http://localhost:8080/uc/resources/agentcluster/suspend
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Suspend an Agent Cluster: XML and JSON Examples.
Request Properties	See Suspend an Agent Cluster: Request Properties.
Example Response	See Suspend an Agent Cluster: XML and JSON Examples.

Suspend an Agent Cluster: XML and JSON Examples

Example

XML

JSON

Example Request

XML

<suspend-agent-cluster>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
</suspend-agent-cluster>

JSON

{
  "agentClusterName": "uc - Default Windows Cluster"
}

Example Response

XML

<command-response>
  <type>suspend_agent_cluster</type>
  <success>true</success>
  <info>Successfully suspended agent cluster "uc - Default Windows Cluster".</info>
  <errors />
</command-response>

JSON

{
    "type": "suspend_agent_cluster",
    "success": true,
    "info": " Successfully suspended agent cluster "uc - Default Windows Cluster".",
    "errors": ""
}

Suspend an Agent Cluster: Request Properties

Property	UI Field Name	Description	Specifications	Required
`agentClusterName`	Cluster Name	Name used within the Controller to identify this agent cluster.		Y

Suspend an Agent Cluster Membership

	Description
URI	http://host_name/uc/resources/agent/ops-suspend-agent-cluster-membership
HTTP Method	POST
Description	Suspends the specified agent cluster membership.
Example URI	http://localhost:8080/uc/resources/agent/ops-suspend-agent-cluster-membership
Authentication	HTTP Basic
Consumes Content-Type	application/xml, application/json
Produces Content-Type	application/xml, application/json
Example Request	See Suspend an Agent Cluster Membership: XML and JSON Examples.
Request Properties	See Suspend an Agent Cluster Membership: Request Properties.
Example Response	See Suspend an Agent Cluster Membership: XML and JSON Examples.

Suspend an Agent Cluster Membership: XML and JSON Examples

Example

XML

JSON

Example Request

XML

By Agent Name

<suspend-agent-cluster-membership>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
  <agentName>XPS-8300 - AGNT0001</agentName>
</suspend-agent-cluster-membership>

By Agent ID

<suspend-agent-cluster-membership>
  <agentClusterName>uc - Default Windows Cluster</agentClusterName>
  <agentID>AGNT0001</agentID>
</suspend-a

JSON

By Agent Name

{
  "agentClusterName": "uc - Default Windows Cluster",
  "agentName": "XPS-8300 - AGNT0001"
}

By Agent ID

{
  "agentClusterName": "uc - Default Windows Cluster",
  "agentID": "AGNT0001"
}

Example Response

XML

<command-response>
  <type>suspend_agent_cluster_membership</type>
  <success>true</success>
  <info>Successfully suspended agent cluster membership.</info>
  <errors />
</command-response>

JSON

{
    "type": "suspend_agent_cluster_membership",
    "success": true,
    "info": " Successfully suspended agent cluster membership.",
    "errors": ""
}

Suspend an Agent Cluster Membership: Request Properties

Property	UI Field Name	Description	Required	Mutually Exclusive With
`agentClusterName`	Cluster Name	Name used within the Controller to identify this agent cluster.	Y
`agentID`	Agent ID	Unique ID for this Agent, created during installation.	Y (unless `agentName` is specified)	`agentName`
`agentName`	Agent Name	Name used within the Controller to identify this resource.	Y (unless `agentId` is specified)	`agentId`

Universal Controller 7.2.x

Agent Cluster Web Services

Overview

Create an Agent Cluster

Agent Cluster Properties

Agent Properties

Agent Cluster: Email Notification Properties

Agent Cluster: SNMP Notification Properties

Delete an Agent Cluster

Delete an Agent Cluster: URI Parameters

List Agent Clusters

List Agent Clusters: XML and JSON Examples

Modify an Agent Cluster

Modify an Agent Cluster: XML and JSON Examples

Read an Agent Cluster

Read an Agent Cluster: URI Parameters

Read an Agent Cluster: XML and JSON Examples

Resolve an Agent Cluster

Resolve an Agent Cluster: XML and JSON Examples

Resolve an Agent Cluster: Request Properties

Resume an Agent Cluster

Resume an Agent Cluster: XML and JSON Examples

Resume an Agent Cluster: Request Properties

Resume an Agent Cluster Membership

Resume an Agent Cluster Membership: XML and JSON Examples

Resume an Agent Cluster Membership: Request Properties

Return an Agent from an Agent Cluster

Return an Agent from an Agent Cluster: URI Parameters

Return an Agent from an Agent Cluster: Example Response

Set an Agent Cluster Task Execution Limit

Set an Agent Cluster Task Execution Limit: XML and JSON Examples

Set an Agent Cluster Task Execution Limit: Request Properties

Suspend an Agent Cluster

Suspend an Agent Cluster: XML and JSON Examples

Suspend an Agent Cluster: Request Properties

Suspend an Agent Cluster Membership

Suspend an Agent Cluster Membership: XML and JSON Examples

Suspend an Agent Cluster Membership: Request Properties