Limitations:
- SSE notifications do not include annotations added to the alarm, hence "annotations" block will not be returned in response
Since Product Version: 3.5
Resource Information
Rate Limiting? |
Yes |
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/v4/sse/AlarmsResponse Parameters
Attribute | Description |
---|---|
acknowledgementStatus boolean |
Indicates whether the Alarm has been acknowledged. |
alarmFoundAt Date |
Reflects the time when the Alarm was found. |
alarmId long |
ID of alarm |
This nested field contains corrective message annotations. These are notes added to the alarm by the operator. |
|
category EventAlarmCategoryEnum |
Specifies the major category for the Alarm/Event. Categories are major functionality areas for events. For example, the wireless network management application categorizes events by the type of network element or entity that can emit them (access point, wireless LAN controller, port). A different application can introduce a different set of categories. Binding the list of categories for a particular implementation is represented as a "Lookup" datatype for the values (as opposed to an immutable enumeration type).
|
condition EventTypeEnum |
Specifies a type of occurrence/event within a category. Different applications can introduce different sets of types. Binding the list of types for a particular implementation is represented as a "Lookup" enumeration datatype for the values (as opposed to an immutable enumeration type).
|
deviceName String |
Represents the source of the event (including name and/or MAC address). The failure source format is configurable and depends on the alarm category. You can find and configure failure source patterns in Administration > Settings > System Settings > Alarms and Events > Alarms and Events. |
deviceTimestamp Date |
Specifies the device clock time when this alarm was created. |
lastUpdatedAt Date |
Reflects the time when the Alarm was last modified. |
message String |
Contains the Event/Alarm description as free text. |
nttyaddrss7_address InetAddress |
IP address of the entity that sent the alarm. In case of AP alarms, it is IP address of the controller which sent the alarm. |
owner String |
Specifies the name or ID of the person assigned to handle this alarm. If value is set to NULL, no owner is assigned. |
severity AlarmSeverityEnum |
Specifies the Event/Alarm severity.
|
source String |
Represents the entity for which the event/alarm is reported. This is not necessarily the reporting entity; in many cases, the notification is sent by an entity reporting an occurrence on another entity. Note that this is an opaque reference type that MIGHT be a reference to a known entity (that is, an instance in the model), but it might also be a reference to an entity that is not represented in the system. |
timeStamp Date |
Specifies the time when this alarm was created. This is the same as the time of the event that resulted in the creation of this alarm (attribute Event.notificationTimestamp). |
wirelessSpecificAlarmId String |
This attribute has the meaning only for alarm which was raised by AP, rogue AP or controller. Reports the MAC address of a rogue AP when a rogue AP is detected. Reports the wireless MAC address of an access point for all other alarms raised by an access point. Reports the controller IP address for alarms reported by a controller. |
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 Payload
https://localhost/webacs/api/v4/sse/Alarms
<?xml version="1.0" ?>
<streamResponse count="1" responseType="listEvents" requestUrl="https://localhost/webacs/api/v4/sse/Alarms" rootUrl="https://localhost/webacs/api/v4/sse">
<streamEvent dtoType="alarmsDTO" id="Alarms" action="CREATED">
<alarmsDTO displayName="String value" id="15" uuid="String value">
<acknowledgementStatus>true</acknowledgementStatus>
<alarmFoundAt>1986-07-24T00:00:00+08:00</alarmFoundAt>
<alarmId>2</alarmId>
<annotations>
<annotation>
<creationTimestamp>1986-07-24T00:00:00+08:00</creationTimestamp>
<creatorId>String value</creatorId>
<noteText>String value</noteText>
</annotation>
<annotation>
<creationTimestamp>1991-01-11T00:00:00+07:00</creationTimestamp>
<creatorId>Another string value</creatorId>
<noteText>Another string value</noteText>
</annotation>
</annotations>
<category>
<ordinal>0</ordinal>
<value>All</value>
</category>
<condition>
<ordinal>-1</ordinal>
<value>SWT_VTP_CONFIG_REV_NUMBER</value>
</condition>
<deviceName>String value</deviceName>
<deviceTimestamp>1986-07-24T00:00:00+08:00</deviceTimestamp>
<lastUpdatedAt>1986-07-24T00:00:00+08:00</lastUpdatedAt>
<message>String value</message>
<owner>String value</owner>
<severity>CRITICAL</severity>
<source>String value</source>
<timeStamp>1986-07-24T00:00:00+08:00</timeStamp>
<wirelessSpecificAlarmId>String value</wirelessSpecificAlarmId>
<nttyaddrss7_address>
<address>192.168.115.243</address>
</nttyaddrss7_address>
</alarmsDTO>
</streamEvent>
</streamResponse>
Sample JSON Payload
https://localhost/webacs/api/v4/sse/Alarms.json
{
"streamResponse" : {
"@count" : 1,
"@requestUrl" : "https://localhost/webacs/api/v4/sse/Alarms",
"@responseType" : "listEvents",
"@rootUrl" : "https://localhost/webacs/api/v4/sse",
"streamEvent" : [ {
"@action" : "CREATED",
"@dtoType" : "alarmsDTO",
"@id" : "Alarms",
"alarmsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"acknowledgementStatus" : true,
"alarmFoundAt" : "1986-07-23T16:00:00.000Z",
"alarmId" : 2,
"annotations" : {
"annotation" : [ {
"creationTimestamp" : "1986-07-23T16:00:00.000Z",
"creatorId" : "String value",
"noteText" : "String value"
}, {
"creationTimestamp" : "1991-01-10T17:00:00.000Z",
"creatorId" : "Another string value",
"noteText" : "Another string value"
} ]
},
"category" : {
"ordinal" : 0,
"value" : "All"
},
"condition" : {
"ordinal" : -1,
"value" : "SWT_VTP_CONFIG_REV_NUMBER"
},
"deviceName" : "String value",
"deviceTimestamp" : "1986-07-23T16:00:00.000Z",
"lastUpdatedAt" : "1986-07-23T16:00:00.000Z",
"message" : "String value",
"nttyaddrss7_address" : {
"address" : "192.168.115.243"
},
"owner" : "String value",
"severity" : "CRITICAL",
"source" : "String value",
"timeStamp" : "1986-07-23T16:00:00.000Z",
"wirelessSpecificAlarmId" : "String value"
}
} ]
}
}