0% found this document useful (0 votes)

145 views164 pages

ENC Integration Manual

Uploaded by

Slimani Azzeddine

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

145 views164 pages

ENC Integration Manual

Uploaded by

Slimani Azzeddine

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

Integration Manual

Ensemble Controller

Product Release: 15.3

Document Issue: A
Document Number: 80000075301
Product Release: 20.1.1
Product Release: 20.1.1
Document Issue: ADocument Issue: A
Document Number: 80000065616
Document Number: 80000065616
Copyright © 2001-2024 Adtran Networks SE. All rights reserved.
Adtran Holdings, Inc.
901 Explorer Blvd.
Huntsville, AL 35806
USA
Adtran Networks SE, formerly known as ADVA Optical Networking SE (an Adtran company)
Campus Martinsried
Fraunhoferstrasse 9a
82152 Martinsried/Munich
Germany
Terms of Use (“Terms”):
Acceptance of Terms
By using this content, including without limitation any services, portals, webpages, manuals, documentation and
any other information provided herein (hereinafter referred to as “Content” and/or “Service”), you assent to the
following terms of use. If you do not agree to these terms, please do not use this Content.
If you are using this Content on behalf of your employer/hirer/contractor, you represent and warrant that you are
authorized to accept these Terms on your employer's/hirer’s/contractor’s behalf.
Use of the Content and Service
You agree not to access the Content by any means other than through the interface that is provided by Adtran
Networks SE. Adtran Networks SE, formerly known as ADVA Optical Networking SE, includes its affiliates and
successors (“Adtran”). You will not use the Service for any purpose that is unlawful or prohibited by these Terms.
You may not use the Service in any manner that could damage, disable, overburden, impair, or otherwise result in
unauthorized access to or interference with, the proper functioning of any Content, accounts, systems, networks
of Adtran or its licensor(s).
If parts of the Content (including without limitation service) require you to open an account, to choose a password
and/or a user name, you are entirely responsible for maintaining the confidentiality of your password and account,
and for any and all activities that occur under your account. You will maintain and promptly update your account
and any information you provide to Adtran to keep it accurate, current and complete.
You will notify Adtran immediately of any unauthorized use of your account or any other breach of security.
Adtran will not be liable for any losses you incur as a result of someone else using your password or account,
either with or without your knowledge. However, you could be held liable for losses incurred by Adtran due to
someone else using your account at any time, without the permission of the account hold.
You may obtain direct access via the Content (including without limitation portal or system) to certain confidential
information of Adtran and its suppliers and contractors, including without limitation technical, contractual,
product, delivery, pricing, marketing and other valuable information that should reasonably be understood as
confidential ("Confidential Information"). You must hold Confidential Information in strict confidence. Title to
Confidential Information remains with Adtran or its respective suppliers and contractors.
No Warranties
ALL CONTENT IS PROVIDED ON AN ''AS IS AVAILABLE'' BASIS WITHOUT ANY WARRANTY OF ANY KIND EITHER
EXPRESSED OR IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. ADTRAN MAKES NO
WARRANTY AS TO THE ACCURACY, COMPLETENESS, OR RELIABILITY OF ANY CONTENT AVAILABLE HEREIN. USE
OF THE CONTENT IS AT YOUR SOLE RISK. YOU ARE RESPONSIBLE FOR VERIFYING ANY INFORMATION BEFORE
RELYING ON IT AND FOR TAKING ALL NECESSARY PRECAUTIONS TO ENSURE THAT CONTENT IS FREE OF

Ensemble Controller R15.3 -Integration Manual - Issue: A 2

Adtran

