u2000 northbound alarm streaming interface developer guide

8/17/2019 U2000 Northbound Alarm Streaming Interface Developer Guide

1/79

U2000

V200R016C10

Northbound Alarm Streaming

Interface Developer Guide

Issue 02

Date 2016-03-20

HUAWEI TECHNOLOGIES CO., LTD.


2/79

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 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

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

http://www.huawei.com/


3/79


4/79

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-03-25) of V200R015C10,

the change is:

Delete the note in Functions Provided by the Northbound Alarm Streaming Interface: If an

NMS is connected to the U2000, the U2000 synchronizes and reports active alarms, which

affects real-time alarm reporting by the U2000 to other NMSs.

Organization1 Introduction to Northbound Alarm Streaming Interface

This chapter describes the definition of the northbound interface, and the definition and

parameters of the northbound alarm streaming interface.

2 Interconnection Commissioning of the Northbound Alarm Streaming Interface

Before interconnecting the NMS with the U2000, you must conduct an interconnection

commissioning. Based on the commissioning results, you can determine whether the

northbound alarm streaming interface meets the conditions for interconnecting with the NMS.

3 Configuration File and Messages for the Alarm Streaming Interface

The configur ation file for the alarm streaming interface allows you to set different parameters

to control alarm streaming messages.

4 Troubleshooting the Northbound Alarm Streaming Interface

The NMS interconnects with the U2000 through the northbound alarm streaming interface.

This chapter provides troubleshooting suggestions for handling any faults that might occur

when the NMS is obtaining alarm messages.

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.

U2000

Northbound Alarm Streaming Interface Developer Guide About This Document



iii


5/79

Symbol Description


avoided, may result in minor or moderate injury.


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.


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.

U2000




iv


6/79


