U2000 Northbound Alarm File Interface Developer Guide

U2000

V200R015C10

Northbound Alarm File InterfaceDeveloper Guide

Issue 04

Date 2015-06-26

HUAWEI TECHNOLOGIES CO., LTD.

Copyright © Huawei Technologies Co., Ltd. 2015. All rights reserved.

No part of this document may be reproduced or transmitted in any form or by any means without prior writtenconsent of Huawei Technologies Co., Ltd. Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.All other trademarks and trade names mentioned in this document are the property of their respective holders. NoticeThe purchased products, services and features are stipulated by the contract made between Huawei and thecustomer. All or part of the products, services and features described in this document may not be within thepurchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information,and recommendations in this document are provided "AS IS" without warranties, guarantees or representationsof any kind, either express or implied.

The information in this document is subject to change without notice. Every effort has been made in thepreparation of this document to ensure accuracy of the contents, but all statements, information, andrecommendations in this document do not constitute a warranty of any kind, express or implied.

Huawei Technologies Co., Ltd.Address: Huawei Industrial Base

Bantian, LonggangShenzhen 518129People's Republic of China

Website: http://www.huawei.com

Email: [email protected]

Issue 04 (2015-06-26) Huawei Proprietary and ConfidentialCopyright © Huawei Technologies Co., Ltd.

i

http://www.huawei.com

mailto:[email protected]

About This Document

ScopeThis document provides information about the U2000 northbound alarm file interface. Thedocument also provides operation guidelines for connecting the network management system(NMS).

This document only describes how to use and configure general functions and does not describeuser-defined functions. If you want to know how to use and configure user-defined functions,apply for related function documents from Huawei.

Product VersionsThe following table lists the product version related to this document.

Product Name Version

U2000 V200R015C10

Intended AudienceThis document is intended for:

Network management engineers

Change History

04 (2015-06-26)

This is 04 version for V200R015C10. Compared with issue 03 (2015-05-18) ofV200R015C10, no change is made.

U2000Northbound Alarm File Interface Developer Guide About This Document


ii

03 (2015-05-18)


02 (2015-04-15)


01 (2015-03-25)

This is 01 version for V200R015C10. Compared with issue Draft A (2015-01-15) ofV200R015C10, no change is made.

Draft A (2015-01-15)

This is a draft for V200R015C10. Compared with issue 01 (2014-04-15) of V200R014C00, nochange is made.

Organization1 Introduction to Northbound Alarm File Interface

This chapter introduces the definition of the northbound interface and the northbound alarm fileinterface provided by the U2000.

2 Interconnection Commissioning of the Northbound Alarm File Interface

Before interconnecting the NMS with the U2000, conduct an interconnection commissioning.Based on the commissioning result, verify that the northbound alarm file interface meets theconditions for interconnecting with the NMS.

3 Introduction to Alarm Export Tool and File

This chapter describes the alarm export tool, formats of alarm export files, alarm exportoperations, and troubleshooting.

4 Troubleshooting the Northbound Alarm File Interface

The NMS interconnects with the U2000 through the northbound alarm file interface. If a faultoccurs when the NMS is obtaining alarm data, refer to relevant troubleshooting methods in thischapter.

ConventionsSymbol Conventions

The symbols that may be found in this document are defined as follows.



iii

Symbol Description

Indicates an imminently hazardous situation which, if notavoided, will result in death or serious injury.

Indicates a potentially hazardous situation which, if notavoided, could result in death or serious injury.

Indicates a potentially hazardous situation which, if notavoided, may result in minor or moderate injury.

Indicates a potentially hazardous situation which, if notavoided, could result in equipment damage, data loss,performance deterioration, or unanticipated results.NOTICE is used to address practices not related to personalinjury.

Calls attention to important information, best practices andtips.NOTE is used to address information not related to personalinjury, equipment damage, and environment deterioration.

General Conventions

The general conventions that may be found in this document are defined as follows.

Convention Description

Times New Roman Normal paragraphs are in Times New Roman.

Boldface Names of files, directories, folders, and users are inboldface. For example, log in as user root.

Italic Book titles are in italics.

Courier New Examples of information displayed on the screen are inCourier New.

Command Conventions

The command conventions that may be found in this document are defined as follows.


Boldface The keywords of a command line are in boldface.

Italic Command arguments are in italics.



iv


[ ] Items (keywords or arguments) in brackets [ ] are optional.

{ x | y | ... } Optional items are grouped in braces and separated byvertical bars. One item is selected.

[ x | y | ... ] Optional items are grouped in brackets and separated byvertical bars. One item is selected or no item is selected.

{ x | y | ... }* Optional items are grouped in braces and separated byvertical bars. A minimum of one item or a maximum of allitems can be selected.

[ x | y | ... ]* Optional items are grouped in brackets and separated byvertical bars. Several items or no item can be selected.

GUI Conventions

The GUI conventions that may be found in this document are defined as follows.


Boldface Buttons, menus, parameters, tabs, window, and dialog titlesare in boldface. For example, click OK.

