U2000 Northbound Alarm Streaming Interface Developer Guide

U2000
V200R016C10
Northbound Alarm Streaming

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:
support@huawei.com
Issue 02 (2016-03-20)
Huawei Proprietary and Confidential

Copyright Huawei Technologies Co., Ltd.
U2000
Northbound Alarm Streaming Interface Developer Guide
About This Document
About This Document
Scope
This document provides information about the U2000 northbound alarm streaming 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
U2000
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-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.
Organization
1 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 configuration 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.
Issue 02 (2016-03-20)

iii
U2000
Symbol
About This Document
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.
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.
iv
U2000
About This Document
Convention
Description
{ 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.
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.
U2000
Contents
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................................................................................................... 2
1.3 Alarm Report 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......................................................11
2.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
Issue 02 (2016-03-20)

vi
U2000
Contents
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
Issue 02 (2016-03-20)

vii
U2000
Introduction to Northbound Alarm

Streaming 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.
Issue 02 (2016-03-20)

U2000
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.
Issue 02 (2016-03-20)

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

Streaming 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
Issue 02 (2016-03-20)
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 Streaming
Interface.
U2000
Function
Description
Implementation
Reporting active alarms

U2000 reports active alarms
to the NMS. After all active
alarms are reported, the
U2000 reports real-time
alarms to the NMS.
isSync to N and
isSyncActive to Y.
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.
Reporting real-time alarms

U2000 reports its own realtime alarms and those of
NEs to the NMS in real
time.

Alarm Streaming
Interface.
isSync to N and
isSyncActive to N.
Alarm Streaming
Interface.
Issue 02 (2016-03-20)

U2000
Function
Description
Implementation
Synchronizing active alarms

NMS issues commands for
synchronizing active alarms
to the U2000. Then, the
U2000 synchronizes and
reports active alarms to the
NMS.
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.
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.
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 = OSS
NeType = OSS
AlarmID = 407
AlarmName = Pm Result
Lost
Category = Event
Severity = Critical
State = Unacknowledged
Event
EventType = OMC
Occurtime = 2009-06-02
16:50:00
Location =
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
<--->
Issue 02 (2016-03-20)

U2000
Function
Description
Implementation
NOTE
If a northbound interface
compatibility ID has been set,
the U2000 will adjust the EMS
ID 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 affects
real-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

interface of the active U2000 server.
Remote HA system
SUN SLS system
ATAE cluster system (Distributed
networking)
Issue 02 (2016-03-20)
ATAE cluster online remote HA

system

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
1.6 Technical Specifications of Northbound Alarm

Streaming Interface
This section describes the technical specifications related to the northbound alarm streaming
interface.
Issue 02 (2016-03-20)
Specification Item
Value
Maximum number of connections on the alarm streaming

interface
Maximum delay in reporting a northbound alarm (unit:

second)
15

U2000
2 Interconnection Commissioning of the Northbound Alarm

Streaming Interface
Interconnection Commissioning of the
Northbound 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.
Issue 02 (2016-03-20)

U2000

Streaming Interface
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 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.
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.
/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
Issue 02 (2016-03-20)
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
Parameter Type
Parameters to be
negotiated

Streaming Interface
Parameter
Parameter Value
Description
Heartbeat period
Change the
parameter value as
required.
The default value is 60

(seconds).
Recollection
policy
l Do not
synchronize
alarms after a
reconnection
By default, the system

forwards all the alarms
that occur within five
hours after a
reconnection.
l Synchronize all
the active alarms
after a
reconnection.
l Synchronize all
the alarms that
occur within a
specified period
of time after a
reconnection.
Alarm message
format
Change the
parameter value as
required.
Determine whether the

negotiated default
message format meets the
requirement of the NMS
If the negotiated default
message format fails to
meet the requirement of
the NMS, modify the
format as required.
Filter conditions
Change the
parameter values as
required.
Determine the types of

alarms that need to be
filtered. For example, you
can configure this
parameter to filter event
alarms and alarms with a
specified AlarmID.
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.
Issue 02 (2016-03-20)

10
U2000

Streaming Interface
2.3.1 (Optional) Enabling the Northbound IP Address for

Connection 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.xml
and 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"?>
<NbiItfClientNorthboundConf>
<InterfaceClient name="Alarm Streaming Interface">
<param name="floatServerName">true</param>
<param name="NORTH01ServerName">true</param>
<param name="NORTH02ServerName">true</param>
</InterfaceClient>
</NbiItfClientNorthboundConf>
InterfaceClient name
Indicates the name of a northbound interface. Configure parameters below
name="Alarm Streaming Interface".
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.
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.
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 the
IP address is required, set NORTH02ServerName to true.
Issue 02 (2016-03-20)

11
U2000

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

Streaming 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
l
In an SLS system, you need to perform the following steps only on the master server.
In an HA or remote HA system, you need to perform the following steps only on the
active server.
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:
Issue 02 (2016-03-20)

12
U2000

Streaming Interface
$ 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.
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.
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_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 Alarm

Streaming 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
active server.
Issue 02 (2016-03-20)

13
U2000

Streaming Interface
Procedure
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 U2000
simultaneously.
Issue 02 (2016-03-20)

14
U2000

Streaming Interface
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
Issue 02 (2016-03-20)
Path in the SettingTool

Command
Default Value
MBTS GSM common alarms
/imap/ifms/MBTS_Filter/
OLD-GSM
yes
MBTS UMTS common alarms
OLD-UMTS
yes
MBTS LTE common alarms
OLD-LTE
yes
MBTS LTE_FDD common

alarms
LTE_FDD
yes
MBTS SRAN common alarms
SRAN
yes
MBTS LTE_TDD common

alarms
LTE_TDD
yes
MBTS GU-GSM common

alarms
GU_GSM
yes
MBTS GU-UMTS common

alarms
GU_UMTS
yes
MBTS GU-SRAN common

alarms
GU_SRAN
yes
MBTS GL-GSM common

alarms
GL_GSM
yes
MBTS GL-LTE common alarms
GL_LTE
yes
MBTS GL-LTE_FDD common

alarms
GL_FDD
yes
MBTS GL-SRAN common

alarms
GL_SRAN
yes
MBTS UL-UMTS common

alarms
UL_UMTS
yes
MBTS UL-LTE common alarms
UL_LTE
yes
MBTS UL-LTE_FDD common

alarms
UL_FDD
yes

15
U2000
Issue 02 (2016-03-20)

Streaming Interface
Common Alarm Types

Command
MBTS UL-SRAN common

alarms
UL_SRAN
yes
MBTS GUL-GSM common

alarms
GUL_GSM
yes
MBTS GUL-UMTS common

alarms
GUL_UMTS
yes
MBTS GUL-LTE common

alarms
GUL_LTE
yes
MBTS GUL-LTE_FDD
common alarms
GUL_FDD
yes
MBTS GUL-SRAN common

alarms
GUL_SRAN
yes
MBTS GUL-GU common

alarms
GUL_GU
yes
MBTS GUL-GL common

alarms
GUL_GL
yes
MBTS GUL-G-LTE_FDD
common alarms
GUL_G_FDD
yes
MBTS GUL-UL common

alarms
GUL_UL
yes
MBTS GUL-U-LTE_FDD
common alarms
GUL_U_FDD
yes
MBTS (G-LTE_TDD)-GSM
common alarms
GT_GSM
yes
MBTS (G-LTE_TDD)-LTE
common alarms
GT_LTE
yes
MBTS (G-LTE_TDD)-SRAN
common alarms
GT_SRAN
yes
MBTS (G-LTE_TDD)LTE_TDD common alarms
GT_TDD
yes
MBTS (U-LTE_TDD)-UMTS
common alarms
UT_UMTS
yes
MBTS (U-LTE_TDD)-LTE
common alarms
UT_LTE
yes
MBTS (U-LTE_TDD)-SRAN
common alarms
UT_SRAN
yes

Default Value
16
U2000
Issue 02 (2016-03-20)

Streaming Interface
Common Alarm Types

Command
MBTS (U-LTE_TDD)LTE_TDD common alarms
UT_TDD
yes
MBTS (G-U-LTE_TDD)-GSM
common alarms
GUT_GSM
yes
MBTS (G-U-LTE_TDD)UMTS common alarms
GUT_UMTS
yes
MBTS (G-U-LTE_TDD)-LTE
common alarms
GUT_LTE
yes
MBTS (G-U-LTE_TDD)-SRAN
common alarms
GUT_SRAN
yes
MBTS (G-U-LTE_TDD)LTE_TDD common alarms
GUT_TDD
yes
MBTS (G-U-LTE_TDD)-GU
common alarms
GUT_GU
yes
MBTS (G-U-LTE_TDD)-GL
common alarms
GUT_GL
yes
MBTS (G-U-LTE_TDD)-UL
common alarms
GUT_UL
yes
MBTS (G-U-LTE_TDD)-GLTE_TDD common alarms
GUT_G_TDD
yes
MBTS (G-U-LTE_TDD)-ULTE_TDD common alarms
GUT_U_TDD
yes
MBTS (G-L-LTE_TDD)-GSM
common alarms
GLT_GSM
yes
MBTS (G-L-LTE_TDD)-LTE
common alarms
GLT_LTE
yes
MBTS (G-L-LTE_TDD)LTE_FDD common alarms
GLT_FDD
yes
MBTS (G-L-LTE_TDD)-SRAN
common alarms
GLT_SRAN
yes
MBTS (G-L-LTE_TDD)LTE_TDD common alarms
GLT_TDD
yes
MBTS (G-L-LTE_TDD)-GL
common alarms
GLT_GL
yes
MBTS (G-L-LTE_TDD)-GLTE_FDD common alarms
GLT_G_FDD
yes

Default Value
17
U2000
Issue 02 (2016-03-20)

Streaming Interface
Common Alarm Types

Command
MBTS (G-L-LTE_TDD)-GLTE_TDD common alarms
GLT_G_TDD
yes
MBTS (U-L-LTE_TDD)-UMTS
common alarms
ULT_UMTS
yes
MBTS (U-L-LTE_TDD)-LTE
common alarms
ULT_LTE
yes
MBTS (U-L-LTE_TDD)LTE_FDD common alarms
ULT_FDD
yes
MBTS (U-L-LTE_TDD)-SRAN
common alarms
ULT_SRAN
yes
MBTS (U-L-LTE_TDD)LTE_TDD common alarms
ULT_TDD
yes
MBTS (U-L-LTE_TDD)-UL
common alarms
ULT_UL
yes
MBTS (U-L-LTE_TDD)-ULTE_FDD common alarms
ULT_U_FDD
yes
MBTS (U-L-LTE_TDD)-ULTE_TDD common alarms
ULT_U_TDD
yes
MBTS (G-U-L-LTE_TDD)GSM common alarms
GULT_GSM
yes
MBTS (G-U-L-LTE_TDD)UMTS common alarms
GULT_UMTS
yes
MBTS (G-U-L-LTE_TDD)-LTE
common alarms
GULT_LTE
yes
MBTS (G-U-L-LTE_TDD)LTE_FDD common alarms
GULT_FDD
yes
MBTS (G-U-L-LTE_TDD)SRAN common alarms
GULT_SRAN
yes
MBTS (G-U-L-LTE_TDD)LTE_TDD common alarms
GULT_TDD
yes
MBTS (G-U-L-LTE_TDD)-GU
common alarms
GULT_GU
yes
MBTS (G-U-L-LTE_TDD)-GL
common alarms
GULT_GL
yes
MBTS (G-U-L-LTE_TDD)-GLTE_FDD common alarms
GULT_G_FDD
yes

Default Value
18
U2000
Issue 02 (2016-03-20)

Streaming Interface
Common Alarm Types

Command
MBTS (G-U-L-LTE_TDD)-UL
common alarms
GULT_UL
yes
MBTS (G-U-L-LTE_TDD)-ULTE_FDD common alarms
GULT_U_FDD
yes
MBTS (G-U-L-LTE_TDD)-GLTE_TDD common alarms
GULT_G_TDD
yes
MBTS (G-U-L-LTE_TDD)-ULTE_TDD common alarms
GULT_U_TDD
yes
MBTS (G-U-L-LTE_TDD)GUL common alarms
GULT_GUL
yes
MBTS (G-U-L-LTE_TDD)-GU-LTE_FDD common alarms
GULT_G_U_FDD
yes
MBTS (G-U-L-LTE_TDD)-GU-LTE_TDD common alarms
GULT_G_U_TDD
yes
MBTS (L-LTE_TDD)-LTE
common alarms
LT_LTE
yes
MBTS (L-LTE_TDD)LTE_FDD common alarms
LT_FDD
yes
MBTS (L-LTE_TDD)-SRAN
common alarms
LT_SRAN
yes
MBTS (L-LTE_TDD)LTE_TDD common alarms
LT_TDD
yes
MBTS WL-LTE common

alarms
WL_LTE
yes
MBTS WL-WiMax common

alarms
WL_WiMax
yes
MBTS CL-LTE common alarms
CL_LTE
yes
MBTS TL-TDL common alarms
TL_TDL
no
MBTS TL-TDS common alarms
TL_TDS
yes
MBTS (U-M)-UMTS
UM_UMTS
yes
MBTS (U-M)-NBM2M
common alarms
UM_NBM2M
yes

Default Value
19
U2000
Issue 02 (2016-03-20)

Streaming Interface
Common Alarm Types

Command
MBTS U-M)-SRAN common