{ 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.

[ 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.


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

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.

U2000




v


7/79

Contents

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

1 Introduction to Northbound Alarm Streaming Interface......................................................1

1.1 Definition of Northbound Interface................................................................................................................................2

1.2 Definition of Northbound Alarm Streaming Interface................................................................................................... 21.3 Alarm Re port Format......................................................................................................................................................3

1.4 Functions Provided by the Northbound Alarm Streaming Interface..............................................................................3

1.5 Using the Northbound Alarm Streaming Interface.........................................................................................................6

1.6 Technical Specifications of Northbound Alarm Streaming Interface.............................................................................7

2 Interconnection Commissioning of the Northbound Alarm Streaming Interface........... 8

2.1 Checking License (Alarm Streaming Interface).............................................................................................................9

2.2 Negotiating the Interconnection Parameters of the Alarm Streaming Interface.............................................................9

2.3 Commissioning the Interconnection of the Northbound Alarm Streaming Interface...................................................10

2.3.1 (Optional) Enabling the Northbound IP Address for Connection with the NMS......................................................112.3.2 Modifying Relevant Configuration Files of the Alarm Streaming Interface.............................................................12

2.3.2.1 Modifying the Configuration File of the Alarm Streaming Interface.....................................................................12

2.3.2.2 (Optional) Modifying the Connection Configuration File of the Alarm Streaming Interface............................... 13

2.3.3 (Optional) Setting Alarm Filtering Rules.................................................................................................................. 14

2.3.3.1 Setting Filtering Rules for the U2000 to Report Alarms to the Northbound Interface.......................................... 14

2.3.3.2 Setting Filtering Rules for the U2000 to Report Alarms to the Northbound Interface.......................................... 22

2.3.3.3 Setting Filtering Rules for the Northbound Interface to Report Alarms to the NMS.............................................23

2.3.4 Simulating the Interconnection with the NMS in Unencrypted Connection Mode (Alarm Streaming Interface)....24

2.3.5 Simulating the Interconnection with the NMS in SSL Connection Mode (Alarm Streaming Interface)..................25

2.4 Checking Alarm Messages........................................................................................................................................... 26

3 Configuration File and Messages for the Alarm Streaming Interface.............................. 27

3.1 Configuration Files Related to the Alarm Streaming Interface....................................................................................28

3.1.1 Configuration File of the Alarm Streaming Interface................................................................................................28

3.1.2 Configuration File of the Alarm Streaming Filter.....................................................................................................49

3.1.3 Connection Configuration File of the Alarm Streaming Interface............................................................................51

3.2 Alarm Streaming Message in NAMEVALUE Format.................................................................................................53

3.2.1 Format Description of the Alarm Streaming Message in NAMEVALUE Format....................................................53

3.2.2 Introduction to the Alarm Handshake Message in NAMEVALUE Format..............................................................54

3.2.2.1 Content of the Alarm Handshake Message in NAMEVALUE Format..................................................................54

U2000

Northbound Alarm Streaming Interface Developer Guide Contents



vi


8/79

3.2.2.2 Format of the Alarm Handshake Message in NAMEVALUE Format...................................................................54

3.2.2.3 Example of the Alarm Handshake Message in NAMEVALUE Format................................................................ 54

3.2.3 Introduction to the Alarm Data Message in NAMEVALUE Format........................................................................ 55

3.2.3.1 Content of the Alarm Data Message in NAMEVALUE Format............................................................................55

3.2.3.2 Format of the Alarm Data Message in NAMEVALUE Format............................................................................. 55

3.2.3.3 Example of the Alarm Data Message in NAMEVALUE Format...........................................................................60

4 Troubleshooting the Northbound Alarm Streaming Interface.......................................... 66

4.1 Common Troubleshooting and Information Collection (Alarm Streaming Interface).................................................67

4.2 Troubleshooting the Interconnection Failure Between the NMS and the U2000.........................................................68

4.3 How to Set Northbound Interface Compatibility......................................................................................................... 69

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

4.5 How to Handle the Closed SSL Connection Problem..................................................................................................70

U2000

Northbound Alarm Streaming Interface Developer Guide Contents



vii


9/79

1 Introduction to Northbound AlarmStreaming Interface

About This Chapter

This chapter describes the definition of the northbound interface, and the definition and

parameters of the northbound alarm streaming interface.

1.1 Definition of Northbound Interface

The northbound interface links the element management system (EMS) and the NMS.

1.2 Definition of Northbound Alarm Streaming Interface

The northbound alarm streaming interface enables the U2000 to send alarm messages in the

defined format to the specified TCP port in real time. The NMS accesses the TCP port

through the TCP/IP protocol to receive alarm streaming messages in real time.

1.3 Alarm Report Format

The U2000 provides NAMEVALUE alarm message formats.

1.4 Functions Provided by the Northbound Alarm Streaming Interface

This section describes the functions provided by the northbound alarm streaming interface,

which helps the NMS to use this interface easily.

1.5 Using the Northbound Alarm Streaming Interface

This section describes how to use the northbound alarm streaming interface when the U2000

system adopts different networking modes.

1.6 Technical Specifications of Northbound Alarm Streaming Interface

This section describes the technical specifications related to the northbound alarm streaming

interface.

U2000

Northbound Alarm Streaming Interface Developer Guide 1 Introduction to Northbound Alarm Streaming Interface



1


10/79

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 Streaming Interface

The northbound alarm streaming interface enables the U2000 to send alarm messages in the

defined format to the specified TCP port in real time. The NMS accesses the TCP port

through the TCP/IP protocol to receive alarm streaming messages in real time.

After collecting alarms from the NE, the U2000 sends alarm messages to the alarm streaming port in real time. An alarm message maps to an alarm. During the period between alarm

generation and alarm forwarding, the delay is within 10 seconds.

NOTE

If there are buffered alarms, the U2000 forwards those alarms first, and then the received alarms. In this

case, the delay during the alarm streaming may increase.

To maintain the link connection, handshake messages are transmitted between the U2000 and

the NMS when no alarm streaming messages are generated. When the connection is

interrupted, the U2000 buffers the alarm messages and then sends them to the NMS when the

connection recovers. In addition, the U2000 filters alarm messages. You can specify that

alarms of only certain NE types will be forwarded.

U2000




2


11/79

1.3 Alarm Report Format

The U2000 provides NAMEVALUE alarm message formats.

Currently, the U2000 supports NAMEVALUE alarm message formats. For details about the

format of NAMEVALUE, see 3.2 Alarm Streaming Message in NAMEVALUE Format.

For alarm messages in NAMEVALUE format, the U2000 buffers the messages for five hours

by default. You can set the buffer duration.

1.4 Functions Provided by the Northbound AlarmStreaming Interface

This section describes the functions provided by the northbound alarm streaming interface,

which helps the NMS to use this interface easily.

Functions

NOTE

Current and active alarms include uncleared and unacknowledged alarms on the U2000.

Table 1-1 describes the functions provided by the U2000 northbound alarm streaming

interface.

Table 1-1 Functions

Function Description Implementation

Reporting historical alarms After the NMS and the

U2000 are connected, the

U2000 reports historical

alarms to the NMS. After all

the historical alarms are

reported, the U2000 reports

real-time alarms to the

NMS.

In the configuration

file /opt/oss/server/etc/

IRPService/locale/en_US/

FMNotifyParams.xml, set

isSync to Y and

isSyncActive to N.

For detailed operations, see

2.3.2.1 Modifying the

Configuration File of the

Alarm StreamingInterface.

U2000




3


12/79


Reporting active alarms After the NMS and the


U2000 reports active alarms

to the NMS. After all active

alarms are reported, the

U2000 reports real-time

alarms to the NMS.

To view active alarms after

the NMS and the U2000 are

connected successfully, the

NMS can issue a command

for synchronizing the alarms

with the U2000.

In the configuration

file /opt/oss/server/etc/



isSync to N and

isSyncActive to Y.




Alarm Streaming

Interface.

Reporting real-time alarms After the NMS and theU2000 are connected, the

U2000 reports its own real-

time alarms and those of

NEs to the NMS in real

time.

In the configurationfile /opt/oss/server/etc/



isSync to N and

isSyncActive to N.




Alarm Streaming

Interface.

U2000




4


13/79


Synchronizing active alarms After the NMS and the


NMS issues commands for

synchronizing active alarms

to the U2000. Then, the

U2000 synchronizes and

reports active alarms to the

NMS.

When synchronizing active

alarms, the U2000 saves the

caches real-time alarms first.

After all active alarms are

reported, the U2000 reports

real-time alarms.

After remotely logging to

the 8765 port on the U2000

server at the NMS, type

REQ_ACT_ALM in the

NMS, and then press Enter

to synchronize active

alarms.

NOTE

After typing

REQ_ACT_ALM, press

Enter. Ignore any alarm that is

reported when you are typing

the command. After typing the

command, press Enter. This

means you do not need to type

the command again.The active alarm received

by the NMS starts with

BEGIN ACT ALM and

ends with END ACT ALM.

An example is as follows:

BEGIN ACT ALM

Sn = 1608

NeSn = 39985

NeFdn = OS=1

NeName = OSSNeType = OSS

AlarmID = 407

AlarmName = Pm Result

LostCategory = Event

Severity = Critical

State = UnacknowledgedEvent

EventType = OMC

Occurtime = 2009-06-02

16:50:00Location =

FunctionSubSetName:Abis

Interface Paging

Measurement per Cell;Obje

ctName:(1 objects of NE

go); TimeSegment:

[2009-06-02 15:45:00]---[2009-06-02 16:

00:00]; Period:15.

END ACT ALM

U2000




5


14/79


NOTE

If a northbound interface

compatibility ID has been set,

the U2000 will adjust the EMSID and FDN format based on

the setting. For example, the

EMS ID is changed from OSS

to OMC and the FDN is

changed from name-value

format to dotted format. For

details, see 4.3 How to Set

Northbound Interface

Compatibility.

If an NMS is connected to the

U2000, the U2000

synchronizes and reports

active alarms, which affectsreal-time alarm reporting by

the U2000 to other NMSs.

1.5 Using the Northbound Alarm Streaming Interface

This section describes how to use the northbound alarm streaming interface when the U2000

system adopts different networking modes.

For details about how to use the northbound alarm streaming interface in different networking

modes, see Table 1-2.

Table 1-2 Usage of the northbound alarm streaming interface

U2000 System Type NMS and U2000 Interconnection Solution

Single-server system Interconnect to the northbound alarm streaming

interface of the U2000 server.

HA system Interconnect to the northbound alarm streaming

interface of the active U2000 server.Remote HA system

SUN SLS system

ATAE cluster system (Distributed

networking)

ATAE cluster online remote HA

system

Interconnect to the northbound alarm streaming

interface of the master servers at the active and

standby U2000 sites.

VM Single System Perform interconnection on the U2000 VM.

VM Cluster System (Distributed

networking)

Perform interconnection on the master U2000

service VM.

U2000




6


15/79

1.6 Technical Specifications of Northbound AlarmStreaming Interface

This section describes the technical specifications related to the northbound alarm streaming

interface.

Specification Item Value

Maximum number of connections on the alarm streaming

interface

5

Maximum delay in reporting a northbound alarm (unit:

second)

15

U2000




7


16/79

2 Interconnection Commissioning of theNorthbound Alarm Streaming Interface

About This Chapter

Before interconnecting the NMS with the U2000, you must conduct an interconnection

commissioning. Based on the commissioning results, you can determine whether the


2.1 Checking License (Alarm Streaming Interface)

Before interconnecting the U2000 with the NMS, you need to ensure that the NMS is licensed

to use the alarm streaming interface.

2.2 Negotiating the Interconnection Parameters of the Alarm Streaming Interface

This section describes how to negotiate the interconnection parameters of the alarm streaming

interface. The U2000 negotiates with the NMS to determine the interconnection parameters of

the alarm streaming interface. The NMS obtains alarm messages based on the negotiated

parameters.

2.3 Commissioning the Interconnection of the Northbound Alarm Streaming Interface

This section describes how to simulate the interconnection of the northbound alarm streaming

interface through Telnet. Based on the obtained alarms, you can determine whether the


The northbound alarm streaming interface supports connection in SSL and non-SSL modes.

The SSL mode is more secure than the non-SSL mode. Therefore, the SSL mode is

recommended.

2.4 Checking Alarm Messages

This section describes how to check whether the obtained alarm messages meet the negotiated

requirements. Based on the check results, you can determine whether the northbound alarm

streaming interface meets the interconnection conditions.

U2000

Northbound Alarm Streaming Interface Developer Guide

2 Interconnection Commissioning of the Northbound Alarm

Streaming Interface



8


17/79

2.1 Checking License (Alarm Streaming Interface)

Before interconnecting the U2000 with the NMS, you need to ensure that the NMS is licensed

to use the alarm streaming interface.

Perform the following operations to check whether the NMS has the 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 ASCII Streaming

Interface, the NMS is authorized to use the alarm streaming interface.

2.2 Negotiating the Interconnection Parameters of theAlarm Streaming Interface

This section describes how to negotiate the interconnection parameters of the alarm streaming

interface. The U2000 negotiates with the NMS to determine the interconnection parameters of

the alarm streaming interface. The NMS obtains alarm messages based on the negotiated

parameters.

Configurable parameters of the alarm streaming interface are included in the following files:

l /opt/oss/server /etc/IRPService/locale/en_US/FMNotifyParams.xml, which is the

configuration file for the alarm streaming interface. You can change configuration

information such as the message format by using this file. For details, see 3.1.1

Configuration File of the Alarm Streaming Interface.

l /opt/oss/server /etc/IRPService/FMNotify/FMNotifyFilter.xml , which is the

configuration file for filter conditions. You can configure filter conditions and determine

whether to report alarms to the NMS by using this file. For details, see 3.1.2

Configuration File of the Alarm Streaming Filter.

Table 2-1 lists main interconnection parameters.

Table 2-1 Negotiated parameters

Parameter Type Parameter Parameter Value Description

Parameters

provided to the

NMS by the U2000

floating IP

address of the

U2000 server

Change the

parameter value as

required.

For example, the IP

address can be

10.121.71.233.

Number of the

port sending

alarm character

streams

Change the

parameter value as

required.

The default value is 8765.

U2000



Streaming Interface



9


18/79


19/79

2.3.1 (Optional) Enabling the Northbound IP Address forConnection with the NMS

When the NMS interconnects with northbound interfaces through multiple IP planes, you

need to enable the extended northbound service IP address on the northbound interface.

Context

The northbound alarm streaming interface supports multiple IP planes and a maximum of

three northbound service IP addresses at a time. Besides the default northbound service IP

address, it supports a maximum of two extended northbound service IP addresses.

The extended northbound service IP address is not enabled by default. If you need to enable

the extended northbound service IP address, configure parameters in the configuration

file /opt/oss/server/etc/CBB/itfn/NbiItfClientNorthboundConf.xml.

Procedure

Step 1 Log in to the U2000 server as user ossuser.

Step 2 Open the configuration file /opt/oss/server/etc/CBB/itfn/NbiItfClientNorthboundConf.xmland enable the extended northbound service IP addresses.

Run the following command:> vi /opt/oss/server/etc/CBB/itfn/NbiItfClientNorthboundConf.xml

The contents of the configuration file are as follows:< xml version="1.0" encoding="UTF-8"?>

true true true

………………………………

l InterfaceClient name

Indicates the name of a northbound interface. Configure parameters below

name="Alarm Streaming Interface".

l floatServerName

Indicates the value of floatServerName in /opt/oss/server/etc/conf/sysconfigure.xml.

It is the default northbound service IP address and does not need to be configured. Retain

the default value true.

l NORTH01ServerName

Indicates the value of NORTH01ServerName in /opt/oss/server/etc/conf/

sysconfigure.xml.

It is the first extended northbound service IP address. Its default value is false. If the IP

address is required, set NORTH01ServerName to true.

l NORTH02ServerName

Indicates the value of NORTH02ServerName in /opt/oss/server/etc/conf/

sysconfigure.xml.

It is the second extended northbound service IP address. Its default value is false. If theIP address is required, set NORTH02ServerName to true.

U2000



Streaming Interface



11


20/79

Step 3 Restart the IRPService service for the configuration to take effect.

Run the following command:> cd /opt/oss/server

> . ./svc_profile.sh> nbi_adm -cmd restart ALARMSTREAM

nbi_adm -cmd restart ALARMSTREAM: restarts the IRPService service.

----End

2.3.2 Modifying Relevant Configuration Files of the AlarmStreaming Interface

This section describes how to modify the relevant configuration files of the alarm streaming

interface according to the negotiated parameters.

For details, see 2.3.2.1 Modifying the Configuration File of the Alarm Streaming

Interface and 2.3.2.2 (Optional) Modifying the Connection Configuration File of the

Alarm Streaming Interface.

2.3.2.1 Modifying the Configuration File of the Alarm Streaming Interface

This section describes the procedure for modifying the configuration file of the alarm

streaming interface.

Prerequisites

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

Context

Before interconnecting the NMS with the U2000, you can set the parameters of the

configuration file, such as the basic parameters of the northbound alarm streaming interface

and the alarm enumeration attribute values. For messages in the NameValue format, you can

set the start and end of the alarm information in an alarm message, such as alarm information

fields, and the name of each field. For details of the configuration file, see 3.1.1

Configuration File of the Alarm Streaming Interface.

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 folder.

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

By default, run the following command:

U2000



Streaming Interface



12


21/79

$ cd /opt/oss/server

Step 2 Stop the IRPService service.

$ . ./svc_profile.sh

$ svc_adm -cmd stopsvc IRPService

The IRPService service has stopped successfully if the following prompt is displayed:

IRPService [stopped ]

Step 3 Edit the configuration file.

$ vi /opt/oss/server /etc/IRPService/locale/en_US/FMNotifyParams.xml

l Configure the basic parameters of the northbound alarm streaming interface.

For details, see the basic configuration part of 3.1.1 Configuration File of the Alarm

Streaming Interface.

l Configure the start of the alarm message in the NAMEVALUE format.

For details, see the NAMEVALUE format configuration part of 3.1.1 Configuration

File of the Alarm Streaming Interface.

l Configure alarm enumeration attributes.

For details, see the enumeration attributes configuration part of 3.1.1 Configuration File

of the Alarm Streaming Interface

Step 4 Restart the IRPService service.

$ . ./svc_profile.sh

$ svc_adm -cmd startsvc IRPService

The IRPService service has restarted successfully if the following prompt is displayed:

IRPService [running ]

----End

2.3.2.2 (Optional) Modifying the Connection Configuration File of the AlarmStreaming Interface

This section describes how to modify the connection configuration file SSLOption.xml to

change the connection mode from the default SSL connection to non-SSL connection.

Prerequisites

You have logged in to the U2000 (active or master) server as user ossuser.

Context

After you modify SSLOption.xml, restart the IRPService service for the modifications to

take effect.


l

In an HA or remote HA system, you need to perform the following steps only on theactive server.

U2000



Streaming Interface



13


22/79




ProcedureStep 1 Go to the installation folder.




Step 2 Edit the configuration file.

$ vi /opt/oss/server/etc/IRPService/FMNotify/SSLOption.xml

Step 3 Modify the configuration item enableSSL to false.

For detailed configuration description, see Connection Configuration File of the Alarm


Step 4 Save the modifications and exit the vi editor.

Step 5 Restart the IRPService service.

$ . /opt/oss/server/svc_profile.sh

$ svc_adm -cmd restartsvc IRPService

When the system displays the following information:IRPService [running ]

The IRPService service has restarted.

----End

2.3.3 (Optional) Setting Alarm Filtering Rules

You can set alarm filtering rules to control the number and types of reported alarms. This

helps prevent the NMS from being overloaded and locate alarms you are concerned about.

2.3.3.1 Setting Filtering Rules for the U2000 to Report Alarms to the Northbound

Interface

If the base stations of a multimode base station report common alarms simultaneously to the

U2000, the repeatedly reported alarms that are then forwarded from the U2000 to the NMS

may affect NMS services. The U2000 northbound interface provides policies for U2000 users

to determine whether to forward common alarms that are reported by different BSs to the

NMS.

Context

The base stations of an MBTS share some common resources such as power module and FAN

unit. When faults occur on common resources, the BSs report alarms to the U2000simultaneously.

U2000



Streaming Interface



14


23/79

Users can modify the configuration items to determine whether to forward the corresponding

common alarms by running the SettingTool command. For details about how to set policies

for forwarding common alarms, see Table 2-2.

Table 2-2 Setting policies for forwarding common alarms

Common Alarm Types Path in the SettingToolCommand

Default Value

MBTS GSM common alarms/imap/ifms/MBTS_Filter/

OLD-GSMyes

MBTS UMTS common alarms/imap/ifms/MBTS_Filter/

OLD-UMTSyes

MBTS LTE common alarms/imap/ifms/MBTS_Filter/

OLD-LTEyes

MBTS LTE_FDD common

alarms

/imap/ifms/MBTS_Filter/

LTE_FDDyes

MBTS SRAN common alarms/imap/ifms/MBTS_Filter/

SRANyes

MBTS LTE_TDD common

alarms


LTE_TDDyes

MBTS GU-GSM common

alarms


GU_GSMyes

MBTS GU-UMTS common

alarms


GU_UMTS yes

MBTS GU-SRAN common

alarms


GU_SRANyes

MBTS GL-GSM common

alarms


GL_GSMyes

MBTS GL-LTE common alarms/imap/ifms/MBTS_Filter/

GL_LTEyes

MBTS GL-LTE_FDD common

alarms


GL_FDDyes

MBTS GL-SRAN common

alarms


GL_SRANyes

MBTS UL-UMTS common

alarms


UL_UMTSyes

MBTS UL-LTE common alarms/imap/ifms/MBTS_Filter/

UL_LTEyes

MBTS UL-LTE_FDD common

alarms


UL_FDDyes

U2000



Streaming Interface



15


24/79


Default Value

MBTS UL-SRAN common

alarms


UL_SRANyes

MBTS GUL-GSM common

alarms


GUL_GSMyes

MBTS GUL-UMTS common

alarms


GUL_UMTSyes

MBTS GUL-LTE common

alarms


GUL_LTEyes

MBTS GUL-LTE_FDD

common alarms


GUL_FDDyes

MBTS GUL-SRAN commonalarms

/imap/ifms/MBTS_Filter/GUL_SRAN

yes

MBTS GUL-GU common

alarms


GUL_GUyes

MBTS GUL-GL common

alarms


GUL_GLyes

MBTS GUL-G-LTE_FDD

common alarms


GUL_G_FDDyes

MBTS GUL-UL common

alarms


GUL_UL yes

MBTS GUL-U-LTE_FDD

common alarms


GUL_U_FDDyes

MBTS (G-LTE_TDD)-GSM

common alarms


GT_GSMyes

MBTS (G-LTE_TDD)-LTE

common alarms


GT_LTEyes

MBTS (G-LTE_TDD)-SRAN

common alarms


GT_SRANyes

MBTS (G-LTE_TDD)-

LTE_TDD common alarms


GT_TDDyes

MBTS (U-LTE_TDD)-UMTS

common alarms


UT_UMTSyes

MBTS (U-LTE_TDD)-LTE

common alarms


UT_LTEyes

MBTS (U-LTE_TDD)-SRAN

common alarms


UT_SRANyes

U2000



Streaming Interface



16


25/79


Default Value

MBTS (U-LTE_TDD)-



UT_TDDyes

MBTS (G-U-LTE_TDD)-GSM

common alarms


GUT_GSMyes

MBTS (G-U-LTE_TDD)-

UMTS common alarms


GUT_UMTSyes

MBTS (G-U-LTE_TDD)-LTE

common alarms


GUT_LTEyes

MBTS (G-U-LTE_TDD)-SRAN

common alarms


GUT_SRANyes

MBTS (G-U-LTE_TDD)-LTE_TDD common alarms

/imap/ifms/MBTS_Filter/GUT_TDD

yes

MBTS (G-U-LTE_TDD)-GU

common alarms


GUT_GUyes

MBTS (G-U-LTE_TDD)-GL

common alarms


GUT_GLyes

MBTS (G-U-LTE_TDD)-UL

common alarms


GUT_ULyes

MBTS (G-U-LTE_TDD)-G-



GUT_G_TDD yes

MBTS (G-U-LTE_TDD)-U-



GUT_U_TDDyes

MBTS (G-L-LTE_TDD)-GSM

common alarms


GLT_GSMyes

MBTS (G-L-LTE_TDD)-LTE

common alarms


GLT_LTEyes

MBTS (G-L-LTE_TDD)-

LTE_FDD common alarms


GLT_FDDyes

MBTS (G-L-LTE_TDD)-SRAN

common alarms


GLT_SRANyes

MBTS (G-L-LTE_TDD)-



GLT_TDDyes

MBTS (G-L-LTE_TDD)-GL

common alarms


GLT_GLyes

MBTS (G-L-LTE_TDD)-G-



GLT_G_FDDyes

U2000



Streaming Interface



17


26/79


Default Value

MBTS (G-L-LTE_TDD)-G-



GLT_G_TDDyes

MBTS (U-L-LTE_TDD)-UMTS

common alarms


ULT_UMTSyes

MBTS (U-L-LTE_TDD)-LTE

common alarms


ULT_LTEyes

MBTS (U-L-LTE_TDD)-



ULT_FDDyes

MBTS (U-L-LTE_TDD)-SRAN

common alarms


ULT_SRANyes

MBTS (U-L-LTE_TDD)-LTE_TDD common alarms

/imap/ifms/MBTS_Filter/ULT_TDD

yes

MBTS (U-L-LTE_TDD)-UL

common alarms


ULT_ULyes

MBTS (U-L-LTE_TDD)-U-



ULT_U_FDDyes

MBTS (U-L-LTE_TDD)-U-



ULT_U_TDDyes

MBTS (G-U-L-LTE_TDD)-

GSM common alarms


GULT_GSM yes


UMTS common alarms


GULT_UMTSyes

MBTS (G-U-L-LTE_TDD)-LTE

common alarms


GULT_LTEyes




GULT_FDDyes


SRAN common alarms


GULT_SRANyes




GULT_TDDyes

MBTS (G-U-L-LTE_TDD)-GU

common alarms


GULT_GUyes

MBTS (G-U-L-LTE_TDD)-GL

common alarms


GULT_GLyes

MBTS (G-U-L-LTE_TDD)-G-



GULT_G_FDDyes

U2000



Streaming Interface



18


27/79


Default Value

MBTS (G-U-L-LTE_TDD)-UL

common alarms


GULT_ULyes

MBTS (G-U-L-LTE_TDD)-U-



GULT_U_FDDyes




GULT_G_TDDyes

MBTS (G-U-L-LTE_TDD)-U-



GULT_U_TDDyes


GUL common alarms


GULT_GULyes

MBTS (G-U-L-LTE_TDD)-G-U-LTE_FDD common alarms

/imap/ifms/MBTS_Filter/GULT_G_U_FDD

yes


U-LTE_TDD common alarms


GULT_G_U_TDDyes

MBTS (L-LTE_TDD)-LTE

common alarms


LT_LTEyes

MBTS (L-LTE_TDD)-



LT_FDDyes

MBTS (L-LTE_TDD)-SRAN

common alarms


LT_SRAN yes

MBTS (L-LTE_TDD)-



LT_TDDyes

MBTS WL-LTE common

alarms


WL_LTEyes

MBTS WL-WiMax common

alarms


WL_WiMaxyes

MBTS CL-LTE common alarms/imap/ifms/MBTS_Filter/

CL_LTEyes

MBTS TL-TDL common alarms/imap/ifms/MBTS_Filter/

TL_TDLno

MBTS TL-TDS common alarms/imap/ifms/MBTS_Filter/

TL_TDSyes

MBTS (U-M)-UMTS/imap/ifms/MBTS_Filter/

UM_UMTSyes

MBTS (U-M)-NBM2M

common alarms


UM_NBM2Myes

U2000



Streaming Interface



19


28/79


Default Value

MBTS U-M)-SRAN common

alarms


UM_SRANyes

MBTS (G-M)-GSM common

alarms


GM_GSMyes

MBTS (G-M)-NBM2M

common alarms


GM_NBM2Myes

MBTS (G-M)-SRAN common

alarms


GM_SRANyes

MBTS (G-U-M)-GSM common

alarms


GUM_GSMyes

MBTS (G-U-M)-UMTScommon alarms

/imap/ifms/MBTS_Filter/GUM_UMTS

yes

MBTS (G-U-M)-NBM2M

common alarms


GUM_NBM2Myes

MBTS (G-U-M)-GU common

alarms


GUM_GUyes

MBTS (G-U-M)-GM common

alarms


GUM_GMyes

MBTS (G-U-M)-UM common

alarms


GUM_UM yes

MBTS (G-L-M)-LTE common

alarms


GLM_LTEyes

MBTS (G-L-M)-LTE_FDD

common alarms


GLM_FDDyes

MBTS (G-L-M)-NBM2M

common alarms


GLM_NBM2Myes

MBTS (G-L-M)-GL common

alarms


GLM_GLyes

MBTS (G-L-M)-G-LTE_FDD

common alarms


GLM_G_FDDyes

MBTS (G-L-M)-GM common

alarms


GLM_GMyes

MBTS (G-L-M)-LM common

alarms


GLM_LMyes

MBTS (G-L-M)-LTE_FDD-M

common alarms


GLM_FDD_Myes

U2000



Streaming Interface



20


29/79


Default Value

MBTS (G-L-M)-SRAN

common alarms


GLM_SRANyes

MBTS (G-U-L-M)-GSM

common alarms


GULM_GSMyes

MBTS (G-U-L-M)-UMTS

common alarms


GULM_UMTSyes

MBTS (G-U-L-M)-LTE

common alarms


GULM_LTEyes

MBTS (G-U-L-M)-LTE_FDD

common alarms


GULM_FDDyes

MBTS (G-U-L-M)-NBM2Mcommon alarms

/imap/ifms/MBTS_Filter/GULM_NBM2M

yes

MBTS (G-U-L-M)-GU common

alarms


GULM_GUyes

MBTS (G-U-L-M)-GL common

alarms


GULM_GLyes

MBTS (G-U-L-M)-G-



GULM_G_FDDyes

MBTS (G-U-L-M)-GM

common alarms


GULM_GM yes

MBTS (G-U-L-M)-UL common

alarms


GULM_ULyes

MBTS (G-U-L-M)-U-



GULM_U_FDDyes

MBTS (G-U-L-M)-UM

common alarms


GULM_UMyes

MBTS (G-U-L-M)-LM

common alarms


GULM_LMyes

MBTS (G-U-L-M)-LTE_FDD-

M common alarms


GULM_FDD_Myes

MBTS (G-U-L-M)-GUL

common alarms


GULM_GULyes

MBTS (G-U-L-M)-G-U-



GULM_G_U_FDDyes

MBTS (G-U-L-M)-GUM

common alarms


GULM_GUMyes

U2000



Streaming Interface



21


30/79


Default Value

MBTS (G-U-L-M)-GLM

common alarms


GULM_GLMyes

MBTS (G-U-L-M)-G-

LTE_FDD-M common alarms


GULM_G_FDD_Myes

MBTS (G-U-L-M)-ULM

common alarms


GULM_ULMyes

MBTS (G-U-L-M)-U-

LTE_FDD-M common alarms


GULM_U_FDD_Myes

MBTS (G-U-L-M)-SRAN

common alarms


GULM_SRANyes

Following is an example of running the SettingTool command to forward MBTS (GU)-GSM

common alarms.

Procedure

Step 1 Run the following command to forward MBTS (GU)-GSM common alarms:

-bash-3.00$ . /opt/oss/server/svc_profile.sh

-bash-3.00$ SettingTool -cmd setparam -path /imap/ifms/MBTS_Filter/GU_GSM -

value yes

-bash-3.00$ svc_adm -cmd reload

NOTE

Users can run the following command for not forwarding MBTS (GU)-GSM common alarms:

-bash-3.00$ SettingTool -cmd setparam -path /imap/ifms/MBTS_Filter/GU_GSM -value no

-bash-3.00$ svc_adm -cmd reload

Step 2 Run the following command to check whether the configuration items have been modifiedsuccessfully:

-bash-3.00$ SettingTool -cmd getparam -path /imap/ifms/MBTS_Filter/GU_GSM

Step 3 Run the following command to restart the fault service for the modification to take effect:

-bash-3.00$ svc_adm -cmd restartsvc FaultService

----End

2.3.3.2 Setting Filtering Rules for the U2000 to Report Alarms to the NorthboundInterface

On the live network, the NMS receives a large number of alarms or events. This causes

overload on the NMS, resulting in network congestion and breakdown. In addition, userscannot quickly locate their concerned alarms or events. After an alarm or event northbound

U2000



Streaming Interface



22


31/79

filtering rule is set, the U2000 reports (or not reports) only alarms or events that match the

rule to the NMS. The reported alarms or events are more accurate and users can focus on

concerned alarms or events.

l If you do not set the northbound filtering rules, all alarms or events are reported by

default.

l Alarm or event northbound filtering rules apply only to alarms or events that are

generated af ter the rules are set. Alarm or event northbound filtering rules take effect for

multiple NMSs.

l If you select reporting alarms that meet the rule to the northbound interface, the alarms,

corresponding acknowledged alarms, unacknowledged alarms, and clear alarms that

meet the northbound filtering rule are reported to the northbound interface (although the

rule is deleted, modified, or not used). If you select do not reporting alarms that meet the

rule to the northbound interface, the alarms, corresponding acknowledged alarms,

unacknowledged alarms, and clear alarms that meet the northbound filtering rule are not

reported to the northbound interface (although the rule is deleted, modified, or not used).

l For the alarms filtered by the northbound filtering rules, alarm synchronization is notreported the upper-layer OSS.

l Only users in the Administrators group can import alarm or event northbound filtering

rules in batches.

l The OSS supports creation of only one alarm northbound filtering rule and one event

northbound filtering rule.

You can set an alarm/event northbound filtering rule on the U2000 client. For detailed

operations, see Setting an Alarm or Event Northbound Filtering Rule in the U2000 Online

Help.

2.3.3.3 Setting Filtering Rules for the Northbound Interface to Report Alarms tothe NMS

This section describes the procedure for modifying the configuration file FMNotifyFilter.xml

when you control the filtering on alarm forwarding.

Prerequisites

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

Context

After you modify FMNotifyFilter.xml, do not restart the IRPService service. Once theinterval set in refreshFltTimer has passed, the system automatically updates

FMNotifyFilter.xml.



active server.




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.

U2000



Streaming Interface



23


32/79

Procedure

Step 1 Go to the installation folder.




Step 2 Edit FMNotifyFilter.xml.

$ vi /opt/oss/server /etc/IRPService/FMNotify/FMNotifyFilter.xml

Step 3 Edit Filterflag.

l If Filterflag is Y or y, the alarms that meet the specified filter conditions are not

forwarded.

l If Filterflag is not Y, the alarms that meet the specified filter conditions are forwarded.

Step 4 Modify or add the filtering conditions.

For details, see filter condition settings in 3.1.2 Configuration File of the Alarm Streaming

Filter.

Step 5 Save the modification and exit the server.

----End

2.3.4 Simulating the Interconnection with the NMS inUnencrypted Connection Mode (Alarm Streaming Interface)

This section describes how to simulate the interconnection between the U2000 and the NMS

using Telnet and how to obtain alarm messages.

Prerequisites

l The configuration files /opt/oss/server /etc/IRPService/locale/en_US/

FMNotifyParams.xml and /opt/oss/server /etc/IRPService/FMNotify/

FMNotifyFilter.xml have been modified.

l The NMS has been licensed to use the alarm streaming interface.

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


active server.




Procedure

Step 1 The NMS remotely logs in to the specified port of the U2000 server to simulate theinterconnection with the U2000.

U2000



Streaming Interface



24


33/79

For example, on the PC, choose Start > Run and then enter telnet floating IP address of the

server 8765.

Step 2 Enter key identity and key.

On the page displayed after choosing NBI Management > Centralized Management >Northbound Configuration Parameters Settings on the OSMU, set Northbound Interface

Name to Northbound Alarm Streaming Interface and Configuration file name to

FMNotifyParams.xml-part2 and set key identity and key.

----End

Result

If the system runs properly, a handshake message is returned as follows:

HandShake = 2008-12-17 09:36:40

If no handshake message is received, see 4 Troubleshooting the Northbound Alarm


2.3.5 Simulating the Interconnection with the NMS in SSLConnection Mode (Alarm Streaming Interface)

This section describes how to simulate the interconnection between the U2000 and the NMS

using the openssl and how to obtain alarm messages.

Prerequisitesl The configuration files /opt/oss/server/etc/IRPService/locale/en_US/

FMNotifyParams.xml, /opt/oss/server/etc/IRPService/FMNotify/

FMNotifyFilter.xml, and /opt/oss/server/etc/IRPService/FMNotify/SSLOption.xml

have been modified.

l The NMS has been licensed to use the alarm streaming interface.

l When enableAuthPeer is set to true in SSLOption.xml, you have obtained the

certificates from the NMS, including the trust certificate, device certificate on the client,

and the private key of the device certificate on the client.

Context



active server.




Procedure

Step 1 The NMS remotely logs in to the specified port of the U2000 server to simulate theinterconnection with the U2000.

U2000



Streaming Interface



25


34/79

For example, run the following commands on the PC where the openssl is installed to

simulate the client:

l When enableAuthPeer is set to true, run the following commands:

openssl s_client -CAfile CA trust certificate -cert device certificate on the client -key

private key of the device certificate on the client -port 8765 -host floating IP address

of the server -tls1 -quiet -crlf

l When enableAuthPeer is set to false, run the following commands:

openssl s_client -port 8765 -host floating IP address of the server -tls1 -quiet -crlf

NOTE

The openssl parameter -tlsl corresponds to the TLSv1 version. During the interconnection, use the

openssl parameter based on the version value set in SSLOption.xml. The SSLv3 protocol corresponds

to the -ssl3 parameter. The TLSv1 protocol corresponds to the -tls1 parameter. The TLSv1.1 protocol

corresponds to the -tls1_1 parameter. The TLSv1.2 protocol corresponds to the -tls1_2 parameter.

If the TLSv1.1 or TLSv1.2 protocol is used, the OpenSSL tool later than the 1.0.1p version must be

used.The SSLv3 protocol has security risk s. If you do not need to use it, close it according to the Disabling

the SSLv3 Protocol Used on the U2000 of U2000 Administrator Guide.

If you need to use a third-party certificate for the interconnection with the NMS, replace the existing

certificate with a third-party certificate by following the instructions provided in "Deploying Certificates

on the U2000Server" in U2000Product Documentation. You must stop all U2000 services before the

replacement. After the replacement, start all U2000 services again.

----End

Result

If the system runs properly, a handshake message is returned as follows:

HandShake = 2008-12-17 09:36:40

If no handshake message is received, see 4 Troubleshooting the Northbound Alarm


2.4 Checking Alarm Messages

This section describes how to check whether the obtained alarm messages meet the negotiated

requirements. Based on the check results, you can determine whether the northbound alarm

streaming interface meets the interconnection conditions.

Check whether the content and format of the reported alarm messages meet the negotiated

requirements based on Alarm Streaming Message in NAMEVALUE Format. If they do,

the northbound alarm streaming interface meets the interconnection conditions. You can then

perform the interconnection.

After the check is complete, exit the connection.

l Unencrypted connection mode

press Ctrl+] and run the following command to exit the Telnet connection:

$ quit

l SSL connection mode

Press Ctrl+c to stop and exit openssl connection.

U2000



Streaming Interface



26


35/79

3 Configuration File and Messages for theAlarm Streaming Interface

About This Chapter

The configuration file for the alarm streaming interface allows you to set different parameters

to control alarm streaming messages.

3.1 Configuration Files Related to the Alarm Streaming Interface

Configuration files related to the alarm streaming interface include the interface configuration

file, filter criteria configuration file, and connection option configuration file for the alarm


3.2 Alarm Str eaming Message in NAMEVALUE Format

This chapter describes the alarm streaming message in NAMEVALUE format. It covers the

format descri ption of the alarm streaming message, introduction to the alarm handshake

message, and introduction to the alarm data message.

U2000


3 Configuration File and Messages for the Alarm Streaming

Interface



27


36/79

3.1 Configuration Files Related to the Alarm Streaming Interface

Configuration files related to the alarm streaming interface include the interface configuration

file, filter criteria configuration file, and connection option configuration file for the alarm


3.1.1 Configuration File of the Alarm Streaming Interface

The U2000 provides a configuration file for the alarm streaming interface to meet the

requirements of different alarm streaming messages.

Overview

The configuration file of the alarm streaming interface is named /opt/oss/server/etc/

IRPService/locale/en_US/FMNotifyParams.xml. It consists of the following parts:

l Basic configuration part: refers to the parameters included in the part. These parameters are the basic parameters related to the

operation of the north bound alarm streaming interface.

l NameValue format configuration part: refers to the parameters included in the

part. These parameters define the

beginning and end of the alarm information in the alarm messages that are in NameValue

format, the alarm information fields, and the names of these fields.

lEnumeration attributes configuration part: refers to the parameters included in the part. These parameters define enumeration

attributes such as the alarm type, severity, category, and status. These parameters apply

to all messages regardless of the message format.

Basic Configuration Part

The basic configuration part in the alarm streaming interface configuration file refers to the

parameters related to the operation of the northbound alarm streaming interface. For details,

see Table 3-1.

Table 3-1 Basic configuration part of the alarm streaming interface configuration file

Parameter Description Reference

refreshFltTimer Refers to the refresh

time for forwarding

filter criteria.

The refresh time is represented in

seconds and ranges from 60s to

3600s. If the refresh time is set to a

value that is less than 60s, the system

changes it to 60s. If the refresh time

is set to a value that is greater than

3600s, the system changes it to

3600s.

The refresh time is an integer. The

default refresh time is 60.

U2000



Interface



28


37/79


Port Refers to the alarm

streaming port. The

NMS receives alarm

messages through this

port.


isDELConfirmAlarm Determines whether to