> Multi-level menus are in boldface and separated by the ">"signs. For example, choose File > Create > Folder.

Keyboard Operations

The keyboard operations that may be found in this document are defined as follows.

Format Description

Key Press the key. For example, press Enter and press Tab.

Key 1+Key 2 Press the keys concurrently. For example, pressing Ctrl+Alt+A means the three keys should be pressed concurrently.

Key 1, Key 2 Press the keys in turn. For example, pressing Alt, A meansthe two keys should be pressed in turn.

Mouse Operations

The mouse operations that may be found in this document are defined as follows.



v

Action Description

Click Select and release the primary mouse button without movingthe pointer.

Double-click Press the primary mouse button twice continuously andquickly without moving the pointer.

Drag Press and hold the primary mouse button and move thepointer to a certain position.



vi

Contents

About This Document.....................................................................................................................ii

1 Introduction to Northbound Alarm File Interface..................................................................11.1 Definition of Northbound Interface................................................................................................................................21.2 Definition of Northbound Alarm File Interface..............................................................................................................21.3 Using the Alarm File Interface.......................................................................................................................................21.4 Technical Specifications of Northbound File Interface..................................................................................................3

2 Interconnection Commissioning of the Northbound Alarm File Interface.......................42.1 Checking License (Alarm File Interface).......................................................................................................................52.2 Negotiating the Interconnection Parameters of the Alarm File Interface.......................................................................52.3 Modifying the Configuration File of the Alarm Export Tool.........................................................................................62.4 Setting an Alarm Export Task........................................................................................................................................82.5 Verifying Interconnection...............................................................................................................................................9

3 Introduction to Alarm Export Tool and File...........................................................................113.1 Alarm Export Tool........................................................................................................................................................123.2 Alarm Export File.........................................................................................................................................................123.3 Alarm Export Operations..............................................................................................................................................153.3.1 Modifying the Configuration File of the Alarm Export Tool....................................................................................153.3.2 Setting Automatic Export of Alarm Files..................................................................................................................163.3.3 Setting the Termination of Automatically Exporting Alarm Files............................................................................16

4 Troubleshooting the Northbound Alarm File Interface......................................................184.1 Common Troubleshooting and Information Collection (Alarm File Interface)...........................................................194.2 Troubleshooting the Alarm File Export Failure ..........................................................................................................204.3 How to Set Northbound Interface Compatibility.........................................................................................................214.4 How to Set Parameters in a Northbound Configuration File........................................................................................22

U2000Northbound Alarm File Interface Developer Guide Contents


vii

1 Introduction to Northbound Alarm FileInterface

About This Chapter

This chapter introduces the definition of the northbound interface and the northbound alarm fileinterface provided by the U2000.

1.1 Definition of Northbound InterfaceThe northbound interface links the element management system (EMS) and the NMS.

1.2 Definition of Northbound Alarm File InterfaceThe U2000 northbound alarm file interface is one of the northbound interfaces. The NMS obtainsalarm data of NEs through the U2000 northbound alarm file interface.

1.3 Using the Alarm File InterfaceThis section describes how to use the northbound alarm file interface when the U2000 systemadopts different networking modes.

1.4 Technical Specifications of Northbound File InterfaceThis section describes the technical specifications related to the northbound file interface.

U2000Northbound Alarm File Interface Developer Guide 1 Introduction to Northbound Alarm File Interface


1

1.1 Definition of Northbound InterfaceThe northbound interface links the element management system (EMS) and the NMS.

The NMS obtains information about the network elements (NEs) managed by the EMS anddelivers operation commands through the northbound interface. The NE information includesthe alarm, configuration, performance, and inventory data. Figure 1-1 shows the position of thenorthbound interface in the network.

Figure 1-1 Position of the northbound interface

In the communication network, the U2000 provides the alarm, configuration, performance, andinventory data of NEs to the NMS through the northbound interface.

1.2 Definition of Northbound Alarm File InterfaceThe U2000 northbound alarm file interface is one of the northbound interfaces. The NMS obtainsalarm data of NEs through the U2000 northbound alarm file interface.

NOTE

When using the northbound alarm file interface, run the alarm export tool on the U2000 server.

1.3 Using the Alarm File InterfaceThis section describes how to use the northbound alarm file interface when the U2000 systemadopts different networking modes.

For details about how to use the northbound alarm file interface in different networking modes,see Table 1-1.



2

Table 1-1 Usage of the alarm file interface

U2000 SystemType

NMS and U2000Interconnection Solution

Method for the NMS to ObtainAlarm Files

Single-serversystem

Perform interconnection on theU2000 server.

Obtain alarm files on the U2000server.

HA system Perform interconnection on theactive U2000 server.

Obtain alarm files on the activeU2000 server.

Remote HAsystem

SUN SLSsystem

Perform interconnection on themaster U2000 server.

Cluster system(Distributednetworking)

ATAE clusteronline remoteHA system

