TNMS

18.10

SNMP NBI Operation Guide (SNOG)

Issue: 3 Issue date: October 2020

Infinera 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 18.10 – 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
Infinera 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 Infinera. The documentation has been prepared to be used by professional
and properly trained personnel, and the customer assumes full responsibility when using it. Infinera
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 Infinera and the customer. However, Infinera has made all reasonable
efforts to ensure that the instructions contained in the document are adequate and free of material
errors and omissions. Infinera will, if deemed necessary by Infinera, explain issues which may not be
covered by the document. Infinera will correct errors in this documentation as soon as possible.
IN NO EVENT WILL INFINERA 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 © Infinera, 2020. All rights reserved.

2/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Preface

Table of Contents

1 Preface ......................................................................................................... 10
1.1 Intended Audience ................................................................................. 10

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 ............................................................................. 13
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
2.7 Agent Engine ID ..................................................................................... 15

3 SNMP Agent Configuration ........................................................................ 17

3.1 System Settings ..................................................................................... 17
3.1.1 Base System Settings ..................................................................... 17
3.1.2 MIB-II Variables ............................................................................... 18
3.2 SNMP User Configuration ...................................................................... 19
3.2.1 SNMP User Identification................................................................. 19
3.2.2 SNMP user access permissions ...................................................... 20
3.2.3 User trap destinations...................................................................... 21
3.2.4 User inform destinations .................................................................. 22
3.2.5 Notification Filtering ......................................................................... 23
3.3 Heartbeat Notifications ........................................................................... 25
3.4 Exporting SNMP Agent Configuration..................................................... 25

4 SNMP NBI MIB – General Description ....................................................... 26

4.1 Exported Object Model ........................................................................... 26
4.2 Hierarchical View ................................................................................... 27
4.3 Notification Model ................................................................................... 29

Issue: 3 Issue date: October 2020 3/139

 TNMS 18.10 – SNMP NBI Operation Guide

4.4 Resynchronization After Network or Manager Errors .............................. 30

4.5 Recommended Table Retrieval Approaches .......................................... 31
4.5.1 Retrieving all rows of a table ............................................................ 31
4.5.2 Retrieving specific rows by index ..................................................... 32
4.5.3 Retrieving blocks of rows for a sub-index ........................................ 32
4.5.4 Limited size of responses ................................................................ 33
4.5.5 Request timeouts ............................................................................ 33
4.6 Data Types ............................................................................................. 34
4.7 Strings and Multi-Language Support ...................................................... 41

5 Retrieving Network Inventory..................................................................... 42

5.1 Network Elements .................................................................................. 42
5.1.1 List of NEs (enmsNETable) ............................................................. 42
5.1.2 Notification of NE object creation (enmsNEObjectCreationTrap) ..... 43
5.1.3 Notification of NE object deletion (enmsNEObjectDeletionTrap) ...... 44
5.1.4 Notification of NE state change (enmsNEStateChangeTrap) ........... 44
5.1.5 Notification of NE attribute value change
(enmsNEAttributeChangeTrap) ....................................................... 45
5.2 Modules ................................................................................................. 46
5.2.1 List of Modules (enmsModuleTable) ................................................ 46
5.2.2 Notification of Module object creation
(enmsModuleObjectCreationTrap)................................................... 47
5.2.3 Notification of Module object deletion
(enmsModuleObjectDeletionTrap) ................................................... 47
5.2.4 Notification of Module state change (enmsModuleStateChangeTrap)
........................................................................................................ 48
5.2.5 Notification of Module attribute value change
(enmsModuleAttributeChangeTrap) ................................................. 48
5.3 Ports ...................................................................................................... 49
5.3.1 List of Ports (enmsPortTable) .......................................................... 49
5.3.2 Notification of Port object creation (enmsPortObjectCreationTrap) .. 50
5.3.3 Notification of Port object deletion (enmsPortObjectDeletionTrap)... 51
5.3.4 Notification of Port state change (enmsPortStateChangeTrap) ........ 51
5.3.5 Notification of Port attribute value change
(enmsPortAttributeChangeTrap) ...................................................... 52
5.4 Termination Points ................................................................................. 52

4/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Preface

5.4.1 List of TPs (enmsTPTable) .............................................................. 52

5.4.2 Notification of TP object creation (enmsTPObjectCreationTrap) ...... 54
5.4.3 Notification of TP object deletion (enmsTPObjectDeletionTrap)....... 55
5.4.4 Notification of TP state change (enmsTPStateChangeTrap) ............ 55
5.4.5 Notification of TP attribute value change
(enmsTPAttributeChangeTrap) ........................................................ 56
5.5 Port Connections .................................................................................... 57
5.5.1 List of Port Connections (enmsPortConnTable) ............................... 57
5.5.2 Notification of Port Connection object creation
(enmsPortConnObjectCreationTrap) ............................................... 58
5.5.3 Notification of Port Connection object deletion
(enmsPortConnObjectDeletionTrap) ................................................ 58
5.5.4 Notification of Port Connection attribute value change
(enmsPortConnAttributeChangeTrap) ............................................. 58
5.6 Equipment Holders ................................................................................. 59
5.6.1 List of Equipment Holders (enmsEquipHolderTable) ....................... 59

6 Retrieving Paths, Services and Cross-connections ................................. 60

6.1 Sub-Network Connections (Optical Paths) ............................................. 60
6.1.1 List of SNCs (enmsSNCTable) ........................................................ 60
6.1.2 Notification of SNC object creation (enmsSNCObjectCreationTrap) 63
6.1.3 Notification of SNC object deletion (enmsSNCObjectDeletionTrap) . 63
6.1.4 Notification of SNC state change (enmsSNCStateChangeTrap) ...... 63
6.1.5 Notification of SNC attribute value change
(enmsSNCAttributeChangeTrap) ..................................................... 64
6.1.6 Association between SNCs and their client SNCs
(enmsSNCClientSNCTable) ............................................................ 65
6.1.7 Receiving protection switch notifications.......................................... 65
6.2 Ethernet Paths ....................................................................................... 66
6.2.1 List of Ethernet Paths (enmsEthernetPathTable) ............................. 66
6.2.2 Notification of Ethernet Path object creation
(enmsEthernetPathObjectCreationTrap).......................................... 67
6.2.3 Notification of Ethernet Path object deletion
(enmsEthernetPathObjectDeletionTrap) .......................................... 67
6.2.4 Notification of Ethernet Path state change
(enmsEthernetPathStateChangeTrap)............................................. 68

Issue: 3 Issue date: October 2020 5/139

 TNMS 18.10 – SNMP NBI Operation Guide

6.2.5 Notification of Ethernet Path attribute value change

(enmsEthernetPathAttributeChangeTrap)........................................ 68
6.3 Services ................................................................................................. 69
6.3.1 List of Services (enmsServiceTable) ............................................... 69
6.3.2 Notification of Service object creation
(enmsServiceObjectCreationTrap) .................................................. 70
6.3.3 Notification of Service object deletion
(enmsServiceObjectDeletionTrap) ................................................... 70
6.3.4 Notification of Service state change (enmsServiceStateChangeTrap)
........................................................................................................ 70
6.3.5 Notification of Service attribute value change
(enmsServiceAttributeChangeTrap) ................................................ 71
6.4 Cross Connections ................................................................................. 72
6.4.1 List of Cross Connections (enmsCCTable) ...................................... 72

7 Retrieving and Receiving Alarms .............................................................. 74

7.1 Approaches for Monitoring Alarms ......................................................... 74
7.1.1 Listening to alarm notifications ........................................................ 74
7.1.2 Polling the alarm tables ................................................................... 75
7.2 Alarm Tables .......................................................................................... 76
7.2.1 List of all active alarms (enmsAlarmTable) ...................................... 76
7.2.2 List of alarms for NEs (enmsAlarmsForNETable) ............................ 78
7.2.3 List of alarms for Ports (enmsAlarmsForPortTable) ......................... 80
7.2.4 List of alarms for TP (enmsAlarmsForTPTable) ............................... 81
7.2.5 List of alarms for Port Connections (enmsAlarmsForPortConnTable)
........................................................................................................ 83
7.2.6 List of alarms for Modules (enmsAlarmsForModuleTable) ............... 85
7.2.7 List of alarms for SNCs (enmsAlarmsForSNCTable) ....................... 86
7.2.8 List of EMS alarms (enmsAlarmsForEMSTable) .............................. 88
7.3 Alarm Notifications ................................................................................. 89
7.3.1 Notification of NE alarm (enmsNEAlarmTrap).................................. 89
7.3.2 Notification of Module alarm (enmsModuleAlarmTrap) .................... 90
7.3.3 Notification of Port alarm (enmsPortAlarmTrap) .............................. 91
7.3.4 Notification of TP alarm (enmsTPAlarmTrap) .................................. 93
7.3.5 Notification of EMS alarm (enmsEMSAlarmTrap) ............................ 94
7.3.6 Notifications on alarm acknowledgement......................................... 95

6/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Preface

8 Reading and Setting Agent Parameters via SNMP ................................... 96

8.1 Agent Parameters (EnmsControl)........................................................... 96
8.2 SNMP Agent Notifications ...................................................................... 97
8.2.1 Notification of agent state change (enmsProxyStateChangeTrap) ... 97
8.3 Notification Filtering (enmsTrapFilter) ..................................................... 97
8.4 Notification History (enmsTrapHistoryTable) .......................................... 99

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

9.1 MEF-UNI-EVC-MIB .............................................................................. 100
9.1.1 mefServiceEvcCfgTable ................................................................ 100
9.1.2 mefServiceEvcStatusTable............................................................ 101

10 Performance Monitoring ........................................................................... 102

10.1 PM Requests........................................................................................ 103
10.1.1 PM request table (enmsPerfMonRequestTable) ............................ 103
10.2 Creating a PM Request ........................................................................ 105
10.3 PM Request States .............................................................................. 107
10.4 PM Request State Change Notifications............................................... 108
10.5 Actions on PM Requests ...................................................................... 109
10.5.1 Executing a PM request ................................................................ 109
10.5.2 Updating PM request attributes ..................................................... 110
10.5.3 Cancelling a PM request ............................................................... 110
10.5.4 Discarding PM data associated to a PM request ........................... 111
10.5.5 Deleting a PM request ................................................................... 111
10.5.6 Error exceptions ............................................................................ 112
10.6 Retrieving PM Data .............................................................................. 112
10.6.1 PM data retention period ............................................................... 113
10.6.2 enmsPerfMonResultPmpTable ...................................................... 113
10.6.3 enmsPerfMonResultValueTable .................................................... 115
10.6.4 enmsPerfMonResultThresholdTable ............................................. 115

11 Optical Power Monitoring ......................................................................... 117

11.1 OPM Requests ..................................................................................... 118
11.1.1 OPM request table (enmsOptPowerMonRequestTable) ................ 118
11.2 Creating an OPM Request ................................................................... 119

Issue: 3 Issue date: October 2020 7/139

 TNMS 18.10 – SNMP NBI Operation Guide

11.3 OPM Request States............................................................................ 121

11.4 OPM Request State Change Notifications ............................................ 122
11.5 Actions on OPM Requests ................................................................... 123
11.5.1 Executing an OPM request ............................................................ 123
11.5.2 Updating OPM request attributes................................................... 124
11.5.3 Cancelling an OPM request ........................................................... 124
11.5.4 Discarding OPM data associated to an OPM request .................... 125
11.5.5 Deleting an OPM request .............................................................. 125
11.5.6 Error exceptions ............................................................................ 126
11.6 Retrieving OPM Data ........................................................................... 126
11.6.1 OPM data retention period............................................................. 127
11.6.2 enmsOptPowerMonResultTable .................................................... 127

12 Net-SNMP Examples for PM Data Retrieval............................................. 128

12.1 Creating a New PM Request ................................................................ 129
12.2 Executing the PM Request ................................................................... 130
12.3 Retrieving the PM Request Results ...................................................... 131
12.4 Re-executing the PM Request .............................................................. 132
12.5 Deleting a PM Request ........................................................................ 133

13 Troubleshooting ........................................................................................ 134

Abbreviations ................................................................................................................... 138

8/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide

History of changes

Issue Issue date Remarks

1 December 2019 First version for 18.10
2 February 2020 Second version for 18.10
Added new table enmsSNCClientSNCTable.
3 October 2020 Third version for 18.10
Added instructions on how to enable/disable
alarm acknowledge notifications.
Added instructions on how to force maximum
message size.

Issue: 3 Issue date: October 2020 9/139

Preface TNMS 18.10 – SNMP NBI Operation Guide

1 Preface

TNMS (Telecommunications Network Management System) is an Infinera

standalone application that manages the physical structure of the transport
network as well as the logical end-to-end connections and services.
SNMP NBI is a northbound interface that allows clients to access TNMS using
the SNMP protocol.
The SNMP NBI Operation Guide describes how to operate SNMP NBI and
integrate it with external applications.

1.1 Intended Audience