delete the

acknowledged alarms

before those alarms are

forwarded.

The value y indicates that the

acknowledged alarms will be deleted

and therefore will not be forwarded.

The value n indicates that the

acknowledged alarms will not be

deleted and therefore will be

forwarded.

isDELUnConfirmA-

larm

Determines whether to

delete theunacknowledged alarms

before those alarms are

forwarded.

The value y indicates that the

unacknowledged alarms will bedeleted and therefore will not be

forwarded. The value n indicates that

the unacknowledged alarms will not

be deleted and therefore will be

forwarded.

AlarmFormat Refers to the format of

an alarm streaming

message.

Set the value to NAMEVALUE.

MAXConnectCount Refers to the number of

network managementsystems (NMSs) that

can be connected to the

northbound alarm

streaming interface at

the same time.

The default maximum number of

connected NMSs is 2.This parameter is configurable. You

are advised to set this parameter to a

value less than 5. If the parameter is

set to a value greater than 5, the

performance of the U2000 in sending

alarms deteriorates.

isSync Determines whether to

forward historical

alarms when an NMS is

connected.

If savetime is set to 0, the system

takes N as the value of this parameter.

Y indicates that the historical alarms

will be forwarded, and N indicates

that the historical alarms will not beforwarded.

To enable isSync to take effect, you

