Ericsson Alarm Interface




Contents

1Understanding the Ericsson Alarm Interface
1.1The Ericsson Alarm Interface in a Management Solution
1.2Key Features for Ericsson Alarm Interface
1.3Ericsson Alarm Interface Concepts

2

Alarm Interface Capabilities NBI Exposure

3

Ericsson Alarm MIB Modules Overview

4

Alarm Type Information Mapping to NBI

5

Alarm Instances Information Mapping to Notification

6

Heartbeat Information Mapping to NBI

7

Mapping Between IETF MIB Framework and ECLI/NETCONF Model

8

Alarm Log and Alert Format

1   Understanding the Ericsson Alarm Interface

1.1   The Ericsson Alarm Interface in a Management Solution

The Ericsson Alarm Interface provides a unified way to expose the alarm status of an Ericsson Managed Element (ME) to a management system or a Command-Line Interface (CLI) client.

Figure 1   Use of the Ericsson Alarm Interface

The Ericsson Alarm Interface consists of alarm handling capabilities exposed over the following interfaces:

Alarm information is available in the ECLI, NETCONF, and SNMP interfaces and in log files.

For a complete description about the ECLI, refer to Ericsson Command-Line Interface.

For a complete description of the Ericsson Network Configuration (NETCONF) interface, refer to Ericsson NETCONF Interface.

1.2   Key Features for Ericsson Alarm Interface

Table 1    Key Features for Ericsson Alarm Interface

Feature

Description

Stateful and stateless notifications

Alarm state changes and alert are spontaneously notified over SNMP.

Support for multiple notification receivers

Multiple SNMP targets can be defined to receive SNMP notifications.

Active alarm list

The active alarm list is exposed over SNMP and NETCONF to enable a management system to synchronize or resynchronize the alarm status with the managed element. The active alarm list is also exposed over the ECLI.

Alarm and alert history

Alarm and alert logs keep in a chronological order all alarm state changes and alerts.

Alarm interface monitoring

A heartbeat mechanism makes it possible to detect problems with the alarm interface (interface down or loss of individual alarms).

Strict alarm identification

An alarm instance is unambiguously identified based on a combination of its source and its alarm type.

Operating Instruction identification

Each alarm type has an Operating Instruction document titled according to its specific problem value.

Alarm filtering

When an alarm is detected as toggling between raised and clear state at a too high frequency, the message "The alarm is toggling" is appended to the additional text. In such situation, the individual state changes are no longer reported until the alarm is cleared.

System UUID identification

An alarm instance may carry the system UUID of the host where it was detected as part of additionalText or additionalInfo.

1.3   Ericsson Alarm Interface Concepts

An alarm is an indication of a fault that has occurred or is likely to occur and that requires human intervention and action. An alarm is stateful which means that the state can either be raised or cleared. The severity level can be changed by the system by either increase or decrease the severity of the alarm. An alarm is cleared when the underlying fault no longer exists.

An alert is a stateless alarm, that is, an alarm that can only have the raised state.

An alarm notification is an alarm state change sent over SNMP. Alarm notifications are sent when an alarm is initially raised, updates its severity, updates its additional text, and is eventually cleared.

Alarm types define what alarms a ME can actually report. An alarm is uniquely identified by the combination of its source with an alarm type. An alarm type is uniquely identified based on the {major type, minor type} combination or the {specific problem, probable cause, event type} combination.

Table 2    Alarm Type to NBI Mapping

Concept

NETCONF/ECLI

Alarm type

FmAlarmType

major type

majorType

minor type

minorType

Specific Problem

specificProblem

Event Type

eventType

Probable Cause

probableCause

Additional Text

additionalText

Perceived Severity

defaultSeverity

configuredSeverity

Managed Object Class

moClasses

Alarm/Alert

isStateFul

1.3.1   Alarm List Rebuilt Event

This event is reported as a SNMP notification when the ME active alarm list reaches a stable situation after a restart or after an ME internal audit process. It is an indication to the SNMP targets to perform the following:

1.3.2   Heartbeat Event

Alarms and alerts may not always reach a management system because of network issues. Such situation can lead to longer service deterioration or unavailability. The heartbeat mechanism enables a management system to detect quickly alarm/alert loss so the ME is not left unattended during a too long period.

Two heartbeat mechanisms are supported: pull heartbeat and push heartbeat.

The heartbeat mechanism enables a management system to detect quickly if some alarms or alerts have been lost.

With the pull mechanism, a management system regularly polls the following information on the ME:

A management system can pull this information using NETCONF or SNMP. The ECLI is not recommended in this case.

With the push mechanism, the ME instead reports Heartbeat events to a management system at a regular time interval. Heartbeat events contain the same information as in the pull mechanism. The push mechanism is supported only over SNMP using an SNMP notification. It can therefore only be used by management systems acting as SNMP targets.

1.3.3   Other Events

Reporting of all other events is done over NETCONF notifications and is not handled by FM.

2   Alarm Interface Capabilities NBI Exposure

Table 3    Alarm Interface Capabilities NBI Exposure

Capability

Exposed over SNMP

