Huawei ESight Northbound SNMP Interface User Reference (V200R002C00 - 01)

Huawei eSight
V200R002C00
Northbound SNMP Interface
User Reference

Issue 01
Date 2011-12-16

HUAWEI TECHNOLOGIES CO., LTD.

Issue 01 (2011-12-16) Huawei Proprietary and Confidential
Copyright Huawei Technologies Co., Ltd.
i

Copyright Huawei Technologies Co., Ltd. 2011. All rights reserved.
No part of this document may be reproduced or transmitted in any form or by any means without prior
written consent of Huawei Technologies Co., Ltd.

Trademarks and Permissions
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.

Notice
The purchased products, services and features are stipulated by the contract made between Huawei and
the customer. All or part of the products, services and features described in this document may not be
within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements,
information, and recommendations in this document are provided "AS IS" without warranties, guarantees or
representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute the warranty of any kind, express or implied.

Huawei Technologies Co., Ltd.
Address: Huawei Industrial Base
Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website: http://www.huawei.com
Email: support@huawei.com

Huawei eSight
Northbound SNMP Interface User Reference About This Document

ii

About This Document
Purpose
This document introduces the northbound Simple Network Management Protocol (SNMP)
interfaces basic concept, principle and deployment, maintenance and operation. And
providing the interface description for OSS system, SNMP alarm interface, field descriptions
and terms and acronyms.
This document to guide the user to understand eSight north to the SNMP interface of the basic
operation.
This document is intended for:

Policy planning engineers

Installation and commissioning engineers

NM configuration engineers

Technical support engineers
Change History
None of change.
Issue 01 (2011-12-16)
This issue is used for first office application (FOA).

Huawei eSight
Northbound SNMP Interface User Reference Contents

iii

Contents
About This Document .................................................................................................................... ii
1 Interface Description .................................................................................................................... 1
1.1 Location ........................................................................................................................................................... 1
1.2 SNMP ............................................................................................................................................................... 2
1.2.1 What is SNMP ........................................................................................................................................ 2
1.2.2 SNMP Structure ...................................................................................................................................... 3
1.3 Supported SNMP Protocols .............................................................................................................................. 3
2 MIB Reference ............................................................................................................................... 5
2.1 Overview for Northbound MIB Files ............................................................................................................... 5
2.2 Overview for Northbound MIB Structure ........................................................................................................ 6
2.3 MIB Object for Common Management (iMAPNorthboundCommon) ............................................................ 8
2.3.1 Structure .................................................................................................................................................. 8
2.3.2 Description .............................................................................................................................................. 9
2.4 MIB Object for Fault Management (IMAPNorthboundFault) ....................................................................... 11
2.4.1 Structure ................................................................................................................................................ 11
2.4.2 Description ............................................................................................................................................ 11
2.5 MIB Object for Device Information (hwIMAPNorthboundDeviceinfo) ....................................................... 21
2.5.1 Structure ................................................................................................................................................ 21
2.5.2 Description ............................................................................................................................................ 21
3 Configure Northbound SNMP Interface ................................................................................ 24
3.1 Configure the Northbound SNMP interface ................................................................................................... 24
3.2 Deploy the Northbound SNMP interface ....................................................................................................... 24
3.2.1 Configure the Northbound File ............................................................................................................. 24
3.3 The Northbound File description.................................................................................................................... 25
3.3.1 GeneralConfig Paramter Description .................................................................................................... 25
3.3.2 SnmpConfig Paramter Description ....................................................................................................... 25
3.3.3 UserInfo Paramter Description ............................................................................................................. 28
3.3.4 AlarmReportPolicy Paramter Description ............................................................................................. 33
3.3.5 AlarmFields Paramter Description ........................................................................................................ 34
4 Acronyms and Abbreviations ................................................................................................... 40

Huawei eSight
Northbound SNMP Interface User Reference 1 Interface Description

1

1 Interface Description
Overview
The eSight supports the following northbound Simple Network Management Protocols
(SNMPs):

SNMPv1

SNMPv2c

SNMPv3
In addition, the superior network management system (NMS) supports the preceding
protocols. Therefore, the eSight northbound SNMP interface can receive commands from the
superior NMS through SNMP and send response messages to the superior NMS.
1.1 Location
The eSight provides services to external systems through SNMP. NEs are connected to the
eSight and the eSight is interconnected with the superior NMS through SNMP. Figure 1-1
shows the location of the northbound SNMP interface.
Huawei eSight

2

Figure 1-1 Position of the northbound SNMP interface

1.2 SNMP
1.2.1 What is SNMP
The SNMP consists of a set of industry standards for network management, which is widely
applied and used, and aims at transmitting management information between nodes. The
SNMP has the following advantages:

Assisting network administrators in searching for and modifying information on any
node on the network.

Adapting to small-sized sites that have requirements on high efficiency and low costs.

Only requiring the User Datagram Protocol (UDP), thus it is supported by various
products.
1.2.2 SNMP Structure
Structure
Table 1-1 describes the components of the SNMP.
Huawei eSight

3

Table 1-1 SNMP structure
Component Description
Structure of Management Information
(SMI)
Defining the management information structure.
Management Information Base (MIB) Containing different types of managed objects.
SNMP management protocol Defining operations on the managed objects and
network management functions

