Versions Compared

Old Version 4

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 5

changes.mady.by.user Stonebranch

Saved on

Key

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

...

XML

JSON

Expand
titleXML
<agentClusters>
      <agentCluster version="1">
            <agents>
                  <agent>
                        <agentName>pc - SS0001</agentName>
                        <membershipDecommissioned>true</membershipDecommissioned>
                        <membershipResumedOn />
                        <membershipSuspended>true</membershipSuspended>
                        <membershipSuspendedOn>2021-06-29 19:18:30 -400</membershipSuspendedOn>
                        <sysId>af1984d3481b4bccb9bea0e4e1d6fbf2</sysId>
                        <type>Linux/Unix</type>
                  </agent>
            </agents>
            <currentCount>0</currentCount>
            <description>Cluster of Linux Agents</description>
            <distribution>Network Alias</distribution>
            <ignoreInactiveAgents>true</ignoreInactiveAgents>
            <ignoreSuspendedAgents>true0</ignoreSuspendedAgents>
            <lastAgentUsed>sb-qa-123</lastAgentUsed>
            <lastResolution>2018-09-12 09:52:03.410 -0500</lastResolution>
            <limitAmount>5</limitAmount>
            <limitType>Unlimited</limitType>
            <name>Cluster 1</name>
            <networkAlias>qa-123</networkAlias>
            <networkAliasPort />
            <notifications>
		<emailNotification>
			<sysId>2b7286b87a7048399fbd95c01a380002</sysId>
			<bcc />
			<body />
			<cc />
			<emailConnection>uc - Gmail Account</emailConnection>
			<emailTemplate>uc - Template</emailTemplate>
			<replyTo />
			<state>Agents Unavailable<[/state]>
			<subject />
			<to />
		</emailNotification>
		<snmpNotification>
			<state>Agents Unavailable</state>
			<sysId>21d992c72be44b159aac91c4ee9f40c6</sysId>
			<severity>Minor</severity>
			<snmpManager>SNMP Manager</snmpManager>
		</snmpNotification>
            </notifications>
            <opswiseGroups /> 
            <resolutionDescription>Agent in Use:'sb-qa-123'</resolutionDescription>
            <resolutionStatus>Success</resolutionStatus>
            <resumedOn>2021-06-29 19:18:30 -400</resumedOn>
            <suspended>false</suspended>
            <suspendedOn />
            <sysId>cb5b876aa9fec69f0032b55e0391d693</sysId>
            <type>Windows</type>
      </agentCluster>
      <agentCluster version="1">
            <agents>
                  <agent>
                        <agentName>pc - SS0002</agentName>
                        <membershipDecommissioned>false</membershipDecommissioned>
                        <membershipResumedOn />
                        <membershipSuspended>true</membershipSuspended>
                        <membershipSuspendedOn>2021-06-29 19:18:30 -400</membershipSuspendedOn>
                        <sysId>af1984d3481b4bccb9bea0e4e1d6fbf3</sysId>
                        <type>Windows</type>
                  </agent>
            </agents>
            <currentCount>0</currentCount>
            <description>Cluster of Windows Agents</description>
            <distribution>Network Alias</distribution>
            <ignoreInactiveAgents>true</ignoreInactiveAgents>
            <ignoreSuspendedAgents>true0</ignoreSuspendedAgents>
            <lastAgentUsed>sb-qa-123</lastAgentUsed>
            <lastResolution>2018-09-13 10:52:03.410 -0500</lastResolution>
            <limitAmount>5</limitAmount>
            <limitType>Unlimited</limitType>
            <name>Cluster 2</name>
            <networkAlias>qa-123</networkAlias>
            <networkAliasPort />
            <notifications>
		<emailNotification>
			<sysId>2b7286b87a7048399fbd95c01a380002</sysId>
			<bcc />
			<body />
			<cc />
			<emailConnection>uc - Gmail Account</emailConnection>
			<emailTemplate>uc - Template</emailTemplate>
			<replyTo />
			<state>Agents Unavailable</state>
			<subject />
			<to />
		</emailNotification>
		<snmpNotification>
			<state>Agents Unavailable</state>
			<sysId>21d992c72be44b159aac91c4ee9f40c6</sysId>
			<severity>Minor</severity>
			<snmpManager>SNMP Manager</snmpManager>
		</snmpNotification>
            </notifications>
            <opswiseGroups /> 
            <resolutionDescription>Agent in Use:'sb-qa-123'</resolutionDescription>
            <resolutionStatus>Success</resolutionStatus>
            <resumedOn />
            <suspended>true</suspended>
            <suspendedOn>2021-06-29 19:18:30 -400</suspendedOn>
            <sysId>cb5b876aa9fec69f0032b55e0391d694</sysId>
            <type>Windows</type>
      </agentCluster>
