Panel

Table of Contents

maxlevel	1

...

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.

...

	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 Web Services#Agent Cluster Properties.
Agent Properties	See Agent Cluster Web Services#Agent Properties.
Agent Cluster: Email Notification Properties	See Agent Cluster Web Services#Agent Cluster Email Notification Properties.
Agent Cluster: SNMP Notification Properties	See Agent Cluster Web Services#Agent Cluster SNMP Notification Properties.
Example Response	Status 200 /OK Successfully created the agent cluster with sysId {sysId}.

...

currentCount currentCount currentCountIf limitType is Limited (2); Current number of tasks currently being run by the Agents Integer; Read onlydescription description descriptiondistribution

Valid Values:

Default is Any suspended suspended suspendedIndication of whether or not the

Property

UI Field Name

Description

Specifications

Required

Anchor

	agentLimitAmount - CAC

	agentLimitAmount - CAC

Current Task Count

agentLimitAmount

Agent Limit Amount

If agentLimitType = Limited; Limit of number of agents in this agent cluster.

Default is 10.

N

Anchor

	agentLimitType - CAC

	agentLimitType - CAC

agentLimitType

Description

User-defined; description of this record.

N

Anchor

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:

As String = Unlimited, As Value = 1
As String = Limited, As Value = 2

Default is Unlimited (1).

N

read only

Anchor

	exportReleaseLevel currentCount - CACexportReleaseLevel
	currentCount - CAC

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

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

Anchor

	exportTable description - CACexportTable
	description - CAC

exportTabledescription

n/a

Record table information.

read only

Description

User-defined; description of this record.

N

Anchor

	ignoreInactiveAgents distribution - CACignoreInactiveAgents
	distribution - CAC

ignoreInactiveAgentsdistribution

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:

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

Specification for whether or not suspended Agents should be ignored when the agent

Anchor

	ignoreSuspendedAgents exportReleaseLevel - CACignoreSuspendedAgents
	exportReleaseLevel - CAC

ignoreSuspendedAgents

Ignore Suspended Agents

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - CAC
	exportTable - CAC

exportTable

n/a

Record table information.

read only

N

Anchor

	ignoreInactiveAgents - CAC
	ignoreInactiveAgents - CAC

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

Anchor

	ignoreSuspendedAgents - CAC
	ignoreSuspendedAgents - CAC

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

Anchor

	lastAgentUsed - CAC
	lastAgentUsed - CAC

lastAgentUsed

Last Agent Used

Agent that was selected the last time a task was sent to this Agent Cluster.

Read only.

N

Anchor

	lastResolution - CAC
	lastResolution - CAC

lastResolution

Last Resolution

If distribution is Network Alias (4); Last attempted time of Network Alias resolution.

Read only.

N

Anchor

	limitAmount - CAC
	limitAmount - CAC

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

Anchor

	limitType - CAC
	limitType - CAC

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:Default

As String = Unlimited, As Value = 1
As String = Limited, As Value = 2

Default is Unlimited (1).

N

Anchor

	name - CAC
	name - CAC

name

Cluster Name

Name of this Agent Cluster.

Y

Anchor

	networkAlias - CAC
	networkAlias - CAC

networkAlias

Network Alias

If distribution is Network Alias (4); Network alias (or VIP).

N

Anchor

	networkAliasPort - CAC
	networkAliasPort - CAC

networkAliasPort

Agent Port

If distribution is Network Alias (4); Network alias (or VIP) port that the Agent's Universal Broker is listening on.

N

Anchor

	opswiseGroups - CAC
	opswiseGroups - CAC

opswiseGroups

Member of Business Services

List of Business Services that this Agent Cluster belongs to.

Format:

XML

Panel
<opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups>

JSON

Panel
"opswiseGroups": ["test"]

N

Anchor

	resolutionDescription - CAC
	resolutionDescription - CAC

resolutionDescription

Resolution Description

If distribution is Network Alias (4); Description of the last attempted resolution.

Read only.

N

Anchor

	resolutionStatus - CAC
	resolutionStatus - CAC

resolutionStatus

Resolution Status