must set isSyncActive to N.

isSyncActive Determines whether to

forward active alarms

when an NMS is

connected.

The default value is N.

Y indicates that the active alarms will

be forwarded, and N indicates that the

active alarms will not be forwarded.

To enable isSyncActive to take

effect, you must set isSync to N.

U2000



Interface



29


38/79


savetime Refers to the number of

hours within which

historical alarms are

saved.

After the U2000 is

reconnected to the

NMS, the U2000

forwards all alarms that

are sent within the

specified save time to

avoid data loss.


This parameter is configurable. You

are advised to set this parameter to avalue less than 5. If this parameter is

set to a value greater to 5, a large

number of historical alarms will be

reported when the U2000 is

reconnected to the NMS. This will

increase the impact on the NMS.

HandShakePeriod Refers to the period for

sending the handshake

message.

The interval during which a

handshake message can be sent. The

interval is represented in seconds.The default value is 60. If the

parameter is set to a value that is less

than 30, the system sends a

handshake message every 30 seconds.

AlarmForWordFilePath Refers to the path for

saving historical alarm

files.

The default path is

$IMAP_ROOT/var/fmnotify/

AlarmLog.

ParaList Determines whether the

NE type IDs that

correspond to ObjFdnand ObjName in an

alarm message will be

displayed.

