Email Alarm Forwarding

7/30/2019 Email Alarm Forwarding

1/19

E-mail Alarm Forwarding v. 3.1.1

Interface Description

DN70136073Issue 3-1-1 en

Nokia Siemens Networks 1(19)


2/19

Table of Contents

The information in this document is subject to change without notice and describes only theproduct defined in the introduction of this documentation. This documentation is intended for theuse of Nokia Siemens Networks customers only for the purposes of the agreement under whichthe document is submitted, and no part of it may be used, reproduced, modified or transmitted in

any form or means without the prior written permission of Nokia Siemens Networks. The

documentation has been prepared to be used by professional and properly trained personnel,and the customer assumes full responsibility when using it. Nokia Siemens Networks welcomes

customer comments as part of the process of continuous development and improvement of thedocumentation.

The information or statements given in this documentation concerning the suitability, capacity, or

performance of the mentioned hardware or software products are given as is and all liabilityarising in connection with such hardware or software products shall be defined conclusively and

finally in a separate agreement between Nokia Siemens Networks and the customer. However,Nokia Siemens Networks has made all reasonable efforts to ensure that the instructionscontained in the document are adequate and free of material errors and omissions. Nokia

Siemens Networks will, if deemed necessary by Nokia Siemens Networks, explain issues whichmay not be covered by the document.

Nokia Siemens Networks will correct errors in this documentation as soon as possible. IN NOEVENT WILL NOKIA SIEMENS NETWORKS BE LIABLE FOR ERRORS IN THIS

DOCUMENTATION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL,DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT

NOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESSOPPORTUNITY OR DATA,THAT MAY ARISE FROM THE USE OF THIS DOCUMENT ORTHE INFORMATION IN IT.

This documentation and the product it describes are considered protected by copyrights and

other intellectual property rights according to the applicable laws.

The wave logo is a trademark of Nokia Siemens Networks Oy. Nokia is a registered trademarkof Nokia Corporation. Siemens is a registered trademark of Siemens AG.

Other product names mentioned in this document may be trademarks of their respectiveowners, and they are mentioned for identification purposes only.

Copyright Nokia Siemens Networks 2012. All rights reserved.

DN70136073Issue 3-1-1 en



3/19

Table of Contents

DN70136073Issue 3-1-1 en


1 About this document ............................................................................ 42 Overview ............................................................................................... 52.1 Introduction ............................................................................................. 52.2 Context of the interface........................................................................... 52.3 Features ................................................................................................. 73 Information model ................................................................................ 83.1 Interface concepts .................................................................................. 84 Description of the interface ............................................................... 104.1 Syntax of the interface .......................................................................... 104.2 Alarm attributes .................................................................................... 104.2.1 Alarm description .................................................................................. 144.2.2 User comments .................................................................................... 154.2.3 E-mail format ........................................................................................ 154.3 Semantics............................................................................................. 154.4 Configuring NetAct for using the interface............................................. 164.5 Example(s) ........................................................................................... 165 Where to find more information......................................................... 19


4/19

About this document

DN70136073Issue 3-1-1 en


1 About this document

The E-mail Alarm Forwarding Interface is designed to send e-mails formultiple e-mail recipients using external e-mail sender programs.

This document describes the alarm format for e-mail and also providesreferences for creating e-mail forwarding rules using the Rule Editor User

interface. Configuring external e-mail forwarding clients and servers isoutside the scope of this document.


5/19

Overview

DN70136073Issue 3-1-1 en


2 Overview

This chapter provides an overview of the alarm format in e-mails.

2.1 Introduction

Alarm formats for e-mail described in Section Semanticsare used forsending alarms from NetAct. This interface does not address theconfiguration of external mail servers.

NetAct uses this interface to notify operators through e-mail by sendingthe alarm details to their e-mail address.

You must be familiar with NetAct FM, the Open Fault Standard Interface(OFaS) and the NetAct alarm structure. This document is intended for

NetAct architects

NetAct designers Developers and testers.

2.2 Context of the interface

The E-mail Alarm Forwarding Interface is part of NetAct. This interfacesends e-mails directly using an external mail server configured via thepreferences.

The alarm forwarding system in NetAct forwards alarms to e-mailaccounts using a specific e-mail format. The e-mail alarm format specifiedin this interface is the same to all the recipients. NetAct sends each alarmnotification in a separate mail.

This interface does not specify how NetAct fetches event information anddoes not describe the format of e-mail rules.


6/19

Overview

DN70136073Issue 3-1-1 en


Figure 1. Context of the E-mail Alarm Forwarding Interface

NetAct-based System

