U2000 Northbound Alarm File Interface Developer Guide.pdf

U2000 V200R016C10

Northbound Alarm File Interface Developer Guide Issue

02

Date

2016-03-20

HUAWEI TECHNOLOGIES CO., LTD.

Copyright © Huawei Technologies Co., Ltd. 2016. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent 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.

Notice The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase 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 representations of any kind, either express or implied. The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute a warranty of any kind, express or implied.

Huawei Technologies Co., Ltd. Address:

Huawei Industrial Base Bantian, Longgang Shenzhen 518129 People's Republic of China

Website:

http://www.huawei.com

Email:

[email protected]

Issue 02 (2016-03-20)

Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.

i

U2000 Northbound Alarm File Interface Developer Guide

About This Document

About This Document

Scope This document provides information about the U2000 northbound alarm file interface. The document 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 describe user-defined functions. If you want to know how to use and configure user-defined functions, apply for related function documents from Huawei.

Product Versions The following table lists the product version related to this document. Product Name

Version

U2000

V200R016C10

Intended Audience This document is intended for: Network management engineers

Change History 02 (2016-03-20) This is 02 version for V200R016C10. Compared with issue 01 (2016-02-25) of V200R016C10, no change. Issue 02 (2016-03-20)


ii


About This Document

01 (2016-02-25) This is 01 version for V200R016C10. Compared with issue Draft A (2015-12-30) of V200R016C10, no change.

Draft A (2015-12-30) This is a draft for V200R016C10. Compared with issue 01 (2015-09-20) of V200R016C00, no change is made.

Organization 1 Introduction to Northbound Alarm File Interface This chapter introduces the definition of the northbound interface and the northbound alarm file interface 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 the conditions 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 export operations, and troubleshooting. 4 Troubleshooting the Northbound Alarm File Interface The NMS interconnects with the U2000 through the northbound alarm file interface. If a fault occurs when the NMS is obtaining alarm data, refer to relevant troubleshooting methods in this chapter. 5 Appendix: Description of Fields Exported Through the Alarm File Interface

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

Description Indicates an imminently hazardous situation which, if not avoided, will result in death or serious injury. Indicates a potentially hazardous situation which, if not avoided, could result in death or serious injury. Indicates a potentially hazardous situation which, if not avoided, may result in minor or moderate injury.

Issue 02 (2016-03-20)


iii


Symbol

About This Document

Description Indicates a potentially hazardous situation which, if not avoided, could result in equipment damage, data loss, performance deterioration, or unanticipated results. NOTICE is used to address practices not related to personal injury. Calls attention to important information, best practices and tips. NOTE is used to address information not related to personal injury, 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 in boldface. For example, log in as user root.

Italic

Book titles are in italics.

Courier New

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

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

Issue 02 (2016-03-20)

Convention

Description

Boldface

The keywords of a command line are in boldface.

Italic

Command arguments are in italics.

[]

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

{ x | y | ... }

Optional items are grouped in braces and separated by vertical bars. One item is selected.

[ x | y | ... ]

Optional items are grouped in brackets and separated by vertical bars. One item is selected or no item is selected.

{ x | y | ... }*

Optional items are grouped in braces and separated by vertical bars. A minimum of one item or a maximum of all items can be selected. Huawei Proprietary and Confidential Copyright © Huawei Technologies Co., Ltd.

iv


About This Document

Convention

Description

[ x | y | ... ]*

Optional items are grouped in brackets and separated by vertical 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. Convention

Description

Boldface

Buttons, menus, parameters, tabs, window, and dialog titles are 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 means the two keys should be pressed in turn.

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

Issue 02 (2016-03-20)

Action

Description

Click

Select and release the primary mouse button without moving the pointer.

Double-click

Press the primary mouse button twice continuously and quickly without moving the pointer.

Drag

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


v


Contents

Contents About This Document.....................................................................................................................ii 1 Introduction to Northbound Alarm File Interface.................................................................. 1 1.1 Definition of Northbound Interface................................................................................................................................ 2 1.2 Definition of Northbound Alarm File Interface..............................................................................................................2 1.3 Using the Alarm File Interface....................................................................................................................................... 2 1.4 Technical Specifications of Northbound File Interface.................................................................................................. 3