alarms
UM_SRAN
yes
MBTS (G-M)-GSM common

alarms
GM_GSM
yes
MBTS (G-M)-NBM2M
common alarms
GM_NBM2M
yes
MBTS (G-M)-SRAN common

alarms
GM_SRAN
yes
MBTS (G-U-M)-GSM common

alarms
GUM_GSM
yes
MBTS (G-U-M)-UMTS
common alarms
GUM_UMTS
yes
MBTS (G-U-M)-NBM2M
common alarms
GUM_NBM2M
yes
MBTS (G-U-M)-GU common

alarms
GUM_GU
yes
MBTS (G-U-M)-GM common

alarms
GUM_GM
yes
MBTS (G-U-M)-UM common

alarms
GUM_UM
yes
MBTS (G-L-M)-LTE common

alarms
GLM_LTE
yes
MBTS (G-L-M)-LTE_FDD
common alarms
GLM_FDD
yes
MBTS (G-L-M)-NBM2M
common alarms
GLM_NBM2M
yes
MBTS (G-L-M)-GL common

alarms
GLM_GL
yes
MBTS (G-L-M)-G-LTE_FDD
common alarms
GLM_G_FDD
yes
MBTS (G-L-M)-GM common

alarms
GLM_GM
yes
MBTS (G-L-M)-LM common

alarms
GLM_LM
yes
MBTS (G-L-M)-LTE_FDD-M
common alarms
GLM_FDD_M
yes

Default Value
20
U2000
Issue 02 (2016-03-20)

Streaming Interface
Common Alarm Types

Command
MBTS (G-L-M)-SRAN
common alarms
GLM_SRAN
yes
MBTS (G-U-L-M)-GSM
common alarms
GULM_GSM
yes
MBTS (G-U-L-M)-UMTS
common alarms
GULM_UMTS
yes
MBTS (G-U-L-M)-LTE
common alarms
GULM_LTE
yes
MBTS (G-U-L-M)-LTE_FDD
common alarms
GULM_FDD
yes
MBTS (G-U-L-M)-NBM2M
common alarms
GULM_NBM2M
yes
MBTS (G-U-L-M)-GU common

alarms
GULM_GU
yes
MBTS (G-U-L-M)-GL common

alarms
GULM_GL
yes
MBTS (G-U-L-M)-GLTE_FDD common alarms
GULM_G_FDD
yes
MBTS (G-U-L-M)-GM
common alarms
GULM_GM
yes
MBTS (G-U-L-M)-UL common

alarms
GULM_UL
yes
MBTS (G-U-L-M)-ULTE_FDD common alarms
GULM_U_FDD
yes
MBTS (G-U-L-M)-UM
common alarms
GULM_UM
yes
MBTS (G-U-L-M)-LM
common alarms
GULM_LM
yes
MBTS (G-U-L-M)-LTE_FDDM common alarms
GULM_FDD_M
yes
MBTS (G-U-L-M)-GUL
common alarms
GULM_GUL
yes
MBTS (G-U-L-M)-G-ULTE_FDD common alarms
GULM_G_U_FDD
yes
MBTS (G-U-L-M)-GUM
common alarms
GULM_GUM
yes

Default Value
21
U2000

Streaming Interface
Common Alarm Types

Command
Default Value
MBTS (G-U-L-M)-GLM
common alarms
GULM_GLM
yes
MBTS (G-U-L-M)-GLTE_FDD-M common alarms
GULM_G_FDD_M
yes
MBTS (G-U-L-M)-ULM
common alarms
GULM_ULM
yes
MBTS (G-U-L-M)-ULTE_FDD-M common alarms
GULM_U_FDD_M
yes
MBTS (G-U-L-M)-SRAN
common alarms
GULM_SRAN
yes
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 modified
successfully:
-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 Northbound
Interface
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, users
cannot quickly locate their concerned alarms or events. After an alarm or event northbound
Issue 02 (2016-03-20)

22
U2000

Streaming Interface
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.
Alarm or event northbound filtering rules apply only to alarms or events that are
generated after the rules are set. Alarm or event northbound filtering rules take effect for
multiple NMSs.
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).
For the alarms filtered by the northbound filtering rules, alarm synchronization is not
reported the upper-layer OSS.
Only users in the Administrators group can import alarm or event northbound filtering
rules in batches.
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 to
the 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 the
interval set in refreshFltTimer has passed, the system automatically updates
FMNotifyFilter.xml.
l
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.
Issue 02 (2016-03-20)

23
U2000

Streaming Interface
Procedure
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.
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 in

Unencrypted 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.
The NMS has been licensed to use the alarm streaming interface.
active server.
Context
Procedure
Step 1 The NMS remotely logs in to the specified port of the U2000 server to simulate the
interconnection with the U2000.
Issue 02 (2016-03-20)

24
U2000

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

Connection 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.
Prerequisites
l
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.
The NMS has been licensed to use the alarm streaming interface.
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.
active server.
Context
Procedure
Step 1 The NMS remotely logs in to the specified port of the U2000 server to simulate the
interconnection with the U2000.
Issue 02 (2016-03-20)

25
U2000

