TNMS SNMP NBI - Operation Guide

TNMS
V16.01
Coriant TNMS
SNMP NBI Operation Guide (SNOG)
Issue: 1 Issue date: July 2016
Coriant is continually striving to reduce the adverse environmental

effects of its products and services. We would like to encourage you
as our customers and users to join us in working towards a cleaner,
safer environment. Please recycle product packaging and follow the
recommendations for power use and proper disposal of our products
and their components.
Disclaimer TNMS V16.01 – SNMP NBI Operation Guide
The information in this document is subject to change without notice and describes only the product
defined in the introduction of this documentation. This documentation is intended for the use of
Coriant customers only for the purposes of the agreement under which the document is submitted,
and no part of it may be used, reproduced, modified or transmitted in any form or means without the
prior written permission of Coriant. The documentation has been prepared to be used by professional
and properly trained personnel, and the customer assumes full responsibility when using it. Coriant
welcomes customer comments as part of the process of continuous development and improvement of
the documentation.
The information or statements given in this documentation concerning the suitability, capacity, or
performance of the mentioned hardware or software products are given "as is" and all liability arising
in connection with such hardware or software products shall be defined conclusively and finally in a
separate agreement between Coriant and the customer. However, Coriant has made all reasonable
efforts to ensure that the instructions contained in the document are adequate and free of material
errors and omissions. Coriant will, if deemed necessary by Coriant, explain issues which may not be
covered by the document. Coriant will correct errors in this documentation as soon as possible.
IN NO EVENT WILL CORIANT BE LIABLE FOR ERRORS IN THIS DOCUMENTATION OR FOR
ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL, DIRECT, INDIRECT, INCIDENTAL
OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUT NOT LIMITED TO LOSS OF PROFIT,
REVENUE, BUSINESS INTERRUPTION, BUSINESS OPPORTUNITY OR DATA,THAT MAY ARISE
FROM THE USE OF THIS DOCUMENT OR THE INFORMATION IN IT.
This documentation and the product it describes are considered protected by copyrights and other
intellectual property rights according to the applicable laws. Other product names mentioned in this
document may be trademarks of their respective owners, and they are mentioned for identification
purposes only.
Copyright © Coriant 2016. All rights reserved.
2/116 © Coriant Issue: 1 Issue date: July 2016

TNMS V16.01 – SNMP NBI Operation Guide
Table of Contents
This document has 116 pages.
1 Preface ........................................................................................................... 9
1.1 Intended audience .................................................................................... 9
1.2 Structure of this document........................................................................ 9
2 Introduction ................................................................................................. 11
2.1 General description ................................................................................ 11
2.2 SNMP protocol support .......................................................................... 12
2.3 Terminology ........................................................................................... 12
2.4 Differences to TNMS Core SNMP Proxy ................................................ 13
2.4.1 General changes ............................................................................. 13
2.4.2 Tables and fields ............................................................................. 14
2.4.3 Notification behaviors ...................................................................... 14
2.4.4 Protocol support changes ................................................................ 15
2.5 Installation and licensing ........................................................................ 15
2.6 MIB file location ...................................................................................... 15
3 SNMP Agent Configuration ........................................................................ 16

3.1 System settings ...................................................................................... 16
3.2 MIB-II variables ...................................................................................... 17
3.3 SNMP user configuration........................................................................ 18
3.3.1 SNMP user identification ................................................................. 19
3.3.2 SNMP user access permissions ...................................................... 20
3.3.3 User trap destinations...................................................................... 21
3.3.1 User inform destinations .................................................................. 21
3.4 Notification filtering ................................................................................. 22
3.5 Heartbeat notifications............................................................................ 24
3.6 Exporting SNMP agent configuration ...................................................... 24
4 SNMP NBI MIB – General description ........................................................ 25

4.1 Exported object model............................................................................ 25
4.2 Hierarchical view .................................................................................... 26
4.3 Notification model ................................................................................... 27
Issue: 1 Issue date: July 2016 © Coriant 3/116

4.4 Resynchronization after network or manager errors ............................... 29

4.5 Recommended table retrieval approaches ............................................. 29
4.5.1 Retrieving all rows of a table ............................................................ 30
4.5.2 Retrieving specific rows by index ..................................................... 31
4.5.3 Retrieving blocks of rows for a sub-index ........................................ 31
4.5.4 Response limited size ...................................................................... 32
4.5.5 Request timeouts ............................................................................ 32
4.6 Data types .............................................................................................. 32
4.7 ‘Obsolete’ and ‘Future’ fields and tables ................................................. 38
4.8 Strings and multi-language support ........................................................ 39
5 SNMP NBI MIB – Network Objects ............................................................. 40

5.1 Network Object Tables ........................................................................... 40
5.1.1 List of NEs (enmsNETable) ............................................................. 40
5.1.2 List of Modules (enmsModuleTable) ................................................ 41
5.1.3 List of Ports (enmsPortTable) .......................................................... 42
5.1.4 List of Termination Points (enmsTPTable) ....................................... 43
5.1.5 List of Port Connections (enmsPortConnTable) ............................... 45
5.2 Network Object Notifications .................................................................. 45
5.2.1 NE object creation (enmsNEObjectCreationTrap) ........................... 45
5.2.2 NE object deletion (enmsNEObjectDeletionTrap) ............................ 46
5.2.3 NE state change (enmsNEStateChangeTrap) ................................. 46
5.2.4 NE attribute value change (enmsNEAttributeChangeTrap) .............. 47
5.2.5 Module object creation (enmsModuleObjectCreationTrap) .............. 48
5.2.6 Module object deletion (enmsModuleObjectDeletionTrap) ............... 48
5.2.7 Module state change (enmsModuleStateChangeTrap) .................... 48
5.2.8 Module attribute value change (enmsModuleAttributeChangeTrap) 49
5.2.9 Port object creation (enmsPortObjectCreationTrap) ........................ 49
5.2.10 Port object deletion (enmsPortObjectDeletionTrap) ......................... 50
5.2.11 Port state change (enmsPortStateChangeTrap) .............................. 50
5.2.12 Port attribute value change (enmsPortAttributeChangeTrap) ........... 51
5.2.13 TP object creation (enmsTPObjectCreationTrap) ............................ 51
5.2.14 TP object deletion (enmsTPObjectDeletionTrap) ............................. 52
5.2.15 TP state change (enmsTPStateChangeTrap) .................................. 52

5.2.16 TP attribute value change (enmsTPAttributeChangeTrap)............... 53

5.2.17 Port connection object creation
(enmsPortConnObjectCreationTrap) ............................................... 54
5.2.18 Port connection object deletion
(enmsPortConnObjectDeletionTrap) ................................................ 54
5.2.19 Port connection attribute value change
(enmsPortConnAttributeChangeTrap) ............................................. 54
6 SNMP NBI MBI – Connection Management ............................................... 56

6.1 Connection Management Tables ............................................................ 56
6.1.1 List of Sub-Network Connections (enmsSNCTable) ........................ 56
6.1.2 List of Ethernet Paths (enmsEthernetPathTable) ............................. 58
6.1.3 List of Services (enmsServiceTable) ............................................... 58
6.1.4 List of Cross Connections (enmsCCTable) ...................................... 59
6.2 Connection Management Notifications ................................................... 60
6.2.1 SNC object creation (enmsSNCObjectCreationTrap) ...................... 60
6.2.2 SNC object deletion (enmsSNCObjectDeletionTrap) ....................... 61
6.2.3 SNC state change (enmsSNCStateChangeTrap) ............................ 61
6.2.4 SNC attribute value change (enmsSNCAttributeChangeTrap) ......... 61
6.2.5 Service object creation (enmsServiceObjectCreationTrap) .............. 62
6.2.6 SNC object deletion (enmsServiceObjectDeletionTrap) ................... 62
6.2.7 Service state change (enmsServiceStateChangeTrap) ................... 63
6.2.8 Service attribute value change (enmsServiceAttributeChangeTrap) 63
6.2.9 Ethernet Path object creation
(enmsEthernetPathObjectCreationTrap).......................................... 64
6.2.10 Ethernet Path object deletion
(enmsEthernetPathObjectDeletionTrap) .......................................... 64
6.2.11 Ethernet Path state change (enmsEthernetPathStateChangeTrap) . 64
6.2.12 Ethernet Path attribute value change
(enmsEthernetPathAttributeChangeTrap)........................................ 65
7 SNMP NBI MIB – Fault management .......................................................... 67

7.1 Fault Management Tables ...................................................................... 67
7.1.1 Global alarm list (enmsAlarmTable) ................................................. 67
7.1.2 Alarms for NE (enmsAlarmsForNETable) ........................................ 69
7.1.3 Alarms for Ports (enmsAlarmsForPortTable) ................................... 70

7.1.4 Alarms for TP (enmsAlarmsForTPTable) ......................................... 71

7.1.5 Alarms for Port Connections (enmsAlarmsForPortConnTable) ........ 72
7.1.6 Alarms for Modules (enmsAlarmsForModuleTable) ......................... 74
7.1.7 Alarms for SNCs (enmsAlarmsForSNCTable) ................................. 75
7.2 Fault Management Notifications ............................................................. 76
7.2.1 NE alarm (enmsNEAlarmTrap) ........................................................ 76
7.2.2 Module alarm (enmsModuleAlarmTrap)........................................... 77
7.2.3 Port alarm (enmsPortAlarmTrap) ..................................................... 79
7.2.4 TP alarm (enmsTPAlarmTrap) ......................................................... 80
7.2.5 EMS alarm (enmsEMSAlarmTrap) .................................................. 81
8 SNMP NBI MIB – EMS and SNMP agent .................................................... 83

8.1 Agent information (enmsControl) ............................................................ 83
8.2 SNMP agent notifications ....................................................................... 84
8.2.1 Agent state change (enmsProxyStateChangeTrap) ......................... 84
8.3 Notification filtering (enmsTrapFilter) ...................................................... 84
8.4 Notification history (enmsTrapHistoryTable) ........................................... 85
9 Ethernet Paths – Support of MEF 40.......................................................... 87

9.1 MEF-UNI-EVC-MIB ................................................................................ 87
9.1.1 mefServiceEvcCfgTable .................................................................. 87
9.1.2 mefServiceEvcStatusTable.............................................................. 88
10 Performance Monitoring ............................................................................. 89

10.1 Introduction ............................................................................................ 89
10.2 PM requests ........................................................................................... 90
10.2.1 enmsPerfMonRequestTable ............................................................ 90
10.3 Creating a PM request ........................................................................... 91
10.4 PM request states .................................................................................. 93
10.5 PM request state change notifications .................................................... 94
10.6 Operations on PM requests .................................................................... 95
10.6.1 Executing a PM request .................................................................. 95
10.6.2 Updating PM request attributes ....................................................... 96
10.6.3 Cancelling a PM request ................................................................. 96
10.6.4 Discarding PM data associated to a PM request ............................. 97

10.6.5 Deleting a PM request ..................................................................... 97

10.6.6 Error exceptions .............................................................................. 98
10.7 Retrieving PM data ................................................................................. 98
10.7.1 PM data retention period ................................................................. 99
10.7.2 enmsPerfMonResultPmpTable ........................................................ 99
10.7.3 enmsPerfMonResultValueTable .................................................... 100
11 Optical Power Monitoring ......................................................................... 101

11.1 Introduction .......................................................................................... 101
11.2 OPM requests ...................................................................................... 102
11.2.1 enmsOptPowerMonRequestTable ................................................. 102
11.3 Creating an OPM request ..................................................................... 103
11.4 OPM request states.............................................................................. 105
11.5 OPM request state change notifications ............................................... 106
11.6 Operations on OPM requests ............................................................... 107
11.6.1 Executing an OPM request ............................................................ 107
11.6.2 Updating OPM request attributes................................................... 108
11.6.3 Cancelling an OPM request ........................................................... 108
11.6.4 Discarding OPM data associated to an OPM request .................... 109
11.6.5 Deleting an OPM request .............................................................. 109
11.6.6 Error exceptions ............................................................................ 110
11.7 Retrieving OPM data ............................................................................ 110
11.7.1 OPM data retention period............................................................. 110
11.7.2 enmsOptPowerMonResultTable .................................................... 111
12 Troubleshooting ........................................................................................ 112
Abbreviations ............................................................................................ 115

Summary of changes
Issue Issue date Remarks

1 July 2016 First V16.01 version.

TNMS V16.01 – SNMP NBI Operation Guide Preface
1 Preface
1.1 Intended audience

This document is intended for anyone responsible for:
- Installing, configuring, maintaining and troubleshooting SNMP NBI, the
TNMS SNMP northbound interface.
- Integrating TNMS with external applications, such as umbrella systems,
using the SNMP protocol.
It is assumed that the reader is familiar with basic SNMP protocol concepts.
1.2 Structure of this document

The remaining of this document is organized as follows:
 Chapter 2 introduces the SNMP NBI component, its installation and
licensing, and the differences to TNMS Core’s SNMP Proxy.
 Chapter 3 explains how to configure the SNMP NBI agent via the
TNMS Client GUI.
 Chapter 4 provides an overview of the SNMP NBI MIB, including its
object and notification models. It also discusses how to access
efficiently the MIB data, and how to detect and handle missed
notifications.
 Chapter 5 describes the tables and notifications related to the network
objects (NE, Module, Port, TP and Port Connection).
 Chapter 6 describes the tables and notifications related to connection
management (Sub-Network Connections and Cross-Connections).
 Chapter 7 describes the tables and notifications related to fault
management.
 Chapter 8 describes the variables, tables and notifications related to
the SNMP agent and EMS themselves.
 Chapter 9 describes the MEF MIB support for the retrieval of Ethernet
Paths.
 Chapter 10 describes how to retrieve Performance Monitoring data
using SNMP NBI.

Preface TNMS V16.01 – SNMP NBI Operation Guide
 Chapter 11 describes how to retrieve Optical Power Monitoring data

using SNMP NBI.
 Chapter 12 provides troubleshooting for the most common issues
when using the SNMP NBI.

TNMS V16.01 – SNMP NBI Operation Guide Introduction
2 Introduction
2.1 General description

SNMP NBI is a northbound interface that allows external clients to access
TNMS using the SNMP protocol. In SNMP terminology, the SNMP NBI is an
SNMP agent, and the external clients, such as umbrella systems or fault
monitoring systems, are the SNMP managers.
Figure 1 SNMP NBI component in a TNMS system
The SNMP NBI provides the following functionality to the SNMP managers:
 Network discovery and synchronization
- Lists of NEs, Modules, Ports, Termination Points (TPs) and Port
Connections (PCs)
- Notifications for network object creation (OC) and deletion
(OD), attribute value changes (AVC) and state changes (SC).
 Fault management
- Lists of alarms, with filtering by type of affected object

Introduction TNMS V16.01 – SNMP NBI Operation Guide
- Alarm raise/clear notifications.

 Connection management
- Lists of Cross-Connections (CCs), Sub-Network Connections
(SNCs) and Ethernet Paths.
- Notifications for object creation (OC) and deletion (OD),
attribute value changes (AVC) and state changes (SC).
 Performance Monitoring
- Retrieval of history and current PM data
 Optical Power Monitoring