NMS
The NMS that adopts the SNMP consists of the network management workstation (NMWS)
and SNMP agent.
Table 1-2 Components of the SNMP NMS
Component Description
NMS The NMS sends different query messages to managed objects through
SNMP and receives the response messages and fault reports from the
managed objects.
SNMP agent The SNMP agent is a program on the terminal. It receives and processes a
query message from the NMWS. After obtaining the management
variable value from other modules of the managed object, the SNMP
agent generates a response message and sends it to the NMWS. In
emergent cases, the SNMP agent automatically sends the fault report (trap
message) to the NMWS.

1.3 Supported SNMP Protocols
Currently, the northbound SNMP interface supports the SNMPv1, SNMPv2c and SNMPv3
protocols.
Table 1-3 describes the protocols supported by the northbound SNMP interface.
Table 1-3 Protocols supported by the northbound SNMP interface
Protocol Description
SNMPv1 The eSight provides the following support for the SNMPv1:

Standard operations of the SNMPv1, including SNMP Get Request,
SNMP Get Next Request, and SNMP Set Request.

SNMPv1 trap

SNMPv1 security mode based on the community
Huawei eSight

4

Protocol Description
SNMPv2c The eSight supports:

Standard SNMPv2c operations, including SNMP Get Request, SNMP Get
Next Request, and SNMP Set Request.

SNMPv2c trap

SNMPv2c security mode based on the community
SNMPv3 The eSight supports:

Standard SNMPv3 operations, including Get Request, SNMP Get Next
Request, SNMP Get Bulk Request, and SNMP Set Request.

SNMPv3 trap

SNMPv3 security mode based on users
NOTE
The SNMPv3 supports the following security levels:
NoAuth and NoPriv
Auth and NoPriv
Auth and Priv
Currently, the eSight supports all the security levels of the SNMPv3. The Auth protocol
supports the MD5 and SHA. The Priv protocol supports the CBC-DES.

Huawei eSight
Northbound SNMP Interface User Reference 2 MIB Reference

5

2 MIB Reference
Overview
eSight SNMP Northbound Interface provide different sub function interface to different OSS
management system.

eSight SNMP Northbound Interface real time reporting a fault alarm to OSS
management system, then OSS management system then can get the fastest network
element alarm in real time the exact information.

eSight SNMP Northbound support OSS management system query eSight current Alarm
in eSight.
2.1 Overview for Northbound MIB Files
The Management Information Base (MIB) is the key component of the SNMP protocol. The
MIB is a set of all the objects managed by SNMP, including different types of variables to be
managed.
The basic operations of the SNMP protocol such as Get and Set are subject to the managed
objects in the MIB.
Table 2-1 MIB files of the northbound SNMP interface
MIB File Description
IMAP_NORTHBOUND_MIB-V1.mib This file is used for commissioning and verifying
the northbound SNMP interface used by the
superior NMS to interconnect with the eSight
when SNMP version is V1. It provides the
sub-interfaces such as the real-time alarm
interface, alarm acknowledgment interface, alarm
un- acknowledgment interface, alarm clearance
interface and heartbeat interface.
Huawei eSight

6

MIB File Description
IMAP_NORTHBOUND_MIB-V2.mib This file is used for commissioning and verifying
superior NMS to interconnect with the eSight
when SNMP version is V2c or V3. It provides
the sub-interfaces such as the real-time alarm
interface, alarm acknowledgment interface, alarm
un- acknowledgment interface, alarm clearance
interface and heartbeat interface.
imap-northbound-deviceinfo.mib This file is used for commissioning and verifying
the northbound SNMP topology management
interface used by the superior NMS to
interconnect with the eSight. This MIB file
provides the interfaces of filtering out and
querying managed objects.
imap_northbound_mib.mib This file is used for commissioning and verifying
superior NMS to interconnect with the eSight.
This MIB file is common for all other MIBs.

The managed objects used by the function interfaces provided by the northbound SNMP
interface are defined in the preceding two MIB files. The MIB files determine:

Operations that can be performed by the superior NMS.

Information that the superior NMS can obtain.
2.2 Overview for Northbound MIB Structure
MIB Structure of the Northbound SNMP Interface
Figure 2-1 shows the MIB structure.
Huawei eSight

7

Figure 2-1 MIB structure

According to the preceding figure, the MIB objects are described as follows:
MIB object assigned by the international organization to Huawei 2011
MIB object assigned by Huawei to the NMS 15
MIB object assigned by the NMS to the northbound SNMP interface 2

The MIB object location is as follows:
iso(1).org(3).dod(6).internet(1).Private(4).enterprise(1).iMAP(2011).products(2).hwNetmana
gement(15).iMAPNorthbound(2)
MIB Object Structure
Figure 2-2 shows MIB object structure of the northbound SNMP interface.
Huawei eSight

8

Figure 2-2 MIB object structure of the northbound SNMP interface

Table 2-2 MIB objects of the northbound SNMP interface
Object Description
iMAPNorthboundCommon This object defines the public service sub-interface of
the northbound SNMP interface, such as setting and
querying the heartbeat interval interface.
iMAPNorthboundFault This object defines the alarm sub-interface of the
northbound SNMP interface, such as the real-time
alarm interface, alarm acknowledgment interface,
alarm un- acknowledgment interface and alarm
clearance interface.
hwIMAPNorthboundDeviceinfo This object defines the topology management
sub-interface, such as managed objects (MO) filter
interface and topology getcontainment interface.