2 Interconnection Commissioning of the Northbound Alarm File Interface....................... 4 2.1 Checking License (Alarm File Interface)....................................................................................................................... 5 2.2 Negotiating the Interconnection Parameters of the Alarm File Interface.......................................................................5 2.3 Modifying the Configuration File of the Alarm Export Tool......................................................................................... 6 2.4 Setting an Alarm Export Task.........................................................................................................................................8 2.5 Verifying Interconnection............................................................................................................................................... 9

3 Introduction to Alarm Export Tool and File...........................................................................11 3.1 Alarm Export Tool........................................................................................................................................................12 3.2 Alarm Export File......................................................................................................................................................... 12 3.3 Alarm Export Operations..............................................................................................................................................15 3.3.1 Modifying the Configuration File of the Alarm Export Tool.................................................................................... 15 3.3.2 Setting Automatic Export of Alarm Files..................................................................................................................16 3.3.3 Setting the Termination of Automatically Exporting Alarm Files............................................................................ 17

4 Troubleshooting the Northbound Alarm File Interface...................................................... 18 4.1 Common Troubleshooting and Information Collection (Alarm File Interface)........................................................... 19 4.2 Troubleshooting the Alarm File Export Failure .......................................................................................................... 20 4.3 How to Set Northbound Interface Compatibility......................................................................................................... 21 4.4 How to Set Parameters in a Northbound Configuration File........................................................................................22

5 Appendix: Description of Fields Exported Through the Alarm File Interface................24

Issue 02 (2016-03-20)


vi


1

1 Introduction to Northbound Alarm File Interface

Introduction to Northbound Alarm File Interface

About This Chapter This chapter introduces the definition of the northbound interface and the northbound alarm file interface provided by the U2000. 1.1 Definition of Northbound Interface The northbound interface links the element management system (EMS) and the NMS. 1.2 Definition of Northbound Alarm File Interface The U2000 northbound alarm file interface is one of the northbound interfaces. The NMS obtains alarm data of NEs through the U2000 northbound alarm file interface. 1.3 Using the Alarm File Interface This section describes how to use the northbound alarm file interface when the U2000 system adopts different networking modes. 1.4 Technical Specifications of Northbound File Interface This section describes the technical specifications related to the northbound file interface.

Issue 02 (2016-03-20)


1



1.1 Definition of Northbound Interface The northbound interface links the element management system (EMS) and the NMS. The NMS obtains information about the network elements (NEs) managed by the EMS and delivers operation commands through the northbound interface. The NE information includes the alarm, configuration, performance, and inventory data. Figure 1-1 shows the position of the northbound interface in the network. Figure 1-1 Position of the northbound interface

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

1.2 Definition of Northbound Alarm File Interface The U2000 northbound alarm file interface is one of the northbound interfaces. The NMS obtains alarm 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 Interface This section describes how to use the northbound alarm file interface when the U2000 system adopts different networking modes. For details about how to use the northbound alarm file interface in different networking modes, see Table 1-1.

Issue 02 (2016-03-20)


2



Table 1-1 Usage of the alarm file interface U2000 System Type

NMS and U2000 Interconnection Solution

Method for the NMS to Obtain Alarm Files

Single-server system

Perform interconnection on the U2000 server.

Obtain alarm files on the U2000 server.

HA system

Perform interconnection on the active U2000 server.

Obtain alarm files on the active U2000 server.

Remote HA system SUN SLS system

Perform interconnection on the master U2000 server.

ATAE cluster system (Distributed networking) ATAE cluster online remote HA system

Perform interconnection on the master servers of the active and standby U2000 sites.

Obtain alarm files on the master servers of the active and standby U2000 sites.

VM Single System

Perform interconnection on the U2000 VM.

Obtain alarm files on the U2000 VM.

VM Cluster System (Distributed networking)

Perform interconnection on the master U2000 service VM.

Obtain alarm files on the master U2000 service VM.

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