This document is intended for people responsible for:
- Installing, configuring, maintaining and troubleshooting SNMP NBI
(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.

10/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Introduction

2 Introduction

2.1 General Description

In SNMP terminology, SNMP NBI is an SNMP agent, and the clients, such as
umbrella systems or fault monitoring systems, are the SNMP managers.

Figure 1 SNMP NBI component in a TNMS system

SNMP NBI provides the following functionalities:

• Network discovery and synchronization:
- Lists of NEs, Modules, Ports, Termination Points (TPs), Port
Connections (PCs) and Equipment Holders.
- 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.
- Alarm raise/clear notifications.

Issue: 3 Issue date: October 2020 11/139

Introduction TNMS 18.10 – SNMP NBI Operation Guide

• 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.

SNMP NBI also provides preliminary MEF MIB support for the retrieval of
Ethernet Paths (MEF 40).

2.2 SNMP Protocol Support

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 SNMP.
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 SNMP TRAP or SNMP INFORM.
Some objects are named differently in SNMP NBI MIB and TNMS. The table
below shows the equivalences.

12/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Introduction

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

TNMS Core is the previous generation EMS, which also has an SNMP
northbound interface called SNMP Proxy. For seamless transition of existing
umbrella systems, TNMS SNMP NBI’s MIB has been designed to be
structurally similar to that of TNMS Core’s SNMP Proxy. However, some
differences do exist, as described below.

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 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.
• Notification filtering is configured per SNMP user, not globally.

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.

Issue: 3 Issue date: October 2020 13/139

Introduction TNMS 18.10 – SNMP NBI Operation Guide

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 when network changes occur.
TNMS Core SNMP Proxy TNMS SNMP NBI

When a NE is removed, an OD trap is sent When a NE, module or port is removed, an OD trap is sent
for that NE only – no OD traps are sent for for that object only – no OD traps are sent for its children.
the child objects. 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

14/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Introduction

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 must be installed during TNMS
installation. It is not possible to install SNMP NBI later without reinstalling
TNMS.
SNMP NBI requires a license to run. The license can be installed at any time,
but only becomes effective after TNMS is restarted. To install it, go to the
License Manager in the TNMS Client.

2.6 MIB File Location

SNMP NBI implements two MIBs:
• TNMS-NBI-MIB
• MEF-UNI-EVC-MIB (limited, preliminary support)
Files for both MIBs can be found in:

<TNMS Home>\Docs\SNMP-NBI

Other MIB files in the location above are included only because they define
data types used by the MEF MIB. SNMP NBI does not implement any tables
or objects of those MIBs.
MIB files are only available if the SNMP NBI component is installed.

2.7 Agent Engine ID

The SNMP NBI agent Engine ID is generated during TNMS startup based on
the MIB Private Enterprise Number (“42229”) and the IP address resolved

Issue: 3 Issue date: October 2020 15/139

Introduction TNMS 18.10 – SNMP NBI Operation Guide

from the system host name. Consequently, the Engine ID will change if and
only if the host IP address changes, that is, if the system host name resolves
to a different IP address.

16/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP Agent Configuration

3 SNMP Agent Configuration

3.1 System Settings

3.1.1 Base System Settings

To configure the basic SNMP NBI system settings:

1. Open TNMS Client and go to Administration > System Preferences >

SNMP NBI.

Figure 2 SNMP NBI system preferences

2. Check Enable SNMP northbound interface. If this option is disabled, all

SNMP communication is blocked: no SNMP requests are accepted and no
traps are sent.
If the checkbox is greyed out, an SNMP NBI license has been installed,
but the server has not been restarted yet. 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.

Issue: 3 Issue date: October 2020 17/139

SNMP Agent Configuration TNMS 18.10 – SNMP NBI Operation Guide

Recommended: either 161, or a number between 49152 and 65535, which

is the private port range defined by IANA. Make sure the chosen port is not
in use by any other service or application on the server.
4. In Proxy name and Network name, optionally 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. (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.
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 retries, 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.1.2 MIB-II Variables

Being an SNMP agent, 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:
1. Open TNMS Client and go to Administration > System Preferences >
SNMP NBI.
2. The Name (sysName), Description (sysDescr) and Object ID
(sysObjectID) variables are set automatically by the SNMP NBI:

18/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP Agent Configuration

3. In Location (sysLocation), optionally provide an description for the

location of this SNMP agent.
4. In Contact (sysContact), optionally provide contact information, such as
the administrator’s email or telephone.

3.2 SNMP User Configuration

To configure SNMP users and notification destinations, open TNMS Client and
go to Administration > SNMP NBI User Management.

Figure 3. List of SNMP NBI users

Here you can add, edit or remove SNMP users. Next sections explain how to
configure a user.

3.2.1 SNMP User Identification

In the New SNMP NBI User > Identification tab (Figure 4), specify user
details.

Issue: 3 Issue date: October 2020 19/139

SNMP Agent Configuration TNMS 18.10 – SNMP NBI Operation Guide

Figure 4 SNMP user identification

The following fields are mandatory:

• User/Community: name of the user (SNMPv3) or the community
(SNMPv2). Maximum length is 32 characters.
• SNMP version: protocol version to be used for this user (v2c or v3).
• Authentication: encryption protocol for user authentication (optional,
SNMPv3 only). Allowed values: MD5, SHA.
• Authentication password: password for user authentication (between
8 and 64 characters).
• Privacy: encryption protocol for privacy (optional, SNMPv3 only).
Allowed values: DES, 3DES, AES128. You must enable authentication
to enable privacy.
• Privacy password: password for privacy (between 8 and 64
characters).

3.2.2 SNMP user access permissions

In the Access Permission tab (Figure 5) configure the user permissions for
incoming SNMP requests:

20/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP Agent Configuration

Figure 5 SNMP user access permissions

1. Select the level of permission granted to the user:

• No permission
• Read
• Read/Write
2. Specify the IP addresses from which requests are accepted. Both IPv4
and IPv6 addresses are supported:
Address format restrictions:
- Host names are not supported (only IP addresses).
- IP masks are not supported (only individual IP addresses).

3.2.3 User trap destinations

In the Traps tab (Figure 6) configure the SNMP TRAP destinations for the
SNMP user:

Issue: 3 Issue date: October 2020 21/139

SNMP Agent Configuration TNMS 18.10 – SNMP NBI Operation Guide

Figure 6 SNMP user trap destinations

To enable the SNMP user to receive traps:

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
Address format restrictions:
- Collapsing of groups of zeros in IPv6 trap destination addresses is
not supported.
- Host names are not supported (only IP addresses).

3.2.4 User inform destinations

In the Informs tab (Figure 7) configure the SNMP INFORM destinations for
the SNMP user.

22/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP Agent Configuration

Figure 7 SNMP user inform destinations

To enable the SNMP user to receive informs:

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
Address format restrictions:
- Collapsing of groups of zeros in IPv6 trap destination addresses is
not supported.
- Host names are not supported (only IP addresses).

3.2.5 Notification Filtering

In the Notification Filtering tab, select what types of notifications are sent to
the trap/inform destinations defined for the SNMP user.

Issue: 3 Issue date: October 2020 23/139

SNMP Agent Configuration TNMS 18.10 – SNMP NBI Operation Guide

Figure 8 SNMP NBI notification preferences

Check types of notifications to be sent to the SNMP managers. Unchecked

types of notifications will be blocked. Available options are:
• Common: SNMP NBI agent notification (for example, change of
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: Alarms originating in TNMS itself.
• PM Request: Notifications related to PM requests.
• OPM Request: Notifications related to OPM requests.
• Monitor: Notifications related to agent monitoring (for example,
heartbeats)
Notification filtering is also configurable via SNMP by setting the
enmsTrapFilter variables (see 8.3).

24/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP Agent Configuration

3.3 Heartbeat Notifications

SNMP NBI is able to send heartbeat notifications so that 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.4 Exporting SNMP Agent Configuration

The TNMS “Export Configuration” functionality may be used to export SNMP
NBI configuration data to an XML file. However, exported data cannot be
imported – its main use is for external auditing of changes.
For more information on how to export configuration data to XML, refer to
TNMS documentation.

Issue: 3 Issue date: October 2020 25/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

4 SNMP NBI MIB – General Description

4.1 Exported Object Model

Figure 9 diagrams the main objects exported by the SNMP NBI MIB, and how
they relate to each other. The modelled objects 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 9 Exported object model

26/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

In relation to fault management, all active alarms in TNMS 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 10).

Figure 10 Exported model of alarms tables

4.2 Hierarchical View

SNMP NBI MIB is structured as follows:

• coriant.svsProductMibs.svsProxEmns
• enmsNetworkSetup
• enmsNETable (5.1.1)
• enmsModuleTable (5.2.1)

Issue: 3 Issue date: October 2020 27/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

• enmsPortTable (5.3.1)
• enmsTPTable (5.4.1)
• enmsPortConnTable (5.5.1)
• enmsEquipHolderTable (5.6.1)
• enmsSNCTable (6.1.1)
• enmsCCTable (6.4.1)
• enmsEthernetPathTable (6.2.1)
• enmsSNCClientSNCTable (6.1.6)
• enmsService
• enmsServiceTable (6.3.1)
• enmsAlarmTables
• enmsAlarmTable (7.2.1)
• enmsAlarmsForNETable (7.2.2)
• enmsAlarmsForPortTable (7.2.3)
• enmsAlarmsForTPTable (7.2.4)
• enmsAlarmsForPortConnTable (7.2.5)
• enmsAlarmsForSNCTable (7.2.7)
• enmsAlarmsForModuleTable (7.2.6)
• enmsAlarmsForEMSTable (7.2.8)
• enmsProxy
• enmsControl (8.1)
• enmsTrapGroup
• enmsTrapHistory
• enmsTrapHistoryTable (8.4)
• enmsTrapVariable
• enmsTraps (5.1, 5.2, 5.3, 5.4, 5.5, 6.1,
6.2, 6.3, 7.3, 8.2, 10.4, 11.4)
• enmsTrapFilter (8.3)
• enmsPerformanceMonitoring
• enmsPerfMonRequestTable (10.1.1)
• enmsPerfMonResultPmpTable (10.6.2)
• enmsPerfMonResultValueTable (10.6.3)
• enmsPerfMonResultThresholdTable (10.6.4)
• enmsOpticalPowerMonitoring
• enmsOptPowerMonRequestTable (11.1.1)
• enmsOptPowerMonResultValueTable (11.6.2)

28/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

4.3 Notification Model

SNMP NBI sends notifications on changes and events affecting modelled
objects. These notifications are based on the ITU recommendation X.721 and
are realized as SNMP Traps.
Supported types of notifications:

Notification Type Abbrev. Meaning

ObjectCreation OC Creation of an object (for example, new NE in the

enmsNETable).

ObjectDeletion OD Deletion of an object (for example, NE removed from

enmsNETable).

StateChange SC Change of object state (for example, the operational

state).

AttributeChange AC Change of a non-state object attribute (for example, the

name).

Alarm Alarm Raise/clear of alarms originating from a network object or

the EMS itself.

Table 4 Notification types

Notifications supported for each type of modelled object:

Modelled 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

Equipment Holder None

Issue: 3 Issue date: October 2020 29/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

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:

Entity Supported notifications

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:

Object Supported notifications

PM request SC

OPM request SC

Table 7 Supported notifications for PM and OPM requests

4.4 Resynchronization After Network or Manager Errors

When network errors occur, traps sent by the SNMP NBI may not reach the
SNMP manager, causing it to become out-of-sync. An out-of-sync situation
may also occur if the SNMP manager does receive the traps, but 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 counter, incremented by one for each trap, allowing
the manager to detect if one or more traps are missing.
Using the trap counter to detect missing traps only works if the SNMP
manager has all notifications types enabled in the SNMP User Configuration
(see 3.2.5).

When an out-of-sync situation 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 on 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).

30/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

The trap history table does not contain 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 some approaches on how to efficiently access
SNMP NBI tables using the GET / GETNEXT / GETBULK operations. The
examples use the NE table (enmsNETable) and module table
(enmsModuleTable), but the suggested approaches are similar for 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 column by

column. The suggested approach to retrieve all rows is:
• Perform successive GETNEXT operations
• In each GETNEXT, request all fields of the row.

Example: 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

In this scenario, the SNMP manager first requests 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 (which in this case is enmsModuleTable):

GETNEXT(enmsNeId.2, enmsNeType.2, …, enmsNeSystemContainer.2)

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

Issue: 3 Issue date: October 2020 31/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

GETNEXT(enmsNeId.5, enmsNeType.5, …, enmsNeSystemContainer.5)

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

GETNEXT(enmsNeId.9, enmsNeType.9, …, enmsNeSystemContainer.9)

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

GETNEXT(enmsNeId.15, enmsNeType.15, …, enmsNeSystemContainer.15)

GETRESPONSE(enmsNeType.2 = “ABC”, enmsNeName.2 = “NE2”, …, enmsMoNeId.2 = 2)

The GETNEXT operations above are requesting the index field (enmsNeId)
just for 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 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

The SNMP manager starts by requesting the first row for NE 9. It performs a
GETNEXT operation, where the supplied OIDs only include the enmsMoNEId
part of the index (the enmsMoModuleId part of the index is therefore omitted):

GETNEXT(enmsMoNeId.9, enmsMoModuleId.9, enmsMoType.9, …, enmsMoSlot.9)

32/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

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)

GETNEXT(enmsMoNeId.9.5, enmsMoModuleId.9.5, enmsMoType.9.5, …, enmsMoSlot.9.5)

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

GETNEXT(enmsMoNeId.9.6, enmsMoModuleId.9.6, enmsMoType.9.6, …, enmsMoSlot.9.6)

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 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 Limited size of responses

Every SNMP response must fit in a single UDP packet, whose maximum size
depends on the network and server configuration. If a response will not fit,
SNMP NBI normally responds with a tooBig error status – most commonly
you’ll need to reduce the max-repetitions parameter of the GETBULK
requests.
In some cases SNMP NBI may not be able to automatically determine the
maximum message size, causing oversized responses to be silently dropped.
To prevent this situation, you may force a maximum message size by editing
the SNMP NBI properties file, which can be found in the following location on
the server installation:
<Product_Installation_Folder>
/server/bicnet/deployments/bicnet.ear/conf/snmpNbi.properties

To set the maximum SNMP message size, add or change the msgMaxSize
property as exemplified below:
msgMaxSize=8000

Restart server for changes to take effect.

Issue: 3 Issue date: October 2020 33/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

4.5.5 Request timeouts

SNMP request response time depends on several factors, such as server

load, network load, table being accessed and volume of data in the table. If
timeout errors occur, you may need to increase the timeout value on the
SNMP manager.
To confirm that a timeout error is not caused by a generic problem, such as
lack of network connectivity or SNMP NBI misconfiguration, first perform a
GET operation on a MIB leaf attribute, for example enmsProxyName (see
8.1). 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.
Data type Description

AdministrativeState Administrative state of managed objects:

- unknown(0)
- locked(1) – Use of resource administratively prohibited.
- unlocked(2) – Use of resource administratively permitted.
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)

Bandwidth Character string with one or more bandwidths separated by

commas.

Boolean Boolean value:

- false (0)
- true (1)

CCId Global identifier of a CC (unsigned 32-bit integer).

34/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

Data type Description

CombinedSwitchState Enumeration of path switch states:

- unknown(0)
- noSelector(1)
- clear(2)
- forceToWorking(3)
- forceToProtecting(4)
- manualToWorking(5)
- manualToProtecting(6)
- forcedExtraToProtection(7)
- lockout(8)
- forcedClear(9)
- sfonwkg(10)
- sfonprot(11)
- sdonwkg(12)
- sdonprot(13)
- waitToRestore(14)
- reverseRequest(15)
- doNotRevert(16)
- exercise(17)
- activeSwitch(18)
- mismatched(19)
- disabled(20)

Directionality Direction of a resource:

- unknown(1)
- unidirectional(2)
- bidirectional(3)

DisplayString String of printable characters, meant to be displayed to

humans. Non-ASCII characters are encoded in UTF-8.

EnmsTimeStamp Human-readable timestamp string. Format:

yyyy-MM-dd HH:mm:ss
Example: 2014-07-09 15:59:30
Timestamps are in UTC.

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)
- ethernetPath(11)
- pmRequest(12)
- opmRequest(13)

Issue: 3 Issue date: October 2020 35/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

Data type Description

EquipmentHolderType Type of equipment holder:

- unknown(0)
- rack(1)
- shelf(2)
- subShelf(3)
- slot(4)
- subSlot(5)

EquipmentHolderId Equipment holder identifier within an NE (unsigned 32-bit

integer).

EthernetPathId Global Identifier of an Ethernet Path (unsigned 32-bit integer).

EthernetPathStatus Status of an Ethernet Path:

- active
- inactive
- inconsistent
- incomplete
- planned
- inTest
- activating
- deactivating
- activationFailed
- deactivationFailed

EthernetPathType Type of Ethernet Path:

- pointToPoint(1)
- multipointToMultipoint(2)
- rootedMultipoint(3)

FilterType Type of object for which to collect PM/OPM data:

- unknown(0)
- tpObject(1)
- portObject(2)
- neObject(3)
- sncObject(4)
- ethernetPathObject(5)
- moduleObject(6),
- equipHolderObject(7)

InfoString Parsable character string.

LayerSet Character string with one or more transport layers (for

example, VC4 or OTU1) separated by commas.

ModuleId Module identifier within an NE (unsigned 32-bit integer).

NEClass (to be supported)

Class of an NE.
- singleNode(1)
- repeaterNode(2)
- managementNode(3)
- masterRingNode(4)
- slaveRingNode(5)

NEId Global identifier of an NE (unsigned 32-bit integer).

36/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

Data type Description

NotificationType Type of notification in the history table:

- objectCreation(1)
- objectDeletion(2)
- stateChange(3)
- attributeValueChange(4)
- alarm(5)
- relationshipChange(6)

OperatingMode Ability of an NE to send notifications:

- operation(1) – NE sends all notifications.
- maintenance(2) – NE suppresses all notifications.

OperationalState Operability of a resource:

- unknown(1) – Operational state cannot be determined
(for example, NE disconnected from DCN).
- enabled(2) – Resource is operational.
- disabled(3) – Resource is not operational.
- partiallyEnabled(4) – Resource is partially operational.

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)

PerceivedSeverity Enumeration of alarm severities:

- cleared(0)
- warning(1)
- minor(2)
- major(3)
- critical(4)
- indeterminate(5)
- nonexistent(6)
- nonAlarmed(7)
- notAlarmed(8)

PerfMonDirection PMP direction:

- unknown(0)
- none(1)
- incoming(2)
- outcoming(3)
- both(4)

PerfMonGranularity Granularity of PM data:

- unknown(0)
- minutes15(1)
- hours24(2)

Issue: 3 Issue date: October 2020 37/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

Data type Description

PerfMonLocation Location of the PM measurement:

- unknown(0)
- nearEnd(1)
- farEnd(2)

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)

PerfMonStatus Status of a PM parameter value:

- unknown(0)
- valid(1)
- invalid(2)
- incomplete(3)

PerfMonThresholdType Type of threshold value:

- unknown(0)
- lowest(1)
- low(2)
- high(3)
- highest(4)

PerfMonType Type of PM data to retrieve:

- unknown(0)
- pmHistory(1)
- pmCurrent(2)
- pmPoints(3)

PortConnId Global identifier of a port connection (unsigned 32-bit integer).

PortId Port identifier within an NE (unsigned 32-bit integer).

ProbableCause Enumeration of alarm probable causes. See MIB for

enumerated values.

ProtectionState Protection state of a cross-connection:

- non(0) – Not applicable (for example, CC is unprotected).
- working(1) – All traffic is being selected from the working
channels.
- protecting(2) – Traffic is being selected from at least one
of the protecting channels.

38/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

Data type Description

PTInterfaceType Type of interface medium:

- unknown(0)
- optical(1)
- electrical(2)
- radio(3)

PTProtectionType Protection type of a port, for MS Protections:

- 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.

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) – Supports bundle SNCs.
- bit 2 (value 4) – May not be connected to other ports.
- bit 3 (value 8) – Does not support unidirectional SNCs.
- bit 4 (value 16) – Does not support flexible SNCs.

Issue: 3 Issue date: October 2020 39/139

SNMP NBI MIB – General Description TNMS 18.10 – SNMP NBI Operation Guide

Data type Description

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
- bit 8 (value 256) – SONET
A value of zero means indeterminate technology, not
applicable or unknown.

SNCId Global identifier of an SNC (unsigned 32-bit integer).

SNCProtectionInfo Level of protection or broadcast of a connection:

- unprotected(1) – 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.

TPEndPointType TP role in an SNC:

- sourceTP(1)
- destinationTP(2)

TPId Higher or lower 32 bits of a TP identifier within a port

(unsigned 32-bit integer).

TPIndex String with hexadecimal representation of a TP index.

Example: 2ABF6

TPReliability Reliability of a TP:

- preEmptive(1) - Resource is unreliable and will only be
used for low priority services (as long it is not needed to
protect high priority services).
- unprotected(2) - Resource not protected by MSP.
- protected(3) – Resource protected by MSP.

TPTerminationType Termination type of a TP:

- connection(1) – CTP
- trail(2) – TTP

TPType Termination point type. Obsolete.

TrafficDirection Traffic direction affected by an alarm:

- unknown(0)
- none(1)
- inbound(2)
- outbound(3)
- both(4)

40/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide SNMP NBI MIB – General Description

Data type Description

TrafficDirectionTelcordia Traffic direction (Telcordia) affected by an alarm:

- unknown(0),
- notApplicable(1)
- unidirectionalClientToLine(2)
- unidirectionalLineToClient(3)
- unidirectionalRcv(4)
- unidirectionalTrtm(5)

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

- sendTrapsOn (1) – Traps are sent
- sendTrapsOff (2) – Traps are blocked

UniqueId Unsigned 32-bit unique identifier.

UsageState The usage state of a resource:

- unknown(0)
- idle(1) – Resource currently not in use.
- active(2) – Not used.
- busy(3) – Resource in use (spare operating capacity may
be available).

Table 10 Data types used in SNMP NBI MIB

4.7 Strings and Multi-Language Support

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

Issue: 3 Issue date: October 2020 41/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

5 Retrieving Network Inventory

Network infrastructure objects (NEs, Modules, Ports, TPs and Port
Connections) can be retrieved by accessing the tables below:
• enmsNETable
• enmsModuleTable
• enmsPortTable
• enmsTPTable
• enmsPortConnTable
• enmsEquipHolderTable
For all tables above except enmsEquipHolderTable, SNMP NBI sends object
creation (OC) and object deletion (OD) notifications, as well as state change
(SC) and attribute value change (AVC) notifications for selected object
attributes.

5.1 Network Elements

5.1.1 List of NEs (enmsNETable)

Table enmsNETable 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).
If the NE is in a system
container, the system
container name is returned.

enmsNeAlarmSeverity PerceivedSeverity Highest severity of all alarms

affecting the NE or its
modules, ports and TPs.

42/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Attribute name Data type Notif. Description

enmsNeOperatingMode OperatingMode AVC NE's ability to send

notifications:
- Operation: NE reports all
events to TNMS;
- Maintenance: 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

allows SNCP creation via
TNMS.

enmsNeClass NEClass (to be supported)

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.
(to be supported)

enmsNeSystemContainer DisplayString AVC System container name.

enmsNeUserText DisplayString AVC User Text, as specified by the

operator in the DCN property
page of the NE.

Table 11 enmNETable attributes

5.1.2 Notification of NE object creation (enmsNEObjectCreationTrap)

Notification sent when an NE is added to the NE table.

Issue: 3 Issue date: October 2020 43/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

Variable 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 Not used.

enmsTrapNeIdName DisplayString NE name, as specified by the operator

in TNMS.

enmsNeSystemContainer DisplayString System container of the NE.

enmsNeUserText DisplayString User Text as specified by the operator

in the DCN property page of the NE.

Table 12 List of enmsNEObjectCreationTrap attributes

5.1.3 Notification of NE object deletion (enmsNEObjectDeletionTrap)

Notification sent when an NE is removed from the NE table.

Variable 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 Not used.

enmsTrapNeIdName DisplayString NE name, as specified by the operator

in TNMS.

enmsNeSystemContainer DisplayString System container of the NE.

enmsNeUserText DisplayString User Text as specified by the operator

in the DCN property page of the NE.

Table 13 List of enmsNEObjectDeletionTrap attributes

5.1.4 Notification of NE state change (enmsNEStateChangeTrap)

Notification sent when an NE state attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

44/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Variable name Data type Description

enmsNeNEId NEId Global NE identifier.

enmsNeName DisplayString NE name, as reported by the NE.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapStateName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapStateOldValue Integer Old state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer New state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapNeIdName DisplayString NE name, as specified by the

operator in TNMS.

enmsNeSystemContainer DisplayString System container of the NE.

enmsNeUserText DisplayString User Text as specified by the

operator in the DCN property
page of the NE.

Table 14 List of enmsNEStateChangeTrap attributes

5.1.5 Notification of NE attribute value change

(enmsNEAttributeChangeTrap)

Notification sent when an NE attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsNeNEId NEId Global NE identifier.

enmsNeName DisplayString NE name, as reported by the NE.

Note: If the AVC relates to the NE
name, this field contains the new
value.

enmsTrapEventDetails DisplayString Empty.

Issue: 3 Issue date: October 2020 45/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

enmsTrapNeIdName DisplayString NE name, as specified by the

operator in TNMS.
Note: If the AVC relates to the NE
Id name, this field contains the
new value.

enmsNeSystemContainer DisplayString System container of the NE.

enmsNeUserText DisplayString User Text as specified by the

operator in the DCN property
page of the NE.

Table 15 List of enmsNEAttributeChangeTrap attributes

5.2 Modules

5.2.1 List of Modules (enmsModuleTable)

Table enmsModuleTable contains all modules of the NEs in the network. It

supports OC, OD and SC notifications.

Attribute name Data type Notif. Description

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.

46/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Attribute name Data type Notif. Description

enmsMoShelf DisplayString Shelf and/or rack of the module,

separated by a dash if both are
present.

enmsMoSlot DisplayString Slot number of the module. If

present, the sub-slot is
appended, separated by a dash.

enmsMoObjectType Integer32 Internal object type.

enmsMoNativeLocation DisplayString AVC Optional native object location in

the network element.

Table 16 List of enmsModuleTable attributes

5.2.2 Notification of Module object creation

(enmsModuleObjectCreationTrap)

Notification sent when a new module is added to the module table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsMoNEId NEId Global NE identifier.

enmsMoModuleId ModuleId Module identifier.

enmsTrapEventDetails DisplayString Empty.

Table 17 List of enmsModuleObjectCreationTrap attributes

5.2.3 Notification of Module object deletion

(enmsModuleObjectDeletionTrap)

Notification sent when a module is removed from the module table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsMoNEId NEId Global NE identifier.

enmsMoModuleId ModuleId Module identifier.

enmsTrapEventDetails DisplayString Empty.

Table 18 List of enmsModuleObjectCreationTrap attributes

Issue: 3 Issue date: October 2020 47/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

5.2.4 Notification of Module state change

(enmsModuleStateChangeTrap)

Notification sent when a module state attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsMoNEId NEId Global NE identifier.

enmsMoModuleId ModuleId Module identifier.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapStateName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapStateOldValue Integer Old state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer New state value. Check the

possible enumerated values of the
changed attribute.

Table 19 List of enmsModuleStateChangeTrap attributes

5.2.5 Notification of Module attribute value change

(enmsModuleAttributeChangeTrap)

Notification sent when a module attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsMoNEId NEId Global NE identifier.

enmsMoModuleId ModuleId Module identifier.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

48/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Variable name Data type Description

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

Table 20 List of enmsModuleAttributeChangeTrap attributes

5.3 Ports

5.3.1 List of Ports (enmsPortTable)

Table enmsPortTable contains all ports in the network. It supports OC, OD,
AVC and SC notifications.

Attribute name Data type Notif. Description

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.

A value of zero means
indeterminate technology,
not applicable or unknown.

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.

Issue: 3 Issue date: October 2020 49/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Notif. Description

enmsPtCanPathProtection Boolean Indicates if the port allows

SNCP creation via TNMS.

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 in the context

of MS Protections.

enmsPtObjectType Integer32 Internal object type.

enmsPtNativeLocation DisplayString AVC Optional native object

location in the network
element.

Table 21 List of enmsPortTable attributes

5.3.2 Notification of Port object creation (enmsPortObjectCreationTrap)

Notification sent when a port is added to the port table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsPtNEId NEId Global NE identifier.

enmsPtPortId PortId Port identifier.

enmsPtName DisplayString Port name.

enmsTrapEventDetails DisplayString Empty.

Table 22 List of enmsPortObjectCreationTrap attributes

50/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

5.3.3 Notification of Port object deletion (enmsPortObjectDeletionTrap)

Notification sent when a port is removed from the port table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsPtNEId NEId Global NE identifier.

enmsPtPortId PortId Port identifier.

enmsPtName DisplayString Port name.

enmsTrapEventDetails DisplayString Empty.

Table 23 List of enmsPortObjectDeletionTrap attributes

5.3.4 Notification of Port state change (enmsPortStateChangeTrap)

Notification sent when a port state attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsPtNEId NEId Global NE identifier.

enmsPtPortId PortId Port identifier.

enmsPtName DisplayString Port name.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapStateName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapStateOldValue Integer Old state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer New state value. Check the

possible enumerated values of the
changed attribute.

Table 24 List of enmsPortStateChangeTrap attributes

Issue: 3 Issue date: October 2020 51/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

5.3.5 Notification of Port attribute value change

(enmsPortAttributeChangeTrap)

Notification sent when a port attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsPtNEId NEId Global NE identifier.

enmsPtPortId PortId Port identifier.

enmsPtName DisplayString Port name.

Note: If the AVC relates to the
port name, this field contains the
new value.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

Table 25 List of enmsPortAttributeChangeTrap attributes

5.4 Termination Points

5.4.1 List of TPs (enmsTPTable)

Table enmsTPTable contains all termination points in the network. It supports

OC, OD, AVC and SC notifications.

Attribute name Data type Notif. Description

enmsTpNEId NEId NE Id (table index).

enmsTpPortId PortId Port Id (table index).

enmsTpTPIdH TPId Higher 32 bits of TP Id (table

index).

52/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Attribute name Data type Notif. Description

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 The number of carried signals

in an Inverse Multiplexing
group, if applicable. 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 (to be supported)

Number of cross connections
using the TP for the TX
direction.

enmsTpUsageCountRX Integer32 (to be supported)

Number of cross connections
using the TP for the RX
direction.

enmsTpUsageStateTX UsageState (to be supported)

Usage state in the TX
direction.

enmsTpUsageStateRX UsageState (to be supported)

Usage state in the RX
direction.

enmsTpReliability TPReliability Obsolete.

Issue: 3 Issue date: October 2020 53/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Notif. Description

enmsTpLayerSet LayerSet TP transport layer set.

enmsTpBandwidthTX Bandwidth (to be supported)

TP bandwidth in the TX
direction.

enmsTpBandwidthRX Bandwidth (to be supported)

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, if the TP

represents a VC group.

enmsTpObjectType Integer32 Internal object type.

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).

enmsTpNativeLocation DisplayString AVC Optional native object location

in the network element.

Table 26 List of enmsTPTable attributes

5.4.2 Notification of TP object creation (enmsTPObjectCreationTrap)

Notification sent when a TP is added to the TP table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsTpNEId NEId Global NE identifier.

enmsTpPortId PortId Port identifier.

enmsTpTPIdH TPId Higher 32 bits of TP Id.

54/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Variable name Data type Description

enmsTpTPIdL TPId Lower 32 bits of TP Id.

enmsTpName DisplayString TP name.

enmsTpTPType TPType Obsolete. Always unknown.

enmsTrapEventDetails DisplayString Empty.

Table 27 List of enmsTPObjectCreationTrap attributes

5.4.3 Notification of TP object deletion (enmsTPObjectDeletionTrap)

Notification sent when a TP is removed from the TP table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

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.

enmsTrapEventDetails DisplayString Empty.

Table 28 List of enmsTPObjectDeletionTrap attributes

5.4.4 Notification of TP state change (enmsTPStateChangeTrap)

Notification sent when a TP state attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

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.

Issue: 3 Issue date: October 2020 55/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

enmsTpName DisplayString TP name.

enmsTpTPType TPType Obsolete. Always unknown.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapStateName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapStateOldValue Integer Old state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer New state value. Check the

possible enumerated values of the
changed attribute.

Table 29 List of enmsTPStateChangeTrap attributes

5.4.5 Notification of TP attribute value change

(enmsTPAttributeChangeTrap)

Notification sent when a TP attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

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.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

56/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Variable name Data type Description

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

Table 30 List of enmsTPAttributeChangeTrap attributes

5.5 Port Connections

5.5.1 List of Port Connections (enmsPortConnTable)

Table enmsPortConnTable contains all managed ports connections. It

supports OC, OD and AVC notifications.

Attribute name Data type Notif. Description

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 31 List of enmsPortConnTable attributes

Issue: 3 Issue date: October 2020 57/139

Retrieving Network Inventory TNMS 18.10 – SNMP NBI Operation Guide

5.5.2 Notification of Port Connection object creation

(enmsPortConnObjectCreationTrap)

Notification sent when a Port Connection is added to the Port Connection

table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsPcPortConnId PortConnId Global port connection identifier.