- Retrieval of Optical Power Monitoring data
The SNMP NBI MIB is based on TNMS Core’s SNMP Proxy MIB, and
therefore inherits its exported data models and notification behaviors.
However, some tables and fields are not yet supported. See section 2.4 for the
main differences.
SNMP NBI also provides preliminary MEF MIB support for the retrieval of
Ethernet Paths (MEF 40).
2.2 SNMP protocol support

The SNMP NBI provides the following protocol capabilities:
 SNMP v2c and v3
 UDP transport protocol
 GET / GETNEXT / GETBULK / SET requests
 TRAP and INFORM notifications
 IPv4 and IPv6
 SNMPv3 authentication protocols: MD5, SHA
 SNMPv3 privacy protocols: DES, 3DES, AES128
2.3 Terminology
The term “SNMP manager”, or simply “manager”, is used to refer any external
system or application that accesses TNMS via the SNMP protocol.
The term “SNMP agent” refers to the SNMP NBI component itself.
The term “EMS” refers to the TNMS system itself.

The term “trap” is commonly used to refer an SNMP notification, regardless of

it being sent as an SNMP TRAP or an SNMP INFORM.
Some objects are named differently in SNMP NBI MIB and TNMS. The table
below shows the equivalences.
SNMP NBI MIB naming TNMS naming
Module Equipment
Port Connection (PC) Physical Trail
Port Physical Termination Point (PTP)
Sub-Network Connection (SNC) Path
Ethernet Path Ethernet Service
Table 1 Naming equivalences between SNMP NBI MIB and TNMS
2.4 Differences to TNMS Core SNMP Proxy

Although SNMP NBI’s MIB is structurally similar to that of TNMS Core SNMP
Proxy, some differences do exist.
2.4.1 General changes
 MIB name is “TNMS-NBI-MIB” instead of “TNMS-MIB”.

 The Private Enterprise Number (PEN) is ‘coriant’ (42229) instead of
‘sni’ (231).
 Enumeration data types were revised and adapted to the TNMS
information model.
 Human-readable timestamps have now the fixed format yyyy-MM-dd
HH:mm:ss, regardless of server regional settings.
 Strings are encoded in UTF-8 instead of ISO-8859-1.
 New MIB objects added associated to new features, such as heartbeat
support, Ethernet Path support, Performance Monitoring and Optical
Power Monitoring.

Introduction TNMS V16.01 – SNMP NBI Operation Guide
2.4.2 Tables and fields
The MIB objects below are present in the SNMP NBI MIB file, but will only be
supported in the future.
Type of MIB objects To be supported in the future
Tables and associated  enmsSNCTPTable

traps  enmsSNCSNCTable
 enmsSNCCCTable
 enmsNeSNCTable
 enmsSubscriberTable
 enmsSubscriberTraps
 enmsAlarmsForServiceTable
Table fields  enmsNETable:

enmsNeClass
 enmsTPTable:
enmsTpUsageCountTX
enmsTpUsageCountRX
enmsTpUsageStateTX
enmsTpUsageStateRX
enmsTpBandwidthTX
enmsTpBandwidthRX
enmsTpTerminType (only the AVC)
Trap fields  enmsSNCTraps:

enmsSNCTPRelationshipChangeTrap
Table 2 MIB objects not yet supported
2.4.3 Notification behaviors
Notification behaviors for Object Deletion events (OD) have been made
consistent among all network object types. Avoiding redundant OD traps helps
minimizing network and processing spikes in case of network changes.
TNMS Core SNMP Proxy TNMS SNMP NBI
When a NE is removed, an OD trap is sent for When a NE, module or port is removed, an OD trap
that NE only – no OD traps are sent for the child is sent for that object only – no OD traps are sent
objects. for its children. The manager may implicitly assume
that the child objects have been removed also.
When a module or port is removed, OD traps for
its children are also sent. Note: OD notifications for child objects are still sent
if the removed parent object belongs to a UNO
network element.
Table 3 OD notification behavior changes

2.4.4 Protocol support changes
As for the SNMP protocol support, the differences to TNMS Core’s SNMP
Proxy are:
 The listening port is now configurable, to allow SNMP NBI to coexist
with other SNMP services on the server.
 SNMP v1 is no longer supported, only v2c and v3.
 Timeout and maximum tries of INFORM notifications are configurable.
2.5 Installation and licensing

SNMP NBI is an optional TNMS component. It can only be installed during
TNMS installation, by selecting “SNMP" in the “Install North Bound Interface”
wizard page. It is not possible to install SNMP NBI later without reinstalling
TNMS.
SNMP NBI also requires a license to run. The license can be installed at any
time, but will only become effective after TNMS is restarted. To install it, go to
the License Manager in the TNMS Client.
2.6 MIB file location

The SNMP NBI MIB file can be found under the following location:
<TNMS Home>\Docs\SNMP-NBI\TNMS-NBI-MIB.my
The file is only available if the SNMP NBI component is installed.

SNMP Agent Configuration TNMS V16.01 – SNMP NBI Operation Guide
3 SNMP Agent Configuration
3.1 System settings

To configure the basic SNMP NBI system settings, proceed as follows.
1. Open TNMS Client and go to Administration > System Preferences >

SNMP NBI > System).
Figure 2 SNMP NBI system preferences
2. Check Enable SNMP northbound interface to enable the SNMP NBI. If

disabled, all SNMP communication is blocked, that is, no SNMP requests
are accepted and no SNMP traps are sent.
If the checkbox is greyed out, it means that an SNMP NBI license has
been installed, but the server has not been restarted yet. You must restart
the server to enable SNMP NBI.
3. In Listening port specify an unused UDP port where SNMP requests are
to be received. The default is 50161.
Recommended: either 161, or a number between 49152 and 65535, which
is the private port range defined by IANA. Just make sure the chosen port
is not used by any other service or application on the server.

TNMS V16.01 – SNMP NBI Operation Guide SNMP Agent Configuration
4. In Proxy name and Network name, enter informative names for this
SNMP NBI instance and for the network.
5. In Trap history length, specify the number of records to be kept in the
trap history table. The default is 256. Allowed values are between 2 and
10000. (See also 4.4 - Resynchronization after network or manager
errors.)
6. The MIB version is read-only and shows the version of the SNMP NBI
MIB. It matches the LAST-UPDATE clause in the MIB definition file, and
therefore can be used to check if an SNMP manager is using the correct
file.
7. Check Enable heartbeat traps if heartbeat traps are to be sent to the
listening SNMP managers.
 In Interval, specify the number of seconds between heartbeats.
Default is 60 seconds. Allowed values are between 5 and 86400
seconds (equivalent to 24 hours).
8. In the Inform group, configure how SNMP INFORM notifications are
managed:
 In Timeout, specify the maximum number of seconds that SNMP
NBI will wait for a response before resending an Inform. Default is
3 seconds. Allowed values are between 1 and 60 seconds.
 In Maximum tries, specify the maximum number of times that
SNMP NBI will try to send an Inform notification to each
destination. Default is 3 tries. Allowed values are between 1 and 5
tries.
The Proxy name, Network name, Trap history length and MIB version
values above are readable via SNMP under the enmsControl MIB branch (see
section 8.1).
The Heartbeat and Inform configuration parameters are also modifiable via
SNMP under the enmsControl MIB branch (see section 8.1).
3.2 MIB-II variables

Being an SNMP agent, the SNMP NBI also implements the MIB-II System
Group variables, which describe the entity on which the agent is running:
sysName, sysDescr, sysObjectID, sysLocation and sysContact. To manage
the values of those variables, proceed as follows.
1. Open TNMS Client and go to Administration > System Preferences >
SNMP NBI > MIB-II.

Figure 3 SNMP NBI MIB-II variables
2. The Name (sysName), Description (sysDescr) and Object ID

(sysObjectID) variables are set automatically by the SNMP NBI:
 Name – Host name of the server.
 Description – Description of the server’s operating system.
 Object Id – OID of the svsProxEnms MIB node.
3. In Location (sysLocation), provide an arbitrary description for the location
of this SNMP agent.
4. In Contact (sysContact), provide an arbitrary value for contact information,
such as the administrator’s email or telephone.
Setting the MIB-II variables via SNMP will not reflect on the preferences GUI.
Additionally, those variables will be reset next time TNMS is started.
3.3 SNMP user configuration

To configure which SNMP users are allowed to access the SNMP NBI MIB, or
to which SNMP notifications are to be sent, open TNMS Client and go to
Administration > SNMP NBI User Management.

Figure 4. List of SNMP NBI users
In the SNMP NBI User Management window (Figure 4) you may add, edit or
remove SNMP users. Next sections explain how to configure a user.
3.3.1 SNMP user identification
In the Identification tab (Figure 5) you specify the basic user details.
Figure 5 SNMP user identification
The following fields are mandatory:

 User/Community – The name of the user (SNMPv3) or the community
(SNMPv2). The maximum length is 32 characters.
 SNMP version – Protocol version to be used for this user (v2c or v3).
 Authentication – The encryption protocol to be used for user
authentication (optional, SNMPv3 only). Allowed values: MD5, SHA.
 Authentication password – Password for user authentication. Length
must be between 8 and 64 characters.

 Privacy – The encryption protocol to be used for privacy (optional,

SNMPv3 only). Allowed values: DES, 3DES, AES128. You must
enable authentication to enable privacy.
 Privacy password - Password for privacy. Length must be between 8
and 64 characters.
3.3.2 SNMP user access permissions
In the Accesses tab (Figure 6) you configure the user permissions for
incoming SNMP requests.
Figure 6 SNMP user access permissions
To configure the SNMP user access permission:
1. Select the level of permission granted to the user for accessing the SNMP
NBI MIB:
 No permission – The user has no access permission.
 Read – The user has read-only access.
 Read/Write – The user has read and write access.
2. Specify the IP addresses from which requests from this user are accepted.
Both IPv4 and IPv6 addresses are allowed. Examples:
 10.55.140.25
 4f::58a3:45fe:38
Address format restrictions:
- Host names are not supported, only IP addresses.

- IP masks are not supported; individual IP addresses must be

specified.
3.3.3 User trap destinations
In the Traps tab (Figure 7) you configure the SNMP TRAP destinations for the
SNMP user.
Figure 7 SNMP user trap destinations
To enable the SNMP user to receive traps, proceed as follows:

1. Check Allow traps.
2. In Destination IP addresses, enter the IPv4 or IPv6 addresses of the
SNMP managers that will receive the trap notification. You must always
specify the port, even if it is the well-known port 162. Examples:
 10.55.140.25:162
 [4f:0:0:0:0:58a3:45fe:38]:50162
- Collapsing of groups of zeroes in IPv6 trap destination addresses is
not supported.
3.3.1 User inform destinations
In the Informs tab (Figure 8) you configure the SNMP INFORM destinations
for the SNMP user.

Figure 8 SNMP user inform destinations
To enable the SNMP user to receive informs, proceed as follows:

1. Check Allow informs.
2. In Destination IP addresses, enter the IPv4 or IPv6 addresses of the
SNMP managers that will receive the inform notifications. You must always
specify the port, even if it is the well-known port 162. Examples:
 10.55.140.25:162
 [4f:0:0:0:0:58a3:45fe:38]:50162
- Collapsing of groups of zeroes in IPv6 trap destination addresses is
not supported.
3.4 Notification filtering

To select what types of notifications are to be sent to the SNMP managers,
open TNMS Client and go to Administration > System Preferences > SNMP
NBI > Notifications.

Figure 9 SNMP NBI notification preferences
The notification preferences pane (Figure 9) shows two lists:

 Disabled – Types of notifications that are blocked.
 Enabled – Types of notifications that are sent.
Use the buttons on the middle to move items between the lists.
The available notification types are:
- Common: SNMP NBI agent notification, e.g. operational state.
- NE: All NE notifications, except alarms.
- Module: All module notifications, except alarms.
- Port: All port notifications, except alarms.
- TP: All TP notifications, except alarms.
- Port Connection: All port connection notifications.
- SNC: All SNC notifications.
- Service: All Service notifications.
- Ethernet Path: All Ethernet Path notifications.
- NE Alarms: Alarms originating in NEs.
- Module Alarms: Alarms originating in modules.
- Port Alarms: Alarms originating in ports.
- TP alarms: Alarms originating in TPs.
- EMS: Alarms originating in the TNMS itself.
- Performance Monitoring: Notifications related to PM requests.
- Optical Power Monitoring: Notifications related to OPM requests.

The notification filtering is also configurable via SNMP through the

enmsTrapFilter MIB variables (see 8.3).
3.5 Heartbeat notifications

SNMP NBI is able to send heartbeat notifications so that the SNMP managers
can detect network connectivity and agent availability issues. These
notifications are sent to all Trap and Inform destinations configured in the
SNMP NBI users.
Heartbeat notifications may be enabled and configured in the SNMP NBI
System Preferences (see 3.1) or via SNMP (see 8.1).
Heartbeat notifications are always sent as SNMP TRAP, even for Inform
destinations.
Heartbeat notifications do not carry a trap counter nor are stored in the
notification history table.
3.6 Exporting SNMP agent configuration

The TNMS “Export Configuration” functionality may be used to export SNMP
NBI configuration data to an XML file. Note, however, that the exported data is
not importable – its main use is for external auditing of changes.
For more information on how to export configuration data to XML, please refer
to TNMS documentation.

TNMS V16.01 – SNMP NBI Operation Guide SNMP NBI MIB – General description
4 SNMP NBI MIB – General description
4.1 Exported object model

The UML-like diagram in Figure 10 shows the main objects exported by the
SNMP NBI MIB, and how they relate to each other. The MIB by itself is not
object-oriented; objects therefore correspond to table entries, and their
relations are represented using primary keys (table indexes) and foreign keys
(fields pointing to the indexes of related objects).
Figure 10 Exported object model

SNMP NBI MIB – General description TNMS V16.01 – SNMP NBI Operation Guide
In relation to fault management, all active alarms in the system are exported
via the table enmsAlarmTable. Other tables act as views of that master table,
showing only the alarms affecting a specific type of object (Figure 11).
Figure 11 Exported model of alarms tables
4.2 Hierarchical view

The SNMP NBI MIB is structured as follows:
 coriant.svsProductMibs.svsProxEmns
 enmsNetworkSetup
 enmsNETable (5.1.1)
 enmsModuleTable (5.1.2)
 enmsPortTable (5.1.3)
 enmsTPTable (5.1.4)
 enmsPortConnTable (5.1.5)

 enmsSNCTable (6.1.1)
 enmsCCTable (0)
 enmsEthernetPathTable (6.1.2)
 enmsService
 enmsServiceTable (6.1.3)
 enmsAlarmTables
 enmsAlarmTable (7.1.1)
 enmsAlarmsForNETable (7.1.2)
 enmsAlarmsForPortTable (7.1.3)
 enmsAlarmsForTPTable (7.1.4)
 enmsAlarmsForPortConnTable (7.1.5)
 enmsAlarmsForSNCTable (7.1.7)
 enmsAlarmsForModuleTable (7.1.6)
 enmsProxy
 enmsControl (8.1)
 enmsTrapGroup
 enmsTrapHistory
 enmsTrapHistoryTable (8.4)
 enmsTrapVariable
 enmsTraps (5.2, 6.2, 7.2, 8.2, 10.5, 11.5)
 enmsTrapFilter (8.3)
 enmsPerformanceMonitoring
 enmsPerfMonRequestTable (10.2.1)
 enmsPerfMonResultPmpTable (10.7.2)
 enmsPerfMonResultValueTable (10.7.3)
 enmsOpticalPowerMonitoring
 enmsOptPowerMonRequestTable (11.2.1)
 enmsOptPowerMonResultValueTable (11.7.2)