2.3 MIB Object for Common Management
(iMAPNorthboundCommon)
2.3.1 Structure
Figure 2-3 shows the structure of the MIB object for common management.
Figure 2-3 Structure of the MIB object for common management

Huawei eSight

9

2.3.2 Description
MIB Object for Event Management (iMAPNorthboundEventMgmt)
Table 2-3 Attribute of MIB object for event management
Attribute Value
Type OBJECT-IDENTIFIER
Location iso(1).org(3).dod(6).internet(1).private(4).enterprises(1).iMAP(2011).product
s(2).hwNetManagement(15).iMAPNorthbound(2).iMAPNorthboundCommon
(1).iMAPNorthboundEventMgmt(2)

Table 2-4 MIB object for event management
Object Subject Subject Subject Subject Description Access
iMAPNorthb
oundNotifica
tionReport
iMAPNorthb
oundNotifica
tionCommon
iMAPNorthb
oundHeartbe
atNotificatio
n
iMAPNorthb
oundHeartbe
atNotificatio
nV2
iMAPNorthb
oundHeartbe
atNotificatio
nType
The eSight sends
heartbeat
messages to the
superior NMS
periodically. If
the superior
NMS receives a
message, it
indicates that the
connection
between the
superior NMS
and the eSight is
set up.
Otherwise, the
setting up the
connection fails.
-
iMAPNorthb
oundHeartbe
atSystemLab
el
- NBI system ID. Read-only
iMAPNorthb
oundHeartbe
atPeriod
- Heartbeat
interval.
Value Range:
3 - 3600
Unit: second
Read-only
iMAPNorthb
oundHeartbe
atTimeStamp
- Heartbeat time
stamp.
Read-only

Huawei eSight

10

MIB Object for Listening on the Connection
(iMAPNorthboundCommuLinkMonitor)
Table 2-5 Attribute of MIB object for listening on the connection
Attribute Value
s(2).hwNetManagement(15).iMAPNorthbound(2).iMAPNorthboundCommon
(1).iMAPNorthboundCommuLinkMonitor(3)

Table 2-6 MIB object for listening on the connection
Object Object Subject Description Access
iMAPNorthboundCo
mmuLinkMonitor
iMAPNorthboundHeartbea
tSvc
iMAPNorthboundHeartbe
atSvcReportInterval
Query and
modify
Heartbeat
interval.
Value Range:
3 - 3600
Read-write
Huawei eSight

11

2.4 MIB Object for Fault Management
(IMAPNorthboundFault)
2.4.1 Structure
Figure 2-4 Structure of the MIB object for fault management

2.4.2 Description
MIB Object for Synchronizing Alarms (iMAPNorthboundFaultQuery)
Table 2-7 Attribute of MIB object for synchronizing alarms
Attribute Value
s(2).hwNetManagement(15).iMAPNorthbound(2).iMAPNorthboundFault(4).i
MAPNorthboundFaultQuery(1)

Huawei eSight

12

Table 2-8 MIB object for querying alarms
Object Subject Description Access
iMAPNorthboundFaultQuery iMAPNorthboun
dAlarmQuery
Synchronize alarms from
eSight to superior NMS.

0: stop synchronizing
alarms.

1: start synchronizing
alarms.
Write-only

MIB Object for Sending Alarm Notifications
(iMAPNorthboundFaultNotification)
Table 2-9 Attribute of MIB object for sending alarm notifications
Attribute Value
MAPNorthboundFaultNotification(3)

Table 2-10 MIB object for sending alarm notifications
Object Subject Subject Subject Description Access
iMAPNort
hboundFa
ultNotifica
tion
iMAPNorthb
oundFaultAl
armNotificati
on
iMAPNorthbound
FaultAlarmNotific
ationV2
iMAPNorthboundF
aultAlarmReportN
otificationType
The eSight sends alarms
to the superior NMS in
real time using this
subject. When an alarm
is generated on the NE
or eSight, the eSight
sends the alarm the
superior NMS.
-
iMAPNorthboundF
aultAlarmQueryBe
ginNotificationTyp
e
The eSight sends a
notification using this
subject to inform the
superior NMS to start
synchronizing alarms.
After receiving this
notification, the superior
NMS starts
synchronizing alarms.
-
iMAPNorthboundF
aultAlarmQueryNo
tificationType
The eSight sends the
found alarms to the
superior NMS using this
subject.
-
Huawei eSight

13

iMAPNorthboundF
aultAlarmQueryEn
dNotificationType
The eSight sends a
notification to inform
the superior NMS to
stop synchronizing
alarms using this
subject.
-
iMAPNorthbound
AlarmCSN
- Alarm sequence
number.
Read-only
iMAPNorthbound
AlarmCategory
- Alarm category.
The values are:

1: Fault notification

2: Clear Alarm
Notification

3: Event Notification

4: Acknowledge
Alarm Notification

5: Un-acknowledge
Alarm Notification

9: Severity Change
Notification
Read-only
iMAPNorthbound
AlarmOccurTime
- Alarm Occurring time Read-only
iMAPNorthbound
AlarmMOName
- Name of a managed
object where an alarm is
generated.
Read-only
iMAPNorthbound
AlarmProductID
- Product Type.
The values are:

1: Transmission

2: Mobile

3: Fixed Network
Narrowband

4 : Fixed Network
Broadband

5: Intelligent
Network