Issue 02 (2016-03-20)

Specification Item

Value

Maximum re-upload attempts that are permitted after automatic file upload fails

3

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

15

Maximum FTP servers supported by automatic file upload

10

Number of objects of the same type supported by northbound performance threshold subscription (unit: number)

50


3


2

2 Interconnection Commissioning of the Northbound Alarm File Interface

Interconnection Commissioning of the Northbound 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 the conditions 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 the northbound alarm file interface. 2.2 Negotiating the Interconnection Parameters of the Alarm File Interface Before interconnecting the U2000 with the NMS, verify the license of the alarm file interface and negotiate the interconnection parameters for the alarm file interface. The alarm file is exported according to the negotiated parameters. 2.3 Modifying the Configuration File of the Alarm Export Tool Before exporting an alarm file, modify the configuration file of the alarm export tool. Determine the number, sequence, and names of the fields in the exported alarm file by modifying the corresponding fields in the configuration files. 2.4 Setting an Alarm Export Task This section describes how to set an automatic alarm export task on the U2000 client. 2.5 Verifying Interconnection This section describes how to simulate the NMS to obtain the alarm file generated by the U2000 in SFTP mode using the OSMU. According to the obtained alarm file, check whether the northbound alarm file interface meets the conditions for interconnecting with the NMS.

Issue 02 (2016-03-20)


4



2.1 Checking License (Alarm File Interface) Before interconnecting the U2000 to the NMS, make sure that the NMS is licensed to use the northbound 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 (traditional style). Alternatively, double-click System Management in Application Center and choose License Management > License Information (application style). The License Information window is displayed.

3.

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

2.2 Negotiating the Interconnection Parameters of the Alarm File Interface Before interconnecting the U2000 with the NMS, verify the license of the alarm file interface and negotiate the interconnection parameters for the alarm file interface. The alarm file is exported according to the negotiated parameters. The interconnection parameters for the alarm file interface include the user name and password for the NMS to log in to the U2000, the format of the exported file, and the fields in the exported file. Table 2-1 lists an example of a group of alarm file interface parameters. The following interconnection operations use this example as a reference. Table 2-1 Example of interconnection parameters

Issue 02 (2016-03-20)

Parameter Type

Parameter

Parameter Value

Description

User

User Name

ftpuser

This parameter cannot be modified.

Password

The default password is Changeme_123

To improve system security, change the default database password upon first login and periodically change the password. The password change interval can be customized as required.


5


Parameter Type

Content


Parameter

Parameter Value

Description

Export Path

/opt/oss/server/var/ fileint/fm/

This parameter cannot be modified.

Alarm Level

l Critical

This parameter can be modified on the U2000 client.

l Major l Minor l Warning Alarm Category

l Alarm l Event

Format

File Format

CSV

This parameter can be modified on the U2000 client. This parameter can be modified on the U2000 client.

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

Prerequisites You have logged in to the U2000 server as user ossuser.

Context 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 server.

l

In an ATAE cluster online remote HA system, you need to perform the following steps on the master server at both active site and standby sites. In a VM cluster system, you need to perform the following steps on the master server at the active site.

You can modify the parameters of the northbound configuration file either by running commands or by using the OSMU. For details about the operations performed on the OSMU, see 4.4 How to 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.

Issue 02 (2016-03-20)


6



$ cd /opt/oss/server Step 2 Modify the configuration file. $ vi etc/alarm/locale/en_US/fmexportsvc_field.xml The following lists the open configuration file. Modify the configuration file according to the modification guide. Configure the fields to be exported. For details, see Appendix: Description of Fields Exported Through the Alarm File Interface.
Log Serial Number Object Identity Name Object Identity ProductName NEType NE Object Identity Alarm Source EquipmentAlarmSerialNumber AlarmName Type Severity Status OccurrenceTime AcknowledgementTime ClearanceTime (UN)AcknowledgementOperator ClearanceOperator LocationInformation LinkFDN LinkName LinkType Alarm Identifier Alarm ID Object Instance Type Auto Clear Alarm Clear Type business Affected addtional Text arrivedUtcTime list Id related LogId agent ID root Id show Flag