enmsPcName DisplayString Port connection name.

enmsTrapEventDetails DisplayString Empty.

Table 32 List of enmsPortConnObjectCreationTrap attributes

5.5.3 Notification of Port Connection object deletion

(enmsPortConnObjectDeletionTrap)

Notification sent when a Port Connection is removed from the Port Connection
table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsPcPortConnId PortConnId Global port connection identifier.

enmsPcName DisplayString Port connection name.

enmsTrapEventDetails DisplayString Empty.

Table 33 List of enmsPortConnObjectDeletionTrap attributes

5.5.4 Notification of Port Connection attribute value change

(enmsPortConnAttributeChangeTrap)

Notification sent when a Port Connection attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsPcPortConnId PortConnId Global port connection identifier.

enmsPcName DisplayString Port connection name.

58/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Network Inventory

Variable name Data type Description

Note: If the AVC relates to the

port connection name, this field
contains the new value.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

Table 34 List of enmsPortConnAttributeChangeTrap attributes

5.6 Equipment Holders

5.6.1 List of Equipment Holders (enmsEquipHolderTable)

Table enmsEquipHolderTable contains all shelves. No notifications are sent

for equipment holders.

Attribute name Data type Notif. Description

enmsEhNEId NEId NE Identifier (table index).

enmsEhEquipHolderId EquipmentHolderId Equipment holder identifier

within the NE (table index).

enmsEhType EquipmentHolderType Type of equipment holder.

Note: Currently only
shelves are supported.

enmsEhName DisplayString Equipment holder name.

Table 35 List of enmsEquipHolderTable attributes

Issue: 3 Issue date: October 2020 59/139

Retrieving Paths, Services and Cross-connections TNMS 18.10 – SNMP NBI Operation Guide

6 Retrieving Paths, Services and Cross-

connections
Connection-related objects (optical paths, ethernet paths, cross-connections
and services) can be retrieved by accessing the following tables:
• enmsSNCTable
• enmsEthernetPathTable
• enmsCrossConnectionTable
• enmsServiceTable
For all tables above, except enmsCrossConnectionTable, SNMP NBI sends
object creation (OC) and object deletion (OD) notifications, as well as state
change (SC) and attribute value change (AVC) notifications for selected object
attributes.

6.1 Sub-Network Connections (Optical Paths)

6.1.1 List of SNCs (enmsSNCTable)

Table enmsSNCTable contains all paths of the Optical Manager. It supports

OC, OD, AVC and SC notifications.

Attribute name Data type Notif. Description

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

60/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Paths, Services and Cross-connections

Attribute name Data type Notif. Description

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

enmsScDest2NEId NEId Identifier of the second Z-

end in the list of path edges.
enmsScDest2PortId PortId

enmsScDest2TPIdH TPId

enmsScDest2TPIdL TPId

enmsScServiceId ServiceId Identifier of enclosing

service, if applicable.

enmsScName DisplayString AVC SNC name as presented in

the TNMS GUI.

enmsScOpState OperationalState SC Operational state of the

SNC:
- enabled if ACS is
‘Active’ and Operational
State is ‘Enabled’.
- partiallyEnabled if ACS
is ‘Active’ and
Operational State is
‘Protection Disturbed’,
‘Server Disturbed’,
‘Degraded’ or ‘Disabled
Local’.
- disabled if ACS is
‘Disabled’ or Operation
State is ‘Disabled’,
‘Server Disabled’ or
‘Disabled Transport’.
- unknown if not
applicable or not
possible to determine.

enmsScAdminState AdministrativeState SC Administrative state.

Reflects the RCS of the
path: ‘unlocked’ if RCS is
‘Active’, otherwise ‘locked’.

Issue: 3 Issue date: October 2020 61/139

Retrieving Paths, Services and Cross-connections TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Notif. Description

enmsScAlarmSeverity PerceivedSeverity AVC Highest severity of all

alarms affecting this SNC.
Depending on TNMS
configuration, this field may
also reflect the highest
severity of alarms affecting
the SNC’s server SNCs.
Note however that
enmsAlarmsForSNCTable
will not associate the SNC
to those server SNCs
alarms.

enmsScBandwidth Bandwidth SNC bandwidth.

enmsScDirection Directionality SNC direction.

enmsScProtectionFlag Boolean Obsolete.

enmsScProtectionInfo SNCProtectionInfo Level of SNC protection or

broadcast.
Obsolete.

enmsScNxCount Unsigned32 Inverse multiplexing

number. Only applicable if
the SNC represents a virtual
concatenated group.

enmsScSNCOwnerId SNCId (to be supported)

enmsSCLayerSet LayerSet Layer set of the SNC.

enmsScFragmentLayer LayerSet The layer of the fragments.

Only applicable if 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).

enmsScSwitchState CombinedSwitchState SC SNC protection switch state.

Table 36 List of enmsSNCTable attributes

62/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Paths, Services and Cross-connections

6.1.2 Notification of SNC object creation (enmsSNCObjectCreationTrap)

Notification sent when a new SNC is added to the SNC table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsScSNCId SNCId Global SNC identifier.

enmsScName DisplayString SNC name.

enmsTrapEventDetails DisplayString Empty.

Table 37 List of enmsSNCObjectCreationTrap attributes

6.1.3 Notification of SNC object deletion (enmsSNCObjectDeletionTrap)

Notification sent when an SNC is removed from the SNC table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsScSNCId SNCId Global SNC identifier.

enmsScName DisplayString SNC name.

enmsTrapEventDetails DisplayString Empty.

Table 38 List of enmsSNCObjectDeletionTrap attributes

6.1.4 Notification of SNC state change (enmsSNCStateChangeTrap)

Notification sent when an SNC state attribute has a new value. This
notification is also used to report protection switch events on CCs and
protection groups affecting SNCs (see 0).

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsScSNCId SNCId Global SNC identifier.

enmsScName DisplayString SNC name.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

Issue: 3 Issue date: October 2020 63/139

Retrieving Paths, Services and Cross-connections TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

enmsTrapStateName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapStateOldValue Integer Old state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer New state value. Check the

possible enumerated values of the
changed attribute.

Table 39 List of enmsSNCStateChangeTrap attributes

6.1.5 Notification of SNC attribute value change

(enmsSNCAttributeChangeTrap)

Notification sent when an SNC attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsScSNCId SNCId Global SNC identifier.

enmsScName DisplayString SNC name.

Note: If the AVC relates to the
SNC name, this field contains the
new value.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

Table 40 List of enmsSNCAttributeChangeTrap attributes

64/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Paths, Services and Cross-connections

6.1.6 Association between SNCs and their client SNCs

(enmsSNCClientSNCTable)

Table enmsSNCClientSNCTable associates paths with their direct client

paths. No notifications are sent for this table.

Attribute name Data type Notif. Description

enmsScsSNCId SNCId SNC Id (table index).

enmsScsClientSNCId SNCId SNC Id of a direct client path.

Table 41 List of enmsSNCClientSNCTable attributes

6.1.7 Receiving protection switch notifications

When a protection switch event occurs on a protected CC or on a protection

group (such as OMSP), SNMP NBI notifies that change by sending an
enmsSNCStateChangeTrap notification on the most server affected SNC.
These notifications will have enmsTrapStateName set to 9 (which means
protectionState).

Although enmsSNCStatChangeTrap is being used to notify protection switch

occurrences on the network, it does not reflect any attribute of the SNC itself.

The following table describes enmsSNCStatChangeTrap contents for

protection switch notifications.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsScSNCId SNCId Global SNC identifier.

enmsScName DisplayString SNC name.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapStateName Integer For protection switch notifications,

the value is 9 - protectionState.

enmsTrapStateOldValue Integer Old state value. For protection

state changes on CCs, values
may be:
- 0 - Not applicable

Issue: 3 Issue date: October 2020 65/139

Retrieving Paths, Services and Cross-connections TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

- 1 - Traffic is selected from a

working channel
- 2 - Traffic is selected from a
protecting channel
For protection state changes on
protection groups, this value is
unavailable (always 0).

enmsTrapStateNewValue Integer New state value. For protection

state changes on CCs or
protection groups, values may be:
- 0 - Not applicable
- 1 - Traffic is selected from a
working channel
- 2 - Traffic is selected from a
protecting channel

Table 42 List of enmsSNCStateChangeTrap attributes for protection switch

notifications

Since SNMP NBI does not model protection groups, the protection switch
notifications do not carry the old protection state, only the new one. Also,
protection switch events on protection groups may generate redundant
notifications or notifications for intermediate conditions.

6.2 Ethernet Paths

6.2.1 List of Ethernet Paths (enmsEthernetPathTable)

Table enmsEthernetPathTable contains all the Ethernet services of the

Ethernet Manager. It supports OC, OD, and SC notifications.

Attribute name Data type Notif. Description

enmsEvcEthernetPathId EthernetPathId Ethernet Path Id (table index)

enmsEvcName DisplayName AVC Ethernet Path name.

enmsEvcSVlanId Integer32 S-VLAN Id

enmsEvcType EthernetPathType Ethernet Path type.

enmsEvcServiceId ServiceIdentifier Identifier of enclosing service, if

applicable.

66/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Paths, Services and Cross-connections

Attribute name Data type Notif. Description

enmsEvcOpState OperationalState SC Operational State

enmsEvcAdminState AdministrativeState SC Administration State

enmsEvcAlarmSeverity PerceivedSeverity AVC Highest severity of all alarms

affecting this Ethernet Path.

Table 43 List of enmsEthernetPathTable attributes

6.2.2 Notification of Ethernet Path object creation

(enmsEthernetPathObjectCreationTrap)

Notification sent when a new Ethernet Path is added to the Ethernet Path
table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsEvcEthernetPathId EthernetPathId Global Ethernet Path identifier.

enmsEvcName DisplayString Ethernet Path name.

enmsTrapEventDetails DisplayString Empty.

Table 44 List of enmsEthernetPathObjectCreationTrap attributes

6.2.3 Notification of Ethernet Path object deletion

(enmsEthernetPathObjectDeletionTrap)

Notification sent when an Ethernet Path is removed from the Ethernet Path
table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsEvcEthernetPathId EthernetPathId Global Ethernet Path identifier.

enmsEvcName DisplayString Ethernet Path name.

enmsTrapEventDetails DisplayString Empty.

Table 45 List of enmsEthernetPathObjectDeletionTrap attributes

Issue: 3 Issue date: October 2020 67/139

Retrieving Paths, Services and Cross-connections TNMS 18.10 – SNMP NBI Operation Guide

6.2.4 Notification of Ethernet Path state change

(enmsEthernetPathStateChangeTrap)

Notification sent when an Ethernet Path state attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsEvcEthernetPathId EthernetPathId Global Ethernet Path identifier.

enmsEvcName DisplayString Ethernet Path name.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapStateName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapStateOldValue Integer Old state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer New state value. Check the

possible enumerated values of the
changed attribute.

Table 46 List of enmsEthernetPathStateChangeTrap attributes

6.2.5 Notification of Ethernet Path attribute value change

(enmsEthernetPathAttributeChangeTrap)

Notification sent when an Ethernet Path attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsEvcEthernetPathId EthernetPathId Global Ethernet Path identifier.

enmsEvcName DisplayString Ethernet Path name.

Note: If the AVC relates to the
Ethernet Path name, this field
contains the new value.

enmsTrapEventDetails DisplayString Empty.

68/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Paths, Services and Cross-connections

Variable name Data type Description

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

Table 47 List of enmsEthernetPathAttributeChangeTrap attributes

6.3 Services

6.3.1 List of Services (enmsServiceTable)

Table enmsEthernetPathTable contains all services defined in TNMS.

A ‘service’ corresponds to a TNMS container of type ‘Service’ – not to be
confused with ‘Ethernet Services’, which in SNMP NBI nomenclature are
called ‘Ethernet Paths’.

Attribute name Data type Notif. Description

enmsSvServiceId (index) Unsigned32 Service Id (table index).

enmsSvSubscriberId (index) Unsigned32 (to be supported)

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 Unsupported

enmsSvDirection Directionality Obsolete

Issue: 3 Issue date: October 2020 69/139

Retrieving Paths, Services and Cross-connections TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Notif. Description

enmsSvProtectionFlag Boolean Obsolete

enmsSvWriteProtected Boolean Obsolete

enmsSvServiceOwnerId Unsigned32 Obsolete

Table 48 List of enmsServiceTable attributes

6.3.2 Notification of Service object creation

(enmsServiceObjectCreationTrap)

Notification sent when a new service is added to the service table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsSvServiceId ServiceId Global service identifier.

enmsSvLabel DisplayString Service name.

enmsTrapEventDetails DisplayString Empty.

Table 49 List of enmsServiceObjectCreationTrap attributes

6.3.3 Notification of Service object deletion

(enmsServiceObjectDeletionTrap)

Notification sent when a service is removed from the service table.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsSvServiceId ServiceId Global service identifier.

enmsSvLabel DisplayString Service name.

enmsTrapEventDetails DisplayString Empty.

Table 50 List of enmsServiceObjectDeletionTrap attributes

6.3.4 Notification of Service state change

(enmsServiceStateChangeTrap)

Notification sent when a service state attribute has a new value.

70/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Paths, Services and Cross-connections

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsSvServiceId ServiceId Global service identifier.

enmsSvLabel DisplayString Service name.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapStateName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

enmsTrapStateOldValue Integer Old state value. Check the

possible enumerated values of the
changed attribute.

enmsTrapStateNewValue Integer New state value. Check the

possible enumerated values of the
changed attribute.

Table 51 List of enmsServiceStateChangeTrap attributes

6.3.5 Notification of Service attribute value change

(enmsServiceAttributeChangeTrap)

Notification sent when a service attribute has a new value.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsSvServiceId SNCId Global service identifier.

enmsSvLabel DisplayString Service name.

Note: If the AVC relates to the
SNC name, this field contains the
new value.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Not relevant.

enmsTrapEventProbableCause ProbableCause Not relevant.

enmsTrapAttributeName Integer Indicates which table field has

changed. Check possible values
in MIB definition.

Issue: 3 Issue date: October 2020 71/139

Retrieving Paths, Services and Cross-connections TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

enmsTrapAttributeOldValue DisplayString Old attribute value.

enmsTrapAttributeNewValue DisplayString New attribute value.

Table 52 List of enmsServiceAttributeChangeTrap attributes

6.4 Cross Connections

6.4.1 List of Cross Connections (enmsCCTable)

Table enmsCCTable contains all cross connections in the network. No

notifications are sent for this table.

Attribute name Data type Notif. Description

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

72/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving Paths, Services and Cross-connections

Attribute name Data type Notif. Description

enmsCcDest2TPIdH TPId

enmsCcDest2TPIdL TPId

enmsCcOpState OperationalState Operational state.

enmsCcDirection Directionality CC direction.

enmsCcProtectionFlag Boolean Indicates whether CC is

protected.

enmsCcProtectionState ProtectionState Actual protection state.

enmsCcNxCount Unsigned32 Used when more than a

single termination point is
connected as a bundle.

Table 53 List of enmsCCTable attributes

Issue: 3 Issue date: October 2020 73/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

7 Retrieving and Receiving Alarms

7.1 Approaches for Monitoring Alarms

TNMS alarms can be monitored via SNMP NBI by listening to alarm
notifications or by polling the alarm tables.

7.1.1 Listening to alarm notifications

In this approach, the manager listens for alarm notifications sent by SNMP
NBI.

SNMP NBI sends alarm raise/clear notifications in one of five different traps,
depending on the object that originated the alarm:

• enmsNEAlarmTrap
• enmsModuleAlarmTrap
• enmsPortAlarmTrap
• enmsTPAlarmTrap
• enmsEMSAlarmTrap

Each trap above carries a set of variables describing the alarm, such as the
identifier of the affected network object, alarm cause, severity, etc. (see
section 7.2 for details).

If the severity variable (enmsTrapEventSeverity) is set to zero, it means the

alarm has been cleared.

Example of module alarm:

enmsModuleAlarmTrap {
enmsTrapCounter = 12345,
enmsMoNEId = 50,
enmsMoModuleId = 9876,
enmsTrapEventDetails = “”,
enmsTrapEventSeverity = 4 (critical),
enmsTrapEventProbableCause = 30 (CardFailure),
enmsAlClass = 4 (equipment),
enmsAlState = 3 (unacknowledged),
enmsAlTimeStamp = “2015-09-10 22:35:01”,
enmsAlEntityString = “CARD 001”,

74/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

enmsTrapEventProbableCauseString = “Card Failure (CFAIL)”,

enmsNeName = “NETEST1”,
enmsTrapNeLocationLct = “”,
enmsTrapNeIdName = “NE Test 1”,
enmsTrapAffectedLocation = “”,
enmsTrapEventTrafficDirection = (0) unknown,
enmsAlServiceAffect = true,
enmsAlAdditionalInformation = “”,
enmsAlNeSystemContainer = “”,
enmsAlNeNativeLocation = “”,
enmsAlAlarmDirectionTelcordia = (0) unknown
}

The enmsTrapEventProbableCause variable indicates the cause of the alarm.

Possible values are defined in the SNMP NBI MIB file, in the ‘ProbableCause’
enumeration. Excerpt:
ProbableCause ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION "Enumeration of alarm probable causes."
SYNTAX INTEGER
{
unknown (0),
acd (1),
...
cardFailure (30),
...
los (132),
...
}

As an example, if the manager is monitoring Loss of Signal (los) alarms, then

it should react whenever it receives an alarm trap with the
enmsTrapEventProbableCause variable set to 132.
To identify which object the alarm has been raised/cleared for, the manager
can use the object ID attributes – in the previous example, those are
enmsMoNEId and enmsMoModuleId. Alternatively, it may use the
enmsAlEntityString variable, which contains a human-readable string
describing the object.
To deal with notification loss, the manager can periodically resynchronize all
alarms by retrieving the global alarm table – see next section.

7.1.2 Polling the alarm tables

In the polling approach, the manager periodically retrieves all rows in the
global alarm table (enmsAlarmTable), then processes each entry as for the
alarm notification. If a previous alarm is no longer in the table, it means the
alarm has been cleared.

Issue: 3 Issue date: October 2020 75/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Depending on alarm monitoring goals, instead of enmsAlarmTable it may be a

better option to poll more specialized alarm tables such as
enmsAlarmsForPortConnTable or enmsAlarmsForSNCTable.

7.2 Alarm Tables

7.2.1 List of all active alarms (enmsAlarmTable)

Table enmsAlarmTable contains all active alarms in TNMS. Its single index
field (enmsAlAlarmNumber) corresponds to the current position of the alarm in
the list and may change between table retrievals. For that reason, this table is
not meant to be accessed randomly via GET operations. Instead, it must 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 (that is, raised by the EMS itself) can be distinguished by
having the NE Id (enmsAlNEId) set to zero.

Attribute name Data type Description

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.

76/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Attribute name Data type Description

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 location of

the originating entity. For
example, for alarms
originating in TPs this field
contains the chain “Module
location / Port location / TP
location”. Only applicable to
alarms originating in modules,
ports or TPs.

enmsAlTrafficDirection TrafficDirection Affected traffic direction.

enmsAlAdditionalInformation DisplayString Optional additional

information.

Issue: 3 Issue date: October 2020 77/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Description

enmsAlNeSystemContainer DisplayString System container name of the

originating NE.

enmsAlNativeLocation DisplayString Optional native object location

in the network element.

enmsAlTrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable to
TL1 originating entities.

Table 54 List of enmsAlarmTable attributes

7.2.2 List of alarms for NEs (enmsAlarmsForNETable)

Table enmsAlarmsForNETable contains all alarms originating in an NE and its

modules, ports and TPs. Its indexes allow retrieving alarms for a selected NE.

Attribute name Data type Description

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 has been
generated by the NE or by
TNMS.

enmsA2TimeStamp EnmsTimeStamp Alarm raising timestamp.

enmsA2EntityString DisplayString Description of the alarm

originating entity.

78/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Attribute name Data type Description

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

originating entity, if
applicable.

enmsA2TPIdL TPId Lower 32 bits of TP Id of

originating entity, if
applicable.

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 reported by the NE
itself.

enmsA2AffectedLocation DisplayString Extended textual location of

the originating entity. For
example, for alarms
originating in TPs this field
contains the chain “Module
location / Port location / TP
location”. Only applicable to
alarms originating in
modules, ports or TPs.

enmsA2TrafficDirection TrafficDirection Affected traffic direction.

enmsA2AdditionalInformation DisplayString Optional additional

information.

enmsA2NeSystemContainer DisplayString System container name of

the originating NE.

enmsA2NativeLocation DisplayString Optional native object

location of the originating
entity in the network element.

enmsA2TrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 55 List of enmsAlarmsForNETable attributes

Issue: 3 Issue date: October 2020 79/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

7.2.3 List of alarms for Ports (enmsAlarmsForPortTable)

Table enmsAlarmsForPortTable contains all alarms originating in a port or a

TP contained in it. Its indexes allow retrieving the alarms for a selected port.

Attribute name Data type Description

enmsA3NEId NEId NE Id of the originating entity

(table index).

enmsA3PortId PortId Port Id of the originating

entity (table index).

enmsA3Severity PerceivedSeverity Severity of the alarm (table

index).

enmsA3AlarmNumber Integer32 Additional table index. Does

not identify the alarm and
may change each time the
table is retrieved.

enmsA3ProbableCause ProbableCause Probable Cause of the alarm.

enmsA3Class AlarmClass Class of the alarm.

enmsA3ServiceAffect Boolean Indicates whether the alarm

is traffic affecting.

enmsA3State AlarmState Indicates whether the alarm

has been acknowledged.

enmsA3TimeStampFromNE Boolean Indicates whether the

timestamp has been
generated by the NE or by
TNMS.

enmsA3TimeStamp EnmsTimeStamp Alarm raising timestamp.

enmsA3EntityString DisplayString Description of the alarm

originating entity.

enmsA3EntityType EntityType Type of alarm originating

entity.

enmsA3TPIdH TPId Higher 32 bits of TP Id of

originating entity, if
applicable.

enmsA3TPIdL TPId Lower 32 bits of TP Id of

originating entity, if
applicable.

enmsA3TPName DisplayString Name of the originating TP, if

applicable.

80/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Attribute name Data type Description

enmsA3ProbableCauseString DisplayString Probable Cause in text form.

enmsA3NELocation DisplayString NE location of originating

entity, as reported by the NE
itself.

enmsA3AffectedLocation DisplayString Extended textual location of

the originating entity. For
alarms originating in ports,
this field contains the chain
“Module location / Port
location”.

enmsA3TrafficDirection TrafficDirection Affected traffic direction.

enmsA3AdditionalInformation DisplayString Optional additional

information.

enmsA3NeSystemContainer DisplayString System container name of

the originating NE.

enmsA3NativeLocation DisplayString Optional native object

location of the originating
entity in the network element.

enmsA3TrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 56 List of enmsAlarmsForPortTable attributes

7.2.4 List of alarms for TP (enmsAlarmsForTPTable)

Table enmsAlarmsForTPTable contains all alarms originating in a TP. Its

indexes allow retrieving the alarms for a selected TP.

Attribute name Data type Description

enmsA4NEId NEId NE Id of the originating entity

(table index).

enmsA4PortId PortId Port Id of the originating

entity (table index).

enmsA4TPIdH TPId Higher 32 bits of TP Id of

originating entity (table
index).

enmsA4TPIdL TPId Lower 32 bits of TP Id of

originating entity (table
index).

Issue: 3 Issue date: October 2020 81/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Description

enmsA4Severity PerceivedSeverity Severity of the alarm (table

index).

enmsA4AlarmNumber Integer32 Additional table index. Does

not identify the alarm and
may change each time the
table is retrieved.

enmsA4ProbableCause ProbableCause Probable Cause of the alarm.

enmsA4Class AlarmClass Class of the alarm.

enmsA4ServiceAffect Boolean Indicates whether the alarm

is traffic affecting.

enmsA4State AlarmState Indicates whether the alarm

has been acknowledged.

enmsA4TimeStampFromNE Boolean Indicates whether the

timestamp has been
generated by the NE or by
TNMS.

enmsA4TimeStamp EnmsTimeStamp Alarm raising timestamp.

enmsA4EntityString DisplayString Description of the alarm

originating entity.

enmsA4EntityType EntityType Type of alarm originating

entity.

enmsA4TPName DisplayString Name of the originating TP, if

applicable.

enmsA4ProbableCauseString DisplayString Probable Cause in text form.

enmsA4NELocation DisplayString NE location of originating

entity, as reported by the NE
itself.

enmsA4AffectedLocation DisplayString Extended textual location of

the originating entity. For
alarms originating in TPs, this
field contains the chain
“Module location / Port
location / TP location”.

enmsA4TrafficDirection TrafficDirection Affected traffic direction.

enmsA4AdditionalInformation DisplayString Optional additional

information.

82/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Attribute name Data type Description

enmsA4NeSystemContainer DisplayString System container name of

the originating NE.

enmsA4NativeLocation DisplayString Optional native object

location of the originating
entity in the network element.

enmsA4TrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 57 List of enmsAlarmsForTPTable attributes

7.2.5 List of alarms for Port Connections

(enmsAlarmsForPortConnTable)

This table contains all alarms affecting port connections. Its indexes allow
retrieving the alarms for a selected port connection.
Alarms for internal port connections are only exposed if internal physical trail
alarm correlation is activated in TNMS System Preferences.

Attribute name Data type Description

enmsA5PortConnId PortConnId Id of the Port Connection

affected by the alarm (table
index).

enmsA5Severity PerceivedSeverity Severity of the alarm (table

index).

enmsA5AlarmNumber Integer32 Additional table index. Does

not identify the alarm and
may change each time the
table is retrieved.

enmsA5ProbableCause ProbableCause Probable Cause of the alarm.

enmsA5Class AlarmClass Class of the alarm.

enmsA5ServiceAffect Boolean Indicates whether the alarm

is traffic affecting.

enmsA5State AlarmState Indicates whether the alarm

has been acknowledged.

enmsA5TimeStampFromNE Boolean Indicates whether the

timestamp has been
generated by the NE or by
TNMS.

enmsA5TimeStamp EnmsTimeStamp Alarm raising timestamp.

Issue: 3 Issue date: October 2020 83/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Description

enmsA5EntityString DisplayString Description of the alarm

originating entity.

enmsA5EntityType EntityType Type of alarm originating

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.

enmsA5ModuleId ModuleId Id of the originating module, if

applicable.

enmsA5ProbableCauseString DisplayString Probable Cause in text form.

enmsA5NELocation DisplayString NE location of originating

entity, as reported by the NE
itself.

enmsA5AffectedLocation DisplayString Extended textual location of

the originating entity. For
example, for alarms
originating in TPs this field
contains the chain “Module
location / Port location / TP
location”. Only applicable to
alarms originating in
modules, ports or TPs.

enmsA5TrafficDirection TrafficDirection Affected traffic direction.

enmsA5AdditionalInformation DisplayString Optional additional

information.

enmsA5NativeLocation DisplayString Optional native object

location of the originating
entity in the network element.

enmsA5TrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 58 List of enmsAlarmsForPortConnTable attributes

84/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

7.2.6 List of alarms for Modules (enmsAlarmsForModuleTable)

This table contains all alarms originating in a module. Its indexes allow
retrieving the alarms for a selected module.

Attribute name Data type Description

enmsA8NEId NEId NEId of the originating entity

(table index).

enmsA8ModuleId ModuleId ModuleId of the originating

entity (table index).

enmsA8Severity PerceivedSeverity Severity of the alarm (table

index).

enmsA8AlarmNumber Integer32 Additional table index. Does

not identify the alarm and
may change each time the
table is retrieved.

enmsA8ProbableCause ProbableCause Probable Cause of the alarm.

enmsA8Class AlarmClass Class of the alarm.

enmsA8ServiceAffect Boolean Indicates whether the alarm

is traffic affecting.

enmsA8State AlarmState Indicates whether the alarm

has been acknowledged.

enmsA8TimeStampFromNE Boolean Indicates whether the

timestamp has been
generated by the NE or by
TNMS.

enmsA8TimeStamp EnmsTimeStamp Alarm raising timestamp.

enmsA8EntityString DisplayString Description of the alarm

originating entity.

enmsA8EntityType EntityType Type of alarm originating

entity.

enmsA8PortId PortId Not applicable. Obsolete.

enmsA8TPIdH TPId Not applicable. Obsolete.

enmsA8TPIdL TPId Not applicable. Obsolete.

enmsA8TPName DisplayString Not applicable. Obsolete.

enmsA8ProbableCauseString DisplayString Probable Cause in text form.

Issue: 3 Issue date: October 2020 85/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Description

enmsA8NELocation DisplayString NE location of originating

entity, as reported by the NE
itself.

enmsA8AffectedLocation DisplayString Extended textual location of

the originating entity. For
modules, this field only
contains the module location.

enmsA8TrafficDirection TrafficDirection Affected traffic direction.

enmsA8AdditionalInformation DisplayString Optional additional

information.

enmsA8NeSystemContainer DisplayString System container name of

the originating NE.

enmsA8NativeLocation DisplayString Optional native object

location of the originating
entity in the network element.

enmsA8TrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 59 List of enmsAlarmsForModuleTable attributes

7.2.7 List of alarms for SNCs (enmsAlarmsForSNCTable)

This table contains all alarms affecting SNCs. Its indexes allow retrieving the
alarms for a selected SNC.
This table only associates the SNCs to alarms directly affecting those SNCs –
it will not associate alarms affecting the server SNCs.

Attribute name Data type Description

enmsA6SNCId SNCId Id of the SNC affected by the

alarm (table index).

enmsA6Severity PerceivedSeverity Severity of the alarm (table

index).

enmsA6AlarmNumber Integer32 Additional table index. Does

not identify the alarm and
may change each time the
table is retrieved.

enmsA6ProbableCause ProbableCause Probable Cause of the alarm.

86/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Attribute name Data type Description

enmsA6Class AlarmClass Class of the alarm.

enmsA6ServiceAffect Boolean Indicates whether the alarm

is traffic affecting.

enmsA6State AlarmState Indicates whether the alarm

has been acknowledged.

enmsA6TimeStampFromNE Boolean Indicates whether the

timestamp has been
generated by the NE or by
TNMS.

enmsA6TimeStamp EnmsTimeStamp Alarm raising timestamp.

enmsA6EntityString DisplayString Description of the alarm

originating entity.

enmsA6EntityType EntityType Type of alarm originating

entity.

enmsA6NEId NEId NE Id of the originating entity.

enmsA6PortId PortId Port Id of the originating

entity.

enmsA6TPIdH TPId Not applicable. Obsolete.

enmsA6TPIdL TPId Not applicable. Obsolete.

enmsA6TPName DisplayString Not applicable. Obsolete.

enmsA6ModuleId ModuleId Id of the originating module, if

applicable.