If distribution is Network Alias (4); Status of the last resolution of the Network Alias.

Read only.

N

Anchor

	resumedOn - CAC
	resumedOn - CAC

resumedOn

Resumed On

Date and time when a suspended Agent Cluster was resumed.

Read only.

N

Anchor

	retainSysIds - CAC
	retainSysIds - CAC

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

title	Note

In XML web services, retainSysIds is specified as an attribute in the <agentCluster> element.

Optional; Valid values: true/false (default is true).

N

Anchor

	Strict Business Services Membership - CAC

	Strict Business Services Membership - CAC

Suspended

strictBsrvcMembership

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 false.

N

Anchor

	suspended - CAC
	suspended - CAC

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

Anchor

	suspendedOn - CAC
	suspendedOn - CAC

suspendedOn

Suspended On

Date and time when the Agent Cluster was suspended.

Read only.

N

Anchor

	sysId - CAC
	sysId - CAC

sysId

n/a

sys_id used within the Controller to identify this Agent Cluster.

N

Anchor

	type - CAC
	type - CAC

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

...

Property

UI Field Name

Description

Specifications

Anchor

	bcc - email
	bcc - email

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.

Anchor

	body - email
	body - email

body

Body

Text of the email message.

Variables and Functions are supported. If the emailTemplate contains text in the body, this text is appended.

Anchor

	cc - email
	cc - email

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.

Anchor

	emailConnection - email
	emailConnection - email

emailConnection

Email Connection

Name of an Email Connection.

If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.

Anchor

	emailTemplate - email
	emailTemplate - email

emailTemplate

Email Template

Name of an Email Template.

If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.

Anchor

	replyTo - email
	replyTo - email

replyTo

Reply-To

Email address of the sender of the email.

Use commas to separate multiple recipients. Variables and Functions are supported.

Anchor

	state - email
	state - email

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

Anchor

	subject - email
	subject - email

subject

Subject

Subject line of the email.

Variables and Functions are supported.

Anchor

	sysid - email
	sysid - email

sysId

n/a

sys_id used within the Controller to identify this Email Notification.

Anchor

	to - email
	to - email

to

To

Email address of the recipient.

Use commas to separate multiple recipients Variables and Functions are supported.

...

Property

UI Field Name

Description

Specifications

Anchor

	severity - snmp
	severity - snmp

severity

Notification Severity

Severity level of this notification.

Valid values:Default is Normal (1

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).

Anchor

	snmpManager - snmp
	snmpManager - snmp

snmpManager

SNMP Manager

SNMP Manager that will receive this notification.

Anchor

	state - snmp
	state - snmp

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

Anchor

	sysId - snmp
	sysId - snmp

sysId

n/a

sys_id used within the Controller to identify this SNMP Notification.

...

	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 Web Services#Agent Cluster Properties.
Agent Properties	See Agent Cluster Web Services#Agent Properties.
Agent Cluster: Email Notification Properties	See Agent Cluster Web Services#Agent Cluster Email Notification Properties.
Agent Cluster: SNMP Notification Properties	See Agent Cluster Web Services#Agent Cluster SNMP Notification Properties.

Anchor
List Agent Clusters XML and JSON Examples
List Agent Clusters XML and JSON Examples
List Agent Clusters: XML and JSON Examples

XML

JSON

Expand

title	XML

<agentClusters>
      <agentCluster version="1">
       <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>
            <strictBsrvcMembership>false</strictBsrvcMembership>
            <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 />
            <strictBsrvcMembership>false</strictBsrvcMembership>
            <suspended>true</suspended>
            <suspendedOn>2021-06-29 19:18:30 -400</suspendedOn>
            <sysId>cb5b876aa9fec69f0032b55e0391d694</sysId>
            <type>Windows</type>
      </agentCluster>
</agentClusters>

Expand

title	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",
  "strictBsrvcMembership":false,
  "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,
  "strictBsrvcMembership":false,
  "suspended": true,
  "suspendedOn": 2021-06-29 19:18:30 -400,
  "sysId": "35dc94a7a8834d28b51e03b5780cd90d",
  "type": "Windows"
  "version": 1
  }
]