</agentClusters>
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",
  "suspended": false,
  "suspendedOn": null,
  "sysId": "35dc94a7a8834d28b51e03b5780cd90c",
  "type": "Windows"
  "version": 1
  },
  {
  "agents": [ {
    "agentName": "Mark-4 - AGNT002",
    "membershipDecommissioned": false,
    "membershipResumedOn": null,
    "membershipSuspended": true, 
    "membershipSuspendedOn": "2021-06-29 19:18:30 -400",
    "sysId": "941e558d6f2b4656bdb870e2551fa85f",
    "type": "Windows"
  } ],
  "currentCount": 0,
  "description": "Cluster of Windows Agents",
  "distribution": "Network Alias",
  "ignoreInactiveAgents": true,
  "ignoreSuspendedAgents": true,
  "lastAgentUsed": "sb-qa-123",
  "lastResolution": "2018-09-13 10:52:03.410 -0500",
  "limitAmount": 5,
  "limitType": "Unlimited",
  "name": "Cluster 2",
  "networkAlias": "qa-123",
  "networkAliasPort": null,
  "notifications": {
    "emailNotifications": [ {
      "bcc": null,
      "body": "${ops_system_identifier}",
      "cc": null,
      "emailConnection": "ecu-office-365",
      "emailTemplate": "agent-built-variables",
      "replyTo": null,
      "state": "Agents Unavailable",
      "subject": null,
      "sysId": "e120f05abd104e2e952c6b9e693891ab",
      "to": "support@stonebranch.com"
    } ],
    "snmpNotifications": [ {
      "severity": "Minor",
      "snmpManager": "test_manager",
      "state": "Agents Unavailable",
      "sysId": "fc4f4e8b0dea4b51a77a3c20f7e62b2a"
    } ]
  },
  "opswiseGroups": [],
  "resolutionDescription": "Agent in Use:'sb-qa-123'",
  "resolutionStatus": "Success",
  "resumedOn": null,
  "suspended": true,
  "suspendedOn": 2021-06-29 19:18:30 -400,
  "sysId": "35dc94a7a8834d28b51e03b5780cd90d",
  "type": "Windows"
  "version": 1
  }
]

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

Anchor
List Agent Cluster - Advanced: URI Parameters
List Agent Cluster - Advanced: URI Parameters
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


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/>
        <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 />
        <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 />
        <distribution>Any</distribution>
        <ignoreInactiveAgents>false</ignoreInactiveAgents>
        <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
        <lastAgentUsed />
        <lastResolution />
        <limitAmount>5</limitAmount>
        <limitType>Unlimited</limitType>
        <name>linux_cluster_2</name>
        <networkAlias />
        <networkAliasPort />
        <notifications/>
        <opswiseGroups/>
        <resolutionDescription />
        <resolutionStatus>None</resolutionStatus>
        <resumedOn />
        <suspended>false</suspended>
        <suspendedOn />
        <sysId>a47c4a0e6c1d4da5896dd9c072bacb28</sysId>
    </unixAgentCluster>
    <windowsAgentCluster exportReleaseLevel="7.3.0.0" exportTable="ops_windows_agent_cluster" retainSysIds="true" version="1">
        <agents/>
        <currentCount>0</currentCount>
        <description />
        <distribution>Any</distribution>
        <ignoreInactiveAgents>false</ignoreInactiveAgents>
        <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
        <lastAgentUsed />
        <lastResolution />
        <limitAmount>5</limitAmount>
        <limitType>Unlimited</limitType>
        <name>wins_cluster_1</name>
        <networkAlias />
        <networkAliasPort />
        <notifications/>
        <opswiseGroups/>
        <resolutionDescription />
        <resolutionStatus>None</resolutionStatus>
        <resumedOn />
        <suspended>false</suspended>
        <suspendedOn />
        <sysId>3f5c2bb17d2d43149eb70da856c51fe2</sysId>
    </windowsAgentCluster>
    <windowsAgentCluster exportReleaseLevel="7.3.0.0" exportTable="ops_windows_agent_cluster" retainSysIds="true" version="1">
        <agents/>
        <currentCount>0</currentCount>
        <description />
        <distribution>Any</distribution>
        <ignoreInactiveAgents>false</ignoreInactiveAgents>
        <ignoreSuspendedAgents>false</ignoreSuspendedAgents>
        <lastAgentUsed />
        <lastResolution />
        <limitAmount>5</limitAmount>
        <limitType>Unlimited</limitType>
        <name>wins_cluster_2</name>
        <networkAlias />
        <networkAliasPort />
        <notifications/>
        <opswiseGroups/>
        <resolutionDescription />
        <resolutionStatus>None</resolutionStatus>
        <resumedOn />
        <suspended>false</suspended>
        <suspendedOn />
        <sysId>3dc7749381ab461883f6a1807c7c3c7d</sysId>
    </windowsAgentCluster>