4.3 Notification model

The SNMP NBI provides notifications about changes and events affecting the
objects modelled by the SNMP NBI MIB. These notifications are based on the
ITU recommendation X.721 and are realized as SNMP Traps.
The supported types of notifications are listed in the table below.
Notification Type Abbrev. Meaning
ObjectCreation OC Creation of an object (e.g. new NE in the enmsNETable).

Notification Type Abbrev. Meaning
ObjectDeletion OD Deletion of an object (e.g. NE removed from

enmsNETable).
StateChange SC Change of object state (e.g. operational state).
AttributeChange AC Change of a non-state object attribute (e.g. name).
Alarm Alarm Raise or clear of an alarm originating from a network

object or from the EMS itself.
Table 4 Notification types
The following table shows what notifications are supported for each type of
modelled object:
Object Supported notifications
NE OC, OD, SC, AVC, Alarm
Module OC, OD, SC, AVC, Alarm
Port OC, OD, SC, AVC, Alarm
TP OC, OD, SC, AVC, Alarm
CC None
PortConn OC, OD, AVC
SNC OC, OD, SC, AVC
Service OC, OD, SC, AVC
Ethernet Path OC, OD, SC
Table 5 Supported notifications for modelled objects
In addition to the notifications for the modelled objects, there are also
notifications associated to the SNMP agent and the EMS themselves:
SNMP agent SC (for example, the operational state)
EMS Alarm (for example, “Not enough disk space”)
Table 6 Supported notifications for SNMP agent and EMS
Finally, there are notifications related to Performance Monitoring and Optical

Power Monitoring:

PM request SC
OPM request SC
Table 7 Supported notifications for PM and OPM requests
4.4 Resynchronization after network or manager

errors
In case of network errors or disturbances, traps sent by the SNMP NBI may
not reach the SNMP manager, causing it to become out-of-sync with TNMS.
An out-of-sync situation may also occur if the SNMP manager does receive
the traps, but for some reason is unable to process them.
To help the SNMP manager to detect out-of-sync situations, all traps sent by
the SNMP NBI include a trap counter, which is incremented by one for each
trap. By checking this trap counter, it is possible detect if one or more traps
are missing.
In case an out-of-sync is detected, instead of resynchronizing all tables –
which can be a heavy and lengthy process – the SNMP manager may try first
to identify the objects associated to the missed traps by looking up the trap
history table (enmsTrapHistoryTable, section 8.4). This table contains
information about the last traps sent by the SNMP NBI, and its maximum
length is configurable either via the GUI (see 3.1) or via SNMP by setting the
enmsTrapHistoryTableLength MIB variable (see 8.1).
The trap history table does not carry the full trap details; its purpose is to allow
the SNMP manager to resynchronize only the specific objects associated to
the missed notifications.
4.5 Recommended table retrieval approaches

This section recommends approaches to efficiently access the SNMP NBI
tables using the GET / GETNEXT / GETBULK operations. The NE table
(enmsNETable) and module table (enmsModuleTable) are used in the
examples, but the suggested approaches are to be generalized to the
remaining tables.

4.5.1 Retrieving all rows of a table
In general it is best to read the tables row by row, as opposed to doing it

column by column.
As an example, let’s suppose that the NE table (enmsNETable) contains the
following data:
enmsNeId enmsNeType enmsNeName … enmsNeSystemContainer

(index)
2 ABC NE2 … SYS-1
5 XYZ NE5 … SYS-1
9 EFG NE9 … SYS-2
15 TYU NE15 … SYS-2

Table 8 Example data for enmsNETable
The suggested approach to retrieve all rows in the table consists of performing
successive GETNEXT operations, and in each operation request all fields of
the same row. In this case the SNMP manager starts by requesting the first
row of values:
GETNEXT(enmsNeId, enmsNeType, …, enmsNeSystemContainer)

GETRESPONSE(enmsNeId.2 = 2, enmsNeType.2 = “ABC”, …, enmsNeSystemContainer.2 = “SYS-1”)
Then it successively performs GETNEXT operations using the OIDs on the

last response, until they don’t match the columns of the requested OIDs and
even fall out to the next table (in this case, enmsModuleTable):
GETNEXT(enmsNeId.2, enmsNeType.2, …, enmsNeSystemContainer.2)

GETRESPONSE(enmsNeId.5 = 2, enmsNeType.5 = “XYZ”, …, enmsNeSystemContainer.5 = “SYS-1”)

GETRESPONSE(enmsNeId.9 = 2, enmsNeType.9 = “EFG”, …, enmsNeSystemContainer.9 = “SYS-2”)

GETRESPONSE(enmsNeId.15 = 2, enmsNeType.15 = “TYU”, …, enmsNeSystemContainer.15 = “SYS-2”)

GETRESPONSE(enmsNeType.2 = “ABC”, enmsNeName.2 = “NE2”, …, enmsMoNeId.2 = 2)
The GETNEXT operations above are requesting the index field (enmsNeId)
just for the sake of clarity. In a real implementation, the SNMP manager may
infer the index values from the OIDs of other fields in the same row.

4.5.2 Retrieving specific rows by index
To retrieve a row by index, use the GET operation and request several column
values at once:
GET(enmsNeType.9, …, enmsNeIdName.9)
GETRESPONSE(enmsNeType.9 = “ABC”, …, enmsNeIdName.9 = “NE9”)
4.5.3 Retrieving blocks of rows for a sub-index
Suppose the SNMP manager needs to retrieve all modules of a given NE, let’s
say the NE 9.
enmsMoNeId enmsMoModuleId enmsMoType … enmsMoObjectType

(index) (index)
2 1 CARDX … 1234
2 2 CARDY 321
5 1 CARDZ 545
9 4 CARDX … 1234
9 5 CARDY … 321
9 6 CARDZ 545
15 3 CARDX … 1234
Table 9 Example data for enmsModuleTable
It begins by requesting the first row for the NE 9, by performing a GETNEXT

operation in which the supplied OIDs stop at the enmsMoNEId part of the
index, in this case the value 9 (the enmsMoModuleId part is therefore
omitted):
GETNEXT(enmsMoNeId.9, enmsMoModuleId.9, enmsMoType.9, …, enmsMoSlot.9)

GETRESPONSE(enmsMoNeId.9.4 = 9, enmsMoModuleId.9.4 = 4, enmsMoType.9.4 = “CARDX”, …,
enmsMoSlot.9.4 = 6)
Then it successively performs GETNEXT operations using the OIDs on the

last response, until they belong to a different NE or fall outside of the table:
GETNEXT(enmsMoNeId.9.4, enmsMoModuleId.9.4, enmsMoType.9.4, …, enmsMoSlot.9.4)

GETRESPONSE(enmsMoNeId.9.5 = 9, enmsMoModuleId.9.5 = 5, enmsMoType.9.5 = “CARDY”, …,
enmsMoSlot.9.5 = 4)

GETRESPONSE(enmsMoNeId.9.6 = 9, enmsMoModuleId.9.6 = 6, enmsMoType.9.6 = “CARDZ”, …,

enmsMoSlot.9.6 = 12)

GETRESPONSE(enmsMoNeId.15.3 = 15, enmsMoModuleId.15.3 = 3, enmsMoType.15.3 = “CARDX”, …,
enmsMoSlot.15.3 = 9)
The GETNEXT operations above are requesting the index fields

(enmsMoNeId and enmsMoModuleId) just for the sake of clarity. In a real
implementation, the SNMP manager may alternatively infer the index values
from the OIDs of other fields in the same row.
4.5.4 Response limited size
Each SNMP response must fit in a single UDP packet, whose maximum size
may be insufficient to carry all requested values (the response will have an
error status set to “Too big.”). To avoid such situations you may need to split
the GETNEXT / GETBULK / GET requests into two or more operations.
4.5.5 Request timeouts
SNMP request response time depends on factors such as server load,

network load, table being accessed and volume of data in the table. In case
timeout errors are received, you may need to increase the timeout value on
the SNMP manager.
To confirm that a timeout error is not caused by a more generic problem (e.g.
no network connectivity, SNMP NBI misconfiguration), first perform a GET
operation on a MIB leaf attribute such as enmsProxyName (see 8.1), for which
a response should be returned in a fairly short time.
4.6 Data types

The following table lists the data types used in the SNMP NBI tables and
traps. It is included here for convenience; please check MIB file for actual
enumeration values.
Attribute name Description
DisplayString String of printable characters, meant to be displayed to

humans. Non-ASCII characters are encoded in UTF-8.
Boolean Boolean value:

- false (0)
- true (1)

TrapFilter Indicates if traps are sent for a certain type of notifications:

- sendTrapsOn (1) – Traps are sent
- sendTrapsOff (2) – Traps are blocked
EnmsTimeStamp Human-readable timestamp string. Format:

yyyy-MM-dd HH:mm:ss
Example: 2014-07-09 15:59:30
Except where noted, timestamps are in GMT.
InfoString Parsable character string.
TPIndex String with hexadecimal representation of a TP index.

Example: 2ABF6
UniqueId Unsigned 32-bit unique identifier.
NEId Global identifier of an NE (unsigned 32-bit integer).
ModuleId Module identifier within an NE (unsigned 32-bit integer).
PortId Port identifier within an NE (unsigned 32-bit integer).
TPId Higher or lower 32 bits of a TP identifier within a port

(unsigned 32-bit integer).
PortConnId Global identifier of a port connection (unsigned 32-bit integer).
SNCId Global identifier of an SNC (unsigned 32-bit integer).
CCId Global identifier of a CC (unsigned 32-bit integer).
EthernetPathId Global Identifier of an Ethernet Path (unsigned 32-bit integer).
Bandwidth Character string with one or more bandwidths separated by

commas.
PerceivedSeverity Enumeration of alarm severities:

- cleared(0)
- warning(1)
- minor(2)
- major(3)
- critical(4)
- indeterminate(5)
AlarmClass Enumeration of alarm classes:

- unknown(0)
- communication(1)
- quality(2)
- processing(3)
- equipment(4)
- environment(5)
- system (6)
- threshold (7)
- security (8)

AlarmState Enumeration of alarm states:

- noAlarm(1)
- acknowledged(2)
- unAcknowledged(3)
OperationalState Operability of a resource:

- unknown(1) – The operational state cannot be
determined (e.g. NE disconnected from DCN)
- enabled(2) – The resource is operational
- disabled(3) – The resource is not operational
- partiallyEnabled(4) – The resource is partially
operational.
OperatingMode Ability of an NE to send notifications:

- operation(1) – NE send all notifications
- maintenance(2) – NE suppresses all notifications
AdministrativeState Administrative state of managed objects:

- unknown(0)
- locked(1) – Resource administratively prohibited from
being used
- unlocked(2) – Resource administratively permitted to be
used
UsageState The usage state of a resource:

- idle(1) – The resource is currently not in use
- active(2) – Not used
- busy(3) – The resource is in use (spare operating
capacity may be available, though).
ProtectionState Protection state of a cross-connection:

- non(0) – Not applicable (e.g. CC is unprotected)
- working(1) – Traffic is selected from the working channel
- protecting(2) – Traffic is selected from the protecting
channel(s)
EntityType Type of entity:

- other(0)
- proxy(1)
- module(2)
- ne(3)
- port(4)
- tp(5)
- portConn(6)
- subNetworkConn(7)
- subscriber(8)
- service(9)
- ems(10)
ProbableCause Enumeration of alarm probable causes. See MIB for

enumerated values.

Directionality Direction of a resource:

- unknown(1)
- unidirectional(2)
- bidirectional(3)
NEClass (Future)
Class of an NE.
- singleNode(1)
- repeaterNode(2)
- managementNode(3)
- masterRingNode(4)
- slaveRingNode(5)
PTTechnology Technology of a port. This value is an integer whose bits are

mapped as follows:
- bit 0 (value 1) – PDH
- bit 1 (value 2) – SDH
- bit 2 (value 4) – ATM
- bit 3 (value 8) – WDM
- bit 4 (value 16) – Ethernet
- bit 5 (value 32) – OTH
- bit 6 (value 64) – Data
- bit 7 (value 128) – Generic
PTServiceType Service type of a port. The value is an integer whose bits are
mapped as follows:
- bit 0 (value 1) – Obsolete
- bit 1 (value 2) – The port supports bundle SNCs
- bit 2 (value 4) – The port may not be connected to other
ports
- bit 3 (value 8) – The port does not support unidirectional
SNCs
- bit 4 (value 16) – The port does not support flexible SNCs
PTInterfaceType Type of interface medium:

- unknown(0)
- optical(1)
- electrical(2)
- radio(3)
PTProtectionType Protection type of a port:

- unprotected(0) – No MS Protection
- msLtpWorking(1) – Working port in an MS-LTP
- msLtpWorkingExtra(2) – Working port in an MS-LTP with
extra traffic
- msLtpProtecting(3) – Protecting port in an MS-LTP
- msLtpProtectingExtra(4) – Protecting port in an MS-LTP
with extra traffic
- bshr2East(5) – East port in a 2-fibre BSHR
- bshr2EastExtra(6) – East port in a 2-fibre BSHR with
extra traffic

- bshr2West(7) – West port in a 2-fibre BSHR

- bshr2WestExtra(8) – West port in a 2-fibre BSHR with
extra traffic
- bshr4EastWorking(9) – East working port in a 4-fibre
BSHR
- bshr4EastProtecting(10) – East protecting port in a 4-
fibre BSHR
- bshr4WestWorking(11) – West working port in a 4-fibre
BSHR
- bshr4WestProtecting(12) – West protecting port in a 4-
fibre BSHR
- bshr4TransoceanicEastWorking(13) – East working port
in a Transoceanic 4-fibre BSHR
- bshr4TransoceanicEastProtecting(14) – East protecting
port in a Transoceanic 4-fibre BSHR
- bshr4TransoceanicWestWorking(15) – West working port
in a Transoceanic 4-fibre BSHR
- bshr4TransoceanicWestProtecting(16) – West protecting
port in a Transoceanic 4-fibre BSHR
TPType Termination point type. Obsolete.
TPTerminationType Termination type of a TP:

- connection(1) – CTP
- trail(2) – TTP
TPReliability Reliability of a TP:

- preEmptive(1) - The resource is rather unreliable and will
only be used for low priority services, as long it is not
needed to protect high priority services.
- unprotected(2) - The resource is not protected by MSP
- protected(3) – The resource is protected by MSP
TPEndPointType Indicates whether the TP has the role of a A-end TP (source

TP) or a Z-end TP (destination TP) in a SNC:
- sourceTP(1),
- destinationTP(2)
SNCProtectionInfo Level of protection or broadcast of a connection:

- unprotected(1) – Only 1 source and 1 destination
endpoint.
- simpleProtectionInfo(2) – 1 source and 2 destination
endpoints, or vice-versa.
- extendedProtectionInfo(3) – More than 2 source or 2
destination endpoints.
NotificationType Type of notification in the history table:

- objectCreation(1)
- objectDeletion(2)
- stateChange(3)
- attributeValueChange(4)