Perform interconnection on themaster servers of the active andstandby U2000 sites.

Obtain alarm files on the masterservers of the active and standbyU2000 sites.

1.4 Technical Specifications of Northbound File InterfaceThis section describes the technical specifications related to the northbound file interface.

Specification Item Value

Maximum re-upload attempts that are permitted after automaticfile upload fails

3

Interval between re-upload attempts after an automatic fileupload attempt fails (unit: minute)

15

Maximum FTP servers supported by automatic file upload 10



3

2 Interconnection Commissioning of theNorthbound Alarm File Interface

About This Chapter

Before interconnecting the NMS with the U2000, conduct an interconnection commissioning.Based on the commissioning result, verify that the northbound alarm file interface meets theconditions for interconnecting with the NMS.

2.1 Checking License (Alarm File Interface)Before interconnecting the U2000 to the NMS, make sure that the NMS is licensed to use thenorthbound alarm file interface.

2.2 Negotiating the Interconnection Parameters of the Alarm File InterfaceBefore interconnecting the U2000 with the NMS, verify the license of the alarm file interfaceand negotiate the interconnection parameters for the alarm file interface. The alarm file isexported according to the negotiated parameters.

2.3 Modifying the Configuration File of the Alarm Export ToolBefore exporting an alarm file, modify the configuration file of the alarm export tool. Determinethe number, sequence, and names of the fields in the exported alarm file by modifying thecorresponding fields in the configuration files.

2.4 Setting an Alarm Export TaskThis section describes how to set an automatic alarm export task on the U2000 client.

2.5 Verifying InterconnectionThis section describes how to simulate the NMS to obtain the alarm file generated by theU2000 in SFTP mode using the OSMU. According to the obtained alarm file, check whetherthe northbound alarm file interface meets the conditions for interconnecting with the NMS.

U2000Northbound Alarm File Interface Developer Guide

2 Interconnection Commissioning of the Northbound AlarmFile Interface


4

2.1 Checking License (Alarm File Interface)Before interconnecting the U2000 to the NMS, make sure that the NMS is licensed to use thenorthbound alarm file interface.

Do as follows to check that the NMS has the required license:

1. Log in to the U2000 client.

2. Choose License > OSS License Management > License Information (traditionalstyle). Alternatively, double-click System Management in Application Center andchoose License Management > License Information (application style). The LicenseInformation window is displayed.

3. Click the Resource Control Item tab. If Resource contains Alarm File Interface, theNMS is authorized to use the alarm file interface.

2.2 Negotiating the Interconnection Parameters of the AlarmFile Interface

Before interconnecting the U2000 with the NMS, verify the license of the alarm file interfaceand negotiate the interconnection parameters for the alarm file interface. The alarm file isexported according to the negotiated parameters.

The interconnection parameters for the alarm file interface include the user name and passwordfor the NMS to log in to the U2000, the format of the exported file, and the fields in the exportedfile. Table 2-1 lists an example of a group of alarm file interface parameters. The followinginterconnection operations use this example as a reference.

Table 2-1 Example of interconnection parameters

ParameterType

Parameter Parameter Value Description

User User Name ftpuser This parametercannot be modified.

Password The default password isChangeme_123

To improve systemsecurity, change thedefault databasepassword upon firstlogin andperiodically changethe password. Thepassword changeinterval can becustomized asrequired.

Export Path /opt/oss/server/var/fileint/fm/

This parametercannot be modified.




5

ParameterType

Parameter Parameter Value Description

Content Alarm Level l Criticall Majorl Minorl Warning

This parameter canbe modified on theU2000 client.

Alarm Category l Alarml Event

This parameter canbe modified on theU2000 client.

Format File Format CSV This parameter canbe modified on theU2000 client.

2.3 Modifying the Configuration File of the Alarm ExportTool

Before exporting an alarm file, modify the configuration file of the alarm export tool. Determinethe number, sequence, and names of the fields in the exported alarm file by modifying thecorresponding fields in the configuration files.

PrerequisitesYou have logged in to the U2000 server as user ossuser.

Contextl In an SLS system, you need to perform the following steps only on the master server.l In an HA or remote HA system, you need to perform the following steps only on the active

server.l In an ATAE cluster online remote HA system, you need to perform the following steps

only on the master server (include active site and standby site).

You can modify the parameters of the northbound configuration file either by running commandsor by using the OSMU. For details about the operations performed on the OSMU, see 4.4 Howto Set Parameters in a Northbound Configuration File.

Procedure

Step 1 Go to the installation directory of the U2000 server software.

NOTE

The default installation directory of the U2000 server software is /opt/oss/server.

$ cd /opt/oss/server

Step 2 Modify the configuration file.




6

$ vi etc/alarm/locale/en_US/fmexportsvc_field.xml

The following lists the open configuration file. Modify the configuration file according to themodification guide. The modification guide is included in the configuration file.

