Initiate a Request for Synchronization of Events or Alarms
post
/{versionId}/fault/trapReceivers/{trapReceiverId}/action
Request that the SDM server re-send events or alarms within a specific time range to the trap receiver targeted by its identifier. SDM resends alarms to this northbound trap receiver only if the type is set to syncActiveAlarm, or it resends events if the type is set to syncAlarm. This method is used to retrieve events or alarms that may not have been received by a northbound server because the system is down or there are network partitions. Using this method for a northbound system can request and synchronize with events or alarms that may have been missed during a connectivity downtime event.
Request
Path Parameters
Back to Top
Response
200 Response
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 initiate a request for synchronization of events or alarms using curl.
curl -X POST \
-b sessionid.txt \
--header "Accept: application/xml" \
--header "Content-Type: application/xml" \
"https://example.com:8443/rest/v1.3/fault/trapReceivers/{trapReceiverId}/action"The following example shows how to initiate a request for synchronization of events or alarms using Python.
import requests
from lxml import etree
url = "https://example.com:8443/rest/v1.3/fault/trapReceivers/{trapReceiverId}/action"
headers = { "Accept":"application/xml", "Content-Type: application/xml", "Cookie":cookie }
data = etree.tostring(etree.parse("request.json"))
resp = requests.post(url, headers=headers, data=data)Example of the Request Body
The following example shows the contents of the request body in XML.
<?xml version="1.0" encoding="UTF-8"?>
<alarmAction>
<startTime>10/05/2022 16:51:52</startTime>
<endTime>10/06/2022 17:51:52</endTime>
<minimumSeverity>Warning</minimumSeverity>
<type>SyncAlarm</type>
</alarmAction>No JSON example has been provided.
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"?>
<alarmActionResult>
<forwardedAlarms>143</forwardedAlarms>
<status>Success</status>
<trapReceiverId>ID1061</trapReceiverId>
<trapReceiverIpAddress>1.1.1.1</trapReceiverIpAddress>
</alarmActionResult>No JSON example has been provided.