e-mails

FM Platform

E-mail Alarm Forwardinginterface

external email server

Email Mediation


7/19

Overview

DN70136073Issue 3-1-1 en


2.3 Features

The following table lists the E-mail Alarm Forwardingfeatures.

Table 1: E-mail Alarm Forwardingfeatures

Feature Description Technology

send alarm to email recipients NetAct sends fault managementevents to e-mail recipients usingthe format specified in the

interface.

ASCII

include alarm description in e-mail

When forwarding an alarm to thee-mail system, NetAct alsosends an alarm description inthe e-mail.

ASCII

include user comments in e-mail When forwarding an alarm to thee-mail system. NetAct alsosends user commentsassociated with the alarm.

ASCII


8/19

Information model

DN70136073Issue 3-1-1 en


3 Information model

This chapter describes the information model of the interface.

3.1 Interface conceptsTableAlarm attributes lists the attribute names used in this interface. Formore information on the OFaS attributes, see Open Fault Standard (OfaS)Interface Description.

Table 2. Alarm attributes

Attribute name Description Source Supported in thecurrent version

specificProblem Qualification of the fault Alarm YesperceivedSeverity Severity of the alarm Alarm Yes

maintenanceRegion Name of the maintenance region Alarm Yes

siteName Name of the site Alarm Yes

siteAddress Address information of the site Alarm Yes

distinguishedName Distinguished name of thealarming object.

Alarm Yes

alarmText Textual description of the fault Alarm Yes

eventTime Time the event was generated Alarm Yes

notificationId Notification id of the fault Alarm Yes

ackTime Time the event was acknowledged Alarm Yes

ackedBy The acknowledge user Alarm Yes

cancelTime Time the event was cancelled Alarm Yes

cancelledBy The cancel user Alarm Yes

additionalText1 Additional information on the fault Alarm Yes


9/19

Information model

DN70136073Issue 3-1-1 en


Attribute name Description Source Supported in thecurrent version

additionalText2 Additional information on the fault Alarm YesadditionalText3 Further additional information on

the faultAlarm Yes

additionalText4 Further additional information onthe fault

Alarm Yes

eventType Type of the event Alarm Yes



additionalText7 Further additional information onthe fault

Alarm Yes


10/19

Description of the interface

DN70136073Issue 3-1-1 en


4 Description of the interface

This section describes the individual components of the e-mail format.

4.1 Syntax of the interface

The interface contains three parts:

Alarm attributes

Alarm description

User comments

The following sub-sections define the syntax of each part of the interface.

4.2 Alarm attributes

This section describes the format of the alarm information for differenttypes of alarms.

Active alarm

The figure 1 describes the representation of various alarm attributes in the e-mail for an active alarm.


11/19


DN70136073Issue 3-1-1 en


Acknowledged alarm

The figure 2 describes the representation of various alarm attributes in the e-mail for an acknowledged alarm. The distinguishing fields for this alarm are

ACKED and ACKED By which are the ack time and ack user information foran acked alarm respectively.

Cleared alarm

The figure 3 describes the representation of various alarm attributes in the e-mail for a cleared alarm. The distinguishing fields for this alarm areCANCELLED and CANCELLED By which is the cancel time and cancel userinformation for a cancelled alarm.

0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 Data \n Column

Number

= = = = = = = = = = = = = = = = = = = = = \n Line 1

A L A R M N U M B E R : \n Line 2

S E V E R I T Y : \n Line 3

M A I N T E N A N C E R E G I O N : \n Line 4

S I T E N A M E : \n Line 5

S I T E A D D R E S S : \n Line 6

D I S T I N G U I S H E D N A M E : \n Line 7

S T A R T E D : \n Line 8

N O T I F I C A T I O N I D : \n Line 9

E V E N T T Y P E : \n Line 10

A L A R M T E X T : \n Line 11

A D D I T I O N A L T E X T 1 : \n Line 12




12/19


DN70136073Issue 3-1-1 en


Figure 1. Alarm format for an active alarm





\n > Line 19

M A N P A G E :

U S E R C O M M E N T S :


13/19


DN70136073Issue 3-1-1 en


Figure 3. Alarm format for a cancelled alarm



A C K E D : \n Line 10

A C K E D B Y : \n Line 11



\n > Line 14

M A N P A G E :



14/19


DN70136073Issue 3-1-1 en


4.2.1 Alarm description

NetAct retrieves the alarm description (man-page) for an alarm as described inFM Basic O&M Metamodel Interface Description. The following is the format for

the alarm description.

Alarm description in the e-mail is an optional component and an option to selectthe alarm description is provided in Rule Editor