enmsA6ProbableCauseString DisplayString Probable Cause in text form.

enmsA6NELocation DisplayString NE location of originating

entity, as reported by the NE
itself.

enmsA6AffectedLocation DisplayString Extended textual description

of the alarm originating entity.

enmsA6TrafficDirection TrafficDirection Affected traffic direction.

enmsA6AdditionalInformation DisplayString Optional additional

information.

enmsA6NativeLocation DisplayString Optional native object

location of the originating
entity in the network element.

Issue: 3 Issue date: October 2020 87/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Description

enmsA9TrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 60 List of enmsAlarmsForSNCTable attributes

7.2.8 List of EMS alarms (enmsAlarmsForEMSTable)

Table enmsAlarmsForEMSTable contains all alarms affecting TNMS itself,

that is, not originated in the NEs. Its single index field
(enmsA10AlarmNumber) corresponds to the current position of the alarm in
the list and may change between table retrievals.

Attribute name Data type Description

enmsA10AlarmNumber Integer32 Table index. Does not identify

the alarm and may change
each time the table is
retrieved.

enmsA10Severity PerceivedSeverity Severity of the alarm.

enmsA10ProbableCause ProbableCause Probable Cause of the alarm.

enmsA10Class AlarmClass Class of the alarm.

enmsA10State AlarmState Indicates whether the alarm

has been acknowledged.

enmsA10TimeStamp EnmsTimeStamp Alarm raising timestamp.

enmsA10EntityString DisplayString Description of the alarm

originating entity.

enmsA10EntityType EntityType Type of alarm originating

entity.

enmsA10ProbableCauseString DisplayString Probable Cause in text form.

enmsA10AdditionalInformation DisplayString Optional additional

information.

Table 61 List of enmsAlarmForEMSTable attributes

88/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

7.3 Alarm Notifications

7.3.1 Notification of NE alarm (enmsNEAlarmTrap)

Notification sent when an NE alarm is raised or cleared, or when the alarm is

acknowledged or unacknowledged.
Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for

synchronization.

enmsNeNEId NEId Global NE identifier.

enmsTrapEventDetails DisplayString Empty.

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 Empty.

enmsTrapEventTrafficDirection TrafficDirection Affected traffic direction.

enmsAlServiceAffect Boolean Indicates whether the alarm

is traffic affecting.

Issue: 3 Issue date: October 2020 89/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

enmsAlAdditionalInformation DisplayString Optional additional

information.

enmsAlNeSystemContainer DisplayString System container name of

the originating NE.

enmsAlNativeLocation DisplayString Optional native object

location of the originating
entity in the network
element.

enmsAlTrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 62 List of enmsNEAlarmTrap attributes

7.3.2 Notification of Module alarm (enmsModuleAlarmTrap)

Notification sent when a module alarm is raised or cleared, or when the alarm
is acknowledged or unacknowledged.
Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for

synchronization.

enmsMoNEId NEId Global NE identifier.

enmsMoModuleId ModuleId Module identifier.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Severity of the alarm, or

‘cleared’ if alarm is cleared.

enmsTrapEventProbableCause ProbableCause Probable Cause of the

alarm.

enmsAlClass AlarmClass Class of the alarm.

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.

90/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Variable name Data type Description

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 the DCN
properties.

enmsTrapAffectedLocation DisplayString Extended textual location of

the originating entity in the
format. For module alarms
it only contains the module
location.

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.

enmsAlNativeLocation DisplayString Optional native object

location of the originating
entity in the network
element.

enmsAlTrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 63 List of enmsModuleAlarmTrap attributes

7.3.3 Notification of Port alarm (enmsPortAlarmTrap)

Notification sent when a port alarm is raised or cleared, or when the alarm is
acknowledged or unacknowledged.
Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for

synchronization.

enmsPtNEId NEId Global NE identifier.

enmsPtPortId PortId Port identifier.

Issue: 3 Issue date: October 2020 91/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Severity of the alarm, or

‘cleared’ if alarm is cleared.

enmsTrapEventProbableCause ProbableCause Probable Cause of the

alarm.

enmsAlClass AlarmClass (to be supported)

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 location of

the originating entity. For
port alarms it contains the
chain “Module location /
Port location”.

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.

enmsAlNativeLocation DisplayString Optional native object

location of the originating
entity in the network
element.

enmsAlTrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

92/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Table 64 List of enmsPortAlarmTrap attributes

7.3.4 Notification of TP alarm (enmsTPAlarmTrap)

Notification sent when a TP alarm is raised or cleared, or when the alarm is

acknowledged or unacknowledged.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for

synchronization.

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.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Severity of the alarm, or

‘cleared’ if alarm is cleared.

enmsTrapEventProbableCause ProbableCause Probable Cause of the alarm.

enmsAlClass AlarmClass (to be supported)

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 location of

the originating entity. For TP
alarms this field contains the
chain “Module location / Port
location / TP location”.

Issue: 3 Issue date: October 2020 93/139

Retrieving and Receiving Alarms TNMS 18.10 – SNMP NBI Operation Guide

Variable name Data type Description

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.

enmsAlNativeLocation DisplayString Optional native object

location of the originating
entity in the network element.

enmsAlTrafficDirectionTelcordia TrafficDirectionTelcordia Affected traffic direction

(Telcordia). Only applicable
to TL1 originating entities.

Table 65 List of enmsTPAlarmTrap attributes

7.3.5 Notification of EMS alarm (enmsEMSAlarmTrap)

Notification sent when an EMS alarm is raised or cleared, or when the alarm is
acknowledged or unacknowledged.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for

synchronization.

enmsTrapEventDetails DisplayString Empty.

enmsTrapEventSeverity PerceivedSeverity Severity of the alarm.

enmsTrapEventProbableCause ProbableCause Probable Cause of the

alarm.

enmsAlClass AlarmClass (to be supported)

enmsAlState AlarmState Indicates whether the alarm

has been acknowledged.

enmsAlTimeStamp EnmsTimeStamp Alarm raising timestamp.

enmsAlEntityString DisplayString Description of the alarm

originating entity.

enmsTrapEventProbableCauseString DisplayString Probable Cause of the

alarm in string format.

94/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Retrieving and Receiving Alarms

Variable name Data type Description

enmsAlAdditionalInformation DisplayString Optional additional

information.

Table 66 List of enmsEMSAlarmTrap attributes

7.3.6 Notifications on alarm acknowledgement

By default, when an alarm is acknowledged or unacknowledged, TRNBI

resends a notification for that alarm but with updated enmsAlState value.
It is possible to disable notifications on alarm acknowledgment by editing the
SNMP NBI properties file, which can be found in the following location on the
server installation:
<Product_Installation_Folder>
/server/bicnet/deployments/bicnet.ear/conf/snmpNbi.properties

To disable the acknowledge/unacknowledged notifications, add or change the

property below and set its value to 0:
resendAlarmOnAcknowledge=0

Set the value to 1 to re-enable the notifications:

resendAlarmOnAcknowledge=1

Restart server for changes to take effect.

Issue: 3 Issue date: October 2020 95/139

Reading and Setting Agent Parameters via SNMP TNMS 18.10 – SNMP NBI Operation Guide

8 Reading and Setting Agent Parameters

via SNMP

8.1 Agent Parameters (EnmsControl)

The enmsControl branch contains several variables with information about the
SNMP NBI component itself.

Attribute name Data type R/W Description

enmsProxyName DisplayString R/W Proxy name, as defined in the

SNMP NBI preferences (see
3.1).

enmsProxyOpState OperationalState R Operational state. Always

‘enabled’, otherwise not
possible to retrieve the value.

enmsNetworkName DisplayString R/W Network name, as defined in

the SNMP NBI preferences
(see 3.1).

enmsTrapHistoryTableLength Integer32 R/W Maximum length of the trap

history table (see 4.4).

enmsTrapCounter Counter32 R Trap counter of the last trap

sent. Resets to zero when
TNMS is restarted. See also
4.4.

enmsProxyPSTAMP DisplayString R Production stamp of the SNMP

NBI component.

enmsEnterpriseId OID R OID of the enterprise node of

the SNMP NBI.

enmsMIBVersion DisplayString R Version of the SNMP NBI MIB.

Matches the LAST-UPDATE
clause in the MIB definition file.

enmsEMSVersion DisplayString R Version of the TNMS

installation.

enmsTimeStampFormat DisplayString R Format of the timestamp

values.
Currently returns always “yyyy-
MM-dd HH:mm:ss”.

96/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Reading and Setting Agent Parameters via SNMP

Attribute name Data type R/W Description

enmsInformTimeout Integer32 R/W Maximum number of seconds

that SNMP NBI will wait for an
Inform response before
retrying. Allowed values are
between 1 and 60 seconds.

enmsInformMaxTries Integer32 R/W 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 R/W Indicates whether heartbeat

notifications are enabled. Valid
values: ‘enabled’ or ‘disabled’.

enmsHeatbeatInterval Integer32 R/W Heartbeat interval in seconds.

Allowed values are between 5
and 86400 seconds.

Table 67 List of enmsControl variables

8.2 SNMP Agent Notifications

8.2.1 Notification of agent state change (enmsProxyStateChangeTrap)

Notification sent when the operational state of the SNMP NBI agent changes.

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

enmsProxyName DisplayString Agent name, as specified in the

properties.

enmsTrapEventDetails DisplayString Empty.

enmsProxyOpState OperationalState Agent operational state.

Table 68 List of enmsProxyStateChangeTrap attributes

8.3 Notification Filtering (enmsTrapFilter)

The enmsTrapFilter branch contains variables that reflect the state of the
notification filters of the SNMP user accessing them (see 3.2.5). These

Issue: 3 Issue date: October 2020 97/139

Reading and Setting Agent Parameters via SNMP TNMS 18.10 – SNMP NBI Operation Guide

variables are writable – the SNMP manager is able to activate and deactivate
notifications for the SNMP user via SET operations.

Variable name Data type Description

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

(except alarms) are enabled.

enmsTPTrapFilter TrapFilter Indicates whether TP notifications

(except alarms) are enabled.

enmsPortConnTrapFilter TrapFilter Indicates whether Port Connection

notifications (except alarms) are
enabled.

enmsSNCTrapFilter TrapFilter Indicates whether SNC notifications

are enabled.

enmsServiceTrapFilter TrapFilter Indicates whether Service

notifications are enabled.

enmsNEAlarmTrapFilter TrapFilter Indicates whether NE alarm

notifications are enabled.

enmsModuleAlarmTrapFilter TrapFilter Indicates whether Module alarm

notifications are enabled.

enmsPortAlarmTrapFilter TrapFilter Indicates whether Port alarm

notifications are enabled.

enmsTPAlarmTrapFilter TrapFilter Indicates whether TP alarm

notifications are enabled.

enmsEMSAlarmTrapFilter TrapFilter Indicates whether EMS alarm

notifications are enabled.

enmsMonitorTrapFilter TrapFilter Indicates whether monitor event

notifications are enabled.

enmsEthernetPathTrapFilter TrapFilter Indicates whether Ethernet Path

notifications are enabled.

enmsPerfMonTrapFilter TrapFilter Indicates whether Performance

Monitoring notifications are enabled.

98/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Reading and Setting Agent Parameters via SNMP

Variable name Data type Description

enmsOptPowerMonTrapFilter TrapFilter Indicates whether Optical Power

Monitoring notifications are enabled.

Table 69 List of enmsTrapFilter variables

8.4 Notification History (enmsTrapHistoryTable)

Table enmsTrapHistoryTable contains information about the last notifications
sent by SNMP NBI. It is mainly used for data resynchronization in case of
missing notifications caused by network errors (see 4.4).

Attribute name Data type Description

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 to the

trap (NEId / PortConnId / SNCId /
EthernetPathId).

enmsHiTrapSecondId UniqueId Second ID of the entity associated to

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 70 List of enmsTrapHistoryTable attributes

Issue: 3 Issue date: October 2020 99/139