- alarm(5)
- relationshipChange(6)
LayerSet Character string with one or more transport layers (e.g. VC4,
OTU1) separated by commas.
TrafficDirection Traffic direction affected by an alarm:

- unknown(0)
- none(1)
- inbound(2)
- outbound(3)
- both(4)
- outboundClientToLine(5)
- outboundLineToClient(6)
EthernetPathType Type of Ethernet Path:

- pointToPoint(1)
- multipointToMultipoint(2)
- rootedMultipoint(3)
EthernetPathStatus Status of an Ethernet Path:

- active
- inactive
- inconsistent
- incomplete
- planned
- inTest
- activating
- deactivating
- activationFailed
- deactivationFailed
PerfMonRequestId Global identifier of a PM request.
PerfMonRequestState State of a PM request:

- unknown(0)
- created(1)
- pending(2)
- started(3)
- finished(4)
- failed(5)
- cancelling(6)
- cancelled(7)
- deleting(8)
PerfMonType Type of PM data to retrieve:

- unknown(0)
- pmHistory(1)
- pmCurrent(2)
PerfMonGranularity Granularity of PM data:

- unknown(0)
- minutes15(1)
- hours24(2)
PerfMonLocation Location of the PM measurement:

- unknown(0)

- nearEnd(1)
- farEnd(2)
PerfMonDirection PMP direction:

- unknown(0)
- none(1)
- incoming(2)
- outcoming(3)
- both(4)
PerfMonStatus Status of a PM parameter value:

- unknown(0)
- valid(1)
- invalid(2)
- incomplete(3)
OptPowerMonRequestId Global identifier of an OPM request.
OptPowerMonRequestState State of an OPM request:

- unknown(0)
- created(1)
- pending(2)
- started(3)
- finished(4)
- failed(5)
- cancelling(6)
- cancelled(7)
- deleting(8)
FilterType Type of object for which to collect PM/OPM data:

- unknown(0)
- tpObject(1)
- portObject(2)
- neObject(3)
- sncObject(4)
- ethernetPathObject(5)
Table 10 Data types used in SNMP NBI MIB
4.7 ‘Obsolete’ and ‘Future’ fields and tables

In the SNMP MIB table descriptions provided in the next chapters, some fields
and tables are classified as “Future” or as “Obsolete”.
“Future” means that the object is not yet supported.
“Obsolete” means that the object is no longer supported and may be removed
from the MIB in the future.

4.8 Strings and multi-language support

SNMP NBI supports multi-language by encoding strings in UTF-8. The SNMP
NBI MIB defines its own DisplayString type as an octet string with display hint
“255t”, equivalent to the SnmpAdminString type in SNMP-FRAMEWORK-MIB.

SNMP NBI MIB – Network Objects TNMS V16.01 – SNMP NBI Operation Guide
5 SNMP NBI MIB – Network Objects
5.1 Network Object Tables
5.1.1 List of NEs (enmsNETable)
This table contains all NEs in the network. It supports OC, OD, AVC and SC
notifications.
Attribute name Data type Notif. Description
enmsNeNEId NEId Global NE identifier (table

index).
enmsNeType DisplayString AVC NE type.
enmsNeName DisplayString AVC NE name, as reported by the

NE.
enmsNeLocation DisplayString AVC NE location in the network

map (topology container).
enmsNeAlarmSeverity PerceivedSeverity Highest severity of all alarms

affecting the NE or its
modules, ports and TPs.
enmsNeOperatingMode OperatingMode AVC NE's ability to send

notifications:
- Operation: The NE reports
all events to TNMS normally;
- Maintenance: The NE is
suppressing all notifications
(typically for maintenance
purposes, to prevent heavy
DCN load).
enmsNeOpState OperationalState SC NE operational state.
enmsNeCanBroadcast Boolean Indicates if at least one port

has broadcast capabilities.
enmsNeCanPathProtection Boolean Indicates if at least one port

has protection capabilities
(SNCP).
enmsNeClass NEClass (Future)

TNMS V16.01 – SNMP NBI Operation Guide SNMP NBI MIB – Network Objects
enmsNeExternalNEId InfoString Obsolete.
enmsNeIsPseudoNE Boolean Obsolete.
enmsNeIdName DisplayString AVC NE name, as specified by the

operator in TNMS.
enmsNeCommunicationState OperationalState AVC Indicates whether the

communication with the NE is
fully operational.
enmsNeDCNLocation DisplayString Path to the NE in the DCN

tree.
(Future)
enmsNeSystemContainer DisplayString AVC System container name.
Table 11 enmNETable attributes
5.1.2 List of Modules (enmsModuleTable)
This table contains all modules in the network. It supports OC, OD and SC
notifications.
enmsMoNEId NEId NE identifier (table index).
enmsMoModuleId ModuleId Module Identifier within the NE

(table index).
enmsMoType DisplayString Type of module. (Obsolete)
enmsMoName DisplayString Module name.
enmsMoOpState OperationalState SC Operational state of the module.
enmsMoShelf DisplayString Shelf of the module, preceded by

the rack number, if applicable.
Example: 02-005
enmsMoSlot DisplayString Slot number of the module. If
present, the sub-slot is
appended, separated by a dot.
enmsMoObjectType Integer32 Internal object type.
Table 12 enmsModuleTable attributes

5.1.3 List of Ports (enmsPortTable)
This table contains all ports in the network. It supports OC, OD, AVC and SC
notifications.
enmsPtNEId NEId NE identifier (table index).
enmsPtPortId PortId Port Identifier within the NE.

(table index).
enmsPtName DisplayString AVC Port name.
enmsPtModuleId ModuleId Obsolete.
enmsPtTechnology PTTechnology Transport technology.
enmsPtServiceType PTServiceType Supported service types.
enmsPtInterfaceType PTInterfaceType Type of interface.
enmsPtBandwidth Bandwidth Port bandwidth.
enmsPtOpState OperationalState Obsolete.
enmsPtOperatingMode OperatingMode Obsolete.
enmsPtDirection Directionality Port direction.
enmsPtCanBroadcast Boolean Indicates if the port has

broadcast capabilities.
enmsPtCanPathProtection Boolean Indicates if the port has

protection capabilities
(SNCP).
enmsPtAlarmSeverity PerceivedSeverity Highest severity of all alarms

affecting the port or its TPs.
enmsPtAdminState AdministrativeState Obsolete.
enmsPtOpStateTX OperationalState SC Operational state in TX

direction.
enmsPtOpStateRX OperationalState SC Operational state in RX

direction.
enmsPtModuleIdTX ModuleId Module ID for TX direction.
enmsPtModuleIdRX ModuleId Module ID for RX direction.
enmsPtLayerSet LayerSet Terminated layers.
enmsPtProtectionType PTProtectionType AVC Protection type.

Table 13 enmsPortTable attributes
5.1.4 List of Termination Points (enmsTPTable)
This table contains all termination points in the network. It supports OC, OD,
AVC and SC notifications.
enmsTpNEId NEId NE Id (table index).
enmsTpPortId PortId Port Id (table index).
enmsTpTPIdH TPId Higher 32 bits of TP Id (table

index).
enmsTpTPIdL TPId Lower 32 bits of TP Id (table

index).
enmsTpTPIndex TPIndex TP index relative to the port

(might be a timeslot index).
enmsTpNxCount Integer32 AVC Inverse multiplexing number in

case the TP represents a
virtual concatenated group.
Otherwise, value is 1.
enmsTpName DisplayString AVC TP name.
enmsTpBandwidth Bandwitdh TP bandwidth.
enmsTpTPType TPType Obsolete.
enmsTpTerminType TPTerminationType Termination type.
enmsTpDirection Directionality TP direction.
enmsTpOpStateTX OperationalState SC Operational state in TX

direction.
enmsTpOpStateRX OperationalState SC Operational state in RX

direction.
enmsTpAlarmSeverity PerceivedSeverity Highest severity of all alarms

affecting the TPs.
enmsTpAdminState OperationalState Obsolete.
enmsTpUsageCountTX Integer32 (Future)

Number of cross connections

using the TP for the TX
direction.
enmsTpUsageCountRX Integer32 (Future)

Number of cross connections
using the TP for the RX
direction.
enmsTpUsageStateTX UsageState (Future)

Usage state in the TX
direction.
enmsTpUsageStateRX UsageState (Future)

Usage state in the RX
direction.
enmsTpReliability TPReliability Obsolete.
enmsTpLayerSet LayerSet TP transport layer set.
enmsTpBandwidthTX Bandwidth (Future)

TP bandwidth in the TX
direction.
enmsTpBandwidthRX Bandwidth (Future)

TP bandwidth in the RX
direction.
enmsTpParentPortId PortId Port Id of parent TP (if

applicable).
enmsTpParentTPIdH TPId Higher 32 bits of TP Id of

parent TP (if applicable).
enmsTpParentTPIdL TPId Lower 32 bits of TP Id of

parent TP (if applicable).
enmsTpFragmentLayer LayerSet Fragment layer set in case the

TP represents a VC group.
enmsTpMuxPartnerTPIdH TPId Higher 32 bits of TP Id of

multiplex partner TP (if
applicable).
enmsTpMuxPartnerTPIdL TPId Lower 32 bits of TP Id of

multiplex partner TP (if
applicable).
Table 14 enmsTPTable attributes

5.1.5 List of Port Connections (enmsPortConnTable)
This table contains all managed ports connections. It supports OC, OD and
AVC notifications.
enmsPcPortConnId PortConnId Port Connection identifier

(table index).
enmsPcSrcNEId NEId NE Id of source port.
enmsPcSrcPortId PortId Port Id of source port.
enmsPcDstNEId NEId NE Id of destination port.
enmsPcDstPortId PortId Port Id of destination port.
enmsPcName DisplayString AVC Port connection name.
enmsPcSrcAlarmSeverity PerceivedSeverity AVC Highest severity of all alarms

affecting the source port or
module.
enmsPcDstAlarmSeverity PerceivedSeverity AVC Highest severity of all alarms

affecting the destination port
or module.
enmsPcBandwidth Bandwidth Port connection bandwidth.
enmsPcDirection Directionality Port connection direction.
enmsPcLayerSet LayerSet Port connection layer set.
Table 15 enmsPortConnTable attributes
5.2 Network Object Notifications
5.2.1 NE object creation (enmsNEObjectCreationTrap)
Attribute name Data type Description
enmsTrapCounter Counter32 Trap counter for synchronization.
enmsNeNEId NEId Global NE identifier.
enmsNeName DisplayString NE name, as reported by the NE.
enmsTrapEventDetails DisplayString Empty.

enmsTrapNeIdName DisplayString NE name, as specified by the operator

in TNMS.
enmsNeSystemContainer DisplayString System container of the NE.
Table 16 enmsNEObjectCreationTrap attributes
5.2.2 NE object deletion (enmsNEObjectDeletionTrap)
enmsTrapNeIdName DisplayString NE name, as specified by the operator

in TNMS.
Table 17 enmsNEObjectDeletionTrap attributes
5.2.3 NE state change (enmsNEStateChangeTrap)
enmsTrapEventSeverity PerceivedSeverity Not relevant.
enmsTrapEventProbableCause ProbableCause Not relevant.
enmsTrapStateName Integer Indicates which table field

changed. Check possible values
in MIB definition.
enmsTrapStateOldValue Integer State old value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer State new value. Check the

changed attribute.
enmsTrapNeIdName DisplayString NE name, as specified by the

operator in TNMS.
Table 18 enmsNEStateChangeTrap attributes
5.2.4 NE attribute value change (enmsNEAttributeChangeTrap)

Note: In case the AVC relates to
the NE name, this field contains
the new value.
enmsTrapAttributeName Integer Indicates which table field

in MIB definition.
enmsTrapAttributeOldValue DisplayString Attribute old value.
enmsTrapAttributeNewValue DisplayString Attribute new value.
enmsTrapNeIdName DisplayString NE name, as specified by the

operator in TNMS.
the NE Id name, this field contains
the new value.
Table 19 enmsNEAttributeChangeTrap attributes

5.2.5 Module object creation (enmsModuleObjectCreationTrap)
enmsMoNEId NEId Global NE identifier.
enmsMoModuleId ModuleId Module identifier.
Table 20 enmsModuleObjectCreationTrap attributes
5.2.6 Module object deletion (enmsModuleObjectDeletionTrap)
Table 21 enmsModuleObjectCreationTrap attributes
5.2.7 Module state change (enmsModuleStateChangeTrap)

in MIB definition.


changed attribute.

changed attribute.
Table 22 enmsModuleStateChangeTrap attributes
5.2.8 Module attribute value change (enmsModuleAttributeChangeTrap)

in MIB definition.
Table 23 enmsModuleAttributeChangeTrap attributes
5.2.9 Port object creation (enmsPortObjectCreationTrap)
enmsPtNEId NEId Global NE identifier.
enmsPtPortId PortId Port identifier.
enmsPtName DisplayString Port name.

Table 24 enmsPortObjectCreationTrap attributes
5.2.10 Port object deletion (enmsPortObjectDeletionTrap)
Table 25 enmsPortObjectDeletionTrap attributes
5.2.11 Port state change (enmsPortStateChangeTrap)

in MIB definition.

changed attribute.

changed attribute.
Table 26 enmsPortStateChangeTrap attributes

5.2.12 Port attribute value change (enmsPortAttributeChangeTrap)

the port name, this field contains
the new value.

in MIB definition.
Table 27 enmsPortAttributeChangeTrap attributes
5.2.13 TP object creation (enmsTPObjectCreationTrap)
enmsTpNEId NEId Global NE identifier.
enmsTpPortId PortId Port identifier.
enmsTpTPIdH TPId Higher 32 bits of TP Id.
enmsTpTPIdL TPId Lower 32 bits of TP Id.
enmsTpName DisplayString TP name.
enmsTpTPType TPType Obsolete. Always unknown.
Table 28 enmsTPObjectCreationTrap attributes

5.2.14 TP object deletion (enmsTPObjectDeletionTrap)
Table 29 enmsTPObjectDeletionTrap attributes
5.2.15 TP state change (enmsTPStateChangeTrap)

in MIB definition.


changed attribute.

changed attribute.
Table 30 enmsTPStateChangeTrap attributes
5.2.16 TP attribute value change (enmsTPAttributeChangeTrap)

in MIB definition.
Table 31 enmsTPAttributeChangeTrap attributes

5.2.17 Port connection object creation

(enmsPortConnObjectCreationTrap)
enmsPcPortConnId PortConnId Global port connection identifier.
enmsPcName DisplayString Port connection name.
Table 32 enmsPortConnObjectCreationTrap attributes
5.2.18 Port connection object deletion

(enmsPortConnObjectDeletionTrap)
Table 33 enmsPortConnObjectDeletionTrap attributes
5.2.19 Port connection attribute value change

(enmsPortConnAttributeChangeTrap)

the port connection name, this
field contains the new value.


in MIB definition.
Table 34 enmsPortConnAttributeChangeTrap attributes

SNMP NBI MBI – Connection Management TNMS V16.01 – SNMP NBI Operation Guide
6 SNMP NBI MBI – Connection

Management
6.1 Connection Management Tables
6.1.1 List of Sub-Network Connections (enmsSNCTable)
This table contains all paths of the Optical Manager. It supports OC, OD, AVC
and SC notifications.
enmsScSNCId SNCId SNC Id (table index).
enmsScSrcNEId NEId Identifier of the first A-end in