<?xml version="1.0" encoding="utf-8"?><all name="ColumnList"><section name="AlmColumnList"> <param name="Csn">Log Serial Number</param> <param name="FDNName">Object Identity Name</param> <param name="FDN">Object Identity</param> <param name="ProductID">ProductName</param> <param name="NEType">NEType</param> <param name="NEFDN">NE Object Identity</param> <param name="NEFDNName">Alarm Source</param> <param name="DevCsn">EquipmentAlarmSerialNumber</param> <param name="Id">AlarmName</param> <param name="Type">Type</param> <param name="AlmLevel">Severity</param> <param name="Status">Status</param> <param name="occurUtcTime">OccurrenceTime</param> <param name="ackUtcTime">AcknowledgementTime</param> <param name="clearUtcTime">ClearanceTime</param> <param name="Operator">(UN)AcknowledgementOperator</param> <param name="ClearOperator">ClearanceOperator</param> <param name="ExtendInfo">LocationInformation</param> <param name="LinkFDN">LinkFDN</param> <param name="LinkFDNName">LinkName</param> <param name="LinkType">LinkType</param> <param name="AlarmIdentifier">Alarm Identifier</param> <param name="AlarmId">Alarm ID</param> <param name="MOType">Object Instance Type</param> <param name="clearCategory">Auto Clear</param> <param name="clearType">Alarm Clear Type</param> <param name="businessAffected">business Affected</param> <param name="addtionalText">addtional Text</param> <param name="arrivedUtcTime">arrivedUtcTime</param> <param name="listId">list Id</param> <param name="relatedLogId">related LogId</param> <param name="agentId">agent ID</param> <param name="rootId">root Id</param>  <param name="showFlag">show Flag</param></section><section name="EventColumnList"> <param name="Csn">Log Serial Number</param> <param name="FDNName">Object Identity Name</param> <param name="FDN">Object Identity</param> <param name="ProductID">ProductName</param> <param name="NEType">NEType</param> <param name="NEFDN">NE Object Identity</param> <param name="NEFDNName">Alarm Source</param> <param name="DevCsn">EquipmentAlarmSerialNumber</param> <param name="Id">AlarmName</param> <param name="Type">Type</param> <param name="AlmLevel">Severity</param> <param name="occurUtcTime">OccurrenceTime</param> <param name="ExtendInfo">LocationInformation</param> <param name="LinkFDN">LinkFDN</param> <param name="LinkFDNName">LinkName</param> <param name="LinkType">LinkType</param> <param name="AlarmIdentifier">Alarm Identifier</param> <param name="AlarmId">Alarm ID</param> <param name="MOType">Object Instance Type</param> <param name="businessAffected">business Affected</param> <param name="addtionalText">addtional Text</param> <param name="arrivedUtcTime">arrivedUtcTime</param>




7

<param name="agentId">agent ID</param> <param name="rootId">root Id</param>  <param name="showFlag">show Flag</param></section></all>

Add, delete, or modify the alarm export fields in section. Only the fields listed in the commentpart of the configuration file can be added. For example, to export the FDN of the generatedalarm object, add the following line to section.

<param name="FDN">Alarm Object FDN</param>

The Alarm Object FDN field is added to the exported file accordingly. The field positioncorresponds to the position of the added field in the configuration file. That is, if the added fieldis between Alarm Name and Type, in the exported file, the Alarm Object FDN field is betweenAlarm Name and Type.

In addition to adding, deleting, or modifying the alarm export fields, you can sort the fields inthe configuration file, and export the configuration file based on the sorted fields.

Step 3 Press Esc, and then run :wq! to save the modification and exit the vi editor.

Step 4 Run the following commands for the modified configuration file to take effect.


$ . ./svc_profile.sh

$ svc_adm -cmd restartsvc FaultService

----End

2.4 Setting an Alarm Export TaskThis section describes how to set an automatic alarm export task on the U2000 client.

PrerequisitesYou have logged in to the U2000 client.

Procedure

Step 1 Choose Maintenance > Task Management (traditional style); alternatively, double-clickSystem Management in Application Center and choose Task Schedule > TaskManagement (application style). The Task Management window is displayed.

Step 2 From the navigation tree on the left, choose File Interface > Alarm/Event Log Export to viewa task record.

Step 3 Double-click the task record to open the Attribute dialog box. Set relevant parameters byreferring to Table 2-2.




8

Table 2-2 An example of setting parameters

Tab Page Parameter Parameter Value

Common Parameters Task Name Alarm/Event Log Export

Start Time 10/11/2008 20:14:00

Period One dayThe shortest period is 5minutes.

Extended Parameters File Type CSV

Compression Option Zip

Alarm Level,Category,Type Alarm Level l Criticall Majorl Minorl Warning

Alarm Category l Alarm Logl Event Log

Alarm Type Select All

NOTE

After the alarm is automatically exported and before the next export, right-click on a task record and thenchoose Run Now to enable the alarm file export task manually.

Step 4 Click OK. The setting of automatic export is complete.

----End