The value of this parameter is pre-

defined by the system and must not

be changed.

TimeFormat Refers to the time

format in the alarm

message.

The default value is 0, and the time

format is YYYY-MM-DD hh:mm:ss.

When the value is 1, time using

daylight saving time (DST) will

contain "DST", and the time format is

YYYY-MM-DD hh:mm:ss DST.

auth Refers to the

authentication-related

parameter group.

To ensure data security, set the

authentication-related parameter

group on the OSMU. For details, see

4.4 How to Set Parameters in a

Northbound Configuration File.

enable Determines whether to

authenticate the NMS

that is connected.

y indicates that authentication is

required. n indicates that

authentication is not required.

By default, the parameter value is y.

You are advised not to set the

parameter to n because doing so will

cause security risks.

U2000



Interface



30


39/79


logintimes Refers to the number of

times for password

checks to be performed

when the NMS is

connected.

This parameter is valid only when

enable is set to y. The default value is

3. If this parameter is set to 0, the

number of parameter check times is

not limited.

NOTICE

To enhance system security, you are

advised not to set this parameter to 0.

accounts Refers to the number of

users that use the

northbound alarm


This parameter is valid only when

enable is set to y. The default value is

1.

A maximum of 5 users can be

created.

account Refers to the name and password of the user

that uses the northbound