VIRUSES. The content of this document may include technical inaccuracies or typographical errors. Adtran
may make changes at any time to the Content (including without limitation portals, systems, products or
specifications) without notice and makes no commitment to update Content.
Adtran may provide economic projections and forward-looking statements on this Content (including
without limitation on portals or systems) that relate to future facts. Such projections and forward-looking
statements are subject to risks which cannot be foreseen and which are beyond the control of Adtran.
Adtran is therefore not in a position to make any representation as to the accuracy of economic projections
and forward-looking statements or their impact on the financial situation of Adtran or the market in the
shares of Adtran.
Limitation of Liability
IN NO EVENT SHALL ADTRAN NETWORKS SE OR ITS AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR RELATED TO
THE ACCESS OR USE OF THE CONTENT (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND BASED ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE. THE SAME APPLIES FOR ANY HARDWARE OR SOFTWARE INCLUDED IN THE CONTENT,
UNLESS A SIGNED AGREEMENT WITH ADTRAN NETWORKS SE OR ITS AFFILIATE(S) OR THE APPLICABLE
PRODUCT LIABILITY LAW EXPRESSLY STATES OTHERWISE.
Trademarks and Copyright
Documents and information, including text, images, graphics, sound files, animation files, video files and
their arrangement made available in the Content (including without limitation the portal or system) are
subject to copyright and other intellectual property protection. They may not be copied for commercial use
or distribution and may not be modified or reposted to other internet sites.
Unless otherwise indicated, all marks displayed on the Content (including without limitation portals) are
subject to the trademark rights of Adtran Networks SE or the respective trademark owner. Adtran Networks
SE and the Adtran Networks SE Logo are trademarks or registered trademarks of Adtran Networks SE in
Germany and other countries.
Any software that is made available for download from the Content ("Software") is a copyrighted work of
Adtran or the respective copyright owner.
The furnishing of this content does not give you any license or rights with respect any content, patents
and/or trademarks herein, unless the Content (including without limitation software) is governed by the
terms of your signed agreement with Adtran. Any reproduction or redistribution of the Content (including
without limitation Software) not in accordance with the foregoing is expressly prohibited.
Third Party Content
Third-party content is the property of their respective owners and does not imply a partnership between
Adtran and any other company. Any references to content that is not from Adtran are provided for
convenience only and do not in any manner serve as an endorsement of that content.
Software generally known as “open source software” is licensed pursuant to the applicable license terms.
The copyright owners of such software disclaim all warranties and conditions, express and implied,
including warranties or conditions of title and non-infringement, and implied warranties or conditions of
merchantability and fitness for a particular purpose, and all liability for damages, including direct, indirect,
special, incidental and consequential damages, such as lost profits.
Export Controls

Ensemble Controller R15.3 Integration Manual - Issue: A 3

Adtran

The Content (including without limitation service, Software, or technology derived or obtained from the
portals) may be subject to the export control laws and/or the import laws of various country (“Controlled
Items”). This includes without limitation the export control laws and regulations of Germany, the European
Union, and the United States. You agree to comply strictly with all such laws. In particular, you will not use,
distribute, transfer or transmit the Controlled Items (even if incorporated into other products) except in
compliance with such laws. You are also responsible for complying with all applicable legal regulations of
the country where you are registered, and any foreign countries with respect to the use of the Controlled
Items by you, your affiliates, subsidiaries, directors, employees, authorized users and permitted third
parties, including end-users. Adtran will support you in obtaining any necessary export or import license for
Controlled Items. You agree that none of the Controlled Items will be sold or otherwise transferred to, or
made available for use by or for, any entity that is (a) named on the EU, U.S. or other government-issued
Sanctioned Party Lists (Denied Party List, Restricted Party, etc.) or (b) engaged, directly or indirectly, in the
design, development, production, stockpiling, or use of chemical or biological weapons, nuclear programs
(including activities related to nuclear devices, nuclear reactors, and nuclear fuel-cycle activities), missiles
and maritime nuclear propulsion projects, except as authorized under applicable laws and regulations.
You agree that, in the event you are notified by Adtran, a third party or a governmental agency about a
license requirement for Controlled Items or particular transactions, you will not export or re-export the
Controlled Items or pursue the transactions, directly or indirectly, until the required licenses are obtained,
and work with Adtran, the third party or the governmental agency to procure the required licenses.
You agree to indemnify and hold harmless Adtran in the event of your non-compliance with any applicable
German, EU, and U.S. export control laws and the export controls or import laws of other countries.
Governing Law and Place of Jurisdiction
The Content and any dispute arising out of or in connection with this Content is governed by German Law,
without its choice of law provisions and the United Nations Convention on Contracts for the International
Sale of Goods is hereby excluded. The District Court of Munich has exclusive jurisdiction for any dispute
arising out of or in connection with this Content.
Privacy Statement
All terms related to our privacy information are available at: https://www.adva.com/en/about-
us/legal/privacy-statement
All terms related to our privacy information for Customer Portal users are available at: https://advaoptical-
communities.force.com/customerportal/CustomerPortalTCs

Ensemble Controller R15.3 Integration Manual - Issue: A 4

Adtran Contents

Contents
Contents 5
Preface 11
Safety Symbol and Message Conventions 11
Documentation 11
Rebranding 12
Ensemble Controller Documentation Suite 13
Accessing Documentation 13
Within Ensemble Controller 13
World Wide Web 13
Documentation Feedback 14
Obtaining Ensemble Controller Information 14
Support Info 14
Exporting the Info Window 15
Accessing the Client Error Log File 15
Creating a System Health Report 15
Requirement to Create a System Health Report 15
Procedure to Create a System Health Report 15
About Information 16
Obtaining Technical Assistance 16
Customer Portal 16
Technical Services 17
Call Adtran 17
Document Revision History 17
Using the Ensemble Controller Heartbeat 21
Functional Specification 21
User Interface Specification 21
Managing Third-Party Equipment 23
Using the Customization Description File 23
Defining the Customization Description File 23
Product Identification 24

Ensemble Controller R15.3 Integration Manual - Issue: A 5

Adtran Contents

Launching the Craft Terminal 24

Launching the Command Line Interface 26
Monitoring the Network Element Status 26
Managing Events 27
Loading the Customization Description File 31
Configuring Juniper Devices 31
Trapsink Registration for Juniper Devices 31
Setting Up Juniper Devices for SNMPv2c Write Access 31
Synchronizing Alarms with Juniper Devices 32
Processing Traps with the OSA SNMP Proxy Agent 32
Requirement Upon Discovery 33
System Object Identifier 33
Automatic Trapsink Registration 33
Trap Mapping 34
Trap Description 34
SnmpAdminString 39
DateAndTime 39
Devices that Support MTOSI Naming 40
Trap Example 42
About the CSV North Bound Interface 44
CSV Change History 44
Changes in Release 8.4 45
Inventory Report 45
Resource Report 45
Performance Log File 46
Changes in Release 8.5 47
Inventory Report 47
Service Inventory Report 47
Resource Report 48
Performance Log File 49
Changes in Release 9.1 49
Changes in Release 9.2 51
Changes in Release 9.3 53
Changes in Release 9.4 55

Ensemble Controller R15.3 Integration Manual - Issue: A 6

Adtran Contents

Changes in Release 9.6 55

Changes in Release 10.1 56
Link Loss Report 56
Resource Reports 57
Event and Alarm Log Files 60
Changes in Release 10.2 62
Entity AID Change 62
Discontinuation of the Additional Alarm Log File 62
Changes in Release 10.3 62
Changes in Release 11.1 62
Changes in Release 11.3 62
Changes in Release 12.1 62
Changes in Release 12.3 63
Changes in Release 13.1 63
Inventory Report Extension 63
FSP 3000 C Access Identifier Changes 64
Changes in Release 14.2 67
Changes in Release 14.3 67
Changes in Release 15.1 67
Changes in Release 15.2 67
Interface Configuration and Setup 68
Editing the CSV Format 68
com.adva.fnm.option.CSVSeparator 68
com.adva.fnm.option.EventLogCSVSeparator 68
com.adva.nlms.mediation.event.CSVLogLineBreakAtEOL 68
Enabling the CSV File Transfer 68
Requirement to Enable the CSV File Transfer 69
Procedure to Enable the CSV File Transfer 69
CSV Event NBI 70
Enabling the Event Log File 70
Details on the Columns Service_Name and Customer_Name 73
CSV <Heart Beat> Event 74
CSV Inventory NBI 75
Report Storage 76

Ensemble Controller R15.3 Integration Manual - Issue: A 7

Adtran Contents

Report Layout 76
Bandwidth Utilization Report 76
Inventory Report 76
Report Details Regarding FSP 3000R7 Passive Units 76
Link Loss Report 84
Naming 85
NE Backup Report 87
Report Naming 87
Power Consumption Report 88
Naming 88
Report Description 88
PTP Remote Slaves Report 89
Report Naming 89
PTP Remote Slaves Usage Report 92
Report Naming 92
Resource Report 93
Service Inventory Report 96
Sync Topology Report 102
Nodes and Links Supporting the Sync Topology Report 102
Naming 103
Report Details 103
Topology Report 106
Report Details 106
Devices Supporting MTOSI Naming 107
CSV Quality Compliance NBI 107
CSV Sync Quality Compliance Report 107
Report Naming 108
Report Description 108
Report Layout 109
Report Storage 110
Cleanup of Earlier Stored Report Files 110
CSV Performance NBI 111
Report Layout 111
Report Storage 111

Ensemble Controller R15.3 Integration Manual - Issue: A 8

Adtran Contents

Cleanup of Old Report Files Stored 111

Performance Report 112
Report Naming 112
Report Description 114
Sync Performance Report 115
Report Naming 115
Report Description 116
About the SNMP North Bound Interface 117
SNMP Change History 117
Changes in Release 9.2 117
Changes in Release 9.4 118
Changes in Release 9.6 118
Changes in Release 10.3 119
Changes in Release 11.2 119
Trap Description 120
SnmpAdminString 124
DateAndTime 125
Devices that Support MTOSI Naming 126
SNMP <Heart Beat> Event 127
Resynchronization 128
Operating Principle 128
Sending Traps Using the HTTP POST Request 129
Sending Traps Using the Transmission Control Protocol 129
Trap Structure and Sending Sequence 132
SNMP MIB File 133
Service Affected Events 133
Functional Specification 133
User Interface Specification 135
Enabling Service Affected Alarms 135
Enabling Logging of Service Affected Alarms in the Ensemble Controller Database 135
North Bound Interface Specification 135
Notification Events 138
OSS-ADD – OSS Address Added 138
OSS-DEL – OSS Address Deleted 138

Ensemble Controller R15.3 Integration Manual - Issue: A 9

Adtran Contents

About the MTOSI North Bound Interface 139

MTOSI Change History 139
Changes in Release 10.3 139
Enabling MTOSI 139
Procedure 140
Logging of MTOSI Activities 143
Services with Implemented Functionality 143
Opening a Service Operation 156
Opening an MTOSI Operation With SoupUI 158
Testing MTOSI Iterators With SoapUI 158
Configuring a Mock Server for MTOSI Notifications With SoapUI 161
MTOSI <Heart Beat> Event 164

Ensemble Controller R15.3 Integration Manual - Issue: A 10

Adtran Preface

Preface
Safety Symbol and Message Conventions 11
Documentation 11
Obtaining Ensemble Controller Information 14
Obtaining Technical Assistance 16
Document Revision History 17

The pictures or graphics shown in this document are for reference only. They
are based on the latest hardware revision available at the time of publication.
The equipment you received might look different than pictures or graphics
shown in this document.

Safety Symbol and Message

Conventions
You will see these symbols throughout the documentation. All personnel should correctly follow
and not ignore any safety instructions.

Icon Meaning Description

Notice Indicates the risk of equipment damage, malfunction,

process interruption, or negative impacts on surroundings.

Note Indicates supplemental information or helpful

recommendations.

Documentation
Rebranding 12
Ensemble Controller Documentation Suite 13
Accessing Documentation 13
Documentation Feedback 14

Ensemble Controller R15.3 Integration Manual - Issue: A 11

Adtran Preface

Rebranding
In the context of changing marketing requirements, we rename Ensemble Controller
applications. This table shows the release when names changed, and the new names for the
applications.

Release Old Name / New Name New Remark

Abbreviation Abbreviation

11.1.1 Network Ensemble ENC

Manager / NM Controller

Network Ensemble ENC Server

Manager Server Controller Server

Network Ensemble ENC Client

Manager Client Controller Client

Service Manager Ensemble Optical EOD

Director

Sync Manager Ensemble Sync ESD

Director

Ethernet Ensemble ECBM

Configuration Command-
Manager Based Manager

Encryption Ensemble ECGD

Manager ConnectGuard
Director

Bandwidth Ensemble EBM

Manager Bandwidth
Manager

12.3.1 Ensemble CryptoManager

ConnectGuard
Director / ECGD

Ensemble Controller R15.3 Integration Manual - Issue: A 12

Adtran Preface

Release Old Name / New Name New Remark

Abbreviation Abbreviation

13.1.1 Control Plane Centralized CPc Manager

Migration Tool / Control Plane
CP Migration Manager
Tool

Ensemble Controller Documentation Suite

Ensemble Controller includes these manuals:
l Ensemble Controller Administrator Manual
o Quickstart Administrator Guide
l Ensemble Controller Integration Manual
l Ensemble Controller User Manual

These manuals especially address licensed Ensemble Controller features:

l Packet Management Guide
l Synchronization Management Guide
l WDM Management Guide
l Ensemble Fiber Director User Manual

Accessing Documentation
Within Ensemble Controller
From the Ensemble Controller Help menu, you can view user documentation either in PDF or
web format.
The default Windows PDF viewer and web browser will normally be used to display the manual.
To use a different browser or viewer, change the Ensemble Controller preferences. These
preferences are stored per user. For more information about how to change preferences and
use a different application, see the User Manual.

World Wide Web

Documentation Portal https://advadocs.com/

Ensemble Controller R15.3 Integration Manual - Issue: A 13

Adtran Preface

Documentation Feedback
We want our documentation to be as helpful as possible. Feedback is always welcome.

Email [email protected]

Mail Adtran
Technical Documentation
Märzenquelle 1-3
98617 Meiningen-Dreissigacker
Germany

Obtaining Ensemble Controller

Information
The Ensemble Controller Help menu includes these options to obtain Ensemble Controller
information.
If these options are not available, your user role might be subject to a view restriction. For more
information about view restrictions, see User Manual, Help.

Support Info 14
About Information 16

Support Info
The support Info dialog box displays information about your Ensemble Controller Client and
Server version, for example:
l Version and build number
l Java version
l Interfaces
l Ports in use
l Certificate and license
l Thread dump

This information is especially useful for Technical Services when you troubleshoot Ensemble
Controller issues.
To open the support Info dialog box, from the Ensemble Controller Help menu, select Support
Info.

Exporting the Info Window 15

Ensemble Controller R15.3 Integration Manual - Issue: A 14

Adtran Preface

Accessing the Client Error Log File 15

Creating a System Health Report 15

Exporting the Info Window

1. To make the information in this Info window available to a technical representative, click
Export. The Save window opens.
2. Store the file in a safe location, and then contact the Technical Services department.

Accessing the Client Error Log File

Use the link in the Info window to access the client error log file:
l Click the first part of the link, which indicates the folder path to access the default file location.
l Click the second part of the link, which is the file name to load the file immediately and save it
as appropriate.

Creating a System Health Report

The Technical Services department uses system health reports to analyze and troubleshoot
Ensemble Controller problems.
Complete these steps to create a system health report.

Requirement to Create a System Health Report 15

Procedure to Create a System Health Report 15

Requirement to Create a System Health Report

To create system health reports, you need to have the permission Create System Health Report.
The system grants this permission to use with an administrator role, as the default.
The administrator sets permissions and corresponding user roles in the Security Manager. To
open the Security Manager, in the Ensemble Controller application bar Settings menu, select
Security, and then Security Manager. For more information about user roles and allocated
privileges, see the Administrator Manual, Roles and Allocated Actions.

Procedure to Create a System Health Report

1. To open the support Info dialog box, from the Ensemble Controller Help menu, select Support
Info.
2. From the ribbon menu, Operation area, select System Health Report.
A confirmation dialog box opens.
3. Click Yes, to open the Save dialog box.
–or–
Click No to stop this action.
4. After you click Yes, in the Save dialog box, browse to an appropriate location where you want
the system to save the report.

Ensemble Controller R15.3 Integration Manual - Issue: A 15

Adtran Preface

5. If required, in the File name field, you can change the file name.
By default, the system names the file in the format healthReport_yyyymmdd-xxxx.zip.
If you change the file name, the system automatically adds the ZIP suffix if missing. This
applies if you use a Windows system. The same applies if you use a Linux system but with a
different suffix.
6. Click Save. A progress window appears.
It might take several minutes for the system to create the report, which depends on the
database size.
The system can create one report at a time. If you or users from other open Ensemble
Controller Clients attempt to create another report simultaneously, an error message
displays in the message pane. The system sends these messages to all available Ensemble
Controller Clients.
After the system finishes the report, the message pane displays respective messages.
The server stores the latest report, and overwrites the existing file that you created
previously. That is, always one report is kept on the server.

About Information
To open a brief summary about the current Ensemble Controller version, from the Help menu,
select About.

Obtaining Technical Assistance

Product Maintenance Agreements and other customer assistance agreements are available
for Adtran products through your Adtran distribution channel. Our service options include:
l 24 x 7 telephone support
l Web-based support tools
l On-site support
l Technical training, both on-site and at Adtran facilities in Germany and the USA
l Expedited repair service
l Extended hardware warranty service

Customer Portal
You can use the customer portal to:
l Access company information and resources at any time.
l Find information specific to your requirements, such as networking solutions, services, and
programs.
l Resolve technical issues by using online support services.
l Download and test software packages.
l Order Adtran training materials.

Ensemble Controller R15.3 Integration Manual - Issue: A 16

Adtran Preface

Access https://www.adva.com/en/customer-portal

Questions [email protected]

Technical Services
Technical services are available to customers who need technical assistance with an Adtran
product that is under warranty or covered by a maintenance contract.

Online https://www.adva.com/en/about-us/contact

Email [email protected]

Call Adtran
Corporate Headquarters
Huntsville, AL, USA
+1 800 923 8726
Europe, Middle East and Africa
Martinsried/Munich, Germany
+49 (0)89 89 06 65 0

Document Revision History

For detailed information about a specific product release, see the appropriate
Release Notes.

Product Document Document Issue Date Description

Release Number Issue

9.6 80000041718 Issue A February 2017 Updated manual

according to new
features in this
Ensemble Controller
release.

Ensemble Controller R15.3 Integration Manual - Issue: A 17

Adtran Preface

Product Document Document Issue Date Description

Release Number Issue

Issue B March 2017 Restructured the

CSV Performance
NBI section to cover
the description of
the new Sync
Performance Report.

10.1 80000043003 Issue A May 2017 Updated manual

according to new
features in this
Ensemble Controller
release.

Issue B July 2017 Updated the Link

Loss Report section
and the section
outlining the NBI
Changes in Release
10.1.

10.2 80000044011 Issue A September Manual updated

2017 according to new
features in this
release.

Issue B October 2017 Removed the last

three rows (no. 24,
25, 26) from the PTP
Remote Slaves
Report.

Added event log

details to the
section CSV Event
NBI.

10.3 80000046841 Issue A February 2018 Manual updated

according to new
features in this
release.

Issue B Added the section

Changes in Release
10.3.

Ensemble Controller R15.3 Integration Manual - Issue: A 18

Adtran Preface

Product Document Document Issue Date Description

Release Number Issue

10.4 80000048556 Issue A June 2018 Manual updated

according to new
10.5 80000049795 Issue A September features in the
2018 release.

11.1 80000052358 Issue A March 2019

11.2 80000053553 Issue A July 2019

11.3 80000056610 Issue A November

2019

Issue B December Revised the update

2019 attribute.

12.1 80000058299 Issue A March 2020 Manual updated

according to new
12.2 80000059647 Issue A July 2020 features in the
release.
12.3 80000061737 Issue A November
2020

12.4 80000062653 Issue A January 2021

13.1 80000063281 Issue A April 2021

Issue B June 2021 Updated

Synchronizing
Alarms with Juniper
Devices.

Added Changes in
Release 13.1.

13.2 80000065828 Issue A September Manual updated

2021 according to new
features in this
13.3 80000066986 Issue A January 2022 release.

Issue B July 2022 Updated Trap

Description.

14.1 80000068788 Issue A May 2022 Manual updated

according to new
features in this
release.

Ensemble Controller R15.3 Integration Manual - Issue: A 19

Adtran Preface

Product Document Document Issue Date Description

Release Number Issue

14.2 80000070105 Issue A September

2022

Issue B September Updated Service

2022 Inventory Report
and Changes in
Release 14.2.

14.3 80000071327 Issue A December Manual updated

2022 according to new
features in this
15.1 80000072272 Issue A May 2023 release.

Issue B July 2023 Updated Enabling

Logging of Service
Affected Alarms in
the Ensemble
Controller
Database.

15.2 80000074001 Issue A September Manual updated

2023 according to new
features in this
15.3 80000075301 Issue A February 2024 release.

Ensemble Controller R15.3 Integration Manual - Issue: A 20

Adtran Using the Ensemble Controller Heartbeat

Chapter 1
Using the Ensemble Controller
Heartbeat
Ensemble Controller (ENC) creates the regular event <Heart Beat> that you can configure for the
different northbound interfaces CSV, SNMP, and MTOSI. Configure these interfaces to indicate
that the Ensemble Controller Server is still up and running.

Functional Specification 21
User Interface Specification 21

Functional Specification
The <Heart Beat> event is disabled by default. You must enable the heartbeat and configure the
time between two <Heart Beat> events in the Ensemble Controller Server configuration
fnm.properties file, as described in User Interface Specification.
The event is triggered in this sequence after the timer between two <Heart Beat> events expired.
The heartbeat process goes as follows. The software:
1. Sends a trap to the SNMP alarm NBI, which contains the varbinds as described in SNMP
<Heart Beat> Event.
2. Writes an entry to the CSV alarm NBI, which contains the properties as described in CSV
<Heart Beat> Event.
3. Sends a trap to the MTOSI NBI, which contains the varbinds as described in MTOSI <Heart
Beat> Event.
4. Starts a new timer.

User Interface Specification

To enable and configure the <Heart Beat> event, in the fnm.properties file, edit these parameters
according to the interface that you need:
l com.adva.fnm.option.HeartBeatInterval
This parameter sends an event to all interfaces that you did not configure, such as CSV, SNMP,

Ensemble Controller R15.3 Integration Manual - Issue: A 21

Adtran Using the Ensemble Controller Heartbeat

and MTOSI.
l com.adva.fnm.option.HeartBeatInterval.CSV_NBI
This property specifies the rate that the system uses to sendt the <Heart Beat> event only to
the CSV alarm NBI.
l com.adva.fnm.option.HeartBeatInterval.SNMP_NBI
This property specifies the rate that the system uses to send the <Heart Beat> event only to
the SNMP alarm NBI.
l com.adva.fnm.option.HeartBeatInterval.MTOSI_NBI
This property specifies the rate that the system uses to send the <Heart Beat> event only to
the MTOSI alarm NBI.

To enable the event, in the fnm.properties file, delete the initial # at the beginning of the
property line:

After you specify or enable a time interval in the fnm.properties file, the system sends the event.
You must do this task before the system will send the event.
The default <Heart Beat> interval is 300 seconds. You can modify this interval as appropriate to
be 5 to 360 seconds. A value beyond this range is invalid, and the system will ignore the
property and not send the event.
Ensemble Controller does not store the event in the database, and therefore, the event is
unavailable in either the GUI or in the report files.
For general information about how to edit properties in the fnm.properties file, see the
Administrator Manual.

Ensemble Controller R15.3 Integration Manual - Issue: A 22

Adtran Managing Third-Party Equipment

Chapter 2
Managing Third-Party
Equipment
This chapter describes how to manage third-party equipment such as Juniper devices.

Using the Customization Description File 23

Configuring Juniper Devices 31
Processing Traps with the OSA SNMP Proxy Agent 32

Using the Customization Description

File
SNMP-capable network elements (NEs) are manageable to a limited extent. Ensemble
Controller supplies a special customization description file where you can itemize all third-party
product specifics.
This section describes how to set up the customization description file and how to load it to the
Ensemble Controller.

Defining the Customization Description File 23

Loading the Customization Description File 31

Defining the Customization Description File

The Ensemble Controller customization description file is an XML file that must comply with the
XML scheme presented in Figure 1.
You can define this product-specific data in the XML file:
l Product Identification (tag <device>)
l Launching the Craft Terminal Details (tag <LCT>)
l Launching the Command Line Interface (tag <CLI>)
l Monitoring the Network Element Status (tag <neStatus>)
l Managing Events (tag <eventList>)

Ensemble Controller R15.3 Integration Manual - Issue: A 23

Adtran Managing Third-Party Equipment

Figure 1 illustrates the overall structure of the customization description file:

Figure 1: Customization Description File - XML Scheme

Product Identification
The required product identification part specifies these attributes:
l Product Name (attribute name)
l Product ID (attribute id)
l SNMP System Object ID (attribute sysOid)

The product ID must be greater than 10,000 and unique for a given Ensemble Controller Server
across all integrated products.
Figure 2 shows a product ID example:
Figure 2: Product Identification - XML Scheme

Launching the Craft Terminal

On the craft terminal launching area, you can determine how you want to launch the product-
specific craft interface. You can open the craft interface either as an original application that
you must install on each client machine. Or you can open the craft interface through the web
interface.
An original craft application supports these parameters:

Ensemble Controller R15.3 Integration Manual - Issue: A 24

Adtran Managing Third-Party Equipment

l Application Name (tag <name>)

l Path for Executable (tag <executable>)
l A Number of Arguments (tag <argument>)

After you configure the <application> tags, the Ensemble Controller GUI menu will include the
Element Manager option.
For more information about how to use the Element Manager in the Ensemble Controller GUI,
see the User Manual.
In addition, you can use these placeholders, which the Ensemble Controller database replaces
with actual values:

Placeholder Description

%a IP address to access the network element.

%g SNMP read community.

%s SNMP write community.

%t SNMP timeout in milliseconds.

%r Number of SNMP retries.

%p Ensemble Controller Server IP address.

A web-based craft interface supports these optional URL components:

l Protocol (tag <protocol>) – default: http
l Port (tag <port>) – default: 80
l Path on Server (tag <path>)

Here is a CLI craft interface example:

fem <IP address> -rc <getcomm> -wc <setcomm> -timeout <timeout> -retries
<retries>
Here is a web-based craft interface URL example:
http://<IP address>/

Ensemble Controller R15.3 Integration Manual - Issue: A 25

Adtran Managing Third-Party Equipment

This figure shows an example of a craft terminal launch:

Launching the Command Line Interface

To launch an unsecure (Telnet) command line interface (CLI), add the XML tag
<cli-enabled/>.
To launch a secure shell (SSH), add the attributes <cli-enabled secure="true"/> to the XML tag.

Monitoring the Network Element Status

This section describes how you want the system to evaluate the overall network element alarm
status. If the software detects a status that is abnormal compared to what is specified in this
section, Ensemble Controller generates a generic alarm with the appropriate severity.
This section is optional. However, any SNMP trap that you specify in the Managing Events section
is logged as a transient event only and has no affect on the alarm status indication.
To edit this section, you must specify these attribute types:
l The SNMP OID (attribute oid) of the object that uses integers to report the network element
status.
l The object severity values.

Figure 3 shows a monitoring example:

Ensemble Controller R15.3 Integration Manual - Issue: A 26

Adtran Managing Third-Party Equipment

Figure 3: Network Element Status Monitoring - XML Scheme

Managing Events
Use the Event Handling area to specify logging and representation of SNMP traps that network
elements receive. Ensemble Controller logs all the traps that you specify in this area to the
global event database. Table 1 and Table 2 list the available specification options.

The XML tag sequence must be exactly as listed in these tables.

Table 1: Event Parameters

Name Tag Occurrences Description

Network Event Level Parameters

Event Name name 1 Event headline displays in a

tooltip.

Event Short Name short-name 1 Identification code displays in the

Ensemble Controller event table.

Event Message message 1 Event message displays in the

Ensemble Controller event table.
Supported placeholders that
require object specification are:
l {1}: Value representation
l {2}: Object name

Default Severity severity-no- 1 Default severity, which you can

service change in Ensemble Controller.
Supported values:
l CRITICAL
l MAJOR
l MINOR
l WARNING
l INFORMATION

Ensemble Controller R15.3 Integration Manual - Issue: A 27

Adtran Managing Third-Party Equipment

Table 1: Event Parameters

Name Tag Occurrences Description

Event Description help 0..1 Event Help text displays in a

tooltip.

Service Affect service- 0..1 If this tag is present, the event is

affecting considered service affecting.

Changed Object vb-number- 0..1 Position of the SNMP trap varbind

Varbind Position value that contains the object (OID and
value) that the trap reports
(counted from 1).

Parameter vb-number- 0..1 Position of the SNMP trap varbind

Varbind Position entity that contains the managed
entity that the traps refers
(counted from 1). Supported
syntaxes are:
l Any sort of INTEGER
l DISPLAY-STRING

Trap Description trap 1 Contains all additional trap

specifics.

Trap Description Level Parameters

Trap Name name 1 The MIB-specified trap name.

Trap Number number 1 The MIB-specified trap number.

MIB Object varbind 0..1 Contains specifics of a MIB object

that this trap can contain.
Multiple occurrences of this tag
are supported.

MIB Object Level Parameters

Object Name name 1 Name of object to be displayed

as part of the message.

Object ID oid 1 SNMP object ID to be used as

identifier of the relevant MIB
object description.

Parameter ID trap- 1 For internal use, has to be defined

param-id as customTrap.

Service Affect service- 0..1 Overrides definition on the event

affecting level.

Value value any Specifies the object value

Representation representation (see Table 2).

Ensemble Controller R15.3 Integration Manual - Issue: A 28

Adtran Managing Third-Party Equipment

These syntaxes can be represented in the event messages:

Table 2: Event Syntax

Syntax How to Specify Example

DISPLAY-STRING Value tag not present.

Octet string Attribute type set to hex. <value type=”hex”/>

(hex)

DateAndTime Attribute type set to <value type=”tstamp”/>

tstamp.

IpAddress Attribute type set to ip <value type=”ip addr”/>

addr.

Integer String that contains a <value>{0} dB</value>

value placeholder {0}.

Enumeration List of value tags. The <value id=”1”>on</value>

attribute ID of each tag is <value id=”2”>off</value>
set to the integer value <value id=”3”>unknown</value>
and contains the string
representation.

Figure 4 shows a specification example for a straightforward alarm event, loss of signal, and a
more complex event, an interface configuration change.

Ensemble Controller R15.3 Integration Manual - Issue: A 29

Adtran Managing Third-Party Equipment

Figure 4: Event Handling - XML Scheme

Ensemble Controller R15.3 Integration Manual - Issue: A 30

Adtran Managing Third-Party Equipment

Loading the Customization Description File

When the Ensemble Controller Server starts, it scans the CustomProducts folder located in the
Ensemble Controller installation directory. All customization description files in this folder are
loaded. If you need to add a file or modify an existing file, restart the server.

Configuring Juniper Devices

This section describes how to configure Juniper devices to interact correctly with the Ensemble
Controller.

Trapsink Registration for Juniper Devices 31

Setting Up Juniper Devices for SNMPv2c Write Access 31
Synchronizing Alarms with Juniper Devices 32

Trapsink Registration for Juniper Devices

For the Ensemble Controller (ENC) to receive SNMP traps from Juniper devices, you must
manually enter the Ensemble Controller Server IP address in use into the NE trapsink table.
Complete these steps to start trapsink registration on Juniper devices using the CLI or Web GUI.
1. Log in to the Juniper CLI.
2. Type the configuration command: configure
3. Create a trap group, or add this group information to an existing trap group:
a. set snmp trap-group <trap_group_name> targets <ip_address>
b. set snmp trap-group <trap_group_name> version v2c
c. commit

Setting Up Juniper Devices for SNMPv2c Write

Access
First, add the relevant Ensemble Controller Server IP address to the trapsink table on the
corresponding Juniper device as described in the section Trapsink Registration for Juniper
Devices.
1. Log in to the Juniper command line interface.
2. Type the configuration command: configure
3. Create the community string with the command:
set snmp community private authorization read-write
4. To set the view, type:
set snmp community private view all

Ensemble Controller R15.3 Integration Manual - Issue: A 31

Adtran Managing Third-Party Equipment

5. To add the IP address of the Ensemble Controller, type:

set snmp community private clients <ip_address>
6. To commit the configuration, type: commit

Synchronizing Alarms with Juniper Devices

Complete these steps to configure Ensemble Controller to synchronize alarms with the Juniper
device upon discovery or upon restoring communication with the network element.
1. Navigate to the Ensemble Controller installation directory: C:\Program Files\ADVA Optical
Networking\FSP Network Manager\scripts\JuniperAlarm.config file.
2. Use FTP to transfer the file to the Juniper device.
3. Log in to the Juniper CLI.
4. Type the configuration command: configure.
5. To execute the configuration, type: load merge JuniperAlarm.config.
6. To commit the configuration, type: commit.

Processing Traps with the OSA SNMP

Proxy Agent
The Sync View Plus (SVP) application uses the OSA SNMP proxy agent to send traps with events
and alarms at the northbound interface (NBI).
For more information about SVP, see the Synchronization Management Guide.
The Ensemble Controller Server (ENC Server )receives traps that the OSA SNMP proxy agent
transmits and displays them in the GUI tab pane, Alarms and Events tables.

For details about the traps that the OSA SNMP proxy agent forwards, see these topics:

Ensemble Controller R15.3 Integration Manual - Issue: A 32

Adtran Managing Third-Party Equipment

Requirement Upon Discovery 33

System Object Identifier 33
Automatic Trapsink Registration 33
Trap Mapping 34
Trap Description 34
SnmpAdminString 39
DateAndTime 39
Devices that Support MTOSI Naming 40
Trap Example 42

Requirement Upon Discovery

For successful discovery, a computer other than the Ensemble Controller server must discover
the OSA SNMP proxy agent because the proxy agent uses port 162 to send traps. This port is the
SNMP standard trap recipient port, and only one process at a time can reserve.

System Object Identifier

The system object identifier (OID) for the OSA SNMP proxy agent can differ depending on the
operating system where you install the proxy agent.
An object identifier compilation example is shown here:

To configure the object identifier, in the fnm.properties file, edit the

com.adva.nlms.mediation.config.osaproxy.sysOID property. See the Administrator Manual.

Automatic Trapsink Registration

To support automatic trapsink registration, you must first manually configure the Windows
SNMP service accordingly.

Ensemble Controller R15.3 Integration Manual - Issue: A 33

Adtran Managing Third-Party Equipment

Trap Mapping
The mapping for traps that the OSA SNMP proxy agent sends are described here:

Data Exposed Varbind Name in Trap

AID osaTrapAdditionalText[Module]

Alarm/Event osaTrapEventType
Alarm (2,3,4,10,11)
Event (12)

Time osaTrapEventTime

Severity osaTrapPerceivedSeverity

ObjectID osaTrapCorrelatedNotifications

Ack osaTrapAcknowledgement

Alias osaTrapManagedObject
osaTrapAdditionalText[Originator IP address]
For example TESTSSU (10.12.104.3)

Text osaTrapAdditionalText[Slogan]

Module Type osaTrapAdditionalText[Equipment type]

Comment osaTrapAdditionalText

Trap Description
When Ensemble Controller generates an event log row, the software can send SNMPv2c or
SNMPv3 traps in addition to event logs in CSV format. The trap contains the data described in
Table 3. You can configure up to 5 trap sinks for each Ensemble Controller Server.
Ensemble Controller uses central trap forwarding and the northbound interface (NBI) to
straightforwardly integrate the system into other operating support systems (OSSs).
Additionally, the system uses lost-trap polling to forward events that the Ensemble
Controller Server raises. Examples of events include root-cause correlation alarms for fiber
breaks or resynchronization of current (standing) alarms.
To configure the NBI trap transmitter, see the Administrator Manual.
If the system uses multiple IP interfaces, in the fmm.properties file, you can define the source IP
address that the event reports as varbind. Use the com.adva.fnm.option.snmpNBISource
parameter for this definition. To set the snmpNBISource property, see the Administrator Manual.
Ensemble Controller supports only one generic SNMP trap. The object identifier (OID) of this trap
is iso.org.dod.internet.private.enterprise.advaMIB.products.fspNm.fspNm-
MIB.fspNmTraps.trapMibPrefix.fspNmGenericEvent (1.3.6.1.4.1.2544.1.13.1.1.0.1). The root OID of the

Ensemble Controller R15.3 Integration Manual - Issue: A 34

Adtran Managing Third-Party Equipment

objects that the generic trap supports is

iso.org.dod.internet.private.enterprises.advaMIB.products.fspNm.fspNm-
MIB.fspNmTraps.trapObjects (1.3.6.1.4.1.2544.1.13.1.1.1)
The system uses a unique number to extend the root OID of each individual object. The No.
column in this table shows this unique number.

Table 3: Supported Objects of the Generic SNMP Trap

No. Name Values Description

1 ID <counter64> A unique event identifier.

2 update true (1) An update event.

false (2) A new event.

syn (3) A synchronization event.

See Trap Structure and
Sending Sequence.

3 name See SnmpAdminString. An event acronym, for

example, LOS for loss of
signal, which Ensemble
Controller defines and
might differ from the alarm
name defined in the local
product MIB. We
recommend that you see
only the Ensemble
Controller alarm name to
ensure proper processing.

4 disposition <integer> Event type.

arm (1) - alarm raised
clr (2) - alarm cleared
trn (3) - network evnt
sec (4) - security evnt
sys (5) - system evnt

5 severity <integer> Event severity.

informational (1)
critical (2)
major (3)
minor (4)
warning (5)

Ensemble Controller R15.3 Integration Manual - Issue: A 35

Adtran Managing Third-Party Equipment

No. Name Values Description

6 impairment <integer> Indicates whether the

serviceAffecting (1) alarm is potentially service
nonServiceAffecting (2) affecting (SA) or not (NSA).
serviceAffectingInstall (3)
serviceAffectingActivate (4)

7 disabled true (1) Shows if the alarm is

false (2) disabled that is, inhibited
(2) or not (1).

9 elementName See SnmpAdminString. The name of the affected

network topology element,
which is the device name
by default or link name in
case of LL-F-TCA, LL-B-TCA,
and FIBER alarms.
NOTE: For LL-F-TCA, LL-B-
TCA, and FIBER alarms, the
system combines them to
one alarm on the NBI.

Ensemble Controller R15.3 Integration Manual - Issue: A 36

Adtran Managing Third-Party Equipment

No. Name Values Description

10 neIpAddress See SnmpAdminString. The network element IP

address.

11 entity See SnmpAdminString. A unique name of the

managed entity that the
event is related to, for
example, the Access
Identifier (AID). The AID is
specific to the network
element type.

12 location <integer> Identifies the location

none (0) associated with the
both (1) particular information that
farEnd (2) is relative to the entity
nearEnd (3) object.
notApplicable (4)

13 direction <integer> The direction of the data

none (0) flow to that the event is
bidirectional (1) related to.
bothDirections (2)
notApplicable (3)
receiveDirectionOnly (4)
transmitDirection Only (5)
unidirectional (6)

14 nmsTime See DateAndTime. The time of detection or

notification reception by
the Ensemble
Controller Server using the
ENC Server time zone.

15 neTime See DateAndTime. The time of detection by the

network element using the
ENC Server time zone;
nmsTime if not available.

16 description See SnmpAdminString. Device-specific message

that contains additional
information about the
event context.

17 acknowledged true (1) Shows if the event is

false (2) acknowledged or not by an
operator, that is,
acknowledged (1) or not (2).

Ensemble Controller R15.3 Integration Manual - Issue: A 37

Adtran Managing Third-Party Equipment

No. Name Values Description

18 corr <integer> Indicates whether the event

redundant (1) is a primary event or root
primary (2) cause (2), or a redundant
event (1), which another
event causes. This value
applies only to alarms.

19 corrRef <counter64> If cor = 1 (redundant), this

field indicates the ID of the
root cause event.
Otherwise, this field is zero. If
the value is unavailable –1 is
given.

20 mtosiNeType See SnmpAdminString. The MTOSI-compatible

network element type
string.

21 serviceName See SnmpAdminString. Name of the service that

the trap is related to. More
precisely, the name of the
logical network resource, for
example, connection.

22 customerName See SnmpAdminString. Name of the customer that

the trap is related to.

23 security true (1) If true, a security alarm or

false (2) event occurred.

24 comment <string> Displays the user comment

associated with an alarm.

25 eventType none (0) Displays the event type

communications (1) associated with the alarm
qos (2) or event.
processing (3)
equipment (4)
environmental (5)

26 physLocation See SnmpAdminString. Displays the physical

location attribute of the
alarm or event.

27 entityAlias See SnmpAdminString. Shows an alternative,

customized entity name
(alias) that the network
element reveals.

Ensemble Controller R15.3 Integration Manual - Issue: A 38

Adtran Managing Third-Party Equipment

SnmpAdminString
An SNMP admin string is an octet string that contains administrative information, preferably in
human-readable form. For internationalization purposes, this information uses the ISO/IEC IS
10646-1 character set encoded as an octet string. The string uses the UTF-8 transformation
format described in [RFC2279].
The 10646 standard is amended over time. For this reason, you must prepare to implement any
code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid
UTF-8 encoding of a code point or are outside this range are prohibited.
We recommend that you avoid the use of control codes, and if necessary to represent a new
line, use the CR LF sequence. Also avoid the use of white space at the beginning or end of a
code sequence
For code points that the UI hardware or software do not directly support, you can provide an
alternative means of entry and display.

Encoding in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII

encoding.

UTF-8 can require multiple bytes to represent a single character / code point. For that reason,
the length of this object in octets differs from the number of characters encoded. Similarly, size
constraints are based on the number of encoded octets, not the number of characters the
encoding represents.

l If the software uses this TC for an object that is used or envisioned as an

index, you must specify a SIZE restriction. This requirement is necessary so
that the number of sub-identifiers for any object instance does not exceed
the limit of 128, as defined by [RFC1905].
l The size of an SnmpAdminString object is measured in octets, rather than in
characters.

DateAndTime
The date-time trap displays in hexadecimal format. This table lists:
l The specification of the date-time trap based on the date-time format YY YY MM DD HH MM
SS DS.
l The decimal fields, and range and symbols if you convert the hexadecimal format to the
decimal format.

Hexadecimal Decimal Decimal Range or Content

Octet Field Symbol

1-2 1 0 to 65536 YY YY - year in network byte

order.

Ensemble Controller R15.3 Integration Manual - Issue: A 39

Adtran Managing Third-Party Equipment

Hexadecimal Decimal Decimal Range or Content

Octet Field Symbol

3 2 1 to 12 MM - month

4 3 1 to 31 DD - day

5 4 0 to 23 HH - hour

6 5 0 to 59 MM - minutes

7 6 0 to 60 SS - seconds
Use 60 for leap-
seconds.

8 7 0 to 9 DS - deci-seconds

9 8 +/ – Direction from UTC.

10 9 0 to 13 Hours from UTC.

Daylight Saving Time in New
Zealand is +13.

11 10 0 to 59 Minutes from UTC.

For example, the date and time 27.01.2022 07:47:03.3 displays as this hexadecimal format: 07 E6
01 1B 07 2F 03 03. In decimal format, the date and time is 2022 01 27 07 47 03 03.

If only local time is available, the time zone information in the fields 8 to 10 is not
present.

Devices that Support MTOSI Naming

These devices support MTOSI naming:
l FSP 150CCf-825
l FSP 150CC-GE201
l FSP 150CC-GE201SE
l FSP 150-XG210
l FSP 150CM
l FSP 150CP
l FSP 150EG-X
l FSP 3000R7

Ensemble Controller R15.3 Integration Manual - Issue: A 40

Adtran Managing Third-Party Equipment

l HN400
l HN4000

Ensemble Controller R15.3 Integration Manual - Issue: A 41

Adtran Managing Third-Party Equipment

Trap Example
This table outlines a trap example:

Position Varbind Name Varbind Description Example Ensemble Controller

Type Support

1 osaTrapManagedObject OCTET Equipment or TESTSSU Alias

STRING communication For example, TESTSSU
server name as (10.12.104.3)
defined in the
SyncView
database.

2 osaTrapEventType INTEGER Alarm event type 12 Alarm (2, 3, 4, 10, 11)

according to X.733. Event (12)

3 osaTrapEventTime OCTET Event time stamp 2012-05-03 10:46:16 Time

STRING coming from the
source of the alarm.

4 osaTrapSpecificProblem INTEGER Corresponds to the 1705 not applicable

SyncView alarm ID.

5 osaTrapPerceivedSeverity INTEGER The event severity 4 Severity

according to X.733.

6 osaTrapProbableCause INTEGER Alarm probable 64 alarmConditionType

cause according to (internal ID)
X.733.

Ensemble Controller R15.3 Integration Manual - Issue: A 42

Adtran Managing Third-Party Equipment

Position Varbind Name Varbind Description Example Ensemble Controller

Type Support

7 osaTrapNotificationId INTEGER Corresponds to 1265 not applicable

SyncView alarm
number.

8 osaTrapCorrelatedNotifications INTEGER The same ID is used 10316 objectID (internal ID)

whenever the alarm
or event is emitted,
cleared, or
acknowledged.

9 osaTrapAcknowledgement INTEGER The corresponding 2 Ack

alarm is
acknowledged.

10 osaTrapAdditionalText OCTET (optional) Clock class changed, Text - Slogan

STRING Slogan PTP-8- AID - Module
Module A,6,149.133.41.146,5551 Module Type - Equipment
Equipment type, Type
Alarm source IP Alias - Originator IP
address, Comment -
Enterprise SNMP ID, osaTrapAdditionalText
Resend trap flag
(audit trap only).

Ensemble Controller R15.3 Integration Manual - Issue: A 43

Adtran About the CSV North Bound Interface

Chapter 3
About the CSV North Bound
Interface
This chapter describes the Ensemble Controller CSV northbound interface.

CSV Change History 44

Interface Configuration and Setup 68
CSV Event NBI 70
CSV Inventory NBI 75
CSV Quality Compliance NBI 107
CSV Performance NBI 111

CSV Change History

This section details changes that were made to respective CSV reports or log files in a certain
release.
See these topics, each representing a release:

Changes in Release 8.4 45

Changes in Release 8.5 47
Changes in Release 9.1 49
Changes in Release 9.2 51
Changes in Release 9.3 53
Changes in Release 9.4 55
Changes in Release 9.6 55
Changes in Release 10.1 56
Changes in Release 10.2 62
Changes in Release 10.3 62
Changes in Release 11.1 62
Changes in Release 11.3 62

Ensemble Controller R15.3 Integration Manual - Issue: A 44

Adtran About the CSV North Bound Interface

Changes in Release 12.1 62

Changes in Release 12.3 63
Changes in Release 13.1 63
Changes in Release 14.2 67
Changes in Release 14.3 67
Changes in Release 15.1 67
Changes in Release 15.2 67

Changes in Release 8.4

These topics discuss the CSV reports and log file changed for release 8.4.5 in comparison to
8.3.2.

Inventory Report 45
Resource Report 45
Performance Log File 46

Inventory Report
For a general description of the inventory report file, see Inventory Report.
The changes in the resource report refer to these values of certain product types:

Product Type Report Column Value (changed to)

FSP 150CC-GE20x1 Module Type PSU

Location 1-1

Resource Report
For a general description of the resource report file, see Resource Report.

1. The x stands for the variants of this product time ending differently, for example FSP 150CC-GE201SE or FSP
150CC-GE206.
Ensemble Controller R15.3 Integration Manual - Issue: A 45
Adtran About the CSV North Bound Interface

The changes in the resource report refer to the entities supported per product type:

An overview of the entities supported per product type is provided in the User Manual, About the
Resources CSV File.
The resource report entities consist of additional information fields providing even more details
specifically of that entity.
The following table lists the information fields that were added in this release to certain entities
with respect to the product type:

Product Type Entity Information Fields

Ethernet LAG_Flow Existing:

Performance Log File

For a general description of the performance log file, see the section CSV Performance NBI.

Ensemble Controller R15.3 Integration Manual - Issue: A 46

Adtran About the CSV North Bound Interface

The changes in the performance log file refer to these values of certain performance
monitoring (PM) layers:

PM Layer Log File Value Comment

Column (changed to)

ESA Probe Multi COS Missing object for ESA Y.1731 is

available again.

Entities ESA-Probe-[esaName]- l Redundant ESA probe

MEP-[DestMEPID]-COS[N] entities removed for Y.1731
l Only MEP-COS ESA probes
are reported.

Changes in Release 8.5

These topics discuss the CSV reports and log file changed for release 8.5.1 in comparison to
8.4.5.

Inventory Report 47
Service Inventory Report 47
Resource Report 48
Performance Log File 49

Inventory Report
For a general description of the inventory report file, see the section Inventory Report.
The changes in the inventory report refer to these values of certain product types:

Product Type Report Column Value (changed to)

FSP 150-GE11x1 SHELF-1-1

Shelf Name
FSP 150CC-GE20x1

FSP 150EG-X Shelf Module Name

Shelf Name FSP 150EG-X

Service Inventory Report

For a general description of the service inventory report file, see the section Service Inventory
Report.

1. The x stands for the variants of this product time ending differently.
Ensemble Controller R15.3 Integration Manual - Issue: A 47
Adtran About the CSV North Bound Interface

To the service inventory report, row no. 34 and 35 have been added as illustrated in this graphic:

Resource Report
For a general description of the resource report file, see the section Resource Report.
The changes in the resource report refer to the entities supported per product type:

Ensemble Controller R15.3 Integration Manual - Issue: A 48

Adtran About the CSV North Bound Interface

Product Type Entity Information Fields

Ethernet ESA Existing:

Performance Log File

For a general description of the performance log file, see the section CSV Performance NBI.
The changes in the performance log file refer to these values of certain performance
monitoring (PM) layers:

PM Layer Log File Column Value (changed to)

ESA Probe Rcvd LM/DM samples Yes/No

Ethernet Port PBB Multicast Frames Discarded PBB Multicast Frames Discarded
(PBBGRPBDAD) (PBBGRPBDAB)

Changes in Release 9.1

This table outlines the changes made for release 9.1.1 regarding the northbound interface (NBI).

Change Description NBI Affected

Semicolon ";" as Semicolon ";" appears now as delimiter in the CSV

delimiter in Description column instead of comma ",".
Description
column for
alarms and
events

Ensemble Controller R15.3 Integration Manual - Issue: A 49

Adtran About the CSV North Bound Interface

Change Description NBI Affected

Service tree 1. Column Service – only presents top-level Service

mapping and services Inventory Report
service layer In the Service column entries only present top-
information level services1. Intermediate- or bottom-level
updated service names do not appear in this column.
See column no. 4

2. Column Service – ‘generic service names’ are

replaced by ‘top-level service names’
In the Service column any generic service
name is replaced by the top-level service
associated with the service found in the service
name column. Generic service names
removed are for example Optical Channel
Service, ODU2 Trail, ...

3. Column Service – top-level services do not

include OMS or OTS
In the Service column the top-level services
(specified by point 1) do not include OMS or OTS.
Although they might be top-level (without any
supported service), OMS and OTS are not
wanted in the inventory as long as they are not
supporting another service. If they support
another service, they are included under the
respective top-level service.

4. Column Service – column renamed to ‘Top-

level Service’
The Service column is renamed to 'Top-level
Service' to reflect the changes specified in
points 1 to 3.
See column no. 4

5. Column Type – only presents service type

names or is <empty>
The Type column only contains service type
names or is <empty>. Service layer names are
not included.
See column no. 21

1. Top-level services are all services that are not supporting any other. ODS for example is always top-level.
The notion of top-level is derived from the Services tab in the tree pane.
Ensemble Controller R15.3 Integration Manual - Issue: A 50
Adtran About the CSV North Bound Interface

Change Description NBI Affected

6. Column Service Layer – numbers are replaced

by service layer names
The Service Layer column contains service
layer names (as in the GUI) instead of numbers.
See column no. 30

7. New column 'Supported Service' –

representation of tree structure
A new column 'Supported Service' is introduced
to mimic the service tree structure. This column
contains the name of the supported service
next in the hierarchy or is <empty> for a top-
level service.
If there are multiple services supported, only
the ones with same top-level service are
considered. If then still multiple services are
supported, the respective row is duplicated as
needed to cover all supported services.
See column no. 40

Header update ReportingEntity1|Ack|Source|Severity|Time| Security Report

for security and ServiceImpairment|TroubleCauseCorrelation|
fault report Description|
(node and NE) Node contains xpath style value: //Network/ETH
Devices/XG210

l Fault Report with overview grouping Fault Report

Changes in Release 9.2

This table outlines the changes made for release 9.2.1 regarding the northbound interface (NBI).

1. 'ReportingEntity' replaces Subnet and Network header in the security report.

2. 'NE' replaces Network header in the fault report.
Ensemble Controller R15.3 Integration Manual - Issue: A 51
Adtran About the CSV North Bound Interface

Change Description NBI Affected

New NE types for FSP The NE_Type or Product Type attribute presents Inventory
1500 more detailed information about the FSP 1500 Report
variant involved. Resource
See column no. 3 for an example. Report

Header extensions in Entity: Flow Resource

Entity: Access Port

Ensemble Controller R15.3 Integration Manual - Issue: A 52

Adtran About the CSV North Bound Interface

Change Description NBI Affected

CSV event log file "NE_Name" is replaced by "Element_Name". CSV Alarm

update See column no. 16. NBI

Changes in Release 9.3

This table outlines the changes made for release 9.3.1 regarding the northbound interface (NBI).

Change Description NBI Affected

CSV File Transfer Added the reports supporting CSV file transfer Inventory Report
to the section Enabling the CSV File Transfer. Performance
Monitoring Reports
PTP Remote Slaves
Report
Sync Topology
Report

New Report File Added the Identification Key and Identification Inventory Report
Values Value to the inventory report description.
See column no. 37 and 38.

Added these values to the service inventory Service Inventory

report: Report
l Secure State
l Start VLAN Tag
l End VLAN Tag
l Start Tag Control
l End Tag Control
l Intermediate VLAN IDs

Added "Outer VLAN tag A to Z" and "Outer VLAN Topology Report
tag Z to A" to the topology report.

New Report Added descriptions for Link Loss Report and PTP Link Loss Report
Descriptions Remote Slaves Report. PTP Remote Slaves
Report

Ensemble Controller R15.3 Integration Manual - Issue: A 53

Adtran About the CSV North Bound Interface

Change Description NBI Affected

Header Entity: Flow Resource Report

Entity: Access Port

Entity: Network Port

CSV event log file "NE_Name" is replaced by "Element_Name". CSV Alarm NBI
update See column no. 16.

Ensemble Controller R15.3 Integration Manual - Issue: A 54

Adtran About the CSV North Bound Interface

Changes in Release 9.4

This table outlines the changes made for release 9.4.1 regarding the northbound interface (NBI).

Change Description NBI Affected

CSV Event Log Added "Event_Type" and "Physical_Location" to the CSV Alarm NBI
File Update event log file.
See column numbers 25 and 26.

Inventory Added "Provisioned Module Type" and "Equipped CSV Inventory NBI
Report File Module Type" to the inventory report.
Update See column numbers 39 and 40.

Changes in Release 9.6

These tables outline the changes made for release 9.6.1 regarding the northbound interface
(NBI).

Table 4:
Inventory Report Update
Change Description NBI Affected

Inventory Added these parameters to the inventory CSV Inventory

Report File report: NBI
Update l SI2_ShelfIndex
l SI3_SlotIndex
l SI4_SubSlotIndex
l Alias
l NELocation
l Country of Origin

Ensemble Controller R15.3 Integration Manual - Issue: A 55

Adtran About the CSV North Bound Interface

Table: Entity AID Change for GE20x, GE110 ProVM

Changes in Release 10.1

These topics discuss the changes made of the northbound interface (NBI) in release 10.1.1.

Link Loss Report 56

Resource Reports 57
Event and Alarm Log Files 60

Link Loss Report

The Link Loss Report has been extended by these columns:
l Threshold_dB
l TCA_Forward_Status
l TCA_Backward_Status

Ensemble Controller R15.3 Integration Manual - Issue: A 56

Adtran About the CSV North Bound Interface

Resource Reports
For a general description of the resource report file, see the section Resource Report.
The changes in the resource report refer to the entities supported per product type:

Entity Object Type Header Information Fields Contained in

PTP_FLOW l Slave Clock [Admin State|Operational l Ethernet Port

Ensemble Controller R15.3 Integration Manual - Issue: A 57

Adtran About the CSV North Bound Interface

Entity Object Type Header Information Fields Contained in

PTP_TS Telecom Slave [Admin State|Operational Root

PTP_SOOC [Admin State|Operational Telecom Slave

PTP_OCS_ [Admin State|Operational SOOC

PORT State|Secondary State|Port
Identity]

PTP_MCI l Master Clock [Admin State|Operational l Master Clock

PTP_MC_ [Admin State|Operational MCI

VIRTUAL_ State|Secondary State]
PORT

PTP_MC Master Clock [Admin State|Operational Root

State|Secondary State|Alias|Clock
Identity|Timing Source|PTP
Profile||PTP Domain
Number|Priority 1| Priority 2]

PTP_BC Boundary Clock [Admin State|Operational Root

Ensemble Controller R15.3 Integration Manual - Issue: A 58

Adtran About the CSV North Bound Interface

Entity Object Type Header Information Fields Contained in

PTP_CLOCK l Grand Master [Admin State|Operational Root

PTP_TC Transparent Clock [Admin State|Operational Root

State|Secondary State|Clock
Identity|Alias|Delay Mechanism]

PTP_TC_ [Admin State|Operational Transparent

PORT State|Secondary State|Port Clock
Identity]

PTP_PORT [Admin State|Operational PTP Clock

Ensemble Controller R15.3 Integration Manual - Issue: A 59

Adtran About the CSV North Bound Interface

Event and Alarm Log Files

This table outlines the configuration changes for CSV event and alarm logs in the log4j.properties file.

Old Configuration (9.6.x) New Configuration (10.1.1)

Configuration log4j.properties log4j.properties log4j2.xml

File

Enable/ Disable Logging

Default log4j.logger.CSVEventLogger <Logger

(disabled) =off, csveventlog name="CSVEventLogger"
level="off" additivity="false" >

Event Logging log4j.logger.CSVEventLogger <Logger

=on, csveventlog name="CSVEventLogger"
level="on" additivity="false" >

Event & Alarm log4j.logger.CSVEventLogger log4j.logger.CSVAlarmLogger <Logger

Logging =on, csveventlog, csvalarmlog =on, csvalarmlog name="CSVEventLogger"
level="on" additivity="false" >

Configuration

Event Log log4j.appender.csveventlog.MaxFileSize <Appender

=1mb name="csveventlog" …
log4j.appender.csveventlog.MaxBackupIndex <DefaultRolloverStrategy
=10 max="10" />
<SizeBasedTriggeringPolicy
size="1mb" />
</Appender>

Ensemble Controller R15.3 Integration Manual - Issue: A 60

Adtran About the CSV North Bound Interface

Old Configuration (9.6.x) New Configuration (10.1.1)

Configuration log4j.properties log4j.properties log4j2.xml

File

Alarm log (has log4j.appender.csvalarmlog.MaxFileSize log4j.appender.csvalarmlog.MaxFileSize

not changed!) =1gb =1gb
log4j.appender.csvalarmlog.MaxDays log4j.appender.csvalarmlog.MaxDays
=90 =90

Ensemble Controller R15.3 Integration Manual - Issue: A 61

Adtran About the CSV North Bound Interface

Changes in Release 10.2

This section outlines the changes made for release 10.2.1 regarding the northbound interface
(NBI).

Entity AID Change 62

Discontinuation of the Additional Alarm Log File 62

Entity AID Change

Table: Entity AID Change for GE201, GE201SE, GE206, GE206F, GE206V

Discontinuation of the Additional Alarm Log File

Creating an additional alarm log file using the log4j2.xml file has been abolished and replaced
by the Archiving Events described in the User Manual.

Changes in Release 10.3

The CSV north bound interface (NBI) additionally supports these devices:
l OSA 5430
l OSA 5440

Changes in Release 11.1

With release 11.1.1, Ensemble Controller no longer supports the Sun Solaris operating system.

Changes in Release 11.3

The CSV north bound interface (NBI) additionally supports the FSP 150-XG118Pro-SH, AC and DC
devices.

Changes in Release 12.1

The Service Inventory Report changed as follows:
Ensemble Controller R15.3 Integration Manual - Issue: A 62
Adtran About the CSV North Bound Interface

l Updated the Top-level Service description.

l Added the Layer Protocol and NI CP Object columns.

Changes in Release 12.3

The CSV north bound interface (NBI) additionally supports the OSA 3350 device. Device changes
show in:
l The NBI trap transmitter including MIB definition updates (FSP-NM-MIB).
l The Eventlog.csv – See CSV Event NBI for details.
l The Inventory Report.csv – See Inventory Report for details.
l The Fault Report.csv.

Changes in Release 13.1

This section describes the north bound interface changes for the release 13.1.

Inventory Report Extension 63

FSP 3000 C Access Identifier Changes 64

Inventory Report Extension

The Inventory Report has the additional columns Vendor Code, CLEI Code, and Unique Serial
Identifier (USI).

Ensemble Controller R15.3 Integration Manual - Issue: A 63

Adtran About the CSV North Bound Interface

FSP 3000 C Access Identifier Changes

This table shows the mapping for the FSP 3000 C access identifier (AID) format changes. The AID is based on the format as presented in the FSP 3000
C Network Element Director user interface.

Entity New AID Structure New AID Example Old AID

Example

Shelf Shelf-<sid> Shelf-1 SHELF-1

Card Module-<sid>/<cid> l Module-1/4 l MOD-1-4

l Module-1/ecm-1 l MOD-1-ECM-1

Plug Plug-<sid>/<cid>/<port> Plug-1/5/n1 PL-1-5-N1

PTP Port-<sid>/<cid>/<port> l Port-1/5/c l PTP-1-2-C

l Port-1/5/n1 l PTP-1-5-N1

OPTL OpticalLane-<sid>/<cid>/<port>/<lane> OpticalLane-1/1/c1/2 PTP-1-1-C1-

OPTL-2

CTP l <facid>-<sid>/<cid>/<port>/<facid> OMS-1/7/n/oms CTP-1-7-N-OMS

Interface l <facid2>-<sid>/<cid>/<port>/<facid1>/<facid2>
Transport OTSiA-7/4/n/oms/otsia-196000000 CTP-7-4-N-
Data Lane OMS-OTSIA-
Facility 196000000

OTU4-1/1/c1/otu4 CTP-1-1-C1-OTU4

ODU4-1/1/c1/otu4/odu4 CTP-1-1-C1-
OTU4-ODU4

Ensemble Controller R15.3 Integration Manual - Issue: A 64

Adtran About the CSV North Bound Interface

Entity New AID Structure New AID Example Old AID

Example

OL150-3/5/n1/ol150 CTP-3-5-N1-
OL150

OTSI-4/alien/2/otsi CTP-4-ALIEN-2-
OTSI

SNC Connection-<sid>/<cid>/<fac>/<snc> Connection-1/1/odu4/1 SNC-1-1-ODU4-1

GTP Port-Group-<sid>/<cid>/<port> Port-Group-1/alien/alien-1 GTP-1-ALIEN-

ALIEN-1

CRS Connection-<sid>/<cid>/<crs> Connection-6/6/1 CRS-6-6-1

EQH Slot-<sid>/<slid> Slot-11/19 SL-11-19

PLGH Slot-<sid>/<cid>/<port> Plug-1/5/n2 PL-1-5-N2

FLTP Mux-<sid>/<cid>/<fltpid> Mux-3/5/ot300 FLTP-3-5-OT300

GCC Management-<sid>/<cid>/<port>/<facid1>/<facid2>/<gccid> Management-1/1/N1/OT100/ODU4/GCC1 Event was

reported to
parent entity
CTP-1-1-N1-
OT100-ODU4

PRTGRP Protection-<sid>/<cid>/<prt> Protection-1/5/1plus1 PROTECTION-

GROUP-1-5-
1plus1

PRTUNIT Protection-<sid>/<cid>/<prt>/<unit> Protection-1/5/1plus1/2 PROTECTION-

UNIT-1-5-1plus1-
2

Ensemble Controller R15.3 Integration Manual - Issue: A 65

Adtran About the CSV North Bound Interface

Entity New AID Structure New AID Example Old AID

Example

ALIEN External-<sid>/alien/<port> External-1/alien/1 PTP-1-ALIEN-1

TL Fiber-<endpointidA>:<endpointidB> Fiber-1/2/c10:1/2/c1 FIBER-1-2-C10:1-

2-C1

Ensemble Controller R15.3 Integration Manual - Issue: A 66

Adtran About the CSV North Bound Interface

Changes in Release 14.2

l Added the Master Clock Identity column to the PTP Remote Slaves Report.
l Made these updates to the Service Inventory Report:
o Added the columns Connectivity Service and Supporting NFCs.
o Changed descriptions of Service Name and Top-level Service.

Changes in Release 14.3

l In the PTP Remote Slaves Report, added the Grandmaster Clock Identity column.
l In the CSV Event NBI, Enabling the Event Log File, changed descriptions of Source and Service_
Name.

Changes in Release 15.1

Starting from release 15.1, the system generates the Sync Quality Compliance Report.
For information about this report, see CSV Quality Compliance NBI and its sections:
l CSV Sync Quality Compliance Report
l Report Description
l Report Naming
l Report LayoutReport Storage

Changes in Release 15.2

Starting from release 15.2, the system generates these reports:
l PTP Remote Slaves Usage Report, see PTP Remote Slaves Usage Report.
l NE Backup Report, see NE Backup Report.
l Bandwidth Utilization Report, see the User Manual, Bandwidth Utilization Report.

Ensemble Controller R15.3 Integration Manual - Issue: A 67

Adtran About the CSV North Bound Interface

Interface Configuration and Setup

This section describes how the CSV northbound interface can be configured and set up to
satisfy the needs.

Editing the CSV Format

CSV log and report files are organized in columns separated by the default pipe “|” character.
This character can be changed as appropriate by adding and/or modifying the respective
properties in the fnm.properties file.
For more information about editing the fnm.properties file, see the Administrator Manual, Editing
the fnm.properties File.

com.adva.fnm.option.CSVSeparator
This property is used to change the CSV column character into a user-defined character.
It is by default included in the fnm.properties file. You can use the search function and then
modify the property as appropriate.
This property does not apply to the CSV alarm and event log file.

com.adva.fnm.option.EventLogCSVSeparator
This property is used to change the CSV column character of the alarm and event log file into a
user-defined character.
It first has to be added to the fnm.properties file and can then be modified as appropriate, for
example: com.adva.fnm.option.EventLogCSVSeparator=;
This separates the columns of the alarm and event log file by a semicolon.

com.adva.nlms.mediation.event.CSVLogLineBreakAtEOL
This property is used to change the line break position of the alarm and event log file to the 'end
of line'. By default, the property is set to "no" and thus, the line break is at 'begin of line'.
It first has to be added to the fnm.properties file and can then be changed to the appropriate
value (yes/no).

Enabling the CSV File Transfer

Complete these steps to configure a secure file transfer protocol (SFTP) master server. This
server stores these comma-separated value (CSV) files that Ensemble Controller creates:
l Inventory Report
l Performance Monitoring Reports (see CSV Performance NBI)

Ensemble Controller R15.3 Integration Manual - Issue: A 68

Adtran About the CSV North Bound Interface

l Synchronization Manager Reports:

o PTP Remote Slaves Report
o Sync Topology Report

Ensemble Controller supports only SFTP for this feature.

Requirement to Enable the CSV File Transfer

To enable the CSV file transfer feature, in the fnm.properties file, set the property
com.adva.nlms.mediation.CSV_FILE_TRANSFER to yes. For details, see the Administrator
Manual.

Procedure to Enable the CSV File Transfer

1. In the tree pane, right-click the Network root, and then select Network Properties.
The Network Properties window opens.
2. From the left menu, select CSV File Transfer.
3. In the Active SFTP Server Settings area, edit the fields as follows:

Field Description

Host name Type the IP address of the SFTP server. Type the actual IP address of
the server, not relative addresses such as localhost or 127.0.0.1.

SFTP login Type the login user name of the SFTP server.

SFTP password Click Set, and then follow the instructions in the dialog box to specify
the password of the SFTP server. The default maximum SFTP server
password length is 64 characters. You can limit password length by
editing the com.adva.fnm.option.maxFtpPasswordLength property
in the fnm.properties file. For information about how to edit the
fnm.properties file, see the Administrator Manual. You should set the
password with a length that is supported by all devices installed in
the network.

Directory on Type the directory path. Specify the full path name:
server
l An absolute path that starts with / where / is the root of file
system.
l A relative path from your $HOME directory, for example,
mydir/backup.
l A relative path where ~ is your $HOME directory, and you use an
SFTP server, for example, ~/backup.

Test SFTP Server Click to verify the SFTP settings. A message displays to indicate
Connection whether the system accepted the SFTP settings. If not, verify your
entries for each parameter.

4. Click OK to apply your settings, or Cancel.

Ensemble Controller R15.3 Integration Manual - Issue: A 69

Adtran About the CSV North Bound Interface

CSV Event NBI

The CSV event log file is organized in columns separated by the default pipe “|” character. If
applicable, this character can be changed as described in Editing the CSV Format.
The pipe character (or its substitute) can be as well used as delimiter within fields containing
different values that need separation. In this case, the pipe character is replaced by _
(underline) every time it occurs in those fields.
Columns and Values in the Event Log File describes the meaning and value definition for each
column. The CSV file is stored in the Ensemble Controller installation directory under var/log. The
folder is created automatically.

Enabling the Event Log File

The administrator can enable the log file to be created by setting the parameter <Logger
name="CSVEventLogger" level="on" ...> to “on” in the log4j2.xml text file that is located in the
Ensemble Controller installation directory.
A time-stamped eventlog.csv file is created, which is type of an event data.

Table 5:
Columns and Values in the Event Log File
No. Name Values Description

1 ID <integer> A unique incremental ID of the

event.

2 Update Yes | No Indicates whether the record is

an update of a previously logged
event with the same ID.

3 Ack ACK | NACK Indicates whether the event has

been acknowledged by an
operator (ACK) or not (NACK).

4 Enabling ENA | DIS Indicates whether the alarm is

disabled, i.e. inhibited (DIS) or not
(ENA).

5 Source <IP address> The network element (NE) that

reports the event (empty if not
related to a NE). Can also be the
faulted service (connection) or
the source line (physical link) of
this event.

Ensemble Controller R15.3 Integration Manual - Issue: A 70

Adtran About the CSV North Bound Interface

No. Name Values Description

6 Severity Critical | Major | Minor | The event severity.

Warning | Informational

7 NMS_Time YYYYMMDDhhmmss The time of detection or

notification reception by the
Ensemble Controller Server (ENC
Server time zone).

8 NE_Time YYYYMMDDhhmmss The time of detection by the NE

(ENC Server time zone; empty if
not available).

9 Type ARM | CLR | TRN | SYS The event type:

l ARM: alarm raising event
l CLR: alarm clearing event
l TRN: transient network event
l SYS: ENC Server system event

10 Impairment SA | NSA Indicates whether the alarm is

potentially service affecting (SA)
or not (NSA).

11 Corr PRM | RDN Indicates whether the event is a

primary event or root cause
(PRM), or a redundant event
(RDN) which is caused by another
event.

12 Corr_Ref <integer> If Corr=RDN this field indicates the

ID of the root cause event;
otherwise it is zero.

13 Event <string> An event acronym, for example

“LOS” or “SWITCH”.

14 Description <string> A description of the event.

15 NE_Type <string> The network element type

(product name).

16 Element_Name <string> The name of the affected

network topology element, which
can be the device or link name.

17 Entity_Name <string> A unique name of the managed

entity which the event is related
to, for example the Access
Identifier (AID).
Example: “CH 2 7 C1”, “Net-A”

Ensemble Controller R15.3 Integration Manual - Issue: A 71

Adtran About the CSV North Bound Interface

No. Name Values Description

18 Location NE | FE | NE-FE The location of the entity which

the event is related to (relative to
#17):
l NE: near end
l FE: far end
l NE-FE: both ends
l <empty>: not applicable

19 Direction BIDIR | RX-TX | TX | UNIDIR The direction of the data flow

which the event is related to:
l BIDIR: bidirectional
l RX-TX: both directions
l RX: receive only
l TX: transmit only
l UNIDIR: unidirectional

20 Entity_Alias <string> An alternative customized entity

name (alias) as exposed by the
NE.

21 Service_ <string> The name of the connectivity

Name service (CfC or NfC).

22 Customer_ <string> The name of the customer that

Name owns the service.

23 Security true (1) | false (2) If true, a security alarm or event

occurred.

24 Comment <string> Displays the user comment

associated with an alarm.

25 Event_Type NA | COMM | QOS | PROC | The event type associated with

EQUIP | ENV the alarm/event.
l NA: not applicable
l COMM: communications
alarm type
l QOS: quality of service alarm
type
l PROC: processing error alarm
type
l EQUIP: equipment alarm type
l ENV: environmental alarm
type

26 Physical_ <string> The physical location attribute of

Location the alarm/event.

Ensemble Controller R15.3 Integration Manual - Issue: A 72

Adtran About the CSV North Bound Interface

Details on the Columns Service_Name and Customer_

Name
The columns Service_Name (no. 21) and Customer_Name (no. 22) are needed to identify
events that are only related to services or customers. Without that information, a unique key is
missing.
The operational support system (OSS) needs a unique key to identify alarms and to match raise
and clear events. The unique key normally consists of the Event (Trap-ID), the Element_Name
and the Entity_Name. There are alarms/ events that are only related to services, for example
SERV-AS-DOWN. In this case these three fields are not unique.
The Service_Name/ Customer_Name column is only set for these alarms and events:
Alarms:
l SERV-AS-DOWN
l DATA-SERV-AS-DOWN
l SERV-N-AFFECTED
l SERV-C-AFFECTED
l SERVICE-M-RING-MD

Events:
l "S-SERV"
l "S-STATE"
l "S-OWNER"
l "S-SERTEST"
l "S-PROT"
l "S-ENCRYPT"
l "SERV_NIS"
l "SERV_OK"
l "SERV_FAULTED_C_AFFECTED"
l "SERV_FAULTED_N_AFFECTED"
l "SERV_DEGRADED_C_AFFECTED"
l "SERV_DEGRADED_N_AFFECTED"

Some services associated with these events, do not show in the event log file
because the system considers them as event log irrelevant information. For
information about the event-associated services, in the Alarms or Events tab,
see the Service column as this figure shows:

Ensemble Controller R15.3 Integration Manual - Issue: A 73

Adtran About the CSV North Bound Interface

CSV <Heart Beat> Event

The Ensemble Controller (ENC) creates the regular event <Heart Beat> for different northbound
interfaces (CSV, SNMP, and MTOSI) to indicate that the Ensemble Controller Server is still up and
running.
Table 6 outlines the <Heart Beat> event properties of the CSV alarm NBI. These properties are not
supported: <Enabling>, <Source>, <NE_Time>, <Corr_Ref>, <NE_Type>, <Element_Name>, <Entity_
Name>, <Location>, <Direction>, <Entity_Alias>, <Service_Name>, <Customer_Name>, <Security>,
<Comment>, <Event_Type> and <Physical_Location>.
For information about the <Heart Beat> event varbinds of the SNMP alarm NBI, see SNMP <Heart
Beat> Event. For the MTOSI alarm NBI, see MTOSI <Heart Beat> Event.
For more general information about the <Heart Beat> event, see Using the Ensemble Controller
Heartbeat.

Table 6: Columns and Values in the <Heart Beat> Event Log File
No. Name Values Description

1 ID 0 A unique incremental ID of the event.

2 Update Yes Indicates whether the record is an

update of a previously logged event
with the same ID.

3 Ack ACK Indicates whether the event has

been acknowledged by an operator
(ACK) or not (NACK).

6 Severity Informational The event severity.

7 NMS_Time YYYYMMDDhhmmss The time of detection or notification

reception by the Ensemble
Controller Server (Ensemble
Controller Server time zone).

Ensemble Controller R15.3 Integration Manual - Issue: A 74

Adtran About the CSV North Bound Interface

No. Name Values Description

9 Type SYS The event type:

l ARM: alarm raising event
l CLR: alarm clearing event
l TRN: transient network event
l SYS: Ensemble Controller Server
system event

10 Impairment NSA Indicates whether the alarm is

potentially service affecting (SA) or
not (NSA).

11 Corr PRM Indicates whether the event is a

primary event or root cause (PRM),
or a redundant event (RDN) which is
caused by another event.

13 Event "HEART-BEAT" An event acronym, for example “LOS”

or “SWITCH”.

14 Description "ENC Heart Beat" A description of the event.

CSV Inventory NBI

The CSV inventory northbound interface (NBI) provides reports that are created according to
the settings in the recurring actions.
For information about how to generate reports by means of the recurring actions, see the User
Manual.
This section contains these topics for details about the CSV inventory NBIs:

Report Storage 76
Report Layout 76
Bandwidth Utilization Report 76
Inventory Report 76
Link Loss Report 84
NE Backup Report 87
Power Consumption Report 88
PTP Remote Slaves Report 89
PTP Remote Slaves Usage Report 92
Resource Report 93
Service Inventory Report 96
Sync Topology Report 102

Ensemble Controller R15.3 Integration Manual - Issue: A 75

Adtran About the CSV North Bound Interface

Topology Report 106

Report Storage
The Ensemble Controller (ENC) installation var\pm directory stores the reports in a comma
separated value (CSV) format, except of the Resource Report. The Resource Report is stored
under var\resources\*.csv.
The software automatically creates the respective folders (csv/resources) and the initial
CSV file at the same time.

l For a 32bit Windows OS, the default ENC installation directory is C:\Program
Files\ADVA Optical Networking\FSP Network Manager.
l For a 64bit Windows OS, the default ENC installation directory is C:\Program
Files (x86)\ADVA Optical Networking\FSP Network Manager.
l For a Linux OS, the default ENC installation directory is opt/adva/fsp_nm.

Report Layout
The CSV reports are organized in columns separated by the default pipe | character. If
applicable, you can change this character as described in Editing the CSV Format.
By default, the pipe character also serves as a delimiter in fields where different values need
separation. Double quotes enclose these and other fields that contain special characters , for
example ...|...|... .

Bandwidth Utilization Report

For information about bandwidth utilization report, see the User Manual, Bandwidth Utilization
Report.

Inventory Report
Inventory reports are named according to this format:
Network_<date>.csv where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for example
Network_2008-07-29 17.25.47.csv.

Report Details Regarding FSP 3000R7 Passive Units

The inventory report provides one row for each module.
For FSP 3000R7 passive units, two rows display. You can ignore the rows that do not show a
Module Name value. Otherwise, these row characteristics apply:
l The value for Shelf Module Name is the passive unit AID.
l The value for Module Type and Shelf is the same and is the type of the passive unit.

Ensemble Controller R15.3 Integration Manual - Issue: A 76

Adtran About the CSV North Bound Interface

l The value for Serial Number and Shelf Serial Number is the same and is the serial number of
the passive unit.
l Passive units do not have a firmware and thus no FW Revision value displays.

Table 7 describes the meaning and value definition for each column in the inventory report.

Table 7: Columns and Values in the Inventory Report File

No. Name Values Description

2 NE <string>(<IP address>) The network element

name and IP address.

3 Product Type FSP 150CCf-825 Indicates the product

FSP 150CC type.
FSP 150CM
FSP 150CP
FSP 150EG-M4
FSP 150EG-M8
FSP 150EG-X
FSP 150-GE
FSP 150-GO
FSP 150Mx
FSP 150-XG
FSP 150-XJ
FSP 500
FSP 1500
FSP 2000
FSP 3000
FSP 3000R7
HN400
HN4000

4 NEMI_SW_ <string> The NEMI/ NCU

Version software version.

Ensemble Controller R15.3 Integration Manual - Issue: A 77

Adtran About the CSV North Bound Interface

No. Name Values Description

5 Module Name <string> The AID of the

module, as reported
in the Shelf List in
Chassis window or in
the PDF Inventory
Report.

6 Module Type <string> The content of the

column <Type>, used
by the GUI and the
column <Module
Type>, used by the
PDF Inventory Report.

7 Order Info <string> The Adtran part

number for each
module.

8 Channel <string> The channel of the

module, for example
“D14”.

9 Protection n/a | Unprotected | Indicates whether the

West | East module is protected
(West or East),
Unprotected or n/a if
it is not applicable for
the module (filter).

101 Name <string> The module name.

11 Clock <string> The configured clock

data rate, for
example “OTU1”, “STM-
16”, “GbE”.

12 Installed At YYYY-MM-DD hh:mm:ss The date and time

when the module
was installed, for
example “2007-02-20
11:29:20”

13 HW Revision <string> The hardware

revision.

1 The 'Name' parameter (No. 10) or the context of it can change or disappear in a future release. We
recommend that you do not consider it for designs.
Ensemble Controller R15.3 Integration Manual - Issue: A 78
Adtran About the CSV North Bound Interface

No. Name Values Description

14 FW Revision <string> The firmware revision.

15 SW Revision <string> The software revision.

16 Serial Number <string> The serial number.

17 Assignment Assigned | Free The assignment of

the module.

18 Service Name <string> The name of the

service associated to
the module.

19 Custom Field <string> Additional

information entered
in the custom field.

20 Custom Subnet <string> Additional

Field information entered
in the custom subnet
field.

21 Location <string> The physical position

of the modules, for
example, Rack-Shelf-
Slot, Shelf-Slot, or Slot.

22 Rack <string> The index of the rack

containing the
module.

23 Shelf <string> The AID of the shelf,

as used in the
Shelves tab or in the
PDF Inventory Report.

24 Shelf HW Revision <string> The hardware

revision of the shelf,
as used in the PDF
Inventory Report.

25 Shelf Serial <string> The serial number of

Number the shelf, as used in
the Shelves tab or in
the PDF Inventory
Report.

Ensemble Controller R15.3 Integration Manual - Issue: A 79

Adtran About the CSV North Bound Interface

No. Name Values Description

26 Shelf Module <string> A short description of

Name the shelf.

27 Shelf Module <string> The description of the

Type1 shelf.

28 Shelf Name <string> The shelf name.

29 Shelf Installed At YYYY-MM-DD hh:mm:ss The date and time

when the shelf was
detected, as used in
the Shelves tab.

30 Shelf Assignment Assigned|Free The assignment of

the shelf.

31 Shelf Order Info <string> The Adtran part

number for each
shelf.

32 Admin State The administrative

state of the module.

33 Operational Values depend on the NE The operational state

State type outlined in Table 8 of the module.

34 Secondary State2 The secondary state

(s) of the module.

35 User Text <string> User-defined

information that is
typed in the
respective fields in
the NE Properties
36 User Description <string>
window in the
Ensemble Controller
GUI.

37 Identification Key IP Address | The identification key

Device Serial Number | is used to recognize
Device MAC Address the network element
in Ensemble
Controller.

1 The 'Shelf Module Type' value (No. 27) is often identical with 'Shelf Name' (No. 28).
2 The 'Secondary State' (No. 34) can contain multiple values concatenated into a single string.
Ensemble Controller R15.3 Integration Manual - Issue: A 80
Adtran About the CSV North Bound Interface

No. Name Values Description

38 Identification <string> The identification

Value value describes the
identification key (no.
37).

39 Provisioned blank|n/a|<string> The type of module

Module Type provisioned in the NE
database. The values
supported are
defined as follows:
l blank - retrieval of
the provisioned
module type
name is
supported but no
module is
provisioned
l n/a - (not
available) retrieval
of the Provisioned
Module Type for
this NE type is not
supported

40 Equipped Module blank|n/a|<string> The type of module

Type equipped in the NE
slot. The values
supported are
defined as follows:
l blank - retrieval of
the provisioned
module type
name is
supported but no
module is
detected
l n/a - (not
applicable)
retrieval of the
Equipped Module
Type for this NE
type is not
supported

Ensemble Controller R15.3 Integration Manual - Issue: A 81

Adtran About the CSV North Bound Interface

No. Name Values Description

41 SI2_ShelfIndex <string> The localization IDs of

the entity.
Example: NTE-1-2-3
42 SI3_SlotIndex <string> where 2 is the
ShelfIndex and 3 is
the SlotIndex. 1 is the
43 SI4_SubSlotIndex <string> NEIndex, which is not
reported.

44 Alias <string> The alternative name

of the entity for easier
identification.

45 NELocation <string> The physical location

of the shelf.

46 Country of Origin <string> The manufacturing

location, which is an
alphabetical code
using two capital
letters. If this value is
not available for an
object, AA displays.

47 Vendor Code <string> A unique code that

identifies the vendor.

48 CLEI Code <string> The common

language equipment
identification code,
which is a globally
unique, 10-character
alphanumeric code.

49 Unique Serial <string> A concatenation of

Identifier (USI) the serial number
and the
manufacturer code,
which uniquely
identifies the
component (shelf,
module, and so on).

Table 8 outlines the administrative state, operational state, and secondary state values (No. 32,
33, 34 of Table 7) per NE type. Some fields in the report can display the value 'N/A', which
indicates that the given field on the given NE type is not applicable.

Ensemble Controller R15.3 Integration Manual - Issue: A 82

Adtran About the CSV North Bound Interface

Table 8: Inventory Log File Values per NE Type

NE Type Admin State Operational Secondary States
State

FSP 3000R7 Unassigned Normal N/A

In Service Abnormal Unequipped
Auto In Service Outage Mismatch
Management Unavailable Supporting Entity
Maintenance Outage
Disabled Loopback
Signaling Auto Locked-Out
Forced ON
Facility Failure
Equipment Fault
Active
Standby Hot
PROTN Switch Inhibited
WKG Switch Inhibited
Diagnostic
Busy
Idle
Rx Idle
Tx Idle

FSP 1500 (all variants) In-Service N/A (not applicable)

Up Up
Down Down
Testing Testing
Unknown
Dormant

FSP 150CCf-825 Unknown Normal (not applicable)

In-Service Outage
Management Testing
Maintenance Unknown
Disabled Dormant
Unassigned Not Present
Link Down

Ensemble Controller R15.3 Integration Manual - Issue: A 83

Adtran About the CSV North Bound Interface

NE Type Admin State Operational Secondary States

State

FSP 150-GE112 Unknown Unknown Active

FSP 150-GE114 In-Service Normal Automatic-In-Service
FSP 150-GE114H Management Outage Facility Failure
FSP 150-GE114PH Maintenance Fault
FSP 150-GE114S Disabled Loopback
FSP 150-GE114SH Unassigned Maintenance
FSP 150CC-GE201 Mismatched Equipment
FSP 150CC-GE201SE Standby Hot
FSP 150CC-GE206 Supporting Entity
FSP 150CC-GE206F Outage
FSP 150CC-GE206V Unassigned
FSP 150CC-SP Unequipped
FSP 150CC-T1804 Disabled
FSP 150CC-T3204 Forced offline
FSP 150-XG210 Initializing
FSP 150CM-HUB Protocol
FSP 150EG-X
FSP 150-XG116Pro
FSP 150-XG120Pro
FSP 150-XG120Pro-SH

FSP 150EG-M4 In-Service Normal N/A

FSP 150EG-M8 Maintenance Outage

FSP 150Mx Up Up (not applicable)

Down Down
Testing Testing
Link Down Unknown
N/A Dormant
Not Present
Link Down

Other devices not N/A N/A (not applicable)

mentioned In-Service Normal
separately Management Outage
Maintenance
Disabled
Unassigned

Link Loss Report

The link loss report contains information on all the links where you enabled the Link Loss
Management feature. You can generate the report either manually as described in the WDM
Management Guide, Creating Link Loss Reports. , or as recurring action as described in the User
Manual, Specifying Recurring Actions.

Ensemble Controller R15.3 Integration Manual - Issue: A 84

Adtran About the CSV North Bound Interface

Naming
Link loss reports are named according to this format:
LinkLossReport_<date>.csv where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for example
LinkLossReport_2013-03-28 8.39.47.csv.
Table 9 describes the meaning and value definition for each column in the link loss report.

Table 9:
Columns and Values in the Link Loss Report File
No. Names Values Description

1 Link Name <string> The name of the link.

2 Start Subnetwork <string> The name of the network and

higher network where the Start
Network Element is located
separating the higher layer
networks by backslashes, for
example \Germany\Berlin.

4 End Subnetwork <string> The name of the network and

higher network where the End
Network Element is located
separating the higher layer
networks by backslashes, for
example \Germany\Berlin.

Ensemble Controller R15.3 Integration Manual - Issue: A 85

Adtran About the CSV North Bound Interface

No. Names Values Description

6 Timestamp last <DD/MM/YY hh:mm> The most recent timestamp of the

measurement 8 measurement timestamps taken
into account to calculate the link
losses.

7 Link Loss Start NE -> <positive integer> The most recent calculated fiber
End NE loss of the link in dB related to the
fiber carrying traffic from the start
network element towards the end
network element.

8 Link Loss End NE -> <positive integer> The most recent calculated fiber
Start NE loss of the link in dB related to the
fiber carrying traffic from the end
NE towards the start NE.

9 Timestamp <DD/MM/YY hh:mm> The most recent time stamp of the

reference 8 measurement timestamps taken
into account to calculate the
reference link losses.

10 Reference Link Loss <positive integer> The calculated fiber loss in the
Start NE -> End NE reference data set of the link in dB
related to the fiber carrying traffic
from the start NE towards the end
NE.

11 Reference Link Loss <positive integer> The calculated fiber loss in the
End NE -> Start NE reference data set of the link in dB
related to the fiber carrying traffic
from the end NE towards the start
NE.

Ensemble Controller R15.3 Integration Manual - Issue: A 86

Adtran About the CSV North Bound Interface

No. Names Values Description

12 Comment Last <text> Messages related to the collection

Measurement and calculation of the most recent
link losses of this link.

13 Threshold [dB] <string> Value for given link.

14 TCA Forward Crossed | OK | N/A Threshold crossing alert status per

Status link direction.

15 TCA Backward
Status

NE Backup Report
The NE backup report contains information about the time and result of backup of all network
elements that belong to a specific subnetwork.
You can generate the report as recurring action as described in the User Manual per the whole
network or per subnet. The system does not support the NE backup report on the network
element level.

Report Naming
The name of NE backup report uses this format:
NEBackup_<date> where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for example
NEBackup_2023-07-06 12.13.16. The system automatically stores this report in the FSP Network
Manager directory var\csv. You can download and open the report both in PDF and CSV format.
Table 10 describes the meaning and value definition for each column in the CSV NE backup
report. Each row represents a single NE that belongs to a relevant subnetwork, and the
information about its last backup. The report in PDF format has the same fields.

Table 10:
Columns and Values in the CSV NE Backup Report File
No. Names Values Description

1 Subnetwork <string> The identification of the

name sunetwork that contains the
monitored network elements.

2 NE IP address <string> The IP address of the network

element.

3 NE name <string> The name of the network

element.

Ensemble Controller R15.3 Integration Manual - Issue: A 87

Adtran About the CSV North Bound Interface

No. Names Values Description

4 Time of last <DD.MM.YYYY hh:mm> The time of the last backup.

backup

5 Result of last <string> The result of the last backup:

backup success or failure.

Power Consumption Report

Power consumption report provides information on network elements daily power consumption
of the last 30 days or less, depending on the available data in the database.
You can generate the report as recurring action as described in the User Manual, Specifying
Recurring Actions.

Naming
Power consumption reports are named according to this format:
Power Consumption Report_<date>.csv where <date> is in the format “YYYY-MM-DD hh.mm.ss”,
for example Power Consumption Report_2015-04-28 8.39.47.csv.

Report Description
This table describes the meaning and value definition for each column in the report.

Table 11: Columns and Values in the Power Consumption Report File
No. Names Values Description

1 Subnet name <string> The identification of the

subnetwork that contains the
monitored network elements.

2 NE IP address <string> The IP address of the network

element.

3 NE name <string> The name of the network

element.

4 Date <YYYY.MM.DD The time of the measurement.

hh:mm:ss.s>

5 Power <integer> The network element daily

consumption power consumption.

Ensemble Controller R15.3 Integration Manual - Issue: A 88

Adtran About the CSV North Bound Interface

PTP Remote Slaves Report

The PTP remote slaves report contains information about PTP remote slaves . The masters report
these entities, which are located on non-restricted network elements.
You can generate the report either manually as described in the Synchronization Management
Guide, or as recurring action as described in the User Manual.

Report Naming
The name of PTP remote slaves report use this format:
PTP Remote Slaves Report_<date> where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for
example PTP Remote Slaves Report_2015-04-28 8.39.47. You can download this report as a PDF
or CSV file.
Table 12 describes the meaning and value definition for each column in the CSV PTP remote
slaves report. Each row represents a single remote slave. The report in PDF format has the same
fields but differently arranged.

Table 12:
Columns and Values in the CSV PTP Remote Slaves Report File
No. Names Values Description

1 Discovery Mode Static | Supported values are: L3

Dynamic Static, L3 Dynamic, L2
Dynamic.

2 Master Node <string> The name of the master sync

node that communicates with
this remote slave.

3 Entity ID <string> AID of the remote slave entity

as reported by the NE, which
contains the master node.

4 IP Address <string> IP address of remote slave (L3

only).

5 MAC Address <string> MAC address of remote slave

(L2 only).

6 Clock Identity <string> Clock identity (L3 only).

7 Port Identity <string> Port identity (L2 only).

8 Admin State In-Service | Administrative state values for

Management | FSP 3000R7 MIB.
Disabled

Ensemble Controller R15.3 Integration Manual - Issue: A 89

Adtran About the CSV North Bound Interface

No. Names Values Description

9 Operational State <string> Operational state values for

FSP 3000R7 MIB.

10 Secondary State <string> Secondary state values for FSP

3000R7 MIB.

11 Time Created YYYYMMDDhhmmss The time that the agent

created this remote slave.

12 Alias <string> The alternative name of the

remote slave.

13 Master <string> The identification of the

Subnetwork subnetwork that contains the
NE with the master node,
which reports this remote
slave.

14 Master NE <string> The identification of the NE

that contains the master
node, which reports this
remote slave.

15 Master MCI <string> AID of the master MCI entity

that communicates with this
remote slave - relevant for
G.8265.1 and enterprise profile
(L3 Dynamic).

16 Master PTP Port <string> AID of the PTP port entity that
communicates with this
remote slave - relevant for
default profile (L2) only.

17 Sync Message 1_PacketPerSecond | Sync message rate of the

Rate 2_PacketsPerSecond | static remote slaves - relevant
4_PacketsPerSecond | only for the G.8265.1 profile.
8_PacketsPerSecond |
16_PacketsPerSecond |
18 Delay Response Delay response message rate
32_PacketsPerSecond |
Message Rate of the static remote slaves -
64_PacketsPerSecond |
128_PacketsPerSecond | relevant only for the G.8265.1
None profile.

Ensemble Controller R15.3 Integration Manual - Issue: A 90

Adtran About the CSV North Bound Interface

No. Names Values Description

19 Announce 1_PacketPer16Seconds | Announce message rate of

20 Sync Negotiated <string> Negotiated lease duration of

Lease Duration(s) sync messages in seconds -
relevent only for the G.8265.1
profile.

21 Delay Response <string> Delay response messages

Negotiated Lease negotiated lease duration in
Duration(s) seconds - relevant only for the
G.8265.1 profile.

22 Announce <string> Announce messages

Negotiated Lease negotiated lease duration in
Duration(s) seconds - relevant only for the
G.8265.1 profile.

23 Slave Node <string> The name of the managed

slave node.

24 Master Slot <string> The name of the slot that

contains the PTP card. This
card serves as the PTP master
that communicates with this
remote slave. This slot is
relevant only for devices with
multiple PTP card options, for
example OSA 5548c.

25 Master Clock <string> PTP clock identity of the

Identity master clock.

Ensemble Controller R15.3 Integration Manual - Issue: A 91

Adtran About the CSV North Bound Interface

No. Names Values Description

26 Grandmaster <string> PTP clock identity of the grand

Clock Identity master clock.
Consider these facts:
l If a Boundary Clock reports
the remote slave, the value
must be taken from the
active slave port
Grandmaster identity
attribute.
l If a Master Clock reports the
remote slave, the value is
the master clock identity
attribute.

PTP Remote Slaves Usage Report

The PTP remote slaves usage report contains information about the usage of all PTP remote
slaves in the system, per master that is connected at the time when you generate the report.
You can generate the report as recurring action as described in the User Manual.

Report Naming
The name of PTP remote slave usage reports use this format:
PTPRemoteSlavesUsage_<date> where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for
example PTPRemoteSlavesUsageReport_2023-07-06 12.13.16. The system automatically stores
this report in the FSP Network Manager directory var\csv.
Table 13 describes the meaning and value definition for each column in the CSV PTP remote
slaves usage report. Each row represents a single master that serves the slaves network, and
the remote slaves usage information.. The report in PDF format has the same fields but
differently arranged.

Table 13:
Columns and Values in the CSV PTP Remote Slaves Usage Report File
No. Names Values Description

1 Master NE <string> The identification of the NE that

contains the master clock that
is monitored.

2 Master Node <string> The name of the master sync

node.

Ensemble Controller R15.3 Integration Manual - Issue: A 92

Adtran About the CSV North Bound Interface

No. Names Values Description

3 Master Clock <string> PTP clock identity of the master

Identity clock.

4 Max Slaves <integer> The maximum number of slave

licenses that are configured for
this master.

5 Used Slaves <integer> The total number of active

remote slaves that the system
currently reports for the master,
on all master interfaces.

6 Used Slaves % <integer> The current percentage of used

slaves out of total available
licenses for the master.

7 Free Slaves <integer> The current number of free

slave licenses for the master.

8 Free Slaves % <integer> The current percentage of free

slave licenses for the master.

9 Threshold % <integer> The percentage of the

configured threshold for the
master. The system raises an
alarm when the used slaves %
value exceeds this threshold.

10 Utilization State Normal | Utilization state values:

Alarmed l normal for used slaves %
lower than or equal to the
threshold %
l alarmed for used slaves %
higher than threshold %

11 TCA Supressed TRUE | Configuration of TCA alarms

FALSE supression.

Resource Report
Resource reports are named according to this format:
Resource_<date>.csv where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for example
Resource_20140210_093523.csv.
They are stored in the Ensemble Controller installation directory under var\resources\*.csv. The
resources folder is created automatically with the first CSV file.
Table 14 describes the meaning and value definition for each column in the resource report.

Ensemble Controller R15.3 Integration Manual - Issue: A 93

Adtran About the CSV North Bound Interface

Table 14: Columns and Values in the Resource Report File

No. Name Values Description

1 Subnet <string> The network name or IP

address and the path to the
network of the entry node in the
network, for example, Network/
FSP3000R7, FSP 3000R7 is the
network name.

2 NE <string>(<IP address>) The network element name

and IP address.

3 Product Type FSP 150CCf-825| Indicates the product type.

4 Entities <string> Indicates the port, module, link,

or shelf of the resource.

5 Alias <string> Indicates the alternative name

for the resource.

6 Admin State Values depend on the NE The administrative state of the

type outlined in Table 15 resource.

7 Operational The operational state of the

State resource.

8 Secondary The secondary states of the

State1 resource.

Depends on the resources of a given port for a network element, the resource
report may contain additional columns.

Table 15 outlines the administrative state, operational state and secondary state values (No. 6, 7,
8 of Table 14) per network element type.

1 The 'Secondary State' (No. 8) can contain multiple values concatenated into a single string.
Ensemble Controller R15.3 Integration Manual - Issue: A 94
Adtran About the CSV North Bound Interface

Table 15: Resource Log File Values per NE Type

NE Type Admin State Operational Secondary States
State

FSP 3000R7 Unassigned Normal N/A1

FSP 1500 (all variants) In-Service N/A1 (not applicable)

Up Up
Down Down
Testing Testing
Unknown
Dormant

FSP 150CCf-825 Unknown Normal (not applicable)

In-Service Outage
Management Testing
Maintenance Unknown
Disabled Dormant
Unassigned Not Present
Link Down

1 The value 'N/A' indicates that the given field on the given NE type is not applicable.
Ensemble Controller R15.3 Integration Manual - Issue: A 95
Adtran About the CSV North Bound Interface

NE Type Admin State Operational Secondary States

State

FSP 150-GE112 Unknown Unknown Active

FSP 150EG-M4 In-Service Normal N/A

FSP 150EG-M8 Maintenance Outage

FSP 150Mx Up Up (not applicable)

Down Down
Testing Testing
Link Down Unknown
N/A1 Dormant
Not Present
Link Down

Other devices not N/A1 N/A1 (not applicable)

mentioned In-Service Normal
separately Management Outage
Maintenance
Disabled
Unassigned

Service Inventory Report

Service inventory reports are named according to this format:
Services_<date>.csv where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for example
Services_2013-03-28 8.39.47.csv.

1. The value N/A indicates that the given field on the given NE type is not applicable.
Ensemble Controller R15.3 Integration Manual - Issue: A 96
Adtran About the CSV North Bound Interface

Table 16 describes the meaning and value definition for each column in the service inventory
report.

Table 16: Columns and Values in the Service Inventory Report File
No. Names Values Description

1 Customer <string> The owner of this service.

2 Service Group <string> The complete path to the

service group from the
customer, with folder names
enclosed in { ... } brackets.

3 Connectivity <string> The name of the connectivity

Service service (CfC or NfC) if there is
one associated with the
connection. Only the top-level
connection shows this.

4 Top-level Service <string> The name of the connectivity

service which all supporting
connections will be grouped.
The column name
TopLevelService is legacy.

5 Service Name <string> The actual name of the

connection (trail, and so on).

6 Service Alternate <string> An alternate name assigned

Name to this service.

7 Layer Protocol <string> The (short) name of the layer

protocol of the connection.

8 Supporting NFCs <string> List of supporting NfCs. Only

connections associated with
CfCs show this.

9 Start TP NE <string> The name of the network

element where the service
originates.

10 End TP NE <string> The name of the network

element where the service
terminates.

11 Start TP Module <string> The AID of the working module

Working where the service originates.

12 Start TP Port <string> The AID of the working port

Working where the service originates.

Ensemble Controller R15.3 Integration Manual - Issue: A 97

Adtran About the CSV North Bound Interface

No. Names Values Description

13 End TP Module <string> The AID of the working module

Working where the service terminates.

14 End TP Port Working <string> The AID of the working port

where the service terminates.

15 Start TP Module <string> The AID of the protected

Protected module where the service
originates.

16 Start TP Port <string> The AID of the protected port

Protected where the service originates.

17 End TP Module <string> The AID of the protected

Protected module where the service
terminates.

18 End TP Port <string> The AID of the protected port

Protected where the service terminates.

19 Interm Modules <"string"> The AID of the intermediate

Working modules in the working path.
To separate different values,
this field starts and ends with
double quotes, for example
("...|...|...").

20 Interm Modules <"string"> The AID of the intermediate

Protected modules in the protected path.
To separate different values,
this field starts and ends with
double quotes, for example
("...|...|...").

21 Type <string> The service type as shown in

the Services tab, Service Type
field in the Ensemble Controller
GUI.

22 Admin State Up | Down | The administrative state of the

Maintenance service.

23 Setup Mode Track Mode | Provision How this service was

Mode provisioned.

Ensemble Controller R15.3 Integration Manual - Issue: A 98

Adtran About the CSV North Bound Interface

No. Names Values Description

24 Protection Type Unprotected | Channel The protection scheme used

25 Restoration Enabled | Disabled When restoration is enabled,

this service is revertive for both
protected and unprotected
tunnels.

26 Remarks <string> Additional information

regarding this service.

27 Channel <string> The wavelength naming

convention if this service is an
optical channel.

28 Optical Channel <string> The name of the service when

this service is actually an
optical channel service (OCS).

29 Impairment Enabled | Disabled Indicates whether optical

Calculation impairment is enabled.

Ensemble Controller R15.3 Integration Manual - Issue: A 99

Adtran About the CSV North Bound Interface

No. Names Values Description

30 Service Layer <string> Indicates the layer of the

particular service or trail:
l ADM Trail (ADM)
l Client Protection Trail
(CTRAIL)
l Ethernet Data Service (EDS)
l Ethernet Service Trail
(ETRAIL)
l Network Service Trail
(NTRAIL)
l ODU0 Trail (ODU0)
l ODU1 Trail (ODU1)
l ODU2 Trail (ODU2)
l ODU2E Trail (ODU2E)
l ODU3 Trail (ODU3)
l ODU4 Trail (ODU4)
l Optical Channel (OCH)
l Optical Channel Service
(OCS)
l Optical Data Service (ODS)
l Optical Multiplex Section
(OMS)
l Optical Transport Section
(OTS)
l OTU Trail (OTU)

31 Reversion None | Manual | Auto When Reversion is set to

“None”, the service has no
nominal paths. In “Manual”
mode, reversion to nominal
paths is done manually. In
“Auto” mode, the NE performs
the reversion to nominal paths
automatically.

32 Handover Enabled | Disabled Indicates whether service is

defined as handover.

33 NI CP Object <string> Control Plane (distributed)

tunnel name.

34 Ring Type Sub Ring | Major Ring Indicates whether the service
belongs to a complete (major)
ring or to a sub ring.

35 Ring Id <string> The ring identification number

to which the service belongs.

Ensemble Controller R15.3 Integration Manual - Issue: A 100

Adtran About the CSV North Bound Interface

No. Names Values Description

36 VLAN Tag <string> The VLAN identification

number.

38 ESA TCA Status OK | Crossed | N/A The status of the ESA probe,
which is reflected according to
the 'threshold crossing alert'
(TCA) that is reported against
the particular ESA probe. These
values are supported:
l OK, when no TCA is received
during the interval
l Crossed, when at least one
TCA is received during the
interval
l N/A, when no ESA probe is
assigned to the service

39 Supervision Entities <string> The list of associated ESA

probes to the service.

40 Supported Service <string> The name of the supported

service next in the hierarchy or
<empty> for a top-level
service.

41 Secure State secureNormal | Indicates the encryption status

secureBlocked | of the service.
unsecureNormal |
unsecureBlocked

42 Start VLAN Tag Tag-Priority List of VLANs of starting entity

Example: 666-* separated by space.

43 End VLAN Tag Tag-Priority List of VLANs of ending entity

Example: 43-* separated by space.

Ensemble Controller R15.3 Integration Manual - Issue: A 101

Adtran About the CSV North Bound Interface

No. Names Values Description

44 Start Tag Control CTagControl:Tag-Prio Tag controls of starting entity.

STagControl:Tag-Prio
Example: None None

45 End Tag Control CTagControl:Tag-Prio Tag controls of ending entity.

STagControl:Tag-Prio
Example: Push:43-0
None

46 Intermediate VLAN NEName: Entity_AID Indicates all VLAN

IDs (CTagControl:Tag-Prio modifications for intermediate
STagControl:Tag-Prio): entities.
VLANs
Example:
FSP 150-GE114Pro (CSH):
FLOW-1-1-1-3-1 (None
None): 77-*

47 Start Termination <string> The alias of the port where the

service starts.

48 End Termination <string> The alias of the port where the

service ends.

Sync Topology Report

The sync topology report contains information about the synchronization topology, which is a
directed graph constructed from sync nodes and sync topology links:
l A sync node represents a discovered synchronization function such as a master, slave,
boundary clock (BC), transparent clock, and other functions supported.
l A sync topology link connects a source sync node (master or BC) to a destination sync node
(slave or BC). A link can be active or inactive. An inactive link is considered a protected link.

Sync topology reports cannot be viewed through the Ensemble Controller GUI or generated in
the “Reports” tab. To enable or disable the generation of a topology report, see the User Manual,
Specifying Recurring Actions.

Nodes and Links Supporting the Sync Topology Report

The sync topology report is supported by ‘precision time protocol’ (PTP) nodes/ links including
G.8265.1 to G.8275.1 and vice versa.
Anything regarding SyncE is not supported that is, SyncE nodes/ links, hybrid SyncE to PTP or PTP
to SyncE topology links.

Ensemble Controller R15.3 Integration Manual - Issue: A 102

Adtran About the CSV North Bound Interface

Naming
Sync topology reports are named according to this format:
SyncTopology_<date>.csv where <date> is in the format “YYYY-MM-DD hh.mm.ss”, for example
SyncTopology_2015-04-28 8.39.47.csv.

Report Details
Each row in the report corresponds to a single topology link providing this information:
l source sync node with its related entities and statuses
l destination sync node with its related entities and statuses
l link status

In case a sync node is not part of any topology link, it is reported as a missing topology link
without any information about the destination sync node or link statuses.
Table 17 describes the meaning and value definition for each column in the report.

Table 17: Columns and Values in the Sync Topology Report File
No. Names Values Description

1 Source Sync Node <string> The name of source sync node

in this sync link, for example:
BC-1-1@DC1

2 Source Sync Node ok | degraded | failed The status of the source sync
Status node in this link. This status is
calculated by the Ensemble
Sync Director according to the
sync node type.

3 Source Sync Node na | gray | green | yellow The health indication of the
Health | red source sync node in this link.
Health is calculated based on
Syncjack tests, which currently
monitor this master node
function.

4 Source Link Entity <string> The AID of the device entity on

the source NE side, which
enables this link, for example an
MCI-1-1-1 entity, which
represents the master entity for
this connection.

Ensemble Controller R15.3 Integration Manual - Issue: A 103

Adtran About the CSV North Bound Interface

No. Names Values Description

5 Source NE Type <string> The type of NE containing the

source sync node function, for
example OSA 5410.

6 Source NE connected | Indicates whether there is an

Connectivity disconnected SNMP connectivity with the
Status source NE at the time of the
report.

7 Destination Sync <string> The name of destination sync

Node Remark: This value is node in this sync link, for
empty in case the example:
source sync node is not TS-1-1@C1.
connected to any other
sync node.

8 Destination Sync ok | degraded | failed The status of the destination

Node Status Remark: This value is sync node in this link. This status
empty in case the is calculated by the Ensemble
source sync node is not Sync Director according to the
connected to any other sync node type.
sync node.

9 Destination Sync na | start | normal | The clock frequency recovery

Node CR State freerun | holdover | state as reported by the device
acquisition | transient for the slave side. In case this
Remark: value is available, it is used in
the calculation of the slave or
l This value is empty in
boundary clock node status
case the source sync
together with the phase
node is not
recovery (PR) state.
connected to any
other sync node.
l This value is empty in
case the destination
node is not a PTP
slave function, for
example transparent
clock.

Ensemble Controller R15.3 Integration Manual - Issue: A 104

Adtran About the CSV North Bound Interface

No. Names Values Description

10 Destination Sync na | start | normal | The clock phase recovery state

Node PR State freerun | holdover | as reported by the device for
acquisition | transient the slave side. In case this value
Remark: is available, it is used in the
calculation of the slave/BC
l This value is empty in
node status together with the
case the source sync
clock recovery (CR) state.
node is not
connected to any
other sync node.
l This value is empty in
case the destination
node is not a PTP
slave function, for
example transparent
clock.

11 Destination Sync na | gray | green | yellow The health indication of the

Node Health | red destination sync node in this
Remark: This value is link. Health is calculated based
empty in case the on Syncjack tests, which
source sync node is not currently monitor this slave
connected to any other node function, and in case the
sync node. feature is supported, self
diagnostic of the slave.1

12 Destination Link <string> The AID of the device entity on

Entity Remark: This value is the destination NE side, which
empty in case the enables this link, for example an
source sync node is not SOOC-1-1-1 entity, which
connected to any other represents the slave entity for
sync node. this connection.

1. For a PTP Slave (or BC) function that is found on a device and is supporting Syncjack, the slave function is
able to monitor its own health by reporting a score from 3 to 5 (3 = bad, 4 = warning, 5 = good). This score is
the result of the slave self-monitoring capability.
l If the device that contains the slave function supports Syncjack, the Destination Sync Node Health is
based on the most severe health composed of:
o Self-monitoring health score from slave.
o Health of all Syncjack tests that are running on the slave device or on other devices, which are
currently running and monitoring the slave function.
l If the device that contains the slave function does not support Syncjack, the Destination Sync Node
Health is based only on the most severe health that is, the health of all Syncjack tests that are running
on the slave device or on other devices, which are currently running and monitoring the slave
function.
Ensemble Controller R15.3 Integration Manual - Issue: A 105
Adtran About the CSV North Bound Interface

No. Names Values Description

13 Destination NE <string> The type of NE containing the

Type Remark: This value is destination sync node function.
empty in case the
source sync node is not
connected to any other
sync node.

14 Destination NE connected | Indicates whether there is an

Connectivity disconnected SNMP connectivity with the
Status Remark: This value is destination NE at the time of
empty in case the the report.
source sync node is not
connected to any other
sync node.

15 Link Status Active | Non-Active An active link is a clock signal

Remark: This value is currently used by the slave to
empty in case the recover the clock.
source sync node is not
connected to any other
sync node.

Topology Report
The topology report contains a list of all physical fibers in the network with their endpoints.
Topology reports can be viewed through the Ensemble Controller GUI or generated through the
“Reports” tab. To enable or disable the generation of a topology report, see the User Manual,
Specifying Recurring Actions. To manually generate a topology report, see the User Manual,
Reports Tab.

Report Details
Each row of the topology report corresponds to a fiber, while these columns provide more
details on each fiber. The columns are separated by the default pipe “|” character. If applicable,
this character can be changed as described in Editing the CSV Format.
l Node A - The name of the source NE. If a name is unavailable, the corresponding IP address is
specified.
l Port A - The entity within the source NE to which the link is connected. For an FSP 3000R7 NE,
this is an Optical Link (OL). If the entity is unknown, this column is left empty.
l Node Z - The name of the destination NE. If a name is unavailable, the corresponding IP
address is displayed.
l Port Z - The entity within the destination NE to which the link is connected. For an FSP 3000R7
NE, this is an OL. If the entity is unknown, this column is left empty.
l Line Name - A label assigned by the user or the auto-discovery process.

Ensemble Controller R15.3 Integration Manual - Issue: A 106

Adtran About the CSV North Bound Interface

l Outer VLAN tag A to Z - indicates the outer VLAN tags from the source NE to the destination NE.
l Outer VLAN tag Z to A - indicates the outer VLAN tags from the destination NE to the source NE.

Pairs of protected links or cloud-rendered links are included in the same way as other links, too
and are not marked as such.

To modify the format of the names used for Port A and Port Z, set
com.adva.nlms.mediation.config.Use_MTOSI_Naming in the fnm.properties
file to the desired value.

Devices Supporting MTOSI Naming

These devices support MTOSI naming:
FSP 150CCf-825
FSP 150CC-GE201
FSP 150CC-GE201SE
FSP 150-XG210
FSP 150CM
FSP 150CP
FSP 150EG-X
FSP 3000R7
HN400
HN4000

CSV Quality Compliance NBI

The CSV quality-compliance northbound interface (NBI) provides reports that the system
creates according to the settings in the recurring actions. To generate reports through recurring
actions, see the user manual.
This section contains these topics about the CSV Sync Quality Compliance Report:

CSV Sync Quality Compliance Report 107

CSV Sync Quality Compliance Report

After you enable the Sync Quality Compliance Report in the recurring actions, Ensemble
Controller generates the report. The minimum time range and default value to generate this
report as a systematic action is 1 day. The maximum time range is 4 weeks. See the User Manual.
The CSV Sync Quality Compliance Report contains information about offset summary
compliance status of selected PTP, NTP or system clocks. This information are per SoftSync
device network element compared against configured thresholds.
Requirements to Generate the Report
l Deploy and configure the Streaming Network Telemetry (SNT) service. For details, see the
Administrator Manual.

Ensemble Controller R15.3 Integration Manual - Issue: A 107

Adtran About the CSV North Bound Interface

l Configure Streaming Telemetry subscriptions in the PTP Assurance Settings window, see the
Synchronization Management Guide.
l Deploy SoftSync devices that the Ensemble Controller manages to obtain data about and
include in report.
l Specify the fnm. properties file with these properties:
o com.adva.nlms.mediation.report.sync.quality.compliance.clock.ref
o com.adva.nlms.mediation.report.sync.quality.compliance.threshold.degraded.ns
o com.adva.nlms.mediation.report.sync.quality.compliance.threshold.failed.ns
You must specify the threshold parameters if you enable the recurring action in the Sync
Quality report. Otherwise, an error message displays.
For details about the properties, see the Administrator Manual.

These topics contain details about the naming, description, layout, and storage of the CSV Sync
Quality Compliance Report:

Report Naming 108

Report Description 108
Report Layout 109
Report Storage 110

Report Naming
Ensemble Controller names the Sync Quality Compliance Report according to the format
SyncQualityCompliance<date>.csv.
The name includes these elements:

Name Element Description

SyncQualityCompliance The report-type identification.

<date> The date format in the filename corresponds to yyyyMMDD_

HHmm, for example, SyncQualityCompliance20220428_
1400.csv.

Report Description
Table 18 describes the meanings and value definitions for each Sync Quality Compliance
Report column.

Ensemble Controller R15.3 Integration Manual - Issue: A 108

Adtran About the CSV North Bound Interface

Table 18:
Columns and Values in the CSV Sync Quality Compliance Report
No. Name Values Description

1 NE Address <string> The IP address of the host or network

element that the system monitors.

2 NE Name <string> The name of the host or network

element that the system monitors.

3 Compliance <string> The compliance status for the host or

Status NE. To determine this status, the
process compares the maximum
absolute offset for the NE referenced
clock with the configured offset
thresholds:
l Ok = Max abs offset did not cross
any threshold.
l Degraded = Max abs offset crossed
degraded threshold but did not
cross failed threshold.
l Failed = Max abs offset crossed the
failed threshold.
l NA = No data found for that host or
NE for entire report period.

4 Max Abs Offset integer Maximum captured absolute offset in

nano seconds for that host or NE over
the report period.

5 Max Offset integer Maximum captured offset in nano

seconds for that host or NE over the
report period.

6 Min Offset integer Minimum captured offset in nano

seconds for that host/NE over the
report period.

7 Avg Offset integer Average offset in nano seconds for

that host or NE over the report period.

Report Layout
The Sync Quality Compliance Report log file is organized in columns separated by the default
pipe | character. If applicable, you can change this character as described in Editing the CSV
Format.

Ensemble Controller R15.3 Integration Manual - Issue: A 109

Adtran About the CSV North Bound Interface

By default, the pipe character also serves as a delimiter in fields where different values need
separation. Double quotes enclose these and other fields that contain special characters , for
example ...|...|... .
This table lists the report structure.

Line Content

1 Contains the name of report and its exact time of creation in this format: #
SyncQualityCompliance<date>.csv, created on <date_time>
l The SyncQualityCompliance<date>.csv has the same format as the report
name. See Report Naming.
l The date_time is the actual time when the Ensemble Controller server creates
the report, including the seconds. The format is YY-MM-DD hh:mm:ss.

2 Contains the time range for the report in this format: # Time Range
From:<yyyyMMDD_HHmm> To: <yyyyMMDD_HHmm>

3 Contains the configured thresholds for the report, in this format: # Offset
Thresholds(ns) Degraded:<deg offest in ns> Failed:<failed offset
in ns>

4 Contains the configured clock references for the report, in this format: # Clock
Reference: PTP | NTP | System Clock

5 Is empty.

6 Contains the column names. See Report Description.

Report Storage
The Ensemble Controller (ENC) installation var\pm directory stores the Sync Quality
Compliance Report in CSV format. The software automatically creates this folder and the initial
CSV file at the same time.

Cleanup of Earlier Stored Report Files

The com.adva.nlms.mediation.performance.CSVvalidTime property that you configure in
the fnm.properties file controls the automatic cleanup of previous report files. These rules
control the cleanup:
l When you enable the recurring action Sync Quality Compliance Report, the software already
deleted all sync quality compliance report files stored in the var\pm folder. This deletion
process also includes sync performance generated files, even if the recurring action Sync
Performance Report is disabled.
l If you disable the recurring action Sync Quality Compliance Report, the software does not
generate report files and performs no cleanup.

Ensemble Controller R15.3 Integration Manual - Issue: A 110

Adtran About the CSV North Bound Interface

CSV Performance NBI

The CSV performance northbound interface (NBI) provides reports that are created according
to the settings in the recurring actions.
For information about generating reports by means of the recurring actions, see the User
Manual.
See these topics describing specifics of the performance reports supported by Ensemble
Controller (ENC):

Report Layout 111

Report Storage 111
Cleanup of Old Report Files Stored 111
Performance Report 112
Sync Performance Report 115

Report Layout
The CSV performance log file is organized in columns separated by the default pipe | character.
If applicable, you can change this character as described in Editing the CSV Format.
By default, the pipe character also serves as a delimiter in fields where different values need
separation. Double quotes enclose these and other fields that contain special characters , for
example ...|...|... .

Report Storage
The Ensemble Controller (ENC) installation var\pm directory stores the report in CSV format. The
software automatically creates this folder and the initial CSV file at the same time.

Cleanup of Old Report Files Stored

The com.adva.nlms.mediation.performance.CSVvalidTime property that you configure in
the fnm.properties file controls the automatic cleanup of previous report files. These rules
control the cleanup:
l When you enable the recurring action Performance Data Export (Short Term), the software
already deleted all sync quality compliance report files stored in the var\pm folder. This
deletion process also includes sync performance generated files, even if the recurring action
Sync Performance Report is disabled.
l If you disable the recurring action Performance Data Export (Short Term), but Sync
Performance Report is enabled, then the system deletes only the sync performance related
files.
l If you disable both recurring actions, Performance Data Export (Short Term) and Sync
Performance Report, the system generates no report files and performs no cleanup.

Ensemble Controller R15.3 Integration Manual - Issue: A 111

Adtran About the CSV North Bound Interface

Performance Report
If you enable the Performance Collection recurring action, Ensemble Controller generates CSV
performance log files for each layer that you select in the performance template.

Report Naming 112

Report Description 114

Report Naming
Ensemble Controller names the CSV performance log files according to these formats:

Report Type Name Format

Short-term report (1 minute) pmDump<layer><date>_<time>.csv

Short-term report (15 minutes) pmDump<layer><date>_<time>.csv

Long-term report (24 hours) pmDump<layer><date>.csv

The name includes these elements:

Name Element Description

pmDump The report-type identification.

<layer> Corresponds to one of these performance monitoring layers in the

performance template:
l Aggregate Layer

l Defect Seconds
l DSx

l Encrypted Service Performance

l ESA Probe
l Ethernet Port
l Ethernet Port High Speed

l Flow Ethernet

l Generic Round Trip Delay Measurement

l GFP Sublayer Service Performance
l GFPFR Sublayer Service Performance
l GFPT Service Performance

Ensemble Controller R15.3 Integration Manual - Issue: A 112

Adtran About the CSV North Bound Interface

Name Element Description

l LAG Shaper
l Legacy DS3
l Legacy DS1
l Legacy OCN
l Legacy Sonet Link
l Legacy Sonet Path
l Legacy Sonet Section
l Legacy Sonet VT

l Network Element

l OCn/STM
l ODU Performance
l ODU Tandem Connection Performance (Instance A)
l ODU Tandem Connection Performance (Instance B)
l ODU Tandem Connection Performance (Instance C)
l OTU FEC Performance
l OTU Performance

l Performance Layer Instant

l Physical Layer Availability
l Physical Layer Coding
l Physical Layer Coding Combined
l Physical Layer Coding High Speed
l Physical Layer Performance
l Policer Flow Ethernet
l Pseudo-Wire
l PTP-FLOW
l PTP-Probe
l PTP-SOOC

l QOS Port Ethernet

l QOS Flow Ethernet
l QOS Flow Shaper
l QOS Access Port Shaper
l QOS Network Port Shaper
l QOS Flow Policer

l Raman

l SDH/Sonet Performance (High Order Path)

l SDH/Sonet Performance (Low Order Path)
l SDH/Sonet Performance (Multiplex Section)
l SDH/Sonet Performance (Regenerator Section)
l SDH/Sonet STS/VC Path
l SDH/Sonet Vt Path
l Specific Latency Measurement

Ensemble Controller R15.3 Integration Manual - Issue: A 113

Adtran About the CSV North Bound Interface

Name Element Description

l T3/E3
l T1/E1
In the filename, the performance layer is specified without spaces, for
example, pmDumpFlowEthernet20130322_1015.csv.

<date> The date format in the filename corresponds to yyyyMMdd, for example,
pmDumpFlowEthernet20130322_1015.csv.

<time> The time format in the filename corresponds to HHmm, for example,
pmDumpFlowEthernet20130322_1015.csv.
The time element is displayed only for short-term reports (1 minute and
15 minutes).

Report Description
The performance log file includes these columns. Table 19 describes the meaning and value
definition for each column.

Table 19:
Columns and Values in the Performance Log File
No. Name Values Description

1 Connection <string> The name of the service to which

the monitored entity belongs. Can
be empty.

2 Granularity 0|15|1440|10080 The granularity of the intervals in

minutes. Zero indicates an instant
value.

3 Type <string> The performance data type.

Example: “APD Voltage”

4 Unit <string> The unit of the monitored value.

Example: “mA”.

5 Aggregation avg|max|min|other The aggregation type of the

monitored value.

6 NE <string> The network element name, for

example “GE206_102”.

7 Entity <string> A unique description of the

monitored entity. Example: “Remote
port on 2TCM-MC-HS at 1-1-6”.

Ensemble Controller R15.3 Integration Manual - Issue: A 114

Adtran About the CSV North Bound Interface

No. Name Values Description

8 Period YYYYMMDDhhmmss The time of monitoring.

9 Value <string> The monitored value.

Sync Performance Report

After you enable sync performance reports in the recurring actions, Ensemble Controller
generates them including status information about all managed and supported network
elements.
By default, a sync performance report covers these network elements:
l OSA 5401
l OSA 5405-I
l OSA 5405-MB
l OSA 5405-O
l OSA 5405-P
l OSA 5410
l OSA 5411
l OSA 5412
l OSA 5420
l OSA 5421
l OSA 5422
l OSA 5430
l OSA 5440
l OSA SoftSync

To include in the report only selected device types from the list above, your administrator or
Adtran representative must add the property
com.adva.nlms.mediation.report.sync.performance.device.types to the fnm.properties
file, and then edit it accordingly. See the Administrator Manual.

Report Naming 115

Report Description 116

Report Naming
Ensemble Controller names sync performance reports according to the format
SyncPerformance<date>_<time>.csv, which is aligned with general performance report file
naming conventions.

Ensemble Controller R15.3 Integration Manual - Issue: A 115

Adtran About the CSV North Bound Interface

The name includes these elements:

Name Element Description

SyncPerformance The report-type identification.

<date> The date format in the filename corresponds to yyyyMMdd, for

example, SyncPerformance20150428_1400.csv.

<time> The time format in the filename corresponds to HHmm, for

example, SyncPerformance20150428_1400.csv.

Report Description
The sync performance report includes these columns. Table 20 describes the meaning and
value definition for each column.

Table 20:
Columns and Values in the Sync Performance Report
No. Name Values Description

1 Connection <string> The name of the service to which

the monitored entity belongs. Can
be empty.

2 Granularity 0 The granularity of the intervals in

minutes. It is always zero indicating
an instant value.

3 Type <string> The performance data type for the

monitored entity. Example:
“Frequency QL Advertised To Next
Node”

4 Unit <string> The unit of the monitored value. It is

always empty for the current report
attributes.

5 Aggregation avg|max|min|other The aggregation type of the

monitored value.

6 NE <string> The unique network element name,

for example “OSA5410_xxx”.

7 Entity <string> A unique description of the

monitored entity. Example: “TIME
CLOCK-1-1-1-1”.

8 Period YYYYMMDDhhmmss The time of monitoring.

9 Value <string> The monitored value.

Ensemble Controller R15.3 Integration Manual - Issue: A 116

Adtran About the SNMP North Bound Interface

Chapter 4
About the SNMP North Bound
Interface
This chapter describes the SNMP northbound interface of the Ensemble Controller.

SNMP Change History 117

Trap Description 120
Resynchronization 128
SNMP MIB File 133
Service Affected Events 133
Notification Events 138

SNMP Change History

This section details changes that were made to the SNMP northbound interface (NBI) in a
certain release.

Changes in Release 9.2 117

Changes in Release 9.4 118
Changes in Release 9.6 118
Changes in Release 10.3 119
Changes in Release 11.2 119

Changes in Release 9.2

This table outlines the changes made for release 9.2.1 regarding the northbound interface (NBI).

Ensemble Controller R15.3 Integration Manual - Issue: A 117

Adtran About the SNMP North Bound Interface

Change Description NBI

Affected

SNMP event log "neName" is replaced by SNMP Alarm

file update "elementName". NBI
See column no. 9.

Changes in Release 9.4

This table outlines the changes made for release 9.4.1 regarding the northbound interface (NBI).

Change Description NBI

Affected

SNMP Trap Added "eventType" and "physLocation" to SNMP Alarm

Objects the objects table. See column numbers NBI
Update 25 and 26.

Changes in Release 9.6

This table outlines the changes made for release 9.6.1 regarding the northbound interface (NBI).

Ensemble Controller R15.3 Integration Manual - Issue: A 118

Adtran About the SNMP North Bound Interface

Table: Entity AID Change for GE20x, GE110 ProVM

Changes in Release 10.3

This table outlines the changes made for release 10.3.1 regarding the northbound interface (NBI).

Change Description NBI

Affected

SNMP Trap Added "entityAlias" to the objects table. SNMP Alarm

Objects See column number 27. NBI
Update

Changes in Release 11.2

This table outlines the changes made for release 11.2.1 regarding the northbound interface (NBI).

Ensemble Controller R15.3 Integration Manual - Issue: A 119

Adtran About the SNMP North Bound Interface

Change Description NBI

Affected

SNMP Trap Updated the description for SNMP Alarm

Objects "serviceName" and "customerName" in NBI
Update the objects table. See column number 21
and 22.

Trap Description
When Ensemble Controller generates an event log row, the software can send SNMPv2c or
SNMPv3 traps in addition to event logs in CSV format. The trap contains the data described in
Table 21. You can configure up to 5 trap sinks for each Ensemble Controller Server.
Ensemble Controller uses central trap forwarding and the northbound interface (NBI) to
straightforwardly integrate the system into other operating support systems (OSSs).
Additionally, the system uses lost-trap polling to forward events that the Ensemble
Controller Server raises. Examples of events include root-cause correlation alarms for fiber
breaks or resynchronization of current (standing) alarms.
To configure the NBI trap transmitter, see the Administrator Manual.
If the system uses multiple IP interfaces, in the fmm.properties file, you can define the source IP
address that the event reports as varbind. Use the com.adva.fnm.option.snmpNBISource
parameter for this definition. To set the snmpNBISource property, see the Administrator Manual.
Ensemble Controller supports only one generic SNMP trap. The object identifier (OID) of this trap
is iso.org.dod.internet.private.enterprise.advaMIB.products.fspNm.fspNm-
MIB.fspNmTraps.trapMibPrefix.fspNmGenericEvent (1.3.6.1.4.1.2544.1.13.1.1.0.1). The root OID of the
objects that the generic trap supports is
iso.org.dod.internet.private.enterprises.advaMIB.products.fspNm.fspNm-
MIB.fspNmTraps.trapObjects (1.3.6.1.4.1.2544.1.13.1.1.1)
The system uses a unique number to extend the root OID of each individual object. The No.
column in this table shows this unique number.

Table 21: Supported Objects of the Generic SNMP Trap

No. Name Values Description

1 ID <counter64> A unique event identifier.

2 update true (1) An update event.

false (2) A new event.

syn (3) A synchronization event.

See Trap Structure and
Sending Sequence.

Ensemble Controller R15.3 Integration Manual - Issue: A 120

Adtran About the SNMP North Bound Interface

No. Name Values Description

3 name See SnmpAdminString. An event acronym, for

4 disposition <integer> Event type.

arm (1) - alarm raised
clr (2) - alarm cleared
trn (3) - network evnt
sec (4) - security evnt
sys (5) - system evnt

5 severity <integer> Event severity.

informational (1)
critical (2)
major (3)
minor (4)
warning (5)

6 impairment <integer> Indicates whether the

serviceAffecting (1) alarm is potentially service
nonServiceAffecting (2) affecting (SA) or not (NSA).
serviceAffectingInstall (3)
serviceAffectingActivate (4)

7 disabled true (1) Shows if the alarm is

false (2) disabled that is, inhibited
(2) or not (1).

Ensemble Controller R15.3 Integration Manual - Issue: A 121

Adtran About the SNMP North Bound Interface

No. Name Values Description

8 neType <integer> Network element type.

9 elementName See SnmpAdminString. The name of the affected

10 neIpAddress See SnmpAdminString. The network element IP

address.

11 entity See SnmpAdminString. A unique name of the

managed entity that the
event is related to, for
example, the Access
Identifier (AID). The AID is
specific to the network
element type.

Ensemble Controller R15.3 Integration Manual - Issue: A 122

Adtran About the SNMP North Bound Interface

No. Name Values Description

12 location <integer> Identifies the location

none (0) associated with the
both (1) particular information that
farEnd (2) is relative to the entity
nearEnd (3) object.
notApplicable (4)

13 direction <integer> The direction of the data

none (0) flow to that the event is
bidirectional (1) related to.
bothDirections (2)
notApplicable (3)
receiveDirectionOnly (4)
transmitDirection Only (5)
unidirectional (6)

14 nmsTime See DateAndTime. The time of detection or

notification reception by
the Ensemble
Controller Server using the
ENC Server time zone.

15 neTime See DateAndTime. The time of detection by the

network element using the
ENC Server time zone;
nmsTime if not available.

16 description See SnmpAdminString. Device-specific message

that contains additional
information about the
event context.

17 acknowledged true (1) Shows if the event is

false (2) acknowledged or not by an
operator, that is,
acknowledged (1) or not (2).

18 corr <integer> Indicates whether the event

redundant (1) is a primary event or root
primary (2) cause (2), or a redundant
event (1), which another
event causes. This value
applies only to alarms.

Ensemble Controller R15.3 Integration Manual - Issue: A 123

Adtran About the SNMP North Bound Interface

No. Name Values Description

19 corrRef <counter64> If cor = 1 (redundant), this

field indicates the ID of the
root cause event.
Otherwise, this field is zero. If
the value is unavailable –1 is
given.

20 mtosiNeType See SnmpAdminString. The MTOSI-compatible

network element type
string.

21 serviceName See SnmpAdminString. Name of the service that

the trap is related to. More
precisely, the name of the
logical network resource, for
example, connection.

22 customerName See SnmpAdminString. Name of the customer that

the trap is related to.

23 security true (1) If true, a security alarm or

false (2) event occurred.

24 comment <string> Displays the user comment

associated with an alarm.

25 eventType none (0) Displays the event type

communications (1) associated with the alarm
qos (2) or event.
processing (3)
equipment (4)
environmental (5)

26 physLocation See SnmpAdminString. Displays the physical

location attribute of the
alarm or event.

27 entityAlias See SnmpAdminString. Shows an alternative,

customized entity name
(alias) that the network
element reveals.

Ensemble Controller R15.3 Integration Manual - Issue: A 124

Adtran About the SNMP North Bound Interface

The 10646 standard is amended over time. For this reason, you must prepare to implement any
code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid
UTF-8 encoding of a code point or are outside this range are prohibited.
We recommend that you avoid the use of control codes, and if necessary to represent a new
line, use the CR LF sequence. Also avoid the use of white space at the beginning or end of a
code sequence
For code points that the UI hardware or software do not directly support, you can provide an
alternative means of entry and display.

Encoding in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII

encoding.

l If the software uses this TC for an object that is used or envisioned as an

Hexadecimal Decimal Decimal Range or Content

Octet Field Symbol

1-2 1 0 to 65536 YY YY - year in network byte

order.

3 2 1 to 12 MM - month

4 3 1 to 31 DD - day

5 4 0 to 23 HH - hour

Ensemble Controller R15.3 Integration Manual - Issue: A 125

Adtran About the SNMP North Bound Interface

Hexadecimal Decimal Decimal Range or Content

Octet Field Symbol

6 5 0 to 59 MM - minutes

7 6 0 to 60 SS - seconds
Use 60 for leap-
seconds.

8 7 0 to 9 DS - deci-seconds

9 8 +/ – Direction from UTC.

10 9 0 to 13 Hours from UTC.

Daylight Saving Time in New
Zealand is +13.

11 10 0 to 59 Minutes from UTC.

For example, the date and time 27.01.2022 07:47:03.3 displays as this hexadecimal format: 07 E6
01 1B 07 2F 03 03. In decimal format, the date and time is 2022 01 27 07 47 03 03.

If only local time is available, the time zone information in the fields 8 to 10 is not
present.

Devices that Support MTOSI Naming

These devices support MTOSI naming:
l FSP 150CCf-825
l FSP 150CC-GE201
l FSP 150CC-GE201SE
l FSP 150-XG210
l FSP 150CM
l FSP 150CP
l FSP 150EG-X
l FSP 3000R7
l HN400
l HN4000

Ensemble Controller R15.3 Integration Manual - Issue: A 126

Adtran About the SNMP North Bound Interface

SNMP <Heart Beat> Event

The Ensemble Controller (ENC) creates the regular event <Heart Beat> for different northbound
interfaces (CSV, SNMP, and MTOSI) to indicate that the Ensemble Controller Server is still up and
running.
Table 22 outlines the <Heart Beat> event varbinds of the SNMP alarm NBI. These varbinds are not
supported: <disabled>, <elementName>, <neIpAddress>, <entity>, <location>, <direction>,
<neTime>, <corrRef>, <mtosiNeType>, <serviceName>, <customerName>, <security>, <comment>,
<eventType>, and <physLocation>.
For information about the <Heart Beat> event properties of the CSV alarm NBI, see CSV <Heart
Beat> Event. For the MTOSI alarm NBI, see MTOSI <Heart Beat> Event.
For more general information about the <Heart Beat> event, see Using the Ensemble Controller
Heartbeat.

Table 22: SNMP <Heart Beat> Event Varbinds

No. Name Values Description

1 ID 0 A unique event identifier.

2 update true (1) Indicates whether it is a new

event or update.

3 name "HEART-BEAT" An event acronym, for

example LOS for Loss of signal

4 disposition sys (5) - system evnt Event type.

5 severity informational (1) Event severity.

6 impairment nonServiceAffecting (2) Indicates whether the alarm is

potentially service affecting
(SA) or not (NSA).

8 neType fspNm (9999) Network element type.

14 nmsTime YYYYMMDDhhmmss The time of detection or

(see DateAndTime) notification reception by the
Ensemble Controller Server
time zone.

16 description "ENC Heart Beat" Device specific message that

contain additional information
regarding the context of the
event.

Ensemble Controller R15.3 Integration Manual - Issue: A 127

Adtran About the SNMP North Bound Interface

No. Name Values Description

17 acknowledged true (1) Shows if the event is

acknowledged or not by an
operator, i.e. acknowledged (1)
or not (2).

18 corr primary (2) Indicates whether the event is

a primary event or root cause
(2), or a redundant event (1)
which is caused by another
event. It applies to alarms only.

Resynchronization
For all current (standing) alarms, traps can be resent without influencing the CSV northbound
alarm interface (NBI). These traps are also referred to as synchronization traps.

Operating Principle 128

Trap Structure and Sending Sequence 132

Operating Principle
The operational support system (OSS) can initialize the process to send synchronization traps
using two mechanisms:
l Sending Traps Using the HTTP POST Request
l Sending Traps Using the Transmission Control Protocol

After the successful activation from any of the two mechanisms, the Ensemble Controller Server
starts to send synchronization traps over the standard SNMP alarm and event northbound
interface (NBI).
To ensure that these requests are not used for a Denial of Service (DoS) attack, the Ensemble
Controller Server prevents sending another request for 5 minutes.

The system may send to OSS not only the current events, but also older ones if
the following setting is enabled (has a value set): Settings > System > Server
Preferences > Event Log > Live to History Transfer > Alarm auto-acknowledge
Threshold / % of all Events in Log. By default, the value of this setting is 50. The
system auto-acknowledges older events if value of this setting is exceeded.
Follow one of these steps to avoid getting older events:

Ensemble Controller R15.3 Integration Manual - Issue: A 128

Adtran About the SNMP North Bound Interface

l Disable the auto-acknowledgement feature.

l Set a filter for the events that are consumed by the target OSS, for example:
only accept events where ACK = NACK (not acknowledged) or NMS_Time =
Current date/time.

For more information about live to history transfer logic for events and alarms,
see User Manual.

Sending Traps Using the HTTP POST Request

The operational support system (OSS) sends an HTTP POST request to the web address https://
{ENC IP}}:{{Port}/advabase/event-nbi/snmp/sync. You can use these ports:
l 8443 for secure https communication, for example https://localhost:8443/advabase/event-
nbi/snmp/sync.
l 8080 for insecure http communication, for example http://localhost:8080/advabase/event-
nbi/snmp/sync. To enable this insecure port, you also need to edit property
com.adva.fnm.option.webserver.port in the fnm.properties file. By default, this property is set
to none.
For information about how to configure properties in the fnm.properties file, see Administrator
Manual.

The system can authenticate requests to this web address by using the HTTP basic
authentication mechanism (https://en.wikipedia.org/wiki/Basic_access_authentication). This
mechanism uses login and password from the Ensemble Controller user database.
After successful authentication, the response returns an integer value. A response of 0 indicates
that the trap synchronization was successfully initialized, and a response greater than 0
indicates that the blackout period has not expired, and the value is the time that remains in
seconds to the expiration of the blackout period. For information about the blackout period, see
Operating Principle.

Sending Traps Using the Transmission Control Protocol

An alternate mechanism that does not include authentication requires that the operational
support system (OSS) establishes a transmission control protocol (TCP) connection to the
Ensemble Controller Server (ENC Server) on a port that you must specify in the fnm.properties
file:
1. Open the fnm.properties file on the relevant server by using a text editor, for example
WordPad.
The fnm.properties file is located in the Ensemble Controller (ENC) installation directory
C:\Program Files\ADVA Optical Networking\FSP Network Manager.
2. In the fnm.properties file, search (Ctrl + f) for the parameter
com.adva.nlms.mediation.event.syncAlarmsListenerPort.
3. Specify a relevant property port that an OSS client then uses to trigger the alarm NBI
synchronization. For examples about how the OSS client triggers alarm NBI synchronization,
see Operating Principle.
For more information about how to edit the fnm.properties file, see the Administrator Manual.

Ensemble Controller R15.3 Integration Manual - Issue: A 129

Adtran About the SNMP North Bound Interface

4. If you have multiple IP interfaces, you can use the parameter

com.adva.fnm.option.snmpNBISource to specify the listening IP interface.
5. Save, and then close the fnm.properties file.

These examples illustrate how the OSS client can establish a TCP connection to the Ensemble
Controller Server:

Ensemble Controller R15.3 Integration Manual - Issue: A 130

Adtran About the SNMP North Bound Interface

Figure 5: Java TCP Connection Creator

Ensemble Controller R15.3 Integration Manual - Issue: A 131

Adtran About the SNMP North Bound Interface

Figure 6: C++ TCP Connection Creator

telnet {IP or host of ENC Server} {port specified in fnm.property}

Example: telnet 172.26.4.24 9090
While Ensemble Controller sends synchronization traps, it silently ignores all further OSS client
trigger events. After it receives a trigger event, it ignores additional trigger events for ten
minutes.
After the Ensemble Controller Server restarts, synchronization traps discontinue and do not
resume.

Trap Structure and Sending Sequence

The synchronization traps are framed by two special traps identifying start and end of the
synchronization traps. This enables the OSS client to clearly identify begin and end of a
resynchronization transmission.
l The resynchronization starts with a FrameStart trap containing this data:
o Id = 0
o Update = syn(3)

Ensemble Controller R15.3 Integration Manual - Issue: A 132

Adtran About the SNMP North Bound Interface

o Name = ResyncFrameStart
o Disposition = sys(5)
All other fields contain default values.

l The resynchronization stops with a FrameStop trap containing this data:

o Id = Number of synchronization traps sent. Intermediate standard traps, synchronization
start traps, and synchronization stop traps are not counted.
o Update = syn(3)
o Name = ResyncFrameStop
o Disposition = sys(5)

The Id field holds the number of traps with standing alarms. This enables the OSS client to verify
whether all traps were received. All other fields contain corresponding default values.
The system sends the synchronization traps for all current (standing) alarms between the
synchronization start trap and the synchronization stop trap. Each of these traps contain the
‘Update = syn(3)’ information. All other fields take over the original trap value.

SNMP MIB File

The Ensemble Controller (ENC) information base (MIB) depends on the general MIB created by
Adtran. Both files are available in the ...\mibs folder of the Ensemble Controller installation
directory.

Service Affected Events

With the Ensemble Controller release 7.5, faulted service alarms have been replaced with
service affected events.

Functional Specification 133

User Interface Specification 135
North Bound Interface Specification 135

Functional Specification
Table 23 summarizes the service affected events that Ensemble Controller supports:

Ensemble Controller R15.3 Integration Manual - Issue: A 133

Adtran About the SNMP North Bound Interface

Table 23: Service Affected Events

Service Service Affected Event

Operation Reason Code Cause / Short Full Name /

State Name Description

NIS na no service affected event supported

Faulted Client SERV_C_AFFECTED Service Affected -

Affected Client Side
Degraded

Faulted Network SERV_N_AFFECTED Service Affected -

Affected Network Side
Degraded

Relevant network or client layer states can coexist. The rules are given in Table 24. 'Faulted' is
always a more significant state than 'Degraded' and a network layer event is more significant
than a client layer event in the case that both exhibit the same state.

Table 24: Network and Client Layer States by Comparison

Service Layer

Operation Reason Code Network Client

State

Faulted Network Affected Faulted Insignificant

Client Affected Not Faulted Faulted

Degraded Network Affected Degraded Not Faulted

Client Affected Neither Faulted nor Degraded

Degraded

Service affected events have to be enabled as described in User Interface Specification.

When enabled, service affected events are sent on both alarm NBIs (CSV and SNMP) when the
operation state or the reason code of a service has changed. Such events will be applicable for
data services only and are by default not logged in the Ensemble Controller (ENC) database.
The logging of service affected events in the Ensemble Controller database can be enabled as
described in User Interface Specification.
l After the logging has been enabled, the service affected events are synchronized and raised
if applicable for services already affected.
l After the logging has been disabled, the service affected events are synchronized and
cleared if applicable for services where a raised service affected event existed.

Ensemble Controller R15.3 Integration Manual - Issue: A 134

Adtran About the SNMP North Bound Interface

User Interface Specification

In general, service affected events have to be enabled in order to be sent to the northbound
interfaces. If applicable, these events can as well be logged in the Ensemble Controller
database by editing the corresponding server parameter.

Enabling Service Affected Alarms 135

Enabling Logging of Service Affected Alarms in the Ensemble Controller Database 135

Enabling Service Affected Alarms

To enable service affected alarms, edit the parameter
com.adva.nlms.mediation.event.sendServiceOperStateChangeAlarms
in the fnm.properties file as described in the Editing the fnm.properties File section in the
Administrator Manual. These values are supported:
l yes - service affected alarms are sent to both alarm NBIs (CSV and SNMP).
l no - (by default) service affected alarms are not sent.

Enabling Logging of Service Affected Alarms in the

Ensemble Controller Database
To enable logging of service affected alarms in the Ensemble Controller (ENC) database, edit
the parameter
com.adva.nlms.mediation.event.storeServiceOperStateChangeAlarms
in the fnm.properties file as described in the Editing the fnm.properties File section in the
Administrator Manual. These values are supported:
l yes - service affected alarms are stored in the Ensemble Controller database.
l no - (by default) service affected alarms are not stored in the Ensemble Controller database.

North Bound Interface Specification

This section describes the SNMP alarm northbound interface (NBI) properties supported by the
service affected events.
Service affected events reuse the short name (cause) and the full name (description) of the
faulted service alarms. They support as well the values <raise> and <clear> for the disposition
field in the same way as alarms support them. Severities are used to distinguish between the
different values of the Service Operation State field.
See this table for a description of these properties. The respective CSV property names are
given in brackets.

Ensemble Controller R15.3 Integration Manual - Issue: A 135

Adtran About the SNMP North Bound Interface

Table 25: Service Affected Events Properties

Property Description

id (ID) l 0 - when events are not stored in the Ensemble Controller

database
l id - when events are stored in the Ensemble Controller database

name (Event) cause / short name as defined in Table 23

disposition (Type) l ARM (raised) - when the service operation state is <Faulted> or
<Degraded>
l CLR (cleared) when:
o the service operation state is <OK>
o the service operation state had been <Faulted> or <Degraded>
and then the reason code changed

severity (Severity) l critical - when the service operation state is <Faulted>

l minor - when the service operation state is <Degraded>

impairment l service affecting (SA) for faulted services

(Impairment) l not service affecting (NSA) for degraded services

neType (NE_Type) l <empty> for CSV

l fspNm for SNMP

serviceName configured name of the service

(Service_Name)

customerName configured name of the customer

(Customer_Name)

nmsTime (NMS_ derived from the time stamp of the service

Time) operational state

neTime (NE_Time) <empty>

same as nmsTime for SNMP

description full name / description name as defined in Table 23

(Description)

An example of a service affected event sequence is given below in Table 26. Only important
properties are listed:

Ensemble Controller R15.3 Integration Manual - Issue: A 136

Adtran About the SNMP North Bound Interface

Table 26: Example of a Service Affected Event Sequence

Service Time Service Affected Event
Stamp
Operation Reason Cause / Disposition Severity
State Code Short Name

NIS na not applicable

Faulted Client T0 SERV_C_ ARM critical

Affected AFFECTED

Faulted Network T1 SERV_C_ CLR

Affected AFFECTED1

T1 SERV_N_ ARM
AFFECTED

Degraded Network T2 SERV_N_ CLR

Affected AFFECTED

T02 SERV_C_ ARM

AFFECTED2

T3 SERV_C_ CLR
AFFECTED3

T24 SERV_N_ ARM minor

AFFECTED4

OK na T4 SERV_N_ CLR
AFFECTED

NIS not applicable

Faulted Network T55 SERV_N_ ARM critical

Affected AFFECTED

NIS na CLR

1. The client layer is still faulted. However, the network layer fault overrides because in a tie of similar
condition network layer rules.
2. Since the network condition improves from Faulted to Degraded, the more significant client layer
condition is raised. The time stamp shown is the same as when the client Faulted condition first occurred.
3. The client layer fault is cleared at this point.
4. Since the network layer degradation still persists, it is raised. The time stamp shown is the same as when
the network Degraded condition first occurred.
5. Since the last Faulted and Degraded conditions had gone back to OK (at T4) a new time stamp is
created for the new Faulted condition.
Ensemble Controller R15.3 Integration Manual - Issue: A 137
Adtran About the SNMP North Bound Interface

Notification Events
These events are generated upon changes related to the NBI trap transmitter.

OSS-ADD – OSS Address Added

Short Name: OSS-ADD

Message: OSS Address added to NBI Trap Transmitter:<address>

Status: WARNING

Description: This event is generated when an address is added to the OSS

Address List box in the NBI Trap Transmitter window.

Cause: An address has been added to the OSS Address List.

Correction: A correction is inapplicable as this is an event (transient condition).

OSS-DEL – OSS Address Deleted

Short Name: OSS-DEL

Message: OSS Address deleted from NBI Trap Transmitter:<address>

Status: WARNING

Description: This event is generated when an address is deleted from the OSS
Address List box in the NBI Trap Transmitter window.

Cause: An address has been deleted from the OSS Address List.

Correction: A correction is inapplicable as this is an event (transient condition).

Ensemble Controller R15.3 Integration Manual - Issue: A 138

Adtran About the MTOSI North Bound Interface

Chapter 5
About the MTOSI North Bound
Interface
This chapter describes the MTOSI (multi-technology operations system interface) northbound
interface of the Ensemble Controller.

MTOSI Change History 139

Enabling MTOSI 139
Services with Implemented Functionality 143
Opening a Service Operation 156
Opening an MTOSI Operation With SoupUI 158
Testing MTOSI Iterators With SoapUI 158
Configuring a Mock Server for MTOSI Notifications With SoapUI 161
MTOSI <Heart Beat> Event 164

MTOSI Change History

This section details changes that were made to the MTOSI northbound interface (NBI) in a
certain release.

Changes in Release 10.3

The section MTOSI <Heart Beat> Event was added as with release 10.3.1, the <heartbeat> event is
(besides CSV and SNMP) supported by the MTOSI interface as well.

Enabling MTOSI
Complete these steps to enable MTOSI.
Enabling MTOSI includes these tasks without limitation:

Ensemble Controller R15.3 Integration Manual - Issue: A 139

Adtran About the MTOSI North Bound Interface

l Enabling or disabling MTOSI.

l Applying naming format to MTOSI-supported entities.
l Specifying the Jetty port.
l Specifying the web server timeout.

These tasks are maintained in the fnm.properties file. This procedure also includes the steps for
enabling the Logging of MTOSI Activities, which is done in the log4j2.xml file.
Both files, fnm.properties and log4j2.xml are located in the Ensemble Controller (ENC)
installation directory C:\Program Files\ADVA Optical Networking\FSP Network Manager.

Procedure
1. Open the fnm.properties file on the relevant server using a text editor, for example WordPad.
2. In the fnm.properties file, search (Ctrl + f) for the parameters outlined in Table 27.
If there are no search results, then add the relevant parameter to the fnm.properties file.
3. Edit these parameters according to the description and supported values:

Table 27:
Parameters for Enabling MTOSI

Parameter Description Supported Default

Values Value

com.adva.nlms.mediation.mtosi.star Enable or disable true or false false

tModule MTOSI in
Ensemble
Controller.
If this attribute is
not included in
the
fnm.properties
file or is set to
“false”, MTOSI will
not be available
in Ensemble
Controller.

Ensemble Controller R15.3 Integration Manual - Issue: A 140

Adtran About the MTOSI North Bound Interface

Parameter Description Supported Default

Values Value

com.adva.nlms.mediation.config.Us When set to yes, yes or no no

e_MTOSI_Naming this attribute
applies the
MTOSI naming
format that is
/shelf=<n>/slot<
n>… to all MTOSI-
supported
entities.
For MTOSI
requests to
succeed, it is
mandatory that
you set this
attribute to yes.

com.adva.fnm.option.webserver.port Specifies the Any 8080

port, which Jetty unoccupied
uses to listen for TCP port in
incoming the server
requests. If not hosting
set, Jetty uses Ensemble
the default 9,000 Controller.
port.

Ensemble Controller R15.3 Integration Manual - Issue: A 141

Adtran About the MTOSI North Bound Interface

Parameter Description Supported Default

Values Value

com.adva.fnm.option.web_server_ By default, Jetty Any valid 30,000

timeout waits 30 number millisecond
seconds before above s
closing the 30,000
connection to millisecond
any incoming s.
request.
Execution time
for more
complex
requests
depending on
server workload
and network
congestion, can
take more time.
To avoid closed
connections
before the
operation can
send the
response back
to the client, you
can use this
parameter to
increase the
timeout.
The Jetty
timeout attribute
does not have a
maximum
limitation and
can be set
arbitrarily. Known
production
clients are
configured with
60,000
milliseconds
timeout, and we
recommend
that Jetty does
not exceed this
limit.

Ensemble Controller R15.3 Integration Manual - Issue: A 142

Adtran About the MTOSI North Bound Interface

4. Save and close the fnm.properties file. For details, see the Administrator Manual.
After you enable MTOSI in Ensemble Controller, an inventory report is available with all
services at http://<server>:<port>/mtosi.

Logging of MTOSI Activities

5. Open the log4j2.xml file on the relevant server using a text editor, for example WordPad.
6. In the log4j.properties file, search (Ctrl + f) for the parameter
log4j.logger.com.adva.nlms.mediation.mtosi.
If you get no search results, add this parameter to the log4j2.xml file.
7. Edit this parameter by adding the value info, mtosilog.
After you enable the logging of MTOSI activities, logging reports are available in the
Ensemble Controller (ENC) installation directory C:\Program Files\ADVA Optical
Networking\FSP Network Manager\var\log\mtosi.log.
8. Save and close the log4j2.xml file.

Services with Implemented

Functionality
When the MTOSI interface is enabled as described in Enabling MTOSI, all available services are
loaded and exposed through the HTTP(s) protocol. The complete list of all available services
can be found at http(s)://<EMS-SERVER>:<EMS-PORT>/mtosi.
Only a subset of the exposed services have active implementation, which might be different
depending on the MTOSI version (one or two) and the network element type. The complete list
of all the services with implemented functionality along with the 'uniform resource identifier'
(URI) endpoint and the respective 'Web service definition language' (WSDL) location in the
TeleManagement Forum1 (TMF) deliverables are described in Table 28 and Table 29.
More details about the functionality per operation and its use is described in the MTOSI NBI
documentation provided for licensed customers.

Table 28: Version 1

Service Name DiscoveryServiceHttp

URI /v1/DiscoveryService

WSDL /tmf854/wsdl/common/DiscoveryService.wsdl

Implemented getAllCapabilities
operations

1. TeleManagement Forum (TM Forum or TMF) provides a set of reference models that aid in analysing and
designing next generation 'billing support solution' (BSS) and 'operations support solution' (OSS) that can
utilize the MTOSI interface specifications.
Ensemble Controller R15.3 Integration Manual - Issue: A 143
Adtran About the MTOSI North Bound Interface

Service Name NotificationConsumerHttp

URI /v1/NotificationService/NotificationConsume

WSDL /tmf854/wsdl/binding/soap_http/NotificationServiceSOAP.wsdl

Implemented notify
operations

Service Name NotificationProducerHttp

URI /v1/NotificationService/NotificationProducer

WSDL /tmf854/wsdl/binding/soap_http/NotificationServiceSOAP.wsdl

Implemented subscribe unsubscribe

operations

Service Name EquipmentInventoryMgrHttp

URI /v1/ConfigurationService/EquipmentInventoryMgr

WSDL /tmf854/wsdl/binding/soap_http/EquipmentInventoryMgrSOAP.wsdl

Implemented getContainedEquipment
operations getAllEquipmentNames
getAllEquipment
getEquipment

Service Name InventoryRetrievalHttp

URI /v1/ConfigurationService/InventoryRetrieval

WSDL /tmf854/wsdl/binding/soap_http/InventoryRetrievalSOAP.wsdl

Implemented getInventory
operations

Service Name ManagedElementMgrHttp

URI /v1/ConfigurationService/ManagedElementMgr

Ensemble Controller R15.3 Integration Manual - Issue: A 144

Adtran About the MTOSI North Bound Interface

WSDL /tmf854/wsdl/binding/soap_http/ManagedElementMgrSOAP.wsdl

Implemented getAllPTPs
operations getAllManagedElementNames
getAllFTPs
getContainedCurrentCTPs
getManagedElement
getTP
getAllManagedElements

Service Name OperationsSystemMgrHttp

URI /v1/ConfigurationService/OperationsSystemMgr

WSDL /tmf854/wsdl/binding/soap_http/OperationsSystemMgrSOAP.wsdl

Implemented getAllMDs
operations getAllMEsWrtOS
getMD
getAllMENamesWrtOS
getAllMEsPassingFilter
getAllOSNames
getOS
getAllMDNames
getAllMENamesPassingFilter
getAllOSs

Service Name ADVAManagedElementMgrHttp

URI /v1/ADVAConfigurationService/ADVAManagedElementMgr

WSDL /adva/wsdl/binding/soap_http/ADVAManagedElementMgrSOAP.wsdl

Ensemble Controller R15.3 Integration Manual - Issue: A 145

Adtran About the MTOSI North Bound Interface

Implemented setMEData
operations setTPData
setManagementCTPData
getContainedCurrentManagementCTPs
deleteManagementCTP
deleteManagedElement
createManagedElement
createManagementCTP
renameTP
getManagementCTP
startDiscoveryPolling

Service Name ADVAEquipmentInventoryMgrHttp

URI /v1/ADVAConfigurationService/ADVAEquipmentInventoryMgr

WSDL /adva/wsdl/binding/soap_
http/ADVAEquipmentInventoryMgrSOAP.wsdl

Implemented provisionEquipment
operations resetEquipment
unprovisionEquipment
setEquipmentData

Service Name ADVAPerformanceManagementMgrHttp

URI /v1/ADVAConfigurationService/ADVAPerformanceManagementMgr

WSDL /adva/wsdl/binding/soap_
http/ADVAPerformanceManagementMgrSOAP.wsdl

Implemented getAllCurrentPMData
operations getAllHistoricalPMData

Service Name ADVAFlowDomainMgrHttp

URI /v1/ADVAConfigurationService/ADVAFlowDomainMgr

WSDL /adva/wsdl/binding/soap_http/ADVAFlowDomainMgrSOAP.wsdl

Ensemble Controller R15.3 Integration Manual - Issue: A 146

Adtran About the MTOSI North Bound Interface

Implemented getAllFDFrs
operations createFTP
releaseVLANLoopback
modifyFDFr
deleteFTP
deleteCTP
renameFDFr
deactivateAndDeleteFDFr
createAndActivateFDFr
getFDFrsWithTP
getContinuityTest
getFDFr
operateLoopback
releaseLoopback
performProtectionCommand
stopContinuityTest
getAllCPTPs
startContinuityTest
operateVLANLoopback

Service Name ADVAConnectivityFaultMaintenanceHttp

URI /v1/ADVAConfigurationService/ADVAConnectivityFaultMaintenance

WSDL /adva/wsdl/binding/soap_
http/ADVAConnectivityFaultMaintenanceSOAP.wsdl

Implemented createMaintenanceAssociation
operations getMaintenanceAssociation
deleteMaintenanceDomain
deleteMaintenanceEndpoint
createMaintenanceEndpoint
getMaintenanceDomain
getMaintenanceEndpoint
deleteMaintenanceAssociation
createMaintenanceDomain
modifyMaintenanceEndpoint

Service Name ADVATCProfileMgrHttp

Ensemble Controller R15.3 Integration Manual - Issue: A 147

Adtran About the MTOSI North Bound Interface

URI /v1/ADVAConfigurationService/ADVATCProfileMgr

WSDL /adva/wsdl/binding/soap_http/ADVATCProfileMgrSOAP.wsdl

Implemented getTCProfile
operations getTCProfilesWithTP
modifyTCProfile

Service Name ADVASyncEMgrHttp

URI /v1/ADVAConfigurationService/ADVASyncEMgr

WSDL /adva/wsdl/binding/soap_http/ADVASyncEMgrSOAP.wsdl

Implemented getContainedCurrentTimingCTPs
operations modifyTDFr
getAllTDFrs
getTDFr
getTDFrsWithTP
renameTDFr

Table 29:
Version 2
Service Name NotificationProducerHttp

URI /v2/Framework/NotificationProducer

WSDL DDPs/Framework/IIS/wsdl/NotificationProducer/
NotificationProducerHttp.wsdl

Implemented subscribe
operations unsubscribe

Service Name ConnectionRetrievalHttp

URI /v2/ManageResourceInventory/ConnectionRetrieval

WSDL DDPs/ManageResourceInventory/IIS/wsdl/ConnectionRetrieval/
ConnectionRetrievalHttp.wsdl

Implemented getSubnetworkConnectionsIterator
operations getAllSubnetworkConnections

Ensemble Controller R15.3 Integration Manual - Issue: A 148

Adtran About the MTOSI North Bound Interface

Service Name EquipmentInventoryRetrievalHttp

URI /v2/ManageResourceInventory/EquipmentInventoryRetrieval

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
EquipmentInventoryRetrieval/EquipmentInventoryRetrievalHttp.wsdl

Implemented getContainedEquipment
operations getEquipment
getEquipmentIterator
getAllEquipment

Service Name ManagedElementRetrievalHttp

URI /v2/ManageResourceInventory/ManagedElementRetrieval

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
ManagedElementRetrieval/ManagedElementRetrievalHttp.wsdl

Implemented getManagedElementsIterator
operations getAllManagedElementsWrtOs
getAllManagedElements
getAllManagedElementsPassingFilter
getManagedElement

Service Name ManagedElementControlHttp

URI /v2/ManageResourceInventory/ManagedElementControl

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
ManagedElementControl/ManagedElementControlHttp.wsdl

Implemented createManagedElement
operations deleteManagedElement
startDiscoveryPolling
setMEData

Service Name ManagementDomainRetrievalHttp

URI /v2/ManageResourceInventory/ManagementDomainRetrieval

Ensemble Controller R15.3 Integration Manual - Issue: A 149

Adtran About the MTOSI North Bound Interface

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
ManagementDomainRetrieval/
ManagementDomainRetrievalHttp.wsdl

Implemented getManagementDomain
operations getAllManagementDomains

Service Name MultiLayerSubnetworkRetrievalHttp

URI /v2/ManageResourceInventory/MultiLayerSubnetworkRetrieval

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
MultiLayerSubnetworkRetrieval/
MultiLayerSubnetworkRetrievalHttp.wsdl

Implemented getMultiLayerSubnetworksIterator
operations getAllTopLevelMultiLayerSubnetworks

Service Name OperationsSystemRetrievalHttp

URI /v2/ManageResourceInventory/OperationsSystemRetrieval

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
OperationsSystemRetrieval/OperationsSystemRetrievalHttp.wsdl

Implemented getOperationsSystem
operations getAllOperationsSystems

Service Name ResourceInventoryRetrievalHttp

URI /v2/ManageResourceInventory/ResourceInventoryRetrieval

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
ResourceInventoryRetrieval/ResourceInventoryRetrievalHttp.wsdl

Implemented getInventoryIterator
operations getInventory

Service Name TerminationPointRetrievalHttp

URI /v2/ManageResourceInventory/TerminationPointRetrieval

Ensemble Controller R15.3 Integration Manual - Issue: A 150

Adtran About the MTOSI North Bound Interface

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
TerminationPointRetrieval/TerminationPointRetrievalHttp.wsdl

Implemented getContainedPotentialConnectionTerminationPoints
operations getContainedCurrentConnectionTerminationPoints
getTerminationPointsIterator
getTerminationPoint
getAllPhysicalTerminationPoints
getAllFloatingTerminationPoints

Service Name TopologicalLinkRetrievalHttp

URI /v2/ManageResourceInventory/TopologicalLinkRetrieval

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
TopologicalLinkRetrieval/TopologicalLinkRetrievalHttp.wsdl

Implemented getAllTopLevelTopologicalLinks
operations getTopologicalLink
getTopologicalLinksIterator
getAllTopologicalLinks
getAllTopologicalLinksWrtOs

Service Name EthernetServiceAssuranceControlHttp

URI /v2/NetworkResourceAssurance/
EthernetServiceAssuranceControl

WSDL DDPs/NetworkResourceAssurance/IIS/wsdl/
EthernetServiceAssuranceControl/
EthernetServiceAssuranceControlHttp.wsdl

Implemented createESAProbe
operations deleteESAProbe

Service Name PerformanceManagementRetrievalHttp

URI /v2/ResourcePerformanceManagement/
PerformanceManagementRetrieval

Ensemble Controller R15.3 Integration Manual - Issue: A 151

Adtran About the MTOSI North Bound Interface

WSDL DDPs/ResourcePerformanceManagement/IIS/wsdl/
PerformanceManagementRetrieval/
PerformanceManagementRetrievalHttp.wsdl

Implemented getAllCurrentPerformanceMonitoringData
operations

Service Name CustomPerformanceManagementRetrievalHttp

URI /v2/ResourcePerformanceManagement/
CustomPerformanceManagementRetrieval

WSDL DDPs/ResourcePerformanceManagement/IIS/wsdl/
CustomPerformanceManagementRetrieval/
CustomPerformanceManagementRetrievalHttp.wsdl

Implemented getHistoricalPMFromManagedElement
operations

Service Name ConnectionControlHttp

URI /v2/ResourceProvisioning/ConnectionControl

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
ConnectionControl/ConnectionControlHttp.wsdl" />

Implemented deleteSubnetworkConnection
operations createAndActivateSubnetworkConnection

Service Name EquipmentControlHttp

URI /v2/ResourceControl/EquipmentControl

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
EquipmentControl/EquipmentControlHttp.wsdl

Implemented setEquipmentData
operations

Service Name FlowDomainControlHttp

URI /v2/ResourceProvisioning/FlowDomainControl

Ensemble Controller R15.3 Integration Manual - Issue: A 152

Adtran About the MTOSI North Bound Interface

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
FlowDomainControl/FlowDomainControlHttp.wsdl

Implemented createAndActivateFlowDomainFragment
operations deactivateAndDeleteFlowDomainFragment

Service Name ADVASyncOpEMgrHttp

URI /v2/ManageResourceInventory/ADVASyncOpEMgr

WSDL DDPs/ManageResourceInventory/IIS/wsdl/
ADVASyncOpEMgr/ADVASyncOpEMgrHttp.wsdl

Implemented getContainedCurrentTimingCTPs
operations getAllTDFrs
modifyTDFr

Service Name SoftwareAndDataControlHttp

URI /v2/ResourceProvisioning/SoftwareAndDataControl

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
SoftwareAndDataControl/SoftwareAndDataControlHttp.wsdl

Implemented backupManagedElement
operations

Service Name PrecisionTimeProtocolControlHttp

URI /v2/ResourceProvisioning/PrecisionTimeProtocolControl

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
PrecisionTimeProtocolControl/
PrecisionTimeProtocolControlHttp.wsdl

Ensemble Controller R15.3 Integration Manual - Issue: A 153

Adtran About the MTOSI North Bound Interface

Implemented modifyPrecisionTimeProtocolClock
operations deletePrecisionTimeProtocolFlowPoint
getPrecisionTimeProtocolFlowPoint
getMasterVirtualPort
createTelecomSlave
deletePrecisionTimeProtocolClock
deleteStaticRemoteSlave
createBoundaryClock
getStaticRemoteSlave
deleteBoundaryClock
createPrecisionTimeProtocolFlowPoint
getPrecisionTimeProtocolPort
createStaticRemoteSlave
getBoundaryClock
deleteMasterClockInterface
modifyPrecisionTimeProtocolPort
createPrecisionTimeProtocolClock
createMasterClockInterface
createOCSPort
createMasterVirtualPort
getPrecisionTimeProtocolClock
deletePrecisionTimeProtocolPort
getMasterClockInterface
createSOOC
deleteSOOC
createPrecisionTimeProtocolPort
deleteTelecomSlave
modifyPrecisionTimeProtocolFlowPoint
deleteMasterVirtualPort
deleteOCSPort

Service Name AMPControlHttp

URI /v2/ResourceProvisioning/AMPControl

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
AMPControl/AMPControlHttp.wsdl

Ensemble Controller R15.3 Integration Manual - Issue: A 154

Adtran About the MTOSI North Bound Interface

Implemented setManagementCTPData
operations createAMP
createStaticRoute
getManagementCTP
getStaticRoute
deleteManagementCTP
deleteAMP
deleteStaticRoute
createManagementCTP
getAMP

Service Name TerminationPointControlHttp

URI /v2/ResourceProvisioning/TerminationPointControl

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
TerminationPointControl/TerminationPointControlHttp.wsdl

Implemented deleteFloatingTerminationPoint
operations createFloatingTerminationPoint
setTerminationPointData

Service Name TrafficConditioningProfileControlHttp

URI /v2/ResourceProvisioning/TrafficConditioningProfileControl

WSDL DDPs/ResourceProvisioning/IIS/wsdl/
TrafficConditioningProfileControl/
TrafficConditioningProfileControlHttp.wsdl

Implemented createTrafficConditioningProfile
operations deleteTrafficConditioningProfile
modifyTrafficConditioningProfile

Service Name AlarmRetrievalHttp

URI /v2/ResourceTroubleManagement/AlarmRetrieval

WSDL DDPs/ResourceTroubleManagement/IIS/wsdl/
AlarmRetrieval/AlarmRetrievalHttp.wsdl

Ensemble Controller R15.3 Integration Manual - Issue: A 155

Adtran About the MTOSI North Bound Interface

Implemented getActiveAlarms
operations getActiveAlarmsIterator

Service Name MaintenanceControlHttp

URI /v2/ResourceTroubleManagement/MaintenanceControl

WSDL DDPs/ResourceTroubleManagement/IIS/wsdl/
MaintenanceControl/MaintenanceControlHttp.wsdl

Implemented getActiveMaintenanceOperations
operations performMaintenanceOperation

Service Name ConnectivityFaultMaintenanceControlHttp

URI /v2/ResourceTroubleManagement/
ConnectivityFaultMaintenanceControl

WSDL DDPs/ResourceTroubleManagement/IIS/wsdl/
ConnectivityMaintenanceControl/
ConnectivityFaultMaintenanceControlHttp.wsdl

Implemented deleteMaintenanceAssociation
operations createMaintenanceDomain
modifyMaintenanceEndpoint
getMaintenanceEndpoint
getMaintenanceDomain
createMaintenanceEndpoint
deleteMaintenanceEndpoint
deleteMaintenanceDomain
getMaintenanceAssociation
createMaintenanceAssociation

Opening a Service Operation

To open a service operation, the service WSDL needs to be loaded on the client application.
The WSDL of the service can be retrieved directly from the server by using the service endpoint
followed by the “?wsdl” parameter or by using the TMF deliverables, which can be provided by
Adtran upon customer request.
To avoid loading the WSDLs one by one, an aggregate WSDL can be created pointing to multiple
service endpoints.
This example indicates an aggregate WSDL pointing to the TMF artifacts:
Ensemble Controller R15.3 Integration Manual - Issue: A 156
Adtran About the MTOSI North Bound Interface

Ensemble Controller R15.3 Integration Manual - Issue: A 157

Adtran About the MTOSI North Bound Interface

In the aggregate WSDL, server endpoints instead of file paths can be specified
as well:

Opening an MTOSI Operation With

SoupUI
Loading an aggregate WSDL of the services to be tested or opened on SoapUI generates a
sample request for each operation.
See these steps for details:
1. Select the service and operation that you wish to open.
2. Double-click the request.
3. Set the correct service URI and press the send button .

Testing MTOSI Iterators With SoapUI

See these steps for details:

Ensemble Controller R15.3 Integration Manual - Issue: A 158

Adtran About the MTOSI North Bound Interface

1. Go to an operation supporting the iterator functionality that is, getAllManagedElements:

2. Set the value of the requestedBatchSize parameter to the desired batch result size.
The values of the requestedBatchSize can be in the range 1 - 4294967295. In this example,
the requestedBatchSize value is 2.
3. From the response, copy/paste the iteratorReferenceURI value to the corresponding iterator
operation request getManagedElementsIterator:

Ensemble Controller R15.3 Integration Manual - Issue: A 159

Adtran About the MTOSI North Bound Interface

4. For the request getManagedElementsIterator, set the value of the "requestedBatchSize"

parameter to the desired batch result size. The values of the requestedBatchSize can be in
the range 1 - 4294967295. In this example, the requestedBatchSize value is 3.

5. Send the request.

6. If the result of the iterator operation has header batchSequenceEndOfReply=false, repeat
the sending of the iterator request.

Ensemble Controller R15.3 Integration Manual - Issue: A 160

Adtran About the MTOSI North Bound Interface

Configuring a Mock Server for MTOSI

Notifications With SoapUI
To receive notifications in SoapUI, complete these steps:
1. Go to the NotificationProducerSoapHttpBinding service.
2. Send the subscribe request with the URI value for consumerEpr:
<v11:consumerEpr>http://localhost:9001/mtosi/cxf/NotificationConsumerImpl</
v11:consumerEpr>
<v11:topic>Inventory</v11:topic>
The port value assigned here is the port where the Ensemble Controller
Server forwards notifications and SoapUI listens to them.

3. Copy the subscriptionID value from the response and keep on hand.
You will later need it for the unsubscription operation under the
NotificationProducerSoapHttpBinding service. For more information about the
unsubscription operation, see Step 9.
4. Right-click the NotificationConsumerSoapHttpBinding service, and then from the menu
select Generate SOAP Mock Service. The Generate MockService window displays:

5. Set the parameters in this window as described and indicated in Step 4:

l From the MockService list, select <create>.
l In the Operations field, select notify.

Ensemble Controller R15.3 Integration Manual - Issue: A 161

Adtran About the MTOSI North Bound Interface

l In the Path field, type /mtosi/cxf/NotificationConsumerImpl.

l In the Port field, type 9001.
l Select Adds the MockServices endpoint to the mocked Interface.

6. Click OK.
7. In the MockService window, click :

8. To unsubscribe, use the unsubscribe operation under the

NotificationProducerSoapHttpBinding service:

9. In the request message, copy, and then paste the subscriptionID value generated in Step 3:

Ensemble Controller R15.3 Integration Manual - Issue: A 162

Adtran About the MTOSI North Bound Interface

Ensemble Controller R15.3 Integration Manual - Issue: A 163

Adtran About the MTOSI North Bound Interface

MTOSI <Heart Beat> Event

Table 30:
MTOSI <Heart Beat> Event Varbinds
No. MTOSI Attribute Ensemble Controller Values Description
Attribute

1 notificationId ID 0 A unique notification identifier.

2 sourceTime nmsTime <sourceTime>YYYYMMDD Time at which the event was sent by Ensemble Controller.
hhmmss... </sourceTime> Data type of sourceTime is xsd:dateTime, for example:
<sourceTime>2016-02-02T17:41:13.984+02:00</sourceTime>

3 objectName - - Contains the fully qualified RDN Name of the operating

system.

4 osTime nmsTime <osTime>YYYYMMDD Same value as for sourceTime. Data type of osTime is
hhmmss... </osTime> xsd:dateTime, for example:
<osTime>2016-02-02T17:41:13.984+02:00</osTime>

Ensemble Controller R15.3 Integration Manual - Issue: A 164

ENC Administrator Manual
No ratings yet
ENC Administrator Manual
572 pages
Adtran AOS Commands!
100% (1)
Adtran AOS Commands!
507 pages
ECI Broadgate Product Line
No ratings yet
ECI Broadgate Product Line
222 pages
SYNFONET Access Node Manager NOkia
No ratings yet
SYNFONET Access Node Manager NOkia
346 pages
HPE - A00059864en - Us - Onyx For HPE StoreFabric M-Series Ethernet Switch User Manual
No ratings yet
HPE - A00059864en - Us - Onyx For HPE StoreFabric M-Series Ethernet Switch User Manual
1,666 pages
WRS-051 Ug Roadm R4.7.1 Standard
No ratings yet
WRS-051 Ug Roadm R4.7.1 Standard
142 pages
Inca IP Video Platform User Manual V1.0.65 20221213
No ratings yet
Inca IP Video Platform User Manual V1.0.65 20221213
203 pages
Unspecified NE Alarms Guide
100% (1)
Unspecified NE Alarms Guide
315 pages
Excel Importer Exporter V2 DOC en
No ratings yet
Excel Importer Exporter V2 DOC en
26 pages
DmSwitch EDD E1 Install Guide
No ratings yet
DmSwitch EDD E1 Install Guide
40 pages
Extreme Broadband Testing: The Adtech AX/4000 Broadband Test System
No ratings yet
Extreme Broadband Testing: The Adtech AX/4000 Broadband Test System
17 pages
Industrial System 800xa Extended Automation: The Power of Integration
No ratings yet
Industrial System 800xa Extended Automation: The Power of Integration
20 pages
Junos Release Notes 10.2
No ratings yet
Junos Release Notes 10.2
284 pages
TL1 Command 68p09278a34
No ratings yet
TL1 Command 68p09278a34
127 pages
Mcafee Data Loss Prevention 9.2.0: Installation Guide
No ratings yet
Mcafee Data Loss Prevention 9.2.0: Installation Guide
76 pages
Ensemble Faqs PDF
No ratings yet
Ensemble Faqs PDF
30 pages
RPS SC200 Mib
No ratings yet
RPS SC200 Mib
94 pages
Library Navigator: Succession 3.0
No ratings yet
Library Navigator: Succession 3.0
90 pages
Westell Model 3504-22Sc Issue B Quadjack For The Westell Quadjack Fiber Transport System
No ratings yet
Westell Model 3504-22Sc Issue B Quadjack For The Westell Quadjack Fiber Transport System
12 pages
Process Control System - Contronic P IO Boards
No ratings yet
Process Control System - Contronic P IO Boards
138 pages
Acom EVO Manager 025-9642 PDF
No ratings yet
Acom EVO Manager 025-9642 PDF
83 pages
B Ons Line Card Configuration
No ratings yet
B Ons Line Card Configuration
1,222 pages
Passport 8600: Resilient Network Solutions
No ratings yet
Passport 8600: Resilient Network Solutions
6 pages
Fortiwlc SD v8.4 Userguide
No ratings yet
Fortiwlc SD v8.4 Userguide
574 pages
MPR Configuration File Management PDF
No ratings yet
MPR Configuration File Management PDF
190 pages
OME0524018-03D Type39FH Manual 10 5 2010
No ratings yet
OME0524018-03D Type39FH Manual 10 5 2010
72 pages
Accedian Skylight Performance Element GT Datasheet
No ratings yet
Accedian Skylight Performance Element GT Datasheet
3 pages
RCMS2900 Series 2
No ratings yet
RCMS2900 Series 2
7 pages
FSP3000R7 R19.3 Management Data Guide IssA
No ratings yet
FSP3000R7 R19.3 Management Data Guide IssA
4,246 pages
Nortel Passport 7400/15000 Series: Management Module Guide
No ratings yet
Nortel Passport 7400/15000 Series: Management Module Guide
27 pages
OIF CMIS Interoperability Demo ECOC2024 Final
No ratings yet
OIF CMIS Interoperability Demo ECOC2024 Final
23 pages
Cisco ASR 9000 Series Modular Line Cards
No ratings yet
Cisco ASR 9000 Series Modular Line Cards
7 pages
IFC Centralized Manager 7.1 UG 913-2091-01 ZA
No ratings yet
IFC Centralized Manager 7.1 UG 913-2091-01 ZA
244 pages
LCT Manual
No ratings yet
LCT Manual
315 pages
Appendix Cause Code Definitions: Passport 7400, 15000, 20000 ATM Monitoring and Troubleshooting Guide 5.1S1
No ratings yet
Appendix Cause Code Definitions: Passport 7400, 15000, 20000 ATM Monitoring and Troubleshooting Guide 5.1S1
13 pages
GV - RSM 8 4 0 0 - RN
No ratings yet
GV - RSM 8 4 0 0 - RN
13 pages
Netsmart: Network Management Solutions
No ratings yet
Netsmart: Network Management Solutions
7 pages
ADVA FSP 3000 CloudConnect
No ratings yet
ADVA FSP 3000 CloudConnect
6 pages
Alcatel 1000 s12 Raptor
No ratings yet
Alcatel 1000 s12 Raptor
2 pages
DRGOS 1.5.1 R Command Reference A
100% (1)
DRGOS 1.5.1 R Command Reference A
184 pages
Nir Aes101so
No ratings yet
Nir Aes101so
42 pages
Installing and Upgrading Avaya Aura Session Manager
No ratings yet
Installing and Upgrading Avaya Aura Session Manager
76 pages
Ensemble Connector API Guide 80000053770 A 18.4.1
100% (1)
Ensemble Connector API Guide 80000053770 A 18.4.1
158 pages
Infineon XMC4500 RM
No ratings yet
Infineon XMC4500 RM
2,636 pages
Sma1 4uc
No ratings yet
Sma1 4uc
4 pages
Thingworx Extension Development User Guide PDF
No ratings yet
Thingworx Extension Development User Guide PDF
93 pages
Cisco NCS 1004 Installation Guide
No ratings yet
Cisco NCS 1004 Installation Guide
22 pages
R18.2 XTC Hardware Description Guide
No ratings yet
R18.2 XTC Hardware Description Guide
680 pages
License Cert1287221
No ratings yet
License Cert1287221
1 page
Cisco Products PDF
No ratings yet
Cisco Products PDF
415 pages
NE80E Core Router V600R002 Product Brochure
No ratings yet
NE80E Core Router V600R002 Product Brochure
8 pages
Technical Specifications Cisco 4451 Cisco 4431 Cisco 4351 Cisco 4331 Cisco 4321 Cisco 4221
No ratings yet
Technical Specifications Cisco 4451 Cisco 4431 Cisco 4351 Cisco 4331 Cisco 4321 Cisco 4221
1 page
009-3253-195 (5400 R4.0 NM Fundamentals) RevA
No ratings yet
009-3253-195 (5400 R4.0 NM Fundamentals) RevA
78 pages
Harris Truepoint 5000 Overview)
No ratings yet
Harris Truepoint 5000 Overview)
14 pages
ENC Administrator Manual
No ratings yet
ENC Administrator Manual
646 pages
Network Element Director FSP3000
No ratings yet
Network Element Director FSP3000
483 pages
OSA542211 5 1CLIReferenceGuide
No ratings yet
OSA542211 5 1CLIReferenceGuide
884 pages
doCONTROL - Guide Utilisateur
No ratings yet
doCONTROL - Guide Utilisateur
53 pages
ABB Freelance PLC & PCS 7 Integration
No ratings yet
ABB Freelance PLC & PCS 7 Integration
57 pages
Multiuser Engineering with TIA Portal
No ratings yet
Multiuser Engineering with TIA Portal
62 pages
FSP3000R7 R19.2 Maintenance and Troubleshooting Manual IssA
No ratings yet
FSP3000R7 R19.2 Maintenance and Troubleshooting Manual IssA
1,256 pages
Chapter 11: Virtual Wan Part 1 - S2S VPN and Vnet Connections
No ratings yet
Chapter 11: Virtual Wan Part 1 - S2S VPN and Vnet Connections
40 pages
Enterprise DevOps Architecture Guide
No ratings yet
Enterprise DevOps Architecture Guide
40 pages
Commands SNMP
No ratings yet
Commands SNMP
6 pages
Prometheus SNMP Exporter Setup Guide
No ratings yet
Prometheus SNMP Exporter Setup Guide
18 pages
Fundamentals of Application Security
100% (1)
Fundamentals of Application Security
57 pages
MT7621A Network Processor Datasheet
No ratings yet
MT7621A Network Processor Datasheet
54 pages
Autopilot Cetrek Fault Codes
No ratings yet
Autopilot Cetrek Fault Codes
1 page
Xplore xDock & xDIM Docking Systems
No ratings yet
Xplore xDock & xDIM Docking Systems
2 pages
Distributed Information Systems: Lecture 4 - Linq
No ratings yet
Distributed Information Systems: Lecture 4 - Linq
19 pages
L3U42A
No ratings yet
L3U42A
4 pages
AMD's CDNA 3 Compute Architecture - Chips and Cheese
No ratings yet
AMD's CDNA 3 Compute Architecture - Chips and Cheese
24 pages
Chapter One UG
No ratings yet
Chapter One UG
90 pages
Computer Awareness For Rbi Assistant Mains
No ratings yet
Computer Awareness For Rbi Assistant Mains
25 pages
China's Humanoid Robots Generate More Soccer Excitement Than Their Human Counterparts - Technology News
No ratings yet
China's Humanoid Robots Generate More Soccer Excitement Than Their Human Counterparts - Technology News
2 pages
Data Sheet - RUCKUS R600
No ratings yet
Data Sheet - RUCKUS R600
5 pages
2022 HR Management Trends & Innovations
No ratings yet
2022 HR Management Trends & Innovations
34 pages
XXX
No ratings yet
XXX
22 pages
Introduction To Javascript
No ratings yet
Introduction To Javascript
127 pages
Ifall: An Android Application For Fall Monitoring and Response
No ratings yet
Ifall: An Android Application For Fall Monitoring and Response
4 pages
ESA Flight Software Testing Overview
No ratings yet
ESA Flight Software Testing Overview
32 pages
HDD or SDD Replacement NUTANIX
No ratings yet
HDD or SDD Replacement NUTANIX
14 pages
IoT Architecture for Smart Cities
No ratings yet
IoT Architecture for Smart Cities
32 pages
SPPID Users Guide
93% (15)
SPPID Users Guide
705 pages
ADAM 4000: Data Acquisition Modules User's Manual
No ratings yet
ADAM 4000: Data Acquisition Modules User's Manual
414 pages
Differences Between Natural and Programming Languages
No ratings yet
Differences Between Natural and Programming Languages
4 pages
Cyber Security Course Structure at Brainware
No ratings yet
Cyber Security Course Structure at Brainware
7 pages
AIS Over WiFi With The DT-06 Module
100% (1)
AIS Over WiFi With The DT-06 Module
2 pages
Web Development Resourses
No ratings yet
Web Development Resourses
3 pages
Chapter 1
No ratings yet
Chapter 1
21 pages
Network Configuration Details
No ratings yet
Network Configuration Details
3 pages
Java Programming Exercises for MCA Students
No ratings yet
Java Programming Exercises for MCA Students
42 pages
Report - Sales Order Stock Report
100% (1)
Report - Sales Order Stock Report
24 pages
Employability Skills - Grade 9 Textbook-1-1
No ratings yet
Employability Skills - Grade 9 Textbook-1-1
23 pages
Y10 P1 Mid-Years QP 2025
No ratings yet
Y10 P1 Mid-Years QP 2025
10 pages

ENC Integration Manual

Uploaded by

ENC Integration Manual

Uploaded by

Integration Manual

Product Release: 15.3

Ensemble Controller R15.3 -Integration Manual - Issue: A 2

Ensemble Controller R15.3 Integration Manual - Issue: A 3

Ensemble Controller R15.3 Integration Manual - Issue: A 4

Ensemble Controller R15.3 Integration Manual - Issue: A 5

Launching the Craft Terminal 24

Ensemble Controller R15.3 Integration Manual - Issue: A 6

Changes in Release 9.6 55

Ensemble Controller R15.3 Integration Manual - Issue: A 7

Ensemble Controller R15.3 Integration Manual - Issue: A 8

Cleanup of Old Report Files Stored 111

Ensemble Controller R15.3 Integration Manual - Issue: A 9

About the MTOSI North Bound Interface 139

Ensemble Controller R15.3 Integration Manual - Issue: A 10

Safety Symbol and Message

Icon Meaning Description

Notice Indicates the risk of equipment damage, malfunction,

Note Indicates supplemental information or helpful

Ensemble Controller R15.3 Integration Manual - Issue: A 11

Release Old Name / New Name New Remark

11.1.1 Network Ensemble ENC

Network Ensemble ENC Server

Network Ensemble ENC Client

Service Manager Ensemble Optical EOD

Sync Manager Ensemble Sync ESD

Ethernet Ensemble ECBM

Encryption Ensemble ECGD

Bandwidth Ensemble EBM

12.2.1 Network Centralized CPc User

12.3.1 Ensemble CryptoManager

Ensemble Controller R15.3 Integration Manual - Issue: A 12

Release Old Name / New Name New Remark

13.1.1 Control Plane Centralized CPc Manager

Ensemble Controller Documentation Suite

These manuals especially address licensed Ensemble Controller features:

World Wide Web

Documentation Portal https://advadocs.com/

Ensemble Controller R15.3 Integration Manual - Issue: A 13

Obtaining Ensemble Controller

Exporting the Info Window 15

Ensemble Controller R15.3 Integration Manual - Issue: A 14

Accessing the Client Error Log File 15

Exporting the Info Window

Accessing the Client Error Log File

Creating a System Health Report

Requirement to Create a System Health Report 15

Requirement to Create a System Health Report

Procedure to Create a System Health Report

Ensemble Controller R15.3 Integration Manual - Issue: A 15

Obtaining Technical Assistance

Ensemble Controller R15.3 Integration Manual - Issue: A 16

Document Revision History

Product Document Document Issue Date Description

9.6 80000041718 Issue A February 2017 Updated manual

Ensemble Controller R15.3 Integration Manual - Issue: A 17

Product Document Document Issue Date Description

Issue B March 2017 Restructured the

10.1 80000043003 Issue A May 2017 Updated manual

Issue B July 2017 Updated the Link

10.2 80000044011 Issue A September Manual updated

Issue B October 2017 Removed the last

Added event log

10.3 80000046841 Issue A February 2018 Manual updated

Issue B Added the section

Ensemble Controller R15.3 Integration Manual - Issue: A 18

Product Document Document Issue Date Description

10.4 80000048556 Issue A June 2018 Manual updated

11.1 80000052358 Issue A March 2019

11.2 80000053553 Issue A July 2019

11.3 80000056610 Issue A November

Issue B December Revised the update

12.1 80000058299 Issue A March 2020 Manual updated

12.4 80000062653 Issue A January 2021

13.1 80000063281 Issue A April 2021

Issue B June 2021 Updated