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

GET groups/alarmSummary

Resource Information

Rate Limiting?

Yes

Sorting?

No

Paging?

No

Filtering?

No

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Provides alarm summary information including: total number of alarms, number of alarmed devices, number of alarmed sites, number of alarmed APs and number of alarmed Clients.

Since Product Version: 2.0

Resource URL

/webacs/api/v1/op/groups/alarmSummary

Response Parameters

Type Attribute Name Description

int

nbrAlarmedAPs

Number of access points with associated alarms.

int

nbrAlarmedClients

Number of clients associated with APs with alarms.

int

nbrAlarmedDevices

Number of Devices (excluding APs) with alarms associated.

int

nbrAlarmedSites

Number of sites containing devices with associated alarms.

int

totalAlarms

Total number of alarms.

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://172.25.123.114/webacs/api/v1/op/groups/alarmSummary

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="../../../../pages/common/login.jsp.html" rootUrl="https://172.25.123.114/webacs/api/v1/op/">
  <alarmsSummaryDTO>
    <nbrAlarmedAPs>1</nbrAlarmedAPs>
    <nbrAlarmedClients>1</nbrAlarmedClients>
    <nbrAlarmedDevices>1</nbrAlarmedDevices>
    <nbrAlarmedSites>1</nbrAlarmedSites>
    <totalAlarms>1</totalAlarms>
  </alarmsSummaryDTO>
</mgmtResponse>

Sample JSON Response Payload

https://172.25.123.114/webacs/api/v1/op/groups/alarmSummary.json

{
  "mgmtResponse" : {
    "@responseType" : "operation",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/groups\/alarmSummary",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/op\/",
    "alarmsSummaryDTO" : {
      "nbrAlarmedAPs" : 1,
      "nbrAlarmedClients" : 1,
      "nbrAlarmedDevices" : 1,
      "nbrAlarmedSites" : 1,
      "totalAlarms" : 1
    }
  }
}