Streaming Interface
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
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 risks. 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
SSL connection mode

Press Ctrl+c to stop and exit openssl connection.
Issue 02 (2016-03-20)

26
U2000
3 Configuration File and Messages for the Alarm Streaming

Interface
Configuration File and Messages for the

Alarm 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 Streaming Message in NAMEVALUE Format
This chapter describes the alarm streaming message in NAMEVALUE format. It covers the
format description of the alarm streaming message, introduction to the alarm handshake
message, and introduction to the alarm data message.
Issue 02 (2016-03-20)

27
U2000

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

name="ParamSet"> part. These parameters are the basic parameters related to the
operation of the northbound alarm streaming interface.
NameValue format configuration part: refers to the parameters included in the

<sub_module name="NameValueFormat"> 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.
Enumeration attributes configuration part: refers to the parameters included in the

<sub_module name="ValueList"> 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.
Issue 02 (2016-03-20)

28
U2000

Interface
Parameter
Description
Reference
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.
isDELUnConfirmAlarm
delete the
unacknowledged alarms
before those alarms are
forwarded.
The value y indicates that the

unacknowledged alarms will be
deleted 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 management
systems (NMSs) that
can be connected to the
northbound alarm
streaming interface at
the same time.
The default maximum number of

connected NMSs is 2.
forward historical
alarms when an NMS is
connected.
If savetime is set to 0, the system

takes N as the value of this parameter.
isSync
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.
Y indicates that the historical alarms

will be forwarded, and N indicates
that the historical alarms will not be
forwarded.
To enable isSync to take effect, you
must set isSyncActive to N.
isSyncActive
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.
Issue 02 (2016-03-20)

29
U2000

Interface
Parameter
Description
Reference
savetime

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.
HandShakePeriod
Refers to the period for

sending the handshake
message.
This parameter is configurable. You

are advised to set this parameter to a
value 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.
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 ObjFdn
and ObjName in an
alarm message will be
displayed.
The value of this parameter is predefined 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
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.
Issue 02 (2016-03-20)

30
U2000

Interface
Parameter
Description
Reference
logintimes

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
account

users that use the
northbound alarm

enable is set to y. The default value is
1.
Refers to the name and

password of the user
that uses the northbound
alarm streaming
interface.

enable 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.
A maximum of 5 users can be

created.
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.
Issue 02 (2016-03-20)

31
U2000

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

Parameter
Description
Reference
name
Refers to the
name of a field
in the message.
This is a common configuration item. You can

retain the default value or set a new value as
required.
The Head and Tail fields define the beginning and
end of an alarm information record. The default
values are +++ and ---, respectively.
enable
Head
Tail
HandShake
Issue 02 (2016-03-20)
Determines
whether the
corresponding
field
information
needs to be
contained in the
message.
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 are
contained in the alarm message regardless of
whether this field is set to y or n.
Identifies the
beginning of
each alarm
record in the
alarm message.
By default, this field is set to +++.
Identifies the
end of each
alarm record in
the alarm
message.
By default, this field is set to ---.
Refers to the
alarm
handshake field.
The default name is HandShake.
This field is contained in the message regardless

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


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.

32
U2000

Interface
Parameter
Description
Reference
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, see
Issue 02 (2016-03-20)

33
U2000

Interface
Parameter
Description
Reference
SeverityID
Refers to the ID
of an alarm
severity.
Alarm severity indicates how severe an alarm is.

The severities are sorted in descending order as
follows:
l 1: critical
l 2: major
l 3: minor
l 4: warning
You can modify the ID definition of the alarm
severities by modifying the enumeration attribute
Severity
Refers to the
severity of an
alarm.
Describes alarm severities. By default, the four

alarm severities are described as follows:
l Critical
l Major
l Minor
l Warning
You can modify the name definition of the alarm
severities by modifying the enumeration attribute
Issue 02 (2016-03-20)

34
U2000

Interface
Parameter
Description
Reference
EventID
Refers to the
type ID of the
NMS of an
alarm.
Identifies the type ID of the NMS of an alarm.

Huawei provides 16 alarm NMS types. The IDs
are represented by the numerals from 1 to 16 as
follows:
l 1: Power system
l 2: Environmental system
l 3: Signaling system
l 4: Trunk system
l 5: Hardware system
l 6: Software system
l 7: Running system
l 8: Communication system
l 9: QoS
l 10: Processing error
l 11: OMC
l 12: Integrity violation
l 13: Operational violation
l 14: Physical violation
l 15: Security service or mechanism violation
l 16: Time domain violation
You can modify the ID definition of an alarm
NMS type by modifying the enumeration attribute
Issue 02 (2016-03-20)

35
U2000

Interface
Parameter
Description
Reference
EventType
Refers to the
type ID of the
NMS of an
alarm.
Identifies the type ID of an NMS alarm. Huawei

provides the following types of NMS alarms:
l Power system
l Environmental system
l Signaling system
l Trunk system
l Hardware system
l Software system
l Running system
l Communication system
l QoS
l Processing error
l OMC
l Integrity violation
l Operational violation
l Physical violation
l Security service or mechanism violation
l Time domain violation
You can modify the name definition of an alarm
NMS type by modifying the enumeration attribute
State
Refers to the
status of an
alarm.
Identifies whether an alarm is acknowledged or

cleared.
l Unacknowledged and uncleared
l Acknowledged but uncleared
l Unacknowledged but cleared
l Acknowledged and cleared
l Unacknowledged event
l Acknowledged event
You can modify the name definition of the
acknowledgment status and clearance status by
modifying the enumeration attribute part of the
configuration file. For details, see Enumeration
Attribute Configuration Part.
Issue 02 (2016-03-20)

36
U2000

Interface
Parameter
Description
Reference
SpecialAlarmStatusID
Refers to the
status of a
maintenancemode alarm.
Determines whether to display the status of a

maintenance-mode NE alarm. If this field is set to
Y, the SpecialAlarmStatusID field is added to
the alarm streaming message. By default, this field
is set to N, indicating that the status of a
maintenance_mode NE alarm will not be
displayed.
You can enable the maintenance-mode alarm
function and activate this property by referring to
Setting the method of reporting maintenancemode alarms.
You can modify the name definition of a
maintenance-mode alarm status by modifying the
enumeration attribute part of the configuration
file. For details, see Enumeration Attribute
Configuration Part.
Issue 02 (2016-03-20)
OccurTime
Refers to the
time when an
alarm is
generated.
Identifies the time when an alarm is generated.
AckTime
Refers to the
time when an
alarm is
acknowledged.
Identifies the time when an alarm is

acknowledged. It applies only to the
acknowledged alarms.
UnAckTime
Refers to the
time when an
alarm is
unacknowledge
d.
Identifies the time when an alarm is

unacknowledged. It applies only to the
unacknowledged alarms.
ClearTime
Refers to the
time when an
alarm is cleared.
Identifies the time when an alarm is cleared. It

applies only to the cleared alarms.
Location
Refers to the
alarm location
information.
Provides the information that helps locate and

handle faults, such as alarm causes.
Operator
Refers to the
information on
the operator.
Identifies who acknowledges the alarm. It applies

only to acknowledged alarms.
Additional
Additional
information.
Indicates additional information about an alarm.

This field is not reported by default.

37
U2000

Interface
Parameter
Description
Reference
RootCauseIndicator
Refers to the
root cause
indicator for an
alarm.
Root cause indicator for an alarm.

l 0 indicates a correlative alarm.
l 1 indicates a root alarm.
NotificationIdSet
ClearType
Refers to the
information
about a
correlative
alarm group.
Indicates the set of IDs for the alarm groups that

are correlated to the active alarm. Each alarm
group ID in this field starts with & and ends with
&. For example, &1&2&.
Clearance type
The ClearType field identifies the alarm

clearance type. The values are as follows:
l Normal clear
l Restore clear
l Manual clear
l Configure clear
l Correlation clear
l Buffer clear
l Status switch clear
The ClearType field applies only to cleared
alarms in NAMEVALUE format and is not
reported by default.
UserLabel
USERLABEL
This field is used to report the label customized by

users on NEs and helps determine the domain to
which an alarm belongs to.
l When the following text in bold is set to Y, the
northbound interface reports this field to the
NMS.
l When the following text in bold is set to N, the
northbound interface does not report this field
to the NMS.
<enable key="enable">N</enable>
Issue 02 (2016-03-20)

38
U2000

Interface
NOTE
Object is the sub-object of an NE, which is subordinate to the NE. For example, BTS is an object
type while BSC is an NE type. For details about the current object types provided by Huawei, see
Alarm Stream Interface Object Type List.xls.
The ObjFdn, ObjName, and ObjType fields exist in object alarm messages but do not exist in
NE alarm messages.
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.
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.
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.
To set the function of reporting maintenance-mode alarms, perform the following steps:
1. Run the following command on the U2000 as user ossuser to enable the maintenance-mode
alarm function:
. /opt/oss/server/svc_profile.sh
SettingTool -cmd setparam -path "/imap/ifms/specialAlarmStatus/nbenable" -value
"true"
svc_adm -cmd reload
2. Run the following command to restart FaultService:
svc_adm -cmd restartsvc FaultService
3. Run the following command to set SpecialAlarmStatusID to Y:
vi /opt/oss/server/etc/IRPService/locale/en_US/FMNotifyParams.xml
The modified SpecialAlarmStatusID field is as follows:
<string key="SpecialAlarmStatusID">
<name key="name">SpecialAlarmStatusID</name>
<enable key="enable">Y</enable>
</string>
4. Run the following command to restart CORBA service:

nbi_adm -cmd restart CORBA
l
Perform the following operations to set RootCauseIndicator and NotificationIdSet to be

reported:
1. Log in to the U2000 server as user ossuser.
2. Obtain the following license items: Smart Trouble Ticketing -GBSS, Smart Trouble
Ticketing -WRAN, and Smart Trouble Ticketing -LTE FDD/TDD.
3. Run the following command to restart FaultService:
svc_adm -cmd restartsvc FaultService
4. Run the following command to set RootCauseIndicator and NotificationIdSet to Y:
The modified RootCauseIndicator field and NotificationIdSet field are as follows:
<string key="RootCauseIndicator">
<name key="name">RootCauseIndicator</name>
</string>
<string key="NotificationIdSet">
<name key="name">NotificationIdSet</name>
</string>
Issue 02 (2016-03-20)

39
U2000

Interface
5. Run the following command to restart CORBA service:

nbi_adm -cmd restart CORBA
l
Perform the following operation to set Additional to be reported:

1. Run the following command on the U2000 as user ossuser to set Additional to Y.:
The modified Additional field is as follows:
<string key="Additional">
<name key="name">Additional</name>
</string>
2. If you need additional information about only certain alarm IDs, configure the ID range of
alarms to be reported.
The following is an example:
<section name="AdditionalInfoAlarmIDRange">
<param name="1">40925-41024</param>
</section>
Enumeration Attribute Configuration Part

The enumeration attributes of an NE, such as the alarm category, type, severity, and status on
the U2000 may be different from those on the NMS. Therefore, the U2000 provides
enumeration attribute configuration through which the U2000 reports enumeration
information according to the definition in the NMS.
The settings in the enumeration configuration part apply to alarm messages of all formats. For
details about the configuration items of the enumeration attributes configuration part, see
Table 3-3.
Table 3-3 Enumeration attribute configuration part of the configuration file
Parameter
Description
Reference
CategoryID
Refers to the
ID of an
alarm
category.
In the U2000 system, the alarm category types and IDs

are as follows:
l 1: Fault alarm
l 2: Cleared alarm
l 3: Event alarm
You can define the ID of an alarm category in the alarm
streaming message.
For example, <param name="1">8</param>
indicates that the ID for fault alarms in the alarm
streaming message is 8.
Issue 02 (2016-03-20)

40
U2000

Interface
Parameter
Description
Reference
Category
Refers to the
name of an
alarm
category.
In the U2000 system, the alarm categories are as follows:

l 1: Fault alarm
l 2: Cleared alarm
l 3: Event alarm
You can define the ID of an alarm category in the alarm
streaming message.
For example, <param name="1">Fault</param>
indicates that fault is used in the alarm streaming
message to refer to fault alarms.
SeverityID
Refers to the
ID of an
alarm
severity.
In the U2000 system, the alarm severity IDs are as

follows:
l 1: Critical alarm
l 2: Major alarm
l 3: Minor alarm
l 4: Warning
You can define the ID of an alarm severity in the alarm
streaming message.
indicates that the ID for critical alarms in the alarm
streaming message is 8.
Severity
Refers to the
name of an
alarm
severity.
In the U2000 system, the alarm severities are as follows:

l 1: Critical alarm
l 2: Major alarm
l 3: Minor alarm
l 4: Warning
You can define the name of an alarm severity in the alarm
streaming message.
For example, <param name="1">critical</
param> indicates that critical is used in the alarm
streaming message to refer to critical alarms.
Issue 02 (2016-03-20)

41
U2000

Interface
Parameter
Description
Reference
TypeID
Refers to the
type ID of the
NMS of an
alarm.
The U2000 has 16 types of alarm NMSs. The IDs are

represented by the numerals from 1 to 16 as follows:
l 1: Power system
l 4: Trunk system
l 7: Running system
l 9: QoS
l 11: OMC
You can define the type ID of an alarm NMS in the alarm
streaming message.
indicates that the NMS type ID for the power system in
the alarm streaming message is 0.
Issue 02 (2016-03-20)

42
U2000

Interface
Parameter
Description
Reference
Type
Refers to the
type name of
the NMS of
an alarm.
The U2000 has 16 types of alarm NMSs. The IDs are

represented by the numerals from 1 to 16 as follows:
l 1: Power system
l 4: Trunk system
l 7: Running system
l 9: QoS
l 11: OMC
You can define the type name of an alarm NMS in the
alarm streaming message.
For example, <param name="1">power</param>
indicates that power is used in the alarm streaming
message to refer to NMS type of power system.
ClearStatus
AckStatus
Refers to the
name of the
alarm
clearance
status.
The U2000 has two clearance statuses: uncleared and

cleared. They are represented by 0 and 1, respectively.
You can define the name of the clearance status of an
alarm in the alarm streaming message.
Refers to the
name of the
alarm
acknowledg
ment status.
The U2000 has two acknowledgment states:

unacknowledged and acknowledged. They are
represented by 0 and 1, respectively. You can define the
name of the acknowledgment status of an alarm in the
alarm streaming message.
For example, <param name="1">cleared</

param> indicates that alarm clearance is used in the
alarm streaming message to refer to the cleared status of
an alarm.
For example, <param

name="1">acknowledged</param> indicates that
alarm acknowledgment is used in the alarm streaming
message to refer to the acknowledged status of an alarm.
Issue 02 (2016-03-20)

43
U2000

Interface
Parameter
Description
Reference
enumSpecial
AlarmStatusI
D
Refers to the
status of a
maintenanceMode alarm.
In addition to the following five types of maintenancemode alarms provided by default, the U2000 provides
another 10 types for users to customize. Users can use
and rename the types as required. For details, see
Customizing the Maintenance Mode in the U2000
Online Help.
The types of maintenance-mode alarms are as follows:
l 0: Normal
l 1: Install
l 2: Expand
l 3: Upgrade
l 4: Testing
l 5: EXPANDSTATUS1
l 6: EXPANDSTATUS2
l 7: EXPANDSTATUS3
l 8: EXPANDSTATUS4
l 9: EXPANDSTATUS5
l 10: EXPANDSTATUS6
l 11: EXPANDSTATUS7
l 12: EXPANDSTATUS8
l 13: EXPANDSTATUS9
l 14: EXPANDSTATUS10
indicates that 1 is used to identify a device that is in
creation status in the alarm streaming message.
AdditionalInf
oAlarmIDRan
ge
Refers to the
additional
alarm ID
range.
When Additional is set to N, this field does not take

effect.
When Additional is set to Y, if this field is not set,
additional information about all alarms is reported. If this
field is set, additional information is reported for only
alarms whose IDs are within the preset range. For
example, to report additional information about alarms
whose IDs range from 40925 to 41024, set this field as
follows:
<param name="1">40925-41024</param>
</section>
Initial Configuration File

The initial configuration file for the system installation is as follows:
<?xml version="1.0" encoding="UTF-8"?>
<module name="FMNotify">
Issue 02 (2016-03-20)

44
U2000

Interface
<sub_module name="ParamSet">

<param name="refreshFltTimer">60</param>
<param name="Port">8765</param>
<param name="isDELConfirmAlarm">Y</param>
<param name="isDELUnConfirmAlarm">Y</param>



<param name="AlarmFormat">NAMEVALUE</param> #AlarmFormat must be set to
NAMEVALUE.
<param name="MAXConnectCount">2</param>

<param name="isCache">Y</param>

<param name="isSync">Y</param>
<param name="isSyncActive">N</param>

<param name="savetime">5</param>


<param name="ALLOWIP"></param>


<param name="isShowID">N</param>

<param name="HandShakePeriod">60</param>
<param name="ShowHandShakeFlag">Y</param>
<param name="AlarmForWordFilePath">$IMAP_ROOT/var/fmnotify/AlarmLog</
param>
<param name="ParaList">19,40,41,81</param>

<param name="MaxAlarmRecordCount">500000</param>

<param name="TimeFormat">0</param>
<auth name="auth">
<param name="enable">N</param>


<param name="logintimes">3</param>
<param name="accounts">1</param>
<param name="account">:</param>
</auth>
</sub_module>

<sub_module name="NameValueFormat">
<string key="Head" >
<name key="name">+++</name>
</string>
<string key="Tail">
<name key="name">---</name>
</string>
<string key="HandShake">
<name key="name">HandShake</name>
</string>
Issue 02 (2016-03-20)

45
U2000

Interface
<string key="NeSn">
<name key="name">NeSn</name>
</string>
<string key="Sn">
<name key="name">Sn</name>
</string>

<string key="ObjFdn">
<name key="name">ObjFdn</name>
</string>
<string key="ObjName">
<name key="name">ObjName</name>
</string>
<string key="ObjType">
<name key="name">ObjType</name>
</string>
<string key="NeFdn">
<name key="name">NeFdn</name>
</string>
<string key="NeName">
<name key="name">NeName</name>
</string>
<string key="NeType">
<name key="name">NeType</name>
</string>
<string key="AlarmID">
<name key="name">AlarmID</name>
</string>
<string key="AlarmName">
<name key="name">AlarmName</name>
</string>
<string key="CategoryID">
<name key="name">CategoryID</name>
</string>
<string key="Category">
<name key="name">Category</name>
</string>
<string key="SeverityID">
<name key="name">SeverityID</name>
</string>
Issue 02 (2016-03-20)

