Documente Academic
Documente Profesional
Documente Cultură
V200R012C00
01
Date
2012-04-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 the warranty of any kind, express or implied.
Website:
http://www.huawei.com
Email:
support@huawei.com
Issue 01 (2012-04-20)
M2000
Northbound Alarm SNMP Interface Developer Guide
Purpose
This document provides information about the M2000 northbound alarm SNMP interface. The
document also provides operation guidelines for connecting the network management system
(NMS).
Related Versions
The following table lists product versions related to this document.
Product Name
Version
M2000
V200R012C00
Intended Audience
This document is intended for:
Network management engineers
Change History
01 (2012-04-20)
This issue is the first official release. Compared with issue Draft A (2012-02-10), this issue
incorporates the changes listed in the following table.
Issue 01 (2012-04-20)
ii
M2000
Northbound Alarm SNMP Interface Developer Guide
Change
Description
Added.
Modified.
Draft A (2012-02-10)
This issue is a draft.
Organization
1 Introduction to Northbound Alarm SNMP Interface
This chapter describes the position of the northbound SNMP interface, the protocols that the
northbound interface supports, and the interconnection of the northbound alarm SNMP interface.
2 Trap Configuration Information of the Northbound Alarm SNMP Interface (M2000
MIB)
This chapter describes configuration information about the alarm traps for the northbound alarm
SNMP interface. It covers the following sections: overview, real-time alarm trap, active alarm
trap, start trap for querying active alarms, end trap for querying active alarms, and heartbeat
notification trap.
3 Trap Configuration Information of the Northbound Alarm SNMP Interface (HW MIB)
The HW-IMAPV1NORTHBOUND-TRAP-MIB (HW MIB for short) is used mainly in the
management of a multi-domain network or upgrades of network management systems (NMSs).
4 Interconnection Commissioning of the Northbound Alarm SNMP Interface
Before interconnecting the NMS with the M2000, you must conduct an interconnection
commissioning. Based on the commissioning result, determine whether the northbound SNMP
interface meets the conditions for interconnecting with the NMS.
5 Troubleshooting the Northbound Alarm SNMP Interface
If a fault occurs when the NMS interconnects to the M2000 through the northbound SNMP
interface, you need to adopt proper measures to rectify the fault. This chapter describes the
process and methods for handling faults related to the northbound SNMP interface.
6 Appendix: Scripts of the Northbound Alarm SNMP Interface
This section describes the scripts provided by the northbound alarm SNMP interface.
Issue 01 (2012-04-20)
iii
M2000
Northbound Alarm SNMP Interface Developer Guide
Conventions
Symbol Conventions
The symbols that may be found in this document are defined as follows.
Symbol
Description
Indicates a hazard with a high level of risk, which if not
avoided, will result in death or serious injury.
Indicates a hazard with a medium or low level of risk, which
if not avoided, could result in minor or moderate injury.
Indicates a potentially hazardous situation, which if not
avoided, could result in equipment damage, data loss,
performance degradation, or unexpected results.
Indicates a tip that may help you solve a problem or save
time.
Provides additional information to emphasize or supplement
important points of the main text.
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 01 (2012-04-20)
Convention
Description
Boldface
Italic
[]
iv
M2000
Northbound Alarm SNMP Interface Developer Guide
Convention
Description
{ x | y | ... }
[ x | y | ... ]
{ x | y | ... }*
[ 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 01 (2012-04-20)
Action
Description
Click
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
Action
Description
Double-click
Drag
Press and hold the primary mouse button and move the
pointer to a certain position.
vi
M2000
Northbound Alarm SNMP Interface Developer Guide
Contents
Contents
About This Document.....................................................................................................................ii
1 Introduction to Northbound Alarm SNMP Interface.............................................................1
1.1 Definition of Northbound Interface....................................................................................................................3
1.2 Definition of Northbound Alarm SNMP Interface.............................................................................................3
1.3 MIB of the Northbound Alarm SNMP Interface................................................................................................4
1.4 Functions of the Northbound Alarm SNMP Interface........................................................................................5
1.4.1 Functions Supported by M2000 MIB........................................................................................................5
1.4.2 Functions Supported by HW MIB...........................................................................................................11
1.5 Security Mechanism of Northbound Alarm SNMP Interface..........................................................................12
1.6 Configuration File of the Northbound Alarm SNMP Interface........................................................................15
1.7 Mechanism for Forwarding Common Alarms..................................................................................................37
1.8 Technical Specifications of Northbound Alarm SNMP Interface....................................................................39
3 Trap Configuration Information of the Northbound Alarm SNMP Interface (HW MIB)
............................................................................................................................................................51
3.1 Active Alarm Notification Trap.......................................................................................................................52
3.2 Active Alarm Synchronization Start Trap........................................................................................................55
3.3 Active Alarm Report Trap................................................................................................................................56
3.4 Active Alarm Synchronization End Trap.........................................................................................................60
3.5 KeepAlive Info (Heartbeat) Trap......................................................................................................................61
Issue 01 (2012-04-20)
vii
M2000
Northbound Alarm SNMP Interface Developer Guide
Contents
Issue 01 (2012-04-20)
viii
M2000
Northbound Alarm SNMP Interface Developer Guide
M2000
Northbound Alarm SNMP Interface Developer Guide
This section describes the technical specifications related to the northbound alarm SNMP
interface.
Issue 01 (2012-04-20)
M2000
Northbound Alarm SNMP Interface Developer Guide
In the communication network, the M2000 provides the alarm, configuration, performance, and
inventory data of NEs to the NMS through the northbound interface.
Issue 01 (2012-04-20)
M2000
Northbound Alarm SNMP Interface Developer Guide
The M2000 northbound alarm SNMP interface receives commands issued by the NMS according
to the SNMP protocol. Then, the interface responds to the commands and sends traps to inform
the NMS.
The SNMP is an industry standard protocol that is widely used for network management. It
ensures that:
l
The administrator can search for and modify information, and locate faults at any node in
the network.
The administrator can diagnose the faults, plan the capacity, and generate reports.
Uses the polling mechanism to provide a basic function set. This ensures that the SNMP
fits small-sized, quick, and low-cost network scenarios.
M2000
Northbound Alarm SNMP Interface Developer Guide
The MIB defines the managed objects that are used by the function interfaces of the SNMP
northbound interface. The definitions determine the operations that the NMS can do and the
network management information that the NMS can obtain.
The International Organization for Standardization (ISO) assigns MIB node 2011 to Huawei
Technologies Co., Ltd.. Huawei Technologies Co., Ltd. assign MIB node 2011.2.15 to the NMS.
The NMS assigns MIB node 2 to the SNMP northbound interface. Therefore, the complete MIB
node information is:
iso(1).org(3).dod(6).internet(1).private(4).enterprises(1).iMAP(2011).products
(2).iMAPNetManagement(15).iMAPNorthbound(2)
IMAP-NORTHBOUND-MIB defines the root node information of the SNMP northbound
interface.
The SNMP northbound interface further assigns the MIB node information based on the root
node. The MIB node information is as follows:
--- iMAP(2011)
|--- products (2)
|--- iMAPNetManagement(15)
|--- iMAPNorthbound (2)
|---- iMAPNorthboundCommon(1)
|---- iMAPNorthboundFault(4)
In later sections, the following acronyms are used to describe the MIB nodes:
l
M2000 MIB: loaded for managing radio access network (RAN) and core network (CN)
devices.
M2000
Northbound Alarm SNMP Interface Developer Guide
Compliance
SNMPv1
l SNMPv1 operations
SNMP Get
SNMP Get Next
SNMP Set
l SNMPv1Trap
l SNMPv1 community-based security model
l SNMPv2c operations
SNMPv2c
SNMP Get
SNMP Get Next
SNMP Get Bulk
SNMP Set
l SNMPv2cTrap
l SNMPv2c community-based security model
l SNMPv3 operations
SNMPv3
SNMP Get
SNMP Get Next
SNMP Get Bulk
SNMP Set
l SNMPv3 Trap
l SNMPv3 user-based security model
CAUTION
SNMPv3 and the M2000 support three security levels: NoAuth and NoPriv, Auth and NoPriv,
Auth and Priv. Auth Protocol supports only MD5 and SHA.
Interface Functions
Table 1-2 lists the seven basic operations that the M2000 northbound alarm SNMP interface
provides to the NMS.
Table 1-2 Overview of the basic operations
Issue 01 (2012-04-20)
Basic Operation
Interface Function
M2000
Northbound Alarm SNMP Interface Developer Guide
Basic Operation
Interface Function
Acknowledge active
alarms
Unacknowledge
active alarms
Report heartbeat
traps
Description
Issue 01 (2012-04-20)
M2000
Northbound Alarm SNMP Interface Developer Guide
Basic Operation
Description
The active alarm query function allows the NMS to query active
alarms of NEs at any time.
Do as follows to enable the active alarm query function:
1. Modify the configuration file as M2000 administrator. For details,
see 1.6 Configuration File of the Northbound Alarm SNMP
Interface.
l Configure the IP address and port from which the NMS
receives traps.
l Set the criteria for filtering alarms by alarm severity.
2. Alarm query is triggered after the NMS sets the MIB node
iMAPNorthboundAlarmQuery to 1.
3. The NMS receives active alarms.
The NMS is not allowed to start a new query before the current
query is complete. The NMS can set iMAPNorthboundAlarmQuery to 0 to stop the current query while receiving active alarms.
Acknowledge active
alarms
Issue 01 (2012-04-20)
M2000
Northbound Alarm SNMP Interface Developer Guide
Basic Operation
Description
Unacknowledge
active alarms
The active alarm clearance function allows the NMS to clear active
alarms of NEs at any time.
Do as follows to enable the active alarm clearance function:
1. Modify the configuration file as M2000 administrator. For details,
see 1.6 Configuration File of the Northbound Alarm SNMP
Interface.
l Configure the IP address and port from which the NMS
receives traps.
l Set the criteria for filtering alarms by alarm severity.
2. Alarm clearance is triggered after the NMS sets the MIB node
iMAPNorthboundAlarmClear as the alarm serial number.
Multiple alarm serial numbers are separated by commas (,).
3. The NMS receives and clears alarms.
l If all alarms are cleared successfully, a null value is returned.
l If there are any invalid alarm serial numbers or alarm serial
numbers that are not cleared, they are returned to the NMS.
The NMS is not allowed to start a new clearance before the current
clearance is complete.
Issue 01 (2012-04-20)
M2000
Northbound Alarm SNMP Interface Developer Guide
Basic Operation
Description
Report heartbeat
traps
After configuring the IP address and port for receiving traps, the NMS
periodically receives heartbeat traps from the M2000 within the preset
heartbeat period. The heartbeat traps help the NMS learn about its
connection status with the M2000. If the NMS does not receive
heartbeat traps from the M2000 within the preset heartbeat period, its
connection with the M2000 is abnormal. If the NMS receives
heartbeat traps from the M2000 within the preset heartbeat period, its
connection with the M2000 is normal.
Do as follows to enable the heartbeat trap report function:
1. Modify the configuration file as M2000 administrator. For details,
see 1.6 Configuration File of the Northbound Alarm SNMP
Interface.
l Configure the IP address and port from which the NMS
receives traps.
l Set the heartbeat period to a value that is greater than 0. In the
configuration file, the default heartbeat period is 60 seconds.
2. The NMS receives heartbeat traps.
Issue 01 (2012-04-20)
10
M2000
Northbound Alarm SNMP Interface Developer Guide
Descripti
on
Data
Type
Index Or
Not
Access
Method
Value
Range
Restricti
on
iMAPNort
hboundHe
artbeatSvc
ReportInte
rval
Gain
access to
and
change the
leaf node
of the
heartbeat
period.
INTEGER
No
RW
3 - 3600
current
M2000
At the M2000 side, the primary functions are:
l
Reporting alarms
Reporting heartbeat
NOTE
To enable this function, set third-party NMS parameters only on the M2000 when deploying the SNMP
NBI instead of configuring the NMS. Alarm information will be received at the preset port of the NMS
server.
After receiving alarms from the equipment or the M2000, the SNMP NBI reports these alarms
to the NMS by means of standard SNMP trap messages.
The SNMP NBI periodically reports heartbeat to the NMS. Based on the heartbeat, the NMS
determines whether the connection with the SNMP NBI is proper.
Function
Description
Subscribi
ng alarms
Subscribes alarms by alarm severity and alarm category. You can set the severity
and category when deploying the SNMP NBI.
Sets the alarm field or variable binding (VB).
Issue 01 (2012-04-20)
Reporting
alarms
Reporting
heartbeat
11
M2000
Northbound Alarm SNMP Interface Developer Guide
NMS
At the NMS side, the primary functions are:
l
Acknowledging/Unacknowledging alarms
Clearing alarms
NOTE
Ensure that the NMS is connected to the SNMP NBI properly before the query function is enabled.
Function
Description
Synchronizing
alarms (querying
current alarms)
Querying alarms by
criteria
Reports alarms by alarm severity and category. The filter criteria are
specified during alarm subscription.
To query current alarms on the M2000, the NMS issues the query
begin command (value: 1) in the Set operation. After receiving the
command, the SNMP agent queries current alarms from the M2000
and reports the result to the NMS. If there are too many alarms and
the query needs to be stopped, the NMS issues the query end
command (value: 0) in the Set operation. After receiving the
command, the SNMP agent stops querying and does not report the
result to the NMS.
You can change filter criteria in real time when loading the HW MIB.
Changing filter
criteria in real time
Changes filter criteria using the Set operation when the SNMP NBI
is running.
The change will take effect without restarting the SNMP NBI.
Acknowledging/
Unacknowledging
alarms
Clearing alarms
Issue 01 (2012-04-20)
12
M2000
Northbound Alarm SNMP Interface Developer Guide
Before the Get, Get Next, or Set operation, the NMS must know the read and write
community names configured for the agent.
For trap and inform packets, the community name is the read community name configured
for the agent.
NOTE
SNMPV3
The security mechanism of SNMPv3 is user-based. In terms of security, SNMPv3 emphasizes
data security and access control and therefore offers a higher level of security than SNMPv1 and
SNMPv2c.
In data security, SNMPv3 provides protection for SNMP packets in the following ways:
l
Issue 01 (2012-04-20)
13
M2000
Northbound Alarm SNMP Interface Developer Guide
packet will be discarded. This check prevents packets from being maliciously modified and
malicious packets from being received.
In access control, the NMS performs security checks on managed objects (MOs) based on
SNMPv3.
Security Level
Table 1-5 shows security levels supported by the SNMP versions.
Table 1-5
Version
Security Level
v1
Without
authentication
and encryption
v2c
Without
authentication
and encryption
v3
Without
authentication
and encryption
v3
With
authentication
and without
encryption
With
authentication
and encryption
v3
Authenticatio
n
Community
Community
User name
MD5 or SHA
MD5 or SHA
Data
Encryption
Description
None
Uses only
community
names for
access
authentication.
None
Uses only
community
names for
access
authentication.
None
None
Uses MD5 or
SHA algorithms
for
authentication.
AES or DES
Uses MD5 or
SHA algorithms
for
authentication;
AES or DES
algorithms for
data encryption.
NOTE
Issue 01 (2012-04-20)
You can set a different user name, authentication password, and encryption password from others.
You can select any of the listed security levels, authentication algorithms, and encryption algorithms.
14
M2000
Northbound Alarm SNMP Interface Developer Guide
Overview
To configure the northbound alarm SNMP interface, modify the following items in the
configuration file:
l
SNMPv3 protocol
NMS information
Heartbeat period
Reported fields
FDN adapter
Issue 01 (2012-04-20)
Paramete
r
Path of
Configuration
Item
Description
Default
Value
Delimiter
snmpagent->MIB1>Delimiter
Space
15
M2000
Northbound Alarm SNMP Interface Developer Guide
Paramete
r
Path of
Configuration
Item
Description
Default
Value
ResIDFor
mat
snmpagent->MIB1>ResIDFormat
NOTE
This parameter applies only to HW MIB and
can be set to:
l 0: octet format. The ResourceIDs and
ObjectInstance fields are displayed in
octet format. For example,
[3145731.-1.22.8.912.1.-1.-1].
l 1: FDN format. The ResourceIDs and
ObjectInstance fields are displayed in
FDN format. For example,
[NE=312323,FR=1,S=1,CP=1,PP=4|1|
2|].
If a northbound interface compatibility ID
has been set, the M2000 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 dotted
format to name-value format. For details, see
5.7 How to Set Northbound Interface
Compatibility.
SupportX
733Alarm
snmpagent->MIB1>SupportX733Alarm
snmpagent->MIB1>KeepAliveVBOID
1.3.6.1.4.1.
2011.2.15.1
NotifyOI
D
snmpagent->MIB1>NotifyOID
snmpagent->MIB1>T2000Support
CsnType
snmpagent->MIB2>CsnType
l 0: character string.
l 1: integer.
Issue 01 (2012-04-20)
16
M2000
Northbound Alarm SNMP Interface Developer Guide
Paramete
r
Path of
Configuration
Item
Description
Default
Value
SupportC
M
snmpagent->MIB2>SupportCM
SNMPv3 Protocol
M2000The M2000 supports SNMPv1, SNMPv2c, and SNMPv3. By default, it supports
SNMPv3.
Do as follows to configure the SNMP protocol:
Modify Level, AuthProtocol, and PrivProtocol in snmpagent->v3trap.
NOTE
Table 1-7 describes the parameters for configuring the SNMPv3 protocol.
Table 1-7 Configuring the SNMPv3 protocol
Parameter
Path of
Configuration
Item
Description
Default Value
Level
snmpagent>v3trap->Level
l 1: unauthorized
and unencrypted
l 2: authorized but
unencrypted
l 3: authorized and
encrypted
AuthProtocol
snmpagent>v3trap>AuthProtocol
Sets the
authorization
protocol:
l 1: MD5 protocol
l 2: SHA protocol
Issue 01 (2012-04-20)
17
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Path of
Configuration
Item
Description
Default Value
PrivProtocol
snmpagent>v3trap>PrivProtocol
l 1: DES
encryption
protocol
l 2: AES
encryption
protocol
NOTE
The M2000 uses 127.0.0.1 as the default IP address for running the SNMP service. If the NMS requires to
use a specific IP address, perform the following operations to configure the SNMP service information.
For example, to avoid possible impact of M2000 active/standby switchovers on northbound
interconnection, use the logical IP address of an M2000 HA system to configure the SNMP service when
interconnecting the NMS with the HA system.
Description
Defa
ult
Valu
e
Agen
t_IP
snmpagent->common->Agent_IP
127.0
.0.1
snmpagent->common>Agent_Port
4700
18
M2000
Northbound Alarm SNMP Interface Developer Guide
NMS Information
The M2000 can concurrently interconnect with four NMSs.
Set the following configuration items related to each NMS:
l
Community name in v1 or v2
Encrypted password in v3
Alarm severity
Alarm category
Table 1-9 describes the parameters for configuring the NMS information and the path of the
parameters in the configuration file.
NOTE
The configuration file displays community names and passwords in ciphertext. Therefore, before setting
a community name or password, run the following commands to enable the GenerateNBPass script to
encrypt the community name or password and then set the corresponding configuration item to the
encrypted community name or password. Send the plaintext community names and passwords to the NMS
OM personnel and explain them how to use the GenerateNBPass script.
The community names and passwords must meet the following requirements:
l
The character string contains at least three of the following four character types:
l Lowercase letters
l Uppercase letters
l Arabic numerals
l Underscores (_)
Description
IPAddress
snmpagent->nmsinfo->IPAddress
Issue 01 (2012-04-20)
19
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Description
Port
snmpagent->nmsinfo->Port
Version
snmpagent->nmsinfo->Version
SNMP version.
l 1: SNMPv1
l 2: SNMPv2
l 3: SNMPv3
Read
snmpagent ->nmsinfo>community1->Read
You can set nmsinfo to nmsinfo1,
nmsinfo2, nmsinfo3, or nmsinfo4.
snmpagent ->nmsinfo>community1->Write
Write
snmpagent->nmsinfo->V3User
V3User
snmpagent->nmsinfo>AuthPassword
You can set nmsinfo to nmsinfo1,
nmsinfo2, nmsinfo3, or nmsinfo4.
PrivPassword
snmpagent->nmsinfo>PrivPassword
You can set nmsinfo to nmsinfo1,
nmsinfo2, nmsinfo3, or nmsinfo4.
Issue 01 (2012-04-20)
20
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Description
Critical
snmpagent->nmsinfo->alarmlevel>Critical
Major
snmpagent->nmsinfo->alarmlevel>Major
Minor
snmpagent->nmsinfo->alarmlevel>Minor
Warning
snmpagent->nmsinfo->alarmlevel>Warning
Event
snmpagent->nmsinfo->category>Event
Fault
snmpagent->nmsinfo->category>Fault
Issue 01 (2012-04-20)
21
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Description
Recover
snmpagent->nmsinfo->category>Recover
Acknowledge
snmpagent->nmsinfo->category>Acknowledge
You can set nmsinfo to nmsinfo1,
nmsinfo2, nmsinfo3, or nmsinfo4.
Unacknowled
ge
snmpagent->nmsinfo->category>Unacknowledge
You can set nmsinfo to nmsinfo1,
nmsinfo2, nmsinfo3, or nmsinfo4.
Change
snmpagent->nmsinfo->category>Change
NeTypeFilter
snmpagent->nmsinfo>NeTypeFilter
You can set nmsinfo to nmsinfo1,
nmsinfo2, nmsinfo3, or nmsinfo4.
Issue 01 (2012-04-20)
22
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Description
MaintenanceA
larmFilter
snmpagent->nmsinfo>MaintenanceAlarmFilter
To configure the NMS, you need to open the configuration file, delete information similar to
<!--NMS Info for SNMP V1 --> and <!-- -->, and manually configure the related
configuration items.
<!--NMS Info for SNMP V1 -->
<nmsinfo name="nmsinfo1">
<param name="IPAddress"></param>
<param name="Port"></param>
<community name="community1">
<param name="Read"></param>
<param name="Write"></param>
</community>
<param name="Version">1</param>
<alarmlevel name="alarmlevel">
<param name="Critical"></param>
<param name="Major"></param>
<param name="Minor"></param>
<param name="Warning"></param>
</alarmlevel>
<category name="category">
<param name="Event"></param>
<param name="Fault"></param>
<param name="Recover"></param>
<param name="Acknowledge"></param>
<param name="Unacknowledge"></param>
<param name="Change"></param>
</category>
<param name="NETypeFilter"></param>
<param name="MaintenanceAlarmFilter"></param>
</nmsinfo>
<!-- -->
Heartbeat Period
Table 1-10 describes the parameters for configuring the heartbeat period and the path of the
parameters in the configuration file.
Issue 01 (2012-04-20)
23
M2000
Northbound Alarm SNMP Interface Developer Guide
Path of
Configuration
Item
Description
Default Value
Interval
snmpagent>heartbeat>Interval
60
Enable
snmpagent>heartbeat>Enable
Whether to enable
heartbeat trap
reporting. When this
parameter is set to 0,
heartbeat trap
reporting is disabled.
When this parameter
is set to a non-0
value, heartbeat trap
reporting is enabled.
Lable
snmpagent>heartbeat->Lable
Identifier of
heartbeat trap
reporting.
SNMP Agent
Reported Fields
The M2000 provides the real-time alarm trap service to the NMS. If the NMS subscribes to this
service, the M2000 sends real-time alarms to the NMS in the form of traps. For details about
how to subscribe to this service, see 2.1 Real-Time Alarm Trap.
To configure real-time alarm traps, set parameters under snmpagent->MIB2->Mib in the
configuration file.
l
Issue 01 (2012-04-20)
24
M2000
Northbound Alarm SNMP Interface Developer Guide
You can set ExtendProductItemX to an integer or a character string, where X can be set to 1,
2, 3, ..15. For details, see 2.3 Start Trap for Querying Active Alarms.
Table 1-11 lists all the reported alarm fields that can be configured and the path of the related
parameters in the configuration file.
Table 1-11 Configurable reported alarm fields
Issue 01 (2012-04-20)
VB Name
Description
Csn
snmpagent->MIB2->Mib->Csn
25
M2000
Northbound Alarm SNMP Interface Developer Guide
VB Name
Description
Category
snmpagent->MIB2->Mib>Category
OccurTime
snmpagent->MIB2->Mib>OccurTime
MOName
snmpagent->MIB2->Mib>MOName
Name of a device.
snmpagent->MIB2->Mib>ProductID
ID of a product.
snmpagent->MIB2->Mib>NEType
Type of a device.
snmpagent->MIB2->Mib>NEDevID
ID of a device.
snmpagent->MIB2->Mib>DevCsn
ProductID
NEType
NEDevID
DevCsn
Issue 01 (2012-04-20)
26
M2000
Northbound Alarm SNMP Interface Developer Guide
VB Name
Description
ID
snmpagent->MIB2->Mib->ID
ID of an alarm category.
You can define multiple alarm
categories for a device type.
After you define alarm categories
for a device type, a device of the
device type can only report
alarms of the predefined alarm
categories.
Type
snmpagent->MIB2->Mib>Type
Level
snmpagent->MIB2->Mib>Level
Severity of an alarm.
This field can be set to:
l 1: Critical
l 2: Major
l 3: Minor
l 4: Warning
l 5: Indeterminate
l 6: Cleared
Restore
snmpagent->MIB2->Mib>Restore
Clearance identifier.
This field can be set to:
l 1: Cleared
l 2: Uncleared
Issue 01 (2012-04-20)
27
M2000
Northbound Alarm SNMP Interface Developer Guide
VB Name
Description
Confirm
snmpagent->MIB2->Mib>Confirm
Acknowledgment identifier.
This field can be set to:
l 1: Acknowledged
l 2: Unacknowledged
AckTime
snmpagent->MIB2->Mib>AckTime
Acknowledgment time.
snmpagent->MIB2->Mib>RestoreTime
Clearance time.
snmpagent->MIB2->Mib>Operator
Acknowledgment operator.
snmpagent->MIB2->Mib>ExtendInfo
Extended information.
snmpagent->MIB2->Mib>Probablecause
Alarm cause.
Proposedrepairactions
snmpagent->MIB2->Mib>Proposedrepairactions
Specificproblems
snmpagent->MIB2->Mib>Specificproblems
ClearOperator
snmpagent->MIB2->Mib>ClearOperator
ObjectInstanceType
snmpagent->MIB2->Mib>ObjectInstanceType
ClearCategory
snmpagent->MIB2->Mib>ClearCategory
RestoreTime
Operator
ExtendInfo
Probablecause
l Automatically Detected
Automatically Cleared
(ADAC)
l Automatically Detected
Manually Cleared (ADMC)
Issue 01 (2012-04-20)
28
M2000
Northbound Alarm SNMP Interface Developer Guide
VB Name
Description
ClearType
snmpagent->MIB2->Mib>ClearType
Issue 01 (2012-04-20)
ServiceAffectFlag
snmpagent->MIB2->Mib>ServiceAffectFlag
AdditionalInfo
snmpagent->MIB2->Mib>AdditionalInfo
ExtendProductItem1
snmpagent->MIB2->Mib>ExtendProductItem1
ExtendProductItem2
snmpagent->MIB2->Mib>ExtendProductItem2
ExtendProductItem3
snmpagent->MIB2->Mib>ExtendProductItem3
ExtendProductItem4
snmpagent->MIB2->Mib>ExtendProductItem4
ExtendProductItem5
snmpagent->MIB2->Mib>ExtendProductItem5
ExtendProductItem6
snmpagent->MIB2->Mib>ExtendProductItem6
ExtendProductItem7
snmpagent->MIB2->Mib>ExtendProductItem7
ExtendProductItem8
snmpagent->MIB2->Mib>ExtendProductItem8
ExtendProductItem9
snmpagent->MIB2->Mib>ExtendProductItem9
ExtendProductItem10
snmpagent->MIB2->Mib>ExtendProductItem10
29
M2000
Northbound Alarm SNMP Interface Developer Guide
VB Name
Description
ExtendProductItem11
snmpagent->MIB2->Mib>ExtendProductItem11
ExtendProductItem12
snmpagent->MIB2->Mib>ExtendProductItem12
ExtendProductItem13
snmpagent->MIB2->Mib>ExtendProductItem13
ExtendProductItem14
snmpagent->MIB2->Mib>ExtendProductItem14
ExtendProductItem15
snmpagent->MIB2->Mib>ExtendProductItem15
Issue 01 (2012-04-20)
30
M2000
Northbound Alarm SNMP Interface Developer Guide
Description
Default
Value
Supported
MIB
snmpagent->common>SupportedMIB
MIB2
l MIB1 indicates
message MIB. OIDs
corresponding to
HWIMAPV1NORTHB
OUND-TRAPMIB.mib are
supported.
l MIB2 indicates
distributed MIB.
OIDs corresponding
to
IMAP_NORTHBO
UND_MIB-V1.mib
and
IMAP_NORTHBO
UND_MIB-V2.mib
are supported.
Issue 01 (2012-04-20)
TrapSendI
P
snmpagent->common>TrapSendIP
127.0.0.1
TrapSendP
ort
snmpagent->common>TrapSendPort
6666
TrapSendIn
terval
snmpagent->common>TrapSendInterval
31
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Description
Default
Value
TimeForma
t
snmpagent->common>TimeFormat
l 0: UTC time
l 1: Local time without
time zone
l 2: Local time with
time zone
l 3: UTC time, which
has a different time
format compared
with the UTC time
when this parameter
is set to 0
l 4: Local time
TimeType
snmpagent->common>TimeType
l 0: UTC time
l 1: EMS time
l 2: NE time
StringSize
snmpagent->common>StringSize
Maximum length of a
character string that can
be restored in the VB.
4096
ActiveAlar
m
snmpagent->common>ActiveAlarm
Specifies to query
current alarms or active
alarms. When it is set to
0, current alarms are
queried. When it is set to
a non-0 value, active
alarms are queried.
TrapCodin
g
snmpagent->common>TrapCoding
ISO-8859-1
l UTF-8
l ISO-8859-1
l GBK
Issue 01 (2012-04-20)
32
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Description
Default
Value
SupportRo
otAlarm
snmpagent->common>SupportRootAlarm
Specifies whether to
support root alarms. This
root alarm analysis
function is valid only
after transport or access
E2E function
components are
installed.
l When it is set to 0,
root alarms are not
supported and all
alarms are reported
and queried.
l When it is set to 1,
root alarms are
supported and alarms
except correlative
alarms are reported
and queried.
PDUTrace
snmpagent->common->
PDUTrace
Specifies whether to
print PDU trace in logs.
l When it is set to 0,
PDU trace is not
printed in logs.
l When it is set to 1,
PDU trace is printed
in logs.
Issue 01 (2012-04-20)
Parameter
Description
Enable
snmpagent->inform->Enable
Default
Value
33
M2000
Northbound Alarm SNMP Interface Developer Guide
Parameter
Description
Default
Value
Timeout
snmpagent->inform>Timeout
Retries
snmpagent->inform->Retries
CacheSize
snmpagent->inform>CacheSize
10000
Issue 01 (2012-04-20)
34
M2000
Northbound Alarm SNMP Interface Developer Guide
Description
Default Value
CsnTyp
e
snmpagent->MIB2->CsnType
Specifies the
report type of
the Csn field that
identifies alarm
serial numbers.
l When it is set
to 1, alarms
are reported
in the form of
integers.
l When it is set
to a non-1
value, alarms
are reported
in the form of
character
strings.
FDN Adapter
NOTE
You do not need to configure the FDN adapter for the RTN.
In V200R012 and later releases, objects are uniquely identified by distinguished names (DNs)
instead of by full distinguished names (FDNs). DNs are represented in the format of "xxx = yyy"
and FDNs are represented in the format of dot-decimal notation. In scenarios where the
M2000 is upgraded to V200R012 or a later release, you need to enable the FDN adapter to adapt
and switch DNs back to FDNs for reporting the NEDevID field.
Table 1-15 describes the path of the parameters for configuring the FDN adapter in the
configuration file.
Issue 01 (2012-04-20)
35
M2000
Northbound Alarm SNMP Interface Developer Guide
Description
Default Value
FDNAd
apter
snmpagent->MIB2->FDNAdapter
Specifies
whether to
enable the
adaption from
DNs to FDNs.
This
configuration
item is
inapplicable to
the RTN.
l When it is set
to 0, the FDN
adapter is
disabled.
l When it is set
to a non-0
value, the
FDN adapter
is enabled.
2.
Run the following command to enable the maintenance-mode alarm report function:
If this function is disabled, the NMS cannot obtain maintenance-mode alarms from any of
the northbound alarm interfaces.
SettingTool -cmd setparam -path /imap/ifms/specialAlarmStatus/enable -value true
3.
Run the following commands to enable the maintenance-mode alarm report function over
the SNMP interface:
If this function is disabled, the NMS cannot obtain maintenance-mode alarms from the
alarm SNMP interface.
SettingTool -cmd setparam -path /imap/ifms/specialAlarmStatus/nbenable -value true
NOTE
4.
5.
Run the following command to verify that FaultService has been started:
svc_adm -cmd status | grep FaultService
If the system displays the following information, FaultService has been started:
Issue 01 (2012-04-20)
36
M2000
Northbound Alarm SNMP Interface Developer Guide
FaultService
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 1-16.
Following is an example of running the SettingTool command to forward MBTS (GU)-GSM
common alarms.
1.
Users can run the following command for not forwarding MBTS (GU)-GSM common alarms:
-bash-3.00$ SettingTool -cmd modparam -path /imap/ifms/MBTS_Filter/GU_GSM -value
no
2.
Issue 01 (2012-04-20)
Run the following command to check whether the configuration items have been modified
successfully:
Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd.
37
M2000
Northbound Alarm SNMP Interface Developer Guide
Run the following command to restart the fault service for the modification to take effect:
-bash-3.00$ svc_adm -cmd restartsvc FaultService
Issue 01 (2012-04-20)
Common Alarm
Default Value
MBTS-GSM common
alarms
/imap/ifms/MBTS_Filter/
OLD_GSM
yes
MBTS-UMTS common
alarms
/imap/ifms/MBTS_Filter/
OLD_UMTS
yes
/imap/ifms/MBTS_Filter/
OLD_LTE
yes
/imap/ifms/MBTS_Filter/
GU_GSM
yes
MBTS (GU)-UMTS
common alarms
/imap/ifms/MBTS_Filter/
GU_UMTS
yes
/imap/ifms/MBTS_Filter/
GL_GSM
yes
/imap/ifms/MBTS_Filter/
GL_LTE
yes
MBTS (UL)-UMTS
common alarms
/imap/ifms/MBTS_Filter/
UL_UMTS
yes
/imap/ifms/MBTS_Filter/
UL_LTE
yes
MBTS (GUL)-GSM
common alarms
/imap/ifms/MBTS_Filter/
GUL_GSM
yes
MBTS (GUL)-UMTS
common alarms
/imap/ifms/MBTS_Filter/
GUL_UMTS
yes
/imap/ifms/MBTS_Filter/
GUL_LTE
yes
/imap/ifms/MBTS_Filter/
WL_LTE
yes
MBTS (WL)-WiMax
common alarms
/imap/ifms/MBTS_Filter/
WL_WiMax
yes
38
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
Specification Item
Value
15
39
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
40
M2000
Northbound Alarm SNMP Interface Developer Guide
Device Information
The device information contains the following fields:
l
Issue 01 (2012-04-20)
41
M2000
Northbound Alarm SNMP Interface Developer Guide
Alarm Information
The alarm information contains the iMAPNorthboundAlarmID field, which is described as
follows:
iMAPNorthboundAlarmID: ID of an alarm category. You can define multiple alarm categories
for a device type. After you define alarm categories for a device type, a device of the device type
can only report alarms of the predefined alarm categories. Figure 2-3 shows the mapping
between device types and alarm categories. An alarm category is uniquely identified by the fields
product ID, device type, and alarm ID. Using the three fields, the NMS determines the alarm
category to which a received alarm belongs.
Figure 2-3 Mapping between device types and alarm categories
Issue 01 (2012-04-20)
42
M2000
Northbound Alarm SNMP Interface Developer Guide
6: Software system
7: Running system
8: Communication system
9: QoS
10: Processing error
11: OMC
12: Integrity violation
13: Operational violation
14: Physical violation
15: Security service or mechanism violation
16: Time domain violation
l
Issue 01 (2012-04-20)
43
M2000
Northbound Alarm SNMP Interface Developer Guide
Additional Information
The additional information contains the following fields:
l
Reserved Fields
The reserved fields are as follows:
l
iMAPNorthboundAlarmParas1
iMAPNorthboundAlarmParas2
iMAPNorthboundAlarmParas3
iMAPNorthboundAlarmParas4
iMAPNorthboundAlarmParas5
iMAPNorthboundAlarmParas6
iMAPNorthboundAlarmParas7
iMAPNorthboundAlarmParas8
iMAPNorthboundAlarmParas9
iMAPNorthboundAlarmParas10
44
M2000
Northbound Alarm SNMP Interface Developer Guide
NOTE
The same data types when the v2c or v3 protocol is used for interconnection are not described.
OID
Type
Description
iMAPNorthbou
ndAlarmCSN
x.1
OCTET STRING
iMAPNorthbou
ndAlarmCatego
ry
x.2
OCTET STRING
Issue 01 (2012-04-20)
iMAPNorthbou
ndAlarmOccur
Time
x.3
OCTET STRING
iMAPNorthbou
ndAlarmMONa
me
x.4
OCTET STRING
Name of a device.
iMAPNorthbou
ndAlarmProduc
tID
x.5
INTEGER
ID of product series.
iMAPNorthbou
ndAlarmNETyp
e
x.6
OCTET STRING
iMAPNorthbou
ndAlarmNEDev
ID
x.7
OCTET STRING
iMAPNorthbou
ndAlarmDevCs
n
x.8
OCTET STRING
iMAPNorthbou
ndAlarmID
x.9
INTEGER
(Integer32)
45
M2000
Northbound Alarm SNMP Interface Developer Guide
Name
OID
Type
Description
iMAPNorthbou
ndAlarmType
x.10
INTEGER
(Integer32)
iMAPNorthbou
ndAlarmLevel
x.11
INTEGER
iMAPNorthbou
ndAlarmRestor
e
x.12
iMAPNorthbou
ndAlarmConfir
m
x.13
INTEGER
INTEGER
Issue 01 (2012-04-20)
iMAPNorthbou
ndAlarmAckTi
me
x.14
OCTET STRING
iMAPNorthbou
ndAlarmRestor
eTime
x.15
OCTET STRING
46
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
Name
OID
Type
Description
iMAPNorthbou
ndAlarmOperat
or
x.16
OCTET STRING
iMAPNorthbou
ndAlarmParas1
x.17
INTEGER
(Integer32)
Reserved field 1.
iMAPNorthbou
ndAlarmParas2
x.18
INTEGER
(Integer32)
Reserved field 2.
iMAPNorthbou
ndAlarmParas3
x.19
INTEGER
(Integer32)
Reserved field 3.
iMAPNorthbou
ndAlarmParas4
x.20
INTEGER
(Integer32)
Reserved field 4.
iMAPNorthbou
ndAlarmParas5
x.21
INTEGER
(Integer32)
Reserved field 5.
iMAPNorthbou
ndAlarmParas6
x.22
INTEGER
(Integer32)
Reserved field 6.
iMAPNorthbou
ndAlarmParas7
x.23
INTEGER
(Integer32)
Reserved field 7.
iMAPNorthbou
ndAlarmParas8
x.24
INTEGER
(Integer32)
Reserved field 8.
iMAPNorthbou
ndAlarmParas9
x.25
INTEGER
(Integer32)
Reserved field 9.
iMAPNorthbou
ndAlarmParas1
0
x.26
INTEGER
(Integer32)
iMAPNorthbou
ndAlarmExtend
Info
x.27
OCTET STRING
iMAPNorthbou
ndAlarmProbab
lecause
x.28
OCTET STRING
Cause of an alarm.
iMAPNorthbou
ndAlarmPropos
edrepairactions
x.29
OCTET STRING
iMAPNorthbou
ndAlarmSpecifi
cproblems
x.30
OCTET STRING
iMAPNorthbou
ndAlarmClearO
perator
x.46
OCTET STRING
47
M2000
Northbound Alarm SNMP Interface Developer Guide
Name
OID
Type
Description
iMAPNorthbou
ndAlarmClearC
ategory
x.48
OCTET STRING
iMAPNorthbou
ndAlarmClearT
ype
x.49
OCTET STRING
iMAPNorthbou
ndAlarmServiceAffectFlag
x.50
iMAPNorthbou
ndAlarmAddio
nalInfo
x.51
OCTET STRING
OCTET STRING
Additional information.
48
M2000
Northbound Alarm SNMP Interface Developer Guide
The fields of the active alarm trap are the same as those of the real-time alarm trap. For details,
see 2.1.2 Fields in the Real-Time Alarm Trap.
Description
The M2000 notifies the NMS that it starts sending the queried active alarms. After the NMS
receives the start trap, the query starts.
Prerequisites
The NMS triggers the query.
Trap Definition
OID= 1.3.6.1.4.1.2011.2.15.2.4.3.3.0.2
Field List
None.
Description
The M2000 notifies the NMS that it stops sending the queried active alarms. After the NMS
receives the end trap, the query ends.
Prerequisites
The NMS triggers the stop of the query, or the query ends after the NMS receives active alarms.
Trap Definition
OID= 1.3.6.1.4.1.2011.2.15.2.4.3.3.0.4
Issue 01 (2012-04-20)
49
M2000
Northbound Alarm SNMP Interface Developer Guide
Field List
None.
Description
The M2000 regularly sends a heartbeat notification trap to the NMS. If the NMS receives a
heartbeat notification trap within a heartbeat period, the connection between the NMS and
M2000 is normal. If the trap is not received, the NMS and M2000 are disconnected.
Prerequisites
The M2000 regularly sends a heartbeat notification trap to the NMS in the preset period.
Trap Definition
OID= 1.3.6.1.4.1.2011.2.15.2.1.2.1.1.1.0.5
Field List
In Table 2-2, by default, the field types are those used for the connection with SNMPv1. For
SNMPv2c or SNMPv3, the same data types are not introduced again. Different data types are
noted in brackets.
Table 2-2 Fields of iMAPNorthboundHeartbeatNotificationType
Issue 01 (2012-04-20)
Name
OID
Type
Description
iMAPNorthbo
undHeartbeatS
ystemLabel
1.3.6.1.4.1.2011.2.15.2.1.2.1.1.1.1
OCTET
STRING
M2000 system
ID
iMAPNorthbo
undHeartbeatP
eriod
1.3.6.1.4.1.2011.2.15.2.1.2.1.1.1.2
INTEGER
(Integer32)
Heartbeat
period in
seconds (must
be greater than
0, and the
maximum is
3600).
iMAPNorthbo
undHeartbeatT
imeStamp
1.3.6.1.4.1.2011.2.15.2.1.2.1.1.1.3
OCTET
STRING
Timestamp, the
time when the
heartbeat
notification trap
is generated.
50
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
51
M2000
Northbound Alarm SNMP Interface Developer Guide
Trigger Condition
Alarms generated on NEs or the M2000 trigger the sending of active alarm notification traps
through the SNMP NBI.
Definition
Name
Enterprise
Type
Description
hwNmNorthboundE
ventNotify
hwNmNorthboundE
ventInfo
Trap/Inform
VB List
In the following table, listed data types are for SNMPv1. Most of these data types are applicable
to SNMPv2c or SNMPv3. For any differences, details will be described in brackets.
NOTE
Bound variables (VBs) are the same for active alarm notification and report traps. Active alarm notification
traps are automatically sent by the M2000 while active alarm report traps are responses to the query of
active alarms from the OSS.
Additional VB are not reported by default. Additional VBs range from
hwNmNorthboundsAdditionalVB1 to hwNmNorthboundsAdditionalVB8.
VB
OID
Data
Type
Description
hwNmNorthboundNEName
1.3.6.1.4.1.2011.2.
15.1.7.1.1
Octet
string
hwNmNorthboundNEType
1.3.6.1.4.1.2011.2.
15.1.7.1.2
Octet
string
hwNmNorthboundObjectInstance
1.3.6.1.4.1.2011.2.
15.1.7.1.3
Octet
string
Issue 01 (2012-04-20)
52
M2000
Northbound Alarm SNMP Interface Developer Guide
VB
OID
Data
Type
Description
hwNmNorthbound
EventType
1.3.6.1.4.1.2011.2.
15.1.7.1.4
Octet
string
hwNmNorthbound
EventTime
1.3.6.1.4.1.2011.2.
15.1.7.1.5
Octet
string
hwNmNorthboundProbableCause
1.3.6.1.4.1.2011.2.
15.1.7.1.6
Octet
string
hwNmNorthboundSeverity
1.3.6.1.4.1.2011.2.
15.1.7.1.7
Octet
string
Issue 01 (2012-04-20)
hwNmNorthbound
EventDetail
1.3.6.1.4.1.2011.2.
15.1.7.1.8
Octet
string
hwNmNorthboundAdditionalInfo
1.3.6.1.4.1.2011.2.
15.1.7.1.9
Octet
string
53
M2000
Northbound Alarm SNMP Interface Developer Guide
VB
OID
Data
Type
Description
hwNmNorthboundFaultFlag
1.3.6.1.4.1.2011.2.
15.1.7.1.10
Octet
string
hwNmNorthboundFaultFunction
1.3.6.1.4.1.2011.2.
15.1.7.1.11
Octet
string
Issue 01 (2012-04-20)
hwNmNorthboundDeviceIP
1.3.6.1.4.1.2011.2.
15.1.7.1.12
IP address
hwNmNorthboundSerialNo
1.3.6.1.4.1.2011.2.
15.1.7.1.13
Integer
hwNmNorthboundProbableRepair
1.3.6.1.4.1.2011.2.
15.1.7.1.14
Octet
string
hwNmNorthboundResourceIDs
1.3.6.1.4.1.2011.2.
15.1.7.1.15
Octet
string
hwNmNorthboundsAdditionalVB1
1.3.6.1.4.1.2011.2.
15.1.7.1.16
Octet
string
hwNmNorthboundsAdditionalVB2
1.3.6.1.4.1.2011.2.
15.1.7.1.17
Octet
string
hwNmNorthboundsAdditionalVB3
1.3.6.1.4.1.2011.2.
15.1.7.1.18
Octet
string
hwNmNorthboundsAdditionalVB4
1.3.6.1.4.1.2011.2.
15.1.7.1.19
Octet
string
hwNmNorthboundsAdditionalVB5
1.3.6.1.4.1.2011.2.
15.1.7.1.20
Octet
string
54
M2000
Northbound Alarm SNMP Interface Developer Guide
VB
OID
Data
Type
Description
hwNmNorthboundsAdditionalVB6
1.3.6.1.4.1.2011.2.
15.1.7.1.21
Octet
string
hwNmNorthboundsAdditionalVB7
1.3.6.1.4.1.2011.2.
15.1.7.1.22
Octet
string
hwNmNorthboundsAdditionalVB8
1.3.6.1.4.1.2011.2.
15.1.7.1.23
Octet
string
hwNmNorthbound
EventName
1.3.6.1.4.1.2011.2.
15.1.7.1.24
Octet
string
hwNmNorthboundReasonID
1.3.6.1.4.1.2011.2.
15.1.7.1.25
Integer
hwNmNorthboundFaultID
1.3.6.1.4.1.2011.2.
15.1.7.1.26
Integer
hwNmNorthboundDeviceType
1.3.6.1.4.1.2011.2.
15.1.7.1.27
Octet
string
hwNmNorthboundTrailName
1.3.6.1.4.1.2011.2.
15.1.7.1.28
Octet
string
hwNmNorthboundRootAlarm
1.3.6.1.4.1.2011.2.
15.1.7.1.29
Integer
hwNmNorthboundGroupID
1.3.6.1.4.1.2011.2.
15.1.7.1.30
Integer
hwNmNorthboundMaintainStatus
1.3.6.1.4.1.2011.2.
15.1.7.1.31
Integer
Trigger Condition
The OSS triggers the alarm synchronization.
The OSS performs the operation hwNmNorthboundEventSynchronizationCommandStart
in the following format:
NMS IP:port:start time:end time
Issue 01 (2012-04-20)
55
M2000
Northbound Alarm SNMP Interface Developer Guide
NOTE
Definition
Name
Enterprise
Type
Description
hwNmNorthboundE
ventSynchronizationStartNotify
hwNmNorthboundE
ventSynchronizationStart
Trap/Inform
VB List
N/A
Trigger Condition
The OSS triggers the synchronization.
The OSS performs the operation hwNmNorthboundEventSynchronizationCommandStart
in the following format:
NMS IP:port:start time:end time
NOTE
Definition
Issue 01 (2012-04-20)
Name
Enterprise
Type
Description
hwNmNorthboundE
ventSynchronizationQueryResultNotify
hwNmNorthboundE
ventSynchronizationQueryResult
Trap/Inform
Indicates the
synchronization
result or required
alarms.
56
M2000
Northbound Alarm SNMP Interface Developer Guide
VB List
In the following table, listed data types are for SNMPv1. Most of these data types are applicable
to SNMPv2c or SNMPv3. For any differences, details will be described in brackets.
NOTE
Bound variables (VBs) are the same for active alarm notification and report traps. Active alarm notification
traps are automatically sent by the M2000 while active alarm report traps are responses to the query of
active alarms from the OSS.
Additional VB are not reported by default. Additional VBs range from
hwNmNorthboundsAdditionalVB1 to hwNmNorthboundsAdditionalVB8.
VB
OID
Data
Type
Description
hwNmNorthboundNEName
1.3.6.1.4.1.2011.2.
15.1.7.1.1
Octet
string
hwNmNorthboundNEType
1.3.6.1.4.1.2011.2.
15.1.7.1.2
Octet
string
hwNmNorthboundObjectInstance
1.3.6.1.4.1.2011.2.
15.1.7.1.3
Octet
string
hwNmNorthbound
EventType
1.3.6.1.4.1.2011.2.
15.1.7.1.4
Octet
string
Issue 01 (2012-04-20)
57
M2000
Northbound Alarm SNMP Interface Developer Guide
VB
OID
Data
Type
Description
hwNmNorthbound
EventTime
1.3.6.1.4.1.2011.2.
15.1.7.1.5
Octet
string
hwNmNorthboundProbableCause
1.3.6.1.4.1.2011.2.
15.1.7.1.6
Octet
string
hwNmNorthboundSeverity
1.3.6.1.4.1.2011.2.
15.1.7.1.7
Octet
string
hwNmNorthbound
EventDetail
1.3.6.1.4.1.2011.2.
15.1.7.1.8
Octet
string
hwNmNorthboundAdditionalInfo
1.3.6.1.4.1.2011.2.
15.1.7.1.9
Octet
string
hwNmNorthboundFaultFlag
1.3.6.1.4.1.2011.2.
15.1.7.1.10
Octet
string
Issue 01 (2012-04-20)
58
M2000
Northbound Alarm SNMP Interface Developer Guide
VB
OID
Data
Type
Description
hwNmNorthboundFaultFunction
1.3.6.1.4.1.2011.2.
15.1.7.1.11
Octet
string
Issue 01 (2012-04-20)
hwNmNorthboundDeviceIP
1.3.6.1.4.1.2011.2.
15.1.7.1.12
IP address
hwNmNorthboundSerialNo
1.3.6.1.4.1.2011.2.
15.1.7.1.13
Integer
hwNmNorthboundProbableRepair
1.3.6.1.4.1.2011.2.
15.1.7.1.14
Octet
string
hwNmNorthboundResourceIDs
1.3.6.1.4.1.2011.2.
15.1.7.1.15
Octet
string
hwNmNorthboundsAdditionalVB1
1.3.6.1.4.1.2011.2.
15.1.7.1.16
Octet
string
hwNmNorthboundsAdditionalVB2
1.3.6.1.4.1.2011.2.
15.1.7.1.17
Octet
string
hwNmNorthboundsAdditionalVB3
1.3.6.1.4.1.2011.2.
15.1.7.1.18
Octet
string
hwNmNorthboundsAdditionalVB4
1.3.6.1.4.1.2011.2.
15.1.7.1.19
Octet
string
hwNmNorthboundsAdditionalVB5
1.3.6.1.4.1.2011.2.
15.1.7.1.20
Octet
string
hwNmNorthboundsAdditionalVB6
1.3.6.1.4.1.2011.2.
15.1.7.1.21
Octet
string
hwNmNorthboundsAdditionalVB7
1.3.6.1.4.1.2011.2.
15.1.7.1.22
Octet
string
hwNmNorthboundsAdditionalVB8
1.3.6.1.4.1.2011.2.
15.1.7.1.23
Octet
string
59
M2000
Northbound Alarm SNMP Interface Developer Guide
VB
OID
Data
Type
Description
hwNmNorthbound
EventName
1.3.6.1.4.1.2011.2.
15.1.7.1.24
Octet
string
hwNmNorthboundReasonID
1.3.6.1.4.1.2011.2.
15.1.7.1.25
Integer
hwNmNorthboundFaultID
1.3.6.1.4.1.2011.2.
15.1.7.1.26
Integer
hwNmNorthboundDeviceType
1.3.6.1.4.1.2011.2.
15.1.7.1.27
Octet
string
hwNmNorthboundTrailName
1.3.6.1.4.1.2011.2.
15.1.7.1.28
Octet
string
hwNmNorthboundRootAlarm
1.3.6.1.4.1.2011.2.
15.1.7.1.29
Integer
hwNmNorthboundGroupID
1.3.6.1.4.1.2011.2.
15.1.7.1.30
Integer
hwNmNorthboundMaintainStatus
1.3.6.1.4.1.2011.2.
15.1.7.1.31
Integer
Trigger Condition
Active alarm synchronization end traps are triggered when:
l
All required alarms have been reported to the OSS in trap packets.
NMS IP:port refers to the IP address and port of the OSS server.
Issue 01 (2012-04-20)
60
M2000
Northbound Alarm SNMP Interface Developer Guide
Definition
Name
Enterprise
Type
Description
hwNmNorthboundE
ventSynchronizationEndNotify
hwNmNorthboundE
ventSynchronizationEnd
Trap/Inform
VB List
In the following table, listed data types for interconnection using the SNMPv1 protocol. Most
of these data types are applicable to the SNMPv2c and SNMPv3 protocols. For any differences,
details will be described in brackets.
VB
OID
Data
Type
Description
hwNmNorthbound
EventSynchronizationEndStatus
1.3.6.1.4.1.2011.2.
15.1.7.7.3.1
Integer
hwNmNorthbound
EventSynchronizationEndStatusDetail
1.3.6.1.4.1.2011.2.
15.1.7.7.3.2
Octet
string
The range is from 3 to 300 seconds and the default value is 60.
Issue 01 (2012-04-20)
61
M2000
Northbound Alarm SNMP Interface Developer Guide
Condition
The M2000 sends the keepAlive info (heartbeat) trap to the NMS/OSS regularly in the preset
period.
Trap Definition
Name
ENTERPRISE
Type
Description
hwNmNorthboundE
ventKeepAlive
hwNmNorthboundE
ventKeepAliveInfo
Trap/Inform
Field List
In the following table, by default, the field types are those used for the connection with SNMPv1.
For SNMPv2c or SNMPv3, the same data types will not be introduced again. Different data
types are remarked in brackets.
Issue 01 (2012-04-20)
Name
OID
Data Type
Descriptio
n
hwNmNorthboundKeepAlive
1.3.6.1.4.1.2011.2.15.1.7.2.1
OCTET STRING
Notification
for the Keep
Alive traps.
62
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
63
M2000
Northbound Alarm SNMP Interface Developer Guide
Description
Issue 01 (2012-04-20)
64
M2000
Northbound Alarm SNMP Interface Developer Guide
2.
Choose License > OSS License Management > License Information. The License
Information window is displayed.
3.
Click the Resource Control Item tab. If Resource contains Alarm SNMP Interface, the
NMS is authorized to use the SNMP interface.
Prerequisites
You have logged in to the M2000 server as user root or ossuser.
Context
l
CAUTION
In an SLS system, you need to perform the following steps only on the master server and do not
need to perform them on the slave or standby server. In an HA or remote HA system, you need
to perform the following steps only on the active server and do not need to perform them on the
standby server.
Issue 01 (2012-04-20)
65
M2000
Northbound Alarm SNMP Interface Developer Guide
Procedure
Step 1 Go to the M2000 installation directory.
The default installation directory is /opt/oss/server.
By default, run the following command:
# cd /opt/oss/server
Step 2 Stop the northbound alarm SNMP interface service.
# . ./svc_profile.sh
# svc_adm -cmd stopsvc SnmpAgent
Step 3 Verify that the MIB type that interconnects with the NMS is MIB2.
1.
Run the following commands to check whether the MIB type that interconnects with the
NMS is MIB2:
# . /opt/oss/server/svc_profile.sh
# cd /opt/oss/server/nbi/snmp/conf
# cat snmpagent.xml
If the command output contains <param name="SupportedMIB">MIB2</param>, go to
Step 4. Otherwise, proceed to Step 3.2 and Step 3.3 to modify the MIB type.
2.
Run the following commands to set SupportedMIB to MIB2 in the configuration file:
# . /opt/oss/server/svc_profile.sh
# cd /opt/oss/server/nbi/snmp/conf
# vi snmpagent.xml
Change <param name="SupportedMIB">MIB1</param> to <param
name="SupportedMIB">MIB2</param>.
For details, see #sec.
3.
Press Esc. Then, run the :wq command to save the modification and exit the vi editor.
Step 4 Determine the SNMP version that interconnects with the NMS. Then set the SNMP version in
the configuration file to the interconnected version.
For details, see SNMP protocol configuration in 1.6 Configuration File of the Northbound
Alarm SNMP Interface.
Step 5 Configure the NMS parameters, including the IP address, port, security user name, and criteria
for filtering alarms by severity.
If you use SNMPv3 to interconnect with the NMS, you need to use the GenerateNBPass tool to
generate the authentication password first, and then add the password to the configuration file.
If your use SNMPv1 or SNMPv2c, you do not need to change the authentication password in
the configuration file.
The security user name of each NMS must be unique. For details, see NMS information
configuration in 1.6 Configuration File of the Northbound Alarm SNMP Interface.
Step 6 Configure the heartbeat period.
Issue 01 (2012-04-20)
66
M2000
Northbound Alarm SNMP Interface Developer Guide
For details, see heartbeat period configuration in 1.6 Configuration File of the Northbound
Alarm SNMP Interface.
Step 7 Configure the reported field in traps.
For details, see the configuration of reported fields in 1.6 Configuration File of the Northbound
Alarm SNMP Interface.
Step 8 Configure the report time type.
For details, see the configuration of report time types in 1.6 Configuration File of the
Northbound Alarm SNMP Interface.
Step 9 Start the northbound alarm SNMP interface service.
# svc_adm -cmd startsvc SnmpAgent
Step 10 The NMS receives traps and heartbeat notifications using the configured IP address and port.
Step 11 The NMS triggers the leaf node iMAPNorthboundAlarmQuery of the northbound alarm SNMP
interface when the NMS needs to query active alarms.
For details about how to set this leaf node, see 1.6 Configuration File of the Northbound
Alarm SNMP Interface.
Step 12 The NMS triggers the leaf node iMAPNorthboundAlarmAcknowledge of the northbound alarm
SNMP interface when the NMS needs to acknowledge active alarms.
For details about how to set this leaf node, see 1.4.1 Functions Supported by M2000 MIB.
Step 13 The NMS triggers the leaf node iMAPNorthboundAlarmUnAcknowledge of the northbound
alarm SNMP interface when the NMS needs to unacknowledge active alarms.
For details about how to set this leaf node, see 1.4.1 Functions Supported by M2000 MIB.
Step 14 The NMS triggers the leaf node iMAPNorthboundAlarmClear of the northbound alarm SNMP
interface when the NMS needs to clear active alarms.
For details about how to set this leaf node, see 1.4.1 Functions Supported by M2000 MIB.
----End
Example
1.
2.
3.
Enter the IP address and port for interconnecting with the NMS. Configure the version of
the SNMP protocol to be used. Retain the default values for the other parameters.
For details, see NMS information configuration in 1.6 Configuration File of the
Northbound Alarm SNMP Interface.
4.
5.
Issue 01 (2012-04-20)
67
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
68
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
69
M2000
Northbound Alarm SNMP Interface Developer Guide
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.
5.8 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 01 (2012-04-20)
70
M2000
Northbound Alarm SNMP Interface Developer Guide
Troubleshooting
For the methods of handling common faults that may occur during the process of obtaining alarm
data for the NMS, see Table 5-1.
Table 5-1 Troubleshooting
Common Fault
Troubleshooting Method
Information Collection
If the fault that occurs when the NMS attempts to obtain data through the northbound SNMP
interface is not listed in Table 5-1, you need to collect the fault information to locate the fault.
For details, see Table 5-2.
Issue 01 (2012-04-20)
71
M2000
Northbound Alarm SNMP Interface Developer Guide
Description
Operation information
Version information
IP information
Log information
NOTE
In an SLS system, you need to perform the following steps only on
the master server and do not need to perform them on the slave or
standby server. In an HA or remote HA system, you need to perform
the following steps only on the active server and do not need to
perform them on the standby server.
Description
The northbound alarm SNMP interface service does not start after the M2000 starts.
Run the following commands:
# cd /opt/oss/server
# . ./svc_profile.sh
# svc_adm -cmd status | grep SnmpAgent
If the following information is displayed, the SnmpAgent service does not start:
SnmpAgent
Issue 01 (2012-04-20)
[not running
72
M2000
Northbound Alarm SNMP Interface Developer Guide
Possible Cause
The M2000 fault service has not started.
Solution
The northbound alarm SNMP interface service depends on the M2000 fault service. Before
starting the northbound alarm SNMP interface service, ensure that the fault service has started.
Run the command # svc_adm -cmd startsvc SnmpAgent to start the fault service and then
the northbound alarm SNMP interface service.
Symptom
After some configuration items are modified, the SNMP northbound interface does not function
according to the new settings.
Possible Cause
After modifying or adding parameter values by running the SettingTool command, you did not
run the command for restarting the northbound alarm SNMP interface services.
Solution
After modifying the configuration items, run the following command to restart the northbound
alarm SNMP interface services:
# svc_adm -cmd restartsvc SnmpAgent
For details about the settings of the SNMP interface configuration items, see 1.6 Configuration
File of the Northbound Alarm SNMP Interface.
Description
The number of VB fields in the reported alarm trap is smaller than that configured in the
configuration file, or some configured reported fields do not appear in the trap report.
Issue 01 (2012-04-20)
73
M2000
Northbound Alarm SNMP Interface Developer Guide
Possible Cause
The field names are wrong.
Solution
Take care to choose alarm field names that can be configured. Follow the specified case
(uppercase or lowercase) to type the field names in the report field in the configuration file.
Description
The SNMP log file is not found in the specified folder.
Possible Cause
l
Ensure that you can access the folder where you create the log file.
Solution
Description
Part of the northbound user password is repeated, for example, 123123123. However, if 123 is
used to access the SNMP northbound interface, the partial password can pass the SNMP
authentication.
Possible Cause
The SNMP encryption algorithm stipulates that:
If the length of a password is shorter than that stipulated by the algorithm, the system
automatically adds the password repeatedly to form a new password to meet the requirement of
the algorithm.
Issue 01 (2012-04-20)
74
M2000
Northbound Alarm SNMP Interface Developer Guide
Solution
l
Prerequisites
You have logged in to the OSMU as user ossuser.
Context
For details about northbound interface changes, see the Huawei PCN M2000-20110001
(M2000 V200R012 Northbound Interface Changes).
Procedure
Step 1 Click NBI Management on the main page of the OSMU.
Step 2 In the navigation tree of the left pane, choose Service Configuration > Northbound Interface
Compatibility Settings. The Northbound Interface Compatibility Settings tab page is
displayed.
Step 3 View the current FDN format and OMC ID settings of each northbound interface.
Step 4 Set the FDN format and OMC ID for each northbound interface based on operator requirements.
NOTE
You can reset the FDN format and OMC ID only after you have discussed with operators and the operators
have agreed such settings.
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
Follow-up Procedure
If the system displays a message stating that the related services fail to restart, these services do
not exist or there are other services being restarted. When this occurs, log in to the M2000 server
to install or manually restart the related services.
Issue 01 (2012-04-20)
75
M2000
Northbound Alarm SNMP Interface Developer Guide
Prerequisites
You have logged in to the OSMU as user ossuser.
Context
For details about the configuration file of each northbound interface, see the related developer
guide.
The OSMU does not support the SLS system. You can use commands to modify the
configuration parameters of the slave server in an SLS system.
Procedure
Step 1 Click NBI Management on the main page of the OSMU.
Step 2 Choose Service Configuration > Set Northbound Configuration Parameters. The Set
Northbound Configuration Parameters 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
You can click Reset to restore the modified parameters to their previous values.
Issue 01 (2012-04-20)
76
M2000
Northbound Alarm SNMP Interface Developer Guide
Issue 01 (2012-04-20)
Script
File path
Function
GenerateNBPass
/opt/oss/server/nbi/snmp/
bin
NBIPostInstall.sh
/opt/oss/server/nbi/snmp/
bin
create_snmp_table.sh
/opt/oss/server/nbi/snmp/
init
77