Exposed over NETCONF/ECLI

SNMP Targets

Yes

Yes

Alarm Notification

Yes

No

Active Alarm List

Yes

Yes

Alarm Types

No

Yes

Heartbeat

Yes (configuration & notifications)

Yes (configuration only)

Alarm/alert Log

No

Yes

Strict Alarm Identification

Yes

Yes

Alarm List Rebuilt Notification

Yes

No

System UUID

Yes (if included in additional text)

Yes

3   Ericsson Alarm MIB Modules Overview

The Ericsson Alarm MIB consists of five different MIB modules.

General imported modules:

Alarm MIB modules:

4   Alarm Type Information Mapping to NBI

Alarm information is available in the SNMP, CLI, and NETCONF interfaces and in log files, as described in this section.

A summary of the number of active alarms is available as follows:

Information about the last issued alarm is available as follows:

Column FmAlarmType shows what static alarm model information is visible over NETCONF and the ECLI. Column FmAlarm shows what active alarm information is visible over NETCONF and the ECLI. Column ERICSSON ALARM MIB is mainly for reference and indicates how the information is mapped on the SNMP interface.

Table 4    Alarm Information to NBI Mapping

Concept

NETCONF/ECLI

Ericsson Alarm MIB

Alarm Information

FmAlarm

eriAlarmActiveAlarmEntry

major type

majorType

eriAlarmActiveMajorType

minor type

minorType

eriAlarmActiveMinorType

Managed Object Instance/Source

source

eriAlarmActiveManagedObject

SpecificProblem

specificProblem

eriAlarmActiveSpecificProblem

Sequence Number

sequenceNumber

-

Event Type

eventType

eriAlarmActiveEventType

Event Time

lastEventTime

eriAlarmActiveEventTime

Perceived Severity

activeSeverity

eriAlarmActiveSeverity

Probable Cause

probableCause

eriAlarmActiveProbableCause

Additional Text

additionalText

eriAlarmActiveAdditionalText

Additional Info

additionalInfo

eriAlarmActiveAdditionalInfo

Original Additional Text

originalAdditionalText

eriAlarmActiveOrigAdditionalText

Resource Id

-

eriAlarmActiveResourceId

Original Event time

originalEventTime

eriAlarmActiveOriginalEventTime

Original severity

originalSeverity

eriAlarmActiveOriginalSeverity

number of active alarms

totalActive

eriAlarmActiveNumber

number of active critical alarms

sumCritical

eriAlarmSumCritical

number of active major alarms

sumMajor

eriAlarmSumMajor

number of active minor alarms

sumMinor

eriAlarmSumMinor

number of active warning alarms

sumWarning

eriAlarmSumWarning

number of indeterminate alarms

-

eriAlarmSumIndeterminate

Heartbeat Interval

heartbeatInterval

eriAlarmHeartbeatInterval

Latest Sequence Number

lastSequenceNo

eriAlarmActiveLastSequenceNo

eriAlarmAlertLastSequenceNo

number of alerts

-

eriAlarmAlertNumber

5   Alarm Instances Information Mapping to Notification

Table 5    Summary Alarm Instances Available in Multiple Interfaces

Concept

Ericsson Alarm MIB

Alarm state change

eriAlarm* Notification

eriAlarm*Alert Notification

eriAlarmAppendInfo Notification

eriAlarmAppendAlertInfo Notification

Managed Object Instance/Source

eriAlarmActiveManagedObject

eriAlarmAlertManagedObject

eriAlarmActiveManagedObject

eriAlarmAlertManagedObject

major type

eriAlarmActiveMajorType

eriAlarmAlertMajorType

eriAlarmActiveMajorType

eriAlarmAlertMajorType

minor type

eriAlarmActiveMinorType

eriAlarmAlertMinorType

eriAlarmActiveMinorType

eriAlarmAlertMinorType

Specific Problem

eriAlarmActiveSpecificProblem

eriAlarmAlertSpecificProblem

-

-

Latest sequence Number

eriAlarmActiveLastSequenceNo

eriAlarmAlertLastSequenceNo

-

-

Event Type

eriAlarmActiveEventType

eriAlarmAlertEventType

-

-

Event Time

eriAlarmActiveEventTime

eriAlarmAlertEventTime

-

-

Probable cause

eriAlarmActiveProbableCause

eriAlarmAlertProbableCause

-

-

Additional text

eriAlarmNObjAdditionalText

eriAlarmNObjAdditionalText

eriAlarmNObjAdditionalText

eriAlarmNObjAdditionalText

eriAlarmNObjMoreAdditonalText

eriAlarmNObjMoreAdditonalText

-

-

Resource ID

eriAlarmNObjResourceId

eriAlarmNObjResourceId

eriAlarmActiveResourceId

eriAlarmAlertResourceId

Additional Info

eriAlarmNObjAdditionalInfo

eriAlarmNObjAdditionalInfo

eriAlarmNObjAdditionalInfo

eriAlarmNObjAdditionalInfo

eriAlarmNObjMoreAdditonalInfo

eriAlarmNObjMoreAdditonalInfo

-

-

New or updated alarm