46
U2000

Interface
<string key="Severity">
<name key="name">Severity</name>
</string>
<string key="EventID">
<name key="name">EventID</name>
</string>
<string key="EventType">
<name key="name">EventType</name>
</string>
<string key="State">
<name key="name">State</name>
</string>
<string key="OccurTime">
<name key="name">Occurtime</name>
</string>

<string key="AckTime">
<name key="name">AckTime</name>
</string>
<string key="UnAckTime">
<name key="name">UnAckTime</name>
</string>

<string key="ClearTime">
<name key="name">ClearTime</name>
</string>
<string key="Location">
<name key="name">Location</name>
</string>
<string key="Operator">
<name key="name">Operator</name>
</string>
<string key="SpecialAlarmStatusID">
<name key="name">SpecialAlarmStatusID</name>
</string>
<string key="Additional">
<name key="name">Additional</name>
</string>
<string key="RootCauseIndicator">
<name key="name">RootCauseIndicator</name>
</string>
<string key="NotificationIdSet">
<name key="name">NotificationIdSet</name>
Issue 02 (2016-03-20)

47
U2000

Interface
</string>
<string key="ClearType">
<name key="name">ClearType</name>
</string>
</sub_module>


<sub_module name="ValueList">
<section name="CategoryID">
<param name="1">1</param>
</section>
<section name="Category">
<param name="1">Fault</param>
<param name="2">Clear</param>
<param name="3">Event</param>
</section>
<section name="SeverityID">
</section>
<section name="Severity">
<param name="1">Critical</param>
<param name="2">Major</param>
<param name="3">Minor</param>
<param name="4">Warning</param>
</section>
<section name="TypeID">
</section>
<section name="Type">
<param name="1">Power System</param>
<param name="2">Environmental System</param>
<param name="3">Signaling System</param>
<param name="4">Trunk System</param>
<param name="5">Hardware System</param>
<param name="6">Software System</param>
<param name="7">Running System</param>
<param name="8">Communication System</param>
<param name="9">QoS</param>
<param name="10">Processing Error</param>
Issue 02 (2016-03-20)

48
U2000
<param
<param
<param
<param
<param
<param
</section>

Interface
name="11">OMC</param>
name="12">Integrity Violation</param>
name="13">Operational Violation</param>
name="14">Physical Violation</param>
name="15">Security Service Or Mechanism Violation</param>
name="16">Time Domain Violation</param>
<section name="ClearStatus">
<param name="0">Uncleared</param>
<param name="1">Cleared</param>
</section>
<section name="AckStatus">
<param name="0">Unacknowledged</param>
<param name="1">Acknowledged</param>
</section>
<section name="enumSpecialAlarmStatusID">
</section>
</section>
</sub_module>

</module>
3.1.2 Configuration File of the Alarm Streaming Filter

The U2000 provides a configuration file for alarm streaming filter conditions. The
configuration file is /opt/oss/server/etc/IRPService/FMNotify/FMNotifyFilter.xml. This
enables you to forward alarms based on demand.
Overview
The configuration file for alarm streaming filter conditions consists of the following two
parts:
l
Basic configuration, which is included in the <common name="common"> part.

You can configure parameters to determine whether the required alarms are forwarded or
not.
Filter conditions setting, which is included in the <condition

name="condition"> part.
Filter conditions include restrictions for each field.
Issue 02 (2016-03-20)

49
U2000

Interface
Basic Configuration
Currently, basic configuration includes only filterflag. By fault, filterflag is set to N, and
alarms are forwarded. If you set filterflag to Y, alarms that meet the defined conditions are
not forwarded.
Filter Conditions Setting

l
Filter conditions are composed of a maximum of ten <condition

name="condition"></condition> fields. The OR relation exists between one
condition and another condition.
Each condition consists of a maximum of 100 parameters such as <param

name="NeType">GGSN80</param>. The AND relation exists between parameters
with different names, and the OR relation exists between parameters with the same
name.
If the condition part is empty, or there is no condition part in the configuration file, all
the alarms meet the requirements for forwarding or filtering. Whether the alarms are to
be forwarded or not depends on filterflag.
If the configuration file does not exist, all the alarms are forwarded to the NMS.
Table 3-4 describes the basic configuration part in the configuration file.
Table 3-4 Description of parameters in the configuration file for the alarm streaming filter
Parameter
Description
Reference
NeType
NE type
For the current NE types and Object types provided by

Huawei, see the Alarm Stream Interface Object Type
List.xls.
NOTE
The Alarm Stream Interface Object Type List.xls document is
decompressed to the 07.Northbound File\Alarm Streaming
Interface.
NeName
NE name
ObjType
Object type
The default value is Object Type. By default, the

ObjType field is included in all alarm messages.
Object is the sub-object of NEs, It is subordinate to NEs.
For example, BTS is an object type while BSC is an NE
type.
ObjName
Object name
The default value is Object Name. By default, the

ObjName field is included in all alarm messages.
CategoryID
Alarm category
ID
By default, the value of 1 stands for a fault alarm, and 3

for an event alarm. Cleared alarms are reported as fault
alarms.
You can modify the definition of alarm categories by
modifying enumeration attributes of the configuration
file. For details, see the part of configuring enumeration
attributes in 3.1.1 Configuration File of the Alarm
Issue 02 (2016-03-20)

50
U2000

Interface
Parameter
Description
Reference
SeverityID
Alarm severity
ID
The alarm severity indicates how severe an alarm is.

Huawei provides four alarm severities in descending
order: critical, major, minor, and warning. By default,
these four alarm severities are represented by 1, 2, 3, and
4 respectively.
You can modify the ID definition of the alarm severities
by modifying enumeration attributes of the configuration
file. For details, see the part of configuring enumeration
attributes in 3.1.1 Configuration File of the Alarm
AlarmID
Alarm ID
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 reports information such as the fault
alarm name, fault handling suggestions, alarm causes, and
fault locating parameters.
RatType
Alarm RAT ID
Alarms reported by NEs contain RAT information that

identifies the RAT of an alarm.
The value range of the alarm RAT ID is as follows:
l 0 indicates the normal alarm.
l 1 indicates the GSM alarm.
l 2 indicates the UMTS alarm.
l 3 indicates the LTE alarm.
l 4 indicates the COMM alarm.
This field is set for only a few NEs.
NOTE
The ObjFdn, ObjName, and ObjType fields exist in object alarm messages but do not exist in NE
alarm messages.
The alarm filter function applies only to reported alarms after the setting.
3.1.3 Connection Configuration File of the Alarm Streaming

Interface
The U2000 provides the configuration file /opt/oss/server/etc/IRPService/FMNotify/
SSLOption.xml for you to set SSL and non-SSL connection parameters. You can modify this
configuration file to connect to the alarm streaming interface in SSL or non-SSL connection
mode.
Overview
The configuration file SSLOption.xml is used to configure whether to use SSL connection
and, when SSL connection is used, configure SSL connection policies.
Issue 02 (2016-03-20)

51
U2000

Interface
Connection Parameters
The configuration items in SSLOption.xml are used to configure connection parameters
related to northbound interface operations. Table 3-5 describes these configuration items.
Table 3-5 Configuration items in SSLOption.xml
Para
mete
r
Descriptio
n
enabl
eSSL
Whether to
use SSL
connection
Reference
l true: SSL connection is used.
l false: Non-SSL connection is used.
The default value is true.
This parameter can be set to SSLv3, TLSv1, TLSv1.1, TLSv1.2,
SSLv23 or TLSvx.
versio
n
SSL
protocol
version
The default value is SSLv23. SSLv23 is compatible with SSLv3,

TLSv1, TLSv1.1 and TLSv1.2. TLSvx is compatible with TLSv1,
TLSv1.1 and TLSv1.2.
NOTICE
The SSLv3 protocol has security risks. 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.
This parameter can be set to high or all. The default value is high.
encry
ptLev
el
Issue 02 (2016-03-20)
Encryption
level
The encryption levels are defined in the algorithm list file /opt/oss/
server/etc/ssl/cipherSuiteConfig.xml. You can select different
algorithm lists from this file to implement security and
performance control. The mapping relationships between
encryption levels and algorithm lists vary with SSL protocol
versions. The algorithm names in this file are consistent with those
defined by the SSL protocol.
l true: The server authenticates the client and an identity
certificate must be deployed on the client. The server
determines whether the client identity certificate is valid based
on the trust certificate deployed on the server.
enabl
eAuth
Peer
Whether to
authenticate
the client.
enabl
eSessi
onRe
use
Whether to
reuse a
session.
l true: The session is reused.
sessio
nTim
eout
Timeout
period for
reusing a
session.
Valid interval between reusing a session. The parameter value

must be an integer in the unit of second.
l false: The server does not authenticate the client and no

identity certificate needs to be deployed on the client.
l false: The session is not reused.

The default value is true.

52
U2000
Para
mete
r
Descriptio
n
enabl
eSSL
PortA
utoAd
apt
Whether to
automaticall
y adapt to
SSL and
non-SSL
ports.

