Академический Документы
Профессиональный Документы
Культура Документы
V200R016C10
02
Date
2016-03-20
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.
Website:
http://www.huawei.com
Email:
support@huawei.com
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
Scope
This document provides information about the U2000 northbound alarm file interface. The
document also provides operation guidelines for connecting the network management system
(NMS).
This document only describes how to use and configure general functions and does not
describe user-defined functions. If you want to know how to use and configure user-defined
functions, apply for related function documents from Huawei.
Product Versions
The following table lists the product version related to this document.
Product Name
Version
U2000
V200R016C10
Intended Audience
This document is intended for:
Network management engineers
Change History
02 (2016-03-20)
This is 02 version for V200R016C10. Compared with issue 01 (2016-02-25) of
V200R016C10, no change.
Issue 02 (2016-03-20)
ii
U2000
Northbound Alarm File Interface Developer Guide
01 (2016-02-25)
This is 01 version for V200R016C10. Compared with issue Draft A (2015-12-30) of
V200R016C10, no change.
Draft A (2015-12-30)
This is a draft for V200R016C10. Compared with issue 01 (2015-09-20) of V200R016C00,
no change is made.
Organization
1 Introduction to Northbound Alarm File Interface
This chapter introduces the definition of the northbound interface and the northbound alarm
file interface provided by the U2000.
2 Interconnection Commissioning of the Northbound Alarm File Interface
Before interconnecting the NMS with the U2000, conduct an interconnection commissioning.
Based on the commissioning result, verify that the northbound alarm file interface meets the
conditions for interconnecting with the NMS.
3 Introduction to Alarm Export Tool and File
This chapter describes the alarm export tool, formats of alarm export files, alarm export
operations, and troubleshooting.
4 Troubleshooting the Northbound Alarm File Interface
The NMS interconnects with the U2000 through the northbound alarm file interface. If a fault
occurs when the NMS is obtaining alarm data, refer to relevant troubleshooting methods in
this chapter.
5 Appendix: Description of Fields Exported Through the Alarm File Interface
Conventions
Symbol Conventions
The symbols that may be found in this document are defined as follows.
Symbol
Description
Indicates an imminently hazardous situation which, if not
avoided, will result in death or serious injury.
Indicates a potentially hazardous situation which, if not
avoided, could result in death or serious injury.
Indicates a potentially hazardous situation which, if not
avoided, may result in minor or moderate injury.
Issue 02 (2016-03-20)
iii
U2000
Northbound Alarm File Interface Developer Guide
Symbol
Description
Indicates a potentially hazardous situation which, if not
avoided, could result in equipment damage, data loss,
performance deterioration, or unanticipated results.
NOTICE is used to address practices not related to personal
injury.
Calls attention to important information, best practices and
tips.
NOTE is used to address information not related to
personal injury, equipment damage, and environment
deterioration.
General Conventions
The general conventions that may be found in this document are defined as follows.
Convention
Description
Boldface
Italic
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
Italic
[]
{ x | y | ... }
[ x | y | ... ]
{ x | y | ... }*
iv
U2000
Northbound Alarm File Interface Developer Guide
Convention
Description
[ x | y | ... ]*
GUI Conventions
The GUI conventions that may be found in this document are defined as follows.
Convention
Description
Boldface
>
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
Key 1, Key 2
Mouse Operations
The mouse operations that may be found in this document are defined as follows.
Issue 02 (2016-03-20)
Action
Description
Click
Double-click
Drag
Press and hold the primary mouse button and move the
pointer to a certain position.
U2000
Northbound Alarm File Interface Developer Guide
Contents
Contents
About This Document.....................................................................................................................ii
1 Introduction to Northbound Alarm File Interface.................................................................. 1
1.1 Definition of Northbound Interface................................................................................................................................ 2
1.2 Definition of Northbound Alarm File Interface..............................................................................................................2
1.3 Using the Alarm File Interface....................................................................................................................................... 2
1.4 Technical Specifications of Northbound File Interface.................................................................................................. 3
Issue 02 (2016-03-20)
vi
U2000
Northbound Alarm File Interface Developer Guide
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
In the communication network, the U2000 provides the alarm, configuration, performance,
and inventory data of NEs to the NMS through the northbound interface.
When using the northbound alarm file interface, run the alarm export tool on the U2000 server.
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
Single-server
system
HA system
Remote HA
system
SUN SLS
system
ATAE cluster
system
(Distributed
networking)
ATAE cluster
online remote
HA system
VM Single
System
VM Cluster
System
(Distributed
networking)
Issue 02 (2016-03-20)
Specification Item
Value
15
10
50
U2000
Northbound Alarm File Interface Developer Guide
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
2.
Choose License > OSS License Management > License Information (traditional
style). Alternatively, double-click System Management in Application Center and
choose License Management > License Information (application style). The License
Information window is displayed.
3.
Click the Resource Control Item tab. If Resource contains Alarm File Interface, the
NMS is authorized to use the alarm file interface.
Issue 02 (2016-03-20)
Parameter
Type
Parameter
Parameter Value
Description
User
User Name
ftpuser
This parameter
cannot be
modified.
Password
To improve system
security, change
the default
database password
upon first login
and periodically
change the
password. The
password change
interval can be
customized as
required.
U2000
Northbound Alarm File Interface Developer Guide
Parameter
Type
Content
Parameter
Parameter Value
Description
Export Path
/opt/oss/server/var/
fileint/fm/
This parameter
cannot be
modified.
Alarm Level
l Critical
l Major
l Minor
l Warning
Alarm Category
l Alarm
l Event
Format
File Format
CSV
Prerequisites
You have logged in to the U2000 server as user ossuser.
Context
l
In an SLS system, you need to perform the following steps only on the master server.
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 directory of the U2000 server software.
NOTE
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
$ cd /opt/oss/server
Step 2 Modify the configuration file.
$ vi etc/alarm/locale/en_US/fmexportsvc_field.xml
The following lists the open configuration file. Modify the configuration file according to the
modification guide. Configure the fields to be exported. For details, see Appendix:
Description of Fields Exported Through the Alarm File Interface.
<?xml version="1.0" encoding="utf-8"?>
<all name="ColumnList">
<section name="AlmColumnList">
<param name="Csn">Log Serial Number</param>
<param name="FDNName">Object Identity Name</param>
<param name="FDN">Object Identity</param>
<param name="ProductID">ProductName</param>
<param name="NEType">NEType</param>
<param name="NEFDN">NE Object Identity</param>
<param name="NEFDNName">Alarm Source</param>
<param name="DevCsn">EquipmentAlarmSerialNumber</param>
<param name="Id">AlarmName</param>
<param name="Type">Type</param>
<param name="AlmLevel">Severity</param>
<param name="Status">Status</param>
<param name="occurUtcTime">OccurrenceTime</param>
<param name="ackUtcTime">AcknowledgementTime</param>
<param name="clearUtcTime">ClearanceTime</param>
<param name="Operator">(UN)AcknowledgementOperator</param>
<param name="ClearOperator">ClearanceOperator</param>
<param name="ExtendInfo">LocationInformation</param>
<param name="LinkFDN">LinkFDN</param>
<param name="LinkFDNName">LinkName</param>
<param name="LinkType">LinkType</param>
<param name="AlarmIdentifier">Alarm Identifier</param>
<param name="AlarmId">Alarm ID</param>
<param name="MOType">Object Instance Type</param>
<param name="clearCategory">Auto Clear</param>
<param name="clearType">Alarm Clear Type</param>
<param name="businessAffected">business Affected</param>
<param name="addtionalText">addtional Text</param>
<param name="arrivedUtcTime">arrivedUtcTime</param>
<param name="listId">list Id</param>
<param name="relatedLogId">related LogId</param>
<param name="agentId">agent ID</param>
<param name="rootId">root Id</param>
<!--<param name="Comment">Alarm Comment</param>-->
<param name="showFlag">show Flag</param>
</section>
<section name="EventColumnList">
<param name="Csn">Log Serial Number</param>
<param name="FDNName">Object Identity Name</param>
<param name="FDN">Object Identity</param>
<param name="ProductID">ProductName</param>
<param name="NEType">NEType</param>
<param name="NEFDN">NE Object Identity</param>
<param name="NEFDNName">Alarm Source</param>
<param name="DevCsn">EquipmentAlarmSerialNumber</param>
<param name="Id">AlarmName</param>
<param name="Type">Type</param>
<param name="AlmLevel">Severity</param>
<param name="occurUtcTime">OccurrenceTime</param>
<param name="ExtendInfo">LocationInformation</param>
<param name="LinkFDN">LinkFDN</param>
<param name="LinkFDNName">LinkName</param>
<param name="LinkType">LinkType</param>
<param name="AlarmIdentifier">Alarm Identifier</param>
<param name="AlarmId">Alarm ID</param>
<param name="MOType">Object Instance Type</param>
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
Add, delete, or modify the alarm export fields in section. Only the fields listed in the
comment part of the configuration file can be added. For example, to export the FDN of the
generated alarm object, add the following line to section.
<param name="FDN">Alarm Object FDN</param>
The Alarm Object FDN field is added to the exported file accordingly. The field position
corresponds to the position of the added field in the configuration file. That is, if the added
field is between Alarm Name and Type, in the exported file, the Alarm Object FDN field is
between Alarm Name and Type.
In addition to adding, deleting, or modifying the alarm export fields, you can sort the fields in
the configuration file, and export the configuration file based on the sorted fields.
Step 3 Press Esc, and then run :wq! to save the modification and exit the vi editor.
Step 4 Run the following commands for the modified configuration file to take effect.
$ cd /opt/oss/server
$ . ./svc_profile.sh
$ svc_adm -cmd restartsvc FaultService
----End
Prerequisites
You have logged in to the U2000 client.
Procedure
Step 1 Choose Maintenance > Task Management (traditional style); alternatively, double-click
System Management in Application Center and choose Task Schedule > Task
Management (application style). The Task Management window is displayed.
Step 2 From the navigation tree on the left, choose File Interface > Alarm/Event Log Export to
view a task record.
Step 3 Double-click the task record to open the Attribute dialog box. Set relevant parameters by
referring to Table 2-2.
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
Parameter
Parameter Value
Common Parameters
Task Name
Start Time
10/11/2008 20:14:00
Period
One day
The shortest period is 5
minutes.
Extended Parameters
Alarm Level,Category,Type
File Type
CSV
Compression Option
Zip
Alarm Level
l Critical
l Major
l Minor
l Warning
Alarm Category
l Alarm Log
l Event Log
Alarm Type
Select All
NOTE
After the alarm is automatically exported and before the next export, right-click on a task record and
then choose Run Now to enable the alarm file export task manually.
Prerequisites
The communication between the NMS and U2000 is normal.
Context
The NMS can use either of the following methods to obtain alarm files:
l
The NMS uses SFTP to obtain alarm files from the specified path on the U2000 server.
Issue 02 (2016-03-20)
U2000
Northbound Alarm File Interface Developer Guide
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.
Procedure
Step 1 Start the Internet Explorer, type https://IP address of the U2000 server:31123, and then
press Enter.
Step 2 Log in to the OSMU as user ossuser.
Step 3 In the main window of the OSMU, click NBI Management.
Step 4 In the navigation tree in the left pane, choose NBI Management > Category Management >
File Interface > Alarm File Interface to open the Alarm File Interface page.
Step 5 On the Query Alarm Files tab page showing generated alarm files, you can click a file name
and open or download it.
Step 6 Verify the downloaded alarm file.
Use an event alarm as an example, as shown in Figure 2-1. The exported file contains alarms
at critical and warning levels, which are the same as the negotiated parameters. The exported
alarm file is therefore correct.
Figure 2-1 Event alarms
----End
Issue 02 (2016-03-20)
10
U2000
Northbound Alarm File Interface Developer Guide
Issue 02 (2016-03-20)
11
U2000
Northbound Alarm File Interface Developer Guide
12
U2000
Northbound Alarm File Interface Developer Guide
Naming Conventions
Alarm export files are named in the following format: File Prefix-Date and Time [DST]Alarm category-auto-Sequence number-Extension, where
The file prefix field takes effect only if you have set the File Prefix parameter while
creating alarm export tasks on the U2000 client. The parameter value is case sensitive
and composed of 0 to 30 digits or letters. For details, see Help.
The date and time field records the time when alarms are exported. DST indicates that
alarms are exported during daylight saving time. [] indicates that the sign is not used in
non-DST period.
The alarm category field records the category of exported alarms. The value can be
alarm-log or event-log, which represent alarm logs and event logs, respectively.
A maximum of 5,000 alarms of the same category can be exported to a file. Additional
alarms of the same category are exported to another file. Files are numbered sequentially
from 1. If one file is enough to store all exported alarms, the file number is 1.
The extension field indicates the format of a file, which can be set to .xml, .csv, .txt,
or .html. If you select a compression mode for export, the extension field is .zip or .gzip
according to the compression mode you select.
Examples
20091006120300-alarm-log-auto-1.xml indicates an alarm log file in .xml format and
exported at 12:03 on October 6, 2009.
20091006120300-event-log-auto-1.zip indicates an event log file compressed in .zip
format and exported at 12:03 on October 6, 2009.
XML
In an XML file, each <Record name="AlarmRecord"></Record> corresponds to an
alarm.
Following is an example XML file:
<?xml version="1.0" encoding="UTF-8"?>
<ExportFileInfo name="AlarmRecords">
<Record name="AlarmRecord">
<column name="Log Serial Number">2</column>
<column name="Object Identity Name">OSS</column>
<column name="Object Identity">OS=1</column>
<column name="ProductName">NMS</column>
<column name="NEType">OSS</column>
<column name="NE Object Identity">OS=1</column>
<column name="Alarm Source">OSS</column>
<column name="EquipmentAlarmSerialNumber">0</column>
Issue 02 (2016-03-20)
13
U2000
Northbound Alarm File Interface Developer Guide
Some messages are displayed in multiple lines due to the large size of contents. In the actual file,
these messages are displayed in one line.
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.
Format description of the alarm generation time: For example, the alarm generation time provided
in the alarm export file is 2013/4/13 06:37:43 GMT+08:00, where
l
2013/4/13 06:37:43 refers to the local time, calculated using the following formula: Local
time = GMT + Time zone.
Issue 02 (2016-03-20)
14
U2000
Northbound Alarm File Interface Developer Guide
<param name="filenum">1000</param>
</policy>
Table 3-1 Parameters for the deletion policy of alarm export files
Parameter
Value
Description
filesize
Can be modified.
Default value: 15
keepdays
Can be modified.
filenum
Number of files.
Can be modified.
NOTE
After modifying the deletion policy of alarm export files, restart FaultService for the modification to
take effect.
You can modify the parameters of the northbound configuration file either by running commands or by
using the OSMU. For details about the operations performed on the OSMU, see 4.4 How to Set
Parameters in a Northbound Configuration File.
Prerequisites
You have logged in to the U2000 server as user ossuser.
Context
l
In an SLS system, you need to perform the following steps only on the master server.
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.
Issue 02 (2016-03-20)
15
U2000
Northbound Alarm File Interface Developer Guide
You can modify the parameters of the northbound configuration file either by running
commands or by using the OSMU. For details about the operations performed on the OSMU,
see 4.4 How to Set Parameters in a Northbound Configuration File.
Procedure
Step 1 Go to the installation folder.
The default installation path is /opt/oss/server.
By default, run the following command:
$ cd /opt/oss/server
Step 2 To edit the configuration file, run the following command:
$ vi etc/alarm/locale/en_US/fmexportsvc_field.xml
NOTE
Modify the configuration file according to the modification guide. The modification guide is included in
the configuration file.
Step 3 To make the modified configuration file effective, run the following commands:
$ . ./svc_profile.sh
$ svc_adm -cmd restartsvc FaultService
----End
Prerequisites
You have logged in to the U2000 client.
Procedure
Step 1 Choose Maintenance > Task Management (traditional style); alternatively, double-click
System Management in Application Center and choose Task Schedule > Task
Management (application style). The Task Management window is displayed.
Step 2 Choose File Interface > Alarm/Event Log Export from the navigation tree to view task
records.
Step 3 Double-click a task record. The Attribute dialog box is displayed. Set Common Parameters
and Extended Parameters.
Step 4 Click OK. The automatic export configuration is complete.
----End
Issue 02 (2016-03-20)
16
U2000
Northbound Alarm File Interface Developer Guide
Prerequisites
l
Context
After automatic alarm export is enabled, it can be manually stopped at any time.
For details on setting the automatic alarm export, see 3.3.2 Setting Automatic Export of
Alarm Files.
Procedure
Step 1 Choose Maintenance > Task Management (traditional style); alternatively, double-click
System Management in Application Center and choose Task Schedule > Task
Management (application style). The Task Management window is displayed.
Step 2 Choose File Interface > Alarm/Event Log Export from the navigation tree to view task
records.
Step 3 Right-click a task record and choose Suspend from the shortcut menu. The automatic export
of alarm files is stopped.
----End
Issue 02 (2016-03-20)
17
U2000
Northbound Alarm File Interface Developer Guide
Issue 02 (2016-03-20)
18
U2000
Northbound Alarm File Interface Developer Guide
Troubleshooting
For the methods of rectifying common faults that occur during the process of obtaining alarm
data for the NMS, see Table 4-1.
Table 4-1 Troubleshooting
Common Fault
Troubleshooting Method
Information Collection
When an unusual fault occurs during the process of obtaining alarm data for the NMS, collect
relevant information for fault localization. For details about information collection, see Table
4-2.
Table 4-2 Description of information collection
Issue 02 (2016-03-20)
Related Information
Description
Operation information
Version information
IP information
19
U2000
Northbound Alarm File Interface Developer Guide
Related Information
Description
Log information
NOTE
l In an SLS system, you need to perform the
following steps only on the master server.
l In an HA or remote HA system, you need to
perform the following steps only on the
active server.
l In an ATAE cluster online remote HA
system, you need to perform the following
steps on the master server at both active site
and standby sites. In a VM cluster system,
you need to perform the following steps on
the master server at the active site.
Symptom
No alarm file exists in the export path. The NMS therefore fails to obtain alarm data of the
NEs.
Troubleshooting
The following causes can result in no file alarm being exported:
l
An NE is disconnected.
2.
Issue 02 (2016-03-20)
20
U2000
Northbound Alarm File Interface Developer Guide
$ cd /opt/oss/server
$ . ./svc_profile.sh
$ svc_adm -cmd status |grep FaultService
If the following information is displayed, the service is started.
FaultService
3.
[running
If the service is not started, run the following command to start it:
$ svc_adm -cmd startsvc FaultService
On the U2000 client, choose Topology > Main Topology (traditional style);
alternatively, double-click Topo View in Application Center and choose Topology >
Main Topology (application style). In the Main Topology window, right-click the
disconnected NE and then choose Reconnect NE.
2.
3.
Rectify the fault on the NE mediation. To reinstall the NE mediation, see the
Commissioning Guide of the corresponding U2000 networking mode.
NOTICE
Confirm the files can be deleted before clearing the disk space. Deleting a file by mistake can
result in incorrect system operation. You are advised to clear the disk space by referring to the
Administrator Guide of the corresponding U2000 networking mode.
Solution
Contact Huawei technical support.
Prerequisites
You have logged in to the master OSMU server (include the master server of active site and
standby site) as user ossuser. OSMU address: https://U2000 master server IP:31123/
Procedure
Step 1 Click NBI Management on the main page of the OSMU.
Issue 02 (2016-03-20)
21
U2000
Northbound Alarm File Interface Developer Guide
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
Prerequisites
You have logged in to the master OSMU server (include the master server of active site and
standby site) as user ossuser. OSMU address: https://U2000 master server IP:31123/
Context
For details about the configuration file of each northbound interface, see the related developer
guide.
Only the northbound performance file interface (NE-based) involves parameter
reconfiguration for slave servers. However, when you modify parameters through the OSMU,
you need to modify them only on the master server, and the slave server automatically
synchronizes the modifications.
Procedure
Step 1 Click NBI Management on the main page of the OSMU.
Step 2 Choose NBI Management > Centralized Management > Northbound Configuration
Parameters Settings. The Northbound Configuration Parameters Settings page is
displayed.
Issue 02 (2016-03-20)
22
U2000
Northbound Alarm File Interface Developer Guide
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.
Issue 02 (2016-03-20)
23
U2000
Northbound Alarm File Interface Developer Guide
The first column Configuration File Field in the following table lists default columns
exported through a file interface export task.
In Configuration File Field column, Alarm Comment field is not exported by default,
other fields are exported by default.
An alarm file interface export task can be executed to export fields both for alarms and
events. The fields exported for alarms and events are described, respectively.
Issue 02 (2016-03-20)
Description
Value
Type
(Unit:
Byte)
Value Sample
Log Serial
Number
Specifies the
serial number of
an alarm in the
alarm log.
Integer
20
21555572
Object Identity
Name
Specifies an
object identity
name.
Character
string
800
NodeB
Name=JEZ_Kaztransco
m_3G
Object Identity
Specifies a
globally unique
identity.
Character
string
300
NE=2633,NODEB=JEZ
_Kaztranscom_3G
ProductName
Specifies a
product name.
Character
string
80
Fixed Network
Narrowband
NEType
Specifies the NE
that generates an
alarm.
Character
string
800
BSC6900 GU
NE Object
Identity
Specifies an NE
FDN identity.
Character
string
300
NE=2633
24
U2000
Northbound Alarm File Interface Developer Guide
Value
Length
Configuration
File Field
Issue 02 (2016-03-20)
Description
Value
Type
(Unit:
Byte)
Value Sample
Alarm Source
Specifies the NE
that generates an
alarm.
Character
string
800
531002_Jezkazgan_H
EquipmentAlar
mSerialNumber
Specifies the
serial number of
a device where an
alarm is
generated.
Integer
20
132895
AlarmName
Specifies the
name an alarm.
Character
string
300
NodeB Unavailable
Type
Character
string
255
Running system
Severity
Specifies the
severity of an
alarm.
Character
string
255
Major
Status
Specifies the
status of an
alarm.
Character
string
255
Unacknowledged and
uncleared alarm
OccurrenceTime
Character
string
80
2014/11/24 23:27:33
GMT+06:00
Acknowledgeme
ntTime
Character
string
80
2014/11/24 23:30:09
GMT+06:00
ClearanceTime
Character
string
80
2014/11/24 23:30:09
GMT+06:00
25
U2000
Northbound Alarm File Interface Developer Guide
Value
Length
Configuration
File Field
Issue 02 (2016-03-20)
Description
Value
Type
(Unit:
Byte)
Value Sample
(UN)Acknowled
gementOperator
Character
string
200
ClearanceOperat
or
Character
string
200
LocationInforma
tion
Specifies the
information used
for fault
diagnosis.
Character
string
800
LinkFDN
Specifies a link
FDN.
Character
string
300
LinkName
Specifies a link
name.
Character
string
800
LinkType
Specifies a link
type.
Character
string
800
Alarm Identifier
Specifies whether
the alarm is an
intermittent alarm
or whether
remarks are
provided for the
alarm.
Character
string
600
(Correlative Alarm)
Alarm ID
Specifies the ID
of an alarm.
Integer
20
22214
Object Instance
Type
Specifies an
object type.
Character
string
80
NodeB
Auto Clear
Specifies whether
to automatically
clear an alarm.
Character
string
255
Yes
Alarm Clear
Type
Specifies an
alarm clearance
type.
Character
string
255
Normal clear
26
U2000
Northbound Alarm File Interface Developer Guide
Value
Length
Configuration
File Field
Value
Type
(Unit:
Byte)
Value Sample
business
Affected
Specifies whether
the service is
affected.
Integer
20
additional Text
Specifies the
information not
for locating an
alarm, but for
helping users
understand an
alarm.
Character
string
2048
arrivedUtcTime
Character
string
80
2014/11/24 23:27:32
GMT+06:00
list Id
Specifies a list
ID.
Integer
20
2743154
related LogId
Integer
20
agent ID
Specifies an
agent that
generates alarms.
Character
string
80
root Id
Specifies a root
ID.
Character
string
80
Alarm Comment
Specifies the
description for an
alarm.
Character
string
300
Specifies whether
alarms are
masked.
Character
string
80
NOTE
This field is not
exported by
default.
show Flag
Issue 02 (2016-03-20)
Description
27
U2000
Northbound Alarm File Interface Developer Guide
Configuration
Field
Issue 02 (2016-03-20)
Description
Value
Type
Value
Length
(Unit:
Byte)
Value Sample
Log Serial
Number
Specifies the
serial number of
an event in the
event log.
Integer
20
21557139
Object Identity
Name
Specifies an FDN
name (object
identity name).
Character
string
800
Object Identity
Specifies an
object identity.
Character
string
300
NE=1015,BRD=11_1_0
ProductName
Specifies a
product name.
Character
string
80
Fixed Network
Narrowband
NEType
Character
string
800
BSC6900 GSM
NE Object
Identity
Specifies an NE
FDN identity.
Character
string
300
NE=1015
Alarm Source
Specifies the NE
that generates an
event.
Character
string
800
130802_Taraz_H
EquipmentAlar
mSerialNumber
Specifies the
serial number of
a device where an
event is
generated.
Integer
20
10206
AlarmName
Specifies the
name of an event.
Character
string
300
Type
Character
string
255
Running system
Severity
Specifies the
severity of an
event.
Character
string
255
Warning
OccurrenceTime
Character
string
80
2014/11/24 23:30:09
GMT+06:00
28
U2000
Northbound Alarm File Interface Developer Guide
Configuration
Field
Issue 02 (2016-03-20)
Description
Value
Type
Value
Length
(Unit:
Byte)
Value Sample
LocationInforma
tion
Specifies the
information for
event diagnosis.
Character
string
800
LinkFDN
Specifies a link
FDN.
Character
string
300
LinkName
Specifies a link
name.
Character
string
800
LinkType
Specifies a link
type.
Character
string
800
Alarm Identifier
Specifies whether
an event is a
repeat event, or
whether remarks
are provided for
the event.
Character
string
600
(Alarm Remarks)
Alarm ID
Specifies the ID
of an event.
Integer
20
22833
Object Instance
Type
Specifies an
object type.
Character
string
80
Board
business
Affected
Specifies whether
the service is
affected.
Integer
20
additional Text
Specifies the
information not
for locating an
event, but for
helping users
understand an
event.
Character
string
2048
arrivedUtcTime
Character
string
80
2014/11/24 23:30:09
GMT+06:00
agent ID
Specifies an
agent that
generates alarms.
Character
string
80
29
U2000
Northbound Alarm File Interface Developer Guide
Configuration
Field
root Id
Value
Length
(Unit:
Byte)
Value Sample
Description
Value
Type
Specifies a root
ID.
Character
string
80
Specifies the
description for an
event.
Character
string
300
Specifies whether
events are
masked.
Character
string
80
NOTE
Generally, the
field value is
empty and does
not support root
or correlative
relationship.
Alarm Comment
NOTE
This field is not
exported by
default.
show Flag
Issue 02 (2016-03-20)
30