6: Operation and
Maintenance Center
(OMC)
Read-only
iMAPNorthbound
AlarmNEType
- Network Element Type. Read-only
iMAPNorthbound
AlarmNEDevID
- Network Element or
Device ID
Read-only
Huawei eSight

14

iMAPNorthbound
AlarmDevCsn
- Serial number of a
device where an alarm
is generated.
Read-only
iMAPNorthbound
AlarmID
- Alarm ID. Read-only
iMAPNorthbound
AlarmType
- Alarm type.
The values are:

1: Communication
alarm

2: Device alarm

3: Process error
alarm

4: QoS alarm

5: Environment
alarm

6: Integrity violation

7: Operational
violation

8: Physical violation

9: Security service or
mechanism violation

10: Time domain
violation

11: Attribute value
change

12: Object creation

13: Object deletion

14: Relationship
change

15: State change

16: Route change

17: Protection switch

18: TCA

19: File transfer
status

20: Backup status

21: Heartbeat
Read-only
Huawei eSight

15

iMAPNorthbound
AlarmLevel
- Alarm severity defined
in nbi.xml file.
Huawei Standard will be
the mapping as follows:

1: Critical

2: Major

3: Minor

4: Warning

5: Indeterminate

6: Clear
International Standard
will be the mapping as
follows:

0: Indeterminate

1: Critical

2: Major

3: Minor

4: Warning

5: Clear
Read-only
iMAPNorthbound
AlarmRestore
- Whether an alarm is
restored.
The options are as
follows:

1: indicates that an
alarm is restored.

2: indicates that an
alarm is not restored.
Read-only
iMAPNorthbound
AlarmConfirm
- Alarm acknowledgment
status.
The values are:

1- Acknowledged

2 - Unacknowledged
Read-only
iMAPNorthbound
AlarmAckTim
- Acknowledgment time. Read-only
iMAPNorthbound
AlarmRestoreTim
e
- Restoration time. Read-only
iMAPNorthbound
AlarmOperator
- Operator that
acknowledges the alarm.
Read-only
iMAPNorthbound
AlarmParas1
- Reserved. Read-only
Huawei eSight

16

iMAPNorthbound
AlarmParas2
iMAPNorthbound
AlarmParas3
iMAPNorthbound
AlarmParas4
iMAPNorthbound
AlarmParas5
iMAPNorthbound
AlarmParas6
iMAPNorthbound
AlarmParas7
iMAPNorthbound
AlarmParas8
iMAPNorthbound
AlarmParas9
iMAPNorthbound
AlarmParas10
iMAPNorthbound
AlarmExtendInfo
- Alarm extension
information, containing
a maximum number of
250 characters.
Read-only
iMAPNorthbound
AlarmProbablecau
se
- Probable cause because
of which alarm occurred
Read-only
iMAPNorthbound
AlarmProposedre
pairactions
- Alarm reparation
suggestion, containing a
maximum number of
250 characters.
Read-only
iMAPNorthbound
AlarmSpecificpro
blems
- Detailed alarm cause,
containing a maximum
number of 250
characters.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem1
- Field 1 that can be
added to the reported
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem2
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem3
alarm.
Read-only
Huawei eSight

17

iMAPNorthbound
AlarmExtendProd
uctItem4
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem5
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem6
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem7
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem8
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem9
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem10
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem11
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem12
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem13
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem14
alarm.
Read-only
iMAPNorthbound
AlarmExtendProd
uctItem15
alarm.
Read-only
iMAPNorthbound
AlarmClearOperat
or
- Operator who clears an
alarm.
Read-only
iMAPNorthbound
AlarmObjectInsta
nceType
- Object instance type. Read-only
Huawei eSight

18

iMAPNorthbound
AlarmClearCateg
ory
- Alarm restore category.
The options are as
follows:

ADAC: indicates
that an alarm is
automatically
cleared after the fault
is rectified.

ADMC: indicates
that an alarm needs
to be cleared
manually after the
fault is rectified.
Read-only
iMAPNorthbound
AlarmClearType
- Alarm clearance type.
The values are:

1: Normal Clear

2: Restore Clear

3: Manual Clear

4: Configure Clear

5: Co-relation Clear
Read-only
iMAPNorthbound
AlarmServiceAffe
ctFlag
- Affecting service flag
for the alarm.
The values are:

1: Affected

2: Unaffected

3: Unknown
Read-only
iMAPNorthbound
AlarmAdditionalI
nfo
- Additional alarm
information.
Read-only
iMAPNorthbound
AlarmEventDetail
- Alarm Event Detail.
Reserved.
Read-only
iMAPNorthbound
AlarmEventType
- Alarm Event Type.
Value range: 0 64.
Reserved.
Read-only
iMAPNorthbound
AlarmDeviceIP
- Alarm Device IP.
Reserved.
Read-only
iMAPNorthbound
AlarmResourceID
s
- Alarm Resource IDs.
Reserved.
Read-only
iMAPNorthbound
AlarmReasonID
- Alarm Reason ID.
Reserved.
Read-only
Huawei eSight

19

iMAPNorthbound
AlarmFaultID
- Fault Alarm ID.
Reserved.
Read-only

MIB Object for Acknowledging Alarms (iMAPNorthboundAlarmAcknowledge)
Table 2-11 Attribute of MIB object for acknowledging alarms
Attribute Value
MAPNorthboundFaultAcknowledge(4)