Interface
Reference
l true: SSL and non-SSL ports are automatically adapted.

l false: SSL and non-SSL ports are not automatically adapted.
This parameter cannot be modified.
3.2 Alarm Streaming Message in NAMEVALUE Format

This chapter describes the alarm streaming message in NAMEVALUE format. It covers the
format description of the alarm streaming message, introduction to the alarm handshake
message, and introduction to the alarm data message.
3.2.1 Format Description of the Alarm Streaming Message in

NAMEVALUE Format
This section describes the format of the alarm streaming message in NAMEVALUE format. It
also covers the descriptors in a common alarm message.
Overview
Alarm messages forwarded through the alarm streaming interface fall into two categories:
alarm handshake messages and alarm data messages.
The U2000 sends alarm handshake messages periodically. Through the received handshake
messages, the NMS identifies the status of the connection to the U2000. You can configure
the HandShakePeriod field in the configuration file to set the period for sending the
handshake message. For details, see the basic configuration part of 3.1.1 Configuration File
of the Alarm Streaming Interface.
An alarm message includes the alarm information that the U2000 collects for all NEs. The
U2000 sends an alarm message whenever it receives an alarm from an NE. The NMS receives
and then parses the alarm message to obtain the NE alarm information in real time.
Descriptors in a Common Alarm Message

A common alarm message includes the following descriptors:
l
<+++>: start of an alarm message.
SPn: SP stands for the space. n is the number of successive spaces included. For
example, SP4 stands for four successive spaces.
\r: Press Enter once.
\n: a new-line character.
YYYY: year, represented by four numerals, for example, 2005.
Issue 02 (2016-03-20)

53
U2000

Interface
MM: month, represented by two numerals, for example, 05 represents May, and 10
represents October.
DD: day, represented by two numerals, for example, 05 represents 5th day of a month,
and 10 represents the 10th day of a month.
hh: hour, represented by two numerals, for example, 05 represents 5 a.m., and 14
represents 2 p.m.
mm: minute, represented by two numerals, for example, 05 represents the fifth minute,
and 25 represents the 25th minute.
ss: second, represented by two numerals, for example, 05 represents the fifth second, and
25 represents the 25th second.
<--->: end of an alarm message.

NOTE
You can configure the Head and Tail fields in the configuration file to set the start and end of an alarm
message. For details, see the NAMEVALUE format configuration part of 3.1.1 Configuration File of
the Alarm Streaming Interface.
3.2.2 Introduction to the Alarm Handshake Message in

NAMEVALUE Format
This section describes the content, format, and an example of the alarm handshake message in
NAMEVALUE format.
3.2.2.1 Content of the Alarm Handshake Message in NAMEVALUE Format

This section describes the content of the alarm handshake message in NAMEVALUE format.
An alarm handshake message includes the time when the message is sent and the message
type represented by the HandShake field.
3.2.2.2 Format of the Alarm Handshake Message in NAMEVALUE Format

This section describes the default format of the alarm handshake message in NAMEVALUE
format.
The NAMEVALUE format of the handshake message is as follows:
<+++><\r\n>
handshake <SP2>=<SP2>YYYY-MM-DD<SP1>hh:mm:ss<\r\n>
<---><\r\n>
NOTE
You can configure the HandShake field in the configuration file to set the handshake flag. For details,
see the NameValue format configuration part of 3.1.1 Configuration File of the Alarm Streaming
Interface.
3.2.2.3 Example of the Alarm Handshake Message in NAMEVALUE Format

This section provides an example of the alarm handshake message in NAMEVALUE format.
Following is an alarm handshake message sent at 14:48:05 on April 2, 2005:
<+++>
handshake
<--->
Issue 02 (2016-03-20)
2005-04-02 14:48:05

54
U2000

Interface
3.2.3 Introduction to the Alarm Data Message in NAMEVALUE

Format
This section describes the content, format, and an example of the alarm data message in
NAMEVALUE format.
3.2.3.1 Content of the Alarm Data Message in NAMEVALUE Format

This section describes the content of the alarm data message in NAMEVALUE format.
In an alarm message for the U2000, each line represents an alarm information field in the
format of NAME = VALUE. The field name is on the left of the equal sign, and the field
value is on the right.
If no value is available for a field, the field is not displayed.
In the configuration file, you can change the fields displayed in an alarm message and the
name of each field. For details, see the NameValue format configuration part of 3.1.1
3.2.3.2 Format of the Alarm Data Message in NAMEVALUE Format

This section describes the format of the alarm data message in NAMEVALUE format.
Following is an example of the alarm data message in the NAME = VALUE format when all
fields are displayed.
<+++><\r\n>
Sn<SP2>=<SP2>the Equipment Serial Number of alarm<\r\n>
NeSn<SP2>=<SP2>the Alarm Serial Number of alarm<\r\n>
ObjFdn<SP2>=<SP2>the identifiers of object<\r\n>
ObjName<SP2>=<SP2>the name of object<\r\n>
ObjType<SP2>=<SP2>the type of object<\r\n>
NeFdn<SP2>=<SP2>the identifiers of NE<\r\n>
NeName<SP2>=<SP2>the name of NE<\r\n>
NeType<SP2>=<SP2>the type of NE<\r\n>
AlarmID<SP2>=<SP2>the id of alarm<\r\n>
AlarmName<SP2>=<SP2>the name of alarm<\r\n>
CategoryID<SP2>=<SP2>the id of alarm category<\r\n>
Category<SP2>=<SP2>the category of alarm<\r\n>
SeverityID<SP2>=<SP2>the id of alarm severity<\r\n>
Severity<SP2>=<SP2>the severity of alarm<\r\n>
State<SP2>=<SP2>the state of alarm<\r\n>
EventID<SP2>=<SP2>the id of alarm type<\r\n>
EventType<SP2>=<SP2>the type of alarm<\r\n>
OccurTime<SP2>=<SP2>the occur time of alarm<\r\n>
ClearTime<SP2>=<SP2>the cleared time of alarm<\r\n>
AckTime<SP2>=<SP2>the acknowledged time of alarm<\r\n>
UnAckTime<SP2>=<SP2>the unacknowledged time of alarm<\r\n>
Location<SP2>=<SP2>the location information of alarm<\r\n>
Operator<SP2>=<SP2>the operator who acknowledged the alarm<\r\n>
ClearType<SP2>=<SP2>ClearType<\r\n>
<---><\r\n>
For details about the meaning of each alarm information field, see Table 3-6.
Issue 02 (2016-03-20)

55
U2000

Interface
Table 3-6 Meanings and values of common alarm information fields

Field
Meaning
Value Description
Sn
Alarm NE flow number
An NE allocates a unique integer serial

number to an alarm. The integer serial number
is used as the unique identifier for that alarm.
For a specific NE, the device flow number is
unique. Different NEs, however, may have the
same device flow number.
NeSn
Alarm whole network

flow number
The U2000 allocates a unique integer serial

number to each received alarm.
ObjFdn
Object identifier
Each object has a unique identifier.
ObjName
Object name
The default value is Object Name. The

ObjName field is included in all alarm
messages by default.
ObjType
Object type
The default value is Object Type. The

ObjType field is included in all alarm
messages by default.
NeFdn
NE identifier
Each NE has a unique identifier.
NeName
NE name
NeType
NE type
Each NE is of a certain type.
AlarmID
Alarm ID
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 locating parameters.
AlarmName
Alarm name
Each alarm has a unique name. The alarm

name maps to the alarm ID.
CategoryID
Alarm category ID
Alarm category. By default, the value 1 stands

for a fault alarm, and 3 for an event alarm.
Cleared alarms are reported as fault alarms.
You can modify the definition of alarm
categories by modifying the enumeration
attribute part of the configuration file. For
details, see the enumeration attributes
configuration part of 3.1.1 Configuration
Issue 02 (2016-03-20)

56
U2000

Interface
Field
Meaning
Value Description
Category
Alarm category
Description of the alarm category. By default,

Fault stands for a fault alarm, and Event for
an event alarm. Cleared alarms are reported as
fault alarms.
You can modify the name definition of alarm
categories by modifying the enumeration
SeverityID
Alarm severity ID
Alarm severity. Huawei provides four alarm

severities. In descending order these are:
critical, major, minor, and warning. By
default, these four alarm severities are
represented by 1, 2, 3, and 4 respectively.
severities by modifying the enumeration
attribute part in the configuration file. For
details, see the enumeration attribute part of
3.1.1 Configuration File of the Alarm
Severity
Alarm severity
Description of the alarm severity. By default,

the four alarm severities are described as
critical, major, minor, and warning.
alarm severities by modifying the
enumeration attribute part in the configuration
file. For details, see the enumeration attribute
part of 3.1.1 Configuration File of the
Alarm Streaming Interface.
Issue 02 (2016-03-20)

57
U2000

Interface
Field
Meaning
Value Description
EventID
Alarm NMS type ID
NMS type ID of an alarm. Huawei provides

16 alarm NMS types.
By default, the IDs are represented by the
numerals from 1 to 16 as follows:
l 1: Power system
l 4: Trunk system
l 7: Running system
l 9: QoS
l 11: OMC
l 15: Security service or mechanism
violation
NMS types by modifying the enumeration
Issue 02 (2016-03-20)

58
U2000