Anchor
List Agent Cluster - Advanced
List Agent Cluster - Advanced
List Agent Cluster - Advanced

	Description
URI	http://host_name/uc/resources/agentcluster/listadv
HTTP Method	GET
Description	Retrieves Agent Clusters details using specific query parameters.
Example URI	http://localhost:8080/uc/resources/agentcluster/listadv http://localhost:8080/uc/resources/agentcluster/listadv?agentclustername=cluster http://localhost:8080/uc/resources/agentcluster/listadv?businessServices=bs1 http://localhost:8080/uc/resources/agentcluster/listadv?type=Linux/Unix http://localhost:8080/uc/resources/agentcluster/listadv?agentclustername=cluster&businessServices=bs1,bs2&type=Windows
Authentication	HTTP Basic
Produces Content-Type	application/xml, application/json
Consumes Content-Type	n/a
Example Responses	See List Agent Cluster - Advanced: XML and JSON Examples
URI Properties	See List Agent Cluster - Advanced: URI Properties

Anchor
List Agent Cluster - Advanced URI Properties
List Agent Cluster - Advanced URI Properties
List Agent Cluster - Advanced: URI Properties

Property

UI Field Name

Description

Specifications

Required

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):

As String = Windows, As Value = 1
As String = Linux/Unix, As Value = 2

If type is not specified, defaults to all types.

N

Anchor
List Agent Cluster - Advanced XML and JSON Examples
List Agent Cluster - Advanced XML and JSON Examples
List Agent Cluster - Advanced: XML and JSON Examples

XML

JSON

Expand

title	XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<agentClusters>
    <unixAgentCluster exportReleaseLevel="7.3.0.0" exportTable="ops_unix_agent_cluster" retainSysIds="true" version="2">
        <agents/>
        <currentCount>0</currentCount>
        <description />
        <distribution>Any</distribution>
        <ignoreInactiveAgents>false</ignoreInactiveAgents>
        <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
        <lastAgentUsed />
        <lastResolution />
        <limitAmount>5</limitAmount>
        <limitType>Unlimited</limitType>
        <name>linux_cluster_1</name>
        <networkAlias />
        <networkAliasPort />
        <notifications/>
        <opswiseGroups/>
        <resolutionDescription />
        <resolutionStatus>None</resolutionStatus>
        <resumedOn />

<strictBsrvcMembership>false</strictBsrvcMembership>

        <suspended>false</suspended>
        <suspendedOn />
        <sysId>89ef2f9a35684825849881978b827ee7</sysId>
    </unixAgentCluster>
    <unixAgentCluster exportReleaseLevel="7.3.0.0" exportTable="ops_unix_agent_cluster" retainSysIds="true" version="2">
        <agents/>

     <currentCount>0</currentCount>
        <description />

<agent>

     <distribution>Any</distribution>
        <ignoreInactiveAgents>false</ignoreInactiveAgents>

<ignoreSuspendedAgents>false</ignoreSuspendedAgents>
        <lastAgentUsed />

<lastResolution />
        <limitAmount>5</limitAmount>
        <limitType>Unlimited</limitType>

<membershipResumedOn

/>

  <name>linux_cluster_2</name>
        <networkAlias />
        <networkAliasPort

<membershipSuspended>true<

membershipSuspended


        <notifications/>

<opswiseGroups/>

<membershipSuspendedOn>2021-06-29

19:18:30

-400</membershipSuspendedOn>

     <resolutionDescription />
        <resolutionStatus>None</resolutionStatus>
        <resumedOn

<sysId>af1984d3481b4bccb9bea0e4e1d6fbf2<

sysId

>
        <suspended>false</suspended>
        <suspendedOn />

<type>Linux/Unix</type>

<strictBsrvcMembership>false</strictBsrvcMembership>        <sysId>a47c4a0e6c1d4da5896dd9c072bacb28</sysId>
    </unixAgentCluster>

</agent>

<windowsAgentCluster exportReleaseLevel="7.3.0.0" exportTable="ops_windows_agent_cluster" retainSysIds="true" version="1">

<

<agents/

agents>