the list of path edges.
enmsScSrcPortId PortId
enmsScSrcTPIdH TPId
enmsScSrcTPIdL TPId
enmsScDestNEId NEId Identifier of the first Z-end in

the list of path edges.
enmsScDestPortId PortId
enmsScDestTPIdH TPId
enmsScDestTPIdL TPId
enmsScSrc2NEId NEId Identifier of the second A-

end in the list of path edges.
enmsScSrc2PortId PortId
enmsScSrc2TPIdH TPId
enmsScSrc2TPIdL TPId
enmsScDest2NEId NEId Identifier of the second Z-

end in the list of path edges.
enmsScDest2PortId PortId
enmsScDest2TPIdH TPId
enmsScDest2TPIdL TPId

TNMS V16.01 – SNMP NBI Operation Guide SNMP NBI MBI – Connection Management
enmsScServiceId ServiceId Identifier of enclosing

service, if applicable.
enmsScName DisplayString AVC SNC name as presented in

the TNMS GUI.
enmsScOpState OperationalState SC Operational state.

The value of this field will be
‘enabled’ if and only if in
TNMS the ACS is ‘Active’
and the Operational State is
‘Enabled’.
enmsScAdminState AdministrativeState SC Administrative state.

This value reflects the RCS
of the path: ‘unlocked’ if
RCS is ‘Active’, otherwise
‘locked’.
enmsScAlarmSeverity PerceivedSeverity Highest severity of all alarms

affecting this SNC.
enmsScBandwidth Bandwidth SNC bandwidth.
enmsScDirection Directionality SNC direction.
enmsScProtectionFlag Boolean Obsolete.
enmsScProtectionInfo SNCProtectionInfo Level of SNC protection or

broadcast.
enmsScNxCount Unsigned32 The inverse multiplexing

number, in case the SNC
represents a virtual
concatenated group.
enmsScSNCOwnerId SNCId (Future)
enmsSCLayerSet LayerSet Layer set of the SNC.
enmsScFragmentLayer LayerSet The layer of the fragments,

in case the SNC represents
a virtual concatenated
group.
enmsScMinBandwidth Bandwidth AVC Minimum actual or required

bandwidth of all edges of the
SNC connection topology.
enmsScRequiredBandwidth Boolean AVC Indicates whether the value

of the attribute Bandwidth is
required (explicitly assigned
by the operator).

Table 35 enmsSNCTable attributes
6.1.2 List of Ethernet Paths (enmsEthernetPathTable)
This table contains all the services of the Ethernet Manager. It supports OC,
OD, and SC notifications.
enmsEvcEthernetPathId EthernetPathId SC Ethernet Path id (table

index)
enmsEvcName DisplayName Ethernet Path name.
enmsEvcSVlanId Integer32 S-VLAN Id
enmsEvcType EthernetPathType Ethernet Path type.
enmsEvcServiceId ServiceIdentifier Identifier of enclosing

service, if applicable.
enmsEvcOpState OperationalState SC Operational State
enmsEvcAdminState AdministrativeState SC Administration State
enmsEvcAlarmSeverity PerceivedSeverity SC Highest severity of all alarms

affecting this Ethernet Path.
Table 36 enmsEthernetPathTable attributes
6.1.3 List of Services (enmsServiceTable)
This table contains all services defined in TNMS (containers of type ‘Service’).
enmsSvServiceId (index) Unsigned32 Service Id (table index).
enmsSvSubscriberId (index) Unsigned32 (future)
enmsSvLabel DisplayString AVC Name of the service.
enmsSvOpState OperationalState SC Operational state of the

service. It corresponds to the
most severe operational
state of the associated
SNCs. From the least severe
to the most severe
operational state, we have:
- ‘enabled’
- ‘partiallyEnabled’
- ‘disabled’

- ‘unknown’
enmsSvAdminState AdministrativeState SC Administrative state of the

service, calculated as
follows:
- ‘unlocked’ if the service
contains SNCs and all of
them have adminState set to
’unlocked’
- ‘locked’ if at least one of its
SNCs has adminState set to
’locked’
- ‘unknown’ in all other
situations.
enmsSvDirection Directionality Obsolete
enmsSvProtectionFlag Boolean Obsolete
enmsSvWriteProtected Boolean Obsolete
enmsSvServiceOwnerId Unsigned32 Obsolete
Table 37 enmsServiceTable attributes
6.1.4 List of Cross Connections (enmsCCTable)
This table contains all cross connections in the network. It does not support
any type of notifications.
enmsCcNEId (index) CCId NE Id (table index).
enmsCcCCId (index) CCId CC identifier within NE (table

index).
enmsCcSrcNEId NEId Identifier of the A-end TP.
enmsCcSrcPortId PortId
enmsCcSrcTPIdH TPId
enmsCcSrcTPIdL TPId
enmsCcDestNEId NEId Identifier of the Z-end TP.
enmsCcDestPortId PortId
enmsCcDestTPIdH TPId

enmsCcDestTPIdL TPId
enmsCcSrc2NEId NEId Identifier of the second A-

end TP.
enmsCcSrc2PortId PortId
enmsCcSrc2TPIdH TPId
enmsCcSrc2TPIdL TPId
enmsCcDest2NEId NEId Identifier of the second Z-

end TP.
enmsCcDest2PortId PortId
enmsCcDest2TPIdH TPId
enmsCcDest2TPIdL TPId
enmsCcOpState OperationalState Operational state.
enmsCcDirection Directionality CC direction.
enmsCcProtectionFlag Boolean Indicates whether CC is

protected.
enmsCcProtectionState SNCProtectionInfo Actual protection state.
enmsCcNxCount Unsigned32 Used whenever more than a

single termination point is
connected as a bundle.
Table 38 enmsCCTable attributes
6.2 Connection Management Notifications
6.2.1 SNC object creation (enmsSNCObjectCreationTrap)
enmsScSNCId SNCId Global SNC identifier.
enmsScName DisplayString SNC name.
Table 39 enmsSNCObjectCreationTrap attributes

6.2.2 SNC object deletion (enmsSNCObjectDeletionTrap)
Table 40 enmsSNCObjectDeletionTrap attributes
6.2.3 SNC state change (enmsSNCStateChangeTrap)

in MIB definition.

changed attribute.

changed attribute.
Table 41 enmsSNCStateChangeTrap attributes
6.2.4 SNC attribute value change (enmsSNCAttributeChangeTrap)


the SNC name, this field contains
the new value.

in MIB definition.
Table 42 enmsSNCAttributeChangeTrap attributes
6.2.5 Service object creation (enmsServiceObjectCreationTrap)
enmsSvServiceId ServiceId Global service identifier.
enmsSvLabel DisplayString Service name.
Table 43 enmsServiceObjectCreationTrap attributes
6.2.6 SNC object deletion (enmsServiceObjectDeletionTrap)

Table 44 enmsServiceObjectDeletionTrap attributes
6.2.7 Service state change (enmsServiceStateChangeTrap)

in MIB definition.

changed attribute.

changed attribute.
Table 45 enmsServiceStateChangeTrap attributes
6.2.8 Service attribute value change (enmsServiceAttributeChangeTrap)
enmsSvServiceId SNCId Global service identifier.

the SNC name, this field contains
the new value.


in MIB definition.
Table 46 enmsServiceAttributeChangeTrap attributes
6.2.9 Ethernet Path object creation

(enmsEthernetPathObjectCreationTrap)
enmsEvcEthernetPathId EthernetPathId Global Ethernet Path identifier.
enmsEvcName DisplayString Ethernet Path name.
Table 47 enmsEthernetPathObjectCreationTrap attributes
6.2.10 Ethernet Path object deletion

(enmsEthernetPathObjectDeletionTrap)
Table 48 enmsEthernetPathObjectDeletionTrap attributes
6.2.11 Ethernet Path state change (enmsEthernetPathStateChangeTrap)


in MIB definition.

changed attribute.

changed attribute.
Table 49 enmsEthernetPathStateChangeTrap attributes
6.2.12 Ethernet Path attribute value change

(enmsEthernetPathAttributeChangeTrap)

the Ethernet Path name, this field
contains the new value.

in MIB definition.

Table 50 enmsEthernetPathAttributeChangeTrap attributes

TNMS V16.01 – SNMP NBI Operation Guide SNMP NBI MIB – Fault management
7 SNMP NBI MIB – Fault management
7.1 Fault Management Tables
7.1.1 Global alarm list (enmsAlarmTable)
This table contains all active alarms in TNMS. Its single index value
(enmsAlAlarmNumber) is not an identifier of the alarm: it corresponds to the
position of the alarm in the list and therefore may change between table
retrievals. Because of that, this table is not meant to be accessed randomly,
via GET operations. Instead, it should be retrieved row by row from top to
bottom, using GETNEXT / GETBULK operations.
The following combination of fields may be used to identify an alarm and relate
it to other tables and traps:
enmsAlProbableCause +
enmsAlTimeStamp +
enmsAlEntityString +
enmsAlNEId +
enmsAlPortId +
enmsAlTPIdH +
enmsAlTPIdL
System alarms (i.e. raised by the EMS itself) can be distinguished by having
the NE Id (enmsAlNEId) set to zero.
enmsAlAlarmNumber Integer32 Table index. Does not identify the

alarm and may change each time
the table is retrieved.
enmsAlSeverity PerceivedSeverity Severity of the alarm.
enmsAlProbableCause ProbableCause Probable Cause of the alarm.
enmsAlClass AlarmClass Class of the alarm.
enmsAlServiceAffect Boolean Indicates whether the alarm is

traffic affecting.

SNMP NBI MIB – Fault management TNMS V16.01 – SNMP NBI Operation Guide
enmsAlState AlarmState Indicates whether the alarm has

been acknowledged.
enmsAlTimeStampFromNE Boolean Indicates whether the timestamp

has been generated by the NE or
by TNMS.
enmsAlTimeStamp EnmsTimeStamp Alarm raising timestamp.
enmsAlEntityString DisplayString Description of the alarm originating

entity.
enmsAlEntityType EntityType Type of alarm originating entity.
enmsAlNEId NEId NE Id of the originating entity.
enmsAlPortId PortId Port Id of the originating entity, if

applicable.
enmsAlTPIdH TPId Higher 32 bits of TP Id of

originating entity, if applicable.
enmsAlTPIdL TPId Lower 32 bits of TP Id of originating

entity, if applicable.
enmsAlTPName DisplayString Name of the originating TP, if

applicable.
enmsAlModuleId ModuleId Id of the originating module, if

applicable.
enmsAlProbableCauseString DisplayString Probable Cause in text form.
enmsAlNELocation DisplayString NE location of originating entity, as

reported by the NE itself.
enmsAlAffectedLocation DisplayString Extended textual description of the

alarm originating entity.
enmsAlTrafficDirection TrafficDirection Affected traffic direction.
enmsAlAdditionalInformation DisplayString Optional additional information.
enmsAlNeSystemContainer DisplayString System container name of the

originating NE.
Table 51 enmsAlarmTable attributes

7.1.2 Alarms for NE (enmsAlarmsForNETable)
This table contains all alarms originating in an NE or entities contained in it

(modules, ports and TPs). Its indexes allow retrieving the alarms for a selected
NE.
enmsA2NEId NEId NE Id of the originating entity (table

index).
enmsA2Severity PerceivedSeverity Severity of the alarm (table index).
enmsA2AlarmNumber Integer32 Additional table index. Does not

identify the alarm and may change
each time the table is retrieved.
enmsA2ProbableCause ProbableCause Probable Cause of the alarm.
enmsA2Class AlarmClass Class of the alarm.
enmsA2ServiceAffect Boolean Indicates whether the alarm affects

a service.
enmsA2State AlarmState Indicates whether the alarm has

been acknowledged.
enmsA2TimeStampFromNE Boolean Indicates whether the timestamp

by TNMS.
enmsA2TimeStamp EnmsTimeStamp Alarm raising timestamp.
enmsA2EntityString DisplayString Description of the alarm originating

entity.
enmsA2EntityType EntityType Type of alarm originating entity.
enmsA2PortId PortId Port Id of the originating entity, if

applicable.
enmsA2TPIdH TPId Higher 32 bits of TP Id of

enmsA2TPIdL TPId Lower 32 bits of TP Id of

enmsA2TPName DisplayString Name of the originating TP, if

applicable.
enmsA2ModuleId ModuleId Id of the originating module, if

applicable.
enmsA2ProbableCauseString DisplayString Probable Cause in text form.

enmsA2NELocation DisplayString NE location of originating entity, as

enmsA2AffectedLocation DisplayString Extended textual description of the

enmsA2TrafficDirection TrafficDirection Affected traffic direction.
enmsA2AdditionalInformation DisplayString Optional additional information.
enmsA2NeSystemContainer DisplayString System container name of the

originating NE.
Table 52 enmsAlarmsForNETable attributes
7.1.3 Alarms for Ports (enmsAlarmsForPortTable)
This table contains all alarms originating in a port or a TP contained in it. Its
indexes allow retrieving the alarms for a selected port.

index).
enmsA3PortId PortId Port Id of the originating entity

(table index).

enmsA3ServiceAffect Boolean Indicates whether the alarm is

traffic affecting.

been acknowledged.

by TNMS.


entity.



applicable.



originating NE.
Table 53 enmsAlarmsForPortTable attributes
7.1.4 Alarms for TP (enmsAlarmsForTPTable)
This table contains all alarms originating in a TP. Its indexes allow retrieving
the alarms for a selected TP.

index).
enmsA4PortId PortId Port Id of the originating entity

(table index).

originating entity (table index).

originating entity (table index).



traffic affecting.

been acknowledged.

by TNMS.

entity.

applicable.



originating NE.
Table 54 enmsAlarmsForTPTable attributes
7.1.5 Alarms for Port Connections (enmsAlarmsForPortConnTable)
This table contains all alarms affecting a port connection, which include all
alarms originating in the endpoint ports or in the associated modules. Its
indexes allow retrieving the alarms for a selected port connection.

enmsA5PortConnId PortConnId Id of the Port Connection affected

by the alarm (table index).


traffic affecting.

been acknowledged.

by TNMS.

entity.
enmsA5NEId NEId NE Id of the originating entity.
enmsA5PortId PortId Port Id of the originating entity.
enmsA5TPIdH TPId Not applicable. Obsolete.
enmsA5TPIdL TPId Not applicable. Obsolete.
enmsA5TPName DisplayString Not applicable. Obsolete.

applicable.



Table 55 enmsAlarmsForPortConnTable attributes
7.1.6 Alarms for Modules (enmsAlarmsForModuleTable)
This table contains all alarms originating in a module. Its indexes allow
retrieving the alarms for a selected module.
enmsA8NEId NEId NEId of the originating entity (table

index).
enmsA8ModuleId ModuleId ModuleId of the originating entity

(table index).


traffic affecting.

been acknowledged.

by TNMS.

entity.
enmsA8PortId PortId Not applicable. Obsolete.




originating NE.
Table 56 enmsAlarmsForModuleTable attributes
7.1.7 Alarms for SNCs (enmsAlarmsForSNCTable)
This table contains all alarms affecting SNCs. Its indexes allow retrieving the
alarms for a selected SNC.
enmsA6SNCId PortConnId Id of the SNC affected by the alarm

(table index).


traffic affecting.

been acknowledged.

by TNMS.

entity.

