About this Resource
The Active Alarm resource defines all active alarms present on the Sonus SBC.REST API Methods for this Resource
- GET activealarm
- GET activealarm id
- POST activealarm - action ack
- POST activealarm - action unack
- POST activealarm - action clear
Resource Schema
Runtime
| Parameter Name | Description |
|---|---|
| AlmIndex | Alarm index which is a function of event ID and Event SubID |
| AlmCfgIndex | Alarm config index which is a function of active alarm event ID and event SubID |
| EventID | Alarm/Event ID indicating the subsystem this alarm belongs to. |
| EventSubID | Alarm/Event SubID with in the subsystem |
| Condition | Specifies the condition that generated the alarm. |
| 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. |
| aCategory | Specifies the category to which the event belongs, based on Bell Core Standard GR-1248-CORE. |
| AutoCancel | Indicates if the alarm can be cancelled by any clearing event. Applicable to alarms only. |
| DecodeKey | Specifies decode keys used to interpret the alarm. Multiple keys are separated by ";". |
| aState | Indicates the state of an alarm, whether it is acknowledged/unacknowledged/canceled. |
| InstanceOID | Specifies source instance responsible to generate the alarm. Multiple keys are separated by ";". |
| Count | Indicates number of occurrences of this alarm. |
| FirstOccur | Indicates the first occurrence of this alarm in epoch seconds. |
| LastOccur | Indicates the last occurrence of this alarm in epoch seconds. |
| ClrID | Clearing event ID, when the condtion stated in this event occurs, the active alarm with the above event ID will be cleared. |
| ClrSubID | Clearing event sub ID, when the condtion stated in this event occurs, the active alarm with the above event ID will be cleared. |
| Desc | A brief description about the alarm/event and the preventive actions that can be taken(if any). |
| HighestSeverityAlarm | The highest severity alarm on this node. |
| HardWareID | Hardware ID of the node. |
Overview
Content Tools