Ethernet Paths – Support of MEF 40 TNMS 18.10 – SNMP NBI Operation Guide

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). Only basic Ethernet Path retrieval is supported.
To monitor changes to Ethernet Paths, use SNMP NBI MIB notifications (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 (to be

supported)

mefServiceEvcCfgCevlanIdPreservation MefServicePreservationType

mefServiceEvcCfgCevlanCosPreservation MefServicePreservationType

mefServiceEvcCfgUnicastDelivery MefServiceDeliveryType (to be

supported)

mefServiceEvcCfgMulticastDelivery MefServiceDeliveryType (to be

supported)

mefServiceEvcCfgBroadcastDelivery MefServiceDeliveryType (to be

supported)

mefServiceEvcCfgL2cpGrpIndex Unsigned32 (to be

supported)

mefServiceEvcCfgAdminState EntityAdminState

100/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Ethernet Paths – Support of MEF 40

Attribute name Data type Notes

mefServiceEvcCfgRowStatus RowStatus Not used (table

is read-only)

Table 71 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 (to be

supported)

mefServiceEvcStatusMaxNumUni Unsigned32 (to be

supported)

mefServiceEvcStatusOperationalState INTEGER

Table 72 mefServiceEvcStatusTable attributes

Issue: 3 Issue date: October 2020 101/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

10 Performance Monitoring
SNMP NBI allows managers to retrieve Performance Monitoring (PM) data
associated to the network objects managed by TNMS:
• History data
• Current data
• PMP and threshold information
Retrieving history PM data via SNMP NBI requires PM data upload to be
enabled in TNMS Server. 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. To retrieve PM data, the SNMP manager creates a request by
inserting a row in the PM request table. Each request specifies the type of
data to retrieve 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 Figure 11, the
manager creates a request and waits for a notification indicating that the PM
data is ready for retrieval:

Figure 11 Example of PM data retrieval using notifications

Alternatively, the manager may poll the state of the request (instead of waiting
for a notification):

102/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Performance Monitoring

Figure 12 Example of PM data retrieval using polling

10.1 PM Requests
PM requests are entries of the MIB table enmsPerfMonRequestTable.
Each PM request specifies the type of data to retrieve and for which network
objects.

10.1.1 PM request table (enmsPerfMonRequestTable)

This table contains all PM requests created by the SNMP manager.

Attribute name Data type Settable? Description

enmsPmRequestId PerfMonRequestId No Id of the request (table index).

enmsPmRequestName DisplayString Yes Optional request name, for manager

reference.

Default is empty.

enmsPmRequestRowStatus RowStatus Yes Standard SNMP RowStatus field for

(see descr.) controlling row creation.

Set to createAndGo (4) to create a new

row, or destroy (6) to remove an existing
row. Other values are not supported.

enmsPmRequestState PerfMonRequestState Yes State of the PM request. Set this field to

(see descr.) 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.

Issue: 3 Issue date: October 2020 103/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Settable? Description

enmsPmRequestType PerfMonType Yes Type of PM data to retrieve:

- pmHistory (1) – retrieve history data

- pmCurrent (2) – retrieve current data
- pmPoints (3) – retrieve PM point info
and associated thresholds.

Default is pmCurrent.

enmsPmRequestStartTime EnmsTimeStamp Yes For history PM data, start time (in UTC) of
the collection period.

Default is empty.

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

Default is empty.

enmsPmRequestGranularity PerfMonGranularity Yes Granularity of PM data:

- minutes15 (1)
- hours24 (2)

Default is minutes15.

enmsPmRequestFilterType FilterType Yes Type of object for which to retrieve PM

data:

- tpObject (1)
- portObject (2)
- neObject (3)
- sncObject (4)
- ethernetPathObject (5)
- moduleObject(6)
- equipHolderObject(7)

(!) Filtering by NE object is unsupported

for request type pmCurrent.

Default is sncObject.

104/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Performance Monitoring

Attribute name Data type Settable? Description

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 “|” (pipe character).
Examples:

TP (enmsTPTable):
173|455|3453|99589454

Port (enmsPortTable):
32|6734

NE (enmsNETable) - history only

85

SNC (enmsSNCTable):
8374

Ethernet Path (enmsSNCTable):

2387

Module (enmsModuleTable):
32|9334

Port (enmsEquipHolderTable):
32|277

Specify multiple objects by separating their

identifiers with commas. Example for port
objects:
32|6734,55|33928

Default is 0.

Table 73 List of enmsPerfMonRequestTable attributes

10.2 Creating a PM Request

Creating a PM request (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. 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 below.

Error cause SNMP error

- The provided instance identifier is already in use. inconsistentValue

Issue: 3 Issue date: October 2020 105/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

Error cause SNMP error

- Attribute enmsPmRequestRowStatus set to notReady, commitFailed

active, notInService or destroy.
- An attribute has been assigned a value inconsistent with
other attributes. Examples:
o The request type was set to history, but the
start/end times are empty;
o The filter type was set to port, but the filter
value contains a TP identifier.

- Attribute enmsPmRequestRowStatus not set. inconsistentName

commitFailed

- Attribute enmsPmRequestRowStatus set to createAndWait. wrongValue

- Wrong type or invalid value assigned to an attribute. badValue
commitFailed

- Values assigned to non-settable attributes. notWritable

commitFailed

- Maximum number of requests exceeded. resourceUnavailable

commitFailed

Table 74 Possible errors during PM request creation.

For new requests, enmsPmRequestRowStatus is set to active, and

enmsPmRequestState to created. The enmsPmRequestId index field is set to
the supplied instance identifier. Other fields left unset are assigned default
values.
Figure 13 exemplifies the creation of a new PM request:

Figure 13 Example of interaction to create PM request

106/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Performance Monitoring

After the interaction above, enmsPerfMonRequestTable will contain a new

entry for instance 25:

Row Last Type Start End Filter Filter

Id Name State Info Granul.
Status Update Time Time Type Value

11 Access active finished 2016-03-20 Execution finished. pmCurrent minutes15 Port 123|98
ports 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 75 Example of enmsPerfMonRequestTable after adding a request

New requests are in the state created, meaning that the request exists but is
not in execution.
Maximum number of PM requests is 5000. After this limit is reached, the
manager must delete existing PM requests before adding new ones.
Alternatively, the manager may reuse existing PM requests by updating its
fields.

10.3 PM Request States

Table 76 lists the possible states of a PM request (reflected in the
enmsPmRequestState attribute) and the actions the manager may perform for
each state.
enmsPmRequestState Description Possible actions

created Request is idle. This is the initial state of a - Execute the request
newly 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
- Re-execute the request

Table 76 States of a PM request and possible actions

Issue: 3 Issue date: October 2020 107/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

The manager performs actions on a request by setting the

enmsPmRequestState attribute using the SNMP SET operation (see section
10.5).
Figure 14 summarizes the main transitions between request states.

Figure 14 PM request states and main transitions

10.4 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:

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

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 77 List of enmsPerfMonRequestStateChangeTrap attributes

108/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Performance Monitoring

10.5 Actions on PM Requests

Actions on PM requests are performed by issuing SNMP SET commands to
change the PM request state and other attributes.

10.5.1 Executing a PM request

To execute a PM request, the manager sends an SNMP SET command to set

enmsPmRequestState to started. The state will first change to pending (the
request has been queued for execution). When 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 15 Example of interaction for executing a PM request

The manager can also update the PM request attributes (see 10.5.2) and
execute it in a single SET command:

Figure 16 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 retrieve the PM data (see section 10.6). If the request execution
fails, the state will change to failed. The enmsPmRequestInfo field provides 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.

Issue: 3 Issue date: October 2020 109/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

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.5.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 sends an SNMP SET.
Multiple attributes can be set in a single SET command.

Figure 17 Example of interaction for updating a PM request

When assigning an invalid value to some attribute, the SET command fails
with the error code inconsistentValue.
Updating a PM request moves it to state created, and any associated PM data
is 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.5.1).
Updating a PM request is only possible if the request is in an idle state (either
created, finished, failed or cancelled).
Updating a PM request in state finished causes associated PM data to be
discarded.

10.5.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. The state changes to
cancelling, and then to cancelled.

110/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Performance Monitoring

Figure 18 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.5.4 Discarding PM data associated to a PM request

After a PM request is successfully executed, resulting PM data is preserved

until the request is re-executed or deleted.
To keep the request for future re-execution, the manager 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 19 Example of interaction for discarding PM data of a PM request

10.5.5 Deleting a PM request

To delete a PM request, the manager sends an SNMP SET command to set

enmsPmRequestRowStatus to destroy.

Figure 20 Example of interaction for deleting a PM request

Issue: 3 Issue date: October 2020 111/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

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

created, finished, failed or cancelled).
Deleting a PM request also deletes associated PM data.

10.5.6 Error exceptions

Table 78 describes common errors returned by SNMP NBI while performing

SNMP SET operations on existing PM requests:

Error cause SNMP error

- Attribute enmsPmRequestState set an invalid value given the inconsistentValue

current request state (see 10.3).
commitFailed
- An attribute was assigned an inconsistent value. Examples:
o The request type was set to history, but the start/end
times are empty;
o The filter type was set to port, but the filter value
contains a TP identifier.

- Attribute enmsPmRequestRowStatus set to other value than wrongValue

destroy.
badValue
- Wrong type or invalid value assigned to an attribute.
commitFailed

- Values assigned to non-settable attributes. notWritable

commitFailed

Table 78 Common errors while performing actions on PM requests

10.6 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.6.2).
▪ enmsPerfMonResultValueTable: For requests of type pmHistory and
pmCurrent, contains the measured values for each PM Point (see
10.6.3).
▪ enmsPerfMonResultThresholdTable: For requests of type pmPoints,
contains the threshold values for each PM Point (see 10.6.4).
These tables contain the PM data results for all finished requests. To retrieve
data for a specific PM request, follow the method suggested in Section 4.5.3
(all tables above are indexed by PM request identifier).

112/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Performance Monitoring

Because of the potentially large volume of data, request only the strictly
needed attributes to speed-up the retrieval operation.

10.6.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
▪ PM points: 1 hour

Results older than the intervals above are periodically discarded and the
associated 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.5.4).

10.6.2 enmsPerfMonResultPmpTable

Table 79 contains the PM Points of all finished PM request results.

Attribute name Data type Description

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.

Issue: 3 Issue date: October 2020 113/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Description

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, or zero

if not supported by the NE.

enmsPmResultPmpNumValues Unsigned32 Number of values collected

for this PMP.

enmsPmResultPmpRelatedPaths DisplayString Names of the paths related

to this PMP (comma-
separated list, truncated to
field size limits). Only
applicable to history data,
empty for other types of
request. Requires
correlation of PM data to
paths to be enabled in the
server.

enmsPmResultPmpRelatedServices DisplayString Names of the services with

paths related to this PMP
(comma-separated list, ,
truncated to field size limits).
Only applicable to history
data, empty for other types
of request. Requires
correlation of PM data to
paths to be enabled in the
server.

enmsPmResultPmpRelatedSubscribers DisplayString Names of the subscribers

related to this PMP (comma-
separated list, truncated to
field size limits). Only
applicable to history data,
empty for other types of
request. Requires
correlation of PM data to
paths to be enabled in the
server.

enmsPmResultPmpNativeLocation DisplayString (to be supported)

Optional native object
location of the PMP in the
network element.

Table 79 List of enmsPerfMonResultPmpTable attributes

114/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Performance Monitoring

10.6.3 enmsPerfMonResultValueTable

Table 80 contains the measured values for the PM Points of all finished PM
request results, for requests of type pmHistory or pmCurrent.

Attribute name Data type Description

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 Parameter name.

enmsPmResultValValue DisplayString Parameter value.

enmsPmResultValUnit DisplayString Parameter unit.

enmsPmResultValStatus PerfMonStatus Status of the collected value.

Table 80 List of enmsPerfMonResultValueTable attributes

10.6.4 enmsPerfMonResultThresholdTable

Table 81 contains the threshold values for the PM Points of all finished PM
request results, for requests of type pmPoints only.

Attribute name Data type Description

enmsPmResultThresholdReqId PerfMonRequestId PM request identifier

(table index).

enmsPmResultThresholdPmpNumber Unsigned32 Number of the PMP in

the result set (table
index).

enmsPmResultThresholdNumber Unsigned32 Number of value in the

collected values for the
PMP. (table index)

enmsPmResultThresholdParam DisplayString Parameter name.

enmsPmResultThresholdType PerfMonThresholdType Threshold type.

enmsPmResultThresholdTriggerFlag Boolean Indicates if the threshold

is for the trigger (true) or
the clear (false).

Issue: 3 Issue date: October 2020 115/139

Performance Monitoring TNMS 18.10 – SNMP NBI Operation Guide

Attribute name Data type Description

Only valid if the NE

supports separate values
for trigger and clear.

enmsPmResultThresholdValue DisplayString Threshold value.

enmsPmResultThresholdUnit DisplayString Threshold unit.

Table 81 List of enmsPerfMonResultThresholdTable attributes

116/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Optical Power Monitoring

11 Optical Power Monitoring

SNMP NBI allows managers to retrieve Optical Power Monitoring (OPM) data
associated to network objects managed by TNMS.
Given its nature, OPM data is not readily available in an MIB table. To retrieve
OPM data, the SNMP manager needs 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 Figure 21, the
manager creates a request and waits for a notification indicating that the OPM
data is ready for retrieval:

Figure 21 Example of OPM data retrieval using notifications

Alternatively, the manager may poll the state of the request instead of waiting
for a notification:

Figure 22 Example of OPM data retrieval using polling

Issue: 3 Issue date: October 2020 117/139

Optical Power Monitoring TNMS 18.10 – SNMP NBI Operation Guide

11.1 OPM Requests

OPM requests are entries of the MIB table enmsOptPowerMonRequestTable.
Each OPM request specifies the network objects data to retrieve data for.

11.1.1 OPM request table (enmsOptPowerMonRequestTable)

Table 82 contains all OPM requests created by the SNMP manager.

Attribute name Data type Settable? Description

enmsOpmRequestId OptPowerMonRequestId No Id of the request (table index).

enmsOpmRequestName DisplayString Yes Optional request name, for

manager reference.

Default is empty.

enmsOpmRequestRowStatus RowStatus Yes Standard SNMP RowStatus field

(see for controlling row creation.
description)
Set to createAndGo (4) to create a
new row, or destroy (6) 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):

- tpObject (1)
- portObject (2)
- sncObject (4)

(!) Filtering by other types of object

is unsupported.

Default is sncObject.

118/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Optical Power Monitoring

Attribute name Data type Settable? Description

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

Specify multiple objects by

separating their identifiers with
commas. Example for port objects:
32|6734,55|33928

Default is 0.

Table 82 List of enmsOptPowerMonRequestTable attributes

11.2 Creating an OPM Request

Creating an OPM request (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. The
manager must perform the following steps:
1) 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).
2) Using the new instance identifier, send an SNMP SET command to set
enmsOpmRequestRowStatus to createAndGo and optionally assign
values to other attributes.
A new entry is added to enmsOptPowerMonRequestTable. 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, commitFailed
active, notInService or destroy.
- An attribute was assigned an inconsistent value. For
example, the filter type is port, but the filter value contains a
TP identifier.

- Attribute enmsPmRequestRowStatus not set. inconsistentName

commitFailed

Issue: 3 Issue date: October 2020 119/139

Optical Power Monitoring TNMS 18.10 – SNMP NBI Operation Guide

Error cause SNMP error

- Attribute enmsOpmRequestRowStatus set to wrongValue

createAndWait.
badValue
- Wrong type or invalid value assigned to an attribute.
commitFailed

- Values assigned to non-settable attributes. notWritable

commitFailed

- Maximum number of requests exceeded. resourceUnavailable

commitFailed

Table 83 Possible errors during OPM request creation.

New requests have enmsOpmRequestRowStatus set to active, and

enmsOpmRequestState set to created. The enmsOpmRequestId index field is
set to the supplied instance identifier. Other fields left unset will be assigned
default values.
Figure 23 exemplifies the creation of a new OPM request:

Figure 23 Example of interaction to create OPM request

After this interaction, enmsOptPowerMonRequestTable contain a new entry

for instance 25:

Row Last Filter Filter

Id Name State Info
Status Update Type Value

11 Access Port 1 active finished 2016-03-20 Execution finished. Port 123|98

14:01:12

19 Middle node active started 2016-03-20 Execution started. SNC 320

14:01:12

25 Client link active created 2016-03-22 Request created. SNC 0

14:55:35

Table 84 Example of enmsOptPowerMonRequestTable after adding a request

120/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Optical Power Monitoring

Created requests are in the state created, meaning the request exists but is
not in execution.
Maximum number of OPM requests is 5000. After this limit is reached, the
manager must delete existing OPM requests before adding new ones.
Alternatively, the manager may reuse existing PM requests by updating its
fields.

11.3 OPM Request States

Table 85 lists the possible states of an OPM request (reflected in the
enmsOpmRequestState attribute) and the actions the manager may perform
for each state.
enmsOpmRequestState Meaning Possible actions

created Request is idle. This is the initial state of - Execute the request
a newly 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

- Re-execute the request

cancelling Request is being cancelled. - None

cancelled Request has been cancelled and is idle. - Update the request
- Re-execute the request

Table 85 States of an OPM request and possible manager actions

The manager performs actions on PM requests by setting the

enmsOpmRequestState attribute using the SNMP SET command (see section
11.5).
Figure 24 summarizes the main transitions between request states.

Issue: 3 Issue date: October 2020 121/139

Optical Power Monitoring TNMS 18.10 – SNMP NBI Operation Guide

Figure 24 OPM request states and main transitions

11.4 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:

Variable name Data type Description

enmsTrapCounter Counter32 Trap counter for synchronization.

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 86 List of enmsOptPowerMonRequestStateChangeTrap attributes

122/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Optical Power Monitoring

11.5 Actions on OPM Requests

Actions on OPM requests are performed by issuing SNMP SET commands to
change the request state and other attributes.

11.5.1 Executing an OPM request

To execute an OPM request, the manager sends an SNMP SET command to

set enmsOpmRequestState to started. The state will first change to pending,
meaning that the request has been queued for execution. When the execution
starts, it changes to started.
Executing an OPM request is only possible if the request is in an idle state
(either created, finished, failed or cancelled).

Figure 25 Example of interaction for executing an OPM request

The manager can also update the OPM request attributes (see 11.5.2) and
execute it in a single SET command:

Figure 26 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 retrieve the OPM data (see section 11.6). If the request
execution fails, the state changes to failed. The enmsOpmRequestInfo field
normally provides 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.

Issue: 3 Issue date: October 2020 123/139

Optical Power Monitoring TNMS 18.10 – SNMP NBI Operation Guide

▪ 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.5.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. Multiple attributes can be set in a single SET command.

Figure 27 Example of interaction for updating an OPM request

When trying to assign an invalid value to some attribute, the SET command
fails with the error code inconsistentValue.
Updating an OPM request moves it to state created. Any associated OPM
data is 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.5.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.5.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 changes to cancelling, and then to cancelled.

124/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Optical Power Monitoring