>
        <currentCount>0</currentCount>

     <description />

<description>Cluster

of

Linux

Agents<

<distribution>Any</

description>

distribution>
        <ignoreInactiveAgents>false</ignoreInactiveAgents>

<distribution>Network

Alias</distribution>

   <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
        <lastAgentUsed

/>
        <lastResolution />

    <limitAmount>5</limitAmount>

<limitType>Unlimited</limitType>
        <name>wins_cluster_1</name>

<lastResolution>2018-09-12

09:52:03.410

-0500</lastResolution>

  <networkAlias />
        <networkAliasPort

<limitAmount>5<

limitAmount

>
        <notifications/>

<limitType>Unlimited</limitType>

     <opswiseGroups/>

<name>Cluster

<resolutionDescription

1<

name

>
        <resolutionStatus>None</resolutionStatus>

     <resumedOn />

<networkAliasPort

 <strictBsrvcMembership>false</

>

strictBsrvcMembership>

        <suspended>false</suspended>

<sysId>2b7286b87a7048399fbd95c01a380002</sysId> <bcc

 <suspendedOn />

<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>


        <sysId>3f5c2bb17d2d43149eb70da856c51fe2</sysId>
    </windowsAgentCluster>
    <windowsAgentCluster exportReleaseLevel="7.3.0.0" exportTable="ops_windows_agent_cluster" retainSysIds="true" version="1">
        <agents/>
        <currentCount>0</currentCount>
        <description />

</notifications>

     <distribution>Any</distribution>

<opswiseGroups

 <ignoreInactiveAgents>false</

>

ignoreInactiveAgents>
        <ignoreSuspendedAgents>false</ignoreSuspendedAgents>

<resolutionDescription>Agent

in

Use:'sb-qa-123'</resolutionDescription>

  <lastAgentUsed />
        <lastResolution

<resolutionStatus>Success<

resolutionStatus

>
        <limitAmount>5</limitAmount>

<resumedOn>2021-06-29

19:18:30

-400</resumedOn>

   <limitType>Unlimited</limitType>

<suspended>false</suspended>

<name>wins_cluster_2</name>
        <networkAlias />

<suspendedOn

/>

      <networkAliasPort />

   <notifications/>

<type>Windows<

<opswiseGroups/

type

</agentCluster>

  <resolutionDescription />

<agentCluster

version="1">

    <resolutionStatus>None</resolutionStatus>

<resumedOn />
        <strictBsrvcMembership>false</strictBsrvcMembership>

<agent>

<suspended>false</suspended>
        <suspendedOn />
        <sysId>3dc7749381ab461883f6a1807c7c3c7d</sysId>
    </windowsAgentCluster>
<

Agent Cluster Web Services#agentName>pc - SS0002</Agent Cluster Web Services#agentName>

/agentClusters>

Expand

title	JSON

