Versions Compared

Old Version 2

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxlevel1

...

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.

...

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 ignoreSuspendedAgentslimitType

 
JSON

resolutionDescriptionresolutionStatusResolution Status

Property

UI Field Name

Description

Specifications

Required

Anchor

agentLimitAmount - CAC

agentLimitAmount - CAC

Current Task Count

agentLimitAmount

Agent Limit AmountIf 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 - CACdistribution - CAC

Distribution

Method used to select an Agent in the Agent Cluster.

Agent LimitSpecification 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/aRecord 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 false).

N

Anchor
ignoreSuspendedAgents - CACignoreSuspendedAgents - CAC

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

Read only.

Anchor
lastAgentUsed exportReleaseLevel - CAClastAgentUsed
exportReleaseLevel - CAC
lastAgentUsed

Last Agent Used

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

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN
Read only.

Anchor
lastResolution exportTable - CAClastResolution
exportTable - CAC
lastResolution

Last Resolution

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

exportTable

n/aRecord table information.read onlyN

Anchor
limitAmount ignoreInactiveAgents - CAClimitAmount
ignoreInactiveAgents - 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 - CAClimitType - 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 (1ignoreInactiveAgents

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

Name of

Anchor
name lastAgentUsed - CACname
lastAgentUsed - CAC
name

Cluster Name

lastAgentUsed

Last Agent Used

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

Read only.

YN

Anchor
networkAlias lastResolution - CACnetworkAlias
lastResolution - CAC
networkAliaslastResolution

Network AliasLast Resolution

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

Read only.

N

Anchor
networkAliasPort limitAmount - CACnetworkAliasPort
limitAmount - CAC
networkAliasPortlimitAmount

Agent PortLimit Amount

If distribution limitType is Network Alias Limited (42); Network alias (or VIP) port that the Agent's Universal Broker is listening onNumber of tasks that can be running at the same time by the Agents in this agent cluster.


N

Panel

N

Anchor
resolutionDescription - CACresolutionDescription - CAC

Resolution Description

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

Read only.

N

Anchor
resolutionStatus - CACresolutionStatus - CAC
Anchor
opswiseGroups limitType - CACopswiseGroups
limitType - CAC
opswiseGroups

Member of Business Services

List of Business Services that this Agent Cluster belongs to.
 
Format:
 
XML

Panel

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

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); Status of the last resolution of the Network Alias.

Read only.

Network alias (or VIP).


N

Anchor
resumedOn networkAliasPort - CACresumedOn
networkAliasPort - CAC
resumedOnnetworkAliasPort

Resumed On

Date and time when a suspended Agent Cluster was resumed.

Read onlyAgent Port

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


N

Specification for whether or not the Create an Agent Cluster web service will persist the sysId property.

Note
titleNote

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

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

Anchor
retainSysIds opswiseGroups - CACretainSysIds
opswiseGroups - CAC
retainSysIds

n/a

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
suspended resolutionDescription - CACsuspended
resolutionDescription - CAC
suspendedresolutionDescription

Suspended

Indication of whether or not the ability for this cluster of Agents to run tasks has been suspendedResolution Description

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

Read only; Boolean; Valid Values: true/false.

N

Anchor
suspendedOn resolutionStatus - CACsuspendedOn
resolutionStatus - CAC
suspendedOnresolutionStatus

Suspended On

Date and time when the Agent Cluster was suspendedResolution Status

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

Read only.

N

Anchor
sysId resumedOn - CACsysId
resumedOn - CAC
resumedOnsysId

n/a

sys_id used within the Controller to identify this Agent Cluster.

Resumed On

Date and time when a suspended Agent Cluster was resumed.

Read only.

N

Anchor
type retainSysIds - CACtype
retainSysIds - CAC
type retainSysIds

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: windowsAgentCluster and unixAgentCluster

N

...

agentNamemembershipDecommissionedmembershipResumedOn

Property

UI Field Name

Description

Specifications

Required

Anchor
agentName - CACAagentName - CACA

Agent

Name of an Agent in the Agent Cluster.

Y

Anchor
membershipDecommissioned - CACAmembershipDecommissioned - CACAMembership DecommissionedIndication 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
Anchor
membershipSuspendedOn - CACAmembershipSuspendedOn - CACA

Membership Resumed On

Date and time that an Agent temporarily suspended from the Agent Cluster has been resumed

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
titleNote

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
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
membershipSuspended suspendedOn - CACACACmembershipSuspended
suspendedOn - CACACAC
membershipSuspendedsuspendedOn

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 On

