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.
Resource URL
/webacs/api/v1/op/groups/alarmSummary
Since : 2.0
Response Parameters
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
|
|
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://192.168.116.207/webacs/api/v1/op/groups/alarmSummary
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<mgmtResponse rootUrl="https://192.168.116.207/webacs/api/v1/op/groups/groups/alarmSummary" requestUrl="https://192.168.116.207/webacs/api/v1/op/groups/alarmSummary" responseType="operation">
<alarmsSummaryDTO>
<nbrAlarmedAPs>1</nbrAlarmedAPs>
<nbrAlarmedClients>1</nbrAlarmedClients>
<nbrAlarmedDevices>1</nbrAlarmedDevices>
<nbrAlarmedSites>1</nbrAlarmedSites>
<totalAlarms>1</totalAlarms>
</alarmsSummaryDTO>
</mgmtResponse>
Sample JSON Response Payload
https://192.168.116.207/webacs/api/v1/op/groups/alarmSummary.json
{
"mgmtResponse" : {
"@rootUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/groups\/groups\/alarmSummary",
"@requestUrl" : "https : \/\/192.168.116.207\/webacs\/api\/v1\/op\/groups\/alarmSummary",
"@responseType" : "operation",
"alarmsSummaryDTO" : {
"nbrAlarmedAPs" : 1,
"nbrAlarmedClients" : 1,
"nbrAlarmedDevices" : 1,
"nbrAlarmedSites" : 1,
"totalAlarms" : 1
}
}
}