2.5 Verifying InterconnectionThis section describes how to simulate the NMS to obtain the alarm file generated by theU2000 in SFTP mode using the OSMU. According to the obtained alarm file, check whetherthe northbound alarm file interface meets the conditions for interconnecting with the NMS.

PrerequisitesThe communication between the NMS and U2000 is normal.

ContextThe NMS can use either of the following methods to obtain alarm files:

l The NMS uses SFTP to obtain alarm files from the specified path on the U2000 server.

l The U2000 uploads alarm files to the NMS.




9

NOTE

The following uses the first method as an example.

l In an SLS system, you need to perform the following steps only on the master server.l In an HA or remote HA system, you need to perform the following steps only on the active



Procedure

Step 1 Start the Internet Explorer, type https://IP address of the U2000 server, and then pressEnter.

Step 2 Log in to the OSMU as user ossuser.

Step 3 In the main window of the OSMU, click NBI Management.

Step 4 In the navigation tree in the left pane, choose NBI Management > Category Management >File Interface > Alarm File Interface to open the Alarm File Interface page.

Step 5 On the Query Alarm Files tab page showing generated alarm files, you can click a file nameand open or download it.

Step 6 Verify the downloaded alarm file.

Use an event alarm as an example, as shown in Figure 2-1. The exported file contains alarmsat critical and warning levels, which are the same as the negotiated parameters. The exportedalarm file is therefore correct.

Figure 2-1 Event alarms

----End




10

3 Introduction to Alarm Export Tool and File

About This Chapter

This chapter describes the alarm export tool, formats of alarm export files, alarm exportoperations, and troubleshooting.

3.1 Alarm Export ToolThe alarm export tool exports alarm logs and event logs from the alarm database to the files inthe specified directory on the server.

3.2 Alarm Export FileThis section describes the path, categories and quantities, naming conventions, formats, anddeletion policy of alarm export files.

3.3 Alarm Export OperationsAlarm export operations consist of modifying configuration files of the alarm export tool, settingautomatic alarm export, and stopping automatic alarm export.

U2000Northbound Alarm File Interface Developer Guide 3 Introduction to Alarm Export Tool and File


11

3.1 Alarm Export ToolThe alarm export tool exports alarm logs and event logs from the alarm database to the files inthe specified directory on the server.

Functions of the Alarm Export ToolThe exported alarms still exist in the database.

Configuration File of the Alarm Export ToolThe configuration file of the alarm export tool is /opt/oss/server/etc/alarm/locale/en_US/fmexportsvc_field.xml, this configuration file defines the name, value, and sequence of alarminformation fields in the exported file.

Automatic Alarm ExportAfter the export function is started, the alarm export tool automatically exports the new alarmsafter the previous alarms are exported from the alarm database to an alarm export file at aspecified time each day. If you have modified Property > Extended Parameters > FilterCondition in the export tool, the alarm export tool exports all data in the alarm database basedon the new filter condition. Later, the alarm export tool exports only the incremental data.

Automatically Uploading Exported FilesThe U2000 can automatically upload exported files through FTP. Choose Software > FTP AutoUpload Management > Target Server Settings (traditional style); alternatively, double-clickSystem Management in Application Center and choose Settings > FTP Auto UploadManagement > Target Server Settings (application style) on the client to set the relevantparameters. After you set the parameters, the U2000 automatically uploads the exported files tothe specified FTP server every five minutes by default. The NMS can therefore obtain thegenerated files. For details about how to configure this function, see the U2000 Online Help.

3.2 Alarm Export FileThis section describes the path, categories and quantities, naming conventions, formats, anddeletion policy of alarm export files.

Path of Alarm Export FilesAll alarm export files are saved in the /opt/oss/server/var/fileint/fm/ directory by default. Ifthis directory is not available when you export alarm files, the export tool automatically createsthis directory.

Categories and Quantities of Alarm Export FilesDuring alarm export, each type of alarms (current alarm logs and event logs) are exported to afile. Each file records a maximum of 5,000 alarms. If the number of a specific alarm type exceeds5,000, the export tool saves additional alarms to a new export file.



12

Naming Conventions of Alarm Export Filesl Naming Conventions

Alarm export files are named in the following format: File Prefix-Date and Time [DST]-Alarm category-auto-Sequence number-Extension, whereThe file prefix field takes effect only if you have set the File Prefix parameter while creatingalarm export tasks on the U2000 client. The parameter value is case sensitive and composedof 0 to 30 digits or letters. For details, see Help.The date and time field records the time when alarms are exported. DST indicates thatalarms are exported during daylight saving time. [] indicates that the sign is not used innon-DST period.The alarm category field records the category of exported alarms. The value can be alarm-log or event-log, which represent alarm logs and event logs, respectively.A maximum of 5,000 alarms of the same category can be exported to a file. Additionalalarms of the same category are exported to another file. Files are numbered sequentiallyfrom 1. If one file is enough to store all exported alarms, the file number is 1.The extension field indicates the format of a file, which can be set to .xml, .csv, .txt, or .html.If you select a compression mode for export, the extension field is .zip or .gzip accordingto the compression mode you select.