Date and time when the Agent Cluster was suspended.

Read only; Boolean; Valid Values: true/false.

N

Read only; Boolean; Valid Values: true/false

Anchor
membershipSuspendedOn sysId - CACACACmembershipSuspendedOn
sysId - CACACAC
membershipSuspendedOn

Membership Suspended On

Date and time that the Agent has been temporarily suspended from the Agent Cluster.

sysId

n/a

sys_id used within the Controller to identify this Agent Cluster.


N

Anchor
type - CACACAC
type - CACACAC
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

Anchor

...

n/a

...

sys_id used within the Controller to identify the Agent Cluster membership of this Agent.

...

N

...

Agent Properties
Agent

...

Properties
Agent

...

Properties

bodyccemailConnectionemailTemplatereplyTostatesubjectsysid - email

an Agent in the Agent Cluster.

Property

UI Field Name

Description

Specifications

Required

Anchor
bcc agentName - emailCACAbcc
agentName - emailCACA
bccagentName

BccAgent

Email address Name 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 - emailbody - email

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

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

Email Connection

Name of an Email Connection.

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

Anchor
emailTemplate - emailemailTemplate - email

Email Template

Name of an Email Template.

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

Anchor
replyTo - emailreplyTo - email

Reply-To

Email address of the sender of the email.

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

Anchor
state - emailstate - email

Notification State

Comma-separated list of Notification states

Valid values:

Anchor
subject - emailsubject - email

Subject

Subject line of the email.

Variables and Functions are supported.

Anchor
sysid - email


Y

Anchor
membershipDecommissioned - CACA
membershipDecommissioned - CACA
membershipDecommissioned

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

Anchor
membershipSuspendedOn - CACA
membershipSuspendedOn - CACA
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

Anchor
membershipSuspended - CACA
membershipSuspended - CACA
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

Anchor
membershipSuspendedOn - CACA
membershipSuspendedOn - CACA
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

Anchor
type - CACA
type - CACA
type

n/a

Type of Agent

Read only; Valid values:

  • Windows
  • Linux/Unix

N

Anchor
sysId - CACA
sysId - CACA
sysId

n/a

sys_id used within the Controller to identify this Email Notification.the Agent Cluster membership of this Agent.


N

...

Anchor

...

Agent Cluster Email Notification Properties
Agent Cluster Email Notification Properties
Agent Cluster: Email Notification Properties

Property

UI Field Name

Description

Specifications

Anchor
bcc - email
bcc - email
bcc

Bcc

Email address of the recipientparty being sent a blind (hidden) copy of the email, if any.

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

...

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

XML

JSON

Expand
titleXML
Anchor

...

Property

...

UI Field Name

...

Description

...

Specifications

...

Notification Severity

...

Severity level of this notification.

...

Valid values:

Default is Normal (1).

...

SNMP Manager

...

SNMP Manager that will receive this notification.

...

Notification State

...

Comma-separated list of Notification states

...

Valid values:

...

n/a

...

sys_id used within the Controller to identify this SNMP Notification.

...

Description

...

URI

...

HTTP Method

...

DELETE

...

Description

...

Deletes a specific Agent Cluster.

...

URI Parameters

...

See Delete an Agent Cluster: URI Parameters.

...

Example URI

...

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.

...

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

...

Description

...

URI

...

http://host_name/uc/resources/agentcluster/list

...

HTTP Method

...

GET

...

Description

...

Retrieves information on all Agent Clusters.

...

Example URI

...

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.

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.

Anchor
Agent Cluster SNMP Notification Properties
Agent Cluster SNMP Notification Properties
Agent Cluster: SNMP Notification Properties

Property

UI Field Name

Description

Specifications

Anchor
severity - snmp
severity - snmp
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).

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.


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

Anchor
Delete an Agent Cluster URI Parameters
Delete an Agent Cluster URI Parameters
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

Anchor
List Agent Clusters
List Agent Clusters
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.

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
titleXML
<agentClusters>
      <agentCluster version="1">
            <agents>
               </notifications>   <agent>
         <opswiseGroups />              <resolutionDescription>AgentagentName>pc in Use:'sb-qa-123'</resolutionDescription>