Table 2-12 MIB object for acknowledging alarms
iMAPNorthboundFault
Acknowledge
iMAPNorthboundAlar
mAcknowledge
Acknowledge alarms.
Enter serial number of alarms, multiple alarm
serial numbers are separated by comma (,).
For example: 123,111.
If the acknowledgement of the given alarm
serial number fails, a list of all the alarms
which were failed to be acknowledged will be
return. Multiple alarm serial numbers are
separated by comma (,).
Write-only

MIB Object for Un-acknowledging Alarms
(iMAPNorthboundAlarmUnAcknowledge)
Table 2-13 Attribute of MIB object for un-acknowledging alarms
Attribute Value
MAPNorthboundFaultUnAcknowledge(5)

Huawei eSight

20

Table 2-14 MIB object for un-acknowledging alarms
iMAPNorthboundFaul
tUnAcknowledge
iMAPNorthboundAlar
mUnAcknowledge
Un-acknowledge alarms.
Enter serial number of alarms. Multiple alarm
serial numbers are separated by comma (,).
For example: 123,111.
If the un-acknowledgement of the given
alarm serial number fails, a list of all the
alarms which were failed to be
un-acknowledged will be return. Multiple
alarm serial numbers are separated by comma
(,).
Write-only

MIB Object for Clearing Alarms (iMAPNorthboundFaultClear)
Table 2-15 Attribute of MIB object for clearing alarms
Attribute Value
MAPNorthboundFaultClear(6)

Table 2-16 MIB object for clearing alarms
iMAPNorthboundFaul
tClear
iMAPNorthboundAlar
mClear
Clear alarms.
Enter serial number of alarms. Multiple
alarm serial numbers are separated by
comma (,). For example: 123,111.
If the clearance of the given alarm serial
number fails, a list of all the alarms
which were failed to be cleared will be
return. Multiple alarm serial numbers
are separated by comma (,).
Write-only

Huawei eSight

21

2.5 MIB Object for Device Information
(hwIMAPNorthboundDeviceinfo)
2.5.1 Structure
Figure 2-5 Structure of the MIB object for device information

2.5.2 Description
MIB Object for Device Information (hwIMAPNorthboundI2000Topo)
Table 2-17 Attribute of MIB topology operation
Attribute Value
s(2).hwNetManagement(15).iMAPNorthbound(2).hwIMAPNorthboundDevic
einfo(101).hwIMAPNorthboundI2000Deviceinfo(5).hwIMAPNorthboundI20
00Topo(1)

Table 2-18 MIB object for setting filter parameters of device
hwIMAPNort
hboundI2000
iMAPNorthbound
TopoBaseDN
Specifies the Base DN for which the
topology needs to be retrieved.
Read-w
rite
Huawei eSight

22

Topo
iMAPNorthbound
TopoScope
Specifies the scope for which the
topology information needs to be
retrieved.
The values are:

1: baseObjOnly, indicates that only
baseDN of the topology tree will be
shown in the topology table.

2: nthLevelSubordinates, indicates
that only the nodes in the configured
level will be displayed.

3: baseNthLevel, indicates that all the
nodes from base to the nth level will
be displayed.

4: baseAll, indicates all the nodes
from the baseDN to the end of the tree
will be displayed.
Read-w
rite
iMAPNorthbound
TopoLevel
Specifies the level for which the topology
information needs to be retrieved. The
value can be greater than or equal to zero.
Read-w
rite

MIB Object for Topology Filter parameters
(iMAPNorthboundTopologyAuditEntry)
Figure 2-6 hwIMAPNorthboundI2000Topo

Table 2-19 Attribute of MIB object for topology audit table
Attribute Value
s(2).hwNetManagement(15).iMAPNorthbound(2).hwIMAPNorthboundDevic
einfo(101).hwIMAPNorthboundI2000Deviceinfo(5).hwIMAPNorthboundI20
00Topo(1).iMAPNorthboundTopologyAuditTable(4).iMAPNorthboundTopol
ogyAuditEntry(1)

Huawei eSight

23

Table 2-20 MIB object for Topology Audit table
iMAPNorthboun
dTopologyAudit
Entry
iMAPNorthboundTopoDn Indicates the DN
of the Managed
Objects (MO).
Read-only
iMAPNorthboundTopoDeviceN
ame
Indicates the Name
of MO.
Read-only
iMAPNorthboundTopoIpAddre
ss
Indicates the IP
Address of MO.
Read-only
iMAPNorthboundTopoVendor Indicates the Name
of MO.
Read-only
iMAPNorthboundTopoVersion Indicates the
Version of MO.
Read-only
iMAPNorthboundTopoDeviceT
ype
Indicates the Type
of MO.
Read-only
MAPNorthboundTop.iMAPNor
thboundTopoAdminStatus
Indicates the
admin status of
MO.
he options are as
follows:

Invalid

Locked

Unlocked

ShutDown
Read-only
iMAPNorthboundTopoConnect
Status
Indicates the
connect status of
MO.
The options are as
follows:

NoDetect

Online

Offline

Invalid
Read-only
iMAPNorthboundTopoParentD
N
Indicates the DN
of the parent object
of MO.
Read-only

Huawei eSight
Northbound SNMP Interface User Reference 3 Configure Northbound SNMP Interface

24

3 Configure Northbound SNMP Interface
Overview
This chapter describes the deployment and configuration of eSight Northbound SNMP
interface, include:

First deploy the Northbound SNMP interface

Configure the Northbound SNMP interface
3.1 Configure the Northbound SNMP interface
eSight configurate the nbi.xml to Northbound SNMP interface configuration (including initial
deployment). The configuration includes network management protocol parameters and safety
parameters for OSS system.The nbi.xml location in <eSight Install Path>/
run/config/nbi/nbi.xml, include:
Step 1 GeneralConfig parameters: configure eSight Northbound system parameters, include the heart
beat needs to be sent to superior NMS, the max number of superior OSS users.
Step 2 SnmpConfig parameters: configure eSigh Northbound snmp params for superior OSS.
Step 3 UserInfo parameters: configure configure the superior OSS information.
Step 4 AlarmReportPolicy parameters: configure the policy for sending eSights alarm information
to the superior OSS.
Step 5 AlarmFields parameters: configure the alarm field content for sending the superior OSS.
----End
3.2 Deploy the Northbound SNMP interface
To deploy a eSight Northbound SNMP interface, need to add the UserInfo parameter.
3.2.1 Configure the Northbound File
This section describes how to restart the eSight service to make the modifications in the
configuration files effective.
Huawei eSight

25

Step 1 Log in to the eSight server as the administrator user.
Step 2 Access the path :<eSight install path>/run/config/nbi/
Step 3 Open nbi.xml file.
each <UserInfo> section corresponding to a OSS information, you only need to configure a
<UserInfo> section information. The configuration parameters show in 3.3.3 , according to
the actual situation of configuration parameters.
Step 4 Save nbi.xml file.
Step 5 Restart eSightservice. Please reference <Huawei eSight V200R002C00 Software Installation
Guide>.
----End
3.3 The Northbound File description
3.3.1 GeneralConfig Paramter Description
Paramter Instance
<GeneralConfig>
<HearbeatInterval>100</HearbeatInterval>
<MaxNMSUsers>20</MaxNMSUsers>
</GeneralConfig>
Paramter Description
Table 3-1 GeneralConfig Paramter Description
Parameter Description Value range and Default
value
GeneralConfig
HearbeatInterval Indicates the frequency with
which the heart beat needs to be
sent to superior NMS.
Value range: 3-3600
The value can be any
unsigned integer other than 0.
Default value: 100
Unit: Second
MaxNMSUsers Indicates the number of superior
NMS users to be configured in
nbi.xml file.
Value range:
1-20
Default value:
6

3.3.2 SnmpConfig Paramter Description

SnmpConfig Paramter Description
Huawei eSight

26

Paramter Instance
<SnmpConfig>
<SNMPVersion>2</SNMPVersion>
<NBIIp>127.0.0.1</NBIIp>
<SNMPAgentCmdPort>4700</SNMPAgentCmdPort>
<SnmpBindIp>127.0.0.1</SnmpBindIp>
<SnmpBindPort>6666</SnmpBindPort>

</SnmpConfig>
Table 3-2 SnmpConfig Paramter Description
value
SnmpConfig
SNMPVersion Indicates the Version of the
SNMP Agent to be created
Value range:
1-3

1: V1

2: V2c

3: V3
Default value:
2
NBIIp Indicates the IP of the SNMP
Agent to be created.
Value range:
IPV4
Default value:
N/A
SNMPAgentCmdPort Indicates the port in which the
SNMP Agent needs to be created.
Value range:
1024 - 65535
Default value:
4700
SnmpBindIp Indicates the originating IP of the
NBI for sending Traps and
Informs.
Value range:
IPV4
Default value:
N/A
SnmpBindPort Indicates the originating port of
NBI for sending Traps and
Informs.
Value range:
1024 - 65535
Default value:
6666

TrapInfo Paramter Description
Huawei eSight

27

Paramter Instance
<TrapInfo>
<InformEnable>1</InformEnable>
<Timeout>3000</Timeout>
<Retries>3</Retries>
<Size>10000</Size>
</TrapInfo>
Table 3-3 TrapInfo Paramter Description
value
TrapInfo
InformEnable Indicates if Inform is enabled or
not.
If this is enabled, V2 and V3
notifications will be sent through
INFORM, else the notifications
will be sent through TRAP.
Value range:
0-1

0: Not support

1: Support
Default value:
1
Timeout The timeout period for inform
sending. This value should be
more than 20 milliseconds.
If the timeout period is less than
20 then the default will be
considered.
Value range:
N/A
Default value:
2000 millisecond
Retries The retry times for inform
sending. This value should be
greater than 0.
If the retry time is less than 0 then
the default value will be
considered.
Value range:
1-3
Default value:
3
Size Indicates the size of the Packet
Data Unit (PDU).
The value should be greater than
or equal to 484.
Value range:
Greater than 484
Default value:
65535

SNMPV3Security Paramter Description
Paramter Instance
<SNMPV3Security>
<V3SecuLevel>2</V3SecuLevel>
<V3AuthProtocol>1</V3AuthProtocol>
Huawei eSight

28

<V3PrivProtocol>1</V3PrivProtocol>
</SNMPV3Security>
value
SNMPV3Security
V3SecuLevel Security level at which the
superior NMS user communicates
with the NBI.
This parameter is applicable only
to SNMPv3.
Value range:
1-3

1: AUTH_NOPRIV

2: AUTH_PRIV