Interface
Field
Meaning
Value Description
EventType
Alarm NMS type
Identifies the type ID of the NMS of an alarm.

Huawei provides the following types of alarm
NMSs:
l Power system
l Environmental system
l Signaling system
l Trunk system
l Hardware system
l Software system
l Running system
l Communication system
l QoS
l Processing error
l OMC
l Integrity violation
l Operational violation
l Physical violation
l Security service or mechanism violation
l Time domain violation
alarm NMS types by modifying the
enumeration attribute part of the configuration
file. For details, see the enumeration attributes
State
Alarm status
Identifies if an alarm is acknowledged and

cleared.
The alarm statuses include the following:
l Unacknowledged and Uncleared
l Acknowledged and Uncleared
l Unacknowledged and Cleared
l Acknowledged and Cleared
l Unacknowledged Event
l Acknowledged Event
acknowledgment status and clearance status
by modifying the enumeration attribute part of
the configuration file. For details, see the
enumeration attributes configuration part of
3.1.1 Configuration File of the Alarm
Issue 02 (2016-03-20)

59
U2000

Interface
Field
Meaning
Value Description
OccurTime
Time of alarm occurrence
Time when an alarm occurs.
AckTime
Time of alarm
acknowledgment
Time when an alarm is acknowledged. The

AckTime field applies only to acknowledged
alarms.
UnAckTime
Time of alarm
unacknowledgment
Time when an alarm is unacknowledged. The

UnAckTime field applies only to
unacknowledged alarms.
ClearTime
Time of alarm clearance
Time when an alarm is cleared. The

ClearTime field applies only to cleared fault
alarms.
Location
Alarm locating
information
Information that helps locate and handle

faults, such as the cause of an alarm.
Operator
Operator information
Identifies who acknowledges the alarm. The

Operator field applies only to acknowledged
alarms.
ClearType
Clearance type
The ClearType field identifies the alarm

clearance type. The values are as follows:
l Normal clear
l Restore clear
l Manual clear
l Configure clear
l Correlation clear
l Buffer clear
l Status switch clear
The ClearType field applies only to cleared
alarms and is not reported by default.
3.2.3.3 Example of the Alarm Data Message in NAMEVALUE Format

This section provides examples of the alarm data message in NAMEVALUE format.
NOTE
The default values are used for the enumeration attributes in the following examples. You can configure
the attributes by modifying the configuration file. For details, see the enumeration attributes
configuration part of 3.1.1 Configuration File of the Alarm Streaming Interface.
If a northbound interface compatibility ID has been set, the U2000 will adjust the EMS ID 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.
Unacknowledged and Uncleared NE Fault Alarm Messages

Following is an example of unacknowledged and uncleared NE fault alarm messages:
Issue 02 (2016-03-20)

60
U2000

Interface
<+++>
Sn = 121
NeSn = 565
NeFdn = NE=100
NeName = TestRNC
NeType = RNC
AlarmID = 101
AlarmName = WRBS Fan Fault Alarm
CategoryID = 1
Category = Fault
SeverityID = 2
Severity = Major
State = Unacknowledged & Uncleared
EventID = 2
EventType = Environmental System
Occurtime = 2005-04-02 17:35:10
Location = Subrack No. = 0, Fan drawer No. = 0
<--->
Unacknowledged and Cleared NE Fault Alarm Messages

Following is an example of unacknowledged and cleared NE fault alarm messages:
<+++>
Sn = 7
NeSn = 451
NeFdn = NE=100
NeName = TestRNC
NeType = RNC
AlarmID = 12
AlarmName = Under-voltage with Input -48V
CategoryID = 1
Category = Fault
SeverityID = 2
Severity = Major
State = Unacknowledged & Cleared
EventID = 1
EventType = Power System
Occurtime = 2005-03-31 17:48:34
ClearTime = 2005-04-02 17:50:41
Location = Subrack No. = 0, -48V input power supply No. = 0
<--->
Acknowledged and Uncleared NE Fault Alarm Messages

Following is an example of acknowledged and uncleared NE fault alarm messages:
<+++>
Sn = 11
NeSn = 455
NeFdn = NE=100
NeName = TestRNC
NeType = RNC
AlarmID = 12
CategoryID = 1
Category = Fault
SeverityID = 2
Severity = Major
State = Acknowledged & Uncleared
EventID = 1
Occurtime = 2005-03-31 17:48:38
AckTime = 2005-04-02 17:50:52
Operator = admin
<--->
Issue 02 (2016-03-20)

61
U2000

Interface
Acknowledged and Cleared NE Fault Alarm Messages

Following is an example of acknowledged and cleared NE fault alarm messages:
<+++>
Sn = 11
NeSn = 455
NeFdn = NE=100
NeName = TestRNC
NeType = RNC
AlarmID = 12
CategoryID = 1
Category = Fault
SeverityID = 2
Severity = Major
State = Acknowledged & Cleared
EventID = 1
Occurtime = 2005-03-31 17:48:38
ClearTime = 2005-04-02 17:28:45
AckTime = 2005-04-02 17:27:52
Operator = admin
<--->
Unacknowledged NE Event Alarm Messages

Following is an example of unacknowledged NE event alarm messages:
<+++>
Sn = 123
NeSn = 567
NeFdn = NE=100
NeName = TestRNC
NeType = RNC
AlarmID = 1406
AlarmName = MTP-3b Signalling Route Inhibited
CategoryID = 3
Category = Event
SeverityID = 2
Severity = Major
State = Unacknowledged Event
EventID = 3
EventType = Signaling System
Occurtime = 2005-04-02 17:40:08
Location = DSP NI = please replace, DSP code = 0, Signalling linkset index = 0
<--->
Acknowledged NE Event Alarm Messages

Following is an example of acknowledged NE event alarm messages:
<+++>
Sn = 123
NeSn = 567
NeFdn = NE=100
NeName = TestRNC
NeType = RNC
AlarmID = 1406
AlarmName = MTP-3b Signalling Route Inhibited
CategoryID = 3
Category = Event
SeverityID = 2
Severity = Major
State = Acknowledged Event
EventID = 3
Issue 02 (2016-03-20)

62
U2000

Interface
EventType = Signaling System

Occurtime = 2005-04-02 17:40:08
AckTime = 2005-04-02 17:31:25
Location = DSP NI = please replace, DSP code = 0, Signalling linkset index = 0
Operator = admin
<--->
Unacknowledged and Uncleared Object Fault Alarm Messages

Following is an example of unacknowledged and uncleared object fault alarm messages:
<+++>
Sn = 29
NeSn = 608
ObjFdn = NE=100,BTS=1
ObjName = SITE1
ObjType = BTS
NeFdn = NE=100
NeName = TestBSC
NeType = BSC
AlarmID = 1000
AlarmName = LAPD_OML alarm
CategoryID = 1
Category = Fault
SeverityID = 1
Severity = Critical
State = Unacknowledged & Uncleared
EventID = 4
EventType = Trunk System
Occurtime = 2005-04-04 09:53:27
Location = OBJ=8 SITE NO=1 MODULE NO=1 SITE MODEL=3
<--->
Unacknowledged and Cleared Object Fault Alarm Messages

Following is an example of unacknowledged and cleared object fault alarm messages:
<+++>
Sn = 26
NeSn = 605
ObjName = SITE1
ObjType = BTS
NeFdn = NE=100
NeName = TestBSC
NeType = BSC
AlarmID = 1000
CategoryID = 1
Category = Fault
SeverityID = 1
Severity = Critical
EventID = 4
Occurtime = 2005-04-04 09:52:59
ClearTime = 2005-04-04 10:24:21
<--->
Acknowledged and Uncleared Object Fault Alarm Messages

Following is an example of acknowledged and uncleared object fault alarm messages:
<+++>
Sn =
Issue 02 (2016-03-20)
26

63
U2000

Interface
NeSn = 605
ObjName = SITE1
ObjType = BTS
NeFdn = NE=100
NeName = TestBSC
NeType = BSC
AlarmID = 1000
CategoryID = 1
Category = Fault
SeverityID = 1
Severity = Critical
State = Acknowledged & Uncleared
EventID = 4
Occurtime = 2005-04-04 09:52:59
AckTime = 2005-04-04 10:16:13
Operator = admin
<--->
Acknowledged and Cleared Object Fault Alarm Messages

Following is an example of acknowledged and cleared object fault alarm messages:
<+++>
Sn = 26
NeSn = 605
ObjName = SITE1
ObjType = BTS
NeFdn = NE=100
NeName = TestBSC
NeType = BSC
AlarmID = 1000
CategoryID = 1
Category = Fault
SeverityID = 1
Severity = Critical
State = Acknowledged & Cleared
EventID = 4
Occurtime = 2005-04-04 09:52:59
ClearTime = 2005-04-04 10:24:21
AckTime = 2005-04-04 10:16:13
Operator = admin
<--->
Unacknowledged Object Event Alarm Messages

Following is an example of unacknowledged object event alarm messages:
<+++>
Sn = 56
NeSn = 635
ObjName = SITE1
ObjType = BTS
NeFdn = NE=100
NeName = TestBSC
NeType = BSC
AlarmID = 2503
AlarmName = OSSU extended C3 alarm recovery
CategoryID = 3
Category = Event
Issue 02 (2016-03-20)

64
U2000