[
    {
        "type": "unixAgentCluster",
        "agents": [],

<membershipDecommissioned>false</membershipDecommissioned>

    "currentCount": 0,
        "description": null,

"distribution": "Any",
        "exportReleaseLevel": "7.3.0.0",
        "exportTable": "ops_unix_agent_cluster",

    "ignoreInactiveAgents": false,
        "ignoreSuspendedAgents": false,

"lastAgentUsed": null,
        "lastResolution": null,
        "limitAmount": 5,

    "limitType": "Unlimited",

"name": "linux_cluster_1",

<type>Windows</type>

   "networkAlias": null,
        "networkAliasPort": null,

</agent>

    "notifications": {

</agents>

     "emailNotifications": [],

      "snmpNotifications": []

<description>Cluster

of

Windows

Agents</description>

 },
        "opswiseGroups": [],

<distribution>Network

Alias</distribution>

      "resolutionDescription": null,

   "resolutionStatus": "None",

"resumedOn": null,

 "retainSysIds": true,
        "strictBsrvcMembership": false,

<lastResolution>2018-09-13

10:52:03.410

-0500</lastResolution>

      "suspended": false,

   "suspendedOn": null,

<limitType>Unlimited</limitType>

"sysId": "89ef2f9a35684825849881978b827ee7",
        "version": 2

<name>Cluster

2</name>

  },
    {

   "type": "unixAgentCluster",

"agents": [],
        "currentCount": 0,

<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>

     "description": null,
        "distribution": "Any",
        "exportReleaseLevel": "7.3.0.0",
        "exportTable": "ops_unix_agent_cluster",

</notifications>

"ignoreInactiveAgents": false,
        "ignoreSuspendedAgents": false,

<opswiseGroups

/>

      "lastAgentUsed": null,

<resolutionDescription>Agent

in

Use:'sb-qa-123'</resolutionDescription>

"lastResolution": null,
        "limitAmount": 5,

<resolutionStatus>Success</resolutionStatus>

       "limitType": "Unlimited",

<resumedOn

/>

"name": "linux_cluster_2",

  "networkAlias": null,

"networkAliasPort": null,
        "notifications": {

          "emailNotifications": [],

<type>Windows</type>

</agentCluster>

</agentClusters> Expand

title	JSON

[ {

agents

snmpNotifications": []

{

"agentName":

"Mark-4

-

AGNT001"

},

"membershipDecommissioned":

true,

membershipResumedOn

opswiseGroups":

null

[],

"membershipSuspended": true,

membershipSuspendedOn

resolutionDescription":

"2021-06-29 19:18:30 -400",

 null,
        "

sysId

resolutionStatus": "

941e558d6f2b4656bdb870e2551fa85e

None",
        "

type

resumedOn":

"Linux/Unix"

 null,

}

],

currentCount

retainSysIds":

0

true,

"description

      "strictBsrvcMembership":

"Cluster of Linux Agents",

false, 
        "

distribution

suspended":

"Network Alias",

 false,
        "

ignoreInactiveAgents

suspendedOn":

true

null,

"ignoreSuspendedAgents": true,

lastAgentUsed

sysId": "

sb-qa-123

a47c4a0e6c1d4da5896dd9c072bacb28",

"lastResolution":

"2018-09-12

09:52:03.410

-0500",

limitAmount

version":

5,

 2
    },

"limitType": "Unlimited",

"name":

"Cluster

1",

networkAlias

type": "

qa-123

windowsAgentCluster",
        "

networkAliasPort

agents":

null

[],

"notifications":

{

emailNotifications

currentCount":

[

0,

{

bcc

description": null,
        "

body

distribution": "

${ops_system_identifier}

Any",
        "

cc

exportReleaseLevel":

null,

"7.3.0.0",
        "

emailConnection

exportTable": "

ecu-office-365

ops_windows_agent_cluster",
        "

emailTemplate

ignoreInactiveAgents":

"agent-built-variables",

 false,
        "ignoreSuspendedAgents": false,
        "

replyTo

lastAgentUsed": null,
        "

state

lastResolution":

"Agents Unavailable",

null,
        "

subject

limitAmount":

null

5,
        "

sysId

limitType": "

e120f05abd104e2e952c6b9e693891ab

Unlimited",
        "

to

name": "

support@stonebranch.com"

wins_cluster_1",

}

],

snmpNotifications

networkAlias":

[

null,

{

severity

networkAliasPort":

"Minor"

null,
        "

snmpManager

notifications":

"test_manager",

 {
            "

state

emailNotifications":

"Agents Unavailable",

[],
            "

sysId

snmpNotifications":

"fc4f4e8b0dea4b51a77a3c20f7e62b2a"

[]

}

]

   },
        "opswiseGroups": [],
        "resolutionDescription":

"Agent in Use:'sb-qa-123'",

 null,
        "resolutionStatus": "

Success

None",
        "resumedOn":

"2021-06-29 19:18:30 -400",

null,
        "

suspended

retainSysIds":

false

true,

"suspendedOn":

null,

sysId

strictBsrvcMembership":

"35dc94a7a8834d28b51e03b5780cd90c",

false,

"type":

"Windows"

version

suspended":

1

false,

},

{

agents

suspendedOn":

[

null,

{

"Agent

Cluster

Web

Services#agentName

"sysId": "

Mark-4 - AGNT002

3f5c2bb17d2d43149eb70da856c51fe2",

"membershipDecommissioned":

false,

membershipResumedOn

version":

null,

"membershipSuspended":

true

},

"membershipSuspendedOn":

"2021-06-29

19:18:30

-400",

sysId

type": "

941e558d6f2b4656bdb870e2551fa85f

windowsAgentCluster",
        "

type

agents":

"Windows"

[],

}

],

   "currentCount": 0,


        "description":

"Cluster of Windows Agents",

 null,
        "distribution": "

Network Alias

Any",
        "

ignoreInactiveAgents

exportReleaseLevel":

true,

"7.3.0.0",

"ignoreSuspendedAgents": true,

lastAgentUsed

exportTable": "

sb-qa-123

ops_windows_agent_cluster",

"lastResolution":

"2018-09-13

10:52:03.410

-0500",

limitAmount

ignoreInactiveAgents":

5,

false,
        "

limitType

ignoreSuspendedAgents":

"Unlimited"

false,

"name":

"Cluster

2",

networkAlias

lastAgentUsed":

"qa-123",

null,
        "

networkAliasPort

lastResolution": null,

"notifications":

{

emailNotifications

limitAmount":

[

5,

{

bcc

limitType":

null

"Unlimited",
        "

body

name": "

${ops

wins_

system

cluster_

identifier}

2",
        "

cc

networkAlias": null,
        "

emailConnection

networkAliasPort":

"ecu-office-365"

null,
        "

emailTemplate

notifications":

"agent-built-variables",

"replyTo":

null,

state

emailNotifications":

"Agents Unavailable",

[],

"subject":

null,

sysId

snmpNotifications":

"e120f05abd104e2e952c6b9e693891ab",

[]

"to":

"support@stonebranch.com"

},

} ],

snmpNotifications

opswiseGroups": [],

{

severity

resolutionDescription":

"Minor"

null,
        "

snmpManager

resolutionStatus": "

test_manager

None",
        "

state

resumedOn":

"Agents Unavailable",

null,
        "

sysId

retainSysIds":

"fc4f4e8b0dea4b51a77a3c20f7e62b2a"

true,

}

]

},