3: NOAUTH_NOPRIV
Default value:
2
V3AuthProtocol Indicates Authentication protocol
used for V3 User. This field is
processed when V3SecuLevel is
set to 1 or 2.
Value range:
1-2

1: SHA

2: MD5
Default value:
1
V3PrivProtocol Indicates Privacy protocol used
for V3 User. This field is
processed when V3SecuLevel is
set to 1 or 2.
Value range:
Valid V3PrivProtocol value
is 1.
Default value:
1: DES

3.3.3 UserInfo Paramter Description

UserInfo Paramter Description
Paramter Instance
<UserInfo>
<OSSId>127.0.0.1</OSSId>
<SnmpFm>1</SnmpFm>
<UserSnmpInfo>
<CommString>public</CommString>
<V3Username>nbi</V3Username>
<V3AuthPwd>+jwVBAvQZtCtUDmUeyBWNg==</V3AuthPwd>
<V3PrivPwd>+jwVBAvQZtCtUDmUeyBWNg==</V3PrivPwd>
<V3UserAcess>1</V3UserAcess>
<ReceiveTrapPort>10160</ReceiveTrapPort>
</UserSnmpInfo>
Huawei eSight

29

.
</UserInfo>
Table 3-4 UserInfo Paramter Description
value
UserInfo
OSSId Indicates IP address of the
superior NMS user.
Value range:
IPV4
Default value:
N/A

SnmpFm Indicates whether the user wants
to do FM operations or not and
also receive the alarm
notifications or not.
Value range:
0-1

0: Not Support

1: Support
Default value:
1
UserSnmpInfo
CommString Indicates the unique ReadWrite
Community String. This field
provides a simple kind of
password protection.
This parameter is applicable to
SNMPv1 and SNMPv2c.
Value range:
Value can be any string,
ranging from length 1 to 32.
Default value:
NA
V3Username Indicates a user name for the
superior NMS user to
communicate with the NBI.
to SNMPv3.
Value range:
Value can be any string, with
length greater than 0.
Default value:
NA
Huawei eSight

30

value
V3AuthPwd Indicates the authentication
password for SNMPv3 user.
to SNMPv3.
Value range:
Password should be
encrypted using the Huawei
encryption tool.
Please see How to Use a
Password Encryption Tool in
Windows
The decrypted password
length must be 8-16.
Default value:
+jwVBAvQZtCtUDmUeyB
WNg==
Note
The value is the encrypted value
of the plain text 12345678.
V3PrivPwd Indicates the privacy password for
SNMPv3 user.
to SNMPv3.
Value range:
Password should be
encrypted using the Huawei
encryption tool.
Please see How to Use a
Password Encryption Tool in
Windows
The decrypted password
length must be 8-16.
Default value:
+jwVBAvQZtCtUDmUeyB
WNg==
Note
The value is the encrypted value
of the plain text 12345678.
V3UserAcess Indicates access level of SNMPv3
user.
Value range:
1-5

1: ALL

2: NOTIFY

3: READONLY

4: READWRITE

5: WRITEONLY
Default value:
1
Huawei eSight

31

value
ReceiveTrapPort Indicates trap port for the superior
NMS to receive the notifications.
Value range:
1024 - 65535
Default value:
10162

How to Use a Password Encryption Tool
1. How to Use a Password Encryption Tool in Windows
Perform the following steps on the eSight server as user administrator.
1)Choose Start > Run, and enter cmd.
2)Run the following command to switch to the encryption directory:
> cd /d <eSight Install Path>\tools\encrypt
3)Encrypt the planned password.
> encrypt.bat planned password
4)The system displays the encrypted password.
for example, YhNyaTIKeyzK9w9Srw2t7Q==.
2. How to Use a Password Encryption Tool in SuSE
Perform the following steps on the eSight server as user root.
1)Run the following command to switch to the encryption directory:
# cd < eSight Install Path >/tools/encrypt
2)Run the following command to grant privilege to the encryption scripts:
# chmod +x *
3)Encrypt the planned password.
# ./encrypt.sh planned password
4)The system displays the encrypted password.
for example, YhNyaTIKeyzK9w9Srw2t7Q==.

AlarmFilter Paramter Description
Paramter Instance
<AlarmFilter>
<AlarmSeverity>
<critical>1</critical>
<major>1</major>
<minor>1</minor>
<warning>1</warning>
<indeterminate>1</indeterminate>
<cleared>1</cleared>
</AlarmSeverity>
<NE>*</NE>
</AlarmFilter>
Huawei eSight

32

Table 3-5 AlarmFilter Paramter Description
value
AlarmFilter
AlarmSeverity Indicates the severity of alarms
that can be reported to superior
NMS.
Value range:
0-1

0: Not Report

1: Report
Default value:
1
NE Indicates the Network Element
whose alarm can be reported to
superior NMS.
Multiple network elements can be
separated using colon.
Value range:
N/A
Default value:
*
The default value indicates
all NEs.

UserNotificationSubscription Paramter Description
Paramter Instance
<UserNotificationSubscription>
<NewAlarm>0</NewAlarm>
<ClearAlarm>0</ClearAlarm>
<Event>1</Event>
<AckAlarm>1</AckAlarm>
<UnAckAlarm>1</UnAckAlarm>
<SeverityChange>0</SeverityChange>
</UserNotificationSubscription>
Table 3-6 UserNotificationSubscription Paramter Description
value
UserNotificationSubscription
Huawei eSight