Interface
SeverityID = 2
Severity = Major
State = Unacknowledged Event
EventID = 5
EventType = Hardware System
Occurtime = 2005-04-04 10:46:37
Location = Obj=0 SiteNo=1 ModuleNo=1 SiteStyle=0 CardID=8 CardNo=6 SubNo=7
<--->
Acknowledged Object Event Alarm Messages

Following is an example of acknowledged object event alarm messages:
<+++>
Sn = 56
NeSn = 635
ObjName = SITE1
ObjType = BTS
NeFdn = NE=100
NeName = TestBSC
NeType = BSC
AlarmID = 2503
AlarmName = OSSU extended C3 alarm recovery
CategoryID = 3
Category = Event
SeverityID = 2
Severity = Major
State = Acknowledged Event
EventID = 5
EventType = Hardware System
Occurtime = 2005-04-04 10:46:37
AckTime = 2005-04-04 10:47:27
Location = Obj=0 SiteNo=1 ModuleNo=1 SiteStyle=0 CardID=8 CardNo=6 SubNo=7
Operator = admin
<--->
Alarm Messages in Maintenance-Mode Alarm Status

Following is an example of alarm messages that are in maintenance-mode alarm status:
<+++>
Sn = 7
NeSn = 451
NeFdn = NE=100
NeName = TestRNC
NeType = RNC
AlarmID = 12
CategoryID = 1
Category = Fault
SeverityID = 2
Severity = Major
EventID = 1
SpecialAlarmStatusID = 1
Occurtime = 2005-03-31 17:48:34
ClearTime = 2005-04-02 17:50:41
<--->
Issue 02 (2016-03-20)

65
U2000
4 Troubleshooting the Northbound Alarm Streaming

Interface
Troubleshooting the Northbound Alarm

Streaming Interface
About This Chapter

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.
4.1 Common Troubleshooting and Information Collection (Alarm Streaming Interface)
If a fault occurs when the NMS attempts to obtain alarm messages through the northbound
alarm streaming interface, rectify the fault following the troubleshooting suggestions given
here for the most common faults. If it is not possible to rectify the fault by using these
troubleshooting suggestions, collect the fault information and contact Huawei technical
support.
4.2 Troubleshooting the Interconnection Failure Between the NMS and the U2000
The interconnection failure between the NMS and the U2000 can occur because the NMS is
not licensed to use the alarm streaming interface or the IRPService service has not been
started. This section describes how to troubleshoot the interconnection failure that occurs
because of either of these two causes.
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.
4.5 How to Handle the Closed SSL Connection Problem
This section describes how to locate the cause when the SSL connection between the NMS
and the U2000 server is closed.
Issue 02 (2016-03-20)

66
U2000

Interface
4.1 Common Troubleshooting and Information Collection

(Alarm Streaming Interface)
If a fault occurs when the NMS attempts to obtain alarm messages through the northbound
alarm streaming interface, rectify the fault following the troubleshooting suggestions given
here for the most common faults. If it is not possible to rectify the fault by using these
troubleshooting suggestions, collect the fault information and contact Huawei technical
support.
Troubleshooting
For suggestions on how to handle common faults that may occur when obtaining alarm data
for the NMS, see Table 4-1.
Table 4-1 Troubleshooting common faults that occur when obtaining alarm data
Common Fault
Troubleshooting Method
The NMS cannot interconnect with the

U2000.
See 4.2 Troubleshooting the

Interconnection Failure Between the
NMS and the U2000.
How to set northbound interface

compatibility
See 4.3 How to Set Northbound Interface

Compatibility.
How to set parameters in a northbound

configuration file
See 4.4 How to Set Parameters in a

Northbound Configuration File.
How to Handle the Closed SSL Connection

Problem
See 4.5 How to Handle the Closed SSL

Connection Problem.
Information Collection
If a fault not included in Table 4-1 occurs when the NMS attempts to obtain alarm messages,
you need to collect the relevant information to locate the fault. Table 4-2 lists the information
that needs to be collected and the collection methods.
Table 4-2 Information to be collected
Issue 02 (2016-03-20)
Related Information
Description
Operation information
Records the operations performed before a

fault occurs and the troubleshooting
measures taken later.
Version information
You need to obtain information of the

U2000 version, NE mediation version, and
NE version.

67
U2000

Interface
Related Information
Description
IP address information
You need to obtain IP address information

of the U2000 server.
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 You can obtain logs from the /opt/oss/

server/var/logs directory. The .trace file
of FMNotify is iMAP.irp_agent.trace.
l Obtain backup trace files from
the /opt/oss/server/var/logs/tracebak
directory.
4.2 Troubleshooting the Interconnection Failure Between

the NMS and the U2000
The interconnection failure between the NMS and the U2000 can occur because the NMS is
not licensed to use the alarm streaming interface or the IRPService service has not been
started. This section describes how to troubleshoot the interconnection failure that occurs
because of either of these two causes.
Problem Description
The NMS cannot interconnect with the U2000. Neither the alarm message nor the heartbeat
signal is received.
Troubleshooting
The NMS can fail to interconnect with the U2000 due to the following causes:
l
The NMS does not have the required license file.
The IRPService service has not been started.
Determine whether the NMS is licensed to use the alarm streaming interface. For details,
see 2.1 Checking License (Alarm Streaming Interface).
Run the following commands to start the IRPService service:
Solution
Issue 02 (2016-03-20)

68

Interface
U2000
$ svc_adm -cmd startsvc IRPService
If the following information is displayed, the service has been successfully started:
IRPService
[running
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.
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.
Issue 02 (2016-03-20)

69
U2000

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.
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
4.5 How to Handle the Closed SSL Connection Problem

This section describes how to locate the cause when the SSL connection between the NMS
and the U2000 server is closed.
Question
The SSL connection between the NMS and the U2000 server is closed.
Issue 02 (2016-03-20)

70
U2000

Interface
Solution
NOTE
SSL connection transmits data based on records and TCP/IP connection transmits data based on streams.
In SSL connection, a sending error occurs when the client end receives data too slowly or even cannot
receive data, or the data transmission times out.
Perform the following steps to determine whether the closed SSL connection problem is
caused by a sending error. When a sending error occurs, the U2000 server (server end of SSL
connection) automatically closes the SSL connection.
1.
Log in to the U2000 client.
2.
Choose System > Log Management > Query System Logs (traditional style);
alternatively, double-click Security Management in Application Center and choose
Log Management > Query System Logs (application style).
3.
. In the displayed Select Source dialog box, select a

In the Filter dialog box, click
northbound interface. For example, select FMNotify for the alarm streaming interface
and NMSMMLServer for the MML command interface.
4.
In the Basic Information area, select SSL connection is closed.
Issue 02 (2016-03-20)
There is a record: This problem is caused by a sending error. As a result, the U2000
server automatically closes the SSL connection. In this situation, the NMS needs to
re-initiate the SSL connection to the U2000 server.
There is no record: This problem is not caused by a sending error. In this situation,
contact Huawei technical support.

71

U2000 Northbound Alarm Streaming Interface Developer Guide

Diunggah oleh

Informasi Dokumen

Deskripsi Asli:

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

U2000 Northbound Alarm Streaming Interface Developer Guide

Diunggah oleh

Hak Cipta:

Format Tersedia

U2000

Northbound Alarm Streaming

HUAWEI TECHNOLOGIES CO., LTD.

Copyright Huawei Technologies Co., Ltd. 2016. All rights reserved.

Trademarks and Permissions

Huawei Technologies Co., Ltd.

Huawei Industrial Base

Huawei Proprietary and Confidential

About This Document

About This Document

Huawei Proprietary and Confidential

About This Document

Huawei Proprietary and Confidential

About This Document

Times New Roman

Normal paragraphs are in Times New Roman.

Names of files, directories, folders, and users are in

Book titles are in italics.

Examples of information displayed on the screen are in

The keywords of a command line are in boldface.

Command arguments are in italics.

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

Optional items are grouped in braces and separated by

Optional items are grouped in brackets and separated by

About This Document

Optional items are grouped in braces and separated by

Optional items are grouped in brackets and separated by

Buttons, menus, parameters, tabs, window, and dialog titles

Multi-level menus are in boldface and separated by the ">"

Press the keys concurrently. For example, pressing Ctrl

Press the keys in turn. For example, pressing Alt, A means

Select and release the primary mouse button without

Press the primary mouse button twice continuously and

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

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

Huawei Proprietary and Confidential

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

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

Huawei Proprietary and Confidential

1 Introduction to Northbound Alarm Streaming Interface

Introduction to Northbound Alarm

About This Chapter

Huawei Proprietary and Confidential

1 Introduction to Northbound Alarm Streaming Interface

1.1 Definition of Northbound Interface

1.2 Definition of Northbound Alarm Streaming Interface

Huawei Proprietary and Confidential

1 Introduction to Northbound Alarm Streaming Interface

1.3 Alarm Report Format

1.4 Functions Provided by the Northbound Alarm

Reporting historical alarms

After the NMS and the

Huawei Proprietary and Confidential

For detailed operations, see

1 Introduction to Northbound Alarm Streaming Interface

Reporting active alarms

After the NMS and the

To view active alarms after

After the NMS and the

For detailed operations, see

Huawei Proprietary and Confidential

1 Introduction to Northbound Alarm Streaming Interface

Synchronizing active alarms