- SS0001</agentName>
           <resolutionStatus>Success</resolutionStatus>             <resumedOn>2021-06-29 19:18:30 -400</resumedOnmembershipDecommissioned>true</membershipDecommissioned>
            <suspended>false</suspended>
            <suspendedOnmembershipResumedOn />
             <sysId>cb5b876aa9fec69f0032b55e0391d693</sysId>             <type>Windows</type><membershipSuspended>true</membershipSuspended>
                        <membershipSuspendedOn>2021-06-29 19:18:30 -400</membershipSuspendedOn>
                        </agentCluster>sysId>af1984d3481b4bccb9bea0e4e1d6fbf2</sysId>
                       <agentCluster version="1" <type>Linux/Unix</type>
            <agents>      </agent>
            <agent></agents>
            <currentCount>0</currentCount>
            <agentName>pc - SS0002</agentName>
                        <membershipDecommissioned>false</membershipDecommissioned>
                        <membershipResumedOn />
                        <membershipSuspended>true</membershipSuspended>
                        <membershipSuspendedOn>2021-06-29 19:18:30 -400</membershipSuspendedOn>
         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
titleJSON
[
  {
  "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

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
titleXML
<?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/>
<sysId>af1984d3481b4bccb9bea0e4e1d6fbf3</sysId>
   <currentCount>0</currentCount>
        <description />
        
<distribution>Any</distribution>
<type>Windows</type>
       <ignoreInactiveAgents>false</ignoreInactiveAgents>
        <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
</agent>
      <lastAgentUsed />
</agents>
   <lastResolution />
<currentCount>0</currentCount>
<limitAmount>5</limitAmount>
        <limitType>Unlimited</limitType>
<description>Cluster
of
Windows
Agents</description>
   <name>linux_cluster_1</name>
        <networkAlias
<distribution>Network Alias<
/
distribution
>
        <networkAliasPort />
<ignoreInactiveAgents>true</ignoreInactiveAgents>
    <notifications/>
<ignoreSuspendedAgents>true0<
<opswiseGroups/
ignoreSuspendedAgents
>
        <resolutionDescription />
<lastAgentUsed>sb-qa-123</lastAgentUsed>
      <resolutionStatus>None</resolutionStatus>
<lastResolution>2018-09-13 10:52:03.410 -0500</lastResolution> 
 <resumedOn />
                 <strictBsrvcMembership>false</strictBsrvcMembership>
        <suspended>false</suspended>
        <suspendedOn
<limitAmount>5<
/
limitAmount
>
        <sysId>89ef2f9a35684825849881978b827ee7</sysId>
    <
limitType>Unlimited</limitType> 
/unixAgentCluster>
    <unixAgentCluster exportReleaseLevel="7.3.0.0" exportTable="ops_unix_agent_cluster" retainSysIds="true" version="2">
<name>Cluster 2</name
<agents/>
<networkAlias>qa-123</networkAlias>
<currentCount>0</currentCount>
<networkAliasPort
<description />
<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>
<distribution>Any</distribution>
        <ignoreInactiveAgents>false</ignoreInactiveAgents>
        <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
        <lastAgentUsed />
        <lastResolution />
</notifications>
     <limitAmount>5</limitAmount>
<opswiseGroups
 <limitType>Unlimited</
>
limitType>
        <name>linux_cluster_2</name>
<resolutionDescription>Agent
in Use:'sb-qa-123'</resolutionDescription>
<networkAlias />
        <networkAliasPort />
<resolutionStatus>Success</resolutionStatus>
     <notifications/>
<resumedOn
 <opswiseGroups/>


        <resolutionDescription />
<suspended>true</suspended>
    <resolutionStatus>None</resolutionStatus>
<suspendedOn>2021-06-29 19:18:30 -400</suspendedOn>
 <resumedOn />
        <suspended>false</suspended>
        <suspendedOn
<sysId>cb5b876aa9fec69f0032b55e0391d694<
/
sysId
>
        <strictBsrvcMembership>false</strictBsrvcMembership>
<type>Windows</type>
   <sysId>a47c4a0e6c1d4da5896dd9c072bacb28</sysId>
</agentCluster>
 </
agentClusters> Expand
titleJSON
[
unixAgentCluster>
{
  <windowsAgentCluster
"agents": [ { 
exportReleaseLevel="7.3.0.0" exportTable="ops_windows_agent_cluster" retainSysIds="true" version="1">
"agentName":
"Mark-4
-
AGNT001",
  <agents/>
"membershipDecommissioned":
true,
"membershipResumedOn": null,
  <currentCount>0</currentCount>
"membershipSuspended":
true,
"membershipSuspendedOn": "2021-06-29 19:18:30 -400",
<description />
"sysId":
"941e558d6f2b4656bdb870e2551fa85e", 
 <distribution>Any</distribution>
"type":
"Linux/Unix"
}
],
<ignoreInactiveAgents>false</ignoreInactiveAgents>
"currentCount":
0,
"description":
"Cluster
of
Linux Agents",
<ignoreSuspendedAgents>false</ignoreSuspendedAgents>
"distribution":
"Network
Alias",
"ignoreInactiveAgents": true,
<lastAgentUsed />
"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": [ {
 <lastResolution />
        <limitAmount>5</limitAmount>
        <limitType>Unlimited</limitType>
        <name>wins_cluster_1</name>
        <networkAlias />
"bcc": null, 
 <networkAliasPort />
"body":
"${ops_system_identifier}",
  <notifications/>
"cc":
null,
   <opswiseGroups/>
"emailConnection": "ecu-office-365",
     <resolutionDescription />
"emailTemplate":
"agent-built-variables",
     <resolutionStatus>None</resolutionStatus>
"replyTo":
null,
"state": "Agents Unavailable",
<resumedOn />
        <strictBsrvcMembership>false</strictBsrvcMembership>
"subject":
null,
     <suspended>false</suspended>
"sysId":
"e120f05abd104e2e952c6b9e693891ab",
"to": "support@stonebranch.com"
<suspendedOn />
}
],
  <sysId>3f5c2bb17d2d43149eb70da856c51fe2</sysId>
"snmpNotifications":
[
{
</windowsAgentCluster>
    <windowsAgentCluster exportReleaseLevel="7.3.0.0"
"severity": "Minor", 
exportTable="ops_windows_agent_cluster" retainSysIds="true" version="1">
"snmpManager":
"test_manager",
  <agents/>
"state":
"Agents
Unavailable",
  <currentCount>0</currentCount>
"sysId":
"fc4f4e8b0dea4b51a77a3c20f7e62b2a"
   <description />
}
]
},
"opswiseGroups": [],
 <distribution>Any</distribution>
"resolutionDescription":
"Agent
in Use:'sb-qa-123'",
"resolutionStatus": "Success",
 <ignoreInactiveAgents>false</ignoreInactiveAgents>
"resumedOn":
"2021-06-29
19:18:30
-400",
"suspended": false,
"suspendedOn": null,
 <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
"sysId":
"35dc94a7a8834d28b51e03b5780cd90c",
"type": "Windows"
<lastAgentUsed />
"version":
1
},
 <lastResolution />
{
"agents":
[
{
   <limitAmount>5</limitAmount>
"agentName":
"Mark-4
-
AGNT002",
"membershipDecommissioned": false,
<limitType>Unlimited</limitType>
"membershipResumedOn":
null,
  <name>wins_cluster_2</name>
"membershipSuspended":
true,
"membershipSuspendedOn": "2021-06-29 19:18:30 -400",
 <networkAlias />
"sysId":
"941e558d6f2b4656bdb870e2551fa85f",
  <networkAliasPort />
"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,
<notifications/>
        <opswiseGroups/>
        <resolutionDescription />
        <resolutionStatus>None</resolutionStatus>
        <resumedOn />
        <strictBsrvcMembership>false</strictBsrvcMembership> 
        <suspended>false</suspended>
        <suspendedOn />
        <sysId>3dc7749381ab461883f6a1807c7c3c7d</sysId>
    </windowsAgentCluster>
</agentClusters>



Expand
titleJSON
[
    {
        "
emailConnection
type": "
ecu-office-365
unixAgentCluster",
        "
emailTemplate
agents":
"agent-built-variables",
[],
        "
replyTo
currentCount":
null
0,
        "
state
description": null,
"Agents
Unavailable",
       "
subject
distribution":
null
"Any",
        "
sysId
exportReleaseLevel": "
e120f05abd104e2e952c6b9e693891ab
7.3.0.0",
        "
to
exportTable": "
support@stonebranch.com" 
ops_unix_agent_cluster",
}
],
     "
snmpNotifications
ignoreInactiveAgents": false,
[
{
       "
severity
ignoreSuspendedAgents":
"Minor"
false,
        "
snmpManager
lastAgentUsed":
"test_manager",
null,
        "
state
lastResolution":
"Agents Unavailable",
null,
        "
sysId
limitAmount":
"fc4f4e8b0dea4b51a77a3c20f7e62b2a"
5,
}
] },
   "
opswiseGroups
limitType":
[]
"Unlimited",
"resolutionDescription":
"Agent
in
Use:'sb-qa-123'",
   "
resolutionStatus
name": "
Success
linux_cluster_1",
"resumedOn":
null,
"suspended":
true,
  "
suspendedOn
networkAlias":
2021-06-29 19:18:30 -400,
null,
"sysId": "35dc94a7a8834d28b51e03b5780cd90d",
    "
type
networkAliasPort": null,
"Windows"
"version":
1
} ]

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

...

...

Authentication

...

HTTP Basic

...

Produces Content-Type

...

application/xml, application/json

...

Consumes Content-Type

...

n/a

...

Example Responses

...

List Agent Cluster - Advanced: URI Parameters

...

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

  • As String = Windows, As Value = 1

  • As String = Linux/Unix, As Value = 2

If type is not specified, defaults to all types.

...

N

List Agent Cluster - Advanced: XML and JSON Examples

XML

JSON

Code Block
languagexml
linenumberstrue
collapsetrue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <agentClusters> <unixAgentCluster exportReleaseLevel=
 "notifications": {
            "emailNotifications": [],
            "snmpNotifications": []
        },
        "opswiseGroups": [],
        "resolutionDescription": null,
        "resolutionStatus": "None",
        "resumedOn": null,
        "retainSysIds": true,
        "strictBsrvcMembership": false, 
        "suspended": false,
        "suspendedOn": null,
        "sysId": "89ef2f9a35684825849881978b827ee7",
        "version": 2
    },
    {
        "type": "unixAgentCluster",
        "agents": [],
        "currentCount": 0,
        "description": null,
        "distribution": "Any",
        "exportReleaseLevel": "7.3.0.0",
        "exportTable
=
": "ops_unix_agent
_cluster" retainSysIds="true" version="2">
_cluster",
        "ignoreInactiveAgents": false,
        "ignoreSuspendedAgents": false,
        "lastAgentUsed": null,
        "lastResolution": null,
<agents/> 
"limitAmount": 5,
<currentCount>0</currentCount> 
 "limitType": "Unlimited",
<description /> 
 "name": "linux_cluster_2",
<distribution>Any</distribution> 
 "networkAlias": null,
<ignoreInactiveAgents>false</ignoreInactiveAgents>
  "networkAliasPort": null,
<ignoreSuspendedAgents>false</ignoreSuspendedAgents>
   "notifications": {
<lastAgentUsed
/>
       "emailNotifications": [],
<lastResolution
/>
<limitAmount>5</limitAmount>
  "snmpNotifications": []
<limitType>Unlimited</limitType>
   },
<name>linux_cluster_1</name>
   "opswiseGroups": [],
<networkAlias
/>
   "resolutionDescription": null,
<networkAliasPort
/>
   "resolutionStatus": "None",
<notifications/>
    "resumedOn": null,
<opswiseGroups/>
     "retainSysIds": true,
<resolutionDescription
/>
    "strictBsrvcMembership": false,
<resolutionStatus>None</resolutionStatus>
      "suspended": false,
<resumedOn
/>
      "suspendedOn": null,
<suspended>false</suspended>
       "sysId": "a47c4a0e6c1d4da5896dd9c072bacb28",
<suspendedOn
/>
       "version": 2
<sysId>89ef2f9a35684825849881978b827ee7</sysId>
    },
</unixAgentCluster>
    {
<unixAgentCluster
exportReleaseLevel="7.3.0.0"
exportTable="ops_unix_agent_cluster"
retainSysIds="true"
version="2">
    "type": "windowsAgentCluster",
<agents/>
     "agents": [],
<currentCount>0</currentCount>
      "currentCount": 0,
<description
/>
      "description": null,
<distribution>Any</distribution>
       "distribution":
<ignoreInactiveAgents>false</ignoreInactiveAgents>
"Any",
<ignoreSuspendedAgents>false</ignoreSuspendedAgents>
"exportReleaseLevel": "7.3.0.0",
<lastAgentUsed />
"exportTable": "ops_windows_agent_cluster",
<lastResolution />
"ignoreInactiveAgents": false,
<limitAmount>5</limitAmount> 
"ignoreSuspendedAgents": false,
<limitType>Unlimited</limitType> 
 "lastAgentUsed": null,
<name>linux_cluster_2</name>
  "lastResolution": null,
<networkAlias
/>
  "limitAmount": 5,
<networkAliasPort
/>
  "limitType": "Unlimited",
<notifications/>
   "name": "wins_cluster_1",
<opswiseGroups/>
    "networkAlias": null,
<resolutionDescription
/>
    "networkAliasPort": null,
<resolutionStatus>None</resolutionStatus>
     "notifications": {
<resumedOn
/>
<suspended>false</suspended> 
"emailNotifications": [],
<suspendedOn
/>
    "snmpNotifications": []
<sysId>a47c4a0e6c1d4da5896dd9c072bacb28</sysId>
</unixAgentCluster>
},
<windowsAgentCluster
exportReleaseLevel="7.3.0.0"
exportTable="ops_windows_agent_cluster"
retainSysIds="true"
version=
"
1
opswiseGroups"
>
: [],
<agents/> 
 "resolutionDescription": null,
<currentCount>0</currentCount>
  "resolutionStatus": "None",
<description
/>
  "resumedOn": null,
<distribution>Any</distribution>
   "retainSysIds": true,
<ignoreInactiveAgents>false</ignoreInactiveAgents>
   "strictBsrvcMembership": false,
<ignoreSuspendedAgents>false</ignoreSuspendedAgents>
     "suspended": false,
<lastAgentUsed
/>
     "suspendedOn": null,
<lastResolution
/>
     "sysId": "3f5c2bb17d2d43149eb70da856c51fe2",
<limitAmount>5</limitAmount>
      "version": 1
<limitType>Unlimited</limitType>
   },
    {
<name>wins_cluster_1</name>
<networkAlias />
"type": "windowsAgentCluster",
<networkAliasPort />
"agents": [],
<notifications/> 
"currentCount": 0,
<opswiseGroups/> 
 "description": null,
<resolutionDescription
/>
 "distribution": "Any",
<resolutionStatus>None</resolutionStatus>
  "exportReleaseLevel": "7.3.0.0",
<resumedOn
/>
  "exportTable": "ops_windows_agent_cluster",
<suspended>false</suspended>
   "ignoreInactiveAgents": false,
<suspendedOn
/>
   "ignoreSuspendedAgents": false,
<sysId>3f5c2bb17d2d43149eb70da856c51fe2</sysId>
</windowsAgentCluster>
"lastAgentUsed": null,
<windowsAgentCluster
exportReleaseLevel="7.3.0.0"
exportTable="ops_windows_agent_cluster"
retainSysIds="true"
version=
"
1">
lastResolution": null,
        "limitAmount": 5,
<agents/>
<currentCount>0</currentCount>
"limitType": "Unlimited",
<description />
"name": "wins_cluster_2",
<distribution>Any</distribution> 
"networkAlias": null,
<ignoreInactiveAgents>false</ignoreInactiveAgents> 
 "networkAliasPort": null,
<ignoreSuspendedAgents>false</ignoreSuspendedAgents>
  "notifications": {
<lastAgentUsed
/>
      "emailNotifications": [],
<lastResolution
/>
<limitAmount>5</limitAmount> 
 "snmpNotifications": []
<limitType>Unlimited</limitType>
  },
<name>wins_cluster_2</name>
  "opswiseGroups": [],
<networkAlias
/>
  "resolutionDescription": null,
<networkAliasPort
/>
  "resolutionStatus": "None",
<notifications/>
   "resumedOn": null,
<opswiseGroups/>
    "retainSysIds": true,
<resolutionDescription
/>
   "strictBsrvcMembership": false,
<resolutionStatus>None</resolutionStatus>
     "suspended": false,
<resumedOn
/>
     "suspendedOn": null,
<suspended>false</suspended>
<suspendedOn />
"sysId": "3dc7749381ab461883f6a1807c7c3c7d",
        "version": 1
<sysId>3dc7749381ab461883f6a1807c7c3c7d</sysId>
</windowsAgentCluster> </agentClusters>
}
]


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

...

XML

JSON


Expand
titleXML
<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>
      <strictBsrvcMembership>false</strictBsrvcMembership>
      <suspended>false</suspended>
      <suspendedOn /
      <sysId>35dc94a7a8834d28b51e03b5780cd90c</sysId>
</windowsAgentCluster>



Expand
titleJSON
{
  "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",
  "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

...