opswiseGroups

strictBsrvcMembership":

[]

false,

"resolutionDescription":

"Agent

in

Use:'sb-qa-123'",

resolutionStatus

suspended":

"Success"

false,

"resumedOn":

null,

"suspended":

true,

  "suspendedOn":

2021-06-29 19:18:30 -400,

 null,
        "sysId": "

35dc94a7a8834d28b51e03b5780cd90d

3dc7749381ab461883f6a1807c7c3c7d",

"type":

"Windows"

   "version": 1
    }
]

Anchor
Modify an Agent Cluster
Modify an Agent Cluster
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

Anchor

	Example Request
	Example Request

Example Request

See Modify an Agent Cluster: XML and JSON Examples.

Agent Cluster Properties

See Agent Cluster Web Services#Agent Cluster Properties.

Agent Properties

See Agent Cluster Web Services#Agent Properties.

Agent Cluster: Email Notification Properties

See Agent Cluster Web Services#Agent Cluster Email Notification Properties.

Agent Cluster: SNMP Notification Properties

See Agent Cluster Web Services#Agent Cluster SNMP Notification Properties.

Example Response

Status 200 /OK
Successfully updated the agent cluster with sysId {sysId}.

...

	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 Web Services#Agent Cluster Properties.
Agent Properties	See Agent Cluster Web Services#Agent Properties.
Agent Cluster: Email Notification Properties	See Agent Cluster Web Services#Agent Cluster Email Notification Properties.
Agent Cluster: SNMP Notification Properties	See Agent Cluster Web Services#Agent Cluster SNMP Notification Properties.

Anchor
Read an Agent Cluster URI Parameters
Read an Agent Cluster URI Parameters
Read an Agent Cluster: URI Parameters

...

XML

JSON

Expand

title	XML