</agentClusters>
Expand
titleJSON
[
    {
        "type": "unixAgentCluster",
        "agents": [],
        "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",
        "networkAlias": null,
        "networkAliasPort": null,
        "notifications": {
            "emailNotifications": [],
            "snmpNotifications": []
        },
        "opswiseGroups": [],
        "resolutionDescription": null,
        "resolutionStatus": "None",
        "resumedOn": null,
        "retainSysIds": true,
        "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",
        "ignoreInactiveAgents": false,
        "ignoreSuspendedAgents": false,
        "lastAgentUsed": null,
        "lastResolution": null,
        "limitAmount": 5,
        "limitType": "Unlimited",
        "name": "linux_cluster_2",
        "networkAlias": null,
        "networkAliasPort": null,
        "notifications": {
            "emailNotifications": [],
            "snmpNotifications": []
        },
        "opswiseGroups": [],
        "resolutionDescription": null,
        "resolutionStatus": "None",
        "resumedOn": null,
        "retainSysIds": true,
        "suspended": false,
        "suspendedOn": null,
        "sysId": "a47c4a0e6c1d4da5896dd9c072bacb28",
        "version": 2
    },
    {
        "type": "windowsAgentCluster",
        "agents": [],
        "currentCount": 0,
        "description": null,
        "distribution": "Any",
        "exportReleaseLevel": "7.3.0.0",
        "exportTable": "ops_windows_agent_cluster",
        "ignoreInactiveAgents": false,
        "ignoreSuspendedAgents": false,
        "lastAgentUsed": null,
        "lastResolution": null,
        "limitAmount": 5,
        "limitType": "Unlimited",
        "name": "wins_cluster_1",
        "networkAlias": null,
        "networkAliasPort": null,
        "notifications": {
            "emailNotifications": [],
            "snmpNotifications": []
        },
        "opswiseGroups": [],
        "resolutionDescription": null,
        "resolutionStatus": "None",
        "resumedOn": null,
        "retainSysIds": true,
        "suspended": false,
        "suspendedOn": null,
        "sysId": "3f5c2bb17d2d43149eb70da856c51fe2",
        "version": 1
    },
    {
        "type": "windowsAgentCluster",
        "agents": [],
        "currentCount": 0,
        "description": null,
        "distribution": "Any",
        "exportReleaseLevel": "7.3.0.0",
        "exportTable": "ops_windows_agent_cluster",
        "ignoreInactiveAgents": false,
        "ignoreSuspendedAgents": false,
        "lastAgentUsed": null,
        "lastResolution": null,
        "limitAmount": 5,
        "limitType": "Unlimited",
        "name": "wins_cluster_2",
        "networkAlias": null,
        "networkAliasPort": null,
        "notifications": {
            "emailNotifications": [],
            "snmpNotifications": []
        },
        "opswiseGroups": [],
        "resolutionDescription": null,
        "resolutionStatus": "None",
        "resumedOn": null,
        "retainSysIds": true,
        "suspended": false,
        "suspendedOn": null,
        "sysId": "3dc7749381ab461883f6a1807c7c3c7d",
        "version": 1
    }
]

...