l Examples20091006120300-alarm-log-auto-1.xml indicates an alarm log file in .xml format andexported at 12:03 on October 6, 2009.20091006120300-event-log-auto-1.zip indicates an event log file compressed in .zipformat and exported at 12:03 on October 6, 2009.

Formats of Alarm Export FilesThe configuration file <U2000 server installation directory>/etc/alarm/locale/en_US/fmexportsvc_field.xml defines the alarm field information and the sequence and name of eachfield contained in the alarm export files. You can modify this configuration file as required. Fordetails, see 3.3.1 Modifying the Configuration File of the Alarm Export Tool.l CSV, TXT, and HTML

In a CSV, TXT, or HTML file, the first row lists the fields recording alarm information,such as the NE name, alarm name, and alarm severity. From the second row, each rowcorresponds to an alarm.

l XMLIn an XML file, each <Record name="AlarmRecord"></Record> corresponds to an alarm.Following is an example XML file:<?xml version="1.0" encoding="UTF-8"?><ExportFileInfo name="AlarmRecords"> <Record name="AlarmRecord"> <column name="Log Serial Number">2</column> <column name="Object Identity Name">OSS</column> <column name="Object Identity">OS=1</column> <column name="ProductName">NMS</column> <column name="NEType">OSS</column> <column name="NE Object Identity">OS=1</column> <column name="Alarm Source">OSS</column> <column name="EquipmentAlarmSerialNumber">0</column> <column name="AlarmName">The Disk Usage Is Too High (Minor)</column>



13

<column name="Type">QoS</column> <column name="Severity">Minor</column> <column name="Status">Unacknowledged and uncleared alarms</column> <column name="OccurrenceTime">2013/4/13 06:37:43 GMT+08:00</column> <column name="AcknowledgementTime"/> <column name="ClearanceTime"/> <column name="(UN)AcknowledgementOperator"/> <column name="ClearanceOperator"/> <column name="LocationInformation">Host=osssvr-1, Operating System=Linux2.6.16.46-0.12-default, Disk=/dev/md/dsk/d50(/export/home)</column> <column name="LinkFDN"/> <column name="LinkName"/> <column name="LinkType"/> <column name="Alarm Identifier"/> <column name="Alarm ID">35</column> <column name="Object Instance Type"/> <column name="Auto Clear">yes</column> <column name="Alarm Clear Type"/> <column name="business Affected"/> <column name="addtional Text">Threshold=70%, Clearance threshold=65%, Capacity=49248MB, Usage=70%</column> <column name="arrivedUtcTime">2013/4/13 06:37:43 GMT+08:00</column> <column name="list Id">2</column> <column name="related LogId">0</column> <column name="agent ID"/> <column name="root Id"/> <column name="show Flag">0</column> </Record></ExportFileInfo>

NOTE

l Some messages are displayed in multiple lines due to the large size of contents. In the actual file,these messages are displayed in one line.

l When interconnecting the system with the NMS through the northbound alarm interface, you areadvised to use the alarm ID instead of alarm name to identify alarms. This improves the efficiencyof identifying alarms.

l When parsing the location and additional information about alarms, you are advised to parse theinformation based on alarm names instead of forcibly specifying the location and number of relatedparameters. When the NMS parses parameter names, ensure that the parameter names are caseinsensitive.

l Considering that NE alarm severity may be adjusted based on NE versions, you are advised not toforcibly specify the severity of a certain alarm.

l Format description of the alarm generation time: For example, the alarm generation time providedin the alarm export file is 2013/4/13 06:37:43 GMT+08:00, where

l 2013/4/13 06:37:43 refers to the local time, calculated using the following formula: Local time= GMT + Time zone.

l GMT+08:00 refers to the time zone.

Deletion Policy of Alarm Export FilesWhen exporting alarm files, the system automatically checks and deletes files from the exportdirectory according to the policy configured for file export.

The configuration file for the deletion policy of alarm export files is /opt/oss/server/etc/alarm/fileExportPolicy.xml. The default parameters and values are as follows:

<?xml version="1.0" encoding="utf-8"?> <policy name="policy" > <param name="filesize">1024</param> <param name="keepdays">15</param>



14

<param name="filenum">1000</param> </policy>

Table 3-1 Parameters for the deletion policy of alarm export files

Parameter Value Description

filesize Default value: 1024Value range: 200-2048

Size of a file (unit: MB)Can be modified.

keepdays Default value: 15Value range: 3-30

Saving days of a file (unit:day)Can be modified.

filenum Default value: 1000Value range: 200-1000

Number of files.Can be modified.

NOTE

After modifying the deletion policy of alarm export files, restart FaultService for the modification to takeeffect.

You can modify the parameters of the northbound configuration file either by running commands or byusing the OSMU. For details about the operations performed on the OSMU, see 4.4 How to Set Parametersin a Northbound Configuration File.