33

value
NewAlarm Indicates whether the NewAlarm
notification is reported or not.
Value range:
0-1

0: Not Report

1: Report
Default value:
1
ClearAlarm Indicates whether the ClearAlarm
notification is reported or not
Value range:
0-1

0: Not Report

1: Report
Default value:
1
Event Indicates whether the Event
notification is reported or not.
Value range:
0-1

0: Not Report

1: Report
Default value:
1
AckAlarm Indicates whether the
AcknowledgeAlarm notification is
reported or not.
Value range:
0-1

0: Not Report

1: Report
Default value:
1

3.3.4 AlarmReportPolicy Paramter Description
Paramter Instance
<AlarmReportPolicy>
<ActiveQuery>1</ActiveQuery>
<TimeType>1</TimeType>
<UTCTime>1</UTCTime>
</AlarmReportPolicy>
Huawei eSight

34

Table 3-7 AlarmReportPolicy Paramter Description
value
AlarmReportPolicy
ActiveQuery Indicates whether NBI reports
This is an unsigned integer current
alarms or active alarms to superior
NMS.
Current alarms are the alarms
which have not been cleared or
acknowledged.
Active alarms are the alarms
which have not been cleared.
Value range:
0-1

0: Report current alarms

1: Report active alarms
Default value:
1
TimeType Indicates the time type used in
notifications.
Value range:
1-2

1: The time that eSight
receives the alarm.

2: The time that alarm
occurs on NE.
Default value:
1
UTCTime Indicates which time is used. Value range:
0-1

0: Local Time

1: UTC Time
Default value:
1

3.3.5 AlarmFields Paramter Description
Paramter Instance
<AlarmFields>
<Csn>1</Csn>
<Category>1</Category>
<OccurTime>1</OccurTime>
<MOName>1</MOName>
<ProductID>1</ProductID>
<NEType>1</NEType>
<NEDevId>1</NEDevId>
<ID>1</ID>
<Type>1</Type>
<Level>1</Level>
Huawei eSight

35

<Restore>1</Restore>
<Confirm>1</Confirm>
<AckTime>1</AckTime>
<RestoreTime>1</RestoreTime>
<Operator>1</Operator>
<ExtendInfo>1</ExtendInfo>
<Probcause>1</Probcause>
<SpecificProblems>1</SpecificProblems>
<ClearOperator>1</ClearOperator>
<ObjectInstanceType>1</ObjectInstanceType>
<ClearCategory>1</ClearCategory>
<ClearType>1</ClearType>
<ServiceAffectFlag>1</ServiceAffectFlag>
<AdditionalInfo>1</AdditionalInfo>
<DevCsn>1</DevCsn>
</AlarmFields>
Table 3-8 AlarmFields Paramter Description
value
AlarmFields
Note
Below parameters in this tag are used to set alarm fields in alarm notification.
Csn Indicates whether the serial
number of the alarm is provided or
not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Category Indicates whether the type of the
alarm is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
OccurTime Indicates whether the alarm
generated time is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Huawei eSight

36

value
MOName Indicates whether the name of the
managed object is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
ProductID Indicates whether the product Id is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
NEType Indicates whether the type of the
Network Element (NE) is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
NEDevId Indicates whether the NE Id is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
ID Indicates whether the alarm Id is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Type Indicates whether the event type is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Huawei eSight

37

value
Level Indicates whether the severity of
the alarm is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Restore Indicates whether the cleared
alarm status is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Confirm Indicates whether the
acknowledged alarm status is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
AckTime Indicates whether the alarm
acknowledged time is provided or
not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
RestoreTime Indicates whether the alarm
cleared time is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Operator Indicates whether the operator
who performs acknowledgement
operation is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Huawei eSight

38

value
ExtendInfo Indicates whether the alarm
extended information including
the location of the alarm is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Probcause Indicates whether the possible
alarm cause is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Proposedrepairaction
s
Indicates whether the alarm repair
suggestion is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
SpecificProblems Indicates whether the detail reason
of the alarm occurrence is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
ClearOperator Indicates whether the operator
who cleared the alarm is provided
or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
ObjectInstanceType Indicates whether the object
instance type of the alarm is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
Huawei eSight

39

value
ClearCategory Indicates whether the clear
category of alarms is provided or
not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
ClearType Indicates whether the clear type of
alarms is provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
ServiceAffectFlag Indicates whether the affecting
service flag for the alarm is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
AdditionalInfo Indicates whether the additional
information regarding the alarm is
provided or not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1
DevCsn Indicates whether serial number of
the alarm device is provided or
not.
Value range:
0-1

0: Not provide

1: Provide
Default value:
1

Huawei eSight
Northbound SNMP Interface User Reference 4 Acronyms and Abbreviations

40

4 Acronyms and Abbreviations
F
FTP File Transfer Protocol

I
IP Internet Protocol

M
MO Managed Object

N
NBI Northbound Interface
NE Network Element
NMS Network Management System

O
OMC Operation and Maintenance Center

S
SM Security Management
SNMP Simple Network Management Protocol

T
TCP Transfer Control Protocol

Huawei ESight Northbound SNMP Interface User Reference (V200R002C00 - 01)

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Huawei ESight Northbound SNMP Interface User Reference (V200R002C00 - 01)

Uploaded by

Copyright:

Available Formats

Huawei eSight

You might also like