S I T E A D D R E S S : \n Line 6

D I S T I N G U I S H E D N A M E : \n Line 7



C A N C E L L E D : \n Line 10

C A N C E L L E D B Y : \n Line 11



\n > Line 14

M A N P A G E :



15/19


DN70136073Issue 3-1-1 en


4.2.2 User comments

The user comments component in the e-mail is optional. The option to select

user comments is provided in Rule Editor. In case user comments are notavailable for the alarm, text indicating the same will be present.

4.2.3 E-mail format

This section describes the format for the e-mail.

ALARM ATTRIBUTES:

ALARM DESCRIPTION FOR THIS ALARM:

USER COMMENTS FOR THIS ALARM DESCRIPTION:

4.3 Semantics

The installation of NetAct configures the email-sending related commandsand information in the preferences.

Create rules using Rule Editor.

There are two steps of e-mail-sending:

1. Rule matching: Upon receiving an alarm which matches the e-mail-forwarding rule, NetAct fetches all required information for creatingthe e-mail.
http://../My%20Documents/E-mail%20Alarm%20Forwarding%20Interface%20Description.dochttp://../My%20Documents/E-mail%20Alarm%20Forwarding%20Interface%20Description.doc


16/19


DN70136073Issue 3-1-1 en


2. Sending to e-mail accounts by forwarding to an external mail server:external mail server details configured in preference data will beused for sending e-mails to specified recipients.

4.4 Configuring NetAct for using the interface

You can configure the mail server you want to use in NetAct inpreferences. The preferences to be configured for external mail server areexplained below and are present in Pref_system_fmcore.xml file.

de

4.5 Example(s)

MAIL FOR AN ACTIVE ALARM:

============================================================ALARM_NUMBER : 2815SEVERITY : CRITICALMaintenance Region : MRNameSite Name : SiteNameSite Address : H1


17/19


DN70136073Issue 3-1-1 en


Distinguished Name : PLMN-PLMN/BSC-1Started : 2008-10-10 17:50:56Notification Id : 4Event Type : PROCESSINGAlarm Text : Alarm Text

Man Page : RNW ALARM UPLOAD ONGOING18A disturbance has occurred in the radionetwork alarm system.To assure the correct alarm situation in the RNC,the system is uploading active alarms from every BTS in the network.No Supp. The alarm requires no actionsDo not cancel the alarm. The system cancels thealarm automatically when the alarm uploading has been finished.

User Comments : No User Comments For This Alarm Number============================================================

MAIL FOR ACKNOWLEDGED ALARM:

============================================================ALARM_NUMBER : 2815SEVERITY : ALARM_ACKED

Maintenance Region : MRNameSite Name : SiteNameSite Address : H1Distinguished Name : PLMN-PLMN/BSC-1Started : 2008-10-10 17:50:56Notification Id : 4Acked : 2008-10-10 17:51:43Acked By : omcEvent Type : PROCESSINGAlarm Text : Alarm Text

Man Page : RNW ALARM UPLOAD ONGOING18A disturbance has occurred in the radionetwork alarm system.To assure the correct alarm situation in the RNC,the system is uploading active alarms from every BTS in the network.No Supp.The alarm requires no actionsDo not cancel the alarm. The system cancels the

alarm automatically when the alarm uploading has been finished.

User Comments : No User Comments For This Alarm Number-----------============================================================

MAIL FOR CANCELLED ALARM:

============================================================ALARM_NUMBER : 2815SEVERITY : ALARM_CLEAREDMaintenance Region : MRNameSite Name : SiteNameSite Address : H1Distinguished Name : PLMN-PLMN/BSC-1Started : 2008-10-10 17:50:56Notification Id : 4Cancelled : 2008-10-10 17:52:44Cancelled by : omcEvent Type : PROCESSINGAlarm Text : Alarm Text

Man Page : RNW ALARM UPLOAD ONGOING18A disturbance has occurred in the radionetwork alarm system.To assure the correct alarm situation in the RNC,the system is ploading active alarms from every BTS in the network.No Supp.The alarm requires no actionsDo not cancel the alarm. The system cancels thealarm automatically when the alarm uploading has been finished.


18/19


DN70136073Issue 3-1-1 en


User Comments : No User Comments For This Alarm Number============================================================


19/19

Where to find more information

DN70136073Issue 3-1-1 en


5 Where to find more information

See the following documentation for more information:

FM Basic: O&M Metamodel Interface Description

Rule Editor help

Open Fault Standard (OFaS) Interface Description

Email Alarm Forwarding

Documents

Transcript of Email Alarm Forwarding