Figure 28 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.5.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.
To keep the request for future re-execution, the manager 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 29 Example of interaction for discarding OPM data of an OPM request

11.5.5 Deleting an OPM request

To delete an OPM request, the manager sends an SNMP SET command to

set enmsOpmRequestRowStatus to destroy.

Figure 30 Example of interaction for deleting an OPM request

Issue: 3 Issue date: October 2020 125/139

Optical Power Monitoring TNMS 18.10 – SNMP NBI Operation Guide

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

created, finished, failed or cancelled).
Deleting an OPM request also deletes associated OPM data.

11.5.6 Error exceptions

Table 87 describes the most common errors returned by SNMP NBI while
performing SNMP SET commands on existing OPM requests.

Error cause SNMP error

- Attribute enmsOpmRequestState set to a value not allowed inconsistentValue

given the current request state (see 11.3).
commitFailed
- An attribute was assigned an inconsistent value. For example,
the filter type was set port, but the filter value contains a TP
identifier.

- Attribute enmsOpmRequestRowStatus set to other value than wrongValue

destroy.
badValue
- Wrong type or invalid value assigned to an attribute.
commitFailed

- Values assigned to non-settable attributes. notWritable

commitFailed

Table 87 Common errors while performing actions on OPM requests

11.6 Retrieving OPM Data

When the execution of an OPM request finishes successfully, the OPM
request state changes to finished. The manager may now retrieve associated
OPM data by accessing the enmsOptPowerMonResultValueTable (see
11.6.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 (both tables are indexed by OPM request
identifier).
Because of the potentially large volume of data, the manager should only
request the strictly needed attributes to speed-up the retrieval operation.

126/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Optical Power Monitoring

11.6.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 associated 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.5.4).

11.6.2 enmsOptPowerMonResultTable

Table 88 contains the OPM Points of all finished OPM request results.

Attribute name Data type Description

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 88 List of enmsOptPowerMonResultPmpTable attributes

Issue: 3 Issue date: October 2020 127/139

Net-SNMP Examples for PM Data Retrieval TNMS 18.10 – SNMP NBI Operation Guide

12 Net-SNMP Examples for PM Data

Retrieval
Net-SNMP (http://www.net-snmp.org) is a set of command-line tools widely used to interact
with SNMP agents. This chapter provides examples on how to use Net-SNMP to request PM
data via TNMS SNMP NBI.
The workflow for retrieving PM data is described in Chapter 10 – read it first.
For simplicity, the NET-SNMP examples in this document omit common arguments for
specifying the MIB, credentials and output formatting options. A full complete command may
look like the following:

snmptable -m TNMS-NBI-MIB –M C:/Home/MIB -v 2c -c public tnmsserver enmsPerfMonRequestTable

Common arguments

Please see Net-SNMP documentation for details.

128/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Net-SNMP Examples for PM Data Retrieval

12.1 Creating a New PM Request

Get a unique index for the new PM request by reading enmsPmRequestNextId, which auto-
increments each time it is accessed.
You may use any other index generation method instead of enmsPmRequestNextId – just
make sure the chosen index is not in use in enmsPerfMonRequestTable.

snmpget enmsPmRequestNextId.0

TNMS-NBI-MIB::enmsPmRequestNextId.0 = Gauge32: 4

Use the selected index (4 in this example) to create a new PM request. RowStatus must be
set to createAndGo(4):

snmpset enmsPmRequestRowStatus.4 i createAndGo

enmsPmRequestName.4 s "Demo request"
enmsPmRequestType.4 i pmHistory
enmsPmRequestStartTime.4 s "2017-03-07 12:00:00"
enmsPmRequestEndTime.4 s "2017-03-07 17:00:00"
enmsPmRequestGranularity.4 i minutes15
enmsPmRequestFilterType.4 i ethernetPathObject
enmsPmRequestFilterValue.4 s "32"

TNMS-NBI-MIB::enmsPmRequestRowStatus.4 = INTEGER: createAndGo(4)

TNMS-NBI-MIB::enmsPmRequestName.4 = STRING: Demo request
TNMS-NBI-MIB::enmsPmRequestType.4 = INTEGER: pmHistory(1)
TNMS-NBI-MIB::enmsPmRequestStartTime.4 = STRING: "2017-03-07 12:00:00"
TNMS-NBI-MIB::enmsPmRequestEndTime.4 = STRING: "2017-03-07 17:00:00"
TNMS-NBI-MIB::enmsPmRequestGranularity.4 = INTEGER: minutes15(1)
TNMS-NBI-MIB::enmsPmRequestFilterType.4 = INTEGER: ethernetPathObject(5)
TNMS-NBI-MIB::enmsPmRequestFilterValue.4 = STRING: 32

Listing all PM requests to confirm new row:

snmptable enmsPerfMonRequestTable

SNMP table: TNMS-NBI-MIB::enmsPerfMonRequestTable

index Name RowStatus LastUpdate Info State Type StartTime

1 ethernetCarrier 1 "2017-03-03 19:47:00" Request reinitialized. 1 2 ""
2 mpls_7090 1 "2017-03-07 08:36:43" Request reinitialized. 1 1 "2017-03-06 20:00:00" "2
3 1 "2017-03-07 16:04:22" Execution finished. Total values: 84. 4 1 "2017-03-07 13:43:31" "2
4 Demo request 1 "2017-03-07 16:35:18" Request created. 1 1 "2017-03-07 12:00:00" "2

Issue: 3 Issue date: October 2020 129/139

Net-SNMP Examples for PM Data Retrieval TNMS 18.10 – SNMP NBI Operation Guide

12.2 Executing the PM Request

Execute the request by setting enmsPmRequestState to started:

snmpset enmsPmRequestState.4 i started

TNMS-NBI-MIB::enmsPmRequestState.4 = INTEGER: started(3)

To check the execution state, read enmsPmRequestState and optionally

enmsPmRequestInfo. In this example the execution is still pending:

snmpget enmsPmRequestState.4 enmsPmRequestInfo.4

TNMS-NBI-MIB::enmsPmRequestState.4 = INTEGER: pending(2)

TNMS-NBI-MIB::enmsPmRequestInfo.4 = STRING: "Request queued for execution."

When the request execution finishes, the resulting data is ready for retrieval:

snmpget enmsPmRequestState.4 enmsPmRequestInfo.4

TNMS-NBI-MIB::enmsPmRequestState.4 = INTEGER: finished(4)

TNMS-NBI-MIB::enmsPmRequestInfo.4 = STRING: " Execution finished. Total values: 156."

An existing PM request may be updated and re-executed any number of times, by setting
enmsPmRequestState to started (see section 13212.4).

130/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Net-SNMP Examples for PM Data Retrieval

12.3 Retrieving the PM Request Results

To get the PM results, first retrieve resulting PMPs by reading the table
enmsPerfMonResultPmpTable. Relevant rows will have enmsPmResultPmpReqId = 4, the
PM request index.
Note: Net-SNMP does not offer an easy way to retrieve only the rows for a specific sub-
index. The example below shows how to retrieve the entire table, which contains the results
for all requests.

snmptable enmsPerfMonResultPmpTable
SNMP table: TNMS-NBI-MIB::enmsPerfMonResultPmpTable

index ReqId PmpNumber NeId PortId TPIdH TPIdL NeIdName ObjLocation Name Location Direction RetrievalTime
PeriodEndTime
(...)
3.80 3 80 105 112010005 0 112010015 7090_100CEM_14 ge.1.5 7090M-RMON-RX 1 2 "2017-03-07 15:16:51" "2017-03-07
3.81 3 81 105 112010005 0 112010015 7090_100CEM_14 ge.1.5 7090M-RMON-RX 1 2 "2017-03-07 15:16:51" "2017-03-07
3.82 3 82 105 112010005 0 112010015 7090_100CEM_14 ge.1.5 7090M-RMON-RX 1 2 "2017-03-07 15:16:51" "2017-03-07
4.1 4 1 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.2 4 2 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.3 4 3 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.4 4 4 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.5 4 5 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.6 4 6 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.7 4 7 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.8 4 8 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.9 4 9 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.10 4 10 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.11 4 11 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.12 4 12 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
4.13 4 13 97 112030004 0 112030014 7090_320M_7 ge.3.4 7090M-RMON-RX 1 2 "2017-03-07 15:16:49" "2017-03-07
(...)

Next, retrieve counter values for the resulting PMPs, by reading the table
enmsPerfMonResultValueTable. Again, relevant rows will have enmsPmResultValReqId = 4.
Fields enmsPmResultValReqId + enmsPmResultValPmpNumber point to the PMP entries in
enmsPerfMonResultPmpTable.

snmptable enmsPerfMonResultValueTable

SNMP table: TNMS-NBI-MIB::enmsPerfMonResultValueTable

index ReqId PmpNumber Number Param Value Unit Status

(...)
3.84.6 3 84 6 pOVERSIZE 0.0 1
3.84.7 3 84 7 pBC 0.0 1
3.84.8 3 84 8 pMC 876.0 1
4.1.1 4 1 1 pOK 0.0 1
4.1.2 4 1 2 pBAD 0.0 1
4.1.3 4 1 3 oALL 0.0 1
4.1.4 4 1 4 pUC 0.0 1
4.1.5 4 1 5 fCSERR 0.0 1
4.1.6 4 1 6 pOVERSIZE 0.0 1
4.1.7 4 1 7 pBC 0.0 1
4.1.8 4 1 8 pMC 0.0 1
4.2.1 4 2 1 pOK 0.0 1
4.2.2 4 2 2 pBAD 0.0 1
4.2.3 4 2 3 oALL 0.0 1
4.2.4 4 2 4 pUC 0.0 1
(...)

Issue: 3 Issue date: October 2020 131/139

Net-SNMP Examples for PM Data Retrieval TNMS 18.10 – SNMP NBI Operation Guide

12.4 Re-executing the PM Request

To reuse a PM request, update its fields (typically the start/end times) and re-execute it by
setting enmsPmRequestState again to started. The example in this chapter re-executes the
previously created PM request, whose index is 4.
In the command below, the start/end times are set using relative times instead of absolute,
using the ISO 8601 notation for durations. SNMP NBI automatically converts ISO 8601
durations to absolute timestamps by adding the duration to the current UTC time. Start time
“-PT30m” will be converted to current UTC time minus 30 minutes, while end time “P0D”
(which is a zero duration) will be converted to the current UTC time (now). This means we
are requesting PM data for the last 30 minutes.
See https://en.wikipedia.org/wiki/ISO_8601#Durations for duration syntax information.
Note: only days, hours and minutes can be used when specifying durations. Other
granularities are not accepted.

snmpset enmsPmRequestStartTime.4 s "-PT30m"

enmsPmRequestEndTime.4 s "P0D"
enmsPmRequestState.4 i started

TNMS-NBI-MIB::enmsPmRequestStartTime.4 = STRING: "-PT30m"

TNMS-NBI-MIB::enmsPmRequestEndTime.4 = STRING: "P0D"
TNMS-NBI-MIB::enmsPmRequestState.4 = INTEGER: started(3)

Listing the PM requests, the supplied durations were converted to absolute timestamps:

snmptable enmsPerfMonRequestTable
SNMP table: TNMS-NBI-MIB::enmsPerfMonRequestTable

index Name RowStatus LastUpdate Info State Type StartTime EndTime

1 ethernetCarrier 1 "2017-03-03 19:47:00" Request reinitialized. 1 2 "" "" 1
2 mpls_7090 1 "2017-03-07 08:36:43" Request reinitialized. 1 1 "2017-03-06 20:00:00" "2017-03-06 20:30:00" 1
3 1 "2017-03-07 16:04:22" Execution finished. Total values: 84. 4 1 "2017-03-07 13:43:31" "2017-03-07 15:03:31" 1
4 Demo request 1 "2017-03-07 18:29:24" Execution finished. Total values: 23. 4 1 "2017-03-07 17:59:24" "2017-03-07 18:29:24"

132/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Net-SNMP Examples for PM Data Retrieval

12.5 Deleting a PM Request

Remove an unwanted PM request by setting enmsPmRequestRowStatus to destroy(6):

snmpset enmsPmRequestRowStatus.4 i destroy

TNMS-NBI-MIB::enmsPmRequestRowStatus.4 = INTEGER: destroy(6)

Confirming that the PM request has been deleted:

snmptable enmsPerfMonRequestTable
SNMP table: TNMS-NBI-MIB::enmsPerfMonRequestTable

index Name RowStatus LastUpdate Info State Type StartTime EndTime

1 ethernetCarrier 1 "2017-03-03 19:47:00" Request reinitialized. 1 2 "" "" 1
2 mpls_7090 1 "2017-03-07 08:36:43" Request reinitialized. 1 1 "2017-03-06 20:00:00" "2017-03-06 20:30:00" 1
3 1 "2017-03-07 16:04:22" Execution finished. Total values: 84. 4 1 "2017-03-07 13:43:31" "2017-03-07 15:03:31" 1

Issue: 3 Issue date: October 2020 133/139

Troubleshooting TNMS 18.10 – SNMP NBI Operation Guide

13 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 0). 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, if 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.2.2).

SNMP user doesn’t have the Change permission of the SNMP

appropriate permission. user to ‘Read’ or ‘Read/Write’ as
appropriate (see 3.2.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.2.1).

134/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Troubleshooting

Symptom Possible cause Solution

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 (that
is, the table is valid, but does not
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 (for access SNMP NBI instead.
example, a 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.2.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.

Issue: 3 Issue date: October 2020 135/139

Troubleshooting TNMS 18.10 – SNMP NBI Operation Guide

Symptom Possible cause Solution

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.2.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.2.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.
For SNMPv3 users, 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.2.2).
(See below for cases specific to
PM/OPM request handing.)
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.

SET operation returns error The instance identifier is already in Make sure the instance identifier is
when creating a PM/OPM use. not used by another row in the
request. PM/OPM request table. An auto-
increment variable may be used to
(See more possible causes generate instance identifiers (see
below.) 10.2 / 11.2).

RowStatus attribute unset or set to When adding a new request, set the
invalid value. RowStatus attribute to createAndGo.

The maximum number of PM / OPM Delete unused requests, or reuse an

requests (5000) has been reached. existing request by updating its
attributes.

136/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Troubleshooting

Symptom Possible cause Solution

SET operation returns error Invalid value assigned to an Check the values supplied to the
when creating or updating a attribute. attributes – non-existent
PM/OPM request. enumeration value, malformed
dates, malformed object identifiers,
etc.

Some attribute value was set to a Make sure the request attributes
value inconsistent with other values. stay consistent with each other.
Examples:
• When setting the request filter
type to port, the filter value must
be a port identifier; the SNMP
manager must change the filter
type and the filter value at the
same time, in a single SET
command.
• When changing a PM request
type to history, the start/end
times must not be empty,
otherwise the manager must set
the request type and the
start/end times simultaneously,
in the same SET command.

SET operation returns error The state transition is not valid. See section 10.3 / 11.3 for possible
when updating the state of the state transitions.
PM/OPM request.

SET operation returns error The request is in state pending, It is only possible to delete requests
when deleting a PM/OPM started or cancelling. that are in idle state (created,
request. finished, failed and cancelled) – the
manager must wait for the request to
reach one of such states.

Table 89 SNMP NBI troubleshooting table

Issue: 3 Issue date: October 2020 137/139

Abbreviations TNMS 18.10 – SNMP NBI Operation Guide

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

138/139 Issue: 3 Issue date: October 2020

TNMS 18.10 – SNMP NBI Operation Guide Abbreviations

TNMS Telecommunication Network Management System

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

Issue: 3 Issue date: October 2020 139/139