enmsA6NEId NEId NE Id of the originating entity.
enmsA6PortId PortId Port Id of the originating entity.

applicable.


Table 57 enmsAlarmsForSNCTable attributes
7.2 Fault Management Notifications
7.2.1 NE alarm (enmsNEAlarmTrap)
enmsTrapCounter Counter32 Trap counter for

synchronization.
enmsTrapEventSeverity PerceivedSeverity Severity of the alarm, or

‘cleared’ if alarm is cleared.
enmsTrapEventProbableCause ProbableCause Probable Cause of the

alarm.

enmsAlClass AlarmClass Alarm class.
enmsAlState AlarmState Indicates whether the alarm

has been acknowledged.
enmsAlTimeStamp EnmsTimeStamp Alarm raise/clear

timestamp.
enmsAlEntityString DisplayString Description of the alarm

originating entity.
enmsTrapEventProbableCauseString DisplayString Probable Cause of the

alarm in string format.
enmsNeName DisplayString NE name, as reported by

the NE.
enmsTrapNeLocationLct DisplayString NE location, as reported by

the NE.
enmsTrapNeIdName DisplayString NE name, as specified by

the operator in TNMS.
enmsTrapAffectedLocation DisplayString Extended textual

description of the alarm
originating entity.
enmsTrapEventTrafficDirection TrafficDirection Affected traffic direction.
enmsAlServiceAffect Boolean Indicates whether the alarm

is traffic affecting.
enmsAlAdditionalInformation DisplayString Optional additional

information.
enmsAlNeSystemContainer DisplayString System container name of

the originating NE.
Table 58 enmsNEAlarmTrap attributes
7.2.2 Module alarm (enmsModuleAlarmTrap)

synchronization.



alarm.
enmsAlClass AlarmClass Class of the alarm.


timestamp.

originating entity.


the NE.

the NE.

the operator in the DCN
properties.

originating entity.


information.

the originating NE.
Table 59 enmsModuleAlarmTrap attributes

7.2.3 Port alarm (enmsPortAlarmTrap)

synchronization.


alarm.
enmsAlClass AlarmClass (Future)


timestamp.

originating entity.


the NE.

the NE.


originating entity.


information.


the originating NE.
Table 60 enmsPortAlarmTrap attributes
7.2.4 TP alarm (enmsTPAlarmTrap)

synchronization.


alarm.


timestamp.

originating entity.


the NE.

the NE.



originating entity.


information.

the originating NE.
Table 61 enmsTPAlarmTrap attributes
7.2.5 EMS alarm (enmsEMSAlarmTrap)

synchronization.
enmsTrapEventSeverity PerceivedSeverity Severity of the alarm.

alarm.

enmsAlTimeStamp EnmsTimeStamp Alarm raising timestamp.

originating entity.


information.
Table 62 enmsEMSAlarmTrap attributes


TNMS V16.01 – SNMP NBI Operation Guide SNMP NBI MIB – EMS and SNMP agent
8 SNMP NBI MIB – EMS and SNMP agent
8.1 Agent information (enmsControl)

This branch contains several variables with information about the SNMP NBI
component itself.
enmsProxyName DisplayString Proxy name, as defined in the

SNMP NBI preferences (see 3.1).
enmsProxyOpState OperationalState Operational state. Always ‘enabled’,

otherwise not possible to retrieve the
value.
enmsNetworkName DisplayString Network name, as defined in the

SNMP NBI preferences (see 3.1).
enmsTrapHistoryTableLength Integer32 Maximum length of the trap history

table (see 4.4).
This field is writable.
enmsTrapCounter Counter32 Trap counter of the last trap sent, or

zero if none. The trap counter
always resets to zero when TNMS is
restarted. See also 4.4.
enmsProxyPSTAMP DisplayString Production stamp of the SNMP NBI

component.
enmsEnterpriseId OID OID of the enterprise node of the

SNMP NBI.
enmsMIBVersion DisplayString Version of the SNMP NBI MIB.

Matches the LAST-UPDATE clause
in the MIB definition file.
enmsEMSVersion DisplayString Version of the TNMS installation.
enmsTimeStampFormat DisplayString Format of the timestamp values.

Currently returns always “yyyy-MM-
dd HH:mm:ss”.
enmsInformTimeout Integer32 Maximum number of seconds that

SNMP NBI will wait for an Inform
response before retrying. Allowed

SNMP NBI MIB – EMS and SNMP agent TNMS V16.01 – SNMP NBI Operation Guide
values are between 1 and 60

seconds.
enmsInformMaxTries Integer32 Maximum number of times that

SNMP NBI will try to send an Inform
notification to each destination.
Allowed values are between 1 and 5
tries.
enmsHeartbeatOpState OperationalState Indicates whether heartbeat

notifications are to be sent. Valid
values are ‘enabled’ and ‘disabled’.
enmsHeatbeatInterval Integer32 Heartbeat interval in seconds.

Allowed values are between 5 and
86400 seconds.
Table 63 enmsControl variables
8.2 SNMP agent notifications
8.2.1 Agent state change (enmsProxyStateChangeTrap)
enmsProxyName DisplayString Agent name, as specified in the

properties.
enmsProxyOpState OperationalState Agent operational state.
Table 64 enmsProxyStateChangeTrap attributes
8.3 Notification filtering (enmsTrapFilter)

This branch contains variables that indicate the state of the notification filters
(see 3.4). These variables are writable – the SNMP manager is able to
activate and deactivate the notifications via SET operations.

TNMS V16.01 – SNMP NBI Operation Guide SNMP NBI MIB – EMS and SNMP agent
enmsCommonTrapFilter TrapFilter Indicates whether common

notifications are enabled.
enmsNETrapFilter TrapFilter Indicates whether NE notifications

(except alarms) are enabled.
enmsModuleTrapFilter TrapFilter Indicates whether Module

notifications (except alarms) are
enabled.
enmsPortTrapFilter TrapFilter Indicates whether Port notifications

enmsTPTrapFilter TrapFilter Indicates whether TP notifications

enmsPortConnTrapFilter TrapFilter Indicates whether Port Connection

notifications (except alarms) are
enabled.
enmsSNCTrapFilter TrapFilter Indicates whether SNC notifications

are enabled.
enmsServiceTrapFilter TrapFilter Indicates whether Service

enmsNEAlarmTrapFilter TrapFilter Indicates whether NE alarm

enmsModuleAlarmTrapFilter TrapFilter Indicates whether Module alarm

enmsPortAlarmTrapFilter TrapFilter Indicates whether Port alarm

enmsTPAlarmTrapFilter TrapFilter Indicates whether TP alarm

enmsEMSAlarmTrapFilter TrapFilter Indicates whether EMS alarm

enmsEthernetPathTrapFilter TrapFilter Indicates whether Ethernet Path

Table 65 enmsTrapHistoryTable attributes
8.4 Notification history (enmsTrapHistoryTable)

The notification history table contains information about the last notifications
sent. It is mainly used for data resynchronization in case of missing
notifications because of network errors (see 4.4).

SNMP NBI MIB – EMS and SNMP agent TNMS V16.01 – SNMP NBI Operation Guide
enmsHiTrapNumber (index) Integer32 Index for the table. Has no correlation

with the trap counter.
enmsHiTrapEntityType EntityType Type of entity associated to the trap.
enmsHiTrapFirstId UniqueId First ID of the entity associated with the

trap (NEId / PortConnId / SNCId /
EthernetPathId).
enmsHiTrapSecondId UniqueId Second ID of the entity associated with

the trap (ModuleId, PortId).
enmsHiTrapTPIdH TPId Higher 32 bits of TP Id, if applicable.
enmsHiTrapTPIdL TPId Lower 32 bits of TP Id, if applicable.
enmsHiTrapNfyType NotificationType Type of notification (OC, OD, Alarm,

etc.).
enmsHiTrapCounter Counter32 Trap counter, as has been sent in the

trap.
Table 66 enmsTrapHistoryTable attributes

TNMS V16.01 – SNMP NBI Operation Guide Ethernet Paths – Support of MEF 40
9 Ethernet Paths – Support of MEF 40
9.1 MEF-UNI-EVC-MIB
TNMS SNMP NBI provides preliminary support for the MEF MIB for the
management of User Network Interfaces (UNIs) and Ethernet Virtual
Connections (EVCs). Currently only basic Ethernet Path retrieval is supported.
Specification of notifications in MEF 40 is not final and as such not
implemented by SNMP NBI. To monitor changes to Ethernet Paths, use the
SNMP NBI MIB notifications instead (see section 6.2).
For more information on the MEF MIB, please refer to the MEF 40 Technical
Specification available on the MEF web site (www.mef.net).
9.1.1 mefServiceEvcCfgTable
The ‘mefServiceEvcCfgTable’ table lists all the Ethernet Paths. This table
implementation is read-only, therefore adding rows is not supported.
Attribute name Data type Notes
mefServiceEvcCfgIndex Unsigned32 Table index.
mefServiceEvcCfgIdentifier DisplayString
mefServiceEvcCfgServiceType INTEGER
mefServiceEvcCfgMtuSize Unsigned32
mefServiceEvcCfgCevlanIdPreservation MefServicePreservationType
mefServiceEvcCfgCevlanCosPreservation MefServicePreservationType
mefServiceEvcCfgUnicastDelivery MefServiceDeliveryType (future)
mefServiceEvcCfgMulticastDelivery MefServiceDeliveryType (future)
mefServiceEvcCfgBroadcastDelivery MefServiceDeliveryType (future)
mefServiceEvcCfgL2cpGrpIndex Unsigned32 (future)
mefServiceEvcCfgAdminState EntityAdminState
mefServiceEvcCfgRowStatus RowStatus Not used (table

is read-only)

Ethernet Paths – Support of MEF 40 TNMS V16.01 – SNMP NBI Operation Guide
Table 67 mefServiceEvcCfgTable attributes
9.1.2 mefServiceEvcStatusTable
The ‘mefServiceEvcStatusTable’ table shows the status of the Ethernet Paths.

It has a 1:1 relation with ‘mefServiceEvcCfgTable’.
Attribute name Data type Notes
mefServiceEvcCfgIndex Unsigned32
mefServiceEvcStatusMaxMtuSize Unsigned32
mefServiceEvcStatusMaxNumUni Unsigned32 (future)
mefServiceEvcStatusOperationalState INTEGER
Table 68 mefServiceEvcStatusTable attributes

TNMS V16.01 – SNMP NBI Operation Guide Performance Monitoring
10 Performance Monitoring
10.1 Introduction
SNMP NBI allows the managers to retrieve Performance Monitoring (PM) data
associated to the network objects managed by TNMS. Both history and
current PM data are supported, for 24h and 15m granularities.
Retrieving history PM data via SNMP NBI requires PM data upload to be
enabled in TNMS Server. Please refer to TNMS documentation for information
on how to enable PM data upload.
Given its nature and potentially large volume, PM data is not readily available
in an MIB table, as happens for other kinds of data such as alarms. To retrieve
PM data, the SNMP manager needs first to create a request by inserting a row
in the PM request table. Each request specifies what type of data to retrieve
(history or current, granularity, start and end times) and for which network
objects. The request is then executed, after which the resulting PM data may
be retrieved.
The following diagrams exemplify the high level interaction between a
manager wanting to retrieve PM data and SNMP NBI. In the first case, the
manager creates a request and waits for SNMP NBI to notify it when the PM
data is ready:
Figure 12 Example of PM data retrieval using notifications
Alternatively, the manager may poll the state of the request instead of waiting
for a notification:

Performance Monitoring TNMS V16.01 – SNMP NBI Operation Guide
Figure 13 Example of PM data retrieval using polling
10.2 PM requests
PM requests are entries of the MIB table enmsPerfMonRequestTable, whose
attributes are described in the section below.
Each PM request specifies what type of data to retrieve (history or current,
granularity, start and end times) and for which network objects.
10.2.1 enmsPerfMonRequestTable
Attribute name Data type Settable? Description
enmsPmRequestId PerfMonRequestId No Id of the request (table index).
enmsPmRequestName DisplayString Yes Optional request name, for manager

reference.
Creation default is empty.
enmsPmRequestRowStatus RowStatus Yes Standard SNMP RowStatus field for

(see description) controlling row creation.
Set to createAndGo to create a new

row, or destroy to remove an existing
row. Other values are not supported.
enmsPmRequestState PerfMonRequestState Yes State of the PM request. Set this field

(see description) to change the state of the request.
Not settable at row creation.
enmsPmRequestLastUpdate EnmsTimeStamp No Time (in UTC) of the last update of

the request.
enmsPmRequestInfo DisplayString No Information about request status.

enmsPmRequestType PerfMonType Yes Type of PM data to retrieve (history or

current).
Creation default is pmCurrent.
enmsPmRequestStartTime EnmsTimeStamp Yes In case of history PM data, start time

(in UTC) of the collection period.
enmsPmRequestEndTime EnmsTimeStamp Yes In case of history PM data, end time

(in UTC) of the collection period.
enmsPmRequestGranularity PerfMonGranularity Yes Granularity of PM data (15 minutes or

24 hours).
Creation default is minutes15.
enmsPmRequestFilterType PerfMonFilterType Yes Type of object for which to retrieve

PM data (TP, Port, NE or SCN).
(!) Filtering by NE object is supported
for history data only.
Creation default is sncObject.
enmsPmRequestFilterValue DisplayString Yes Identifier of the object for which to

retrieve PM data. The identifier of an
object is the index of that object in the
corresponding MIB table, with the
individual index values separated by
the pipe (“|”) character. Examples:
TP (enmsTPTable):
173|455|3453|99589454
Port (enmsPortTable):
32|6734
NE (enmsNETable) - history only
85
SNC (enmsSNCTable):
8374
Several objects may be specified by

separating their identifiers with
commas. Example for port objects:
32|6734,55|33928
Creation default is 0.
Table 69 enmsPerfMonRequestTable attributes
10.3 Creating a PM request

Creating a PM request, that is, adding a row to the MIB table
enmsPerfMonRequestTable, follows the method defined in the SNMP RFC
2579, which uses a RowStatus attribute to control the row existence. As such,
the manager must perform the following steps:

1) Obtain an instance identifier for the new row, by reading the

enmsPmRequestNextId leaf attribute using SNMP GET (this variable auto-
increments with each GET access).
2) Using the new instance identifier, send an SNMP SET command to set
enmsPmRequestRowStatus to createAndGo and optionally assign values
to other attributes.
If the SNMP SET command succeeds, a new entry is added to
enmsPerfMonRequestTable. If it fails, no entry will be added. Reasons for
failure are listed in the table below.
Error cause SNMP error
- The provided instance identifier is already in use. inconsistentValue

- Attribute enmsPmRequestRowStatus set to notReady,
active, notInService or destroy.
- An attribute was assigned a value inconsistent with other
attributes.
- Attribute enmsPmRequestRowStatus not set. inconsistentName
- Attribute enmsPmRequestRowStatus set to createAndWait. wrongValue

- Wrong type or invalid value assigned to an attribute.
- Values assigned to non-settable attributes. notWritable
- Maximum number of requests exceeded resourceUnavailable
Table 70 Possible errors during PM request creation.
Newly added requests will have enmsPmRequestRowStatus set to active, and