Log Serial Number Object Identity Name Object Identity ProductName NEType NE Object Identity Alarm Source EquipmentAlarmSerialNumber AlarmName Type Severity OccurrenceTime LocationInformation LinkFDN LinkName LinkType Alarm Identifier Alarm ID Object Instance Type

Issue 02 (2016-03-20)


7



business Affected addtional Text arrivedUtcTime agent ID root Id show Flag

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

The Alarm Object FDN field is added to the exported file accordingly. The field position corresponds to the position of the added field in the configuration file. That is, if the added field is between Alarm Name and Type, in the exported file, the Alarm Object FDN field is between Alarm Name and Type. In addition to adding, deleting, or modifying the alarm export fields, you can sort the fields in the 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. $ cd /opt/oss/server $ . ./svc_profile.sh $ svc_adm -cmd restartsvc FaultService ----End

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

Prerequisites You have logged in to the U2000 client.

Procedure Step 1 Choose Maintenance > Task Management (traditional style); alternatively, double-click System Management in Application Center and choose Task Schedule > Task Management (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 view a task record. Step 3 Double-click the task record to open the Attribute dialog box. Set relevant parameters by referring to Table 2-2.

Issue 02 (2016-03-20)


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 day The shortest period is 5 minutes.

Extended Parameters

Alarm Level,Category,Type

File Type

CSV

Compression Option

Zip

Alarm Level

l Critical l Major l Minor l Warning

Alarm Category

l Alarm Log l 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 then choose 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 Interconnection This section describes how to simulate the NMS to obtain the alarm file generated by the U2000 in SFTP mode using the OSMU. According to the obtained alarm file, check whether the northbound alarm file interface meets the conditions for interconnecting with the NMS.

Prerequisites The communication between the NMS and U2000 is normal.

Context The 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. NOTE

The following uses the first method as an example.

Issue 02 (2016-03-20)


9



l


l


l


Procedure Step 1 Start the Internet Explorer, type https://IP address of the U2000 server:31123, and then press Enter. 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 name and 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 alarms at critical and warning levels, which are the same as the negotiated parameters. The exported alarm file is therefore correct. Figure 2-1 Event alarms

----End

Issue 02 (2016-03-20)


10


3

3 Introduction to Alarm Export Tool and File

Introduction to Alarm Export Tool and File

About This Chapter This chapter describes the alarm export tool, formats of alarm export files, alarm export operations, and troubleshooting. 3.1 Alarm Export Tool The alarm export tool exports alarm logs and event logs from the alarm database to the files in the specified directory on the server. 3.2 Alarm Export File This section describes the path, categories and quantities, naming conventions, formats, and deletion policy of alarm export files. 3.3 Alarm Export Operations Alarm export operations consist of modifying configuration files of the alarm export tool, setting automatic alarm export, and stopping automatic alarm export.

Issue 02 (2016-03-20)


11



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

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

Configuration File of the Alarm Export Tool The 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 alarm information fields in the exported file.

Automatic Alarm Export After the export function is started, the alarm export tool automatically exports the new alarms after the previous alarms are exported from the alarm database to an alarm export file at a specified time each day. If you have modified Property > Extended Parameters > Filter Condition in the export tool, the alarm export tool exports all data in the alarm database based on the new filter condition. Later, the alarm export tool exports only the incremental data.

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

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

Path of Alarm Export Files All alarm export files are saved in the /opt/oss/server/var/fileint/fm/ directory by default. If this directory is not available when you export alarm files, the export tool automatically creates this directory.

Categories and Quantities of Alarm Export Files During alarm export, each type of alarms (current alarm logs and event logs) are exported to a file. Each file records a maximum of 5,000 alarms. If the number of a specific alarm type exceeds 5,000, the export tool saves additional alarms to a new export file. Issue 02 (2016-03-20)


12



Naming Conventions of Alarm Export Files l

Naming Conventions Alarm export files are named in the following format: File Prefix-Date and Time [DST]Alarm category-auto-Sequence number-Extension, where The file prefix field takes effect only if you have set the File Prefix parameter while creating alarm export tasks on the U2000 client. The parameter value is case sensitive and composed of 0 to 30 digits or letters. For details, see Help. The date and time field records the time when alarms are exported. DST indicates that alarms are exported during daylight saving time. [] indicates that the sign is not used in non-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. Additional alarms of the same category are exported to another file. Files are numbered sequentially from 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 according to the compression mode you select.

l

Examples 20091006120300-alarm-log-auto-1.xml indicates an alarm log file in .xml format and exported at 12:03 on October 6, 2009. 20091006120300-event-log-auto-1.zip indicates an event log file compressed in .zip format and exported at 12:03 on October 6, 2009.

Formats of Alarm Export Files The configuration file /etc/alarm/locale/en_US/ fmexportsvc_field.xml defines the alarm field information and the sequence and name of each field contained in the alarm export files. You can modify this configuration file as required. For details, 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 row corresponds to an alarm.

l

XML In an XML file, each corresponds to an alarm. Following is an example XML file: 2 OSS OS=1 NMS OSS OS=1 OSS 0

Issue 02 (2016-03-20)


13



The Disk Usage Is Too High (Minor) QoS Minor Unacknowledged and uncleared alarms 2013/4/13 06:37:43 GMT+08:00 Host=osssvr-1, Operating System=Linux2.6.16.46-0.12-default, Disk=/dev/md/dsk/d50(/export/home) 35 yes Threshold=70%, Clearance threshold=65%, Capacity=49248MB, Usage=70% 2013/4/13 06:37:43 GMT+08:00 2 0 0 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 are advised to use the alarm ID instead of alarm name to identify alarms. This improves the efficiency of identifying alarms.

l

When parsing the location and additional information about alarms, you are advised to parse the information based on alarm names instead of forcibly specifying the location and number of related parameters. When the NMS parses parameter names, ensure that the parameter names are case insensitive.

l

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

l

Format description of the alarm generation time: For example, the alarm generation time provided in 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 Files When exporting alarm files, the system automatically checks and deletes files from the export directory 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: 1024 15

Issue 02 (2016-03-20)


14



1000

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

Value

Description

filesize

Default value: 1024

Size of a file (unit: MB)

Value range: 200-2048

Can be modified.

Default value: 15

Saving days of a file (unit: day)

keepdays

Value range: 3-30

Can be modified. filenum

Default value: 1000

Number of files.

Value range: 200-1000

Can be modified.

NOTE

After modifying the deletion policy of alarm export files, restart FaultService for the modification to take effect. You can modify the parameters of the northbound configuration file either by running commands or by using the OSMU. For details about the operations performed on the OSMU, see 4.4 How to Set Parameters in a Northbound Configuration File.

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

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

Prerequisites You have logged in to the U2000 server as user ossuser.

Context l


l


l


Issue 02 (2016-03-20)


15



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

Procedure Step 1 Go to the installation folder. The default installation path is /opt/oss/server. By default, run the following command: $ cd /opt/oss/server 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 in the configuration file.

Step 3 To make the modified configuration file effective, run the following commands: $ . ./svc_profile.sh $ svc_adm -cmd restartsvc FaultService ----End

3.3.2 Setting Automatic Export of Alarm Files After you set automatic alarm export, the alarm export tool automatically exports the alarms generated in the alarm database after the last automatic export to a file in a specified format at a scheduled time each day.

Prerequisites You have logged in to the U2000 client.

Procedure Step 1 Choose Maintenance > Task Management (traditional style); alternatively, double-click System Management in Application Center and choose Task Schedule > Task Management (application style). The Task Management window is displayed. 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 Parameters and Extended Parameters. Step 4 Click OK. The automatic export configuration is complete. ----End Issue 02 (2016-03-20)


16



3.3.3 Setting the Termination of Automatically Exporting Alarm Files This section describes the procedure for setting the termination of automatically exporting alarm files.

Prerequisites l

The conditions for automatic alarm export are met.

l

You have logged in to the U2000 client.

Context After 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 Alarm Files.

Procedure Step 1 Choose Maintenance > Task Management (traditional style); alternatively, double-click System Management in Application Center and choose Task Schedule > Task Management (application style). The Task Management window is displayed. 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 of alarm files is stopped. ----End

Issue 02 (2016-03-20)


17


4

4 Troubleshooting the Northbound Alarm File Interface

Troubleshooting the Northbound Alarm File Interface

About This Chapter The NMS interconnects with the U2000 through the northbound alarm file interface. If a fault occurs when the NMS is obtaining alarm data, refer to relevant troubleshooting methods in this chapter. 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 file interface, handle the fault according to common troubleshooting methods. If it is not possible to handle a fault using common troubleshooting methods, collect information about the fault and contact Huawei engineers for assistance. 4.2 Troubleshooting the Alarm File Export Failure One of the following three causes can result in no alarm file being generated: inactive alarm data export service, disconnected NEs, or no free disk space on the U2000 server. This section describes how to handle the problem in any of the previous three situations. 4.3 How to Set Northbound Interface Compatibility This section describes how to set the FDN format and OMC ID of northbound interfaces so that the northbound interfaces are compatible with earlier versions. 4.4 How to Set Parameters in a Northbound Configuration File This section describes how to set parameters in the configuration file of a northbound interface.

Issue 02 (2016-03-20)


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 file interface, handle the fault according to common troubleshooting methods. If it is not possible to handle a fault using common troubleshooting methods, collect information about the fault and contact Huawei engineers for assistance.

Troubleshooting For the methods of rectifying common faults that occur during the process of obtaining alarm data 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 Export Failure .

How to set parameters in a northbound configuration file

See 4.4 How to Set Parameters in a Northbound Configuration File.

Information Collection When an unusual fault occurs during the process of obtaining alarm data for the NMS, collect relevant information for fault localization. For details about information collection, see Table 4-2. Table 4-2 Description of information collection

Issue 02 (2016-03-20)

Related Information

Description

Operation information

Record the operations performed before a fault occurs and the troubleshooting measures taken later.

Version information

Obtain version information about the U2000, NE mediations, and NEs from each office.

IP information

Obtain IP information about U2000 servers from each office.


19



Related Information

Description

Log information

NOTE 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 server. l In an ATAE cluster online remote HA system, you need to perform the following steps on the master server at both active site and standby sites. In a VM cluster system, you need to perform the following steps on the master server at the active site.

l Obtain log information from /opt/oss/ server/var/logs. In this path, the .trace filename of FaultService is iMAP.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 Failure One of the following three causes can result in no alarm file being generated: inactive alarm data export service, disconnected NEs, or no free disk space on the U2000 server. This section describes how to handle the problem in any of the previous three situations.

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

Troubleshooting The 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 Faults View the status of the alarm data export service, that is FaultService to confirm the service is started. 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.

Issue 02 (2016-03-20)


20



$ cd /opt/oss/server $ . ./svc_profile.sh $ svc_adm -cmd status |grep FaultService If the following information is displayed, the service is started. FaultService

3.

[running

]

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

Handling NE Disconnection Faults 1.

On the U2000 client, choose Topology > Main Topology (traditional style); alternatively, double-click Topo View in Application Center and choose Topology > Main Topology (application style). In the Main Topology window, right-click the disconnected NE 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 Server Clear the disk space on the U2000 server.

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

Solution Contact Huawei technical support.

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

Prerequisites You have logged in to the master OSMU server (include the master server of active site and standby 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. Issue 02 (2016-03-20)


21



Step 2 In the navigation tree of the left pane, choose NBI Management > Centralized Management > Northbound Interface Compatibility Settings. The Northbound Interface Compatibility Settings tab page is displayed. 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 negotiated with telecom operators.

Step 5 Select The northbound interface change has been discussed with the customer. The customer demands the above settings. Step 6 Click OK. The system displays a message stating that some services will restart for the settings to take effect. 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 Configuration File 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 and standby 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 developer guide. Only the northbound performance file interface (NE-based) involves parameter reconfiguration for slave servers. However, when you modify parameters through the OSMU, you need to modify them only on the master server, and the slave server automatically synchronizes the modifications.

Procedure Step 1 Click NBI Management on the main page of the OSMU. Step 2 Choose NBI Management > Centralized Management > Northbound Configuration Parameters Settings. The Northbound Configuration Parameters Settings page is displayed. Issue 02 (2016-03-20)


22



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

l If an interface is not installed, its configuration file cannot be modified. If you select an interface that is not installed, a message is displayed, indicating that the interface is not installed and you can modify its 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 value ranges, 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

Issue 02 (2016-03-20)


23


5

5 Appendix: Description of Fields Exported Through the Alarm File Interface

Appendix: Description of Fields Exported Through the Alarm File Interface l

The first column Configuration File Field in the following table lists default columns exported through a file interface export task.

l

In Configuration File Field column, Alarm Comment field is not exported by default, other fields are exported by default.

l

An alarm file interface export task can be executed to export fields both for alarms and events. The fields exported for alarms and events are described, respectively.

Table 5-1 Alarm fields Value Length Configuration File Field

Issue 02 (2016-03-20)

Description

Value Type

(Unit: Byte)

Value Sample

Log Serial Number

Specifies the serial number of an alarm in the alarm log.

Integer

20

21555572

Object Identity Name

Specifies an object identity name.

Character string

800

NodeB Name=JEZ_Kaztransco m_3G

Object Identity

Specifies a globally unique identity.

Character string

300

NE=2633,NODEB=JEZ _Kaztranscom_3G

ProductName

Specifies a product name.

Character string

80

Fixed Network Narrowband

NEType

Specifies the NE that generates an alarm.

Character string

800

BSC6900 GU

NE Object Identity

Specifies an NE FDN identity.

Character string

300

NE=2633


24



Value Length Configuration File Field

Issue 02 (2016-03-20)

Description

Value Type

(Unit: Byte)

Value Sample

Alarm Source

Specifies the NE that generates an alarm.

Character string

800

531002_Jezkazgan_H

EquipmentAlar mSerialNumber

Specifies the serial number of a device where an alarm is generated.

Integer

20

132895

AlarmName

Specifies the name an alarm.

Character string

300

NodeB Unavailable

Type

Specifies the type of an alarm.

Character string

255

Running system

Severity

Specifies the severity of an alarm.

Character string

255

Major

Status

Specifies the status of an alarm.

Character string

255

Unacknowledged and uncleared alarm

OccurrenceTime

Specifies the time when an alarm is generated. (The field value is displayed based on the time zone of the server.)

Character string

80

2014/11/24 23:27:33 GMT+06:00

Acknowledgeme ntTime

Specifies the time when an alarm is acknowledged. (The field value is displayed based on the time zone of the server.)

Character string

80

2014/11/24 23:30:09 GMT+06:00

ClearanceTime

Specifies the time when an alarm is cleared. (The field value is displayed based on the time zone of the server.)

Character string

80

2014/11/24 23:30:09 GMT+06:00


25




Issue 02 (2016-03-20)

Description

Value Type

(Unit: Byte)

Value Sample

(UN)Acknowled gementOperator

Specifies the user who (UN)acknowledg es alarms.

Character string

200

< System operator >

ClearanceOperat or

Specifies the user who clears alarms.

Character string

200

< NE operator >

LocationInforma tion

Specifies the information used for fault diagnosis.

Character string

800

Subrack No.=0, Slot No.=1, Subsystem No.=5, NodeB ID=5433, NodeB Name=JEZ_Kaztransco m_3G, Alarm Cause=All cells of the NodeB unavailable.

LinkFDN

Specifies a link FDN.

Character string

300

-

LinkName

Specifies a link name.

Character string

800

-

LinkType

Specifies a link type.

Character string

800

-

Alarm Identifier

Specifies whether the alarm is an intermittent alarm or whether remarks are provided for the alarm.

Character string

600

(Correlative Alarm)

Alarm ID

Specifies the ID of an alarm.

Integer

20

22214

Object Instance Type

Specifies an object type.

Character string

80

NodeB

Auto Clear

Specifies whether to automatically clear an alarm.

Character string

255

Yes

Alarm Clear Type

Specifies an alarm clearance type.

Character string

255

Normal clear


26




Value Type

(Unit: Byte)

Value Sample

business Affected

Specifies whether the service is affected.

Integer

20

-

additional Text

Specifies the information not for locating an alarm, but for helping users understand an alarm.

Character string

2048

-

arrivedUtcTime

Specifies the time when an alarm arrives at the OSS. (The field value is displayed based on the time zone of the server.)

Character string

80

2014/11/24 23:27:32 GMT+06:00

list Id

Specifies a list ID.

Integer

20

2743154

related LogId

Specifies the log ID of an associated alarm.

Integer

20

0

agent ID

Specifies an agent that generates alarms.

Character string

80

-

root Id

Specifies a root ID.

Character string

80

-

Alarm Comment

Specifies the description for an alarm.

Character string

300

-

Specifies whether alarms are masked.

Character string

80

0

NOTE This field is not exported by default.

show Flag

Issue 02 (2016-03-20)

Description


27



Table 5-2 Event fields

Configuration Field

Issue 02 (2016-03-20)

Description

Value Type

Value Length (Unit: Byte)

Value Sample

Log Serial Number

Specifies the serial number of an event in the event log.

Integer

20

21557139

Object Identity Name

Specifies an FDN name (object identity name).

Character string

800

Slot No.=11, Subrack No=1, Subsystem No.=0

Object Identity

Specifies an object identity.

Character string

300

NE=1015,BRD=11_1_0

ProductName

Specifies a product name.

Character string

80

Fixed Network Narrowband

NEType

Specifies the type of an NE on the network.

Character string

800

BSC6900 GSM

NE Object Identity

Specifies an NE FDN identity.

Character string

300

NE=1015

Alarm Source

Specifies the NE that generates an event.

Character string

800

130802_Taraz_H

EquipmentAlar mSerialNumber

Specifies the serial number of a device where an event is generated.

Integer

20

10206

AlarmName

Specifies the name of an event.

Character string

300

DSP Start Successful

Type

Specifies the type of an event.

Character string

255

Running system

Severity

Specifies the severity of an event.

Character string

255

Warning

OccurrenceTime

Specifies the time when an event is generated. (The field value is displayed based on the time zone of the server.)

Character string

80

2014/11/24 23:30:09 GMT+06:00


28


Configuration Field

Issue 02 (2016-03-20)

Description


Value Type


Value Sample

LocationInforma tion

Specifies the information for event diagnosis.

Character string

800

Subrack No.=1, Slot No.=11, Subsystem No.=0, DSP No.=38

LinkFDN

Specifies a link FDN.

Character string

300

-

LinkName

Specifies a link name.

Character string

800

-

LinkType

Specifies a link type.

Character string

800

-

Alarm Identifier

Specifies whether an event is a repeat event, or whether remarks are provided for the event.

Character string

600

(Alarm Remarks)

Alarm ID

Specifies the ID of an event.

Integer

20

22833

Object Instance Type

Specifies an object type.

Character string

80

Board

business Affected

Specifies whether the service is affected.

Integer

20

-

additional Text

Specifies the information not for locating an event, but for helping users understand an event.

Character string

2048

-

arrivedUtcTime

Specifies the time when an event arrives at the OSS. (The field value is displayed based on the time zone of the server.)

Character string

80

2014/11/24 23:30:09 GMT+06:00

agent ID

Specifies an agent that generates alarms.

Character string

80

-


29


Configuration Field root Id



Value Sample

Description

Value Type

Specifies a root ID.

Character string

80

-

Specifies the description for an event.

Character string

300

-

Specifies whether events are masked.

Character string

80

0

NOTE Generally, the field value is empty and does not support root or correlative relationship.

Alarm Comment NOTE This field is not exported by default.

show Flag

Issue 02 (2016-03-20)


30

U2000 Northbound Alarm File Interface Developer Guide.pdf

Recommend Documents