About this Resource

Modified: for 2.0.0

The Active Alarm resource defines all active alarms present on the SBC.

REST API Methods for this Resource

Resource Schema

Runtime

Parameter Name Description Data Type Possible Values
AlmIndex Alarm index which is a function of event ID and Event SubID int
AlmCfgIndex Alarm config index which is a function of active alarm event ID and event SubID int
EventID Alarm/Event ID indicating the subsystem this alarm belongs to. int
EventSubID Alarm/Event SubID with in the subsystem int
Condition Specifies the condition that generated the alarm. string
aSeverity Specifies the severity of the alarm. The severity of the alarm determines its color in the Alarm View Panel.

This field is available for Alarms only.

 EnumPossible values:
  • 0 - almEvent
  • 1 - almWarning
  • 2 - almMinor
  • 3 - almMajor
  • 4 - almCritical
aCategory Specifies the category to which the event belongs, based on Bell Core Standard GR-1248-CORE. EnumPossible values:
  • 0 - almCatNone
  • 1 - almCommunication
  • 2 - almEquipment
  • 3 - almProcessing
  • 4 - almGeneral
  • 5 - almEnvironmental
  • 6 - almQOS
  • 7 - almSecurity
AutoCancel Indicates if the alarm can be cancelled by any clearing event. Applicable to alarms only. int
DecodeKey Specifies decode keys used to interpret the alarm. Multiple keys are separated by ";". string
aState Indicates the state of an alarm, whether it is acknowledged/unacknowledged/canceled. EnumPossible values:
  • 0 - almStateNone
  • 1 - almAcknowledge
  • 2 - almUnacknowledge
  • 3 - almCancel
InstanceOID Specifies source instance responsible to generate the alarm. Multiple keys are separated by ";". string
Count Indicates number of occurrences of this alarm. int
FirstOccur Indicates the first occurrence of this alarm in epoch milliseconds. long
LastOccur Indicates the last occurrence of this alarm in epoch milliseconds. long
ClrID Clearing event ID, when the condtion stated in this event occurs, the active alarm with the above event ID will be cleared. int
ClrSubID Clearing event sub ID, when the condtion stated in this event occurs, the active alarm with the above event ID will be cleared. int
Desc A brief description about the alarm/event and the preventive actions that can be taken(if any). string
HighestSeverityAlarm The highest severity alarm on this node. EnumPossible values:
  • 0 - almEvent
  • 1 - almWarning
  • 2 - almMinor
  • 3 - almMajor
  • 4 - almCritical
HardWareID Hardware ID of the node. string