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

GET Alarms

Resource Information

Rate Limiting?

Yes

Sorting?

Yes

Paging?

Yes

Filtering?

Yes

Response Formats

xml

json

User Group

NBI Read

HTTP Methods

GET

Alarm is a representation of the fault or change of state that occurred in the managed system; it could be resource or service and customer related. Alarms are associated with a group of events received from the managed resources, usually with the same source and category, indicating that such fault or event had occurred.

Since Product Version: 1.2

Resource URL

/webacs/api/v1/data/Alarms

Response Parameters

Type Attribute Name Description

boolean

acknowledgementStatus

Indicates whether the Alarm has been acknowledged.

Date

alarmFoundAt

long

alarmId

A calculated opaque value that is used by the event handling implementation logic to identify the alarm and that serves as an identifier (sometimes known as a "business key"). In most cases, the specific alarm ID is an identifier for the entity that caused the alarm (known as the "alarm source" and available in the "source" attribute) augmented by a distinguishing value (or values) to facilitate unique identifying value for this specific alarm. The distinguishing values can be, but are not limited to, the specific types of the alarm.

Annotation[]

annotations

This nested field contains corrective message annotations. These are notes added to the alarm by the operator.

String

applicationSpecificAlarmID

Reports the applicationspecificalarmid generated by EPNM during event processing which acts as business key to relate an event to alarm

EventAlarmCategoryEnum

category

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).

String

chassisId

Chassis ID

EventTypeEnum

condition

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).

String

correlationType

String

deviceName

Represents the entity for which the event/alarm is reported.

Date

deviceTimestamp

Specifies the device clock time when this alarm was created.

String

instanceUuid

This is a uuid for this instance.

Date

lastUpdatedAt

Reflects the time when the Alarm was last modified.

String

message

Contains the Event/Alarm description as free text.

String

nttyaddrss7_address

Used to associate AP alarms with their controller.

String

owner

Specifies the name or ID of the person assigned to handle this alarm. If value is set to NULL, no owner is assigned.

long

rootCauseId

String

serviceAffecting

Service Affecting

int

serviceImpacting

AlarmSeverityEnum

severity

Specifies the Event/Alarm severity.

Allowed values:

  • CRITICAL
  • MAJOR
  • MINOR
  • WARNING
  • CLEARED
  • INFORMATION

String

source

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.

String

srcObjectBusinessKey

Alarm Source Object Business Key

int

srcObjectClassId

Alarm Source Object Class ID

String

srcObjectDisplayName

Alarm Source Object Display Name

long

srcObjectId

Alarm Source Object ID

String

tableName

Table Name

Date

timeStamp

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).

String

wirelessSpecificAlarmId

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://172.25.123.114/webacs/api/v1/data/Alarms/15

<?xml version="1.0" ?>
<queryResponse type="Alarms" responseType="getEntity" requestUrl="https://172.25.123.114/webacs/api/v1/data/Alarms/15" rootUrl="https://172.25.123.114/webacs/api/v1/data">
  <entity dtoType="alarmsDTO" type="Alarms" url="https://172.25.123.114/webacs/api/v1/data/Alarms/15">
    <alarmsDTO displayName="String value" id="15" uuid="String value">
      <acknowledgementStatus>true</acknowledgementStatus>
      <alarmFoundAt>2020-07-28T20:28:06.078Z</alarmFoundAt>
      <alarmId>2</alarmId>
      <annotations>
        <annotation>
          <creationTimestamp>2020-07-28T20:28:06.085Z</creationTimestamp>
          <creatorId>String value</creatorId>
          <noteText>String value</noteText>
        </annotation>
      </annotations>
      <applicationSpecificAlarmID>String value</applicationSpecificAlarmID>
      <chassisId>String value</chassisId>
      <correlationType>String value</correlationType>
      <deviceName>String value</deviceName>
      <deviceTimestamp>2020-07-28T20:28:06.090Z</deviceTimestamp>
      <lastUpdatedAt>2020-07-28T20:28:06.090Z</lastUpdatedAt>
      <message>String value</message>
      <nttyaddrss7_address>String value</nttyaddrss7_address>
      <owner>String value</owner>
      <rootCauseId>2</rootCauseId>
      <serviceAffecting>String value</serviceAffecting>
      <serviceImpacting>1</serviceImpacting>
      <severity>CRITICAL</severity>
      <source>String value</source>
      <srcObjectBusinessKey>String value</srcObjectBusinessKey>
      <srcObjectClassId>1</srcObjectClassId>
      <srcObjectDisplayName>String value</srcObjectDisplayName>
      <srcObjectId>2</srcObjectId>
      <tableName>String value</tableName>
      <timeStamp>2020-07-28T20:28:06.091Z</timeStamp>
      <wirelessSpecificAlarmId>String value</wirelessSpecificAlarmId>
    </alarmsDTO>
  </entity>
</queryResponse>

Sample JSON Payload

https://172.25.123.114/webacs/api/v1/data/Alarms/15.json

{
  "queryResponse" : {
    "@type" : "Alarms",
    "@responseType" : "getEntity",
    "@requestUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Alarms\/15",
    "@rootUrl" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data",
    "entity" : {
      "@dtoType" : "alarmsDTO",
      "@type" : "Alarms",
      "@url" : "https : \/\/172.25.123.114\/webacs\/api\/v1\/data\/Alarms\/15",
      "alarmsDTO" : {
        "@displayName" : "String value",
        "@id" : "15",
        "@uuid" : "String value",
        "acknowledgementStatus" : true,
        "alarmFoundAt" : "2020-07-28T20 : 28 : 06.078Z",
        "alarmId" : 2,
        "annotations" : {
          "annotation" : {
            "creationTimestamp" : "2020-07-28T20 : 28 : 06.085Z",
            "creatorId" : "String value",
            "noteText" : "String value"
          }
        },
        "applicationSpecificAlarmID" : "String value",
        "chassisId" : "String value",
        "correlationType" : "String value",
        "deviceName" : "String value",
        "deviceTimestamp" : "2020-07-28T20 : 28 : 06.090Z",
        "lastUpdatedAt" : "2020-07-28T20 : 28 : 06.090Z",
        "message" : "String value",
        "nttyaddrss7_address" : "String value",
        "owner" : "String value",
        "rootCauseId" : 2,
        "serviceAffecting" : "String value",
        "serviceImpacting" : 1,
        "severity" : "CRITICAL",
        "source" : "String value",
        "srcObjectBusinessKey" : "String value",
        "srcObjectClassId" : 1,
        "srcObjectDisplayName" : "String value",
        "srcObjectId" : 2,
        "tableName" : "String value",
        "timeStamp" : "2020-07-28T20 : 28 : 06.091Z",
        "wirelessSpecificAlarmId" : "String value"
      }
    }
  }
}