Get a List of Alarms
get
/{versionId}/fault/alarms
Retrieve alarms maintained by the fault management system in the SDM database. These alarms originate from events that SDM generated or were received from all the devices that Session Element Manager is managing. The query for alarms can be filtered by using the query parameters provided in the request.
Request
Path Parameters
Query Parameters
Back to Top
Response
200 Response
OK
400 Response
The user input is invalid.
401 Response
The session ID is invalid.
404 Response
The object (resource URI, device, and so on) of your input request cannot be found.
Examples
Examples of Accessing the API
See Authenticate for how to acquire a session cookie.
The following example shows how to get a list of alarms using curl.
curl -X GET \
-b sessionid.txt \
--header "Accept: application/xml" \
"https://example.com:8443/rest/v1.3/fault/alarms"The following example shows how to get a list of alarms using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/fault/alarms"
headers = { "Accept":"application/xml", "Cookie":cookie }
resp = requests.get(url, headers=headers)Example of the Response Body
The following example shows the contents of the response body in XML.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<alarmDetails>
<alarmDetail>
<acknowledgedBy></acknowledgedBy>
<annotation></annotation>
<description>Authentication failed for user admin in the area tacacs with failure authentication-failure.</description>
<failedResource>admin</failedResource>
<nfName>ecb189</nfName>
<objectId>142</objectId>
<severity>Major</severity>
<source>ECBHA189</source>
<sourceGroupId>ID40</sourceGroupId>
<sourceIp>10.0.17.189</sourceIp>
<sysUpTime>0 days, 4 hours, 30 minutes, 29 seconds</sysUpTime>
<time>Thu Oct 06 17:53:47 IST 2022</time>
<trapName>apSecurityTacacsFailureNotification</trapName>
<type>TACACS+ authentication failure</type>
</alarmDetail>
</alarmDetails>No JSON example has been provided.