enmsPmRequestState set to created. The enmsPmRequestId index field is
set to the value used as instance identifier, and other fields that were left unset
will be assigned default values.
The following sequence diagram exemplifies the creation of a new PM
request:

Figure 14 Example of interaction to create PM request
After this interaction, enmsPerfMonRequestTable will contain a new entry for

instance 25, as exemplified below.
Row Last Type Start End Filter Filter

Id Name State Info Granul.
Status Update Time Time Type Value
11 Inner NEs active finished 2016-03-20 Execution finished. pmCurrent minutes15 NE 1234
14:01:12
19 Middle active started 2016-03-20 Execution started. pmHstory 2016-03-01 2016-03-15 hours24 SNC 320
node 14:01:12 00:00:00 00:00:00
25 Client active created 2016-03-22 Request created. pmCurrent minutes15 SNC 0

link 14:55:35
Table 71 Example of enmsPerfMonRequestTable after adding a request
As explained above, newly created requests are in the state created, meaning
that the request exists but is not in execution. Next sections in this chapter
describe the possible PM request states and how those states change.
10.4 PM request states

The following table lists the possible states of a PM request (reflected in the
enmsPmRequestState attribute) and the actions the manager may perform for
each state.
PM request state Meaning Possible manager actions
created Request is idle. This is the initial state of a newly - Execute the request
created request. - Update the request
pending Request is awaiting execution. - Cancel the request
started Request is being executed. - Cancel the request
finished Request finished successfully. - Retrieve the PM data

- Update the request
PM data is available for retrieving. - Re-execute the request
- Discard the PM data
failed Request failed and is idle. - Update the request

- Re-execute the request
cancelling Request is being cancelled. - None
cancelled Request has been cancelled and is idle. - Update the request
Table 72 States of a PM request and possible manager actions

The manager performs actions on a request by setting the state attribute

(enmsPmRequestState) using the SNMP SET command – see section 10.6
for details on how to perform each action.
The diagram below summarizes the main transitions between request states.
Figure 15 PM request states and main transitions
10.5 PM request state change notifications

Whenever the state of a PM request changes, SNMP NBI sends an
enmsPerfMonRequestStateChangeTrap notification to the managers. This
notification carries the following attributes:
enmsPmRequestId PerfMonRequestId Id of the request.
enmsPmRequestName DisplayString Name of the request.
enmsPmRequestState PerfMonRequestState New state of the request.
enmsPmRequestInfo DisplayString Information about request status.
Table 73 enmsPerfMonRequestStateChangeTrap attributes

10.6 Operations on PM requests

Operations over PM requests are performed by issuing SNMP SET
commands to change the PM request state and other attributes.
10.6.1 Executing a PM request
To execute (or re-execute) a PM request, the manager must send an SNMP

SET command to set enmsPmRequestState to started. If the command is
successful, the state will first change to pending, meaning that the request has
been queued for execution. When the execution starts, it will change to
started.
Executing a PM request is only possible if the request is in an idle state (either
created, finished, failed or cancelled).
Figure 16 Example of interaction for executing a PM request
The manager can also update the PM request attributes (see 10.6.2) and
execute it in a single SET command:
Figure 17 Updating and executing a PM request in a single SET command
If the request is executed successfully, the state will change to finished. The
manager may now retrieve the PM data (see section 10.7). If the request
execution fails, the state will change to failed. The enmsPmRequestInfo field
will normally give a hint on what caused the failure. Typical failure reasons
include:
 Network objects for which to obtain PM data do not exist;
 A timeout occurred while collecting data from the NEs;

 An internal server error occurred.

In any case, the manager may update the PM request and re-execute it.
Executing a PM request in state finished causes associated PM data to be
discarded.
10.6.2 Updating PM request attributes
When a PM request is created, unset attributes are assigned default values.

Before executing the PM request, the manager must set those attributes with
valid values, otherwise the PM request execution will fail. The manager may
also want to reuse a previously executed PM request, or correct the attributes
of a failed PM request.
To update the attributes of a PM request, the manager may send an SNMP
SET as exemplified below. Multiple attributes can be set in a single SET
command.
Figure 18 Example of interaction for updating a PM request
In case the manager tries to assign an invalid value to some attribute, the SET
command fails with the error code inconsistentValue.
Updating a PM request causes it to go to state created, and any associated
PM data to be discarded.
It is also possible to update the PM request attributes and execute it at the
same time in a single SET command – see 10.6.1.
Updating a PM request is only possible if the request is in an idle state (either
Updating a PM request in state finished causes associated PM data to be
discarded.
10.6.3 Cancelling a PM request
To cancel the execution of a PM request, the manager sends an SNMP SET

command to set enmsPmRequestState to cancelled. If the command is
successful, the state will first change to cancelling, and then to cancelled.

Figure 19 Example of interaction for cancelling a PM request
Cancelling a PM request is only possible if the request is in state pending or

started.
10.6.4 Discarding PM data associated to a PM request
After a PM request is successfully executed, the resulting PM data is

preserved until the request is re-executed, or until the request is deleted.
If the manager does not need the PM data anymore, but wants to keep the
request for future re-execution, then it may discard the data by sending an
SNMP SET command to set enmsPmRequestState to created. This way,
resources are freed up from the server, while the PM request is kept for reuse.
Figure 20 Example of interaction for discarding PM data of a PM request
10.6.5 Deleting a PM request
To delete a PM request, the manager sends an SNMP SET command to set

enmsPmRequestRowStatus to destroy.
Figure 21 Example of interaction for deleting a PM request

Deleting a request is only possible if the request is in an idle state (either

Deleting a PM request also deletes associated PM data.
10.6.6 Error exceptions
The table below describes the most common errors returned by SNMP NBI
while performing SNMP SET operations over existing PM requests.
- Attribute enmsPmRequestState set a value not allowed inconsistentValue

given the current request state (see 10.4).
attributes.
- Attribute enmsPmRequestRowStatus set to other value than wrongValue

destroy.
Table 74 Common errors while performing operations on PM requests
10.7 Retrieving PM data

When the execution of a PM request finishes successfully, the PM request
state changes to finished. The manager may now retrieve the associated PM
data by accessing the following tables:
 enmsPerfMonResultPmpTable: Contains the PM Points of the request
results (see 10.7.2).
 enmsPerfMonResultValueTable: Contains the measured values for
each PM Point (see 10.7.3).
The mentioned tables contain the whole PM data results for all finished
requests. To retrieve the data for a specific PM request, follow the method
suggested in Section 4.5.3, using the PM request identifier as the sub-index
(both tables are indexed by PM request identifier).
Because of the potentially large volume of data to retrieve, the manager
should only request the strictly needed attributes to speed-up the retrieval
operation.

10.7.1 PM data retention period
PM data is available for the following approximate times after the PM request
finishes:
 History data: 12 hours

 Current data: 1 hour
Results older than the intervals above are periodically discarded and the
corresponding requests are moved to the created state.
History data is only available as long as it exists in TNMS Server, which has
its own retention period.
It is recommended that the manager forces the data to be discarded as soon

as it finishes retrieving it – see section 10.6.4 for details.
10.7.2 enmsPerfMonResultPmpTable
This table contains the PM Points of all finished PM request results.
enmsPmResultPmpReqId PerfMonRequestId PerfMon request identifier.

(table index)
enmsPmResultPmpPmpNumber Unsigned32 Number of the PMP in the result

set. (table index)
enmsPmResultPmpNeId NEId NE Id of the PMP.
enmsPmResultPmpPortId PortId Port Id of the PMP.
enmsPmResultPmpTPIdH TPId Highest 32-bits of the TP Id of

the PMP, if applicable.
enmsPmResultPmpTPIdL TPId Lowest 32-bits of the TP Id of

the PMP, if applicable.
enmsPmResultPmpNeIdName DisplayString NE Id name of the NE of the

PMP.
enmsPmResultPmpObjLocation DisplayString Object location of the PMP.
enmsPmResultPmpName DisplayString PMP name.
enmsPmResultPmpLocation PerfMonLocation PMP location (near end/far

end).
enmsPmResultPmpDirection PerfMonDirection PMP direction.

enmsPmResultPmpRetrievalTime EnmsTimeStamp Retrieval time.
enmsPmResultPmpPeriodEndTime EnmsTimeStamp End time of the collection

period.
enmsPmResultPmpMonitoredTime Unsigned32 Total monitored time.
enmsPmResultPmpNumValues Unsigned32 Number of values collected for

this PMP.
Table 75 enmsPerfMonResultPmpTable attributes
10.7.3 enmsPerfMonResultValueTable
This table contains the measured values for the PM Points of all finished PM
request results.
enmsPmResultValReqId PerfMonRequestId PM request identifier (table

index).
enmsPmResultValPmpNumber Unsigned32 Number of the PMP in the result

set. (table index)
enmsPmResultValNumber Unsigned32 Number of value in the collected

values for the PMP. (table
index)
enmsPmResultValParam DisplayString Port Id of the PMP.
enmsPmResultValValue DisplayString Parameter name.
enmsPmResultValUnit DisplayString Parameter unit.
enmsPmResultValStatus PerfMonStatus Status of the collected value.
Table 76 enmsPerfMonResultValueTable attributes

TNMS V16.01 – SNMP NBI Operation Guide Optical Power Monitoring
11 Optical Power Monitoring
11.1 Introduction
SNMP NBI allows the managers to retrieve Optical Power Monitoring (OPM)
data associated to the network objects managed by TNMS.
Given its nature, OPM data is not readily available in an MIB table, as
happens for other kinds of data such as alarms. To retrieve OPM data, the
SNMP manager needs first to create a request by inserting a row in the OPM
request table. The request is then executed, after which the resulting OPM
data may be retrieved.
The following diagrams exemplify the high level interaction between a
manager wanting to retrieve OPM data and SNMP NBI. In the first case, the
manager creates a request and waits for SNMP NBI to notify it when the OPM
data is ready:
Figure 22 Example of OPM data retrieval using notifications
Alternatively, the manager may poll the state of the request instead of waiting
for a notification:

Optical Power Monitoring TNMS V16.01 – SNMP NBI Operation Guide
Figure 23 Example of OPM data retrieval using polling
11.2 OPM requests

OPM requests are entries of the MIB table enmsOptPowerMonRequestTable,
whose attributes are described in the section below.
Each OPM request specifies for which network objects data to retrieve data.
11.2.1 enmsOptPowerMonRequestTable
enmsOpmRequestId OptPowerMonRequestId No Id of the request (table index).
enmsOpmRequestName DisplayString Yes Optional request name, for

manager reference.
enmsOpmRequestRowStatus RowStatus Yes Standard SNMP RowStatus field

(see for controlling row creation.
description)
Set to createAndGo to create a
new row, or destroy to remove an
existing row. Other values are not
supported.
enmsOpmRequestState OptPowerMonRequestState Yes State of the OPM request. Set this

(see field to change the state of the
description) request.
Not settable at row creation.
enmsOpmRequestLastUpdate EnmsTimeStamp No Time (in UTC) of the last update of

the request.
enmsOpmRequestInfo DisplayString No Information about request status.

enmsOpmRequestFilterType FilterType Yes Type of object for which to retrieve

OPM data (TP, Port or SCN).
(!) Filtering by NE object is
unsupported.
Creation default is sncObject.
enmsOpmRequestFilterValue DisplayString Yes Identifier of the object for which to

retrieve OPM data. The identifier of
an object is the index of that object
in the corresponding MIB table,
with the individual index values
separated by the pipe (“|”)
character. Examples:
TP (enmsTPTable):
173|455|3453|99589454
Port (enmsPortTable):
32|6734
SNC (enmsSNCTable):
8374
Several objects may be specified

by separating their identifiers with
commas. Example for port objects:
32|6734,55|33928
Creation default is 0.
Table 77 enmsOptPowerMonRequestTable attributes
11.3 Creating an OPM request

Creating an OPM request, that is, adding a row to the MIB table
enmsOptPowerMonRequestTable, follows the method defined in the SNMP
RFC 2579, which uses a RowStatus attribute to control the row existence. As
such, the manager must perform the following steps:
3) Obtain an instance identifier for the new row, by reading the
enmsOpmRequestNextId leaf attribute using SNMP GET (this variable
auto-increments with each GET access).
4) Using the new instance identifier, send an SNMP SET command to set
enmsOpmRequestRowStatus to createAndGo and optionally assign
values to other attributes.
If the SNMP SET command succeeds, a new entry is added to
enmsOptPowerMonRequestTable. If it fails, no entry will be added. Reasons
for failure are listed in the table below.
- The provided instance identifier is already in use. inconsistentValue

- Attribue enmsPmRequestRowStatus set to notReady, active,

notInService or destroy.
attributes.
- Attribute enmsPmRequestRowStatus not set. inconsistentName
- Attribute enmsOpmRequestRowStatus set to wrongValue

createAndWait.
- Maximum number of requests exceeded resourceUnavailable
Table 78 Possible errors during OPM request creation.
Newly added requests will have enmsOpmRequestRowStatus set to active,

and enmsOpmRequestState set to created. The enmsOpmRequestId index
field is set to the value used as instance identifier, and other fields that were
left unset will be assigned default values.
The following sequence diagram exemplifies the creation of a new OPM
request:
Figure 24 Example of interaction to create OPM request
After this interaction, enmsOptPowerMonRequestTable will contain a new

entry for instance 25, as exemplified below.
Row Last Filter Filter

Id Name State Info
Status Update Type Value
11 Inner NEs active finished 2016-03-20 Execution finished. NE 1234

14:01:12
19 Middle node active started 2016-03-20 Execution started. SNC 320

14:01:12

Row Last Filter Filter

Id Name State Info
Status Update Type Value
25 Client link active created 2016-03-22 Request created. SNC 0

14:55:35
Table 79 Example of enmsOptPowerMonRequestTable after adding a request
As described above, newly created requests are in the state created, meaning
that the request exists but is not in execution. The next sections describe the
possible OPM request states and how those states change.
11.4 OPM request states

The following table lists the possible states of an OPM request (reflected in the
enmsOpmRequestState attribute) and the actions the manager may perform
for each state.
OPM request Meaning Possible manager actions
state
created Request is idle. This is the initial state of a newly - Execute the request
created request. - Update the request
pending Request is awaiting execution. - Cancel the request
started Request is being executed. - Cancel the request
finished Request finished successfully. - Retrieve the OPM data

- Update the request
OPM data is available for retrieving. - Re-execute the request
- Discard the OPM data
failed Request failed and is idle. - Update the request

cancelling Request is being cancelled. - None
cancelled Request has been cancelled and is idle. - Update the request
Table 80 States of an OPM request and possible manager actions
The manager performs actions on a request by setting the state attribute

(enmsOpmRequestState) using the SNMP SET command – see section 11.6
for details on how to perform each action.
The diagram below summarizes the main transitions between request states.

Figure 25 OPM request states and main transitions
11.5 OPM request state change notifications

Whenever the state of an OPM request changes, SNMP NBI sends an
enmsOptPowerMonRequestStateChangeTrap notification to the managers.
This notification carries the following attributes:
enmsOpmRequestId OptPowerMonRequestId Id of the request.
enmsOpmRequestName DisplayString Name of the request.
enmsOpmRequestState OptPowerMonRequestState New state of the request.
enmsOpmRequestInfo DisplayString Information about request status.
Table 81 enmsOptPowerMonRequestStateChangeTrap attributes

11.6 Operations on OPM requests

