Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

GET groups/alarmSummary

Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of clients associated with the alarmed APs. Does not count cleared alarms.

Since Product Version: 2.0

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Resource URL

/webacs/api/v3/op/groups/alarmSummary

Unmodified

This resource has not been modified since the previous API version.

Response Parameters

Attribute Description

nbrAlarmedAPs int

Number of access points with associated alarms of critical, major, minor, warning, and information severities.

nbrAlarmedClients int

Number of clients associated with APs with alarms of critical, major, minor, warning, and information severities.

nbrAlarmedDevices int

Number of Devices (excluding APs) with alarms of critical, major, minor, warning, and information severities associated.

nbrAlarmedSites int

Number of sites containing devices with associated alarms of critical, major, minor, warning, and information severities.

totalAlarms int

Total number of alarms of critical, major, minor, warning, and information severities.

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Response Payload

https://10.56.58.149/webacs/api/v3/op/groups/alarmSummary

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://10.56.58.149/webacs/api/v3/op/groups/alarmSummary" rootUrl="https://10.56.58.149/webacs/api/v3/op">
  <alarmsSummaryDTO>
    <nbrAlarmedAPs>1</nbrAlarmedAPs>
    <nbrAlarmedClients>1</nbrAlarmedClients>
    <nbrAlarmedDevices>1</nbrAlarmedDevices>
    <nbrAlarmedSites>1</nbrAlarmedSites>
    <totalAlarms>1</totalAlarms>
  </alarmsSummaryDTO>
</mgmtResponse>

Sample JSON Response Payload

https://10.56.58.149/webacs/api/v3/op/groups/alarmSummary.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://10.56.58.149/webacs/api/v3/op/groups/alarmSummary",
    "@responseType" : "operation",
    "@rootUrl" : "https://10.56.58.149/webacs/api/v3/op",
    "alarmsSummaryDTO" : [ {
      "nbrAlarmedAPs" : 1,
      "nbrAlarmedClients" : 1,
      "nbrAlarmedDevices" : 1,
      "nbrAlarmedSites" : 1,
      "totalAlarms" : 1
    } ]
  }
}