<windowsAgentCluster exportReleaseLevel="7.2.0.0" exportTable="ops_windows_agent_cluster" retainsSysIds="true" version="1">
      <agents>
            <agent>
                  <Agent Cluster Web Services#agentNameagentName>pc - SS0001</Agent Cluster Web Services#agentNameagentName>
                  <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>
      <strictBsrvcMembership>false</strictBsrvcMembership>
      <suspended>false</suspended>
      <suspendedOn /
      <sysId>35dc94a7a8834d28b51e03b5780cd90c</sysId>
</windowsAgentCluster>

Expand

title	JSON

{
  "type": "windowsAgentCluster",
  "agents": [ {
    "Agent Cluster Web Services#agentNameagentName": "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",
  "strictBsrvcMembership":false,
  "suspended": false,
  "suspendedOn": null,
  "sysId": "35dc94a7a8834d28b51e03b5780cd90c",
  "version": 1
}

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	agentClusterName - TEL
	agentClusterName - TEL

agentClusterName

Cluster Name

Name used within the Controller to identify this agent cluster.

Y

Anchor

	limitAmount - TEL
	limitAmount - TEL

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

Anchor

	limitType - TEL
	limitType - TEL

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

Anchor
Suspend an Agent Cluster
Suspend an Agent Cluster
Suspend an Agent Cluster

...

Versions Compared

Old Version 1

New Version Current

Key

Anchor
List Agent Clusters XML and JSON Examples
List Agent Clusters XML and JSON Examples
List Agent Clusters: XML and JSON Examples

Anchor
List Agent Cluster - Advanced
List Agent Cluster - Advanced
List Agent Cluster - Advanced

Anchor
List Agent Cluster - Advanced URI Properties
List Agent Cluster - Advanced URI Properties
List Agent Cluster - Advanced: URI Properties

Anchor
List Agent Cluster - Advanced XML and JSON Examples
List Agent Cluster - Advanced XML and JSON Examples
List Agent Cluster - Advanced: XML and JSON Examples

Anchor
Modify an Agent Cluster
Modify an Agent Cluster
Modify an Agent Cluster

Anchor
Read an Agent Cluster URI Parameters
Read an Agent Cluster URI Parameters
Read an Agent Cluster: URI Parameters

Anchor
Suspend an Agent Cluster
Suspend an Agent Cluster
Suspend an Agent Cluster

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

AnchorList Agent Clusters XML and JSON ExamplesList Agent Clusters XML and JSON ExamplesList Agent Clusters: XML and JSON Examples

AnchorList Agent Cluster - AdvancedList Agent Cluster - AdvancedList Agent Cluster - Advanced

AnchorList Agent Cluster - Advanced URI PropertiesList Agent Cluster - Advanced URI PropertiesList Agent Cluster - Advanced: URI Properties

AnchorList Agent Cluster - Advanced XML and JSON ExamplesList Agent Cluster - Advanced XML and JSON ExamplesList Agent Cluster - Advanced: XML and JSON Examples

AnchorModify an Agent ClusterModify an Agent ClusterModify an Agent Cluster

AnchorRead an Agent Cluster URI ParametersRead an Agent Cluster URI ParametersRead an Agent Cluster: URI Parameters

AnchorSuspend an Agent ClusterSuspend an Agent ClusterSuspend an Agent Cluster

Anchor
List Agent Clusters XML and JSON Examples
List Agent Clusters XML and JSON Examples
List Agent Clusters: XML and JSON Examples

Anchor
List Agent Cluster - Advanced
List Agent Cluster - Advanced
List Agent Cluster - Advanced

Anchor
List Agent Cluster - Advanced URI Properties
List Agent Cluster - Advanced URI Properties
List Agent Cluster - Advanced: URI Properties

Anchor
List Agent Cluster - Advanced XML and JSON Examples
List Agent Cluster - Advanced XML and JSON Examples
List Agent Cluster - Advanced: XML and JSON Examples

Anchor
Modify an Agent Cluster
Modify an Agent Cluster
Modify an Agent Cluster

Anchor
Read an Agent Cluster URI Parameters
Read an Agent Cluster URI Parameters
Read an Agent Cluster: URI Parameters

Anchor
Suspend an Agent Cluster
Suspend an Agent Cluster
Suspend an Agent Cluster