eriAlarmNObjRecordType

-

-

-

6   Heartbeat Information Mapping to NBI

In Table 6, the columns NETCONF/ECLI and ERICSSON ALARM MIB show what information a management system must access to implement a heartbeat pull over NETCONF and SNMP, respectively.

Table 6    Heartbeat Information Mapping to NBI

Heartbeat Information

NETCONF/ECLI

Ericsson Alarm MIB

Latest time stamp

lastChanged

eriAlarmActiveLastChanged

eriAlarmAlertLastChanged

Latest Sequence Number

lastSequenceNo

eriAlarmActiveLastSequenceNo

eriAlarmAlertLastSequenceNo

Events AlarmListRebuilt and HeartBeat are reported using NOTIFICATION-TYPE eriAlarmHeartBeatNotif and eriAlarmAlarmListRebuilt, respectively, according to ERICSSON-ALARM-MIB.

The heartbeat interval of the COM SNMP alarm interface is configurable as follows:

7   Mapping Between IETF MIB Framework and ECLI/NETCONF Model

Table 7    Mapping IETF MIB Framework and ECLI/NETCONF Model

Concept

NETCONF/ECLI

SNMP Object Name

SNMP OID

SNMP target

SnmpTargetV1

SnmpTargetV2C

SnmpTargetV3

SnmpTargetV3Dtls

SnmpTargetAddrEntry

1.3.6.1.6.3.12.1.2.1

 

address

address

address

address

snmpTargetAddrTAddress

1.3.6.1.6.3.12.1.2.1.3

 

port

port

port

port

 

-

informTimeout

informTimeout

informTimeout

snmpTargetAddrTimeout

1.3.6.1.6.3.12.1.2.1.4

 

-

informRetryCount

informRetryCount

informRetryCount

snmpTargetAddrRetryCount

1.3.6.1.6.3.12.1.2.1.5

 

community

community

user

user

snmpTargetParamsSecurityName

1.3.6.1.6.3.12.1.3.1.4

 

-

-

snmpSecurityLevel

-

snmpTargetParamsSecurityLevel

1.3.6.1.6.3.12.1.3.1.5

     

authProtocol

-

usmUserAuthProtocol

1.3.6.1.6.3.15.1.2.2.1.5

     

privProtocol

-

usmUserPrivProtocol

1.3.6.1.6.3.15.1.2.2.1.8

SNMP view

SnmpViewV1

SnmpViewV2C

SnmpViewV3

 

snmpVacmMIB

1.3.6.1.6.3.16

8   Alarm Log and Alert Format

The Alarm Log and Alert Log files are exposed by File Management as two file groups named AlarmLogs and AlertLogs, respectively.

Alarm Log files are rotated. Internal limits set the maximum file size and the maximum number of files. When the maximum number of files is exceeded, the oldest file is deleted automatically. The same behavior applies to Alert Log files.

The Alarm Log and Alert Log records are encoded in a common XML format. The log record consists of two elements. The first element indicates the time the record is logged. The second element contains specific information about the alarm or alert and is formatted as a semicolon-separated string.

Table 8    Alarm and Alert Log Record Format

Tags and Information

Description

<FmLogRecord>

Log record start

<LogTimestamp>

 

Time stamp tag

The time the record is logged


Format: <YYYY-MM-DDThh:mm:ss>Z

</LogTimestamp>

 

<Alarm> or <Alert>

 

Alarm or alert-specific information

Formatted as a semicolon-separated string containing the following tokens:


1. Event Time
2. Source
3. Major Type
4. Minor Type
5. Specific Problem
6. Probable Cause
7. Severity
8. Additional Text
9. Sequence Number
10. Event Type

</Alarm> or </Alert>

 

</FmLogRecord>

Log record end

Example 1   Log Records in Alarm Log

<FmLogRecord>
 <LogTimestamp>2014-03-06T11:20:15Z</LogTimestamp>
 <Alarm>
2014-03-06T11:20:14Z; ManagedElement=CSCF06ST,SystemFunctions=1,Brm=1,BrmBackupManager=⇒
SYSTEM_DATA,BrmBackupScheduler=SYSTEM_DATA;193;327681;BRM, Scheduled Backup Failed;418;MAJOR;⇒
Scheduled Backup for SYSTEM_DATA failed with disk space error;33;OTHER
 </Alarm>
</FmLogRecord>

<FmLogRecord>
 <LogTimestamp>2014-03-06T11:20:25Z</LogTimestamp>
 <Alarm>
2014-03-06T11:20:25Z; ManagedElement=CSCF06ST,SystemFunctions=1,Brm=1,BrmBackupManager=⇒
SYSTEM_DATA,BrmBackupScheduler=SYSTEM_DATA;193;327681;BRM, Scheduled Backup Failed;418;CLEARED;⇒
Scheduled Backup for SYSTEM_DATA failed with disk space error;34;OTHER
 </Alarm>
</FmLogRecord>


Copyright

© Ericsson AB 2017. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
All trademarks mentioned herein are the property of their respective owners. These are shown in the document Trademark Information.

    Ericsson Alarm Interface