Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

GET Alarms

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: 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/Alarms

Updated

Since version 4 type of nttyaddrss7_address is InetAddress.

Response Parameters

Attribute Description

acknowledgementStatus boolean

Indicates whether the Alarm has been acknowledged.

alarmFoundAt Date

Reflects the time when the Alarm was found.

alarmId long

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.

annotations Arrow image Annotation[]

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 entity for which the event/alarm is reported.

deviceTimestamp Date

Specifies the device clock time when this alarm was created.

instanceOrigin InstanceOriginEnum

Allowed values:

  • UNCONCERNED
  • APPLICATION
  • NETWORK

instanceTenantId Integer

This is a tenant id for this instance.

lastUpdatedAt Date

Reflects the time when the Alarm was last modified.

message String

Contains the Event/Alarm description as free text.

nttyaddrss7_address InetAddress

Used to associate AP alarms with their controller.

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.

Allowed values:

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

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

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 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" instanceTenantId="String value" uuid="String value">
      <acknowledgementStatus>true</acknowledgementStatus>
      <alarmFoundAt>2018-12-21T12:10:35.659+07:00</alarmFoundAt>
      <alarmId>2</alarmId>
      <annotations>
        <annotation>
          <creationTimestamp>2018-12-21T12:10:35.660+07:00</creationTimestamp>
          <creatorId>String value</creatorId>
          <noteText>String value</noteText>
        </annotation>
        <annotation>
          <creationTimestamp>2018-12-20T12:10:35.660+07:00</creationTimestamp>
          <creatorId>Another string value</creatorId>
          <noteText>Another string value</noteText>
        </annotation>
      </annotations>
      <deviceName>String value</deviceName>
      <deviceTimestamp>2018-12-21T12:10:35.665+07:00</deviceTimestamp>
      <lastUpdatedAt>2018-12-21T12:10:35.665+07:00</lastUpdatedAt>
      <message>String value</message>
      <owner>String value</owner>
      <severity>CRITICAL</severity>
      <source>String value</source>
      <timeStamp>2018-12-21T12:10:35.665+07: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" : {
    "@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,
        "@instanceTenantId" : "String value",
        "@uuid" : "String value",
        "acknowledgementStatus" : true,
        "alarmFoundAt" : "2018-12-21T05:10:35.659Z",
        "alarmId" : 2,
        "annotations" : {
          "annotation" : [ {
            "creationTimestamp" : "2018-12-21T05:10:35.660Z",
            "creatorId" : "String value",
            "noteText" : "String value"
          }, {
            "creationTimestamp" : "2018-12-20T05:10:35.660Z",
            "creatorId" : "Another string value",
            "noteText" : "Another string value"
          } ]
        },
        "deviceName" : "String value",
        "deviceTimestamp" : "2018-12-21T05:10:35.665Z",
        "lastUpdatedAt" : "2018-12-21T05:10:35.665Z",
        "message" : "String value",
        "nttyaddrss7_address" : {
          "address" : "192.168.115.243"
        },
        "owner" : "String value",
        "severity" : "CRITICAL",
        "source" : "String value",
        "timeStamp" : "2018-12-21T05:10:35.665Z",
        "wirelessSpecificAlarmId" : "String value"
      }
    } ]
  }
}