3.3 Alarm Export OperationsAlarm export operations consist of modifying configuration files of the alarm export tool, settingautomatic alarm export, and stopping automatic alarm export.

3.3.1 Modifying the Configuration File of the Alarm Export ToolBefore you export alarm files, set the number of fields, field sequence, and name description ofalarm information in the alarm export tool configuration file by performing the following steps.

PrerequisitesYou have logged in to the U2000 server as user ossuser.

Contextl In an SLS system, you need to perform the following steps only on the master server.l In an HA or remote HA system, you need to perform the following steps only on the active



You can modify the parameters of the northbound configuration file either by running commandsor by using the OSMU. For details about the operations performed on the OSMU, see 4.4 Howto Set Parameters in a Northbound Configuration File.



15

Procedure

Step 1 Go to the installation folder.

The default installation path is /opt/oss/server.

By default, run the following command:


Step 2 To edit the configuration file, run the following command:

$ vi etc/alarm/locale/en_US/fmexportsvc_field.xml

NOTE

Modify the configuration file according to the modification guide. The modification guide is included inthe configuration file.

Step 3 To make the modified configuration file effective, run the following commands:


$ svc_adm -cmd restartsvc FaultService

----End

3.3.2 Setting Automatic Export of Alarm FilesAfter you set automatic alarm export, the alarm export tool automatically exports the alarmsgenerated in the alarm database after the last automatic export to a file in a specified format ata scheduled time each day.

PrerequisitesYou have logged in to the U2000 client.

Procedure


Step 2 Choose File Interface > Alarm/Event Log Export from the navigation tree to view task records.

Step 3 Double-click a task record. The Attribute dialog box is displayed. Set Common Parametersand Extended Parameters.

Step 4 Click OK. The automatic export configuration is complete.

----End

3.3.3 Setting the Termination of Automatically Exporting AlarmFiles

This section describes the procedure for setting the termination of automatically exporting alarmfiles.



16

Prerequisitesl The conditions for automatic alarm export are met.l You have logged in to the U2000 client.

ContextAfter automatic alarm export is enabled, it can be manually stopped at any time.

For details on setting the automatic alarm export, see 3.3.2 Setting Automatic Export of AlarmFiles.

Procedure


Step 2 Choose File Interface > Alarm/Event Log Export from the navigation tree to view task records.

Step 3 Right-click a task record and choose Suspend from the shortcut menu. The automatic export ofalarm files is stopped.

----End



17

4 Troubleshooting the Northbound Alarm FileInterface

About This Chapter

The NMS interconnects with the U2000 through the northbound alarm file interface. If a faultoccurs when the NMS is obtaining alarm data, refer to relevant troubleshooting methods in thischapter.

4.1 Common Troubleshooting and Information Collection (Alarm File Interface)If a fault occurs when the NMS attempts to obtain alarm data through the northbound alarm fileinterface, handle the fault according to common troubleshooting methods. If it is not possibleto handle a fault using common troubleshooting methods, collect information about the faultand contact Huawei engineers for assistance.

4.2 Troubleshooting the Alarm File Export FailureOne of the following three causes can result in no alarm file being generated: inactive alarm dataexport service, disconnected NEs, or no free disk space on the U2000 server. This sectiondescribes how to handle the problem in any of the previous three situations.

4.3 How to Set Northbound Interface CompatibilityThis section describes how to set the FDN format and OMC ID of northbound interfaces so thatthe northbound interfaces are compatible with earlier versions.

4.4 How to Set Parameters in a Northbound Configuration FileThis section describes how to set parameters in the configuration file of a northbound interface.

U2000Northbound Alarm File Interface Developer Guide 4 Troubleshooting the Northbound Alarm File Interface


18

4.1 Common Troubleshooting and Information Collection(Alarm File Interface)

If a fault occurs when the NMS attempts to obtain alarm data through the northbound alarm fileinterface, handle the fault according to common troubleshooting methods. If it is not possibleto handle a fault using common troubleshooting methods, collect information about the faultand contact Huawei engineers for assistance.

TroubleshootingFor the methods of rectifying common faults that occur during the process of obtaining alarmdata for the NMS, see Table 4-1.

Table 4-1 Troubleshooting

Common Fault Troubleshooting Method

The alarm file is not exported. See 4.2 Troubleshooting the Alarm File ExportFailure .

How to set parameters in anorthbound configuration file

See 4.4 How to Set Parameters in a NorthboundConfiguration File.

Information CollectionWhen an unusual fault occurs during the process of obtaining alarm data for the NMS, collectrelevant information for fault localization. For details about information collection, see Table4-2.

Table 4-2 Description of information collection

Related Information Description

Operation information Record the operations performed before afault occurs and the troubleshooting measurestaken later.

Version information Obtain version information about theU2000, NE mediations, and NEs from eachoffice.

IP information Obtain IP information about U2000 serversfrom each office.



19

Related Information Description

Log information NOTE

l In an SLS system, you need to perform thefollowing steps only on the master server.