Operations over OPM requests are performed by issuing SNMP SET
commands to change the OPM request state and other attributes.
11.6.1 Executing an OPM request
To execute (or re-execute) an OPM request, the manager must send an

SNMP SET command to set enmsOpmRequestState to started. If the
command is successful, the state will first change to pending, meaning that
the request has been queued for execution. When the execution starts, it will
change to started.
Executing an OPM request is only possible if the request is in an idle state
(either created, finished, failed or cancelled).
Figure 26 Example of interaction for executing an OPM request
The manager can also update the OPM request attributes (see 11.6.2) and
execute it in a single SET command:
Figure 27 Updating and executing an OPM request in a single SET command
If the request is executed successfully, the state will change to finished. The
manager may now retrieve the OPM data (see section 11.7). If the request
execution fails, the state will change to failed. The enmsOpmRequestInfo field
will normally give a hint on what caused the failure. Typical failure reasons
include:
 Network objects for which to obtain OPM data do not exist;
 A timeout occurred while collecting data from the NEs;

 An internal server error occurred.

In any case, the manager may update the OPM request and re-execute it.
Executing an OPM request in state finished causes associated OPM data to
be discarded.
11.6.2 Updating OPM request attributes
When an OPM request is created, unset attributes are assigned default

values. Before executing the OPM request, the manager must set those
attributes with valid values, otherwise the OPM request execution will fail. The
manager may also want to reuse a previously executed OPM request, or
correct the attributes of a failed OPM request.
To update the attributes of an OPM request, the manager may send an SNMP
SET as exemplified below. Multiple attributes can be set in a single SET
command.
Figure 28 Example of interaction for updating an OPM request
In case the manager tries to assign an invalid value to some attribute, the SET
command fails with the error code inconsistentValue.
Updating an OPM request causes it to go to state created, and any associated
OPM data to be discarded.
It is also possible to update the OPM request attributes and execute it at the
same time in a single SET command – see 11.6.1.
Updating an OPM request is only possible if the request is in an idle state
(either created, finished, failed or cancelled).
Updating an OPM request in state finished causes associated OPM data to be
discarded.
11.6.3 Cancelling an OPM request
To cancel the execution of an OPM request, the manager sends an SNMP

SET command to set enmsOpmRequestState to cancelled. If the command is
successful, the state will first change to cancelling, and then to cancelled.

Figure 29 Example of interaction for cancelling an OPM request
Cancelling an OPM request is only possible if the request is in state pending

or started.
11.6.4 Discarding OPM data associated to an OPM request
After an OPM request is successfully executed, the resulting OPM data is

preserved until the request is re-executed, or until the request is deleted.
If the manager does not need the OPM data anymore, but wants to keep the
request for future re-execution, then it may discard the data by sending an
SNMP SET command to set enmsOpmRequestState to created. This way,
resources are freed up from the server, while the OPM request is kept for
reuse.
Figure 30 Example of interaction for discarding OPM data of an OPM request
11.6.5 Deleting an OPM request
To delete an OPM request, the manager sends an SNMP SET command to

set enmsOpmRequestRowStatus to destroy.
Figure 31 Example of interaction for deleting an OPM request

Deleting a request is only possible if the request is in an idle state (either

Deleting an OPM request also deletes associated OPM data.
11.6.6 Error exceptions
The table below describes the most common errors returned by SNMP NBI
while performing SNMP SET operations over existing OPM requests.
- Attribute enmsOpmRequestState set to a value not allowed inconsistentValue

given the current request state (see 11.4).
attributes.
- Attribute enmsOpmRequestRowStatus set to other value wrongValue

than destroy.
Table 82 Common errors while performing operations on OPM requests
11.7 Retrieving OPM data

When the execution of an OPM request finishes successfully, the OPM
request state changes to finished. The manager may now retrieve the
associated OPM data by accessing the enmsOptPowerMonResultValueTable
(see 11.7.2).
The mentioned tables contain the whole OPM data results for all finished
requests. To retrieve the data for a specific OPM request, follow the method
suggested in Section 4.5.3, using the OPM request identifier as the sub-index
(both tables are indexed by OPM request identifier).
Because of the potentially large volume of data to retrieve, the manager
should only request the strictly needed attributes to speed-up the retrieval
operation.
11.7.1 OPM data retention period
OPM result data is available for 1 hour after the OPM request finishes. Results
older than this interval are periodically discarded and the corresponding
requests are moved to the created state.

It is recommended that the manager forces the data to be discarded as soon

as it finishes retrieving it – see section 11.6.4 for details.
11.7.2 enmsOptPowerMonResultTable
This table contains the OPM Points of all finished OPM request results.
enmsOpmResultValReqId OptPowerMonRequestId OptPowerMon request

identifier. (table index)
enmsOpmResultValPmpNumber Unsigned32 Number of the value in the

result set of the OPM
request. (table index)
enmsOpmResultValNeId NEId NE Id of the object.
enmsOpmResultValPortId PortId Port Id of the object.
enmsOpmResultValTPIdH TPId Highest 32-bits of the TP

Id of the object, if
applicable.
enmsOpmResultValTPIdL TPId Lowest 32-bits of the TP

Id of the object, if
applicable.
enmsOpmResultValNeIdName DisplayString NE Id name of the NE of

the object.
enmsOpmResultValObjLocation DisplayString Object location.
enmsOpmResultValLane Unsigned32 Lane of the OPM counter.
enmsOpmResultValLayer DisplayString Layer of the OPM counter.
enmsOpmResultValParam DisplayString OPM counter name.
enmsOpmResultValValue DisplayString OPM counter value.
enmsOpmResultValUnit DisplayString OPM counter unit.
Table 83 enmsOptPowerMonResultPmpTable attributes

Troubleshooting TNMS V16.01 – SNMP NBI Operation Guide
12 Troubleshooting
The table below proposes solutions for the most common issues when operating with SNMP
NBI. Also check TNMS System Event Log for messages related to SNMP NBI events.
Symptom Possible cause Solution
The SNMP NBI menu entries in SNMP NBI not installed in the server Reinstall TNMS and select the
TNMS Client are missing or SNMP northbound interface (see
greyed out. 2.5).
SNMP NBI license not installed Install SNMP NBI license (see 2.5).
The “Enable SNMP northbound An SNMP NBI license has been Restart TNMS server (see 2.5).
interface” checkbox (SNMP NBI installed, but the server has not
system settings) is greyed out. been restarted yet.
No response from SNMP NBI or SNMP NBI not installed or not Install SNMP NBI or its license (see
timeout error. licensed. 2.5).
Timeout configured on the SNMP Increase the timeout value

manager is too low (see 4.5.5). configured on the SNMP manager.
Incorrect SNMP agent address Make sure that the SNMP agent
configured on the SNMP manager. address configured on the SNMP
manager corresponds to the TNMS
server machine.
Incorrect SNMP agent port Make sure that the SNMP agent port
configured on the SNMP manager. configured on the SNMP manager
matches the SNMP NBI listening
port (see 3.1).
The source address of the SNMP Add the SNMP manager’s IP

requests is not in the list of allowed address (or addresses, in case it has
manager addresses for the SNMP multiple network interfaces) to the
user. list of allowed manager addresses in
the SNMP NBI user configuration
(see 3.3.2).
SNMP user doesn’t have the Change permission of the SNMP

appropriate permission. user to ‘Read’ or ‘Read/Write’ as
appropriate (see 3.3.2).
Incorrect user data or SNMP Make sure the SNMP manager is

protocol version configured on the using the correct user (SNMPv2
SNMP manager. community or SNMPv3 user) and
protocol version, as configured in the
SNMP NBI user configuration (see
3.3.1).

TNMS V16.01 – SNMP NBI Operation Guide Troubleshooting
SNMP NBI could not bind to the Make sure that the configured
listening port. listening port is not being used by
any other service or application on
the TNMS server machine (see 3.1).
You may use a utility such as
‘netstat’ to list the ports on which the
server computer is listening.
Network connectivity problem. Check network connectivity between

the TNMS server machine and the
SNMP manager machine.
Confirm that the ports chosen for
SNMP communication, in particular,
the SNMP NBI listening port, are not
blocked by any firewall.
SNMP error “No such name” The requested object doesn’t exist in Check if the requested OID is valid
received. the MIB. Usually occurs with GET and belongs to the SNMP NBI MIB.
requests.
Verify if the SNMP manager is trying
to get a nonexistent table value (i.e.
the table is valid, but doesn’t contain
any value for the index specified in
the OID).
The SNMP manager is still using If the SNMP manager was

TNMS Core’s SNMP Proxy MIB previously configured to access
definition. TNMS Core’s SNMP Proxy, then
some adaptations are needed before
redirecting it to the SNMP NBI. See
2.4.
The SNMP manager is accessing Reconfigure the SNMP manager to

the wrong SNMP agent (e.g. a access SNMP NBI instead.
TNMS Core’s SNMP Proxy
installation).
SNMP error “Authentication Incorrect user data or SNMP Make sure the SNMP manager is
error” received. protocol version configured on the using the correct user authentication
SNMP manager. details, as configured in the SNMP
NBI user configuration (see 3.3.1).
This frequently occurs with SNMPv3,
so confirm the user name, the
authentication and privacy protocols,
and the corresponding passwords.
SNMP error “Too big” received. The response to the request does Split the failing GET / GETNEXT /
not fit in a single SNMP packet (see GETNEXT operations into two or
4.5.4). Typically occurs when the more requests.
SNMP manager requests too many
OIDs in the same operation, or the Use a lower max-repetitions value
max-repetitions value for a for GETBULK requests.
GETBULK operation is too high.

Troubleshooting TNMS V16.01 – SNMP NBI Operation Guide
No traps/informs received from SNMP manager address not added Add the SNMP manager address to
SNMP NBI. to the trap destination list. the trap/inform destination list of the
appropriate SNMP NBI user (see
3.3.3).
Incorrect trap destination port. Make sure the destination port of the
traps/informs matches the port on
which the SNMP manager is waiting
for traps (see 3.3.3).
Incorrect SNMP user data. Make sure the SNMPv2 community

or SNMPv3 user for which the
traps/informs are sent is configured
in the SNMP manager.
In case of SNMPv3, check the user
name, the authentication and privacy
protocols, and the corresponding
passwords.
The SNMP manager is not listening Make sure the SNMP manager is
to the trap receiving port. really listening for traps/informs on
the configured port.
Network connectivity problem. Check network connectivity between

the TNMS server machine and the
SNMP manager machine.
Confirm that the ports chosen for
SNMP communication are not
blocked by any firewall.
SET operation returns an error. SNMP user doesn’t have write Change permission of the SNMP to
permission. ‘Read/Write’ (see 3.3.2).
The target MIB object is not writable. Check the object the SNMP
manager is trying to set.
The type of the value in the SET Use the correct data type.
request is not compatible with the
MIB object.
Table 84 SNMP NBI troubleshooting table

TNMS V16.01 – SNMP NBI Operation Guide Abbreviations
Abbreviations
AC Attribute Change
ACS Actual Creation State
AES Advanced Encryption Standard
AVC Attribute Value Change
DB Database
DES Data Encryption Standard
3DES Triple DES
EMS Element Management System
EVC Ethernet Virtual Connection
GUI Graphical User Interface
HW Hardware
IANA Internet Assigned Numbers Authority
ITU International Telecommunication Union
MD5 Message Digest 5
NBI Northbound Interface
NE Network Element
NMS Network Management System
OC Object Creation
OD Object Deletion
OPM Optical Power Monitoring
PEN Private Enterprise Number
PDU Protocol Data Unit
PM Performance Monitoring
RCS Required Creation State
RFC Request for Comments
SC State Change
SHA Secure Hash Algorithm
SEL System Event Log
SNMP Simple Network Management Protocol
SW Software
TCP Transmission Control Protocol

Abbreviations TNMS V16.01 – SNMP NBI Operation Guide
TNMS Telecommunication Network Management System

UDP User Datagram Protocol
UNO Universal Network Object
UI User Interface
UNI User Network Interface

TNMS SNMP NBI - Operation Guide

Uploaded by

Copyright:

Available Formats

TNMS SNMP NBI - Operation Guide

Uploaded by

Document Information

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

TNMS SNMP NBI - Operation Guide

Uploaded by

Copyright:

Available Formats

TNMS

Issue: 1 Issue date: July 2016

Coriant is continually striving to reduce the adverse environmental

2/116 © Coriant Issue: 1 Issue date: July 2016

3 SNMP Agent Configuration ........................................................................ 16

4 SNMP NBI MIB – General description ........................................................ 25

Issue: 1 Issue date: July 2016 © Coriant 3/116

4.4 Resynchronization after network or manager errors ............................... 29

5 SNMP NBI MIB – Network Objects ............................................................. 40

4/116 © Coriant Issue: 1 Issue date: July 2016

5.2.16 TP attribute value change (enmsTPAttributeChangeTrap)............... 53

6 SNMP NBI MBI – Connection Management ............................................... 56

7 SNMP NBI MIB – Fault management .......................................................... 67

Issue: 1 Issue date: July 2016 © Coriant 5/116

7.1.4 Alarms for TP (enmsAlarmsForTPTable) ......................................... 71

8 SNMP NBI MIB – EMS and SNMP agent .................................................... 83

9 Ethernet Paths – Support of MEF 40.......................................................... 87

10 Performance Monitoring ............................................................................. 89

6/116 © Coriant Issue: 1 Issue date: July 2016

10.6.5 Deleting a PM request ..................................................................... 97

11 Optical Power Monitoring ......................................................................... 101

12 Troubleshooting ........................................................................................ 112

Abbreviations ............................................................................................ 115

Issue: 1 Issue date: July 2016 © Coriant 7/116

Issue Issue date Remarks

8/116 © Coriant Issue: 1 Issue date: July 2016

1.1 Intended audience

1.2 Structure of this document

Issue: 1 Issue date: July 2016 © Coriant 9/116

 Chapter 11 describes how to retrieve Optical Power Monitoring data

10/116 © Coriant Issue: 1 Issue date: July 2016

2.1 General description

Figure 1 SNMP NBI component in a TNMS system

Issue: 1 Issue date: July 2016 © Coriant 11/116

- Alarm raise/clear notifications.

2.2 SNMP protocol support

12/116 © Coriant Issue: 1 Issue date: July 2016

The term “trap” is commonly used to refer an SNMP notification, regardless of

SNMP NBI MIB naming TNMS naming

Port Connection (PC) Physical Trail

Port Physical Termination Point (PTP)

Sub-Network Connection (SNC) Path

Ethernet Path Ethernet Service

Table 1 Naming equivalences between SNMP NBI MIB and TNMS

2.4 Differences to TNMS Core SNMP Proxy

2.4.1 General changes

 MIB name is “TNMS-NBI-MIB” instead of “TNMS-MIB”.

Issue: 1 Issue date: July 2016 © Coriant 13/116

2.4.2 Tables and fields

Type of MIB objects To be supported in the future

Tables and associated  enmsSNCTPTable

Table fields  enmsNETable:

Trap fields  enmsSNCTraps:

Table 2 MIB objects not yet supported

2.4.3 Notification behaviors

Table 3 OD notification behavior changes

14/116 © Coriant Issue: 1 Issue date: July 2016

2.4.4 Protocol support changes

2.5 Installation and licensing

2.6 MIB file location