alarm streaming

interface.

This parameter is valid only whenenable is set to y. You need to set the

user account and password on the

OSMU. For details, see 4.4 How to

Set Parameters in a Northbound

Configuration File.

NOTE

By default, authentication is required.

The password must meet the

requirements of the operating system. For

details about the password policies of the

operating system, see the DVD-ROM

delivered with the operating system.

If the password is incorrectly entered for

three consecutive times, the account will

be locked for 30 minutes.

NameValue Format Configuration Part

Lines in NameValue alarm messages are in the following format: field name on the left and

field value on the right, which is Name field = Name value. The NameValue format

configuration part in the configuration file defines the beginning and end of the alarm

information in an alarm message that is in the NameValue format. It also provides alarm

information fields and the names of each field.

For details about the configuration items in the NameValue format configuration part of the

configuration file and the meaning of each information field in an alarm message, see Table

3-2.

U2000



Interface



31


40/79

Table 3-2 NameValue format configuration part of the configuration file


name Refers to the

name of a fieldin the message.

This is a common configuration item. You can

retain the default value or set a new value asrequired.

The Head and Tail fields define the beginning and

end of an alarm information record. The default

values are +++ and ---, respectively.

enable Determines

whether the

corresponding

field

information

needs to be

contained in themessage.

This is a common configuration item. You need to

set the value as required.

y indicates that the corresponding field will be

contained. n indicates that the corresponding field

will not be contained.

The Head, Tail, and HandShake fields arecontained in the alarm message regardless of

whether this field is set to y or n.

Head Identifies the

beginning of

each alarm

record in the

alarm message.

By default, this field is set to +++.

This field is contained in the message regardless

of whether the enable field is set to y or n.

Tail Identifies the

end of each

alarm record in

the alarmmessage.

By default, this field is set to ---.



HandShake Refers to the

alarm

handshake field.

The default name is HandShake.



Sn Refers to the

serial number

(SN) of an NE

where alarms

are generated.

NEs allocate a unique integer SN to each alarm.

For a specified NE, the device flow number is

unique. Different NEs may have the same device

flow number.

NeSn Refers to the SN

of an alarm on

the entire

network.

The U2000 allocates a unique integer SN to each

alarm.

ObjFdn Refers to the

identifier of an

object.

Each object has a unique identifier.

ObjName Refers to the

name of an

object.

The default value is Object Name. By default, the

ObjName field is included in all alarm messages.

U2000



Interface



32


41/79


ObjType Refers to the

type of an

object.

The default value is Object Type. By default, the

ObjType field is included in all alarm messages.

NeFdn Refers to the

identifier of an

NE.

Each NE has a unique identifier.

NeName Refers to the

name of an NE.

Each NE has a unique name.

NeType Refers to the

type of an NE.

Each NE is of a certain type.

AlarmID Refers to the ID

of an alarm.

Each NE alarm has a unique ID. In a product, the

alarm ID identifies the category of an alarm, such

as fault or event. The alarm ID indicates

information such as the fault alarm name, fault

handling suggestions, alarm causes, and fault

location parameters.

AlarmName Refers to the

name of an

alarm.

Each alarm has a unique name. The alarm name

corresponds to the alarm ID.

CategoryID Refers to the ID

of an alarm

category.

Alarm category. By default, 1 refers to a fault

alarm, and 3 refers to an event alarm. Cleared

alarms are reported as fault alarms.

You can modify the definition of alarm category

IDs by modifying the enumeration attribute part of

the configuration file. For details, see

Enumeration Attribute Configuration Part.

Category Refers to an

alarm category.

Describes alarm categories. By default, Fault

refers to a fault alarm, and Event refers to an

event alarm. Cleared alarms are reported as fault

alarms.

You can modify the name definition of alarm

categories by modifying the enumeration attribute

part of the configuration file. For details, seeEnumeration Attribute Configuration Part.

U2000



Interface



33


42/79

Parameter D

u2000 northbound alarm streaming interface developer guide

Documents