l In an HA or remote HA system, you need toperform the following steps only on the activeserver.

l In an ATAE cluster online remote HA system,you need to perform the following steps onlyon the master server (include active site andstandby site).

l Obtain log information from /opt/oss/server/var/logs. In this path, the .tracefilename of FaultService isiMAP.ifms_agent.trace.

l Obtain the exported alarm file from /opt/oss/server/var/fileint/fm/.

l Obtain backup trace files from the /opt/oss/server/var/logs/tracebak directory.

4.2 Troubleshooting the Alarm File Export FailureOne of the following three causes can result in no alarm file being generated: inactive alarm dataexport service, disconnected NEs, or no free disk space on the U2000 server. This sectiondescribes how to handle the problem in any of the previous three situations.

SymptomNo alarm file exists in the export path. The NMS therefore fails to obtain alarm data of the NEs.

TroubleshootingThe following causes can result in no file alarm being exported:l The alarm data export service is not started.l An NE is disconnected.l There is no free disk space on the U2000 server.

Handling Alarm Export Service Not Started FaultsView the status of the alarm data export service, that is FaultService to confirm the service isstarted. If the service is not started, run the relevant commands to start it.

1. Log in to the U2000 server as user ossuser.2. Determine the status of the alarm export service.





20

$ svc_adm -cmd status |grep FaultService

If the following information is displayed, the service is started.FaultService [running ]

3. If the service is not started, run the following command to start it:$ svc_adm -cmd startsvc FaultService

Handling NE Disconnection Faults1. On the U2000 client, choose Topology > Main Topology (traditional style); alternatively,

double-click Topo View in Application Center and choose Topology > MainTopology (application style). In the Main Topology window, right-click the disconnectedNE and then choose Reconnect NE.

2. Verify the network and rectify the network fault.3. Rectify the fault on the NE mediation. To reinstall the NE mediation, see the

Commissioning Guide of the corresponding U2000 networking mode.

Handling Insufficient Disk Space Faults on the U2000 ServerClear the disk space on the U2000 server.

NOTICEConfirm the files can be deleted before clearing the disk space. Deleting a file by mistake canresult in incorrect system operation. You are advised to clear the disk space by referring to theAdministrator Guide of the corresponding U2000 networking mode.

SolutionContact Huawei technical support.

4.3 How to Set Northbound Interface CompatibilityThis section describes how to set the FDN format and OMC ID of northbound interfaces so thatthe northbound interfaces are compatible with earlier versions.

PrerequisitesYou have logged in to the master OSMU server (include the master server of active site andstandby site) as user ossuser. OSMU address: https://U2000 master server IP:31123/

Procedure

Step 1 Click NBI Management on the main page of the OSMU.

Step 2 In the navigation tree of the left pane, choose NBI Management > CentralizedManagement > Northbound Interface Compatibility Settings. The Northbound InterfaceCompatibility Settings tab page is displayed.



21

Step 3 View the current FDN format and OMC ID of each northbound interface.

Step 4 Set the FDN format and OMC ID for each northbound interface based on telecom operators'requirements.

NOTE

You can reset the FDN format, OMC ID, and SRAN northbound interface only after you have negotiatedwith telecom operators.

Step 5 Select The northbound interface change has been discussed with the customer. Thecustomer demands the above settings.

Step 6 Click OK.

The system displays a message stating that some services will restart for the settings to takeeffect.

Step 7 Click Yes to confirm the settings and restart the related services. Click No to cancel the settings.

----End

4.4 How to Set Parameters in a Northbound ConfigurationFile

This section describes how to set parameters in the configuration file of a northbound interface.

Prerequisites

You have logged in to the master OSMU server (include the master server of active site andstandby site) as user ossuser. OSMU address: https://U2000 master server IP:31123/

Context

For details about the configuration file of each northbound interface, see the related developerguide.

Only the northbound performance file interface (NE-based) involves parameter reconfigurationfor slave servers. However, when you modify parameters through the OSMU, you need to modifythem only on the master server, and the slave server automatically synchronizes themodifications.

Procedure

Step 1 Click NBI Management on the main page of the OSMU.

Step 2 Choose NBI Management > Centralized Management > Northbound ConfigurationParameters Settings. The Northbound Configuration Parameters Settings page is displayed.

Step 3 Select a northbound interface and its configuration file. Then set new values to parameters to bemodified in the configuration file.



22

NOTE

l If an interface is not installed, its configuration file cannot be modified. If you select an interface thatis not installed, a message is displayed, indicating that the interface is not installed and you can modifyits configuration file only after installation.

l You can click Reset to restore the modified parameters to their previous values.

l The modifications of parameters marked with * take effect only after you restart related services.

l Parameter validity check will check the validity of parameter values. For details about parameter valueranges, see the parameter description in the related interface developer guide.

Step 4 Click Save for the modification to take effect.

You can view service restart logs in Service Restarted Log.

----End



23

Documents

U2000 Northbound Alarm File Interface Developer Guide