Apollo

STMS User Guide

V12
Document Revision: 01
Published: June 2024
© 2024 Ribbon Communications Operating Company, Inc. © 2024 ECI Telecom Ltd. All rights reserved.
This is a legal agreement between you, the end user, and ECI Ltd. (“ECI”). BY OPENING THE DOCUMENTATION AND/OR DISK
PACKAGE, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS
OF THIS AGREEMENT, PROMPTLY RETURN THE UNOPENED DOCUMENTATION AND/OR DISK PACKAGE AND THE
ACCOMPANYING ITEMS (INCLUDING WRITTEN MATERIALS AND BINDERS OR OTHER CONTAINERS), TO THE PLACE FROM
WHICH YOU OBTAINED THEM.
All documentation and/or disk and all information and/or data contained in the documentation and/or disk ["ECI's Proprietary"] is ECI's
proprietary and is subject to all copyright, patent, and other laws protecting intellectual property, and any international treaty provisions,
as well as any specific agreement protecting ECI's rights in the aforesaid information. Any use of ECI's Proprietary for any purposes
[included but not limited: published, reproduced, or disclosed to third parties, in whole or in part] other than those for which it was
disclosed, without the express prior written permission of ECI, is strictly forbidden.
ECI's Proprietary is provided "AS IS" and may contain flaws, omissions, or typesetting errors. No responsibility and or liability
whatsoever are assumed by ECI for you or any other party, for the use thereof, nor for the rights of third parties, nor for any loss or
damage whatsoever or howsoever caused, arising directly or indirectly in connection with ECI's Proprietary, which may be affected in
any way by the use and/or dissemination thereof. ECI reserves the right, without prior notice or liability, to make changes in equipment
design or specifications including any change in and to the ECI's Proprietary.
Any representation(s) in ECI's Proprietary concerning performance of ECI's product(s) are for informational purposes only and are not
warranties of product performance or otherwise, either express or implied. No warranty is granted nor liability assumed in relation
thereto, unless specifically undertaken in ECI's sales contract or order confirmation. ECI's Proprietary is periodically updated, and
changes will be incorporated in subsequent editions. All graphics included in this document are for illustrative purposes only and might
not correspond with your specific product version.
The documentation and/or disk and all information contained therein is owned by ECI and is protected by all relevant copyright, patent,
and other applicable laws and international treaty provisions. Therefore, you must treat the information contained in the documentation
and disk as any other copyrighted material (for example, a book or musical recording).
Other Restrictions. You may not rent, lease, sell, or otherwise dispose of ECI's Proprietary, as applicable.
YOU MAY NOT USE, COPY, MODIFY, OR TRANSFER THE DOCUMENTATION AND/OR DISK OR ANY COPY IN WHOLE OR PART,
EXCEPT AS EXPRESSLY PROVIDED IN THIS LICENSE. ALL RIGHTS NOT EXPRESSLY GRANTED ARE RESERVED BY ECI.
All trademarks mentioned herein are the property of their respective holders.
Notwithstanding the generality of the aforementioned, you expressly waive any claim and/or demand regarding liability for indirect,
special, incidental, or consequential loss or damage which may arise in respect of ECI's Proprietary contained therein, howsoever
caused, even if advised of the possibility of such damages.
The end user hereby undertakes and acknowledges that they read the "Before You Start/Safety Guidelines" instructions (when provided
by ECI) and that such instructions were understood by them. ECI shall not be liable to you or to any other party for any loss or damage
whatsoever or howsoever caused, arising directly or indirectly in connection with you fulfilling and/or failure to fulfill in whole or in part
the "Before You Start/Safety Guidelines" instructions.

Ribbon's qualification lab is accredited by A2LA for competence in electrical testing according to the International
Standard ISO IEC 17025-2017 General Requirements for the Competence of Testing and Calibration Laboratories.\

Ribbon's management applications run on VMWare virtualization hypervisors.

Catalog #: X66945
Drawing #: 497006-2412-148-A00
Contents
STMS User Guide .............................................................................................................. 1
STMS User Guide Revision History................................................................................. 2
Network Setup ................................................................................................................... 3
Group Configuration .........................................................................................................................................3
Create a Group........................................................................................................................................... 4
Move a Group............................................................................................................................................. 4
Delete a Group ........................................................................................................................................... 4
NE Discovery: STMS........................................................................................................................................4
NE Discovery via the STMS Client............................................................................................................. 4
NE Discovery via the STMS Discovery Utility ............................................................................................ 6
Define the NE ID ........................................................................................................................................ 9
Define STMS Server Data..............................................................................................................................10
View STMS Domain Properties......................................................................................................................10
View SNMP Settings ......................................................................................................................................12
Define the NE Configuration Files Directory...................................................................................................13
Define STMS Performance Parameters.........................................................................................................13
Maintain Historical Alarms ..............................................................................................................................14
Upgrade the ST Software ...............................................................................................................................14
Rollback the ST Software ...............................................................................................................................20
Change Server IP Address.............................................................................................................................21
Change the IP Address in the DB Server or Zone.................................................................................... 23
Change the IP Address in the NMS Server or Zone................................................................................. 28
Change the IP Address in the STMS Server or Zone............................................................................... 29
Connect STMS to OSS ..................................................................................................................................36
NE Management .............................................................................................................. 38
NE Implicit Configuration................................................................................................................................38
Equipment Implicit Configuration.............................................................................................................. 39
Controller Cards Implicit Configuration..................................................................................................... 39
Severity Profiles Implicit Configuration..................................................................................................... 39
PM Threshold Profiles Implicit Configuration ........................................................................................... 40
Cross Connection Implicit Configuration .................................................................................................. 40
Protection Group Implicit Configuration.................................................................................................... 40
Transport Entities Implicit Configuration................................................................................................... 40
Configure an NE Using Plug and Play ...........................................................................................................41

Ribbon Communications Inc. Proprietary iii

 Contents

View NE Properties ........................................................................................................................................43

View NE Operational Status ...........................................................................................................................49
View Inventory Reports ..................................................................................................................................49
Connect to an NE Using SSH ........................................................................................................................52
Check Network Connectivity ..........................................................................................................................53
Ping to Check Reachability of a Host ....................................................................................................... 53
Delete an NE from the STMS Database ........................................................................................................55
Move an NE....................................................................................................................................................56
Reboot an NE.................................................................................................................................................56
Flash LEDs on an NE.....................................................................................................................................57
Refresh an NE................................................................................................................................................57
Refresh Alarm Information..............................................................................................................................57
Management Port Down Alarm ......................................................................................................................58
Unmanage an NE...........................................................................................................................................58
Reconnect an NE ...........................................................................................................................................58
Change the NE IP Address ............................................................................................................................58
Enabling NE IP Change Capability........................................................................................................... 59
Possible Configuration on NE During IP Change..................................................................................... 59
Define Logging for an NE ...............................................................................................................................61
View NE Temperature Statistics .....................................................................................................................62
View Inhale Air Temperature and Rotation Speed..........................................................................................63
View NE Power Control Areas........................................................................................................................65
View NE Capacity Data ..................................................................................................................................67
Define LCT Access to an NE ..........................................................................................................................69
Define Cryptographic Strength Security .........................................................................................................70
Crypto-Profiles.......................................................................................................................................... 70
Define a Crypto-Profile ............................................................................................................................. 71
View the Crypto Show Profile Tab ............................................................................................................ 72
View the Supported Profiles Tab .............................................................................................................. 72
Define Diffie Hellman (DH) Groups ................................................................................................................73
NTP Configuration ..........................................................................................................................................74
Configure NTP on an NE.......................................................................................................................... 75
Add an NTP Bootstrap Server for an NE.................................................................................................. 76
Remove an NTP Bootstrap Server from an NE........................................................................................ 76
Add an NTP Authentication Key for an NE............................................................................................... 76
Remove an NTP Authentication Key from an NE..................................................................................... 77
Define NTP Symmetric Mode ................................................................................................................... 77

Ribbon Communications Inc. Proprietary iv

 Contents

Remove a Peer from the NTP Peers List for an NE................................................................................. 78

Define NTP Client Mode........................................................................................................................... 78
Remove an NTP Server from the List of Servers for an NE..................................................................... 79
Define an NTP Host in Broadcast Mode for an NE .................................................................................. 79
Define NTP Broadcast Client Mode ......................................................................................................... 80
Set the Device Date and Time.................................................................................................................. 80
Remove the NTP Configuration from an NE ............................................................................................ 81
View NTP Properties ................................................................................................................................ 81
Security Certificate Management ...................................................................................................................82
Register a CA ........................................................................................................................................... 83
Configure the CA...................................................................................................................................... 83
Generate Certificates for all NEs.............................................................................................................. 84
Generate a CA Signed Certificate for STMS ............................................................................................ 85
Activate a CA Signed Certificate for STMS .............................................................................................. 85
Generate a Certificate for a Specific NE .................................................................................................. 86
Activate a Certificate for a Specific NE..................................................................................................... 86
View a CSR .............................................................................................................................................. 87
Delete a CA .............................................................................................................................................. 88
View CA Status......................................................................................................................................... 88
View Signed Certificate Status ................................................................................................................. 89
View Deleted Authority Status .................................................................................................................. 90
View the CRL............................................................................................................................................ 91
View the Peer IPs Table: STMS ............................................................................................................... 92
Secure Boot.............................................................................................................................................. 93
NE Configuration Backup and Restore ..........................................................................................................94
Define the Backup File Directory.............................................................................................................. 95
Perform an Immediate Network Configuration Backup ............................................................................ 95
Schedule a Network Configuration Backup.............................................................................................. 96
View All Network Configuration Backups ................................................................................................. 96
View a Specific Network Configuration Backup ....................................................................................... 97
View the Network Configuration Backup Log ........................................................................................... 97
Suspend a Scheduled Network Configuration Backup ............................................................................ 97
Resume a Scheduled Network Configuration Backup ............................................................................. 97
Monitor the Network Configuration Backups ............................................................................................ 98
Edit a Scheduled Network Configuration Backup .................................................................................... 98
Delete a Scheduled Network Configuration Backup ................................................................................ 98
Sort the List of Scheduled Network Configuration Backups..................................................................... 98

Ribbon Communications Inc. Proprietary v

 Contents

Verify a Network Configuration Backup.................................................................................................... 99

Delete a Network Configuration Backup .................................................................................................. 99
Compare Network Configuration Backups ............................................................................................... 99
Save a Network Configuration Backup to a File....................................................................................... 99
Restore an NE Configuration Backup ...................................................................................................... 99
Restore a Selected Configuration .......................................................................................................... 100
NE Event Logs .............................................................................................................................................100
View NE Event Logs............................................................................................................................... 100
Filter the NE Event Logs List.................................................................................................................. 101
Define the Number of Logs per Page..................................................................................................... 102
Purge NE Event Logs............................................................................................................................. 102
Export NE Event Logs to an XML File .................................................................................................... 102
Stop and Restart Logging for NE Events ............................................................................................... 103
ASON WSON Configuration.........................................................................................................................104
View ASON-WSON Control Plane Attributes ......................................................................................... 104
View ASON-WSON Control Plane Protocol Attributes ........................................................................... 105
View ASON-WSON Port Parameters ..................................................................................................... 108
View the ASON-WSON Trails List ...........................................................................................................110
View the GMPLS Control Channels List..................................................................................................112
View XC Resource Ownership ................................................................................................................113
Define Auto-Discovered ASON Data Links..............................................................................................113
Define RSVP Authentication......................................................................................................................... 114
View RSVP Statistics...............................................................................................................................118
Synchronize the Standby RCP Configuration ..............................................................................................120
Define Utilization Thresholds........................................................................................................................120
Configure a Subtending Shelf ......................................................................................................................121
View the Maintenance List ...........................................................................................................................122
Change the NE Password ............................................................................................................................123
Cards and Modules ....................................................................................................... 125
OPT99xx Cards and Modules ......................................................................................................................125
HIO10_20 ............................................................................................................................................... 125
HIO10_40 ............................................................................................................................................... 126
HIO100_2 ............................................................................................................................................... 128
TIOMR_32 .............................................................................................................................................. 128
HIO500 ................................................................................................................................................... 129
HIO400A................................................................................................................................................. 131
OPT99xx Common Cards and Modules (OPT99xx) .............................................................................. 131

Ribbon Communications Inc. Proprietary vi

 Contents

OPT9904X Cards and Modules ...................................................................................................................132

AoC10B and AoC10C............................................................................................................................. 132
MIO200 and MIO200EN......................................................................................................................... 134
MIO200B and MIO200BEN .................................................................................................................... 135
MIO700................................................................................................................................................... 138
OPT99xx Common Cards and Modules (OPT9904x) ............................................................................ 140
Supported Passive and Photonic Cards................................................................................................. 140
OPT9901X Cards and Modules ...................................................................................................................141
OPT9901X Common Cards and Modules.............................................................................................. 142
ADM100 ................................................................................................................................................. 142
RADM100............................................................................................................................................... 142
Agg200 ................................................................................................................................................... 143
MADM10 ................................................................................................................................................ 143
CPE10 .................................................................................................................................................... 144
CPE100 .................................................................................................................................................. 145
DCMR100............................................................................................................................................... 145
ADM100HO ............................................................................................................................................ 146
OPT96xx Cards and Modules ......................................................................................................................146
TR10_4................................................................................................................................................... 147
TR10_4EN.............................................................................................................................................. 148
TR10_12-TR10_12R .............................................................................................................................. 149
TR10_12ULL .......................................................................................................................................... 149
TR100-TR100L....................................................................................................................................... 150
TR200_2................................................................................................................................................. 151
TR200_2A .............................................................................................................................................. 151
TM100 .................................................................................................................................................... 152
TM200EN ............................................................................................................................................... 152
TM100_2EN ........................................................................................................................................... 154
TM100_2ENB......................................................................................................................................... 155
TM200ENB............................................................................................................................................. 156
TM400 .................................................................................................................................................... 157
TM400-REG100 ..................................................................................................................................... 158
TM400R and TM400ENB ....................................................................................................................... 159
TM400_2 ................................................................................................................................................ 162
TM800 .................................................................................................................................................... 165
TM800_2 ................................................................................................................................................ 166
TM800_2REG ........................................................................................................................................ 168

Ribbon Communications Inc. Proprietary vii

 Contents

TM800E .................................................................................................................................................. 169

TM1200 .................................................................................................................................................. 169
TM1200E ................................................................................................................................................ 170
AoC10-AoC10B...................................................................................................................................... 171
AoC10C .................................................................................................................................................. 172
AoC25-AoC25B...................................................................................................................................... 173
CMR40B ................................................................................................................................................. 174
CMR100-CMR100L................................................................................................................................ 175
CMR100M .............................................................................................................................................. 176
OPT96xx Common Cards and Modules................................................................................................. 177
CMR200 ................................................................................................................................................. 178
OPT96xx Fabric Interface Cards..................................................................................................................179
FIO10_5-FIO10_5B................................................................................................................................ 179
FIOMR_16-FIOMR_16B......................................................................................................................... 180
FIO100 ................................................................................................................................................... 181
FIO100M ................................................................................................................................................ 181
OPT96xx Layer 2 Cards...............................................................................................................................181
AoC10_L2 .............................................................................................................................................. 182
AoC10_L2 Port Configuration ................................................................................................................ 182
AoC10_L2 Switch Configuration ............................................................................................................ 189
Optical Components.....................................................................................................................................206
Multidegree ROADM Cards.................................................................................................................... 207
Mux-DeMux Cards ................................................................................................................................. 212
OADM Cards .......................................................................................................................................... 216
Optical Filters, Splitters, and Couplers ................................................................................................... 219
Optical Amplifiers.................................................................................................................................... 223
OTDR ..................................................................................................................................................... 236
OTDR_8 ................................................................................................................................................. 237
OTDR_30_1625_XFP ............................................................................................................................ 237
OTDR1610_8s, OTDR1610M_8s, OTDR1625M_8s, OTDR1626_8s ................................................... 237
DCF ........................................................................................................................................................ 238
OMSP ..................................................................................................................................................... 239
OLP_S2 .................................................................................................................................................. 239
Pluggable Transceiver Modules ...................................................................................................................239
Assign Cards ................................................................................................................................................240
Replace Cards..............................................................................................................................................242
Unassign a Card...........................................................................................................................................243

Ribbon Communications Inc. Proprietary viii

 Contents

View the Card Description ............................................................................................................................243

View Card Properties ...................................................................................................................................243
Optical Card Properties .......................................................................................................................... 243
xRCP-RCP Card Properties ................................................................................................................... 244
CTM Card Properties ............................................................................................................................. 246
View Card Performance Statistics................................................................................................................247
xRCP-RCP Card Operations ........................................................................................................................249
Restart an xRCP-RCP Card ................................................................................................................... 249
Reboot an xRCP-RCP Card ................................................................................................................... 249
Configure xRCP-RCP Redundancy ....................................................................................................... 250
Ports and Interfaces...................................................................................................... 252
Supported Ports and Interfaces....................................................................................................................252
Terminology ..................................................................................................................................................254
Supported Interfaces ....................................................................................................................................254
OTN Interfaces ....................................................................................................................................... 255
FC Interfaces.......................................................................................................................................... 256
Video Interfaces ..................................................................................................................................... 256
Management Interfaces.......................................................................................................................... 256
Physical Optical Interfaces ..................................................................................................................... 256
SDH Interfaces ....................................................................................................................................... 256
SONET Interfaces .................................................................................................................................. 257
Channelized Interfaces........................................................................................................................... 258
Concatenated Interfaces ........................................................................................................................ 259
1 GbE and 10 GbE Interfaces ................................................................................................................ 259
10, 100, and 1000 Mbps Ethernet Interfaces ......................................................................................... 259
Logical Interfaces ................................................................................................................................... 259
Interface Name.............................................................................................................................................260
Logical Interface Numbering ........................................................................................................................260
Router ID and Primary Address....................................................................................................................261
Primary Interface ..........................................................................................................................................261
IP Addresses and Interfaces ........................................................................................................................261
View Port Properties.....................................................................................................................................261
Enable or Disable a Port ..............................................................................................................................262
Configure Ports ............................................................................................................................................262
Configure TM200EN and TM100_2EN Card Ports ................................................................................ 264
Configure Frequencies for an OCHP Port.............................................................................................. 265
Configuring an OCHP Port for Alien Transmission................................................................................. 267

Ribbon Communications Inc. Proprietary ix

 Contents

Loopback Interfaces .....................................................................................................................................271

Enable or Disable a Loopback Interface ................................................................................................ 271
Create a Logical Loopback Interface...................................................................................................... 271
Enable or Disable a Logical Loopback Interface .................................................................................... 271
Enter a Description for a Logical Loopback Interface ............................................................................ 272
Delete a Logical Loopback Interface ...................................................................................................... 272
View the Interfaces in a Loopback Interface Folder ............................................................................... 272
View Logical Loopback Interface Properties .......................................................................................... 273
Define TR10_4EN-TR10_12EN Encryption Settings ...................................................................................274
Define TR10_12ENB Encryption Settings....................................................................................................276
Define TM200EN-TM100_2EN Encryption Settings ....................................................................................277
Define TM200ENB-TM100_2ENB Encryption Settings................................................................................278
Define HIO400EN-MIO200EN Encryption Settings .....................................................................................279
OTDR Management .....................................................................................................................................279
Start OTDR Calibration .......................................................................................................................... 279
Start OTDR Test ..................................................................................................................................... 280
Run OTDR_8 Tests ......................................................................................................................................281
Upload SOR Files from an NE .....................................................................................................................285
View ONCP Data..........................................................................................................................................285
Configure LOS Threshold.............................................................................................................................286
Define Performance Margin Threshold ........................................................................................................286
View Configured VPPs .................................................................................................................................287
Define the OSPF Area for an OSC Port .......................................................................................................288
Define the OSPF Area for an OTU Port .......................................................................................................289
Define OSPF-TE Authentication for GMPLS Routing Instances ..................................................................291
Define OSPF Areas for DCN Routing Instances ..........................................................................................293
Define Spectral Pre-Emphasis .....................................................................................................................295
Define Fast State of Polarization Tracking ...................................................................................................296
Port Maintenance .........................................................................................................................................297
Run an Optical Loopback Command ..................................................................................................... 297
Run a Send BDI Command.................................................................................................................... 297
Run a Send CSF Command................................................................................................................... 298
Set Test Mode......................................................................................................................................... 298
Run a Delay Measurement Operation.................................................................................................... 298
Run a PRBS Detection Test ................................................................................................................... 299
L1-XCs ............................................................................................................................ 301
L1-XC Compatibility Guidelines....................................................................................................................301

Ribbon Communications Inc. Proprietary x

 Contents

L1-XC Modes ...............................................................................................................................................303

L1-XC Leg Directionality...............................................................................................................................303
ODU-XC Fabric Support...............................................................................................................................303
L1-XC Protection ..........................................................................................................................................305
Unprotected Configurations.................................................................................................................... 305
Protected Configurations........................................................................................................................ 306
Define Y-Protection................................................................................................................................. 308
Managing L1-XCs.........................................................................................................................................309
View L1-XCs........................................................................................................................................... 309
Create L1-XCs........................................................................................................................................ 310
Modify an L1-XC..................................................................................................................................... 314
Delete L1-XCs ........................................................................................................................................ 316
L1-XC Connection Tables.............................................................................................................................316
Packet Configuration .................................................................................................... 324
Configure L2 Port Parameters......................................................................................................................324
Configure Link OAM .....................................................................................................................................326
View Link OAM Events and Statistics ..........................................................................................................326
Configure Link OAM Thresholds ..................................................................................................................327
Switch Configuration ....................................................................................................................................327
Configure Switch Properties................................................................................................................... 328
Configure a VLAN ID Range Profile ....................................................................................................... 330
Configure a Port TPID Profile ................................................................................................................. 331
Configure a CoS Group Profile............................................................................................................... 332
Configure a QoS Profile ......................................................................................................................... 333
Configure a Policer Profile...................................................................................................................... 340
Configure a WRED Profile...................................................................................................................... 341
Configure a Slow Path Policer Profile .................................................................................................... 343
Configure a LAG..................................................................................................................................... 344
Configure Slow Path............................................................................................................................... 348
View Configured VSIs ............................................................................................................................ 349
View VSI Properties ............................................................................................................................... 349
View VSI Statistics.................................................................................................................................. 350
Protection....................................................................................................................... 353
Equipment Protection ...................................................................................................................................353
FM Protection ......................................................................................................................................... 353
Fast IOP Protection ................................................................................................................................ 353
Port Protection..............................................................................................................................................356

Ribbon Communications Inc. Proprietary xi

 Contents

Port Association Guidelines.................................................................................................................... 356

IOP Protection for L1 Ports .................................................................................................................... 357
IOP Protection for Physical Packet Ports ............................................................................................... 363
Traffic Protection ..........................................................................................................................................366
Modify a Traffic Protection Group of L1-XCs: OPT99xx......................................................................... 367
Modify a Traffic Protection Group of L1-XCs: OPT96xx......................................................................... 368
ROADM Protection.......................................................................................................................................369
Configure an ASE Leg............................................................................................................................ 370
Protection Maintenance................................................................................................................................374
Perform Protection Maintenance............................................................................................................ 375
View Protection Alarms ................................................................................................................................376
FM Fabric Status ..........................................................................................................................................376
Fiber Connectivity ......................................................................................................... 377
Fiber Connectivity Prerequisites and Guidelines .........................................................................................378
Define Fiber Connectivity .............................................................................................................................378
Define Fiber Connectivity for an NE Managed by a Different STMS............................................................380
Define Fiber Connectivity for Alien (non-Apollo) Equipment ........................................................................381
View Fiber Connectivity for an NE................................................................................................................381
Fiber and Port Connectivity Rules................................................................................................................382
Customer Management................................................................................................. 390
Create a Customer .......................................................................................................................................390
Modify Customer Information .......................................................................................................................391
Customer Import and Export ........................................................................................................................391
Import Customer Information.................................................................................................................. 391
Export Customer Information ................................................................................................................. 391
Customer Reports ........................................................................................................................................392
Generate a Customer Report: STMS ..................................................................................................... 392
Generate an Interface Utilization Report: STMS .................................................................................... 392
Delete a Customer .......................................................................................................................................393
View Customer Information ..........................................................................................................................393
Apollo Workflows .......................................................................................................... 395
Apollo Workflow: Add ROADM Degrees ......................................................................................................395
To add a new ROADM card to Site A ..................................................................................................... 396
Assign New ROADM Card in Site A ....................................................................................................... 397
Configure Port on New ROADM Card.................................................................................................... 400
Create a Logical Element for a New ROADM Card ............................................................................... 401

Ribbon Communications Inc. Proprietary xii

 Contents

Create Links Between LEs ..................................................................................................................... 403

Apollo Workflow: Add WSON-Protected Trail...............................................................................................408
Create OMS DL Trails: NMS .................................................................................................................. 409
Create WSON-Protected OCH Trail: NMS ............................................................................................. 412
Provision an LP Trail for the New Service: NMS .................................................................................... 413
Apollo Workflow: Change Bandwidth ...........................................................................................................414
Configure Client and Line Ports on MIO200 Cards - Both NEs: EMS.................................................... 415
Create Topology Links Between Line Ports: NMS.................................................................................. 416
Provision Underlying OCH Trail Between Line Ports: NMS ................................................................... 417
Provision ODU4 Trail: NMS.................................................................................................................... 418
Provision ODUF-GFP Trail: NMS ........................................................................................................... 419
Create P2P Service Between GE10 Client Ports: NMS ......................................................................... 419
Increase BW for ODUF-GFP to 5Gbps: NMS ........................................................................................ 420
Apollo Workflow: Configure an Alien Lambda Running Over an Apollo Network .........................................421
Configure Unmanaged Elements with Same Frequency and Spacing: NMS ........................................ 422
Configure TFA OCHP Port with Frequency: STMS ................................................................................ 424
Create Fiber Connectivity via LightSOFT Between the NE-TFA: STMS ................................................ 427
Enable Alien Lambda on the Same TFA Port: STMS ............................................................................. 431
Provision an OCH Trail: NMS................................................................................................................. 432
Apollo Workflow: Configure Client-Port Protection.......................................................................................434
Configure Client-Port Protection (Initial Configuration) .......................................................................... 435
Configure Client-Port Protection (Standard Operation).......................................................................... 436
Discover the Participating Network Elements: EMS............................................................................... 438
Configure Cards on the Network Element at One Service Endpoint: EMS............................................ 438
Configure Ports on TM200EN Cards on the First NE: EMS................................................................... 440
Configure Protection Group for 2 Client Ports on the First NE: EMS ..................................................... 442
Repeat Card Port and Protection Group Configuration on the Second Endpoint NE: EMS .................. 443
Create Logical Elements: NMS .............................................................................................................. 445
Create Topology Links Between the Line Ports on the Two NEs: NMS ................................................. 446
Create UME Equipment for One End of the Service: NMS .................................................................... 447
Create Topology Links Between the Client Ports and UMEs at One End of the Service: NMS ............. 448
Create UME Equipment for the Second End of the Service: NMS ........................................................ 449
Create Topology Links Between the Client Ports and UME at the Second End of the Service: NMS ... 450
Provision OCH Trails Between the Line Ports: NMS.............................................................................. 452
Provision ODU Trails Between the Line Ports - AoC and Combiner Cards Only: NMS ......................... 453
Provision an LP Trail for New Service: NMS .......................................................................................... 454
Apollo Workflow: Configure ERP Ring 8032 Protection ...............................................................................455

Ribbon Communications Inc. Proprietary xiii

 Contents

Assign Client and Line Ports on AoC10_L2 Cards: EMS ....................................................................... 456
Create LEs for the AoC10_L2 Cards: NMS............................................................................................ 457
Add Topology Links and OCH Trails Between AoC10_L2 Line Ports: NMS .......................................... 458
Create OTN LP Between AoC10_L2 Line Ports: NMS........................................................................... 459
Create ERP Service Between AoC10_L2 Cards: NMS.......................................................................... 460
Create MP2MP Service Between Client Ports: NMS ............................................................................. 461
Verify RPL Port: EMS ............................................................................................................................. 462
Apollo Workflow: Configure Multi-Route OCH Protection ............................................................................463
Configure Multi-Route OCH Protection (Initial Configuration) ................................................................ 464
Configure Multi-Route OCH Protection (Standard Operation) ............................................................... 465
Discover the Participating Network Elements - OCH: EMS ................................................................... 466
Assign Cards - TRP TFA ROADMs - on the First Endpoint NE: EMS .................................................... 467
Configure Cards and Ports on the First Endpoint NE: EMS................................................................... 468
Repeat the Card and Port Configuration on the Second Endpoint NE: EMS......................................... 470
Create the Logical Elements - MOCH: NMS .......................................................................................... 470
Create Links Between LEs: NMS ........................................................................................................... 472
Provision Underlying OMS Trails: NMS.................................................................................................. 473
Provision a Multi-Route OCH Trail: NMS ............................................................................................... 474
Configure Client Ports If Not Configured Previously - Combiner Cards: EMS ....................................... 475
Provision an LP Trail Based on the Multi-Route OCH Trail: NMS .......................................................... 476
Apollo Workflow: Configure OTN Services...................................................................................................476
Configure Client and Line Ports on MIO200 Cards on Both NEs: EMS................................................. 478
Create Topology Links Between Line Ports - OTN: NMS....................................................................... 479
Provision the Underlying OCH Trail Between Line Ports: NMS ............................................................. 480
Provision the ODU4 Trail: NMS.............................................................................................................. 481
Provision an LP Trail for the New Service - OTN: NMS ......................................................................... 481
Apollo Workflow: Configure Y-Protection......................................................................................................482
Configure Y-protection (initial configuration)........................................................................................... 483
Configure Y-protection (standard operation) .......................................................................................... 484
Discover the Participating Network Elements - Y-Protection: EMS ........................................................ 485
Configure a TR10_12 Card on the NE at One Service Endpoint: EMS ................................................. 486
Configure Three Ports on the TR10_12 Card: EMS............................................................................... 487
Repeat Card and Port Configuration on Second Endpoint NE: EMS..................................................... 488
Create the Logical Elements - Y-Protection: NMS.................................................................................. 489
Create a Topology Link Between One Set of Line Ports: NMS .............................................................. 490
Create a Direct Topology Link Between the Second Set of Line Ports: NMS ........................................ 490
Provision an Underlying OMS Trail: NMS .............................................................................................. 491

Ribbon Communications Inc. Proprietary xiv

 Contents

Provision an Underlying OCH Trail Between the First Set of Line Ports: NMS...................................... 492
Provision an Underlying OCH Trail Between the Second Set of Line Ports: NMS................................. 493
Provision LP Trail for a New Service: NMS ............................................................................................ 494
Apollo Workflow: Edit Optical Trail: Frequency ............................................................................................496
Open List of All Optical Trails ................................................................................................................. 498
Select the OCH Trail to Edit ................................................................................................................... 498
Choose the New Route: Manual or Automatic ....................................................................................... 499
Apollo Workflow: Migrate Optical Trail: Insert Site .......................................................................................503
Set Original Trail Links to Maintenance Mode........................................................................................ 505
Create New Topology Links.................................................................................................................... 506
Replace Paths ........................................................................................................................................ 509
Validate and Complete Migration ........................................................................................................... 510

Ribbon Communications Inc. Proprietary xv

STMS User Guide
This document describes how to configure and manage network elements (NEs) in your network using
STMS.

Ribbon Communications Inc. Proprietary 1

 STMS User Guide Revision History

STMS User Guide Revision History

Revision History

Revision No. Pages Changed Description of Changes

01 N/A First revision

Ribbon Communications Inc. Proprietary 2

 Network Setup

Network Setup
The Network Explorer provides a hierarchical view of the network. The root domain, called the STMS
Domain, is created during STMS installation. If your network has a small number of NEs, this one domain
may be sufficient. However, it is recommended that you set up groups (or subdomains) for your NEs under
the STMS Domain, as described in Group Configuration. You can then perform NE discovery using either the
STMS client or the STMS discovery utility, as described in NE Discovery.
For further information refer to these sections:
• Group Configuration
• NE Discovery: STMS
• Define STMS Server Data
• View STMS Domain Properties
• View SNMP Settings
• Define the NE Configuration Files Directory
• Define STMS Performance Parameters
• Maintain Historical Alarms
• Upgrade the ST Software
• Rollback the ST Software
• Change Server IP Address
• Connect STMS to OSS

Group Configuration
Groups enable you to organize NEs logically, according to a common attribute such as geographical location.
This type of hierarchical structure provides a logical organized view of the network.

Network Hierarchy

The above illustration shows an example of a network hierarchical structure. Three groups - East, Midwest,
and West - appear below the root STMS Domain. These groups represent geographical regions of the U.S.
Two subgroups - New York and Pittsburgh - appear below the East group. These subgroups represent
cities in the East.
For details on configuring groups, see:
• Create a Group
• Move a Group
• Delete a Group

Ribbon Communications Inc. Proprietary 3

 Network Setup

Create a Group
Groups are a convenient tool for organizing your network. You can create as many groups and subgroups as
are necessary to accurately depict your network. The groups that you create are added below the root STMS
Domain; subgroups are added below their respective groups.
Start
1. In the Network Explorer tab, do one of the following:
◦ To create a group, right-click STMS Domain and click Create Group.
◦ To create a subgroup, right-click the relevant group and click Create Group.
2. Type the name of the group.
The name must be unique and contain 1 to 30 alphanumeric characters in length, including spaces
and special characters (e.g., * . - _ $).
3. Click OK.

Move a Group
You can move a group or subgroup within your network from the STMS Domain to another group or
subgroup, or vice versa, from group to group, or from subgroup to subgroup.
Start
• In the Network Explorer tab, drag the group or subgroup to the relevant location in the tree.
The group or subgroup is moved.

Delete a Group
You can delete groups or subgroups as required. If you want to delete groups that contain subgroups or NEs,
first delete the relevant subgroups and NEs.
Start
• In the Network Explorer tab, right-click the group or subgroup you want to delete, click Delete.
The group/subgroup is deleted.

NE Discovery: STMS
You can discover NEs using either the STMS client or the STMS discovery utility:
• NE Discovery via the STMS Client
• NE Discovery via the STMS Discovery Utility
• Define the NE ID

Note
The number of NEs that can be managed by an STMS is on a cost basis. Verify that the purchased
license is current and has not exceeded its token limits. For more information, see Manage Licenses
in the STMS Getting Started and Administration Guide.

NE Discovery via the STMS Client

You can discover NEs using the STMS client using one of the following procedures:
• Discover NEs
• Discover NEs Using an IP Range from File

Ribbon Communications Inc. Proprietary 4

 Network Setup

Discover NEs
Using the STMS Client, you can discover NEs within the STMS Domain or within groups and subgroups. You
can discover an NE for a single IP address or you can specify a range to discover all NEs with IP addresses
in that range.

Note
During NE discovery, the STMS needs to identify the public key of each discovered NE in order to
communicate with it. If an NE's public key is different from the Default value, the STMS must also
know its Current value. In this case, you must copy the NE's public key file to a predefined folder on
the STMS server before performing NE discovery.
The filename format of the public key file must be: <NE IP address>_PublicKey.pem

Start
1. In the Network Explorer tab, right-click STMS Domain or a group/subgroup and click Discover
Network Element.
The Discover Network Element window opens.

2. From the IPv6 Management Mode dropdown list, select 6to4 to discover NEs that use IPv6, or
None to discover NEs that use IPv4.
3. In the Name/IP Address field, type the host name or IP address of the management interface for the
NE, or type in a range of IP addresses (any IP address range followed by a netmask). Ranges may be
specified as "a-b" where "a" represents the start of the range and "b" represents the end of the range.
The netmask is an integer from 1 to 32.
For example, 10.0.232.20-24/27 specifies a range of IP addresses that includes 10.0.232.20,
10.0.232.21, 10.0.232.22, 10.0.232.23, and 10.0.232.24.
When discovering a range of IP addresses, the STMS should not have a new key during the process.
4. From the Type dropdown list, select the type of product series for the NE you wish to discover.
5. In the 6to4 address field, type the Anycast address of the NE, or type in a range of addresses.
6. Click OK.
7. Repeat this procedure for each NE you want to discover.

Note
The progress during discovery is displayed beside the NE icon in the Network Explorer tab,
as shown:

Ribbon Communications Inc. Proprietary 5

 Network Setup

Discover NEs Using an IP Range from File

You can discover NEs using a file that contains a range of IP addresses.
Use the following syntax for each line in the file:
[typeName]:(ip address|ip address range):[groupName]
where:
• typeName : an optional typeName. If not specified, the type defaults to the SR9700.
• ip address : any valid IP address with or without netmask.
• ip address range : any IP address range with a netmask. Range may be specified in any
hostpart of ip address. An IP address can be in the form x.x.x.x and a range is specified in any host
part octet as "a-b", where "a" represents the start of the range and "b" represents the end of the range
inclusive, for example, 192.168.1.2-100/24. The network part of the address must be specified by a
valid netmask - the ip address followed by a /XX, where XX is any number from 1 to 32 for ipv4
address.
• groupName : an optional STMS groupname (the group must already exist in the STMS).

The following is an example of the file:

AS9215:10.0.228.189:
AS9215:10.0.246.199:
AS9216:10.0.228.190:
AS9216:10.0.251.46:
DM9225E:10.0.228.186:
DM9225:10.0.228.188:
DM9234:10.0.228.187:
DM9234:10.0.251.44-45/24
You can discover NEs using an IP range from file using the STMS GUI.
Start
1. In the Network Explorer tab, right-click STMS Domain (to discover NEs within the STMS Domain) or
the group for which you want to discover the NEs, and click Discover IP Range From File.
2. Browse to the file that contains the IP address list and click Open.

NE Discovery via the STMS Discovery Utility

You can discover NEs using the STMS discovery utility. This utility (also referred to as the discover
command) enables you to discover NEs and create STMS groups (or subdomains). This enables you to
discover several NEs at a time.
Start
1. Log in to a system in which the STMS server has been installed.
2. Open a shell prompt.
3. Change the working directory to the directory in which you installed the STMS software.
4. At the prompt, type:
./bin/discover option argument
where:
◦ option is a valid command option (or set of options).
◦ argument is a valid argument (or arguments) associated with the command option.
For a complete list of command options and arguments, see STMS Discovery Utility Commands.
5. Press ENTER.

Ribbon Communications Inc. Proprietary 6

 Network Setup

Refer also to:

• Perform Ranged Discovery Using the STMS Discovery Utility
• STMS Discovery Utility Commands

Perform Ranged Discovery Using the STMS Discovery Utility

You can use the STMS discovery utility for ranged discovery, that is, discovery driven by a list of IP
addresses or ranges. This is useful for discovering a larger number of NEs.
Before initiating ranged discovery, ensure you have a logical organization around your elements. Create
STMS groups to hold, for example, numbers of elements based on geographical locations or administrative
partitioning, and decide which elements (based on address, host name, location, etc.) you wish to put into
the respective groups.
You need to obtain a list of elements by address and device type in CSV format. Common locations for such
lists include inventory systems and spreadsheets. Ensure that each element in the list has an additional
column for the group to which they will be assigned. Without a group listing, all NEs are assigned to a default
group and the list becomes unwieldy when managing a large number of elements. Put the list on the STMS
server so you can call it during discovery.
Use the range option command to discover elements of a particular type. This allows you to discover any
number of elements in a given IP address range. You must run this command for each type of element you
want to discover; it cannot be used to discover a mix of elements.
You can use the STMS discovery utility for range discovery via a CSV list.
Start
1. Log in to a system on which the STMS server has been installed.
2. Open a shell prompt.
3. Change the working directory to the directory in which you installed the STMS software.
4. At the prompt, type:
./bin/discover -t type -f file -o filename
where:
◦ type is the type of device to discover (default is SR9710).
◦ file is name of the CSV file that contains a listing of elements by address and device type.
◦ filename is the name of the file where the discovery results are written.
For a complete list of command options and arguments, see STMS Discovery Utility Commands.
For example, if you enter a file containing the following information:
SR9200:10.0.242.208
SR9200:10.0.242.209
SR9200:10.0.242.210
SR9200:10.0.242.212
SR9200:10.0.242.213
SR9200:10.0.242.214
you get the results shown in Step 5.
5. Press ENTER.
The output displays the progress of the discovery:
Discovering 10.0.242.208
Discovering 10.0.242.209
Discovering 10.0.242.210
Discovering 10.0.242.211
Discovering 10.0.242.212
10.0.242.211::DISCOVERY_FAILED
10.0.242.210::DISCOVERY_COMPLETE
10.0.242.209::DISCOVERY_COMPLETE
10.0.242.208::NOT_PRESENT
10.0.242.212::NOT_PRESENT

Ribbon Communications Inc. Proprietary 7

 Network Setup

Writing results to: result ... done.

You can use the STMS discovery utility for range discovery via an IP address range.
Start
1. Log in to a system in which the STMS server has been installed.
2. Open a shell prompt.
3. Change the working directory to the directory in which you installed the STMS software.
4. At the prompt, type:
./bin/discover -t type ip address range -o filename
where:
◦ type is the type of device to discover (default SR9710).
◦ ip address range is the range of addresses to be discovered.
◦ filename is the name of the file where the discovery results are written.
For a complete list of command options and arguments, see STMS Discovery Utility Commands.
For example, entering ./bin/discover -t SR9200 10.0.242.208-212/24 -o filename gives you the
results shown in Step 5.
5. Press ENTER.
The output displays the progress of the discovery:
Discovering 10.0.242.208
Discovering 10.0.242.209
Discovering 10.0.242.210
Discovering 10.0.242.211
Discovering 10.0.242.212
10.0.242.211::DISCOVERY_FAILED
10.0.242.210::DISCOVERY_COMPLETE
10.0.242.209::DISCOVERY_COMPLETE
10.0.242.208::NOT_PRESENT
10.0.242.212::NOT_PRESENT
Writing results to: result ... done.

Note
The batch size command can be used in combination with the other commands to limit the
number of elements discovered at one time. For example, ./discover -t type -b 3 -f file -o
filename limits discovery to three elements at a time. The server waits for each batch to
complete before moving on to the next.

STMS Discovery Utility Commands

The following table describes the valid command options and arguments for the STMS discovery utility (or
discover command).

Ribbon Communications Inc. Proprietary 8

 Network Setup

Command options and arguments

Options/Arguments Description

-h host Connects to the STMS server specified by the host argument in order to issue
commands for that server (host is the host name or IP address of the STMS
server).
Note: If you are running the STMS server on a system other than your local
system, you must use the-h option and host argument to issue any STMS
Discovery Utility commands for the remote server.

-b batchsize Completes discovery in batches; waits for each batch to complete before
moving on to the next (default batch size 10).

-ofilename Name of file where discovery results must be written.

-ttype Specifies the type of device to discover. The correct type is reflected in the
output file if the -o option is specified (type defaults to SR9700).

-f file Specifies a file containing a list of NEs to discover. Each line of the file can
contain a host name, the IP address of an NE's management interface, or a
range of IP addresses. You can also specify a group for each entry by using
the :group argument, as described later in this table.
• ip address - any valid IP address with or without /32 netmask.
• ip address range - any IP address range with a netmask. Ranges may be
specified in any hostpart of IP address. An IP address can be in the form
x.x.x.x and a range is specified in any host part octet as "a-b", where "a"
represents the start of the range and "b" represents the end of the range
inclusive, for example, 192.168.1.2-100/24. The network part of the address
must be specified by a valid netmask - the IP address followed by /XX,
where XX is any number from 1 to 32 for IPv4 address.

host [:group] Where the host argument specifies the host name or IP address of the
management interface for the NE to be discovered. You can also specify a
range of IP addresses by using the last octet to indicate the range. For
example, the range specified by 192.168.1.2-100 includes all IP addresses
from 192.168.1.2 to 192.168.1.100.
Additionally, you can use the optional :group argument to specify the name of
a group in the STMS Domain under which you want to discover an NE (the
group must currently exist). For example,
192.168.1.2-100:WEST specifies the group named WEST for all NEs with IP
addresses from 192.168.1.2 to 192.168.1.100

Define the NE ID
Each NE has a unique and persistent ID which is used to identify it in the STMS when uploading information
to the NMS. If the NE ID is not defined on the NE or if there is a mismatch in the NE ID configured on the NE
and STMS, the NE goes to DISCOVERY_FAILED state in the STMS. You can define the NE ID manually via
the CLI.

Ribbon Communications Inc. Proprietary 9

 Network Setup

Start
• At the CLI prompt, type the following command:
set network-element opt96xx ne-id <ne ID number>

Define STMS Server Data

When you define STMS server data on an NE, the NE automatically contacts the STMS server, which then
collects information about the NE's configuration. If the specified STMS server is unavailable, the NE
continues to ping the STMS server until communication is established.

Note
Assigning an NE to multiple STMS server instances is not supported.

You can configure STMS server data on an NE using the CLI. To access the CLI, you must log in to the NE.
You can log in to the NE either by logging on at a console or by telneting to the NE.

Note
For more information about using the CLI (including logging in to the NE), see the ShadeTree User
Guide.

Start
1. Log in to the NE via the CLI.
2. At the prompt, type configure and press ENTER.
The CLI enters into configuration mode, as indicated by [edit] and the prompt hash (#).
3. At the prompt, type:
set system services <stms server ip-address>

where stms server ip-address is the IP address of the STMS server, in the form A.B.C.D
4. Press ENTER.
5. At the prompt, type set system services management stms discovery enable , and then
press ENTER.
6. Type commit and press ENTER.
7. Type exit and press ENTER.
The CLI returns to operation mode.

Note
You have to perform these steps for each NE on which you want to configure the STMS server
data.

View STMS Domain Properties

The root domain, called the STMS Domain, is created during STMS installation. You can view STMS
Domain properties.
Start
• In the Network Explorer tab, right-click STMS Domain and select Properties.
The STMS Domain properties appear in the right pane.

Ribbon Communications Inc. Proprietary 10

 Network Setup

STMS domain properties

Field Description

STMS P4 Version Build version information for the STMS software.

STMS Server Install Directory in which the STMS server software is installed.
Directory

IDL Version Map Interface Definition Language (IDL) version mapping information;
specifies the different versions of the IDL interface supported by the
STMS software to an NE. STMS supports up to three different versions of
ShadeTree NE software and each version may have a different IDL
interface. The IDL versions are specified in the following format:
<IDL 1>:<IDL 2>:<IDL 3>
where each of <IDL 1>, <IDL 2>, and <IDL 3> have the following format:
<release date>-<build line>:<IDL version>

RDR Role If RDR is configured, RDR Role indicates whether the selected STMS is
defined as the Primary or Mirror STMS. The Primary STMS is the
functioning STMS, and the Mirror STMS starts functioning only if the
Primary STMS fails.

STMS Listener Port Port on which the STMS server listens for pings from NEs.

Network Element Bootstrap Port an NE uses to communicate with the STMS server.
Port

# of Discovery Retries Number of times the STMS attempts to initially discover an NE.

# of Worker Threads Number of threads the STMS uses to process data.

Network Element Ping Number of seconds between pings of an NE by the STMS server.
Interval

Event Queue Size Maximum number of events to queue for processing.

Config Change Limit Number of configuration change elements the STMS processes per
transaction.

LI Limit/Transaction Number of logical interfaces on an NE the STMS processes per

transaction.

Alarm Queue Size Size (in number of alarms) of the queue for alarms to be written to the
STMS DB.

Ribbon Communications Inc. Proprietary 11

 Network Setup

Field Description

Max. Period to Persist Maximum period the alarm will be persisted in the database. Default
Alarms value is 60 minutes.

Max. Period to Persist Maximum period the event will be persisted in the database once it has
Events reached the STMS. Default value is 5 days.

Min. # of Persistent Alarms Minimum number of alarms always persisted in the database, even if the
Max. Period to Persist Alarms is exceeded.

STMS Server Free Memory Amount of free memory available to the Java Virtual Machine (JVM) used
by the STMS server.

STMS Server Total Memory Total amount of memory allocated to the JVM used by the STMS server.

Maintain historical alarms Whether the STMS maintains historical alarm information.

Email SMTP Host Host name of the mail server the STMS server can use to send emails
such as notification of alarms.

Email Domain Name Domain name to append to unqualified email addresses when sending
email.

Default File Server Host Host name of the server to use for remote storage of files.

Network Element Files Path to the directory for NE system configuration files.
Directory

Reports Directory Path to the directory for report files.

View SNMP Settings

You can view SNMP settings for the STMS Domain.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
The STMS Domain properties appear.
2. Select the SNMP tab.
The SNMP settings appear.

Ribbon Communications Inc. Proprietary 12

 Network Setup

SNMP settings

Field Description

Alarm Age (seconds) Time in seconds an alarm based on an SNMP trap received by the STMS stays
in the STMS cache and related to that, in the GUI (default 3600 sec). The age is
checked every Max. Period.

Trap Destination Port Port the STMS uses to listen for incoming SNMP traps (default 1620).

Define the NE Configuration Files Directory

The configuration files directory is used to store system configuration files for NEs. The default configuration
files directory is the /deviceConfig directory in the STMS root directory. You can define the configuration files
directory.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
The STMS Domain properties appear.
2. In the Properties tab, in the Network Element Files Directory field, type the path to the directory
you want to use.
3. Click Apply.

Define STMS Performance Parameters

The STMS software is configured during installation to provide optimal performance and reliability. However,
depending on the complexity of your network or changes to your network following the installation of the
STMS software, you may need to adjust particular STMS performance parameters.

Note
It is highly recommended that you only change STMS configuration settings described in this section if
directed by an appropriate network/system administrator or technical support representative.

Note
The parameters described in this section are stored in the STMS database. If you use dbutil to revert
the STMS to a prior state, changes you made to these settings may be lost.

You can define STMS performance parameters.

Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
The STMS Domain properties appear.
2. In the Properties tab, define the performance attributes and click Apply.
The following table describes the STMS performance attributes.

Ribbon Communications Inc. Proprietary 13

 Network Setup

STMS performance parameters

Parameter Description

# of Discovery Retries Number of times the STMS attempts to discover an NE initially (default 6).

# of Worker Threads Number of threads the STMS uses to process data (default 10).

Network Element Ping Number of seconds between pings of an NE by the STMS server (default
Interval 120).

Event Queue Size Max. number of events to queue for processing (default 50,000).

Config Change Limit Number of configuration change elements the STMS processes per
transaction (default 100).

LI Limit/Transaction Number of logical interfaces on an NE the STMS processes per transaction

(default 100).

Alarm Queue Size Size (in number of alarms) of the queue for alarms that are to be written to
the STMS DB (default 10,000).

Max. period to Persist Max. number of minutes to persist alarms (default 60).
Alarms (minutes)

Maintain Historical Alarms

By default, the STMS does not maintain historical alarm information within its database. If you want to
maintain this information, you must enable this feature.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
The STMS Domain properties appear.
2. In the Properties tab, select the Maintain historical alarms checkbox.
3. Click Apply.

Upgrade the ST Software

This section describes how to upgrade the ST software. The installation processing time depends on the
DCN bandwidth (IMG/OSC/GCC) and the number of RCPs in the NE.
Start
1. From STMS select Tools > Software Manager.
The Software Upgrade Manager Wizard window appears.

Ribbon Communications Inc. Proprietary 14

 Network Setup

2. Select the check box of the relevant NE to upgrade or select the Select all checkbox at the top of the
column.
3. Click Next or select the Select Version radio button in the Software Upgrade Wizard tab.

4. Click Upload Version.

The Upload Version window appears.

Ribbon Communications Inc. Proprietary 15

 Network Setup

5. Click Browse, and select the new version folder that includes all the relevant bundles for this version.
(for example, opt9603-7.2R27.0-276400.tar, opt9608-7.2R27.0-276400.tar,
opt9624-7.2R27.0-276400.tar, opt9608LC-7.2R27.0-276400.tar, opt9624LC-7.2R27.0-276400.tar).

6. Click Open.
The Upload Version window appears.

Ribbon Communications Inc. Proprietary 16

 Network Setup

7. Click Start.
The upload process starts and the progress of the upload is shown in the Status area.

When all the 3 steps in Status are show 100%, the upload process is complete.

Ribbon Communications Inc. Proprietary 17

 Network Setup

The uploaded version appears in the Software Upgrade Manager Wizard window. If the version
does not appear automatically, refresh the window manually.

8. Select the version check box, and click Next or select the Pre Install Test radio button in the
Software Upgrade Wizard tab.

9. Select relevant NE on which you want to run the pre install test, and click Run Pre Install Test.
The Activity and Status columns are updated according to the result of the test.

Ribbon Communications Inc. Proprietary 18

 Network Setup

10. Click Next or select the Install radio-button in the Software Upgrade Wizard tab.

11. Select relevant NE on which you want to install the new version, and click Run Install Version.
12. To view current status of the installation, click Refresh.
13. Check that the installation process is completed.
14. Click Next or select the Pre Upgrade Test radio-button in the Software Upgrade Wizard tab.

15. Select relevant NE on which you want to run the pre upgrade test, and click Run Pre Upgrade Test.
16. Click Next or select the Upgrade radio-button in the Software Upgrade Wizard tab.

Ribbon Communications Inc. Proprietary 19

 Network Setup

17. Select relevant NE on which you want to install the upgrade, and click Run Upgrade.
The software upgrade is installed.

Rollback the ST Software

You can roll back the ST software to previous versions. If a previous version exists (available if there was a
previous upgrade operation), you can rollback to that version. You do not have the option to rollback between
versions.

Important
Be aware that the rollback operation is traffic-affecting.

Start
1. From STMS select Tools > Software Manager.
The Software Upgrade Manager Wizard window appears.
2. Click Miscellaneous, and then select Rollback.
The Rollback tab appears listing the available versions to which you can roll back the software.

Ribbon Communications Inc. Proprietary 20

 Network Setup

The Rollback tab includes the following columns.

◦ Group: The name of the network element group.
◦ Host Name: The host name of the network element.
◦ IP Address: The IP address of the network element.
◦ Current Version: The number of the current version of the network element software.
◦ Previous Version: The number of the previous version of the network element software.
◦ Status: The status of the rollback operation.
◦ Reason: The reason why the rollback did not complete successfully.
3. Select the version to which you want to rollback.
4. Click Rollback.
The rollback starts and the current status of the rollback appears in the Status column. If the rollback
does not finish successfully, the reason for not finishing appears in the Reason column.

Change Server IP Address

This section describes how to change the IP address of the DB, STMS and NMS server or zone after they
have been configured. These servers can be on either Linux or Solaris computers. There are some
differences between the procedures for the two systems, which are indicated in the text.
Prerequisites
• Disable auto restart of the application
• (Linux) Include hosts entry of corresponding applications in a local /etc/hosts file of each machine
• (Solaris) After changing the IP address of the applications zone, reboot the particular zone
Linux
Follow the steps below in each of the different scenarios.
• Follow these steps to change the IP address in the DB server or zone to new_ip
◦ In the DB server or zone:
• Verify that the /etc/hosts entry is configured with the new_ip
• Start the DB
◦ In the NMS server or zone:
• Make sure that the NMS application is shut down
• Execute"/opt/NMS/server/sh/SetupNMS -setORA "new_ip
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application

Ribbon Communications Inc. Proprietary 21

 Network Setup

◦ In the STMS server or zone:

• Make sure that the STMS application is shut down
• Execute /opt/STMS/sh/SetupSTMS.sh -setora "new_ip
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application

Note
After executing above scenario make sure auto restart is enabled for the applications
zone.

• Follow these steps to change the IP address in the NMS server or zone to new_ip
◦ In DB server or zone and in the NMS server or zone:
• Verify that the /etc/hosts entry is configured with the new IP address
• Start the application
◦ In the STMS server or zone:
• Make sure that the STMS application is shut down
• Execute "/opt/STMS/sh/SetupSTMS.sh -setnmsnew_ip
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application
• Follow these steps to change the IP address in the STMS server or zone to new_ip
◦ In the DB server or zone, the NMS server or zone, and the STMS server or zone:
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application
Solaris
Follow the steps below in each of the different scenarios.
• Follow these steps to change the IP address in the DB server or zone to new_ip
◦ In the DB server or zone:
• Verify that the /etc/hosts entry is configured with the new_ip
• Make sure that the DB shut down
• Execute UpdOraIP.sh
• Start the DB
◦ In the NMS server or zone:
• Make sure that the NMS application is shut down
• Execute"/opt/NMS/server/sh/SetupNMS -setORA "new_ip
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application
◦ In the STMS server or zone:
• Make sure that the STMS application is shut down
• Execute /opt/STMS/sh/SetupSTMS.sh -setora "new_ip
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application
• Follow these steps to change the IP address in the NMS server or zone to new_ip
◦ In DB server or zone and in the NMS server or zone:
• Execute /opt/NMS/server/sh/SetupNMS -update
• Verify that the /etc/hosts entry is configured with the new IP address
• Start the application
◦ In the STMS server or zone:
• Make sure that the STMS application is shut down
• Execute "/opt/STMS/sh/SetupSTMS.sh -setnmsnew_ip
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application
• Follow these steps to change the IP address in the STMS server or zone to new_ip
◦ In the DB server or zone, the NMS server or zone, and the STMS server or zone:

Ribbon Communications Inc. Proprietary 22

 Network Setup

• Make sure that the STMS application is shut down

• Execute /opt/STMS/sh/SetupSTMS.sh -update
• Verify that the /etc/hosts file configuration, new IP address should be updated with new_ip
• Start the application
Refer also to:
• Change the IP Address in the DB Server or Zone
• Change the IP Address in the NMS Server or Zone
• Change the IP Address in the STMS Server or Zone

Change the IP Address in the DB Server or Zone

You can change the IP address in the DB server or zone.
Start
1. Stop the DB before changing the Oracle IP.

2. Before changing the IP, do the following:

◦ Execute the tnsnames.ora file

Ribbon Communications Inc. Proprietary 23

 Network Setup

◦ Execute the listener.ora file.

3. (Linux) Change the IP address of the Oracle zone using the SRM solution.
◦ The following is an example of the tnsnames.ora file after updating the IP:

Ribbon Communications Inc. Proprietary 24

 Network Setup

The following is an example of the listener.ora file after updating the IP:

4. (Solaris) Change the IP address of the Oracle zone using the ConfNet tool.

Ribbon Communications Inc. Proprietary 25

 Network Setup

Ribbon Communications Inc. Proprietary 26

 Network Setup

5. (Linux) Login as the ora user and start the DB.

6. (Solaris) Login as the ora user and run the UpdOra.sh script to update the new IP address in the
listners.ora and tnsnames.ora files.

The following is an example of the tnsnames.ora file after updating the IP:

The following is an example of the listener.ora file after updating the IP:

Ribbon Communications Inc. Proprietary 27

 Network Setup

7. (Solaris) Start the DB as the ora user.

8. (Solaris) Execute the UpdOraIP.sh script usage.

Note
(Solaris) The same procedure should be followed if you want to add multiple IP address or
remove any IP from the Oracle config files.

Change the IP Address in the NMS Server or Zone

Linux
• When the NMS main server IP is changed using the SRM solution, the NMS should not be in a
running state.
• When Oracle server IP is changed, the NMS should not be in a running state.

Ribbon Communications Inc. Proprietary 28

 Network Setup

• Start the NMS.

Solaris
• Usage
nms-server / # /opt/NMS/server/sh/SetupNMS -h
Usage: SetupNMS [-dd num] [ -sync ip data_name ] [ -obiee <add|del|check> id ip ]
[ -setORA <ip_address> ] [ -update]
Where:
◦ -update: updates main NMS server IP
◦ -setORA <ip_address>: updates modified oracle server IP address in the NMS server and also
updates the main NMS server
• When NMS main server IP is changed, the NMS should not be in a running state.

• When Oracle server IP is changed, the NMS should not be in a running state.

Change the IP Address in the STMS Server or Zone

You can change the IP address in the STMS server or zone.
Start
1. Stop the STMS server before changing the IP.
Solaris

Ribbon Communications Inc. Proprietary 29

 Network Setup

Solaris and Linux

The following is an example of the server details before changing the IP.

Ribbon Communications Inc. Proprietary 30

 Network Setup

The following is an example of the configuration files information before changing the DB and NMS IP
in the STMS server.

Ribbon Communications Inc. Proprietary 31

 Network Setup

2. Change DB IP in the Oracle server and start Oracle.

3. Change the NMS server IP.
4. Try changing the DB and NMS IP in the STMS server using -setora and -setnms (they should pass
the following pre-check scenarios).

5. Using -setora, change the DB IP in the STMS server.

Ribbon Communications Inc. Proprietary 32

 Network Setup

The following is an example of the configuration files information after changing the DB IP in the
STMS zone.

6. Change the NMS IP in the STMS zone.

The following is an example of the configuration files information after changing the NMS IP in the
STMS.

Ribbon Communications Inc. Proprietary 33

 Network Setup

7. After changing the DB and NMS IP in the STMS zone, execute /opt/STMS/sh/SetupSTMS.sh.

Ribbon Communications Inc. Proprietary 34

 Network Setup

8. Check that the server is not trying to provide the same IP as the new DB and NMS IPs.

9. Start the STMS.

Ribbon Communications Inc. Proprietary 35

 Network Setup

Connect STMS to OSS

Note
These steps must be performed in a maintenance window as the procedure requires an application
restart.

Prerequisites
• The Orbix package must be installed in STMS
• The must be sufficient NBI tokens available in the STMS license
• Take a backup using EmsStmsDBBackup for the STMS that is going to be integrated to OSS

Start
1. Login to the STMS server console.
2. Stop the STMS server.
#su - stms
#STMS stop
3. Execute the following commands to add an OSS IP in the STMS database.
◦ Run the dbconfig script in /opt/STMS/db directory as below.

Note
The commands mentioned below must only run when the STMS is stopped.

• Check the current status

# ./dbconfig NSTarget
Connecting using these args: WALLET WALLET oracle.jdbc.OracleDriver
jdbc:oracle:thin:/@EMS_STMS_OW_0001
NSTarget=z2-ferrari,127.0.0.1
◦ Update the OSS IPs to the STMS database. Make sure that existing IPs in the database for NS
Target is also given along with the OSS IP.

Ribbon Communications Inc. Proprietary 36

 Network Setup

./dbconfig NSTarget z2-ferrari,<OSS IP>,127.0.0.1

Multiple OSS IPs can be updated using the following command:
./dbconfig NSTarget z2-ferrari,<OSS IP1>,<OSS IP2>,127.0.0.1
4. Start the STMS server.
#su - stms
#STMS start
5. Ensure that the STMS IP and hostname are updated in the OSS (/etc/hosts) and Initiate a connection
to STMS from OSS and verify that the connection is established.

Note

In case of an STMS restart or SetupSTMS.sh execution in the future ensure that the relevant IPs
are present in the database before starting STMS.

Ribbon Communications Inc. Proprietary 37

 NE Management

NE Management
You can perform various management and configuration tasks on NEs in the network via the STMS, as
described in:
• NE Implicit Configuration
• Configure an NE Using Plug and Play
• View NE Properties
• View NE Operational Status
• View Inventory Reports
• Connect to an NE Using SSH
• Check Network Connectivity
• Delete an NE from the STMS Database
• Move an NE
• Reboot an NE
• Flash LEDs on an NE
• Refresh an NE
• Refresh Alarm Information
• Management Port Down Alarm
• Unmanage an NE
• Reconnect an NE
• Change the NE IP Address
• Define Logging for an NE
• View NE Temperature Statistics
• View Inhale Air Temperature and Rotation Speed
• View NE Power Control Areas
• View NE Capacity Data
• Define LCT Access to an NE
• Define Cryptographic Strength Security
• Define Diffie Hellman (DH) Groups
• NTP Configuration
• Security Certificate Management
• NE Configuration Backup and Restore
• NE Event Logs
• ASON WSON Configuration
• Define RSVP Authentication
• Synchronize the Standby RCP Configuration
• Define Utilization Thresholds
• Configure a Subtending Shelf
• View the Maintenance List
• Change the NE Password

NE Implicit Configuration
Implicit configuration is the ability to configure equipment and/or supported entities by the NE, without
operator intervention, to their default values as a trigger of another operation.
Implicit configuration is applied in the following cases:
• Equipment configuration: Includes system minimal configuration and discovered equipment whose
location is determined and unique (e.g. a second RCP card, fabric card). Such equipment entities are
implicitly configured to their default configuration values including supported entities. The operator is
required to set equipment type to slots having cards other than common cards.
• Card with unique configuration of supported entities: Includes cards having a unique
configuration of supported entities. Examples are all cards belonging to passive optics cards (e.g.
DCF, splitter/coupler), amplifiers, some ports in ADD ROADMs and service cards having non-FRU

Ribbon Communications Inc. Proprietary 38

 NE Management

transceivers. In these cases, as part of card assignment, its supported entities, such as its ports, sub-
interfaces or cross-connections, are implicitly configured to default values. When there is a multiple
configuration in the supported entities the operator must explicitly configures these entities.
• Port with unique configuration of its supported entities: The operator is required to specify the
port type and its supported entities are implicitly configured. Service cards, data cards and ROADMS
belong to this category.
In some cases upon explicit configuration of the port, its supported entities and cross connections are
implicitly configured. For example: AOC10 card where its line port is configured to be compatible to
Apollo mode.
In case there are several channelization options within sub-interfaces (e.g. ODU0 within ODU2 and
ODU1 within ODU2), it is required to specify the mapping type in order to configure the additional sub-
interfaces.
Ports participating in ODU cross connections can aggregate a mixture of sub-interfaces (e.g. ODU2
can have a mixture of 2 x ODU0 and 3x ODU1). Therefore it is required to provide information on the
sub-interfaces in order to configure the cross-connection.
For further information refer to these sections:
• Equipment Implicit Configuration
• Controller Cards Implicit Configuration
• Severity Profiles Implicit Configuration
• PM Threshold Profiles Implicit Configuration
• Cross Connection Implicit Configuration
• Protection Group Implicit Configuration
• Transport Entities Implicit Configuration

Equipment Implicit Configuration

Equipment implicit configuration is applied on the following equipment:
• System minimal configuration (i.e. main shelf, RCP, FANs and PFMs) as a result of installation
operation
• Controller cards
• Common cards are implicitly configured by the NE
For cards other than common cards, the operator is required to set the equipment type and the card is
configured to its default configuration. Cards that require a fabric card are not configured when a fabric card
is not yet configured. Cards having unique configuration of supported entities are implicitly configured to their
default configuration values. A port having unique configuration of its supported entities is implicitly
configured to its default configuration values following its configuration.

Controller Cards Implicit Configuration

Controller cards have the following implicit configuration rules:
• The first discovered controller card is implicitly configured as a simplex (i.e. having no redundancy).
• If two controller cards are simultaneously discovered they are implicitly configured to their default
configuration.
The operator must explicitly configure auto-switchover and high availability in order to have redundancy
behavior. Without redundancy configured, configuration changes are not synchronized to the standby. The
main shelf implicitly configures a controller card discovered in a passive shelf.

Severity Profiles Implicit Configuration

Severity profiles contain alarm and event lists per each managed entity type. NE implicitly creates all default
profiles per each managed entity types.
You can also manually create a severity profile from the STMS. See Creating a Severity Profile in the STMS
Performance Management Guide.

Ribbon Communications Inc. Proprietary 39

 NE Management

PM Threshold Profiles Implicit Configuration

PM threshold profiles contain counters threshold lists per each managed entity type. NE implicitly creates all
default PM profiles per each managed entity.
You can also manually create a PM profile from the STMS. See Creating a PM Profile in the STMS
Performance Management Guide.

Cross Connection Implicit Configuration

Cross connection implicit configuration is as follows:
• Fixed cross connections are implicitly configured following assignment of card having unique
connectivity.
• A card deletion implicitly deletes its fixed cross connections.
• Fixed cross connections are implicitly configured following configuration of a port having unique
connectivity (e.g. a client port in CMB40 implicitly configures a fixed cross connection).
• Port deletion implicitly deletes its fixed cross connections.
• Modification changes in fixed cross connection attributes are allowed only on non-traffic affecting
attributes.

Protection Group Implicit Configuration

Entities that participate in protection implicitly configure their protection group entity, as follows:
• A protected fixed cross connection implicitly configures its protection group (e.g. protection group in
splitter coupler cards).
• Configuration of an unprotected cross connection to be protected implicitly configures its protection
group.
• Configuration of a protected cross connection to be unprotected implicitly deletes its protection group.
• Upon configuration of fabric protection the associated protection group is implicitly configured.
• Upon deletion of fabric protection the associated protection group is implicitly deleted.
• Modification changes on protection group attributes are allowed.
A protection group is explicitly created and deleted in the case of port protection.

Transport Entities Implicit Configuration

Transport entities (ports and sub-interfaces) have the following implicit configuration rules:
• Cards with unique configuration, following card configuration, all ports and their supported entities are
implicitly configured to their default values. In addition the NE implicitly configures all cross
connections on this card (e.g. passive optics cards (DCF, splitter/coupler), and amplifiers).
• High order sub-interfaces are implicitly configured following its supporting port configuration (e.g. upon
configuration of port type OTU2, NE implicitly configures its ODU2 sub-interface).
• High order sub- interfaces are implicitly deleted due to deletion of its supporting port.
• A port with unique configuration of its sub-interface, following configuration of port type and/or port
mapping, its sub-interfaces is implicitly configured to the default values (e.g. FC10G port with port
mapping ODU2 implicitly configures a sub- interface ODU2).
• For OTS ports in OADM and MUX/DEMUX and some ports in ROADM cards, each OTS port and all
its OCH sub-interfaces are implicitly configured. The number of OCH sub- interfaces are determined
according to port spacing attribute (44 channels for 100 GHz and 88 channels for 50 GHz).
• Modification requests on implicitly configured transport entities are allowed unless they require
deletion of the entities.

Ribbon Communications Inc. Proprietary 40

 NE Management

Configure an NE Using Plug and Play

The Plug and Play tool uses the LightPLAN OM/SM output file to install and configure equipment on
managed NEs (locally or remotely) through automatically-generated CLI commands. Plug and Play
functionality simplifies the configuration of the NE and its component shelves, cards, and ports, as well as
the associated fiber link configuration.
You can configure an NE that is already installed using the Plug and Play tool.
Start
1. From the Tools menu, select Plug & Play.
The Select and Configure NE(s) window opens.

2. In the Selected File field, click Select and browse for the XML file.
The NEs in the XML file are listed in the Network Elements section.
The NEs that exist in the Network and are found and are listed as Ping Succeeded and Installed.

Ribbon Communications Inc. Proprietary 41

 NE Management

3. To view each NEs configuration in the XML file, right-click on the NE and select XML Hierarchy.
A window opens showing the NEs configuration in an XML tree view. If the XML code was configured
properly, then the shelf, cards and ports are shown in green and marked as success.

If the XML code was not configured correctly then the NE is displayed in red with an explanation in the
Error Details section.

Ribbon Communications Inc. Proprietary 42

 NE Management

4. In the Select and Configure NE(s) window select the NEs that you want to update with the
configuration and click Configure.
If an NE is not discovered by the STMS, you receive a warning.

5. Click Yes to configure the NE anyway, and click No to cancel.

When finished, each NE's configuration status is listed in the Network Elements area.

View NE Properties
You can view NE properties, such as general information about the NE, its location, and its performance
thresholds.
Start

Ribbon Communications Inc. Proprietary 43

 NE Management

1. In the Network Explorer tab, right-click the NE and select Properties.

The Properties window appears, with the General tab selected by default.

2. Select one of the following tabs:

◦ General
◦ Shelf & Time
◦ Location
◦ IP & Firewall
◦ PM
◦ OTDR
The available fields are described in the following table.

Ribbon Communications Inc. Proprietary 44

 NE Management

NE Properties

Field Description

General

Hostname (read-only) Host name of the NE or the IP address of the NE's

management interface.

State (read-only) Current state of the NE:

• reachable: NE has successfully been contacted by the
STMS.
• not reachable: NE cannot be contacted by the STMS.
• discovery in progress: NE is currently being discovered
by the STMS.
• discovery complete: NE has successfully been
discovered by the STMS.
• discovery failed: NE was not successfully discovered
by the STMS.
• rediscovery scheduled: NE will be rediscovered prior to
being managed by the STMS.
• rediscovery in progress: NE is currently being
rediscovered by the STMS.
• squelched: Management of the NE has been
suspended by the STMS temporarily. After a period of
time the STMS will attempt to rediscover the NE.
• orphaned by user: Per user request, NE is no longer
being managed by the STMS.
• delete in progress: NE is currently being deleted by the
STMS (will no longer be managed by the STMS).
• unsupported version: NE is running a version of the
routing software not currently supported by the STMS.
• unknown: NE state unknown.

NE ID Unique number assigned to the NEs managed by the STMS.

(Read Only)

Description Description of the shelf.

Group Name (read-only) Name of the group to which the NE belongs.

Audible Alarm Enable or disable the NE's audible alarm indications.

DCN IP Address (read-only) The NE's DCN IP address. If the NE uses IPv6, this field is
called DCN IPv4 Address.

IMG IP Address (read-only) The NE's management interface IP address. If the NE uses
IPv6, this field is called IMG IPv4 Address.

Ribbon Communications Inc. Proprietary 45

 NE Management

Field Description

IPv4 NE Mode The NE mode, which can be one of the following:

• GATEWAY: Used when both DCN and IMG IP
addresses are defined.
• DCN Only : Used when only a DCN IP address is
defined.
• ETH only: Used when only an IMG IP address is
defined.

IPv6 NE Management Mode The IPv6 NE mode, either 6to4 or None.

IPv6 NE Mode The IPv6 NE mode, such as GATEWAY or Remote.

IPv6 Address The NE's IPv6 IP address.

IMG IPv6 Address The NE's management interface IP address (IPv6 NEs only).

Anycast 6to4 Address The NE's Anycast address.

IMG Operational Speed (read only) The current operating IMG port speed.

Auto Negotiation (read/write) The IMG ports can be configured with Auto Negotiation or
No Auto Negotiation. The default value is Auto Negotiation.

IMG Port Speed (read/write) The IMG port speed can be configured as 10m, 100m, and
1G.

Duplex Mode (read/write) The Duplex mode can be configured as half duplex or full
duplex.

Severity Profile The severity profile assigned to the NE.

NE Mode (read-only) The NE mode, which can be one of the following:

• GATEWAY: Used when both DCN and IMG IP
addresses are defined.
• DCN Only : Used when only a DCN IP address is
defined.
• ETH only: Used when only an IMG IP address is
defined.

Model (read-only) Model information for the NE.

Domain Name Domain name of NE.

Router ID Primary IP address of the NE.

Ribbon Communications Inc. Proprietary 46

 NE Management

Field Description

DNS Servers DNS servers resolve host names to IP addresses. You must
have a DNS server address configured in order for the
switch router to resolve IP addresses to host names.

Active RCP Software Version (read-only) Software version of the active RCP card. The initial part of
the version number indicates the NE version number (e.g.
7.3).

Standby RCP Software Version (read- Software version of the standby RCP card. The initial part of
only) the version number indicates the NE version number (e.g.
7.3).

NE Uptime (read-only) Length of time (in hours, minutes, and seconds) that the
system process daemon has been running on the
corresponding RCP.

Linux Hostname (read-only)

Shelf & Time

Mode (for OPT96xx only) Current operating mode of the shelf.

Configured Type Type of shelf configured.

Actual Type Type of shelf that is physically present.

Date & Time Date and time set on the NE. Click Refresh to update.
Click Set Date and Time to manually set the NE date and
time or to select an NTP server to set the NE date and time.
(To use this option, NTP must be configured with an NTP
server.)

Time Zone Time zone configured on the NE; can be modified by the
user. Default time zone is Universal Time Coordinated
(UTC), the international time standard (formerly Greenwich
Mean Time (GMT)).

Location

System Location Free-text attribute used for indicating the chassis location
(255 character limit).

Longitude NE's distance east or west (in degrees and minutes), relative
to the Prime Meridian (0° longitude).

Ribbon Communications Inc. Proprietary 47

 NE Management

Field Description

Latitude NE's distance north or south (in degrees and minutes),

relative to the Equator line (0° latitude).

Rack Number Rack number on which shelf is located.

Position in Rack The number within the rack that indicates the shelf position.

IP & Firewall

IP Policing - Exclude Layer-2 Encap Configures the switch router to ignore the Layer 2 header
(for OPT96xx only) when policing and shaping IP traffic.
By default, when the switch router polices or shapes IP
traffic on the ingress, it includes the bits in the Layer 2
header when it determines the rate of the packet flow.
You can configure the switch router to exclude these bits as
part of the flow. This leads to a less aggressive policing and
shaping scheme and potentially fewer dropped packets
since the packet size is smaller.

IPv6 Classification - Include Traffic Class Sets the IPv6 classification mode to include traffic
(for OPT96xx only) classification.

Pre-Filter Name of a firewall filter to apply globally before all

configured interface firewall filters.
When global filters are configured and there is no interface
filter for the destined interface, and if no match conditions
are met in any of the filters, the packet is accepted.
When global filters are configured and there is an interface
filter for the destined interface, if no match conditions are
met in any of the filters, the packet is discarded.

Post-Filter Name of a firewall filter to apply globally after all configured

interface firewall filters.
When global filters are configured and there is no interface
filter for the destined interface, and if no match conditions
are met in any of the filters, the packet is accepted.
When global filters are configured and there is an interface
filter for the destined interface, if no match conditions are
met in any of the filters, the packet is discarded.

PM

CPU Percentage of CPU resources that can be used before a

CPU utilization alarm is generated, range from 1 to 100
percent (default 90).

Ribbon Communications Inc. Proprietary 48

 NE Management

Field Description

Memory Percentage of memory resources that can be used before a

memory utilization alarm is generate, range from 1 to 100
percent (default 90).

File system Percentage of file system resources that can be used before
a file system utilization alarm is generated, range from 1 to
100 percent (default 90).

Protocol Protocol used for PM data collection.

User ID User ID to connect to the NE for PM data collection.

Password Password for the User ID to connect to the NE for PM data

collection.

OTDR

Protocol Protocol used for PM data collection.

User ID User ID to connect to the NE for PM data collection.

Password Password for the User ID to connect to the NE for PM data

collection.

View NE Operational Status

You can view the operational status for an NE.
Start
1. In the Network Explorer tab, right-click on the NE and select Properties.
The NE properties appear.
2. Click the Operational Status tab.
The NE operational details appear. The details vary for different types of NEs:
◦ For all OPT99xx NEs and for OPT96xx NEs, DC power consumption information appears.

Note
You can disable power management on OPT96xx NEs.

◦ For OPT99xx NEs, the Fan Spin appears for the three Fan cards.
◦ Temperature statistics appear for all NEs.

View Inventory Reports

You can view an inventory report of the NEs in the user interface or you can export the report to HTML.
View an NE Inventory Report
Start

Ribbon Communications Inc. Proprietary 49

 NE Management

1. In the Network Explorer tab, right-click the STMS domain and select Show Inventory.
A list of Ungrouped NEs appear in the Shelves tab.

2. To view a detailed breakdown of the NEs, click the Query Inventory tab.
3. In the Shelf tab, click Search.
A list of NEs appears.

4. Click the Card tab, and then click Search.

A list of cards appears.

Ribbon Communications Inc. Proprietary 50

 NE Management

5. Click the Port tab, and then click Search.

A list of ports appears.

Export an NE Inventory Report to HTML

Start
1. In the Network Explorer tab, right-click on the NE whose inventory you want to export to HTML and
select Reports > Inventory.
2. From the Save window, select the folder where you want to save the file.
3. Enter a name for the file and from the Files of Type dropdown list, select HTML Files.
The file is exported to the selected folder.
The following is an example of an Inventory report exported to HTML.

Ribbon Communications Inc. Proprietary 51

 NE Management

Connect to an NE Using SSH

The STMS server enables you to connect to the NE using the SSH client provided with the STMS software.

Note
On Solaris systems, SUNWCuser metacluster or above must be installed to use the SSH command.

Note
Windows does not come with a built-in SSH command, so it is necessary to install a third-party
SSH application. The suggested application is PuTTY (which can be obtained at http://
www.putty.org/).
The default installation location for PuTTY is C:\\Program Files\\PuTTY, so that the path is
assumed here. If you installed PuTTY with another path, or if you are using a different SSH
program, adjust these instructions accordingly.
After installing PuTTY in Windows, follow these steps:
• Add ";C:\Program Files\PuTTY" to your windows Path environment variable.
• To get the update to the path to take effect, restart your web browser and then restart your
client from the "Download the Client via WebStart" link.
In the directory "C:\Program Files\PuTTY", copy the binary file "putty.exe" to a file called "ssh.exe."

Start
1. In the Network Explorer tab, right-click the NE to which you want to connect and select Connect >
ssh.
The Login Name window opens.
2. Enter a valid user name and click OK.
An SSH session to the NE opens in a new window.
3. At the password prompt, enter the password and press Enter.
An SSH session is established with the NE.

Ribbon Communications Inc. Proprietary 52

 NE Management

Check Network Connectivity

ICMP (Internet Control Message Protocol) is the most commonly used protocol in networking technology.
As a connectionless protocol, ICMP does not use any port number and works in the network layer.
ICMP is commonly used for diagnostic purposes, error reporting or querying any server, and sometimes
hackers are using ICMP to send payloads and to gain network information followed by attempts of denial-of-
service (DoS) attacks.
When an unknown destination IPv4/IPv6 packet with an ICMP Request/UDP/TCP header is sent to Apollo,
Apollo replies back to the source with ICMP unreachable messages.
This practice will busy the processor continuously and detrimentally as it will notify that the destination is
unreachable.
This can be avoided by using the command set system services icmpv4 unreachable disable.
The STMS user can also disable the ICMP destination unreachable setting directly as shown in the
screenshot below.

Ping to Check Reachability of a Host

You can use ping to determine if a remote host is reachable.
Ping sends Internet Control Message Protocol (ICMP) echo request packets to a specific host, and then
displays an ICMP echo reply packet from the host.
You can check the reachability of a host through network interfaces or though the management interface.
Ping can also be used to help determine if the management network has been configured correctly.
Start

Ribbon Communications Inc. Proprietary 53

 NE Management

1. In the Network Explorer tab, right-click the NE for which you want to check the network connectivity
and select Ping NE.
The Ping IP Address window opens.

2. Define the packet size and click Ping.

The ping results appear.

Ribbon Communications Inc. Proprietary 54

 NE Management

Delete an NE from the STMS Database

You can delete an NE from the STMS client and optionally also delete it from the STMS database.
Deleting an NE from the STMS client clears the NE from display in the STMS server and removes the
associated STMS server configuration information from the NE. An NE that has been deleted from the STMS
client is still listed in the Network Element Status list, but you have the option of also deleting it from the
STMS database.
To display an NE in the STMS client after it has been deleted from the STMS client, you must discover the
NE again using the procedures described in NE Discovery. You can rediscover an NE that has been deleted
from the STMS database, but it will appear as a fresh (new) NE.
Delete an NE from the STMS Client and the STMS Database
Start
1. In the Network Explorer tab, right-click the NE that you want to delete and select Delete.
The following message appears.

Ribbon Communications Inc. Proprietary 55

 NE Management

2. (Optional) If you want to delete the NE from both the STMS client and the STMS database, select
Delete NE completely from STMS-DB.
3. Click Yes.
The NE is deleted. If you did not select Delete NE completely from STMS-DB, the NE is only deleted
from the STMS client and you can rediscover the NE again using the procedures described in NE
Discovery.
Delete an NE from the STMS Database After it has been Deleted from the STMS Client
Start
1. In the Network Explorer tab, right-click the NMS Domain and select Network Element Status.
2. In the Network Element Status list, right click the NE you want to delete from the STMS database, and
select Delete.
The following message appears.

3. Click Yes to delete the NE from the STMS database.

Move an NE
You can move NEs within the STMS hierarchical structure in one of the following ways:
• From the STMS Domain to a group or subgroup, or vice versa
• From group to group
• From subgroup to subgroup
Start
• Drag the NE to the desired location in the Network Explorer tree.

Reboot an NE
Rebooting the NE performs a system-wide reboot of the NE.

Note
In a dual RCP system, rebooting an NE reboots both the active and the standby RCPs. See
Rebooting an RCP.

Start

Ribbon Communications Inc. Proprietary 56

 NE Management

1. In the Network Explorer tab, right-click the NE you want to reboot, and select Actions > Hitless
Reboot.
A confirmation message appears.
2. Click Yes.
The NE is rebooted.

Flash LEDs on an NE
You can flash the LEDs on all of the component cards for an NE. This option is useful for physically locating
a particular NE in an equipment room.
Start
• In the Network Explorer tab, right-click the NE for which you want to flash LEDs and select Flash
LEDs > Start.
The LEDs start flashing.
To stop flashing the LEDs, right-click the NE and select Flash LEDs > Stop.

Refresh an NE
While the STMS server strives to maintain and display complete and accurate information for each NE, there
may be instances when the configuration and alarm information displayed in the STMS server may not fully
reflect the information for an NE that is stored in the STMS DB. Under these circumstances, you can perform
an update (or "refresh") of the configuration and alarm information for a particular NE.

Note
It is recommended that you perform a refresh only when necessary. Refreshing alarm information for
an NE can unnecessarily consume processing and networking resources and so degrade the overall
performance of the STMS.

Note
To perform a refresh for only an NE's alarm information, see Refreshing Alarm Information.

Refresh Alarm Information

While the STMS strives to maintain and display completely accurate information about the alarms for each
NE, there may be instances when the alarm information displayed in the STMS server may not fully reflect
the current state of alarms for an NE. Under these circumstances, you can request that the STMS perform
an update (or "refresh") of the alarm information for a particular NE.

Note
It is recommended that you perform a refresh only when necessary. Refreshing alarm information for
an NE can unnecessarily consume processing and networking resources, so degrading the overall
performance of the STMS.

To perform a refresh for both NE configuration and alarm information, see Refresh an NE.

Start
• In the Network Explorer tab, right-click on the NE for which you want to refresh alarm information
and select Actions > Refresh Alarms.

Ribbon Communications Inc. Proprietary 57

 NE Management

Management Port Down Alarm

The STMS and the LCT-STMS present the mngPortDown alarm where relevant, as follows:
• the mngPortDown alarm on an IMG port is supported in all Apollo systems 96xx and 99xx via CLI.
• in Apollo systems 96xx and 99xx that support multi-shelf ports, all ports support the mngPortDown
alarm.
• the mngPortDown alarm is also presented in LightSOFT, STMS, MUSE and LCT.
• in the case of card out, mngPortDown alarm will be masked.
• in the case of a bit fail, mngPortDown alarm will be masked but can be shown in the CLI commands.

Unmanage an NE
You can temporarily suspend the ability to manage an NE through the STMS server, without deleting it.
When you unmanage an NE, it remains discovered by the STMS and is displayed in the Network Explorer
tab, but you can't issue commands to manage or provision it (or the component cards and interfaces
associated with it).
In addition, alarm and log information of an unmanaged NE is not displayed in the STMS server. You can
only continue to view its properties.
To start managing the NE again, you must reconnect the NE.

Note
It is recommended that you unmanage an NE only under special circumstances (such as an NE
generating an unusual number of alarms or unnecessarily consuming STMS processing and
networking resources).

Note
Reconnecting an NE causes the STMS to refresh its configuration information and can unnecessarily
consume processing and networking resources, which can degrade the overall performance of the
STMS.

Start
• In the Network Explorer tab, right-click the NE you want to unmanage and select Unmanage.

Reconnect an NE
You can reconnect an unmanaged NE.
Start
• In the Network Explorer tab, right-click the NE you want to reconnect and click Reconnect.

Change the NE IP Address

You can change the IP address of an NE via the STMS.
The STMS will automatically update the NMS/LightSOFT interface and fiber connectivity peers.

Ribbon Communications Inc. Proprietary 58

 NE Management

Limitations
• You cannot change the IP address of the following NE types:
◦ NE with an encryption card
◦ NE with an AOC10_L2 card
◦ NE with ASON/WSON
◦ NE with cross-STMS fiber connectivity
◦ NE that does not support management-mode change
◦ Reuse of old NE IP is not supported

Introduction
By default, the NE IP change is disabled in STMS, and you can enable it using the Admin tool.
The procedure is a three-steps process:
1. IP change from old to new to update FCs in far NEs.
2. Execute SQL queries.
3. Rediscover NE from the STMS GUI.

Enabling NE IP Change Capability

First of all, check the following:
1. From the STMS server, check if IP change is enabled: cd /opt/STMS/bin (stms user)./admin show |
grep ipChangeEnabled
2. Enable NE IP change capability: cd /opt/STMS/bin./admin set ipChangeEnabled true

Possible Configuration on NE During IP Change

Be aware of the following:
1. NE is discovered in STMS.
2. FCs (Internal/External) can exist.
3. Static trails created from LightSOFT can exist on the NEs.

Start
1. Launch STMS. If already launched, you may need to relaunch STMS to enable the IP address
change.
2. From the Tools menu, select Change NE IP Address.
The NE IP Change window opens.

3. In the Old NE IP field, enter the current NE IP address.

4. In the New NE IP field, enter the new NE IP address.
5. In the Old NE IMG(fe-rcp) IP (with subnet) field, enter the current physical IP address of the chassis.

Ribbon Communications Inc. Proprietary 59

 NE Management

6. In the New NE IMG(fe-rcp) IP (with subnet) field, enter the new physical IP address of the chassis.
7. Click Finish.
8. Read the notification and click Next.

9. Check the old and new IPs in the following message.

10. Click OK if accurate.

The old IP will disconnect from the STMS.

If the change is successful, a success message appears.

Ribbon Communications Inc. Proprietary 60

 NE Management

If the change fails, a message appears listing the peers for which fiber connectivity settings failed to
be updated.
In this case, you need to define fiber connectivity for each peer manually.

11. Execute the following script from the STMS:

./UtilStmsSqlFcUpdateIpChange -oldip "xx.xx.xx.xx" -newip "yy.yy.yy.yy" -screen trace -od
output
Xx.x.xx.xx = OLD ip
Yy.yy.yy.yy = NEW ip
40 stms(z10-solarist3) /etc/eci/test1 $ ./UtilStmsSqlFcUpdateIpChange -h
12. Discover the NE using the new IP address.
When a new IP is discovered, external FC will be in OK status.
13. Launch the FC manager and verify the FC with all Peer NEs are in OK status.
14. Check that links in LightSOFT are in the proper status.

Define Logging for an NE

Logging is enabled for an NE record of system-wide events, such as:
• Users logging in and out of the router
• Interfaces coming up or going down
• Changes to the configuration
• Authorization attempts
For more information on log management, see the STMS Performance Management Guide.
Start
1. In the Network Explorer tab, right-click the NE for which you want to set logging, and click Logging.
The Logging Levels window opens.
2. In the Logging Level list, select a level:
◦ Emergency: Panic conditions that make the system unusable
◦ Alert: Conditions that must be corrected immediately

Ribbon Communications Inc. Proprietary 61

 NE Management

◦ Critical: Critical conditions

◦ Error: Error conditions
◦ Warning: Warning messages
◦ Notice: Conditions that need special handling
◦ Info: Informational messages
◦ Disable: Logging
3. Click OK.

Note
Logging levels are defined in a hierarchical structure. Messages are displayed for the level you
specify and all those below that logging level. For example, if you set the logging level to alert,
messages for the emergency level are displayed in addition to messages for the alert level. If
you set the logging level to critical, messages for both the emergency and alert levels are
displayed in addition to messages for the critical level.

Note
By default, if you set logging for multiple NEs, messages for all of the NEs are displayed in the
Network Element Logging tab in the Alarm/Log panel. However, you can change the STMS
server view preference to display the logging messages for each NE in separate tabs in the
Alarm/Log panel.

View NE Temperature Statistics

You can view temperature statistics for an NE.
Start
1. In the Network Explorer tab, right-click on the NE and select Properties.
The NE properties appear.
2. Click the Operational Status tab.
The temperature statistics for the NE's installed cards appear in a table.

3. To view a graph of the statistics, select the checkboxes for the relevant cards (four maximum) in the
View Graph column and click View Graph.
A window opens, displaying a graph of the temperature statistics for the selected cards.

Ribbon Communications Inc. Proprietary 62

 NE Management

View Inhale Air Temperature and Rotation Speed

The system reliability level depends on the environmental conditions of the installation. In order to verify a
required reliability, it is essential to measure the inhale temperature and fans speed. These measurements
over time will provide a clear environmental condition picture.
• The inhale air temperature is measured in Celsius units and the highest and lowest temperature level
is saved for each 15-minute period.
• The fans rotation speed is measured both in RPM units and as a percentage (%), where 100% is the
full speed. For each 15-minute period, the highest and lowest speed is logged.
• Each 15-minute measurement is logged in the NE and later saved in the STMS, according to the
performance monitoring rule.
The data is displayed under the Inhale Data tab. Here all the high and low temperatures and fan speeds are
displayed in 15-minute intervals according to the configured time period.

Ribbon Communications Inc. Proprietary 63

 NE Management

Inhale Data tab

The Inhale Data is saved for 730 days (2 years) in STMS.

When it exceeds this time limit it is deleted using a Cron expression Days to Save 15Min InhaleFiles under
the PM Collection Manager.

Ribbon Communications Inc. Proprietary 64

 NE Management

PM Collection Manager

View NE Power Control Areas

OPT99xx features a distributed fully-redundant power feed subsystem. The power distribution is divided into
separate areas, where each xPFM pair provides power to one area.
Start
• Do one of the following:
◦ From the Network Explorer tab, right-click the NE and select Show Power Control Areas.
The Power Control Areas View window opens, displaying the OPT99xx chassis power
distribution structure. The color of the xPFM pair corresponds to the color of the cards/slots it is
feeding.

Ribbon Communications Inc. Proprietary 65

 NE Management

◦ From NE Chassis view, click on an xPFM.

The xPFM pair and the cards/slots it is feeding are highlighted.

Ribbon Communications Inc. Proprietary 66

 NE Management

View NE Capacity Data

You can view port usage and card capacity data for an OPT99xx NE.
Start
1. From the Network Explorer tab, right-click the NE and select Show Capacity.
The Show Capacity window opens, displaying the chassis.
The Capacity area shows the maximum capacity of the NE, the assigned cards capacity, and the
available capacity.
In the View area, the Port Usage view is selected by default. In this view, the number of assigned/

Ribbon Communications Inc. Proprietary 67

 NE Management

available ports appears at the top of each card in the chassis. Different colors within the cards indicate
the number of unused, provisioned, or blocked ports (see the legend).

2. To view card capacity data, select the Card Capacity view.

The percentage of used capacity appears at the top of each card in the chassis. Different colors within
the cards indicate the amount of free, provisioned, and blocked capacity (see the legend).

Ribbon Communications Inc. Proprietary 68

 NE Management

3. To export the capacity data to a CSV file, click Export.

Define LCT Access to an NE

You can manage the secure access level of each NE by defining its LCT Security Mode. This parameter
controls all LCT user privileges when connecting to the NE.

Note
Only users belonging to the Admin or Security user groups can define Security access to an NE.

The security modes available are:

• No Access: Disconnected.
• No Access with RO Option: Disconnected but the LCT user has the option to ask for Read Only
access.
• RO Access: Read Only access.
• RO Access with RW Option (default): Read Only access is allowed, and the LCT user has the option
to ask for Read Only access.
• RW Access: Read and Write access.
Start

Ribbon Communications Inc. Proprietary 69

 NE Management

1. Right-click on the NE and select Properties.

The NE Properties view appears.
2. Click the Security tab.
The LCT Security area appears.

3. From the LCT Security Mode dropdown list, select the required security mode and click Apply.

Note
Only users belonging to the Admin or Security user groups can define this setting. Other
users have read-only permissions.

Define Cryptographic Strength Security

Cryptographic strength determines the level of security required to achieve maximum security. This is
achieved by the use of crypto-profiles that include sets of algorithms and key-lengths. The profiles that have
been created all follow the format defined in a profile template that includes the profile name, description,
details, and compliance.

Note
Only users belonging to the Admin or Security user groups can define Security access to an NE.

Crypto-Profiles
The following crypto-profile is available:
• B-VTX-1: Provides a high degree of security and complies with umbrella security standards such as
CNSA-2016/01 and BSI-2018/01 as opposed to a collection piecemeal algorithm specific standards. It
also requires CA signed digital certificates.
The following is an example of the B-VTX-1 crypto-profile.
B-VTX-1 crypto-profile

Ribbon Communications Inc. Proprietary 70

 NE Management

Define a Crypto-Profile
Start
1. Right-click on the NE and select Properties.
The NE Properties view appears.
2. Click the Security tab.
The Cryptostrength Security area appears.

3. From the Crypto-Profile dropdown list, select the required profile and click Apply.

Ribbon Communications Inc. Proprietary 71

 NE Management

Note
Only users belonging to the Admin or Security user groups can define this setting. Other
users have read-only permission

View the Crypto Show Profile Tab

Start
1. Right-click on the STMS Domain and select Properties.
The STMS Domain Properties view appears.
2. Click the Security tab, and then select the Crypto Show Profile tab.
The Crypto Show Profile tab shows details of the currently configured crypto profile for the STMS
domain.

View the Supported Profiles Tab

Start
1. Right-click on the STMS Domain and select Properties.
The STMS Domain Properties view appears.

Ribbon Communications Inc. Proprietary 72

 NE Management

2. Click the Security tab, and then select the Supported Profiles tab.
The Supported Profiles tab shows details of the supported profiles for the STMS domain.

Define Diffie Hellman (DH) Groups

Diffie-Hellman is a ubiquitous cryptographic technique in encryption products. The security of DH depends on
a number of factors. One of these is a static, pre-shared parameter called DH-groups. Diffie-Hellman Groups
(DH Groups) are used to determine the strength of the key used in the Diffie-Hellman key exchange process.
The higher the DH Group numbers are more the more secure the key, but the downside is that high DH
Groups require additional processing resources to compute the key.
A given DH Group is known to encryption peers that need to establish common encryption keys. Typically a
DH Group is also publicly known and standardized, so that its integrity and security can be scrutinized and
trusted.
The following table shows the cards that support the different DH Groups.

Ribbon Communications Inc. Proprietary 73

 NE Management

Cards supporting DH Groups

Cards DH Groups

• TR10_4EN • MODP-Group-5
• TR10_12EN • MODP-Group-14
• HIO400EN • MODP-Group-15
• TM100_2EN • MODP-Group-16
• MIO200EN • MODP-Group-17
• TM200EN • MODP-Group-18
• MODP-Group-24
• ECDH-Group-SECP256R1
• ECDH-Group-SECP384R1
• ECDH-Group-SECP521R1

• TM200ENB • MODP-Group-14
• TR10_12ENB • MODP-Group-15
• TM100_2ENB • MODP-Group-16
• MODP-Group-17
• MODP-Group-18
• ECDH-Group-SECP256R1
• ECDH-Group-SECP384R1
• ECDH-Group-SECP521R1

For details on how to configure DH Groups on the above cards, see:

• Define TR10_4EN/TR10_12EN encryption settings
• Define TR10_12ENB encryption settings
• Define TM200EN/TM100_2EN encryption settings
• Define TM200ENB/TM100_2ENB encryption settings
• Define HIO400EN/MIO200EN encryption settings

NTP Configuration
Network Time Protocol (NTP) is used to synchronize the clocks in computers, routers, and other network
devices. There are many stratum-1 and stratum-2 time servers on the internet that are synchronized to UTC
via radio, satellite, or modem. Stratum-1 servers are synchronized to a reference clock, while stratum-2
servers are synchronized to stratum-1 servers.
You can configure the switch router to be an NTP client, an NTP server, or both. However, NTP servers are
only trusted (time-wise) if the server is synchronized to another server. This means that every NTP server is
synchronized to at least one other device upstream. This progression of NTP servers terminates at a high-
precision clock. When a synchronization attempt occurs and the switch router's time differs from the NTP
server time by less than 128 seconds (approximately two minutes), the clock is slowly synchronized.
However, if the switch router's clock differs from the NTP server by more than 128 seconds, the clock is not
synchronized. You must set the clock on the switch router to deviate from the correct time less than 128
seconds.
When the switch router first boots and connects to a network, it contacts its NTP boot server for the correct
time and date. You must configure an NTP boot server to ensure that the switch router's date and time are
set within 128 seconds of the current time so that the switch router can synchronize to an NTP server. You
can add more than one boot server for NTP. Additional servers make NTP synchronization more precise and
reliable.

Ribbon Communications Inc. Proprietary 74

 NE Management

The switch router can operate in the following NTP modes:

• Symmetric: An NTP host operating in this mode is synchronized by its peers and synchronizes its
peers. This mode is intended for root servers with moderate to large subnets where rapid response is
required.
• Client: An NTP host operating in this mode is synchronized by a peer. However, it does not
synchronize its peers.
• Broadcast: An NTP host operating in this mode broadcasts to a multicast or broadcast address,
which allows it to synchronize all of its peers. However, it cannot be synchronized by any of its peers.
This mode is intended for operation on high-speed LANs with numerous workstations and where the
highest accuracies are not required.
• Broadcast Client: A switch router operating in this mode enables reception of broadcast server
messages.
In order to avoid accidental or malicious disruption in the Client mode, both the server and client should
operate using symmetric-key or public-key authentication.
For further information refer to these sections:
• Configure NTP on an NE
• Add an NTP Bootstrap Server for an NE
• Remove an NTP Bootstrap Server from an NE
• Add an NTP Authentication Key for an NE
• Remove an NTP Authentication Key from an NE
• Define NTP Symmetric Mode
• Remove a Peer from the NTP Peers List for an NE
• Define NTP Client Mode
• Remove an NTP Server from the List of Servers for an NE
• Define an NTP Host in Broadcast Mode for an NE
• Define NTP Broadcast Client Mode
• Set the Device Date and Time
• Remove the NTP Configuration from an NE
• View NTP Properties

Configure NTP on an NE
You can configure NTP on an NE.
Start
1. In the Network Explorer tab, right-click the NE and select NTP > Configure.
The NTP Configuration Mode window opens.
2. Select the relevant NTP Mode checkbox (Symmetric, Client, Broadcast Server, or Broadcast
Client). You can select more than one mode.
3. To configure NTP authentication, select the Enable Authentication checkbox.
4. Click Next.
The NTP Configuration window opens.
5. You can perform the following procedures:
◦ Add an NTP Bootstrap Server for an NE
◦ Remove an NTP Bootstrap Server from an NE
◦ Add an NTP Authentication Key for an NE
◦ Remove an NTP Authentication Key from an NE
◦ Define NTP Symmetric Mode
◦ Remove a Peer from the NTP Peers List for an NE
◦ Define NTP Client Mode
◦ Remove an NTP Server from the List of Servers for an NE
◦ Define an NTP Host in Broadcast Mode for an NE
◦ Define NTP Broadcast Client Mode
◦ Set the Device Date and Time

Ribbon Communications Inc. Proprietary 75

 NE Management

◦ Remove the NTP Configuration from an NE

◦ View NTP Properties
6. Click Save. to save the configuration.
Once NTP is configured, the NE attempts to start using NTP to synchronize its time. However, if the
time difference between the NE and the NTP server is too large, the NE's time is not adjusted. See
Setting the Device Time to Work with NTP.

Add an NTP Bootstrap Server for an NE

You can add an NTP bootstrap server for an NE.
Start
1. In the NTP Configuration window, under the Bootstrap Servers list, click Add.
The Bootstrap Server Hostname window opens.
2. Enter the hostname or IP address of the NTP boot server, and click OK.
The hostname/IP address is added to the Bootstrap Servers list.

Note
You can add more than one boot server for NTP. More servers make NTP synchronization
more precise and reliable.

Remove an NTP Bootstrap Server from an NE

You can remove an NTP bootstrap server from an NE.
Start
• In the NTP Configuration window, from the Bootstrap Servers list, select the bootstrap server you
want to remove and click Remove.
The bootstrap server is removed.

Add an NTP Authentication Key for an NE

You can add an NTP authentication key for an NE.
Start
1. In the NTP Configuration window, click Add.
The Add Authentication Key window opens.
2. Define the following parameters for NTP authentication.

Ribbon Communications Inc. Proprietary 76

 NE Management

Parameters for NTP authentication

Parameter Description

Authentication A number for the authentication key, from 1-4,294,967,295.

Key

Type Authentication type - MD5. Must be the same between NTP peers.

Value Enter the password for authentication. If the password includes special
characters, enclose the password in quotes (").

Trusted Select this checkbox to configure the authentication keys that connecting NTP
peers can use when they connect to the switch router.

3. To add the authentication key to the Authentication Keys list, click Finish.

Note
Other NTP hosts can synchronize to the switch router without authentication. However, if NTP
authentication is configured, remote hosts must authenticate before they are used to
synchronize the time on the local switch router.

Remove an NTP Authentication Key from an NE

You can remove an NTP authentication key from an NE.
Start
• In the NTP Configuration window, from the Authentication Keys list, select the key you want to
remove and click Remove.

Define NTP Symmetric Mode

You can define an NE as an NTP host in symmetric mode.
Start
1. To add a peer, click Add.
The Add NTP Peer window opens.
2. Configure the following parameters.

Ribbon Communications Inc. Proprietary 77

 NE Management

Parameters for NTP host in symmetric mode

Parameter Description

Hostname Hostname or IP address of the remote NTP peer.

Prefer Select this checkbox if this peer is preferred over all other configured peers.

Version Version of NTP packets you want the NE to send, from 1 to 3.

Min Poll Minimum polling interval, in the range 4-14. These values represent a power 2,
so the polling interval can be set from 16 (24) to 16,384 (214) seconds. Min.
polling interval must be less than the max. polling interval. Default is 6 (i.e., 64
seconds).

Max Poll Maximum polling interval, in the range 4-14. These values represent a power 2,
so the polling interval can be set from 16 (24) to 16,384 (214) seconds. Max.
polling interval must be greater than the min. polling interval. Default is 10 (i.e.,
1024 seconds).

Key If authentication is required, select an authentication key number from the

dropdown list.

3. To add the peer to the NTP Peers list for this NE, click Finish.

Remove a Peer from the NTP Peers List for an NE

You can remove a peer from the list of NTP peers.
Start
• In the NTP Configuration window, from the NTP Peers list, select the peer you want to remove and
click Remove.
The peer is removed from the list.

Define NTP Client Mode

You can define an NE as an NTP host in client mode.
Start
1. To add a server, click Add.
The Add NTP Server window opens.
2. Configure the following parameters.

Ribbon Communications Inc. Proprietary 78

 NE Management

Parameters for NTP client mode

Parameter Description

Hostname Hostname or IP address of the remote NTP server.

Prefer Select this checkbox if this server is preferred over all other configured servers.

Version Select the version of NTP packets you want the NE to receive, from 1 to 3.

Min Poll Enter the minimum polling interval, in the range 4-14. These values represent a
power 2, so the polling interval can be set from 16 (24) to 16,384 (214) seconds.
The min. polling interval must be less than the max. polling interval. Default is 6
(i.e., 64 seconds).

Max Poll Enter the maximum polling interval, in the range 4-14. These values represent a
power 2, so the polling interval can be set from 16 (24) to 16,384 (214) seconds.
The max. polling interval must be greater than the min. polling interval. Default is
10 (i.e., 1024 seconds).

Key If authentication is required, select an authentication key number from the

dropdown list.

3. To add the server to the list of NTP servers for this NE, click Finish.

Remove an NTP Server from the List of Servers for an NE

You can remove a server from the list of NTP servers for an NE.
Start
• In the NTP Configuration window, From the NTP Servers list, select the server you want to remove
and click Remove.
The server is removed from the NTP Servers list.

Define an NTP Host in Broadcast Mode for an NE

To define an NTP host in broadcast mode for an NE:
1. In the NTP Configuration window, click Add.
The Add Broadcast Servers window opens.
2. In the Broadcast Servers group, define the following parameters.

Ribbon Communications Inc. Proprietary 79

 NE Management

Parameters for NTP host in broadcast mode

Parameter Description

Broadcast Address IP multicast address to which to send NTP messages.

Version Version of NTP packets you want the NE to receive, from 1

to 3.

Key If authentication is required, select an authentication key

number from the dropdown list.

TTL Enter the time-to-live (TTL) value for the NTP packets the
switch router sends, from 1 to 7 (default 1).

3. To add the NTP host to the Broadcast Servers list, click Finish.

Define NTP Broadcast Client Mode

You can define an NE to listen for broadcast NTP messages.
Start
In the Broadcast Client group, define the following parameters.

Parameters for NTP broadcast client mode

Parameter Description

Broadcast Client Select this checkbox to enable the NE to listen for broadcast
NTP messages.

Multicast Address Multicast IP address from which to listen for messages.

Set the Device Date and Time

The date and time can be set manually or you can configure an NTP server to synchronize the date and
time.
When NTP is configured, a synchronization attempt occurs. If the switch router's time differs from the NTP
server's time by less than 128 seconds, the clock is slowly synchronized. However, if the switch router's
clock differs from the NTP server by more than 128 seconds, the clock cannot be synchronized, and you
must manually change the clock on the switch router (to be less than 128 seconds off the NTP time).
You can manually change the router clock by either logging in to the router and changing it in LSH, or by
removing the NTP configuration and manually changing the clock via the STMS GUI.
You can use the Set Device Date and Time window to set the device's time.

Note
If NTP is configured, setting the date and time manually is disabled. If NTP is not configured, you can
only set the date and time manually.

Ribbon Communications Inc. Proprietary 80

 NE Management

Start
1. In the Network Explorer tab, right-click the NE and select Properties.
The NE properties appear.
2. Click Set Date & Time.
The Set Device Date and Time window opens.

3. Do one of the following:

◦ To set the date and time from the NTP server, select the NTP Server option and select an NTP
server from the dropdown list.
◦ To manually set the date and time, select the Set Date & Time Manually option and enter a new
time. In the first field, enter the date in MM/DD/YYYY format. In the second field, enter the time in
HH:MM:SS format (HH in 24-hour format).
4. Click Finish.

Remove the NTP Configuration from an NE

You can remove the NTP configuration from an NE.
Start
• In the Network Explorer tab, right-click the NE from which you want to remove NTP and select NTP >
Remove.
The NTP configuration is removed from the NE.

Note
The configuration can be changed within the modes already selected. For example, if Client
mode is selected, peers can be added, removed, or modified.

View NTP Properties

You can view NTP properties.
Start
1. In the Network Explorer tab, right-click the NE whose properties you want to view, and select
Properties.
2. Click the NTP tab. (If the NTP tab is not visible on the tab bar, click the right arrow on the row of tabs
until the tab becomes visible.)
In the Operational tab, you can see the following operational properties of NTP peer associations:
◦ remote: Name of the remote NTP server.
◦ refid: Where each server is getting its time right now, either a server hostname or something
like .GPS., indicating a Global Positioning System source.
◦ st: Stratum - a number from 1 to 16, indicating the remote server precision. 1 is the most accurate,
16 means 'server unreachable'. Your stratum is equal to the accurate remote server plus 1.

Ribbon Communications Inc. Proprietary 81

 NE Management

◦ poll: Polling interval (in seconds) between time requests. The value ranges between the min. and
max. allowed polling values. Initially the value is smaller to allow synchronization to occur quickly.
After the clocks are 'in sync', the polling value increases to reduce network traffic and load on
popular time servers.
◦ reach: Octal representation of an array of eight bits, representing the last eight times the local
machine tried to reach the server. The bit is set if the remote server was reached.
◦ delay: Length of time (sec) needed to receive a response for a "what time is it" request.
◦ offset: The most important value; the difference of time between the local and remote server. In
the course of synchronization, the offset time drops more, indicating that the local machine time is
getting more accurate.
◦ jitter: Dispersion, also called jitter, is a measure of the statistical variance of the offset across
several successive request/response pairs. Lower dispersion values are preferred over higher
dispersion values as they allow more accurate time synchronization.
3. Click the Configuration tab to view the NTP configuration properties. These include:
◦ List of Bootstrap servers
◦ List of Authentication Keys
◦ List of Peers for symmetric mode
◦ List of servers for client mode
◦ Broadcast server configuration
◦ Broadcast client configuration

Security Certificate Management

The STMS and NEs use security certificates for SSL communication. STMS acts as a Certificate Authority
(CA) for creating security certificates. Each certificate (key-pair) is composed of a private key and a public
key.
You can create certificates using:
• STMS as a CA: meaning that the STMS is acting as a CA for the NE
• EJBCA: a third party CA that manages and validates its certificates
If you are using SSL, you can create a new STMS certificate by either loading it from an existing file or by
instructing the STMS to generate a new file (see Create a new STMS Certificate). You can then choose
whether to enable the STMS to distribute the new STMS public key to the NEs (with V6.1 or higher)
automatically, or to load it to each NE manually yourself (via disk-on-key/Telnet). You must load the public
key manually to NEs with V5.1 or lower.
You must load the first EJBCA certificates using open SSL commands. Thereafter certificates are created
automatically according to your settings. You can generate certificates for all the NEs or for a specific NE.
STMS maintains a Certificate Revocation List (CRL) that maintains a list of digital certificates that have been
revoked by the issuing CA before their scheduled expiry date and should no longer be trusted. You can
create certificates for all the NEs or for a specific NE. As new certificates are created, the old certificates are
moved to the CRL. Once a certificate is activated automatically, the NE is discovered automatically.
Certificates are issued with a specified lifetime (from 30 to 365 days). You can set alarms on certificates to
automatically renew the certificate x-number of days before the expiry date. When that day is reached, the
CA automatically renews the certificate. If there is a breakdown in communication between the CA server
and the NE, STMS polls the CA/CRL every x-hours, as configured in the CA Configuration tab (see Configure
alarms from the CA). If the certificate is not renewed automatically due to a breakdown in communications,
am alarm is indicated for the select NE or all NEs that the certificate is now invalid.
For further information refer to these sections:
• Register a CA
• Configure the CA
• Generate Certificates for all NEs
• Generate a CA Signed Certificate for STMS
• Activate a CA Signed Certificate for STMS

Ribbon Communications Inc. Proprietary 82

 NE Management

• Generate a Certificate for a Specific NE

• Activate a Certificate for a Specific NE
• View a CSR
• Delete a CA
• View CA Status
• View Signed Certificate Status
• View Deleted Authority Status
• View the CRL
• View the Peer IPs Table: STMS
• Secure Boot

Register a CA
You can register STMS as a CA or EJBCA as the CA. You can configure more than one CA, however, you
can only have one active CA at a time.
Start
1. In the Network Explorer tab, right-click the STMS Domain and select Properties > Security > CA
Registration.
The CA Registration tab appears.

2. From the CA Type dropdown list, select the CA you want to register. You can select from:
◦ STMS as a CA
◦ EJBCA
3. If you select STMS as a CA the Host Name, Port and User Name fields are deactivated. Continue
with step 5.
4. 4.If you selected EJBCA, enter the following information of the EJBCA server:
◦ Host Name
◦ Port
◦ User Name
5. In the Password field, enter the password of the CA.
6. In the CA Name field, enter the name of the CA.

Note
The CA-name must be the same as root-CA certificate name.

7. Click Apply.

Configure the CA
You can configure the CA.
Start

Ribbon Communications Inc. Proprietary 83

 NE Management

1. In the Network Explorer tab, right-click the STMS Domain and select Properties > Security > CA
Configuration.
The CA Configuration tab appears.

The Active CA is the name of the CA as entered in the CA Registration tab.

2. From the Alarm Period (DigitalCertificateExpirationReminder) dropdown list, select the number of
days for the alarm. You can select from 7 to 30 days.
3. From the Certificate Valid Period dropdown list, select the number of days that you want the
certificate to be valid for. You can select from 30 to 365 days.
4. From the CA/CRL Polling Period dropdown list, select the number of hours between polling. You can
select from 1 to 6 hours.
5. Click Apply.

Generate Certificates for all NEs

You can generate certificates for all NEs. When you generate certificates for all NEs the generation process
also activates all the certificates.
Start
1. In the Network Explorer tab, right-click the NE and select Security > Sign NE(s) Certificate.
The NE Ca Certificate Parameters window appears.

2. In the Country Name field, enter the 2-letter code for your country.
3. In the Organizational Unit Name field, enter the name of your organizational unit.

Ribbon Communications Inc. Proprietary 84

 NE Management

4. In the Email Address field, enter your email address.

5. From the CA dropdown list, select the name of the CA issuing the certificate.
6. Click Generate.
The CSRs are generated and activated for all NEs.

Generate a CA Signed Certificate for STMS

You can generate a CA (EJBCA/STMS as a CA) signed certificate for STMS.
Start
1. In STMS select Security > STMS Signed Certificate > Fetch CSR.
The NE <NE name> Ca Certificate Parameters window appears.

2. In the Common Name field, enter a name for the certificate

3. In the Country Name field, enter the 2-letter code for your country.
4. In the Organizational Unit Name field, enter the name of your organizational unit.
5. In the Email Address field, enter your email address.
6. From the Algorithm dropdown list, select the required algorithm. You can select from RSA and
ECDSA.
7. From the Key/Curve dropdown list, select the modulus of the algorithm.
◦ If you selected RSA as the algorithm, you can select from 3072, 4096, and 8192.
◦ If you selected ECDSA as the algorithm, you can select from prime256v1, secp384r1, and
secp521r1.
8. Click Generate.
The CSR is generated for the selected NE.

Activate a CA Signed Certificate for STMS

You can activate a CA (EJBCA/STMS as a CA) signed certificate for STMS.
Start
1. In STMS select Security > STMS Signed Certificate > Activate Certificate.
A Do you want to continue? message appears notifying you that this operation will create new
authentication keys by the NE that will affect communication between STMS and the NE.

Ribbon Communications Inc. Proprietary 85

 NE Management

2. (Optional) Select Add Certificate to CRL List if you want the certificate you are replacing to be added
to the CRL.
3. Click Continue.
A message appears confirming that the certificate was activated successfully and the old certificate is
moved to the CRL so that it can't be used again. The NE is discovered automatically.

Generate a Certificate for a Specific NE

You can generate a certificate for a specific NE.
Start
1. In Network Explorer right-click the NE for which you want to generate a certificate and select
Security > Fetch CSR From NE.
The NE <NE name> Ca Certificate Parameters window appears.

2. In the Common Name field, enter a name for the certificate

3. In the Organizational Unit Name field, enter the name of your organizational unit.
4. In the Email Address field, enter your email address.
5. From the CA dropdown list, select the required CA.
6. Click Generate.
The CSR is generated for the selected NE.

Activate a Certificate for a Specific NE

You can activate a certificate for a specific.
Start

Ribbon Communications Inc. Proprietary 86

 NE Management

1. In Network Explorer right-click the NE for which you want to activate a certificate and select Security
> Activate Certificate.
A Do you want to continue? message appears notifying you that this operation will create a new
authentication keys by the NE that will affect communication between STMS and the NE.

2. (Optional) Select Add Certificate to CRL List if you want the certificate you are replacing to be added
to the CRL.
3. Click Continue.
A message appears confirming that the certificate was activated successfully and the old certificate is
moved to the CRL so that it can't be used again. The NE is discovered automatically.

View a CSR
You can view the CSR of a certificate that has been generated but not yet activated.
Start
• In STMS select Security > STMS Signed Certificate > View CSR.
The View CSR window appears.

Note
You can also view the CSR for a specific NE as follows:
◦ In Network Explorer right-click the NE for which you want to view the CSR and select
Security > View CSR.

Ribbon Communications Inc. Proprietary 87

 NE Management

Delete a CA
You can only delete a CA if there is another CA that has been defined and for which a CSR have been
generated, meaning there must always be one CA registered in the system.
Start
1. In STMS select Security > Delete Authority.
The Delete CA Root Key window appears.

2. From the CA dropdown list, select the CA to delete.

3. Click Delete.

Note
You cannot delete the current CA because there must be at least one CA registered.

View CA Status
When you are transitioning from one CA to another, you may want to view the statuses of the CSR
certificates during the transition.
Start
1. In STMS select Security > Status > Load CA Root Key Status.
The Load CA Root Key Status window appears.

Ribbon Communications Inc. Proprietary 88

 NE Management

During the transition from one CA to another this window shows the status of the CSRs as the
transition process progresses.
2. Click Refresh to show the latest status.

View Signed Certificate Status

When you are transitioning from one CA to another, you may want to view the statuses of the CSR
certificates during the transition.
Start
1. In STMS select Security > Status > Sign NE(s) Certificate Status.
The Sign NE(s) Certificate window appears.

Ribbon Communications Inc. Proprietary 89

 NE Management

During the transition from one CA to another this window shows the status of the signed NEs
certificates as the transition process progresses.
2. Click Refresh to show the latest status.

View Deleted Authority Status

When you delete a CA, you may want to view the status of the NEs during the deletion process.
Start
1. In STMS select Security > Status > Delete Authority Status.
The Delete Authority Status window appears.

Ribbon Communications Inc. Proprietary 90

 NE Management

This window shows the status of the NEs as the CA is being deleted.
2. Click Refresh to show the latest status.

View the CRL

You can view a list of all CAs in the CRL.
Start
• In the STMS window, click Security > View CRL.
The View - CRL STMS window appears.

Ribbon Communications Inc. Proprietary 91

 NE Management

View the Peer IPs Table: STMS

For data encryption, NEs have to authenticate themselves when sending messages to other NEs. Each NE
stores a list of peer IPs containing the public key of each NE from which it can receive encrypted messages.
The Peer IPs table contains entries created and updated by the STMS for the NE automatically. The table
shows whether each peer IP is in use, and whether the peer public key is consistent with the value of NE
public key stored by the STMS (for the peer IP). If the public key is inconsistent, you can fix this
inconsistency via the Resolve option.
Start
• In the Network Explorer tab, right-click the NE and select Security > Peer IPs Table.

Ribbon Communications Inc. Proprietary 92

 NE Management

The Peer IPs Table window opens.

◦ To delete entries from the table, select the relevant entries and click Delete.
◦ If the peer public key is inconsistent with the value of the NE public key stored by the STMS for the
peer IP (No appears in the Peer Public Key Consistency column), click Resolve to fix the
inconsistency.

Secure Boot
As of V9.6R1, OPT9901X supports a secure boot, which is built in to the hardware. A secure boot process of
a device is essentially a chain-of-trust implementation where the security/ integrity of the first link in that
chain is guaranteed by some physical means that are hard to defeat. In the context of Ribbon products, it
could be some hardware electro-mechanical implementation that provides a reasonably high assurance that
the first verification will always take place and the system will progress only if this first verification step is
successful.

Ribbon Communications Inc. Proprietary 93

 NE Management

NE Configuration Backup and Restore

You can create backups of one or more NE's configuration information, as well as persistent files. Backups
are stored in the STMS database.
Using the Configuration Manager, you can:
• Schedule recurring backups to start at any time hourly, daily, or weekly, schedule a one-time backup,
or start an immediate backup.
• View the details of an existing backup.
• Suspend a scheduled backup, resolve schedule conflicts automatically, and audit backup and restore
events.
• Compare the details of two backups of the same NE (or two NEs of the same type) and view the
differences between them.

Ribbon Communications Inc. Proprietary 94

 NE Management

Notes
◦ For the OPT96xx: This feature requires that a Secure Shell/Secure Copy (SSH/SCP) or
File Transfer Protocol (FTP) service be running on the computer that is hosting the STMS
server, and that the host's firewall allows connections to that service.
◦ For the 9200 series: This feature requires that Trivial File Transfer Protocol (TFTP) be
running on the computer hosting the STMS server.
◦ The user name and password to use for accessing this service must also be configured
as STMS Domain properties. See View STMS Domain properties.

For further information refer to these sections:

• Define the Backup File Directory
• Perform an Immediate Network Configuration Backup
• Schedule a Network Configuration Backup
• View All Network Configuration Backups
• View a Specific Network Configuration Backup
• View the Network Configuration Backup Log
• Suspend a Scheduled Network Configuration Backup
• Resume a Scheduled Network Configuration Backup
• Monitor the Network Configuration Backups
• Edit a Scheduled Network Configuration Backup
• Delete a Scheduled Network Configuration Backup
• Sort the List of Scheduled Network Configuration Backups
• Verify a Network Configuration Backup
• Delete a Network Configuration Backup
• Compare Network Configuration Backups
• Save a Network Configuration Backup to a File
• Restore an NE Configuration Backup
• Restore a Selected Configuration

Define the Backup File Directory

The default directory for the network configuration backups on the STMS server is: /opt/STMS/data/
deviceConfig
You can change the directory as required.
Start
1. From the Edit menu, select Server Preferences.
The STMS Domain properties appear.
2. In the General tab, delete the file directory defined in the Network Element File Directory field, and
enter the new directory.
3. Click Apply.
The new file directory is defined.

Perform an Immediate Network Configuration Backup

You can perform an immediate backup of the network configuration using one of the following methods:
Method 1
Start
1. From the main menu, select Tools and then select Configuration Manager.
The Configuration Manager window opens.
2. In the Backup Scheduler tab, click Create. The Create Schedule window opens.
a. Select the Start Immediately checkbox.

Ribbon Communications Inc. Proprietary 95

 NE Management

b. Enter a label to identify this backup.

OR
3. In the Backup Manager tab, click Create. The Create System Configuration Backup window
opens.
(Optional) Enter a label to identify this backup.
4. In the Select the NEs to backup pane, select the checkbox corresponding to the NE(s) you wish to
back up.
5. Click OK.
A confirmation message appears.
6. Click Yes.
The backup begins immediately.
The backup result appears in the Result column in the Backup Manager tab. If the backup fails, the
reason for the failure is shown in Reason column in the Backup Manager tab.
Method 2
Start
1. Right-click the NE you wish to back up, and select Actions.
2. Select Backup Configuration Now.
The STMS automatically backs up the configuration of the NE you have selected.

Schedule a Network Configuration Backup

You can schedule a backup of the network configuration.
Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Select the Backup Scheduler tab, and then click the Create button. The Create Schedule window
opens.
OR
Right-click the NE you wish to back up:
a. Select Actions.
b. Select Schedule Configuration Backup. The Create Schedule window opens.
3. From the Start Time dropdown lists, enter the month, day, year, and time the backup must first be run.
4. From the Interval list, select the desired time interval.
5. Enter a label to identify this backup.

Note
If the label you specify is a duplicate of another active schedule's label, an error message
appears.

6. In the Select the NEs to Backup pane, select the checkbox corresponding to the NE(s) you want to
back up.
7. Click OK.
A confirmation message appears.
8. Click Yes.
The backup begins at the scheduled time.
The backup result appears in the Result column of the Backup Manager tab. If the backup fails, the
reason for the failure is also shown in Reason column in the Backup Manager tab. In addition, a
failure event is created and appears in the Events Manager tab.

View All Network Configuration Backups

You can view network configuration backups.

Ribbon Communications Inc. Proprietary 96

 NE Management

Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Manager tab.

View a Specific Network Configuration Backup

You can view a specific network configuration backup.
Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Manager tab.
3. From the list, select the NE backup you want to view.
The configuration information appears in the View Configuration window.

View the Network Configuration Backup Log

You can view the network configuration backup log entries.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
2. Click the NE Event Logs tab.
3. Click the Filter button.
The NE Event Log Filter window opens.
4. Select the Type checkbox.
5. From the corresponding dropdown list, select configuration archive to view configuration backup
logs. Or select scheduled archive to view scheduled backup logs.
6. Click Apply.

Suspend a Scheduled Network Configuration Backup

You can temporarily defer a scheduled backup. A suspended scheduled backup is not performed until it is
resumed. See Resume a Scheduled Network Configuration Backup.
Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Scheduler tab if it is not already active.
3. Right-click the backup schedule you want to suspend from the list, and select Suspend from the
shortcut menu.

Note
If the backup is set for "once", it cannot be suspended.

4. Click Yes to confirm. The backup schedule is suspended. You can confirm the suspension by viewing
the log. See View a Specific Network Configuration Backup.

Resume a Scheduled Network Configuration Backup

You can resume a scheduled backup that was suspended. The scheduled backup is performed at its next
scheduled time.
Start

Ribbon Communications Inc. Proprietary 97

 NE Management

1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Scheduler tab if it is not already active.
3. From the list, right-click the backup schedule you want to resume and select Unsuspend from the
menu. The backup schedule is resumed. You can confirm the resumption by viewing the log. See
View a Specific Network Configuration Backup.

Monitor the Network Configuration Backups

You can monitor the status of a network configuration backup in real time by observing the network
configuration backup log entries.
See View the Network Configuration Backup Log.

Edit a Scheduled Network Configuration Backup

You can edit an existing scheduled backup. A scheduled backup is not processed while it is being edited.
Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Scheduler tab if it is not already active.
3. Right-click the backup schedule you want to edit, and select Edit from the menu. The Edit Schedule
window opens.
4. (Optional) Using the Start Time dropdown lists, change the month, day, year, and time the backup
should be run.

Note
If the backup is set for "once", you cannot edit its interval.

5. (Optional) In the Select the NEs to Backup pane, select the checkbox(es) corresponding to the
NE(s) you want to back up.
6. Click OK.
A confirmation message appears.
7. Click Yes.
The backup begins at the scheduled time.
8. To view the results of the backup, check the bottom of the Configuration Manager window or the NE
Event Logs.

Delete a Scheduled Network Configuration Backup

You can delete a scheduled network configuration backup.
Start
1. From the main menu, select Tools and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Scheduler tab if it is not already active.
3. Right-click the scheduled backup(s) you want to delete from the list, and select Delete from the menu.
4. Click Yes to delete the scheduled backup(s).

Sort the List of Scheduled Network Configuration Backups

You can sort the list of scheduled network configuration backups by any of the headers in the list.
Start

Ribbon Communications Inc. Proprietary 98

 NE Management

1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Scheduler tab if it is not already active.
3. Click the heading in the list by which you want to sort.
The list of scheduled configuration backups is sort by the selected column heading.

Verify a Network Configuration Backup

You can verify that a network configuration backup was processed by viewing the NE Event Logs.
See View the Network Configuration Backup Log.

Delete a Network Configuration Backup

You can delete a network configuration backup.
Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Explorer tab.
3. Right-click the NE backup you want to delete, and from the menu select Delete.
4. Click Yes to confirm.
The backup is deleted.

Compare Network Configuration Backups

You can compare the details of two backups of the same NE and view the differences between them.
Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Manager tab.
3. Right-click an NE backup you wish to compare, and select Diff... The Configuration Diff window
opens.
4. From the dropdown list, select another configuration backup to compare.
5. Click OK. The configuration differences are displayed.

Save a Network Configuration Backup to a File

You can save the contents of a network configuration backup to a text file.
Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Manager tab.
3. Right-click the NE backup you wish to save to a text file, and select Export from the menu.
The Save window opens.
4. Select the directory where you want to save the file, and enter a file name.
5. Click Save.
The backup is saved to a text file.

Restore an NE Configuration Backup

You can restore a network configuration backup to the NE from which it originated.
Manual Restore

Ribbon Communications Inc. Proprietary 99

 NE Management

Start
1. From the main menu, select Tools, and then select Configuration Manager.
The Configuration Manager opens.
2. Click the Backup Manager tab.
3. Right-click the NE backup you want to restore, and select Restore from the menu.
A confirmation message appears.
4. If you want to reboot the NE after configuration is restored, select the Reboot upon completion
checkbox.
5. Click Yes to confirm.
The backup is restored to the originating NE.
Automatic Restore
Start
• Right-click the NE on which you want to restore the backup configuration, and from the menu, select
Actions and then Restore Last Configuration.
The STMS automatically restores the latest backup for the NE you have selected.

Restore a Selected Configuration

If you have multiple configurations, you can choose which configuration to restore on an NE.
Start
1. Right-click the NE on which you want to restore configuration.
2. Select Actions and then Restore Selected Configuration.
The Restore Selected Configuration window opens.
3. Select the NE backup from the list you want to restore, and click OK.

NE Event Logs
The NE event logs list the transactions recording the changes to the NEs. A log is entered in the event logs
when one of the following occurs:
• Discovery of an NE - Success or Failure
• Changes to an NE - Reachable or Unreachable
• Results of NE Profile apply operations - Success or Failure
• Results of software apply operations
• Results of Backup operations - Success or Failure
• Results of Backup schedule - Started, Completed, or Failed
• Results of Backup restoration - Success or Failure
From STMS, you can:
• View NE Event Logs
• Filter the NE Event Logs List
• Define the Number of Logs per Page
• Purge NE Event Logs
• Export NE Event Logs to an XML File
• Stop and Restart Logging for NE Events

View NE Event Logs

You can view the NE event logs.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.

Ribbon Communications Inc. Proprietary 100

 NE Management

2. Click the NE Event Logs tab.

The list of NE event logs appears in the Live tab. This shows a list of NE event logs with the following
properties:
◦ The list automatically updates whenever a new NE event occurs.
◦ The list is always sorted by time in descending order. You cannot sort this list any other way.
◦ The list includes NE Event Logs since STMS was installed or since the last purge command,
whichever was later.
◦ The list contains a maximum of 1000 records. Records are maintained in a First In First Out (FIFO)
method. So if the number of records exceeds 1000, the oldest records are discarded.
◦ Severities are highlighted in color as follows:
• Red - CRITICAL
• Gray - WARNING
• Orange - MAJOR
• Yellow - MINOR
3. Right-click the row and click View Details to show event details which are too lengthy to display in a
column.

Filter the NE Event Logs List

You can filter the NE event logs list.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
2. Click the NE Event Logs tab.
3. In the Query tab, click Filter.
The NE Event Log Filter window opens.

This window contains eight different filters, one for each column. The following conditions apply:
◦ You must select the checkbox next to each filter before it can be applied.
◦ If more than one filter is selected, the selected filters are applied in an "AND" operation.
For example, in the window above, the Type and IP Address filters are selected. Therefore, the
list contains only Event Logs that have a type of "ne discovery" and have an IP Address in the
range of 10.0.232.20-24/27.
◦ To remove the filter, clear all the checkboxes and click Apply. This returns the full list of NE Event
Logs.

Ribbon Communications Inc. Proprietary 101

 NE Management

Define the Number of Logs per Page

You can define the number of logs that appear in the NE event logs list.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
2. Click the NE Event Logs tab.
3. In the Query tab, click Filter.
The NE Event Log Filter window opens.

4. In the Paging Size field, enter the new number of logs.

5. Click Apply.

Purge NE Event Logs

You can purge NE event logs prior to a selected date and time.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
2. Click the NE Event Logs tab.
3. In the Query tab, click the Purge button.
The Purge window opens.
4. Select the date and time from which you want to keep log files.
All logs prior to the selected date and time will be purged.
5. Click OK.
Purged logs are exported to an XML file on the server. Upon completion, a message with the path to
this file appears.

Export NE Event Logs to an XML File

You can export event logs to an XML file.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties.
2. Click the NE Event Logs tab.

Ribbon Communications Inc. Proprietary 102

 NE Management

3. In the Query tab, click Export.

4. Save the XML file to the relevant directory.

Stop and Restart Logging for NE Events

You can use the Stop Events and Start Events options to drop specific events at the STMS. You can define
the name of the events to be dropped in the event block list. You can either use the default block list, or
create and upload your own block list.
Start
1. In the Network Explorer tab, right-click STMS Domain and select Properties, then click the NE
Event Logs tab.
A list of NE event logs appears in the Live tab.

2. To stop processing events included in the block list, click Stop Events.
The STMS stops processing the specified events.
3. To restart processing events included in the block list, click Start Events.
The STMS restarts processing the specified events.
4. To upload a custom block list, click Upload Event Blocklist.
The Upload Event Blocklist dialog box appears.

5. From the dropdown list, select Empty Sample to download an empty sample file, or select and
existing block list, then click Download.
The selected file is downloaded.
6. In a text editor, open the file and edit the list of events as required, then save your changes.

Ribbon Communications Inc. Proprietary 103

 NE Management

7. In the Upload Event Blocklist dialog box, click Upload, then browse to and select your updated file.
The updated file is uploaded. The next time you click Stop Events, the STMS will stop processing the
events listed in the new block list.

ASON WSON Configuration

Optional Feature
Automatic Switched Optical Network (ASON) and Wavelength Switched Optical Network (WSON)
protection are available in the STMS on a cost basis. To ensure ASON/WSON restoration is
supported, verify that the purchased license is current and has not exceeded its token limits (see
Manage Licenses in the STMS Getting Started and Administration Guide).

The Apollo platform supports the implementation of ASON and WSON protection. ASON- and WSON-
protected trails are created in LightSOFT and managed via the GMPLS Control Plane. The Control Plane is
capable of establishing LSPs comprising ODUk XCs or OCH XCx and can create, delete, manage, and
protect the LSPs.
The STMS manages the ASON/WSON trail on the NE-level only, and mainly provides support for LightSOFT
management of the ASON/WSON trails.
The STMS receives and handles notifications about the creation, deletion, and modification of ASON
attributes on OTUk ports and WSON attributes on OTS ports.
For further information refer to these sections:
• View ASON-WSON Control Plane Attributes
• View ASON-WSON Control Plane Protocol Attributes
• View ASON-WSON Port Parameters
• View the ASON-WSON Trails List
• View the GMPLS Control Channels List
• View XC Resource Ownership
• Define Auto-Discovered ASON Data Links

View ASON-WSON Control Plane Attributes

Where ASON/WSON support is employed on the network, XCs and their sub-interfaces can be owned by the
Control Plane or by the management plane (LightSOFT, STMS, or ShadeTree CLI). Resources controlled by
the Control Plane can only be managed (created, deleted, or modified) by the Control Plane. You can,
however, view ASON/WSON Control Plane attributes.
Start
1. In the Network Explorer tab, right-click the NE and select Properties.
The NE properties appear.
2. Select the CP Attrs tab.
The Control Plane attributes appear. See the table below for a description of the attributes.

Ribbon Communications Inc. Proprietary 104

 NE Management

Control Plane attributes

Attribute Description

GMPLS Mode Defines whether ASON or WSON is enabled for the NE.

Inhibit GMPLS If set to Yes, it prevents ASON/WSON protection from switching to

this restoration path. Only relevant if GMPLS Mode is set to ASON
or WSON.

CP Router IP Address (read-only) IP address of the Control Plane DCN

View ASON-WSON Control Plane Protocol Attributes

You can view ASON/WSON Control Plane protocol attributes.
Start
1. In the Network Explorer tab, right-click the NE and select Properties.
The NE properties appear.
2. Select the CP Protocols Attrs tab.

Note
The CP Protocols Attrs tab only appears if GMPLS Mode is set to ASON or WSON.

The Control Plane protocol attributes appear. See the table below for a description of the attributes. All
of the attributes, except Signaling Recovery Time, are read-only.

Ribbon Communications Inc. Proprietary 105

 NE Management

Ribbon Communications Inc. Proprietary 106

 NE Management

Control Plane protocol attributes

Attribute Description

RSVP-TE Signaling

Hello Interval The time interval (in seconds) between RSVP-TE signaling
hello messages.

Signaling Refresh Interval The time interval (in seconds) between RSVP-TE refresh
messages sent to upstream or downstream next hop (in
seconds).

Clear-out Multiplier The Signaling Refresh Interval is multiplied by the Clear-out

Multiplier to define the time period in which refresh messages
can be received for the LSP. If no refresh message is received
for the LSP during this time period, the CP controller tears
down the LSP.

Signaling Recovery Time The time period during which the restarted device can get
recovery information from its neighbors.

No. of Retry Restoration Intervals The number of intervals that the NE attempts to restore the
trail.

No. of Restoration Attempts in One The number of times that the NE attempts to restore the trail
Retry within one interval.

Retry Restoration Time Interval The time period (in seconds) between restoration attempts.

Data Link WTR By default, the value is 5 mins (read only)

OSPF-TE

Hello Interval The time interval (in seconds) between OSPF-TE hello
messages.

Link State Advertisement Refresh Time The time interval (in seconds) between OSPF-TE refresh
messages.

Minimum Link State Advertisement The minimal time interval (in seconds) between two LSA
Interval messages about the same TE-link.

TE Metric The type used as TE metric. Must be the same for the entire
network.
• For ASON: Hop Count, Cost, or Length
• For WSON: Hop Count, Cost, Length, or OSNR

Ribbon Communications Inc. Proprietary 107

 NE Management

View ASON-WSON Port Parameters

ASON/WSON port parameters are defined in LightSOFT and inherited by the STMS. From the STMS, you
can only view these parameters (which are read-only).
Start
1. In the Network Explorer tab (or in Chassis view), right-click the relevant port (OTUk port for ASON or
OTS port for WSON) and select Properties.
The port properties appear.
2. Select the GMPLS Parameters tab.
The ASON/WSON port parameters appear. See the tables below for the parameter descriptions.

Ribbon Communications Inc. Proprietary 108

 NE Management

ASON port parameters

Parameter Description

Network Interface Type Network interface type. Possible values: NNI, UNI, None.
Only NNI ports can be the endpoints of ASON data link. All other ASON
fields only contain meaningful data when the network interface type is NNI.

Auto Discovery Indicates whether NE remote NE discovery is enabled/disabled.

Remote NE ID NE ID of the remote NE.

Received Remote NE ID NE ID of the remote NE received.

Remote Port ID Port ID for the ASON port on the remote NE.

Received Remote Port ID Port ID for the ASON port on the remote NE received.

Data Link EndPoint If the port is a TE-Link endpoint (i.e. the TE-Link exists in the NE) and
there is no mismatch between peer IDs on both ends of the TE-Link, the
value should be Yes. In all other instances, the value should be No.

Data Link Length (km) Link length in kilometers.

Data Link Operational State Operational state value of the TE-Link entity with an endpoint on this port
(Up, Down, Init, or Degraded).

ASON XC Defined Indicates whether an ASON XC has been created on the port.

Tributary Slot Type Bandwidth of each tributary slot.

Data Link Cost Value of cost metric.

Supported ODU Types ODU rates supported for the selected port.

Data Link Latency The latency or delay in micro-seconds which will be added when a signal
traverses the Data link.

SRLGs List of strings corresponding to the SRLG values of the ASON Data Link
connected to the port.

Data Link Exclude Indicates whether data link is enabled/disabled.

Ribbon Communications Inc. Proprietary 109

 NE Management

WSON port parameters

Parameter Description

Network Interface Type Network interface type. Possible values: NNI, UNI, None.
Only NNI ports can be the endpoints of WSON data link. All other WSON
fields only contain meaningful data when the network interface type is NNI.

Remote NE ID NE ID of the remote NE.

Data Link EndPoint If the port is a TE-Link endpoint (i.e. the TE-Link exists in the NE) and there
is no mismatch between peer IDs on both ends of the TE-Link, the value
should be Yes. In all other instances, the value should be No.

Remote Port ID Port ID for the WSON port on the remote NE.

SRLGs List of strings corresponding to the SRLG values of the WSON Data Link
connected to the port

Data Link OSNR OSNR WSON data link.

Data Link Cost Value of cost metric.

Associated OSC ID(s) List of up to two OSC ports associated with the OTS port.

Data Link Operational Operational state value of the TE-Link entity with an endpoint on this port
State (Up, Down, Init, or Degraded).

View the ASON-WSON Trails List

If there is at least one ASON/WSON trail with a head-end residing in the Control Plane of the NE, the ASON
Trails or WSON Trails folder appears in the Network Explorer tab, below the cards. ASON/WSON trails are
created and managed in LightSOFT. From the STMS, you can only view the trails and their parameters
(which are read-only).
Start
• In the Network Explorer tab, click the ASON Trails or WSON Trails folder for the relevant NE.
The ASON/WSON Trails list appears in the right pane, showing the ASON/WSON trails and their
parameters.
See the table below for the parameter descriptions.

Ribbon Communications Inc. Proprietary 110

 NE Management

NE ASON/WSON trail parameters

Parameter Description

Trail Name Name of the ASON/WSON trail

Alarm Status Indicates the number of critical, major, and minor alarms on the trail

Trail ID ID of the ASON/WSON trail

NMS Trail ID ID of the NMS trail associated with the ASON/WSON trail, as defined in
LightSOFT

Trail Rate (ASON only) Rate of SNC of the trail (ODUk)

Bandwidth (WSON only) Bandwidth of the trail (10G, 40G, 100G), based on the XC rate

Wavelength (WSON only) Frequency in which the trail is created

Alarm Severity Profile Alarm severity profile of the trail

Ribbon Communications Inc. Proprietary 111

 NE Management

View the GMPLS Control Channels List

You can view the GMPLS Control Channels list.
Start
• In the Network Explorer tab, click the GMPLS Control Channels folder below the relevant NE.

Note
The GMPLS Control Channels folder only appears if the GMPLS Mode attribute is set to
ASON or WSON.

The GMPLS Control Channels list appears in the right pane. See the table below for the parameter
descriptions.

GMPLS Control Channel parameters

Parameter Description

Remote CP IP Address IP Address of the remote CP Routing Instance. Specifies the other end
of ASON/WSON data Link.

Operational State ASON or WSON data link state.

Alarm Status Indicates the number of critical, major, and minor alarms on the control
channel.

Alarm Master Mask Indicates whether the alarm master mask is enabled/disabled. It is
disabled by default.
Note: To enable the alarm master mask, you must create a custom
severity profile for the protection group, and set the reporting to False for
the alarms that you do not want to view.

Alarm Severity Profile Alarm severity profile of the control channel.

Ribbon Communications Inc. Proprietary 112

 NE Management

View XC Resource Ownership

XC resources are owned by the Control Plane (CP), or by the Data Management Plane (Mgmt) except in the
following circumstances, where they are co-owned:
• When LightSOFT migrates a trail from non-ASON to ASON, or from ASON to non-ASON. During
migration the resources are co-owned. However, when the migration process is complete, the
resources remain with a single owner (Control Plane or Management, as applicable).
• When LightSOFT migrates a trail from non-WSON to WSON, or from WSON to non-WSON. During
migration the resources are co-owned. However, when the migration process is complete, the
resources remain with a single owner (Control Plane or Management, as applicable).
• When STMS must release a resource that is owned by the Control Plane, and there is no other way to
release the resource (e.g., the Control Plane controller is not reachable), the STMS 'takes over' the
resource by adding the Management as a resource owner, and then removing the Control Plan as co-
owner. The resource can then be modified or deleted.
You can view XC resource ownership details.
Start
1. Right click the NE icon in the Network Explorer tab and select Show XCs.
The XC Manager window opens, showing the XCs defined for the NE.

2. In the Results area, the XC Owners field shows the owner per resource. Values are either:
◦ Mgmt: XCs owned by the Data Plane only
◦ CP: XCs owned by the Control Plane only
◦ Mgmt & CP: XCs owned by both the Management and Control Planes

Define Auto-Discovered ASON Data Links

You can define ASON data links that can be auto-discovered in LightSOFT.
Start
1. Create bidirectional, external fiber connectivity for the relevant OTU ports (see Define Fiber
Connectivity).

Ribbon Communications Inc. Proprietary 113

 NE Management

2. In the Properties > GMPLS Parameters tab of each OTU port, select NNI for the Network Interface
Type, and click Apply.
NNI configuration is enabled for the OTU ports.
3. In the Properties > GMPLS Parameters tab of each OTU port, select Enable for the Auto Discovery
field.

Auto-discovery is enabled. The Received Remote NE ID and Received Remote Port ID appear.
These attributes are sent to LightSOFT. If successful, the auto-discovered data link can be created
from LightSOFT (see the LightSOFT User Guide).

Note
Auto-discovery must be enabled in LightSOFT. See the LightSOFT User Guide.

Define RSVP Authentication

This feature provides basic messaging integrity and authentication to RSVP messages. This is an optional
feature, that may be enabled on the RSVP capable interfaces of a given router or host. Once enabled, it
requires that all the incoming RSVP messages contain an integrity object. Similarly, all RSVP messages sent
by such interface must contain the integrity object.
Each integrity object contains a checksum that helps the receiver gain confidence that the corresponding
message was sent by a genuine sender and was also not tampered with or spoofed in between. The basis
for this confidence is a shared, secret key between a sender and receiver that is used to generate a
cryptographically strong hash. There can be multiple shared keys between a sender and a receiver. The
sender selects only a single key from this set while generating the hash. It also encodes a 'key-index' in the
integrity object (but not the key itself). The receiver looks at the key-index and locates the corresponding
shared key. Using this shared key, the receiver can verify the hash sent through the integrity object.
RSVP Authentication is supported on GMPLS Routing-Instance in the Apollo Platform.
It is important to remember the secret keys must be configured for both the sender and the neighbor.
See also:
• View RSVP Statistics

Note
The procedure described below must be performed reciprocally on both the sender and neighbor NEs.

Start

Ribbon Communications Inc. Proprietary 114

 NE Management

1. In the Network Explorer tab, right-click the NE and select Properties.

The NE properties appear.
2. Select the CP Attrs tab.
The Configuration tab appears.
3. In the CP Attrs area, confirm that the Gmpls mode is set to either ASON or WSON.

4. In the Rsvp Instance area, set Authentication to Enable to enable you to enter RSVP local and
neighbor authentication keys.

5. In the Rsvp Authentication area, click Local Keys to define the local authentication keys.
The Authentication Keys window appears.

Ribbon Communications Inc. Proprietary 115

 NE Management

6. Click Add to add a new local authentication key.

See the table below for a description of the fields.
7. Click Save to save the local authentication key.
8. Repeats steps 6 and 7 if you want to add additional local authentication keys.
9. After entering the local authentication keys, click on Local Keys to view the local keys you have
added. Notice that the value in the KeyValue column is now the calculated KeyValue using the
selected CryptoAlgorithm.

You can, if required, edit the KeyValue or the CryptoAlgorithm or delete any local authentication keys
no longer required.

Note
If you edit the KeyValue or the CryptoAlgorithm at this point, you must make sure that the
corresponding edit is made in the neighbor authentication key on the neighbor NE, and vice
versa.

10. After creating the local authentication keys, click Apply to apply the settings to the selected NE.

Ribbon Communications Inc. Proprietary 116

 NE Management

11. Click Neighbor Keys to define the authentication keys for the neighbor.
The Authentication Keys window appears.

12. In the Neighbor ID field, enter the neighbor's IP address.

Note
The neighbor authentication key that you enter in the next step must be an existing
authentication key for the neighbor whose IP address you entered in the Neighbor ID field. If
there are no authentication keys for that neighbor, you must first enter the authentication key
on the neighbor NE as described in steps 5 to 10, above, before you can proceed further.

13. Click Add to add a new neighbor authentication key.

Note
The neighbor authentication key that you enter here must be identical to the local
authentication key you created for the neighbor. To avoid mistakes, it is strongly recommended
that you copy the this key from the neighbor and paste it here.

See the table below for a description of the fields.

14. Click Save to save the neighbor authentication key.

Ribbon Communications Inc. Proprietary 117

 NE Management

15. Repeats steps 13 and 14 if you want to add additional neighbor authentication keys.
16. After entering the neighbor authentication keys, click on Neighbor Keys to view the neighbor keys
you have created. Notice that the value in the KeyValue column is now the calculated KeyValue using
the selected CryptoAlgorithm.

You can, if required, edit the KeyValue or the CryptoAlgorithm or delete any neighbor authentication
keys no longer required.

Note
If you edit the KeyValue or the CryptoAlgorithm at this point, you must make sure that the
corresponding edit is made in the local authentication key on the neighbor NE, and vice versa.

17. In the Primary Auth Key field, enter the primary authentication key ID you want to use if you have
more than one authentication key. If no value is entered in this field, the highest value key ID is used,
by default, when the RSVP package is sent.
18. In the Rsvp Instance area, configure the respective values as required.
19. Click Apply to apply your settings to the NE.

Authentication Keys fields

Field Description

KeyID Unique numeric value. The minimum value is 1 and the maximum
value is 232-1 (999,999,999).

KeyValue Random string of characters. The minimum length is based on the

selected CryptoAlgorithm. For HMAC-MD5, the length is up to 16
bytes, and for HMAC-SHA256, the length is up to 256 bytes.

CryptoAlgorithm Choose between HMAC-MD5 and HMAC-SHA256. The default is

HMAC-MD5.

View RSVP Statistics

The Rsvp Statistics tab enables you to verify the number of RSVP packets that have been delivered
successfully. This tab also enables you to see the number RSVP packets not successfully delivered and the
reasons for their non-delivery.
Start
1. In the Network Explorer tab, right-click the NE and select Properties.
The NE properties appear.
2. Select the CP Attrs tab.
The Configuration tab appears.

Ribbon Communications Inc. Proprietary 118

 NE Management

3. Click the Rsvp Statistics tab.

From this tab you can readily see the statistics for all the RSVP messages sent.
In addition to the statistics Per Instance, you can also view statistics:
◦ Per Key: Shows the statistics for the key ID selected from the Key Id dropdown list.

◦ Per Neighbor Key: Shows the statistics for the neighbor whose IP address is selected from the
Neighbor Key dropdown list and for the key ID selected from Key Id dropdown list.

Ribbon Communications Inc. Proprietary 119

 NE Management

◦ Per Neighbor: Shows the statistics for the neighbor whose IP address is selected from the
Neighbor Key dropdown list.

4. Click Clear to reset the counters to zero.

Synchronize the Standby RCP Configuration

In a dual RCP system, you can manually synchronize the configuration file on the active RCP with the
configuration files on the standby RCP.

Note
If you enable automatic RCP switchover, you can also enable automatic configuration synchronization
(automatically synchronizing the configuration files on the active and standby RCPs). See Configuring
RCP Redundancy.

Start
1. In the Network Explorer tab, right-click the NE for which you want to synchronize the configuration
files and select Actions >Synchronize Standby RCP Configuration.
The Synchronize Configuration window opens.
2. Click Yes.

Define Utilization Thresholds

You can define several utilization thresholds for an NE. If the NE exceeds the percentage specified by a
threshold, an alarm is generated.
Start
1. In the Network Explorer tab, right-click the NE for which you want to change the control protocols
service profile, and then select Properties. The property sheet for the NE opens.
2. In the Properties tab, in the corresponding fields, type valid values for the utilization thresholds.
The following table describes each of the utilization thresholds.

Ribbon Communications Inc. Proprietary 120

 NE Management

Utilization thresholds

Threshold Description

CPU Percentage of CPU resources that can be used before a CPU

utilization alarm is generated, range from 1 to 100 percent
(default 90).

Memory Percentage of memory resources that can be used before a

memory utilization alarm is generate, range from 1 to 100 percent
(default 90).

File system Percentage of file system resources that can be used before a file
system utilization alarm is generated, range from 1 to 100 percent
(default 90).

3. Click Apply.

Configure a Subtending Shelf

You can configure a subtending shelf.

Note
Adding a subtending shelf is not traffic-affecting.

Start
1. In the Network Explorer tab, right-click the NE on which you want to add a subtending shelf, and
select Assign Shelf.
The Assign Shelf window opens.

Ribbon Communications Inc. Proprietary 121

 NE Management

2. Select the subtending shelf ID, Artemis shelf type, and the shelf mode.
3. (Optional) In the Description field, enter a description of the shelf.
4. In the Rack Number field, enter a rack number.
5. In the Position in Rack field, enter the position in the rack.
6. Click Finish to save.

Note
All XCs and associated trails must be deleted prior to the deletion of a subtending shelf.

Note
Removing a subtending shelf does not cause a service interruption to other shelves within the
same multi-shelf NE.

View the Maintenance List

You can view a list of the maintenance operations currently running on network objects (NEs, cards, ports).
The Maintenance List is only available for objects currently undergoing maintenance operations.

These objects appear with the maintenance icon in the Network Explorer pane.
Start
• Right-click on the object and select:
◦ NE Maintenance List - for an NE
◦ Maintenance List - for a card or port

Ribbon Communications Inc. Proprietary 122

 NE Management

Note
From Chassis view, you can select NE Maintenance List from the Maintenance menu.
This option is only available for NEs undergoing maintenance operations.

The Maintenance List window opens.

Change the NE Password

You can change the password for a network entity directly from the STMS. The password must be at least
eight (8) characters long, and contain one uppercase letter, one lowercase letter, one digit, and one special
character. The password must also be different from the last ten (10) passwords defined for this network
element.
Start
1. From the Security menu, select Change NE Password.

Ribbon Communications Inc. Proprietary 123

 NE Management

2. In the Change NE Password dialog box, enter the network element username, then enter and confirm
the network element password.

3. From the Select NEs list, select the checkbox(es) for the network elements to which the new
password should be applied.
4. Click Apply.

Ribbon Communications Inc. Proprietary 124

 Cards and Modules

Cards and Modules

The STMS enables you to manage the configuration of the following Apollo cards and modules:
• OPT99xx Cards and Modules
• OPT9904X Cards and Modules
• OPT9901X Cards and Modules
• OPT96xx Cards and Modules
• OPT96xx Fabric Interface Cards
• OPT96xx Layer 2 Cards
• Optical Components
• Pluggable Transceiver Modules
• Assign Cards
• Replace Cards
• Unassign a Card
• View the Card Description
• View Card Properties
• View Card Performance Statistics
• xRCP-RCP Card Operations

OPT99xx Cards and Modules

OPT99xx supports the following service cards:
• HIO10_20
• HIO10_40
• HIO100_2
• TIOMR_32
• HIO500
• HIO400A
• OPT99xx Common Cards and Modules (OPT99xx)
Additional cards and modules provide common functionality for OPT99xx. See OPT99xx Common Cards
and Modules.
For detailed descriptions of the supported OPT99xx cards and modules, see the Apollo Reference Manual.

HIO10_20
The HIO10_20 is a 10G multi-service interface card for the OPT9932 and OPT9914 platforms that supports
up to 20 client interfaces, SFP+ based transceivers. Each port can be configured to OTU2, OTU2e, STM-64,
OC-192, FC1200, FC800, 40GbE, or 10GbE. Client-side signals are mapped to G.709 ODU-k and cross
connected through the central universal fabric to the egress side. Two additional client interfaces can be
configured to 40 GbE. These are QSFP+ based ports and the configuration of such interface is at the
expense of four SFP+ ports. The card supports 10-BASE-T SFP+ electrical pluggable transceivers.
The HIO10_20 provides a multi-service, cost-effective solution to customers for grooming 10G services over
OTN DWDM networks.
For more information about the HIO10_20 card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 125

 Cards and Modules

HIO10_20 card - port configuration rules

Number of Ports Port Number Port Role Port Type Sub-IF Type

22 0,1 Client/Line ETY40G ODU3

2-21 Client/Line • STM64 • ODU2

• OC192 • ODU2
• FC800 • ODUflex-FC800
• FC1200 • ODU2e
• ETY10GOC • ODU2e
• OTU2 • ODU2 (PT21)
• OTU2e • ODU2e
• GE10 • N/A
• GE10-OTU2e • N/A
• ET10GOCE • ODU2e

Important
The following exceptions apply when configuring HIO10_20 ports:
• If any port between 2-5 is configured, port 0 must be disabled.
• If port 0 is configured, ports 2-5 must be disabled.
• If any port between 6-9 is configured, port 1 must be disabled.
• If port 1 is configured, ports 6-9 must be disabled.
• GE10-OTU2e ports can only be configured as ports 12-21.

Note
To define the port configuration for an HIO10_20 card, see Configure Ports.

HIO10_40
The HIO_40 is a high-density single slot QSFP-based card with full hybrid capability. The HIO_40 has a
capacity of up to 400G, and supports a mixture of L1/L2 interfaces with a configurable mixture of rates, both
client (OTU4, OTU2e, OTU2, 40GbE, STM-64) and line (OTU4 with ODUflex NNI uplinks).
The OTR100Q28_ZR4DR transceiver is supported in the HIO10_40 OTU4 ports. RS-FEC is implicitly
configured with no option to disable it.
For more information about the HIO10_40 card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 126

 Cards and Modules

HIO10_40 card - port configuration rules

Number of Ports Port Port Role Port Type Sub-IF Type

Number

40 0, 4, 8, 12 Client/Line • OTU4 • ODU4 (PT21)

• ETY100G • ODU4
• GE100 • N/A
• GE100-OTU4 • N/A
• ETY40G • ODU3
• ETY10GOC • ODU2e
• GE10 • N/A
• GE10-OTU2e • N/A
• OTU2 • ODU2
• OTU2e • ODU2e

1, 2, 3, 5, 6, Client/Line • ETY10GOC • ODU2e

9, 10, 11, 13, • GE10 • N/A
14, 15, • GE10-OTU2e • N/A
• OTU2 • ODU2
• OTU2e • ODU2e

16, 20, 28, Client/Line • ETY40G • ODU3

32 • STM64 • ODU2
• OC192 • ODU2
• ETY10GOC • ODU2e
• GE10 • N/A
• GE10_OTU2e • N/A
• OTU2 • ODU2
• OTU2e • ODU2e

17-19, Client/Line • STM64 • ODU2

21-27, • OC192 • ODU2
29-31, 33-39 • ETY10GOC • ODU2e
• GE10 • N/A
• GE10_OTU2e • N/A
• OTU2 • ODU2
• OTU2e • ODU2e

HIO10_40 ports are divided into 4 port groups, where each group supports an accumulative bandwidth of
100GB:
• Group A: Ports 8, 9, 10, 11, 16, 17, 18, 19, 24, 25
• Group B: Ports 12, 13, 14, 15, 20, 21, 22, 23, 26, 27
• Group C: Ports 0, 1, 2, 3, 28, 29, 30, 31, 36, 37
• Group D: Ports 4, 5, 6, 7, 32, 33, 34, 35, 38, 39
When configuring HIO10_40 ports via the Port Configuration window, the relevant group is indicated in the
Group column for each port.

Ribbon Communications Inc. Proprietary 127

 Cards and Modules

Note
To define the port configuration for an HIO10_40 card, see Configure Ports.

HIO100_2
HIO100_2 provides an OTU4 uplink for the OPT9932 and OPT 9914 platforms. HIO100_2 also supports up
to two 100G ports in a single slot card with CFP pluggable optics. The client-side signals are mapped to
G.709 ODU-k and cross connected through the central universal fabric to the egress side.
The HIO100_2 provides a multi-service, cost-effective solution to customers for Metro, Regional, and Long
haul applications over OTN DWDM networks.
For more information about the HIO100_2 card, see the Apollo Reference Manual.

HIO100_2 - Port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

40 0-39 Client/Line • ETY100G • ODU4

• OTU4 • ODU4 (PT21)
• GE100 • N/A
• GE-100- • N/A
OTU4

An LO sub-interface can be created under HO ODU4 of OTU4, and supports PT21: ODUF-GFP. It has mode
= L1 or L2.
ODUF-GFP L2 is created together with its associated VPP. If this VPP is the master, the LAG is also created
at the same time. If the VPP is the slave, it will be associated to an existing LAG.

Note:
To define the port configuration for a HIO100_2 card, see Configure Ports.

TIOMR_32
The TIOMR_32 is a multi-rate interface card for the OPT99xx platforms that supports up to 32 low-rate client
interfaces using SFP transceivers. Each port can be configured to STM-1, STM-4, STM-16, FC100/FC200/
FC400, or GbE. Client-side signals are mapped to G.709 ODU-k and cross connected through the central
universal fabric to the egress side.
The TIOMR_32 provides a multi-service, cost-effective solution to customers for grooming low-rate (< 10G)
services over OTN DWDM networks.
For more information about the TIOMR_32 card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 128

 Cards and Modules

TIOMR_32 - Port configuration rules

Number of Port Label Port Number Port Port Type Sub-IF Type
Ports Role

32 0-31 0-31 Client • ETY1G • ODU0

• ETY1Ge • ODU1
• FC100 • ODUflex-FC400
• FC200
• FC400
• OC3
• OC3e
• OC12
• OC48
• STM1
• STM1e
• STM4
• STM16

Important
The following exceptions apply when configuring TIOMR_32 ports:
• FC400 can only be configured for even ports (0, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26,
28, and 30).
• The port following an FC400 port is not configurable. For example, if FC400 is configured for
port 2, you can't configure port 3.
• If an odd port is already configured, you can't configure FC400 for the port preceding it. For
example, if ETY1G is configured for port 7, you can't configure FC400 for port 6.

Note
To define the port configuration for a TIOMR_32 card, see Configure Ports.

HIO500
The HIO500 is a single slot hybrid (OTN/packet) I/O card with ODUflex NNI uplink and G.HAO support for
the OPT9932 and OPT9914 platforms, providing 500G/400G capacity, depending on the platform
configuration. This is a configurable-rate card based on coherent transmission with adaptive modulation,
15% SD-FEC, NCG 11-12dB, supporting a mixture of Layer1/Layer2 client/line interfaces with a rate mixture
of 200G/100G/10G.
The HIO500 enables full utilization of the OPT99xx slot capacity of 400/500 Gbps. From a management
perspective the card can be configured in two operation modes:
• HIO400: With a capacity of 400 Gbps
• HIO500: With a capacity of 500 Gbps (OPT9932)
The HIO500 is optimized for client/line low rate/high rate solutions that provide up to 2 x 200G lines for short-
medium ranges, or up to 5 x 100G lines for high ranges, or 5 x 100G/50 x 10G clients.
The HIO500/HIO400 works with D-CFP2 coherent line transceivers, supporting configurable QPSK, 8QAM,
or 16QAM modulation, with Flex-Grid capabilities. This transceiver includes a coherent receiver, DSP
processing, and soft decision forward error correction, for superior noise tolerance, as well as an exceptional
ability to mitigate CD and PMD impairments.

Ribbon Communications Inc. Proprietary 129

 Cards and Modules

When client ports are configured for 100G/OTU4, SR10 and LR4 transceivers are supported, as well as
ER4DR (40Km) and ZR4DR (80Km) for OTU4 grey output. The supported FEC mode for ZR4DR is RS-FEC.
HIO500EN/HIO400EN
The HIO500/HIO400 card is also available with a software encryption option. HIO400 and HIO500 support
Flexo-1 and Flexo-2 rates. When configured as an HIO500EN or HIO400EN, encryption is supported for
OTU4 and OTUC2 rates on the line ports. Authentication is via private/public keys, with the key period
configured per NE.
You can configure SC-FEC for an OTU4 port in the HIO500 family of cards that have the OTR200P2_CFO,
OTR200P2_CF, OTR200P2_CFE, OTR100P2_CF, OTR400P2_CFA2BD transceiver types. There are two
available options when selecting the DP_DQPSK Line Code for the FEC type; SD-FEC and SC-FEC, where
SD-FEC is the default.
The HIO500EN/HIO400EN also supports an OTR400P2_CF26 transceiver in OTUC2 port type.
The HIO500 supports up to 41 ports (Port 0 to Port 40). The card can house up to four CFP2 transceivers.
Each transceiver may represent 10 potential ports (for supporting 10G fan-out mode). The four CFP2 ports
are divided into four groups.
If the first port in a group is configured to 100G/200G, all other ports in the group are disabled.
For more information about the HIO500 card, see the Apollo Reference Manual.

HIO400 - Port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

41 1,21 1,21 Client/Line • OTU4 • ODU4

• ETY100 • ODU4
G • N/A
• GE100 • N/A
• GE100- • ODU2e
OTU4 • N/A
• ETY10G • ODUC1
oc
• GE10
• FlexO-1

11,31 11,31 Client/Line • OTUC2 • ODUC2

• OTU4 • ODU4
• ETY100 • ODU4
G • N/A
• GE100 • N/A
• GE100- • ODU2e
OTU4 • N/A
• ETY10G • ODUC2
oc
• GE10
• FlexO-2

2-10, 12-20, 2-10, 12-20, Client/Line • ETY10G • ODU2e

22-30, 32-40 22-30, 32-40 oc • N/A
• GE10

Ribbon Communications Inc. Proprietary 130

 Cards and Modules

Notes
• Port 0 is currently disabled.
• The following port types have rates of 100G: OTU4, ETY100G, GE100, and GE100-OTU4.
• The OTUC2 port type has a rate of 200G (only supported in ports 11 & 31).

Note
To define the port configuration for an HIO500 card, see Configure Ports.

HIO400A
The HIO400A is a 400G Line card for the OPT9914 and OPT9932 shelves with new Coherent High Baud
Rate 400G CFP2 OpenROADM using the transceivers OTR400P2_CFA1, OTR400P2_CFA2BD,
OTR400P2_CFA2T, OTR400P2_CFO, OTR200P2_CFA2.
Sub-If types ODUC1, ODUC2, ODUC3, ODUC4.
The HIO400A has two ports supporting any combination of 200G, 300G and 400G up to 400G.
Port 1 supports FlexO-2, FlexO-3 and FlexO-4. and port 0 supports FlexO-2. The card cannot support ports
configured for more than 400G. Therefore if port 0 is configured for FlexO-2, port 1 can only be configured
for FlexO-2. You can only configure the card for 300G or 400G, on port 1, leaving port 0 is disabled.
GCC 0 is supported on all the port-types.
The HIO400A only enables interop with the MIO700 card using transceiver OTR400P2_CFA1.
For more information about the HIO400A card, see the Apollo Reference Manual.

HIO400A - Port configuration rules

Number of Ports Port Label Port Number Port Role Port Type

2 0 0 Line • FlexO-2

1 1 Line • FlexO-2
• FlexO-3
• FlexO-4

OPT99xx Common Cards and Modules (OPT99xx)

The following cards and modules provide common functionality for OPT99xx:
• xRCP: the central control component in the OPT99xx platforms, providing the main system processor
responsible for essential system management, timing, and control. The card supports timing
functionality for a wide range of synchronization standards by the Central Timing Module (xCTM)
residing on it. In addition, xRCP/xRCP1 cards include a Fabric Element (FE) used as part of the
OPT99xx system fabric.
• xFM: part of the universal fabric in OPT99xx platforms together with FEs residing on the xRCP cards.
• xMIM: the connection unit between the OPT99xx family and external management.
• xTAM: the timing and alarms connection unit between the OPT99xx platforms and the external world.
It provides interfaces for timing and alarms.
• xPFM: serves as an input power filter for the DC voltage connected to the OPT99xx.

Ribbon Communications Inc. Proprietary 131

 Cards and Modules

• xFCM: has two types of fan trays that provide cooling air to the platform: xFCMV and xFCMH. The
two types have identical electronic design and cooling and control functionality, and differ only in
physical structure and number of fan units.
For more information about the OPT99xx common cards and modules, see the Apollo Reference Manual.

OPT9904X Cards and Modules

OPT9904X supports the following cards:
• AoC10B and AoC10C
• MIO200 and MIO200EN
• MIO200B and MIO200BEN
• MIO700
• OPT99xx Common Cards and Modules (OPT9904x)
• Supported Passive and Photonic Cards
For detailed descriptions of the supported OPT9904x cards and modules, see the Apollo Reference Manual.

AoC10B and AoC10C

The AoC10B/AoC10C card provides 10 Gbps ADM service on a card. It supports up to 16 client interfaces,
which are multiplexed into the G.709 multiplexing structure and sent via two OTU2 line interfaces.
Any of the client interfaces can be configured to accept an STM-1, STM-4, GbE, FC/FC2/FC4, OTU-1,
STM-16, DVB-ASI, SDI, or HD-SDI signal. The card has integrated cross-connect capabilities, providing
more efficient utilization of the lambda. Any of the signals can be added or dropped at each site, while the
rest of the traffic continues on to the next site. Broadcast TV services can be dropped and continued
(duplicated), eliminating the need for external equipment to provide this functionality.
For more information about the AoC10B or AoC10C card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 132

 Cards and Modules

AoC10B/AoC10C Card - Port Configuration Rules

Card Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

AoC10B 16 C0 - C15 0,...,15 Client • STM1/ • ODU0

OC3 • ODU0
• STM1e/ • ODU0
OC3e • ODU0
• STM4/ • ODU0
OC12 • ODU0
• FC100 • ODUslot
• ETY1G • ODU1
• ETY1Ge • ODU1
• VIDEO2 • ODU1
70 • ODU1
• STM16/ • 2*ODU1
OC48
• FC200
• HDSDI1
485
• OTU1
• FC400

2 L1, L2 16, 17 Line OTU2 ODU2(PT21

)

AoC10C 16 C0 - C15 0,...,15 Client • STM1/ • ODU0

OC3 • ODU0
• STM1e/ • ODU0
OC3e • ODU0
• STM4/ • ODU0
OC12 • ODU0
• FC100 • ODUslot
• ETY1G • ODU1
• ETY1Ge • ODU1
• VIDEO2 • ODU1
70 • ODU1
• STM16/ • 2*ODU1
OC48
• FC200
• HDSDI1
485
• OTU1
• FC400

2 L1, L2 16, 17 Line OTU2 ODU2(PT21

)

Note
To define the port configuration for an AoC10B/AoC10C card, see Configure Ports.

Ribbon Communications Inc. Proprietary 133

 Cards and Modules

MIO200 and MIO200EN

MIO200 is a multipurpose ODU-XC base card with 100G CFP based uplink interface and up to 12 x SFP/
SFP+ based client ports. The card also supports packet switching over OTN and 200G bandwidth.
The card throughput is 200 Gbps, and four cards together comprise a 800G mesh cross-connect, without the
need for a central matrix. MIO200 is a multi-rate IO card and supports 100G, 10G, and 1G clients. MIO200
client ports support dual rate GE/10GE clients for both SM10km and MM. Transceiver OTP10DR_L supports
both 10GE LR and GE LX and transceiver OTP10DR_S supports10GE SR and GE SX. The card supports
10-BASE-T SFP+ electrical pluggable transceivers. Port type ETY1G is not available for 10-BASE-T SFP+
electrical pluggable transceivers.
The OPT9904X equipped with MIO200 cards provides a multi-service, low cost, minimal size sub 1T ODU-
XC solution to customers for grooming 10G and sub 10G services over the OTN DWDM networks.
The MIO200 card is also available with an encryption option. When configured as an MIO200EN, encryption
is supported for OTU4 rates on the line ports. Authentication is via private/public keys, with the key period
configured per NE.
You can configure SC-FEC for an OTU4 port in the MIO200 family of cards that have an OTR100PT_CF
transceiver. There are two available options when selecting the DP_DQPSK Line Code for the FEC type;
SD-FEC and SC-FEC, where SD-FEC is the default.
For more information about the MIO200 card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 134

 Cards and Modules

MIO200 - Port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

1 0 0 Client/Line ETY100G ODU4

OTU4 ODU4 (P21)

12 P1-P12 1,...,12 Client/Line • ETY1G • ODU0

• ETY1Ge • ODU0
• ETY10GOC • ODU2e
• FC100 • ODU0
• FC200 • ODU1
• FC400 • ODUF-FC400
• FC800 • ODUF-FC800
• FC1200 • ODU2e
• FC1600 • ODUF-FC1600
• OC3 • ODU0
• OC3e • ODU0
• OC12 • ODU0
• OC48 • ODU1
• OC192 • ODU2
• M-OTDR • N/A
• OTU2 • ODU2
• OTU2e • ODU2
• STM1 • ODU0
• STM1e • ODU0
• STM4 • ODU0
• STM16 • ODU1
• STM64 • ODU2
• ET10GOCE • ODU2e

Note
To define the port configuration for an MIO200 card, see Configure Ports.

MIO200B and MIO200BEN

The OPT9904X platform does not need a separate switching fabric; switching is integrated into the
backplane through MIO200/MIO200B cards, enabling smooth capacity expansion in 200G increments. High-
speed full mesh connectivity between four MIO200/B cards is supported, enabling an 800G mesh cross-
connect, without the need for a central matrix, with 4x100G uplink and 40x10G clients.
The MIO200B/MIO200BEN cards are slightly different in appearance from the MIO200/MIO200EN cards.
The difference is the physical line port. In MIO200/MIO200EN the line port (port 0) form factor is CFP, while
in MIO200B/MIO200BEN the line port form factor is QSFP-DD.
The MIO200B card is also available with an encryption option. When configured as an MIO200BEN,
encryption is supported for OTU4 rates on the line ports. Authentication is via private/public keys, with the
key period configured per NE.
For more information about the MIO200B and MIO200BEN cards, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 135

 Cards and Modules

MIO200B - Line port requirements

Port Transceiver FEC Remarks

Type

OTU OTR100Q28_FR1DR, OTR100Q28_LR1DR, FEC Single lambda MSA OTU4 grey

4 OTR100Q28_ER1DR

OTU OTR100Q28_SR4DR, OTR100Q28_LR4DR, FEC Legacy grey transceivers

4 OTR100Q28_ER4FDR, OTR100Q28_ZR4DR

Flex OTR100Q28DD_ZTL oFE Coherent GL2 transceiver in use

O-1 C in OPT9901x line

OTU OTR100Q28DD_ZTL default SC- Coherent GL2 transceiver in use

4 FEC in OPT9901x line

Ribbon Communications Inc. Proprietary 136

 Cards and Modules

MIO200B - Port assignments

Port Type Selectable on Ports

ETY1G 5-12

ETY1Ge 5-12

ETY10GOC 1-10

FC100 5-12

FC200 5-12

FC400 5-12

FC800 1-10

FC1200 1-10

FC1600 1-4

OC3 5-12

OC12 5-12

OC48 5-12

OC192 1-10

OSC1G 12

M-OTDR 1-12

OTU2 1-10

OTU2e 1-10

STM1 5-12

STM4 5-12

STM16 5-12

STM64 1-10

Ribbon Communications Inc. Proprietary 137

 Cards and Modules

Note
To define the port configuration for an MIO200B card, see Configure Ports.

MIO700
The MIO700 is a multi-IO line card for the OPT9904x cage. The entire card throughput to the matrix is
700Gbps, and the four cards together comprise a 2800G mesh cross connect, without the need for a central
matrix. The card supports 200G, 100G and 10G clients, so the MIO700 is a multi-rate IO card.
The MIO700 card MUST occupy a double length slot in chassis view. This means that the card can be
installed only in part of the IO slots, similar to other cards occupying double length slots.
At present only 660Gps is supported for both TDM and DATA in despite of the back plane revision.
The OTR100Q28_ZR4DR transceiver is supported in the MIO700 OTU4 ports. RS-FEC is implicitly
configured with no option to disable it.
Using the OTR400p2-CFA1 (from Acacia) transceiver the MIO700 line ports can the configured as FlexO
ports subject to the following:
• Port 0 and Port 1 Line ports can be configured according to the following table:

Line Configuration Parameters

Port Type Line Code FEC type Default Ports Transceiver

(Modulation) Support

FlexO-1 DP-QPSK oFEC (default) 0, 1 Acacia OTR400

P2_CFA1

FlexO-2 DP-QPSK oFEC Default 0, 1 Acacia OTR400

P2_CFA1

FlexO-2 DP-8QAM oFEC 0, 1 Acacia OTR400

P2_CFA1

FlexO-2 DP-16QAM oFEC 0, 1 Acacia OTR400

P2_CFA1

FlexO-3 DP-8QAM oFEC Default 0 Acacia OTR400

P2_CFA1

FlexO-4 DP-16QAM oFEC Default 0 Acacia OTR400

P2_CFA1

• The maximum bandwidth for the two ports together is 400G. The valid configuration is therefore two
FlexO-2 ports, or one FlexO-3 or FlexO-4 port. When Port 1 is configured to FlexO-3 or FlexO-4 the
configuration of Port 0 is rejected. When Port 0 is configured, Port 1 can only be configured to
FlexO-2.
You cannot assign an MIO700 card if there is an assigned MIO200 in the shelf. Similarly, you cannot assign
an MIO200 car if there is an assigned MIO700 in the shelf.
For more information about the MIO700 card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 138

 Cards and Modules

MIO700 - Port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

1 0 0 Line • OTUC2 • ODUC2

• OTU4 • ODU4
• FlexO-1
• FlexO-2
• FlexO-3
• FlexO-4

1 1 Line • OTUC2 • ODUC2

• OTU4 • ODU4
• FlexO-1
• FlexO-2

24 P2-P25 2,…,23 Client • OTU4 • ODU4

• ETY100G • ODU4
• 100GE_O • OTU4
TU4 • N/A
• GE100 • ODU2e
• ETY10GO • N/a
C • ODU3
• GE10 • ODU2
• ETY40G • ODU2
• STM64 • ODU2e
• OC192 • ODU2
• 10GE_OT • ODU2
U2e
• OTU2
• OTU2e

• For Port 0 and Port 1, The OTUC2 port also supports the OTR400P2_CF26 transceiver and the
OTR400P2_CFA2BD transceiver. MIO700 supports OTR400P2_CFA2, and OTR400P2_CFO. Sub-If
types ODUC1, ODUC2, ODUC3, ODUC4.
• Port 0 also supports the OTUC4 port type, along with the OTR400P2_CF26 transceiver. You can
however, only configure GCC0 on this port.

OTUC4 Port configuration parameters

Port# Port Type Transceiver Line Code FEC Type

Type

0 OTUC4 OTR4002P_CF26 DP-16QAM HG-SD-FEC

MIO700 ports are divided into the following slice groups:

• Group 0: Ports 6, 7, 8, 9, 14, 15, 16, 17, 22, 23
• Group 1: Ports 10, 11, 12, 13, 18, 19, 20, 21, 24, 25

Ribbon Communications Inc. Proprietary 139

 Cards and Modules

Note
To define the port configuration for an MIO700 card, see Configure Ports.

OPT99xx Common Cards and Modules (OPT9904x)

The following cards and modules provide common functionality for OPT9904x:
• RCP04x: The central control component in the OPT9904X platform, providing the main system
processor responsible for essential system management, timing, and control. The card supports
timing functionality for a wide range of synchronization standards by the Central Timing Module
(xCTM) residing on it.
• PFM04x: An input power filter for the DC voltage connected to the OPT9904X and also protects the
equipment from external abnormal voltage connectivity. Each platform has two PFM04X units for
redundancy purposes.
• PFM08 _AC: An AC to DC power converter that supplies 48 VDC to the OPT9608 platform. AC power
redundancy is supported by installing two PFM08_AC cards in the platform. To support the
redundancy each PFM08_AC must be fed from a different AC source. A single card can provide the
total power required by the OPT9608.
• FCM04x: Positioned at the right side of the OPT9904X platform and provides cooling air to the system
from four separate fans. Air is drawn in by the fans from the right side of the chassis and pumped out
through the horizontally-mounted cards and modules through the left side of the chassis. FCM04X
includes a controller that controls the operation of the fans.
• FCM08_S: Positioned at the right side of the OPT9608 platform and provides cooling air to the system
from nine separate fans. Air is drawn in by the fans from the right side of the chassis and pumped out
through the horizontally mounted cards and modules through the left side of the chassis.
The FCM08_S includes an integral built-in Layer 2 switch with four ports: one port is for connecting
the OPT9608 to management (IMG port), and three multi-shelf ports to connect to additional Apollo
system management ports at same site.
The FCM08_S includes a controller that controls the operation of the fans. If one of the fans fails, the
remaining ones operate in turbo mode and the fail LED lights until the FCM08_S is replaced. If the
operation does not take more than four minutes, the FCM08_S can be extracted and replaced without
interrupting the router operation (hot swapping). Apollo recommends preparing the replacement
module in advance and so shortening replacement time to a minimum.

Note
The FCM08_S card is only supported on the OPT9608LC platform.

• TAMIM04x: The timing, alarms, and management connection unit between the OPT9904X platform
and the external world. It provides interfaces for timing, alarms and the external management. The
TAMIM04X is installed at the upper part of the OPT9904X.
For more information about the OPT9904x common cards and modules, see the Apollo Reference Manual.

Supported Passive and Photonic Cards

Passive cards for the OPT9904X are supported only via an Artemis shelf.
Several OPT96xx photonic cards are supported in the OPT9904X platform, including:
• OA_LF
• OA_DLF
• OA_DLHF
• OLP_S2
• OMSP
• OTDR_8

Ribbon Communications Inc. Proprietary 140

 Cards and Modules

• OA_DPR
• OA_DFBL
• ROADM_4FS

OPT9901X Cards and Modules

The Apollo OPT9901X platform supports multiple network functionalities in a single platform, through
software configuration of virtual assignable I/O cards. To change the platform functionality, you don't have to
manually replace a physical card. You simply right-click the platform in the management software and select
a configuration (ADM, MADM, CPE, AGG, RADM, DCMR) from the menu.
The OPT9901X changes the equation for provisioning L1 business services. Rather than mapping multiple
colored interfaces onto a ring using muxponders, each requiring engineering, it enables supporting all
services on a single 100G channel. L1 services connect to the OPT9901X via low-cost gray interfaces, and
are added to the ring traffic under software control.
The OPT9901X platform is designed for small regional or metro access networks requiring ODU-XC for
flexible grooming of 10G and sub-10G networks to OTU4. The OPT9901X integrates full OTN, Ethernet,
TDM, and SAN functionality in a single compact platform, and can be configured for cost-effective 100G
ADM or CPE applications, with up to 20x10G or 16x1G client interfaces, for efficient grooming of services at
the SDH/SONET/Ethernet/ODU level, in ring, hub, or terminal topologies.
The OPT9901x in ADM100 and AGG200 mode supports 10 GCC ports in total on OTU2/2e clients and on
OTU4 uplinks up to a maximum of 10 per chassis.
OPT9901x client ports support dual rate GE/10GE clients for both SM10km and MM.
Transceiver OTP10DR_L supports both 10GE LR and GE LX and
transceiver OTP10DR_S supports10GE SR and GE SX. The card supports 10-BASE-T SFP+ electrical
pluggable transceivers.
The OPT9901X platform can include up to two pluggable XFP form-factor OTDR modules on ports 20 and
21 in four modes: ADM100, CPE100, DCMR100, and RADM100. The OTDR scan may be either a reference
test or a regular test, however, the Raman pre installation test in not applicable in this module.
The OPT9901X platform can include up to two pluggable XFP form-factor single channel EDFA modules on
ports 20 and 21 in four modes: ADM100, CPE100, DCMR100, and RADM100.
The OPT9901X platform offers an option for a redundant ADM100 configuration. Two OPT9901X platforms,
each set up as an ADM100, can be configured as a single redundant ADM100. The two platforms are
configured as a single ‘virtual’ NE.
The OPT9901X can be configured for CPE100 "virtual card" functionality, supporting 1 x 100G clients
mapped to OTU4 line.
The OPT9901X can be configured for dual CMR100 (muxponder) "virtual card" functionality, supporting two
muxponders ranging from 10x10G to OTU4.
The OPT9901X can be configured for ADM100HO "virtual card" functionality, supporting up to 20 clients,
mapped to 2 x OTU4 lines. This increases the number of 10G clients that can be supported to maximal
platform capacity.
OPT9901X supports the following cards:
• OPT9901X Common Cards and Modules
• ADM100
• RADM100
• Agg200
• MADM10
• CPE10
• CPE100
• DCMR100
• ADM100HO

Ribbon Communications Inc. Proprietary 141

 Cards and Modules

For more information about the OPT9901X card, see the Apollo Reference Manual.

OPT9901X Common Cards and Modules

The following cards and modules provide common functionality for OPT9901X:
• PFM01X_DC/PFM1X_AC: The PFM01X_DC and PFM01X_AC are input power supplies for the
OPT9901X, protecting the equipment from external abnormal voltage connectivity. Each platform has
two power supply units for redundancy purposes. It is recommended to connect each to a different
power source (unless only one power source is available). When only one power source is available, it
is recommended to connect it to the two power inputs of both units. In such case, and provided a
redundant power supply is installed, the faulty unit can be replaced without affecting traffic.
• FCM01X: The FCM01X provides cooling air to the system from five separate fans, positioned at the
right side of the OPT9901X. Air is drawn in by the fans from the right side of the chassis and pumped
out through the left side of the chassis. The fans are fed through control circuits that improve the
system's performance and support its redundancy.
You can mix the AC and DC PFM when the OPT9901x AC power supply module is located at the PFM01X_A
and the OPT9901x DC power supply module is located at PFM01X_B.
When the OPT9901x AC power supply module is located at the PFM01X_B and the OPT9901x DC power
supply module is located at the PFM01X_BA a new alarm IllegalPowerSupplyMixing is raised.

ADM100
The OPT9901X can be configured for ADM100 "virtual card" functionality, supporting 10-20 clients mapped
to 2 x OTU4 lines.
The ADM100 IO card in OPT9901x comprises two line ports with OTU4 rate, numbered Port 22 and Port
23, supporting QSFP28 form factor transceivers.
The sub-4G clients in OPT9901x directed to the HyPhy device. The HyPhy maps clients to 2 x OTU2 (20 x
TS(OTU0)).

ADM100 Card: Port Configuration Rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

2 L22, L23 22,23 Line • 2 x OTU4 odu4

20 C0-C19 0-19 Client • Up to 16 x 1GbE/ • odu0

STM-1/STM-4/ • odu1
OC-3/OC-12/ • oduf-fc400
FC-100 • odu2e/
• Up to 8 x STM-16/ odu2e/
OC-48/FC-200 odu2
• Up to 4 x FC-400 • odu2x
• Up to 10 x 10GbE/
OTU2e/ OTU2
• Up to 10 x OTU2x

RADM100
The OPT9901X platform offers an option for a redundant ADM100 configuration. Two OPT9901X platforms,
each set up as an ADM100, can be configured as a single redundant ADM100. The two platforms are

Ribbon Communications Inc. Proprietary 142

 Cards and Modules

configured as a single ‘virtual’ NE. Management interconnections are through an external Ethernet cable.
Traffic interconnections between the two platforms are via QSFP28DD DAC cable that can carry the
passthrough OTU4 traffic, as well as control/signal traffic as necessary.

RADM100 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 L22, L23 22, 23 Line OTU4 odu4

Agg200
The OPT9901X can be configured for Agg200 "virtual card" functionality, supporting 20 x OTU2/2e (can be
channelized) mapped to 2 x OTU4.
The Agg200 IO card in OPT9901x comprises two line ports with OTU4 rate, Port 22 and Port 23,
supporting QSFP28 form factor transceivers.
The Agg200 IO card in OPT9901x comprises 20 client ports:
• Port [0:9] - 10 x OTU2/OTU2e, supporting SFP+ form factor transceivers
• Port [10:19] - 10 x OTU2x, supporting SFP+ form factor transceivers

Agg200 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 L22, L23 22, 23 Line • 2 x OTU4 odu4

20 C0-C19 0-19 Client • 10 x OTU2/ • odu2/

OTU2e odu2e
• 10 x OTU2x • odu2x

MADM10
The OPT9901X can be configured for MADM10 "virtual card" functionality, supporting 16 sub-10G clients
mapped to 4 x OTU2 lines.
The MADM10 IO card in OPT9901x comprises four line ports with OTU2x rates, numbered Port [16:19] ,
supporting SFP+ form factor transceivers.
The MADM10 IO card comprises up to 16 client ports. The sub-4G clients in OPT9901x are directed to
the HyPhy device. The HyPhy maps clients to 2 x OTU2 (20 x TS(OTU0)).

Ribbon Communications Inc. Proprietary 143

 Cards and Modules

MADM10 card - port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

4 L16-L19 16-19 Line • 4 x OTU2x odu2x

16 C0-C15 0-15 Client • Up to 16 x 1GbE/ • odu0

STM-1/STM-4/ • odu1
OC-3/OC-12/ • oduf-fc400
FC-100 • odu2e/
• Up to 8 x STM-16/ odu2e/
OC-48/FC-200 odu2
• Up to 4 x FC-400
• Up to 2 x 10GbE/
OTU2e/OTU2

CPE10
The OPT9901X can be configured for CPE10 "virtual card" functionality, supporting 1-4 x 10G clients
mapped to 2-8 x STM64/OC192/FC800/1200/OTU2/2e lines.
The OPT9901x IO card comprises eight (2x4) line ports out of ten (Port [10:19] ) with OTU2x rate,
supporting SFP+ form factor transceivers:
• Line Port [10:19] - 8 (2x4 out of 10) x OTU2/ODU2e, supporting SFP+ form factor transceivers
• Up to 8 (2x4 out of 10) x OTU2/ODU2e line services can be assigned
The CPE10 IO card in OPT9901x comprises four client ports out of 10 (Port [0:9] ), supporting SFP+ form
factor transceivers:
• Client Port [0:9] - 4 (out of 10) x 10GBE/OTU2/OTU2e/STM64/OC192/
FC800/1200, supporting SFP+ form factor transceivers
• Up to 4 (out of 10) x 10GBE/OTU2/OTU2e/STM64/OC192/FC800/1200 client services can be
assigned.
• The ∑ TS (assigned client services) must be less or equal to ∑ TS (assigned line services).

CPE10 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

8 L10-L19 10-19 Line OTU2/OTU2e odu2/odu2e

4 C0-C9 0-9 Client • 10GbE/ • odu2e

FC1200/ • odu2
OTU2e • oduf-fc800
• STM64/
OC192/OTU2
• FC800

Ribbon Communications Inc. Proprietary 144

 Cards and Modules

CPE100
The OPT9901X can be configured for CPE100 "virtual card" functionality, supporting 1 x 100G clients
mapped to OTU4 line.
The CPE100 IO card in OPT9901x comprises one Client port [22], supporting the QSFP28 form factor
transceiver and one Line port [23], supporting the QSFP28 form factor transceiver.
When assigning the IO card in CPE100 mode, the card appears with implicit ports and implicit XC with
default XCVR on both client and line port as OTR100Q28_LR4DR.

CPE100 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

1 L23 23 OTU4 Line odu4

1 C22 22 ETY100G Client odu4

DCMR100
The OPT9901X can be configured for dual CMR100 (muxponder) "virtual card" functionality, supporting two
muxponders ranging from 10x10G to OTU4.
The Dual CMR100 IO card in OPT9901x comprises two line ports (one line port per CMR100) with OTU4
rate, numbered Port 22 (CMR100 #1) and Port 23 (CMR100 #2), supporting QSFP28 form factor
transceivers.
The OPT9901x IO card comprises two groups of client ports (up to 10 client ports per CMR100):
• Client Ports [0:19] support services according to the table below:
• Up to 10 10GBE, STM-64, OC-192, FC800/1200, UTU2/2e client services can be assigned to ports
[0:9] to CMR100 #1.
• Up to 10 10GBE, STM-64, OC-192, FC800/1200, UTU2/2e client services can be assigned to ports
[10:19] to CMR100 #2.
• Up to 6 FC1600 client services can be assigned to each CMR100 #1 and CMR100 #2.
• The ∑ TS (assigned client services) must be less or equal to ∑ TS (assigned line services) .

Ribbon Communications Inc. Proprietary 145

 Cards and Modules

DCMR100 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 L22, L23 22,23 Line OTU4 odu4

20 C0-C19 0-19 Client • STM-64 • odu2e

• OC-192 • odu2
• FC-800 • oduf-fc800
• FC-1200 • odu2e
• OTU2 • odu2
• OTU2e • odu2e
• FC-1600 • oduf-
• ETY10G fc1600
OC • odu2e
• ETY10G • ETY10GE
OCE

ADM100HO
The OPT9901X can be configured for ADM100HO "virtual card" functionality, supporting up to 20 clients,
mapped to 2 x OTU4 lines. This increases the number of 10G clients that can be supported to maximal
platform capacity.
The ADM100HO IO card in OPT9901x comprises two line ports with OTU4 rate, numbered Port 22 and Port
23, supporting QSFP28 form factor transceivers.

ADM100HO Card: Port Configuration Rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 L22, L23 22,23 Line • 2 x OTU4 odu4

20 C0-C19 0-19 Client • 10GbE • odu2e

• STM-64/ • odu2
OC-192 • oduf-fc800
• FC-800 • odu2e
• FC-1200 • oduf-
• FC-1600 fc1600
• OTU2e/ OT • odu2/
U2 odu2e

OPT96xx Cards and Modules

OPT96xx supports the following Layer1 service cards:
• TR10_4
• TR10_4EN
• TR10_12-TR10_12R
• TR10_12ULL

Ribbon Communications Inc. Proprietary 146

 Cards and Modules

• TR100-TR100L
• TR200_2
• TR200_2A
• TM100
• TM200EN
• TM100_2EN
• TM100_2ENB
• TM200ENB
• TM400
• TM400-REG100
• TM400R and TM400ENB
• TM400_2
• TM800
• TM800_2
• TM800_2REG
• TM800E
• TM1200
• TM1200E
• AoC10-AoC10B
• AoC10C
• AoC25-AoC25B
• CMR40B
• CMR100-CMR100L
• CMR100M
• OPT96xx Common Cards and Modules
• CMR200

Note
For detailed descriptions of the supported Layer1 service cards, see the Apollo Reference Manual.

TR10_4
The TR10_4 is a 10 Gbps transponder card that maps the client signal according to G.709 and transmits a
colored signal towards the network.
The card includes two transponders (client and line) providing full functionality in a space saving form factor
and operating in an East/West configuration. Each one can be configured independently for transponder or
regenerator applications.
For more information about the TR10_4 card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 147

 Cards and Modules

TR10_4 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 C1, C2 0,2 Client • STM64 • ODU2

• OC192 • ODU2
• FC800 • ODU2
• FC1200 • ODU2f
• ETY10G • ODU2
• ETY10GOC • ODU2e
• OTU2 • ODU2
• OTU2e • ODU2e

2 L1, L2 1,3 Line OTU2/2e/2f ODU2/2e/2f

Note
To define the port configuration for a TR10_4 card, see Configure Ports.

TR10_4EN
The TR10_4EN is a 10 Gbps transponder card with encryption capabilities. The card maps the client signal
according to G.709 to OTU2/ODU2e/ODU2f. The encryption is performed at the optical ODU2/2e layer, using
an encryption system and sends it to the line. The encryption system encodes the data with AES-GCM 256
algorithm to ensure a high security level. In addition to its main role as a transponder, the TR10_4EN
provides encryption on the optical (ODU2/e) layer.
The TR10_4EN provides the following encryption capabilities:
• AES256-GCM encryption with initialization vector and message integrity check
• Diffie-Hellman group 5 key exchange
• Encryption can be applied to any of its client-line interface mappings: 10G LAN to OTU2/2e, 10G
WAN STM-64 to OTU2/2e, FC8 to OTU2, and FC10 to OTU2f
For more information about the TR10_4EN card and its encryption capabilities, see the Apollo Reference
Manual. To define encryption settings for a TR10_4EN port, see Define encryption settings for TR10_4EN.

TR10_4EN card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 C1, C2 0,2 Client • STM64 • ODU2

• OC192 • ODU2
• FC800 • ODU2
• FC1200 • ODU2f
• ETY10GOC • ODU2e
• OTU2 • ODU2
• OTU2e • ODU2e

2 L1, L2 1,3 Line OTU2/2e/2f ODU2/2e/2f

Ribbon Communications Inc. Proprietary 148

 Cards and Modules

Note
To define the port configuration for a TR10_4EN card, see Configure Ports.

TR10_12-TR10_12R
The TR10_12/TR10_12R is a high-density 10Gbps multiservice transponder that provides six pairs of
independent 10G transponders for client and line. Each transponder pair can be configured independently for
transponder or regenerator applications. The card, which can be mixed with other service or photonic cards,
occupies a single slot and can be installed in all Apollo platforms. The card supports 10-BASE-T SFP+
electrical pluggable transceivers.
The card includes six transponders (client and line) providing full functionality in a space saving form factor
and operating in an East/West configuration. They can also be configured as six regenerators between the
line ports.
For more information about the TR10_12 card, see the Apollo Reference Manual.

TR10_12/TR10_12R card - port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

6 C1-C6 0,2,4,6,8,10 Client • STM64/OC192 • ODU2

• ETY10GOC • ODU2e
• ETY10G • ODU2
• ETY10GOCE • ODU2e

6 L1-L6 1,3,5,7,9,11 Line OTU2/2e OTU2/2e

12 P0-P11 0,…,11 Client/Line • OTU2 • ODU2

• OTU2e • ODU2e
• STM64/OC192 • ODU2
• ETY10GOC • ODU2e
• FC1200 • ODU2e
• FC800 • ODUF-FC800

Note
To define the port configuration for a TR10_12 card, see Configure Ports.

TR10_12ULL
The TR10_12ULL is a 10 Gbps transponder card that maps the client signals according to G.709 and
transmits a colored signal towards the network. The card has 12 ports - four dedicated for ULL (Ultra Low
Latency) transponder channels with very low latency for FC16, FC12, and ETY10GOC clients. The other
eight ports can be configured as four independent transponders.
For more information about the TR10_12ULL card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 149

 Cards and Modules

TR10_12ULL card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

12 P0-P11 0,…,11 Client/Line • OTU2 • ODU2

• OTU2e • ODU2e
• STM64/OC192 • ODU2
• ETY10GOC • ODU2e
• FC1200 • ODU2e
• FC800 • ODUF-FC800
• ULL_FC1200 • ULL-FC1200
• ULL_FC1600 • ULL-FC1600
• ULL_ETY10G • ULL-
OC ETY10GOC

Note
To define the port configuration for a TR10_12ULL card, see Configure Ports.

TR100-TR100L
The TR100/TR100L transponder maps a 100 GbE client signal into a 100 Gbps colored line signal for WDM
network transport, according to the G.709 standard. It occupies a double slot in Apollo platforms.
The TR100/TR100L uses DP-QPSK modulation, a coherent receiver, DSP processing, and soft decision
forward error correction, for superior noise tolerance, and an exceptional ability to mitigate CD and PMD
impairments.
The TR100 is optimized for Ultra Long Haul networking applications, and the TR100L supports regional
applications. While the TR100L does not support single fiber bi-directional WDM operation, in terms of all
other capabilities, the cards are identical and they are interoperable with each other.
The TR100/TR100L can be used in regenerator applications when installed adjacent to another TR100/
TR100L card, or in add/drop mode with an IOP protection option. For regenerator applications the TR100/
TR100L is supported only in OPT9624 and only in slots 0, 2, 4, 6, 12, 14, 16, 18, 20, 22. Slots 8 and 10 are
not supported for regenerator applications.
For more information about the TR100/TR100L card, see the Apollo Reference Manual.
Card assignment of a TR100/TR100L card requires defining an additional mandatory attribute, Operation
Mode (see Card Assignment).

TR100/TR100L card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

1 Client 1 Line ETY100G ODU4

1 Line 0 Client OTU4 ODU4

Ribbon Communications Inc. Proprietary 150

 Cards and Modules

Note
To define the port configuration for a TR100/TR100L card, see Configure Ports.

TR200_2
The TR200_2 is a low-cost, high-density double independent transponder/muxponder that supports transport
of one ETY100G/OTU4 service over OTU4 or two ETY100G/OTU4 services over OTUC2. It occupies a
single slot in OPT96xx platforms. The card maps the ETY100G/OTU4 client signals to OTU4 or OTUC2.
The TR200_2 works with D-CFP2 coherent line transceivers that enable transmission of 100Gbps DP-
QPSK, 200Gbps 8-QAM, or 200Gbps 16-QAM modulation, all with Flex-Grid capabilities. This transceiver
includes a coherent receiver, DSP processing, and soft decision forward error correction, for superior noise
tolerance, as well as an exceptional ability to mitigate CD and PMD impairments.
For more information about the TR200-2 card, see the Apollo Reference Manual.

TR200-2 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 Line 0,1 Line • OTU4 • ODU4

• OTUC2 • ODUC2 +
2*ODU4

4 C2-C5 2,…,5 Client • OTU4 • ODU4

• ETY100G • ODU4

Note
To define the port configuration for a TR200-2 card, see Configure Ports.

TR200_2A
The TR200_2 card supports a new mode (TR200_2A) with the following plug-ins: OTR200P2_CFA2,
OTR400P2_CFA2, OTR200P2_CFA2BD, OTR400P2_CFA2BD and OTR400P2_CFA2T. This card supports
all the features similar to TR200-2 card.
The TR200_2A card is a single slot card supported on all 96xx chassis types which includes 2 line ports and
4 client ports:
• The line ports support Flexo-1/2 with GL2 XCVRS.
• The client ports support OTU4/ETY100G.
• Ports 2 and 3 comprise group 1.
• Ports 4 and 5 comprise group 2.
• Mixing OTU4 and ETY100G clients in a group is not supported.
• IOP for ETY100G and OTU4 is supported.
• OLP-S2 and OLP-SF is supported on both line FlexO-1 and FlexO-2.
• GCC-0 and GCC Transparency is supported as with the TR200-2 card.
• Graceful Switchover is supported on ETY100G ports.
The TR200_2A card supports the OTR400P2_CFA2BD line transceiver.
These modules are designed for a wide range of applications, for example, supporting single fiber and QPSK
in 200G. These modules are also OpenROADM MSA compliant.

Ribbon Communications Inc. Proprietary 151

 Cards and Modules

The TM200_2A can be configured to snoop LLDP information on an ETY100G port that is connected to a
client device such as a router.

TM100
The TM100 is a 100G coherent transponder and muxponder card optimized for metro applications (up to
1200 km without regeneration). When assigned as a transponder (TR100M) the TM100 maps a 100 GbE
client signal into a 100 Gbps colored line signal for WDM network transport, according to the G.709 standard.
In addition it can be configured as a muxponder in two modes: to multiplex 10 x 10 GbE clients
(MXP100E10) or to multiplex 2 x 40 GbE clients (MXP100E40).
During card assignment of the TM100 card, you must select one of the operation modes for the Card Type
(TR100M, MXP100E10, or MXP100E40).
For more information about the TM100 card, see the Apollo Reference Manual.

TM100 card - port configuration rules

Operation Number of Port Label Port Port Role Port Type Sub-IF Type
Mode Ports Number

TR100M 1 Client 1 Client ETY100G ODU4

1 Line 0 Line OTU4 ODU4

MXP100E10 10 Client 1,,,,,10 Client ETY10GOC ODU2e

1 Line 0 Line OTU4 ODU4

MXP100E40 2 Client 1,2 Client ETY40G ODU3

1 Line 0 Line OTU4 ODU4

Note
To define the port configuration for a TM100 card, see Configure Ports.

TM200EN
The TM200EN is a 200G multi-service, low cost, minimal size transponder/muxponder card for customers
with DWDM networks.
The card is enhanced with optional encryption capabilities (license-based) and software add-ons, tailored to
encrypted/unencrypted applications. TM200EN is supplied without the encryption option, by default.
The card applications are used in small regional or metro access networks requiring flexible grooming of 10G
to OTU2 and 10G\\100G OTU4\\OTUC2.
The TM200EN works with D-CFP2 coherent line transceivers that enable transmission of 100Gbps DP-
QPSK, 200Gbps 8-QAM, or 200Gbps 16-QAM modulation, all with Flex-Grid capabilities. This transceiver
includes a coherent receiver, DSP processing, and soft decision forward error correction, for superior noise
tolerance, as well as an exceptional ability to mitigate CD and PMD impairments. The card supports 10-
BASE-T SFP+ electrical pluggable transceivers.

Ribbon Communications Inc. Proprietary 152

 Cards and Modules

In addition, the TM200EN supports an OTR400P2_CF26 transceiver in OTUC2 port type. It also supports the
OTR400P2_CFA2BD, OTR200P2_CFA2BD, OTR400P2_CFA2, OTR200P2_CFA2, OTR400P2_CFA2T,
OTR400P2_CFA1 line transceivers.
The TM200EN card can be configured to operate in two modes (expected types):
• TM200EN: for muxponder applications of N x 10G/16G/32G/100G to 100G or 200G user selectable
• TM200B - for muxponder applications of OTU4 or 100GE,10x10GE user selectable
◦ 1x100GE or OTU4
◦ 10x10GE (SFP+)
• TR10_12EN: for six 10G transponders application
For more information about the TM200EN card, see the Apollo Reference Manual. To define encryption
settings, see Define TM200EN-TM100_2EN Encryption Settings.

TM200EN card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

1 Line 0 Line • OTU4 • ODU4

• OTUC2 • ODUC2 (PT22)
• FlexO-1 + 2*ODU4
• FlexO-2 (PT21)
• ODUC1
• ODUC2

20 C1-C20 1,...,20 Client • OTU4 • ODU4

• ETY100 • ODU4
G • ODU3
• ETY40G • ODU2e
• ETY10G • ODU2
OC • ODU2
• STM64 • ODUflex-FC800
• OC192 • ODU2e
• FC800 • ODUF-FC1600
• FC1200 • ODUF-FC3200
• FC1600 • ODU2
• FC3200 • ODU2e
• OTU2 • ODU2e
• OTU2e
• ET10GO
CE

Ribbon Communications Inc. Proprietary 153

 Cards and Modules

TM200B card - port configuration rules

Number Port Label Port Number Port Role Port Type Sub-IF Type
of Ports

1 Line 0 Line • OTUC2 • ODUC2

1 Line 1 Line • OTU4 • ODU4

• ETY100G • ODU4

10 C1-C10 11,...,20 Client • OTU4 • ODU4

• ETY100G • ODU4
• ETY40G • ODU3
• ETY10GOC • ODU2e
• STM64 • ODU2
• OC192 • ODU2
• FC800 • ODUflex-FC800
• FC1200 • ODU2e
• FC1600 • ODUF-FC1600
• FC3200 • ODUF-FC3200
• OTU2 • ODU2
• OTU2e • ODU2e

TR10_12EN card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

12 C9-C12 9,...,12 Client • ETY10GOC • ODU2e

• ETY10G • ODU2
• STM64 • ODU2
P13-P14 13,14 Client/Line
• OC192 • ODU2
• FC800 • ODUflex-
L15-L20 15,...,20 Line • FC1200 FC800
• OTU2 • ODU2e
• OTU2e • ODU2
• ODU2e

Note
To define the port configuration for a TM200EN/TR10_12EN card, see Configure Ports.

TM100_2EN
TM100_2EN is a 2 x 100G Multi-Service, low cost, minimal size encrypted solution to customers for DWDM
networks that can be configured to operate with or without encryption. The card applications is used in small
regional or metro access networks requiring flexible grooming of 10G to OTU2 and 10G\\100G OTU4,
encrypted or non-encrypted.

Ribbon Communications Inc. Proprietary 154

 Cards and Modules

The card is very similar to the TM200EN in all client port aspects. The main difference is in the line ports;
TM200EN has a single CFP2-based line port, while TM100_2EN has two QSFP28-based line ports that can
be configured to OTU4.
TM100_2EN is a double slot long card that provides similar main functions as the TM200EN.
For more information about the TM100_2EN card, see the Apollo Reference Manual. To define encryption
settings, see Define TM200EN-TM100_2EN Encryption Settings.

TM100_2EN card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

22 Line 0, Line 0,21 Line OTU4 ODU4

21

C1-C20 1,…,20 Client • OTU4 • ODU4

• ETY100G • ODU4
• ETY40G • ODU3
• ETY10GOC • ODU2e
• STM64 • ODU2
• OC192 • ODU2
• FC800 • ODUflex-
• FC1200 FC800
• FC1600 • ODU2e
• FC3200 • ODUF-
• OTU2 FC1600
• OTU2e • ODUF-
FC3200
• ODU2
• ODU2e

Note
To define the port configuration for a TM100_2EN card, see Configure Ports.

TM100_2ENB
TM100_2ENB is a 2 x 100G multi-service, low-cost, minimal-size transponder/muxponder card for customers
with DWDM networks. The card provides a high level of encryption that complies with FIPS Level 2
encryption standards. The traffic of each client port can be configured, by the user, to be encrypted or not.
The card applications are used in small regional or metro access networks requiring flexible grooming of 10G
to OTU2 and 10G\\100G OTU4.
The TM100_2ENB is very similar to the TM200ENB in all client port aspects. The main difference is in the
line ports; TM200ENB has a single CFP2-based line port, while TM100_2ENB has two QSFP28-based line
ports that can be configured to ODU4.
For more information about the TM100_2ENB card, see the Apollo Reference Manual. To define encryption
settings, see Define TM200ENB-TM100_2ENB Encryption Settings.

Ribbon Communications Inc. Proprietary 155

 Cards and Modules

TM100_2ENB card - port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

22 Line 0, Line 0,21 Line OTU4 ODU4

21

C1-C20 1,…,20 Client • OTU4 • ODU4

• ETY100G • ODU4
• ETY40G • ODU3
• ETY10GOC • ODU2e
• STM64 • ODU2
• OC192 • ODU2
• FC800 • ODUflex-
• FC1200 FC800
• FC1600 • ODU2e
• FC3200 • ODUF-
• OTU2 FC1600
• OTU2e • ODUF-
FC3200
• ODU2
• ODU2e

Note
To define the port configuration for a TM100_2ENB card, see Configure Ports.

TM200ENB
The TM200ENB is a 200G multi-service, minimal size encrypted solution to customers for DWDM networks.
The card provides a high level of encryption that complies with FIPS 140-2 Level 2 encryption standards.
The traffic of each client port can be configured, by the user, to be encrypted or not.
The card applications are used in small regional or metro access networks requiring flexible grooming of 10G
to OTU2 and 10G\\100G OTU4\\OTUC2, encrypted or non-encrypted.
In addition, the HIO500/HIO400 supports an OTR400P2_CF26 transceiver in OTUC2 port type.
The TM200ENB supports the OTR400P2_CFA2BD, OTR200P2_CFA2BD, OTR400P2_CFA2,
OTR200P2_CFA2, OTR400P2_CFA2T, OTR400P2_CFA1 line transceivers.
TM200ENB can be configured to operate in two modes (expected types):
• TM200ENB: for muxponder applications of N x 10G/16G/32G/100G to 100G or 200G user selectable
• TR10_12ENB: for six 10G transponders application
For more information about the TM200ENB card, see the Apollo Reference Manual. To define encryption
settings, see Define TM200ENB-TM100_2ENB Encryption Settings.

Ribbon Communications Inc. Proprietary 156

 Cards and Modules

TM200ENB card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

1 Line 0 Line • OTU4 • ODU4

• OTUC2 • ODUC2 (PT22)
• FlexO-1 +
• FlexO-2 2*ODU4(PT21)
• ODUC1
• ODUC2

20 C1-C20 1,…,20 Client • OTU4 • ODU4

• ETY100 • ODU4
G • ODU3
• ETY40G • ODU2e
• ETY10G • ODU2
OC • ODU2
• STM64 • ODUflex-FC800
• OC192 • ODU2e
• FC800 • ODUF-FC1600
• FC1200 • ODUF-FC3200
• FC1600 • ODU2
• FC3200 • ODU2e
• OTU2
• OTU2e

TR10_12ENB card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

12 C9-C12 9,…,12 Client • ETY10GOC • ODU2e

• ETY10G • ODU2
• STM64 • ODU2
P13-P14 13,14 Client/Line
• OC192 • ODU2
• FC800 • ODUflex-
L15-L20 15,…,20 Line • FC1200 FC800
• OTU2 • ODU2e
• OTU2e • ODU2
• ODU2e

Note
To define the port configuration for a TM200ENB/TR10_12ENB card, see Configure Ports.

TM400
The TM400 is a Flex-grid and Flex-rate transponder/muxponder card designed for ultra-long haul, metro-long
haul, and metro-regional network configurations. It has four client ports and two line ports supporting line

Ribbon Communications Inc. Proprietary 157

 Cards and Modules

rates of 2 x 200 Gbps, or 2 x 100 Gbps. The card occupies a double (long) slot in the Apollo supported
platforms. The card can be configured to operate in one of two modes: transponder or muxponder.
TM400 provides a multi-service, cost-effective solution with 100G/200G wavelengths.
For more information about the TM400 card, see the Apollo Reference Manual.
Since the TM400 occupies a double slot, you can only assign it to a free even-numbered IO slot, where the
following odd-numbered slot is free as well. In the STMS, when you assign the TM400 card to an even-
numbered slot, the following slot is automatically disabled for assignment.

TM400 card - port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

40 CLIENT-<n+10> ; 2,12,22,32 Client ETY100G ODU4

n=2…41

CLIENT-<n+10> ; 2,12,22,32 Client OTU4 ODU4

n=2…41

CLIENT-<n> ; n=2…41 2-41 Client ETY10GOC ODU2e

2 LINE 0, LINE 1 0, 1 Line OTU4 ODU4

or or
OTUC2 ODUC2 (PT22)
+ 2*ODU4(PT21)
+ 10*ODU2e (for
each ODU4)
or ODUC2
(PT22) +
2*ODU4(PT21)

You can configure up to 40 client ports, depending on Line Port Type and Client Port Type selected per Client
Port Group.
Under ODUC2, another Sub-IF level exists - ODU4. Each ODU4 works with the regular PT21 rules.
You can only configure a second line port if you purchased the license for it. See the STMS Getting Started
and Administration Guide.

Note
To define the port configuration for a TM400 card, see Configure Ports.

TM400-REG100
The TM400 can be configured as a regenerator by assigning it as TM400_REG100. The two LINE ports are
used to implement the regenerator configuration, while the Client ports are not used.
The functions of the regenerator are to clean up and amplify the optical signals transmitted through the
optical line (3R regeneration). Any attempt to assign the Client ports in the TM400_REG100 mode will be
rejected by the software.

Ribbon Communications Inc. Proprietary 158

 Cards and Modules

When the TM400 is assigned as regenerator (TM400_REG100), the software implicitly configures both line
ports to operate as independent OTU4 ports. It also configures the cross-connect between the lines for the
regenerator application. The user only has to configure the SD-FEC modes, including:
• SD-FEC15 (regularly marked SD-FEC (legacy))
• SD-FEC25
For more information about the TM400-REG100 card, see the Apollo Reference Manual.

TM400-REG100 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 L0, L1 0, 1 Line OTU4 ODU4

Note
To define the port configuration for a TM400-REG100 card, see Configuring Ports.

TM400R and TM400ENB

The TM400ENB is a 400G coherent multiservice transponder/muxponder that supports configurable Layer 1
encryption, with FIPS 140-3 Level 3 standard. The TM400R provides all the capabilities of the TM400ENB
card, without the encryption features.
Each client service can be encrypted independently, with its own key management, including independent
key period rotation times. Encryption is enabled/disabled per service, and can be applied per service to any
of its client interface mappings.
Service providers can now install the hardware for an ultra-high-speed 400Gbps network on day one, and
offer both encrypted and unencrypted services to their clients. Existing clients can be upsold at any time to
an encrypted service without the need to replace any hardware, as the service can be enabled at any time
via software commands.
The TM400R and TM400ENB, which can be mixed with other service or photonic cards, can be installed in
Apollo 96xx platforms. Both cards multiplex services into 300G, or 400G coherent lines based on D-CFP2
coherent technology, supporting different combinations of rates and modulations. Card applications are
typically in data centers and SAN interconnectivity, as well as expansion of existing networks with 400G
encrypted wavelengths, grooming any mixture of services into FlexO-3 or FlexO-4.
The TM400R and TM400ENB work with D-CFP2 coherent line transceivers, supporting configurable 8-QAM,
or 16-QAM modulation, with Flex-Grid capabilities. This transceiver includes a coherent receiver, DSP
processing, and soft decision forward error correction, for superior noise tolerance, as well as an exceptional
ability to mitigate CD and PMD impairments.
The cards support the OTR400P2_CFA2, OTR400P2_CFA2BD, OTR400P2_CFA2T and OTR400P2_CFO
transceivers.
The TM400R and TM400ENB have 1 line port and the following client ports:
• 1 x QSFP-DD port
• 4 x QSFP+/28 ports
• 16 x SFP+/SFP28/SFP56 ports
The client ports support the following rates:
• 10GE, 100GE, 400GE
• OTU2, OTU2e, OTU4
• ETY10GOC, ETY25G, ETY100G, ETY400G

Ribbon Communications Inc. Proprietary 159

 Cards and Modules

• FC16, FC32, and FC64

For more information about the TM400R and TM400ENB cards, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 160

 Cards and Modules

TM400ENB card port configuration rules

Number Port Label Port Por Port Type Sub-IF Type

of Ports Numbe t
r Rol
e

4 C1-C4 1-4 Clie • ETY10GOC • ODU2e

nt • OTU2 • ODU2
• OTU2e • ODU2e

12 C5-C8, C9- 5-8, Clie • ETY10GOC • ODU2e

C12, C13- 9-12, nt • OTU2 • ODU2
C16 13-16 • OTU2e • ODU2e
• ETY25G • ODUF-
• OTU4 ETY25G
• ETY100G • ODU4

4 C17-C20 17-20 Clie • ETY10GOC • ODU2e

nt • OTU2 • ODU2
• OTU2e • ODU2e
• ETY25G • ODUF-
• OTU4 ETY25G
• ETY100G • ODU4
• ETY400G • ODUFlex400

4 C21-C24 21-24 Clie • ETY10GOC • ODU2e

nt • OTU2 • ODU2
• OTU2e • ODU2e
• FC1600 • ODUF-
FC1600

8 C25-C32 25-32 Clie • ETY10GOC • ODU2e

nt • FC1600 • ODUF-
• FC3200 FC1600
• ODUF-
FC3200

2 C33-C34 33, 34 Clie • ETY10GOC • ODU2e

nt • FC3200 • ODUF-
• FC6400* FC3200
*only for port 33 and port 34 must be • ODUF-
disabled when configuring to FC6400. FC6400

Ribbon Communications Inc. Proprietary 161

 Cards and Modules

Number Port Label Port Por Port Type Sub-IF Type

of Ports Numbe t
r Rol
e

2 C35-C36 35, 36 Clie • ETY10GOC • ODU2e

nt • FC1600 • ODUF-
• FC3200 FC1600
• FC6400* • ODUF-
*only for either port 35 and port 36. FC3200
The other port must be disabled when • ODUF-
configuring to FC6400. FC6400

1 L0 0 Line • FlexO-3 • ODUC3

• FlexO-4 • ODUC4

Note
To define the port configuration for a TM400ENB card, see Configure Ports.

TM400_2
The TM400_2 dual transponder/muxponder is a single slot card for the OPT96xx platforms comprising 2 x
400G transponders/muxponders. Each transponder/muxponder supports from one to four ETY100G/OTU4
clients or one ETY400G client. The card includes a high baud rate standard CFP2 ZR transceiver for line,
configurable to full standard OTUC2 or OTUC4.
The TM400_2 comprises two line ports, numbered Port 0 and Port 1, supporting CFP2 form factor
transceivers.
In addition, the TM400_2A card supports the OTR400P2_CFA2BD line transceiver.
The TM400-2A supports line rates with:
• FlexO-1 Sub-If type ODUC1
• FlexO-2 Sub-If type ODUC2
• FlexO-3 Sub-If type ODUC3
• FlexO-4 Sub-If type ODUC4
The TM400_2 is a flexible card that can be configured in any of the following modes:
• Dual 100GE Muxponder, mapping 2 x 100GE/OTU4 signals to OTUC2.
• Dual 100GE Muxponder, mapping 4 x 100GE signals to OTUC4.
• Dual 400GE metro transponder, mapping 2 x 400GE signals to 2 x OTUC4
• Single 400GE long-haul transponder, mapping 400GE signals to 2 x OTUC2
• Regenerator mode with fixed OTUC2
These high density cards can also be combined to maximize transport capacity in the OPT96xx platforms.
For example:
• OPT9603: Up to 3 dual muxponder cards in the platform, supporting 3 x 2 x 400G = 6 x 400G
muxponders/transponders per platform
• OPT9608: Up to 8 dual muxponder cards in the platform, supporting 8 x 2 x 400G = 16 x 400G
muxponders/transponders per platform
• OPT9608D: Designed for data centers. Supports the following:
◦ 8 universal slots for L1/L2 data service and photonic cards.
◦ 2 slots for redundant RCP main controller and fabric cards (RCP08D).

Ribbon Communications Inc. Proprietary 162

 Cards and Modules

◦ 2 slots for redundant power feed modules (PFM08D_DC/PFM08D_AC) using a -48VDC or AC

power source.
◦ 2 drawers for the fan control modules (FCM08D) with five fans each, 10 fans total.
◦ 1 slot for alarm and management interface control module (MIM08D).
◦ Two filter trays.
• OPT9624: Up to 24 dual muxponder cards in the platform, supporting 24 x 2 x 400G = 48 x 400G
muxponders/transponders per platform
The TM400_2 can be configured to snoop LLDP information on an ETY400G port or an ETY100G port that is
connected to a client device such as a router. When enabled, the following snooping information is gathered
at the ingress of the port:
• Chassis ID
• Port Type
• Port ID
• Management Address Type
• Management Address
• Interface Number
• Interface Type
• OID
• Time To Live
The TM400_2 can be configured into three different modes:
• TM400_2: Can be configured in regular mode where you can use all clients and all ports.
• TM400_MC: Is a fixed port configuration with 2 x lines and 1(OTUC2) x client (ETY400G).
• TM400_REG: Is only a 2 x line configuration with OTUC2.
The following is an example of configuring the TM400_MC:

Configuring the TM400_MC

In the example, the client port ETY100G (port 2) is split into 2 x OTUC2 line ports (ports 0 and1). The port
numbers are fixed, the cross-connections are fixed but you can change the frequencies and line codes.
When you configure TM400_REG, you cannot configure any client port. The client ports are completely
disabled but you can only configure the 2 x line ports that are fixed OTUC2 ports. You can change the
frequency and line codes of these ports.
The TM400_2 can be used as a transponder or a muxponder. As a transponder, you configure the ETY400G
as a client directly connected into OTUC4 to transmit to the other side as shown in the following example.

Ribbon Communications Inc. Proprietary 163

 Cards and Modules

TM400_2 configured as a transponder

In muxponder mode, you configure the ETY100G you can configure to multiplex the lines to OTUC2/OTUC4,
meaning you will have 2 x ODU4s / 4 x ODU4s as shown in the following example.

TM400_2 configured as a muxponder

Ribbon Communications Inc. Proprietary 164

 Cards and Modules

TM400_2 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 Line 0,1 Line OTUC2/OTUC4 ODUC2 with

ODU4 lower-
order sub-if/
ODUC4 with
ODUflex400/
ODU4 lower-
order sub-if

2 Client 2,6 Client ETY400G ODUflex400

8 Client 2,3,4,5,6,7,8,9 Client ETY100G ODU4

2 Client 2,5,6,7 Client OTU4 ODU4

Note
100GE IOP (OCH1+1) protection and OLP on client (shelf protection) is a basic requirement in
DWDM networks and is supported today by all Apollo cards with LR4 clients. New generation
dense transponder/muxponder cards use 100GE fanout ports.
Fanout ports based on 100GE LR1 do not support IOP. Traffic disruption can therefore reach 3
seconds, far from the <50msec requirement.
Recent developments in DSPs enable IOP for LR1 and LR1 fanout.
• From STMS V12, TM400_2 in 400G muxponder mode supports IOP and OLP client
protection for 100GE LR1 fanout with the OTR400Q56DD_LR1 module.
• From STMS V12, TM800_2 in muxponder mode supports IOP and OLP client protection for
LR1 fanout with the OTR400Q56DD_LR1 module.

TM800
The TM800 is a flexible grid, flexible rate, 800G transponder/muxponder designed to maximize traffic
carrying capacity for any application or line condition. It maps up to 8 x 100GbE or OTU4 clients, on to two
line interfaces that can be configured from 100 Gbps to 400 Gbps in 50 Gbps increments.
The TM800 can be configured for use for all applications and in all bit rates and baud rates, including:
• 400G metro
• 200G long haul
• 100G ultra long haul
The TM800 provides software-controllable dials for the modulation scheme (BPSK up to 64QAM), baud rate
(34G to 72G), and transmit power. The TM800 combines this with full spectral flexibility to select a channel
width to always find the "sweet spot" that maximizes the line rate - and thus the services capacity - for any
set of channel conditions. The TM800 features SD-FEC of 15% and 27%, with NCG of 12.7dB.
The TM800 can be configured to snoop LLDP information on an ETY100G port that is connected to a client
device such as a router. When enabled, the following snooping information is gathered at the ingress of the
ETY100G port:

Ribbon Communications Inc. Proprietary 165

 Cards and Modules

• Chassis ID
• Port ID
• TTL (Time to Live)
• Management Address
The Bit per Symbol parameter is implicitly configured according to the configured spectral bandwidth and
line rate. If you select Expert mode, you can select a different Bit per symbol value from the dropdown list.
For more information about the TM800 card, see the Apollo Reference Manual.

TM800 card - port configuration rules

Number of Port Label Port Port Port Type Sub-IF Type

Ports Number Role

8 C2-C9 2-13 Client ETY100G ODU4

C2-C13 2-13 Client OTU4 ODU4

2 Line 0, Line 1 0, 1 Line OTUA ODUA

Note
To define the port configuration for a TM800 card, see Configure Ports.

TM800_2
The TM800_2 - Dual 800G muxponder card is a double slot card, assignable to any even slot of the
OPT96xx family:
• Only the 800G module is supported.
• TM800_2 comprises two independent slices, each one including two client transceivers supporting
400GE and 4X100GE (fanout), each with QSFP112.

Ribbon Communications Inc. Proprietary 166

 Cards and Modules

TM800_2 Port Configurations

Port Type Port No Rate FEC Type Transceiver Client Support

Type

ENHZR-400 0, 1 400G SD-FEC15 OTR800PJ_CF Any possible

combination of
ETY100G.
OTU4 and
ETY400G up to
maximum line Rate.

ENHZR-500 0, 1 500G SD-FEC15 OTR800PJ_CF Any possible

combination of
ETY100G.
OTU4 and
ETY400G up to
maximum line Rate.

ENHZR-600 0, 1 600G SD-FEC15 OTR800PJ_CF Any possible

combination of
ETY100G.
OTU4 and
ETY400G up to
maximum line Rate.

ENHZR-700 0, 1 700G SD-FEC15 OTR800PJ_CF Any possible

combination of
ETY100G.
OTU4 and
ETY400G up to
maximum line Rate.

ENHZR-800 0, 1 800G SD-FEC15 OTR800PJ_CF Any possible

combination of
ETY100G.
OTU4 and
ETY400G up to
maximum line Rate.

Ribbon Communications Inc. Proprietary 167

 Cards and Modules

Note
100GE IOP (OCH1+1) protection and OLP on client (shelf protection) is a basic requirement in
DWDM networks and is supported today by all Apollo cards with LR4 clients. New generation
dense transponder/muxponder cards use 100GE fanout ports.
Fanout ports based on 100GE LR1 do not support IOP. Traffic disruption can therefore reach 3
seconds, far from the <50msec requirement.
Recent developments in DSPs enable IOP for LR1 and LR1 fanout.
• From STMS V12, TM400_2 in 400G muxponder mode supports IOP and OLP client
protection for 100GE LR1 fanout with the OTR400Q56DD_LR1 module.
• From STMS V12, TM800_2 in muxponder mode supports IOP and OLP client protection for
LR1 fanout with the OTR400Q56DD_LR1 module.

Note
• Port type and spectral bandwidth are mandatory parameters when configuring the service.
• SBW is editable without port deletion, but traffic affecting.

TM800_2REG
The TM800_2REG card supports a Unidirectional Regenerator facility.

TM800_2REG Supports all ENHZR-X Rates

Rx Modem Loopback after the ENHZR framer.
All OTUCn members are looped back as a group.
This is based on the REGEN Simplex EN Bit Enhancement feature as follows:
• Suppression of TXRPF flag when Rx encounters a LOL event.
• Flexibility to force an RPF alarm (Tx Datapath).

TM800_2REG Does Not Support Client Ports

After TM800_2REG assignment no ports are configured.
• Users must select the port type and the SBW.
• Both line ports support the same ENHZR rate.
• Different rates shall be rejected.
• Wavelength and Spectral Bandwidth must be the same for both ports.
• Both ENHZR ports must be explicitly configured by the user in the same commit and the two ODUCn
objects will be implicitly created.
• The cross-connect will be fixed, created implicitly by embedded.

TM800_2REG Does Not Support FCC Communication Channels

All ENHZR-x parameters, alarms, performance monitoring, consequent actions and configuration are
supported in the same way as in MPJ1200_2.
• ODUCn is an empty object for connectivity only, and will not support fault management, PM, etc.
• When AIS2LOL is enabled, detection of an ENHZR-x signal fail will cause laser shut-down of the Tx.
• Rx Modem loopback is enabled implicitly on both line transceivers.
• Automatic RPF insertion as a CA is disabled.

Ribbon Communications Inc. Proprietary 168

 Cards and Modules

• RPF CA is forced by SW on the other line port when an ENHZR-x fault with RPF CA specification is
detected.

TM800E
The TM800E programmable transponder/muxponder can transport two 400GE clients, offering the most
400GE clients per application. The modulation scheme is adjusted automatically by the device, based on the
line rate and bits/symbol, to optimize the optical performance for a wide range of distances and fiber
conditions. Built-in monitoring provides continuous OSNR and performance feedback.
The TM800E can be configured for use for all applications, with the following line rates. The modulation
setting (b/sym) can be configured per rate.
• 1x400GbE (over 2 carriers of 200Gbps line rates) for long haul
• 2x400GbE for metro
• Regeneration mode: Supports optical-electrical-optical (OEO) regeneration of 100G-400G line rates
for all TM800/E and TM1200/E cards. When configured as TM800E_REG, the card supports OTU-A
regeneration of line rates with 100G-400Gbps via both line ports.
The TM800E maximizes 400GE transport in networks where a flexible grid is available, as well as in
networks with technological constraints to a 50GHz grid.
The TM800E can be configured to snoop LLDP information on an ETY400G port that is connected to a client
device such as a router. When enabled, the following snooping information is gathered at the ingress of the
ETY400G port:
• Chassis ID
• Port ID
• Management Address
The Bit per Symbol parameter is implicitly configured according to the configured spectral bandwidth and
line rate. If you select Expert mode, you can select a different Bit per symbol value from the dropdown list.
For more information about the TM800E card, see the Apollo Reference Manual.

TM800E card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

2 C2, C3 2,3 Client ETY400G ODUF-400

2 Line 0, Line 1 0, 1 Line OTUA ODUA

Note
To define the port configuration for a TM800E card, see Configure Ports.

TM1200
The TM1200 is a flexible grid, flexible rate, 1.2T transponder/muxponder designed to maximize traffic
carrying capacity for any application or line condition. It maps up to 12 x 100GbE or OTU4 clients, on to two
line interfaces that can be configured from 100 Gbps to 600 Gbps in 50 Gbps increments.
The TM1200 can be configured for use for all applications and in all bit rates and baud rates, including:
• 600G DCI
• 400G metro

Ribbon Communications Inc. Proprietary 169

 Cards and Modules

• 200G long haul

• 100G ultra long haul
The TM1200 provides software-controllable dials for the modulation scheme (BPSK up to 64QAM), baud rate
(34G to 72G), and transmit power. The TM1200 combines this with full spectral flexibility to select the best
channel width to find the "sweet spot" that maximizes the line rate - and thus the services capacity - for any
set of channel conditions. The TM1200 features SD-FEC of 15% and 27%, with NCG of 12.7dB, and a power
consumption of <0.22W per 1G.
The TM1200 can be configured to snoop LLDP information on an ETY100G port that is connected to a client
device such as a router. When enabled, the following snooping information is gathered at the ingress of the
ETY100G port:
• Chassis ID
• Port ID
• TTL (Time to Live)
• Management Address
The Bit per Symbol parameter is implicitly configured according to the configured spectral bandwidth and
line rate. If you select Expert mode, you can select a different Bit per symbol value from the dropdown list.
For more information about the TM1200 card, see the Apollo Reference Manual.

TM1200 card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

12 C2-C13 2-13 Client ETY100G ODU4

C2-C13 2-13 Client OTU4 ODU4

2 Line 0, Line 1 0, 1 Line OTUA ODUA

Note
To define the port configuration for a TM1200 card, see Configure Ports.

TM1200E
The TM1200E programmable transponder/muxponder can transport up to 3 x 400GE clients. The modulation
scheme is adjusted automatically by the device, based on the line rate and bits/symbol, to optimize the
optical performance for a wide range of distances and fiber conditions. Built-in monitoring provides
continuous OSNR and performance feedback.
The TM1200E can be configured for use for all applications, with the following line rates. The modulation
setting (b/sym) can be configured per rate.
• 1x400GE (over 2 carriers of 200Gbps line rates) for long haul
• 2x400GE for metro
• 3x400GE, mapping to 2x600G for DCI applications
The TM1200E maximizes 400GE transport in networks where a flexible grid is available, as well as in
networks with technological constraints to a 50GHz grid.
The TM1200E can be configured to snoop LLDP information on an ETY400G port that is connected to a
client device such as a router. When enabled, the following snooping information is gathered at the ingress of
the ETY400G port:

Ribbon Communications Inc. Proprietary 170

 Cards and Modules

• Chassis ID
• Port ID
• Management Address
The Bit per Symbol parameter is implicitly configured according to the configured spectral bandwidth and
line rate. If you select Expert mode, you can select a different Bit per symbol value from the dropdown list.
For more information about the TM1200E card, see the Apollo Reference Manual.

TM1200E card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

3 C2, C3,C4 2,3,4 Client ETY400G ODUF-400

2 Line 0, Line 1 0, 1 Line OTUA ODUA

Note
To define the port configuration for a TM1200E card, see Configure Ports.

AoC10-AoC10B
The AoC10/AoC10B provides 10 Gbps ADM service on a card. It supports up to 16 client interfaces, which
are multiplexed into the G.709 multiplexing structure and sent via two OTU2 line interfaces.
Any of the client interfaces can be configured to accept an STM-1, STM-4, GbE, FC/FC2/FC4, OTU-1,
STM-16, DVB-ASI, SDI, or HD-SDI signal. The card has integrated cross-connect capabilities, providing
more efficient utilization of the lambda. Any of the signals can be added or dropped at each site, while the
rest of the traffic continues on to the next site. Broadcast TV services can be dropped and continued
(duplicated), eliminating the need for external equipment to provide this functionality.
For more information about the AoC10/AoC10B card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 171

 Cards and Modules

AoC10/AoC10B card - port configuration rules

Card Number Port Label Port Port Role Port Type Sub-IF Type
of Ports Number

AoC10 16 C0 - C15 0,...,15 Client • STM1/OC3 • ODUslot

• STM1e/ • ODUslot
OC3e • ODUslot
• STM4/OC12 • ODUslot
• FC100 • ODUslot
• ETY1G • ODUslot
• ETY1Ge • ODUslot
• VIDEO270 • ODU1
• STM16/ • ODU1
OC48 • ODU1
• FC200 • ODU1
• HDSDI1485 • 2*ODU1
• OTU1
• FC400

2 L1, L2 16,17 Line OTU2 ODU2 + 4 *

ODU1

AoC10B 16 C0 - C15 0,...,15 Client • STM1/OC3 • ODU0

• STM1e/ • ODU0
OC3e • ODU0
• STM4/OC12 • ODU0
• FC100 • ODU0
• ETY1G • ODU0
• ETY1Ge • ODUslot
• VIDEO270 • ODU1
• STM16/ • ODU1
OC48 • ODU1
• FC200 • ODU1
• HDSDI1485 • 2*ODU1
• OTU1
• FC400

2 L1, L2 16,17 Line OTU2 ODU2(PT21)

Note
To define the port configuration for an AoC10/AoC10B card, see Configure Ports.

AoC10C
The AoC10C provides 10 Gbps ADM service on a card. It supports up to 16 client interfaces, which are
multiplexed into the G.709 multiplexing structure and sent via two OTU2 line interfaces.
The Aoc10C supports OTN SFP+ based uplinks on line ports 16 and 17. It uses both tunable
(OTP10T96_ALLM & OTP10T_ALLM) and fixed (OTP10D_ALLMxx) DWDM limiting SFP+ only
transceivers. AOC10C supports AOC10C and AOC25C expected types.

Ribbon Communications Inc. Proprietary 172

 Cards and Modules

The AoC10C interops with the Aoc10B and all other Apollo cards supporting OTU2 : TR10_12, TR10_4,
HIO10_20, HIO10_40, OPT9901x, MIO200 and MIO700- interop is at OTU2 both GFEC and EFEC.
Any of the client interfaces can be configured to accept an STM-1, STM-4, GbE, FC/FC2/FC4, OTU-1,
STM-16, DVB-ASI, SDI, or HD-SDI signal. The card has integrated cross-connect capabilities, providing
more efficient utilization of the lambda. Any of the signals can be added or dropped at each site, while the
rest of the traffic continues on to the next site.
For more information about the AoC10C card, see the Apollo Reference Manual.

AoC10C card - port configuration rules

Card Number of Port Port Port Port Type Sub-IF Type

Ports Label Number Role

AoC10C 16 C0 - C15 0,...,15 Client • STM1/OC3 • ODU0

• STM1e/ • ODU0
OC3e • ODU0
• STM4/OC12 • ODU0
• FC100 • ODU0
• ETY1G • ODU0
• ETY1Ge • ODUslot
• VIDEO270 • ODU1
• STM16/ • ODU1
OC48 • ODU1
• FC200 • ODU1
• HDSDI1485 • 2*ODU1
• OTU1
• FC400

2 L1, L2 16,17 Line OTU2 ODU2(PT21)

Note
To define the port configuration for an AoC10/AoC10B card, see Configure Ports.

AoC25-AoC25B
The AoC10 can be assigned as an AoC25 operating in 2.5 Gbps mode, and enabling the user high flexibility
in implementation of more applications with the same hardware. When assigned as an AoC25 the card can
work as a Multi-service OTU1 muxponder and/or transponder.
The two Line ports (port 16 and 17) are disabled in this mode, and only the 16 client ports are used. The first
eight ports (Port 0 to Port 7) are configured as Client ports, and the last eight (Port 8 to Port 15), as Line
ports.
For more information about the AoC25/AoC25B card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 173

 Cards and Modules

AoC25/AoC25B card - port configuration rules

Card Number Port Label Port Port Role Port Type Sub-IF Type
of Ports Number

AoC25 8 C0 - C7 0,…,7 Client • STM1/OC3 • ODUslot

• STM1e/ • ODUslot
OC3e • ODUslot
• STM4/OC12 • ODUslot
• FC100 • ODUSlot
• ETY1G • ODUSlot
• ETY1Ge • ODU1
• STM16/ • ODU1
OC48
• FC200

8 C8 - C15 8,…,15 Client OTU1 ODU1

AoC25B 8 C0 - C7 0,…,7 Client • STM1/OC3 • ODU0

• STM1e/ • ODU0
OC3e • ODU0
• STM4/OC12 • ODU0
• FC100 • ODU0
• ETY1G • ODU0
• ETY1Ge • ODU0
• VIDEO270 • ODU1
• STM16/ • ODU1
OC48 • ODU1
• FC200
• HDSDI1485

8 C8 - C15 8,…,15 Client OTU1 ODU1(PT20)

Note
To define the port configuration for an AoC25/AoC25B card, see Configure Ports.

CMR40B
The CMR40B is a multiservice combiner card that supports 4 x 10G LAN/STM-64/OC-192/OTU2/OTU2e
aggregation to OTU-3e. It enjoys enhanced noise tolerance with improved chromatic dispersion tolerance,
and offers good bandwidth efficiency. It reduces the number of frequencies, increases capacity, and
simplifies management, and can be used in both metro/core and long-haul networks.
The CMR40B uses a coherent receiver and DP-DQPSK modulation format. The client side utilizes XFPs for
10G interfaces.
For more information about the CMR40B card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 174

 Cards and Modules

CMR40B card - port configuration rules

Number Port Label Port Port Role Port Type Sub-IF Type
of Ports Number

4 C1 - C4 0,1,2,3 Client • STM64 • ODU2

• OC192 • ODU2
• ETY10GO • ODU2e
C • ODU2 or ODUF-FC800
• FC800 • ODU2e
• FC1200 • ODU2
• OTU2 • ODU2e
• OTU2e

1 Line 4 Line OTU3e ODU3e(PT21) +

4 * ODU2/ODU2e/ODUF-
FC800

Note
To define the port configuration for a CMR40B card, see Configure Ports.

CMR100-CMR100L
The CMR100/CMR100L combiner (muxponder) interfaces to any combination of ten of the following client
signals through XFPs, and maps them into a 100 Gbps colored line signal for WDM network transport,
according to the G.709 standard: 10GbE/STM64/OC192/FC8/FC10/OTU2/OTU2e. It occupies a double slot
in Apollo platforms.
The CMR100/CMR100L uses DP-QPSK modulation, a coherent receiver, DSP processing, and soft decision
forward error correction, for superior noise tolerance, and an exceptional ability to mitigate CD and PMD
impairments.
The CMR100 is optimized for Ultra Long Haul networking applications, and the CMR100L supports regional
applications. While the TR100L does not support single fiber bi-directional WDM operation, in terms of all
other capabilities, the cards are identical and they are interoperable with each other. The client side utilizes
XFPs for 10G interfaces.
For more information about the CMR100/CMR100L card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 175

 Cards and Modules

CMR100/CMR100L card - port configuration rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

10 C1 - C10 1,2,3,…,10 Client • STM64 • ODU2

• OC192 • ODU2
• ETY10GOC • ODU2e
• FC800 • ODUF-FC800
• FC1200 • ODU2e
• OTU2 • ODU2
• OTU2e • ODU2e

1 Line 0 Line OTU4 ODU4 (PT21)+

10 * ODU2/
ODU2e

Note
To define the port configuration for a CMR100/CMR100L card, see Configure Ports.

CMR100M
The CMR100M is a combiner card that interfaces to any combination of ten of the following client signals
through SFP+, and maps them into a 100 Gbps colored line signal for WDM network transport, according to
the G.709 standard: 10GbE/STM64/40GbE. It occupies a double slot in the Apollo platforms.
The CMR100M is optimized for metro applications (up to 1200 km without regeneration). The client side
utilizes SFP+ transceivers for 10G interfaces. The card supports 10-BASE-T SFP+ electrical pluggable
transceivers.
The CMR100M uses a CFP based on DP-QPSK modulation, a coherent receiver, DSP processing, and soft
decision forward error correction, for superior noise tolerance, and an exceptional ability to mitigate CD and
PMD impairments.
In addition, the CMR100M line can be deployed with non-colored CFP (instead the coherent CFP) for simple
point to point over dark fiber or any other application. The card supports SR10 or LR4 100G line
transmission.
For more information about the CMR100M card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 176

 Cards and Modules

CMR100M card - port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

12 C1-C12 1,2,3,...,12 Client • STM64 • ODU2

• OC192 • ODU2
• ETY10GO • ODU2e
C • ODUF-FC800
• FC800 • ODU2e
• FC1200 • ODU2
• OTU2 • ODU2e
• OTU2e • ODU3
• ETY40G • ODU2e
• ET10GOC
E

1 Line 0 Line OTU4 ODU4 (PT21) +

10* ODU2/ODU2e/
ODUF_FC800

Note
To define the port configuration for a CMR100M card, see Configure Ports.

OPT96xx Common Cards and Modules

The following cards and modules provide common functionality for OPT96xx shelf type:
• RCP03A: An upgrade of RCP03 as the main controller of the OPT9603 shelf.
New upgrades are included in RCP03A:
◦ a new L3 switch as old device (98DX3133).
◦ SSD M.2 (16GB) SD as old SD card (8G).
• RCP08A: Replaces the current RCP08_O, RCP1_4 (HC RCP) and RCP08_D cards.
New upgrades are included in RCP08A:
◦ a new L3 switch as old device (98DX3135-L3 and 98DX160-L2).
◦ SSD M.2 (16GB) SD as old SD card (8G).
• RCP08D: An RCP card optimized for pure optical DWDM applications. Two RCP modules are
installed in an OPT9608D platform for redundancy.
• PFM08D_AC: Converts AC input voltage (110/220V 50/60Hz) to operating voltage (54Vdc) used by all
the cards in the shelf. The card supplies ~1450W to the shelf when connected to 110Vac
and ~3000W when connected to 220Vac. Each OPT9608D platform should have two PFM08D_AC
units installed, for power redundancy, with each PFM card ideally connected to a different power
source. When necessary, a single card can provide the total power required by the OPT9608D.
• PFM08D_DC: A DC power feed module that takes a 48 VDC power feed input and distributes power
to all cards in the platform, providing up to 2400 W. The OPT9608D platforms work with two PFM
modules configured in a load sharing protection scheme. In case of failure, a single working module
can provide the maximum system power feed until the failed module can be replaced.
• FCM08D: Two FCM08D fan control modules are installed at the rear of the OPT9608D platform and
are responsible for platform ventilation and cooling. Each FCM08D module includes 5 fans; the
OPT9608D is protected by a total of 10 fans for secure resiliency. In case one or more of the fans
fails, the rest of the fans in both modules move to turbo mode to compensate. Air is drawn in by the
fans from the front of the chassis and pumped out to the rear of the chassis.

Ribbon Communications Inc. Proprietary 177

 Cards and Modules

• MIM08D: The OPT9608D platform works with a MIM08D alarm and management control module that
controls alarm and management interfaces.
For more information about the OPT9608D common cards and modules, see the Apollo Reference Manual.

CMR200
The CMR200 is a 100G/200G muxponder supporting:
• Up to 20 x STM-64/10GE/OTU2/2e clients
or
• Up to 10 x STM-64/10GE/OTU2/2e clients + 1 x 100GE client
The CMR200 is optimized for metro and regional/long haul applications. The client side utilizes SFP+
transceivers for the 10G interfaces, and one QSFP28 transceiver for the 100G interface. The line interface
supports OTR100P2_CFO, OTR200P2_CFO, OTR200P2_CFA2, and OTR200P2_CFA2BD transceivers.
This double-slot card, which can be mixed with other service or photonic cards, can be installed in Apollo
96xx platforms.
The CMR200 multiplexes services into 100G and/or 200G coherent lines based on D-CFP2 coherent
technology, supporting a wide range of rates with different modulations and Flex-Grid capabilities. This
transceiver includes a coherent receiver, DSP processing, built-in OSNR measurements, and soft decision
forward error correction, for superior noise tolerance, as well as an exceptional ability to mitigate CD and
PMD impairments.
The CMR200 offers the following working mode options:
• TM200 - 1 x 100 GbE QSFP28 and 10 x 10 GbE SFP+ based client interface ports, with 200G DCO
• CMR200 - 10 x 10 GbE SFP+ based client interface ports, with 100G DCO
• CMR200 - Up to 20 x 10 GbE based SFP+ client interface ports, with 200G DCO
In the 10x10G + 100G working mode, only client ports 1 (for 100G) and client ports 12-21 (for 10G) are
active.
In 10x10G working mode, only client ports 2-11 are active.
For each working mode a specific set of client types are assigned. To change the working mode of CMR200,
you must re-assign the card for the required mode.
For more information about the CMR200 card, see the Apollo Reference Manual.

CMR200 Card - Port Configuration Rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

1 Line 1 Line • OTU4 ODU4

• ETY100G

20 C2-C21 2-21 Client • ETY10G • ODU2e

OC • ODU2
• ETY10G • ODU2e
• ETY10G • ODU2
OCe • ODU2
• STM64 • ODU2
• OC192 • ODU2e
• OTU2
• OTU2e

Ribbon Communications Inc. Proprietary 178

 Cards and Modules

To define the port configuration for a CMR200 card, see Configure Ports.

OPT96xx Fabric Interface Cards

OPT96xx supports the following layer 1 fabric interface cards:
• FIO10_5-FIO10_5B
• FIOMR_16-FIOMR_16B
• FIO100
• FIO100M

Note
For detailed descriptions of the supported fabric interface cards, see the Apollo Reference Manual.

FIO10_5-FIO10_5B
The FIO10_5/FIO10_5B is a fabric interface I/O card that supports up to five 10G interfaces using fixed or
tunable pluggable XFP transceivers. Each port can be configured to serve as either client or line interface
port. Client interface ports accept 10G LAN, STM-64, FC8, OTU-2, or OTU-2e signals. Client signals are
mapped to ODU-2 or ODU-2e (G.709) and cross connected through the central universal fabric to the line
side.
The FIO10_5B card does not support FC ports (e.g. FC800, FC1200).
For more information about the FIO10_5/FIO10_5B card, see the Apollo Reference Manual.

FIO10_5/FIO10_5B card - port configuration rules

Card Number Port Port Port Role Port Type Sub-IF Type
of Ports Label Number

FIO10_5 5 P0 - P4 0,…,4 Client/Line • STM64 • ODU2

• OC192 • ODU2
• FC800 • ODU2
• FC1200 • ODU2e
(day2) • ODU2
• ETY10G • ODU2e
• ETY10GO • ODU2
C • ODU2e
• OTU2
• OTU2e

FIO10_5B 5 P0 - P4 0,…,4 Client/Line • STM64 • ODU2

• OC192 • ODU2
• ETY10G • ODU2
• ETY10GO • ODU2e
C • ODU2(PT2
• OTU2 1)
• OTU2e • ODU2e

Ribbon Communications Inc. Proprietary 179

 Cards and Modules

Note
To define the port configuration for an FIO10_5 card, see Configure Ports.

FIOMR_16-FIOMR_16B
The FIOMR_16/FIOMR_16B card is a fabric interface I/O card that supports up to 16 low-rate client
interfaces using SFP transceivers. Each port can be configured to STM-1, STM-4, GbE, FC1/FC2/FC4,
OTU-1, STM-16, DVB-ASI, SDI, and HD-SDI signals. Client-side signals are mapped to G.709 ODU-k and
cross connected through the central universal fabric to the egress side.
The FIOMR_16B card does not support FC ports (e.g. FC100, FC200) or Video ports (e.g. VIDEO270).
For more information about the FIOMR_16/FIOMR_16B card, see the Apollo Reference Manual.

FIOMR_16/FIOMR_16B card - port configuration rules

Card Number Port Port Port Role Port Type Sub-IF Type
of Ports Label Number

FIOMR_16 16 P0,…,P15 0,…,15 Client/Line • STM1/OC3 • ODUslot

• STM1e/ • ODUslot
OC3e • ODUslot
• STM4/ • ODUslot
OC12 • ODUslot
• FC100 • ODUslot
• ETY1G • ODUslot
• ETY1Ge • ODU1
• VIDEO270 • ODU1
• STM16/ • ODU1
OC48 • ODU1
• FC200 • 2*ODU1
• HDSDI148
5
• OTU1
• FC400

FIOMR_16B 16 P0,…,P15 0,…,15 Client/Line • STM1/OC3 • ODU0

• STM1e/ • ODU0
OC3e • ODU0
• STM4/ • ODU0
OC12 • ODU0
• ETY1G • ODU1
• ETY1Ge • ODU1(PT20
• STM16/ )
OC48
• OTU1

Note
To define the port configuration for an FIOMR_16 card, see Configure Ports.

Ribbon Communications Inc. Proprietary 180

 Cards and Modules

FIO100
The FIO100 card is an OTU4v uplink for the 1Tbps universal fabric of the OPT9624 platform. The 100G
OTU-4 is terminated to its tributary signals (ODUk) and cross connected through the fabric to the egress
side.
For more information about the FIO100, see the Apollo Reference Manual.

FIO100 card - port configuration rules

Number of Ports Port Label Port Number Port Role Port Type Sub-IF Type

1 Line 0 Line OTU4 ODU4 (PT21)

Note
To define the port configuration for an FIO100 card, see Configure Ports.

FIO100M
The FIO100M card is an OTU4 uplink for the 1 Tbps universal fabric of the OPT9624 platform. The 100G
OTU-4 is terminated to its tributary signals (ODUk) and cross connected through the fabric to the egress
side.

Note
The FIO100M is supported only in the 9600 Apollo platform when the FM1000 1 Tbps universal fabric
is also installed.

For more information about the FIO100M, see the Apollo Reference Manual.

FIO100M card - port configuration rules

Number of Ports Port Label Port Number Port Role Port Type Sub-IF Type

1 Line 0 Line OTU4 ODU4 (PT21)

Note
To define the port configuration for an FIO100M card, see Configure Ports.

OPT96xx Layer 2 Cards

Layer 2 cards in Apollo support both black and white and colored (C/DWDM) line/clients, with optional
bidirectional functionality. Services on these cards can be configured independently to work with no
protection or full equipment protection. The cards support GFEC, EFEC (I.4), and no FEC modes towards
the line. The service cards interface smoothly with alien client transceivers as well.
Apollo service cards comply with ITU-T standards for 50GHz and 100GHz multichannel spacing (DWDM)
using fixed or tunable XFP transceivers. They support PM and GCC in-band management, with Ethernet and
MPLS-TP PM.

Ribbon Communications Inc. Proprietary 181

 Cards and Modules

Apollo currently supports the AoC10_L2 layer 2 card.

See also:
• AoC10_L2
• AoC10_L2 Port Configuration
• AoC10_L2 Switch Configuration

AoC10_L2
The AoC10_L2 is an MPLS service card that supports an advanced Ethernet-based metro-core layer,
enabling NG Ethernet applications such as triple play, VPLS business connectivity, 3G Ethernet-based
aggregation, and CoC bandwidth applications. The AoC10_L2 cards provides complete PB (QinQ) and
MPLS switching functionality, offering scalability and smooth interoperability with IP/MPLS core routers.
The AoC10_L2 supports full interoperability with data cards in the NPT, XDM, and BroadGate platforms, as
well as seamless interfacing with external third-party hardware.
You can configure Fast IOP protection for AoC10_L2 cards. See Fast IOP protection (L2 ports).
For more information about the AoC10_L2 card, see the Apollo Reference Manual.

AoC10_L2 Port Configuration

AoC10_L2 card - port configuration rules

Number of Ports Port Label Port Number Port Type

16 P0,…,P15 0,…,15 GE

4 P16,…,P19 16,…,19 • GE10

• GE10-OTU2E

2 P20,P21 20,21 GE10

During port configuration of an AoC10_L2 card, you must define the Port Mode for each port to one of the
following:
• UNI (default)
• I-NNI
• E-NNI
• MoE
• I-MOE
• Mirror
The Port Mode for ports 20 and 21 can only be set to I-MOE.

Note
To define the port configuration for an AoC10_L2 card, see Configuring Ports.

See also:
• Configure L2 Port Parameters: AoC10_L2
• Configure MPLS Port Parameters: AoC10_L2
• Configure Link OAM for a Port: AoC10_L2

Ribbon Communications Inc. Proprietary 182

 Cards and Modules

• Configure a LAG: AoC10_L2

Configure L2 Port Parameters: AoC10_L2

You can configure the L2 parameters for a port.
Start
1. In the Network Explorer tab, right-click the relevant port and select Properties.
The port properties appear in the right pane.
2. In the Properties tab, select the L2 Parameters tab.
The L2 parameters appear.

3. Define the parameters as required and click Apply.

The parameters displayed depend on the Port Mode defined for the port. See the following table.

Ribbon Communications Inc. Proprietary 183

 Cards and Modules

L2 Parameters

Parameter Description Port Mode

Ethernet Attribute

LLCF Trigger Enables the port to be an LLCF trigger UNI, E-NNI

LLCF Client Enables the port to be an LLCF client UNI, E-NNI

Max Packet Length The maximum packet length allowed for the All modes
port

MAC Filter Defines whether the reserved MAC address is UNI, E-NNI, MIRROR
filtered or not

Scheduling Mode For future versions UNI, E-NNI, MIRROR

UNI Attributes

Untagged Frame Handling The method used for frame handling: Priority UNI
Tagged, Forward, PVID, Block, and None

PVID The C-VLAN ID assigned to untagged frames UNI

received on this port (PVID translation)

Default CD Priority The default priority for untagged or priority- UNI

tagged frames

Ingress Policer Attributes

Ingress Policer State The Ingress policer state: Policing, or NRL UNI, E-NNI
(No Rate Limit)

Ingress Policer Profile The Ingress policer profile UNI, E-NNI

Egress Policer Attributes

Egress Policer State The Egress policer state: Policing, or NRL UNI, E-NNI
(No Rate Limit)

Egress Policer Profile The Egress policer profile UNI, E-NNI

Configure MPLS Port Parameters: AoC10_L2

You can define MPLS parameters for MOE and iMOE ports.

Ribbon Communications Inc. Proprietary 184

 Cards and Modules

Start
1. In the Network Explorer tab, right-click the relevant port and select Properties.
The port properties appear in the right pane.
2. In the Properties tab, select one of the following:
◦ MPLS tab - to define MPLS parameters.

◦ MPLS Status tab - to view MPLS status parameters (read-only).

3. In the MPLS tab, define the parameters as required and click Apply. See the following table.

Ribbon Communications Inc. Proprietary 185

 Cards and Modules

MPLS Port Parameters

Parameter Description

Tunnel Capacity Mode The tunnel capacity mode: Normal mode or Extended mode.

Next Hop MAC Address The destination port's MAC address

Severity Profile The severity profile assigned to the port protection group (if port
protection is defined). The default value is default.

Alarm Master Mask Enables or disables the alarm master mask. Enabling it causes all
alarms for the port protection group to be masked. Disabled by
default.

DiffServ Block Read-only. Shows DiffServ block attributes for an MOE port (for
tunnels on which DiffServ is enabled).

MoE Attributes

In Exp Mapping Read-only. Shows the mapping of EXP bits from incoming MPLS
packets. Each incoming EXP bit is mapped to a specific CoS and
color.

Out Exp Mapping Read-only. Shows the mapping of EXP bits from outgoing MPLS
packets. A specific CoS and color is mapped to each outgoing EXP
bit.

Configure Link OAM for a Port: AoC10_L2

Configuring Link Operation, Administration, and Maintenance (OAM) enables you to monitor a link for critical
events. You can also set the remote device to Loopback mode in order to perform testing on the link.
Start
1. In the Network Explorer tab, right-click the relevant port and select Properties.
The port properties appear in the right pane.
2. In the Properties tab, select the Link OAM Configuration tab.
The Link OAM parameters appear.

Ribbon Communications Inc. Proprietary 186

 Cards and Modules

3. Select the Enable OAM checkbox.

4. Define the Local Mode and Remote Mode.
5. To set the remote device to Loopback mode, select the Loopback checkbox.

Configure a LAG: AoC10_L2

Two or more links can be aggregated together to form a Link Aggregation Group (LAG). A LAG is treated by
MAC clients as a single link. This section describes how to configure a LAG.
Start
1. In the Network Explorer tab, right-click the AoC10_L2 card and select Show LAG.
The LAG window opens.

Ribbon Communications Inc. Proprietary 187

 Cards and Modules

2. Select and transfer two ports or more (with the same type and port mode) from the Individual Port
List to the right pane.

3. Define the LAG parameters. See the table below.

4. Click Apply.
The LAG is created.
5. To view the LAG details, select it from the Aggregation Group dropdown list and click Get.

Ribbon Communications Inc. Proprietary 188

 Cards and Modules

Notes
◦ To create a new LAG port from this view, click New. The details of the selected LAG port
are cleared.
◦ To delete a LAG, click Delete.

LAG parameters

Parameter Description

Master Port Defines the master port.

Distribution Enables/disables distribution for the port.

Protection Type Currently only Load Sharing is available. (Read-only)

LACP Enable Enables/disables LACP for the port.

• If LACP is Disabled, LACPDU will not be sent/received.
• If LACP is Enabled, LACPDU will be sent/received based on LACP
Mode.

LACP Mode Defines the LACP mode for the port as one of the following:
• Active: LACPDU will be sent/received.
• Passive: LACPDU will be sent/received only if the partner's LACP
Mode is Active (the partner sends LACPDUs).

Actor Port Priority Defines the port priority (higher value= lower priority).

LACPDU Timeout Defines the LACPDU time interval:

• Short = 1 second
• Long = 30 seconds

LAG Link Down Threshold Defines how many failed LAG member ports (including the master and
slaves) are considered Link Down.

Alarm Master Mask The alarm master mask.

PM Monitor Enables/disables PM monitoring for the LAG.

Mac Address The MAC address automatically associated with the LAG. (Read-only)

Severity Profile The severity profile.

AoC10_L2 Switch Configuration

The following AoC10_L2 switch configuration operations are available:

Ribbon Communications Inc. Proprietary 189

 Cards and Modules

• Configure General Switch Parameters: AoC10_L2

• Configure RSTP: AoC10_L2
• Manage Switch Policer Profiles: AoC10_L2
• Configure Link OAM Thresholds: AoC10_L2
• Configure Port Mirroring: AoC10_L2
• View Host Budget Information: AoC10_L2
• View VSI Configuration: AoC10_L2
• View CE-VLAN and COS Translation for a UNI Port: AoC10_L2
• Configure Egress COS Policing: AoC10_L2
• View PW Redundancy for a VSI: AoC10_L2
• View VSI Alarms: AoC10_L2
• View VSI PM Counters: AoC10_L2
• View Switch PM Counters: AoC10_L2
• View CFM Configuration: AoC10_L2
• View BD Tunnel Configuration: AoC10_L2
• View Tunnel XC Configuration: AoC10_L2

Configure General Switch Parameters: AoC10_L2

This section describes how to configure general switch parameters for the AoC10_L2 card.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Properties.
The switch properties appear in the right pane.

Ribbon Communications Inc. Proprietary 190

 Cards and Modules

2. In the General tab, set the Switching Mode parameter to PB (default) or MPLS-PE and click Apply.
3. Configure the switch parameters and click Apply.
Different parameters must be defined for each switching mode. See the following table.

Ribbon Communications Inc. Proprietary 191

 Cards and Modules

AoC10_L2 General Switch Parameters

Parameter Description

Ethernet (PB) Network ID PB network ID.

MPLS Network ID MPLS network ID.

PE ID Switch ID.

Ethernet MAC Address Ethernet MAC address defined for the network (read-only).

Scheduling Mode Set to Auto by default. (read-only).

FIB

Aging Time Timeout period in seconds for aging out dynamically learned forwarding
information.

Switch Quota Exceeded Action performed if the switch quota is exceeded: Forward (default) or
Action Drop.

PM Monitor Enables or disables performance monitoring.

CFM Domain

CFM Local MEP ID MEP ID of local MEP for all MEGs with configured MEP in which switch
participates.

CFM LTM Flooding • Disable (default): LTM is not forwarded unless the target MAC address
has been learned.
• Enable: LTM is flooded when the target MAC address has not been
learned.

PM

PM Profile PM profile, which contains object thresholds for triggering alarms and
events.

PM Monitor Enables or disables performance monitoring.

CCN

CCN Enable Enables the switch to accept CCN messages.

CCN Forwarding Enables the switch to forward CCN messages.

Ribbon Communications Inc. Proprietary 192

 Cards and Modules

Parameter Description

LACP System Priority Defines the system priority for LACP (higher value = lower priority).
If both systems have the same System Priority, the system with the lowest
LAG MAC address is preferred.

Configure RSTP: AoC10_L2

AoC10_L2 supports RSTP protection mechanisms. RSTP functionality is configured at both the card and port
levels.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Properties.
The switch properties appear in the right pane.
2. Select the RSTP tab.

The RSTP tab displays two tabs:

◦ Switch RSTP: Displays the RSTP configuration settings for the card.
◦ RSTP Ports: Displays the list of ports with RSTP defined for the card. Ports without RSTP do not
appear (MOE and I-MOE).
3. In the Switch RSTP tab, you can define the following RSTP parameters, as required:
◦ Bridge Priority: The RSTP Bridge Priority, which is used with the Bridge's MAC Address. Default:
8192.
◦ Fwd Delay: The time that the bridge stays in each of the Listening and Learning states that
precede the Forwarding State. Default: 15 sec.

Ribbon Communications Inc. Proprietary 193

 Cards and Modules

When a topology change is underway and has been detected, this parameter is also used to age
all dynamic entries in the Forwarding database.
◦ Max Age: The time that learned Spanning Tree information is kept before being discarded. Default:
20 sec.
◦ Hello Time: The time interval between the generation of Configuration BPDUs by the Root.
Default: 2sec.
◦ Notification Enable: Enables or disables RSTP notifications. Enabled by default.
◦ BPDU Frame Format: Type of BPDU frame format. Default: Standard-BPDU-B.
◦ Tx Hold Count: Time interval in which no more than two configuration BPDU frames are
transmitted.
The rest of the parameters are read-only.
4. In the RSTP Ports tab, you can define the following RSTP port parameters, as required:
◦ RSTP Enabled: Defines whether RSTP is enabled for the port
◦ BPDU PA: BPDU MAC DA used by RSTP
◦ Port Priority: Priority of RSTP port
◦ Admin Edge: Defines the initial port state when the port is enabled
The rest of the parameters are read-only.
5. Click Apply to save your changes.

Manage Switch Policer Profiles: AoC10_L2

This section describes how to manage switch policer profiles defined for the AoC10_L2 card.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Properties.
The switch properties appear in the right pane.
2. Select the Policer Profiles tab.
The list of Policer Profiles appears.

3. To create a Policer Profile, click Create.

The Create Policer Profile window opens.

4. Type the Policer Profile name and define the following fields:

Ribbon Communications Inc. Proprietary 194

 Cards and Modules

◦ CIR: Committed Information Rate

◦ CBS: Committed Burst Size
◦ EIR: Excess Information Rate
◦ EBS: Excess Burst Size
◦ CM: Coupling Flag
5. Click Create.
The new policer profile is created and appears in the list of policer profiles.

Configure Link OAM Thresholds: AoC10_L2

You can define link OAM thresholds.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Properties.
The switch properties appear in the right pane.
2. Select the Link OAM Threshold tab.
The ports and their default thresholds appear.

3. Modify the thresholds as required and click Apply.

Configure Port Mirroring: AoC10_L2

Port mirroring is a method of monitoring network traffic. A copy of each incoming and outgoing packet from
one port of a network switch is forwarded to another port, from where the packet can be studied. Port
mirroring can be used for diagnostics or debugging.
You can configure port mirroring by defining a source port from which to copy all packets, and a destination
(mirror) port to which those packets are sent. The Port Mode for the destination port must be defined as
MIRROR during port configuration.
There can only be one source port and two mirror ports (Ingress & Egress) per switch. The mirror port can
also be a single port, configured as both Ingress and Egress mirror ports.
This section describes how to configure port mirroring.
Start

Ribbon Communications Inc. Proprietary 195

 Cards and Modules

1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Properties.
The switch properties appear in the right pane.
2. Select the Port Mirror tab.
The Port mirroring parameters appear.

3. For Source Port, select the source port from the dropdown list.
4. For Mirror Ingress traffic to, select the mirror port to which Ingress traffic will be copied.
5. For Mirror Egress traffic to, select the mirror port to which Egress traffic will be copied.
6. Click Configure.
Port mirroring is configured.

View Host Budget Information: AoC10_L2

On the AoC10-L2 card, the host CPU is responsible for receiving and transmitting control packets, as well as
for handling state machines for all the configured control protocol instances. Host budget management is
required to ensure that the host CPU can perform these processes. This section describes how to view host
budget information.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Properties.
The switch properties appear in the right pane.
2. Select the Host Budget tab.
The host budget information appears.

Ribbon Communications Inc. Proprietary 196

 Cards and Modules

The host budget information includes the following:

◦ Utilized control packet budget: The amount of utilized managed resources in the managed
resources pool
◦ Available control packet budget: The amount of available managed resources in the managed
resources pool
◦ BFD current session number: The current BFD session Number
◦ BFD maximum session number: The maximum BFD Session Number

View VSI Configuration: AoC10_L2

You can view the configuration of a VSI.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
The list of defined VSIs appears in the VSI List tab. You can filter the list using the Filter options.

2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens, displaying the configuration details. The information that appears in this
window changes according to the VSI type and configuration. See the table below for a description of
the available tabs.
Most of the parameters in the VSI window are configured from LightSOFT and are read-only. For more
information, see the LightSOFT User Guide.

Ribbon Communications Inc. Proprietary 197

 Cards and Modules

Tabs in the VSI window

Tab Description

VSI Definitions Displays the VSI definitions. It also enables you to view Egress CE-VLAN and
COS translation for UNI ports on the VSI, as well as configure Egress COS
policing. See View CE-VLAN and COS Translation for a UNI Port and Configure
Egress COS Policing.

PW Redundancy Displays the Pseudowire (PW) redundancy configuration for the VSI. See View
PW Redundancy for a VSI.

Alarms Displays alarms for the VSI. See View VSI Alarms.

PM Counters Displays PM counters for the VSI. See View VSI PM Counters.

View CE-VLAN and COS Translation for a UNI Port: AoC10_L2

You can view the CE-VLAN and COS translation for a UNI port on a VSI.
Start

Ribbon Communications Inc. Proprietary 198

 Cards and Modules

1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
The list of defined VSIs appears in the VSI List tab.
2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens.

3. In the VSI Definitions tab, click next to the relevant UNI port row in the table.
The row expands to display the CE-VLAN and COS translation details for the port.

Ribbon Communications Inc. Proprietary 199

 Cards and Modules

Configure Egress COS Policing: AoC10_L2

You can configure Egress COS policing.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
The list of defined VSIs appears in the VSI List tab.
2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens.
3. In the VSI Definitions tab, click next to the relevant UNI port row in the table.
The row expands to display the CE-VLAN and COS translation details for the port.
4. Scroll down to view the Egress Cos Policer pane.

5. Do one of the following:

◦ Define the policing settings for the COSs by selecting the checkbox in the relevant COS columns
and selecting the State and Profile settings.
◦ Define the same policing setting for all COSs by selecting Policing All CoSs and selecting the
state from the dropdown list.

Ribbon Communications Inc. Proprietary 200

 Cards and Modules

6. Click Apply to save the settings.

View PW Redundancy for a VSI: AoC10_L2

You can view the PW redundancy configuration for a VSI.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
The list of defined VSIs appears in the VSI List tab.
2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens.
3. Select the PW Redundancy tab.
The PW Redundancy List displays PW redundancy objects defined for the VSI.
4. Select the relevant PW redundancy object.
The PW redundancy object details appear in the Properties tab (below the PW Redundancy List).

5. To view PM counters for the object, select the PM Counters tab and define the settings for the
counters to be displayed.
6. To view which maintenance commands are running on the object, select the Commands tab.

View VSI Alarms: AoC10_L2

You can view the alarms for a VSI.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
The list of defined VSIs appears in the VSI List tab.
2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens.

Ribbon Communications Inc. Proprietary 201

 Cards and Modules

3. Select the Alarms tab.

The current alarms appear in the Current Alarms tab.
4. To view non-reported alarms, select the Non Reported Alarms tab.

View VSI PM Counters: AoC10_L2

You can view the PM counters for a VSI.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
The list of defined VSIs appears in the VSI List tab.
2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens.
3. Select the PM Counters tab.
The current PM counters appear.
You can select the time interval (Duration) of the counters to be displayed, as well as the time period
in which the list is refreshed (Refresh in).
4. To view historical PM counters:
◦ Select Historic Counters.
◦ Define the time period
◦ Click Apply.
The historical PM counters from the defined time period appear.
5. To view policer PM counters:
◦ Select the Policer PM Counters tab.
◦ Select the port and policer from the dropdown lists.
◦ Click Get PM Counters.
The policer PM counters appear.

View Switch PM Counters: AoC10_L2

You can view the PM counters for the switch.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Properties.
The switch properties appear in the right pane.

Ribbon Communications Inc. Proprietary 202

 Cards and Modules

2. Select the PM Counters tab.

3. Select the Bridge PM Counters or FDB PM Counters tab.

4. For Duration, select the time interval of the counters to be displayed.
5. For PM Counters, select Current Counters or Historic Counters.
◦ For current counters, you can define the Refresh in setting as required.
◦ For historic counters, define the time period for the counters.
6. For Modes, select if you want the values shown in Octets or Mbps.
7. Click Apply.
The counters appear in the list.

Note
If you export the report, the values are always shown on Octets irrespective of your settings on this
page. This also applies to scheduled reports.

View CFM Configuration: AoC10_L2

You can view the CFM configuration for a VSI.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
The list of defined VSIs appears in the VSI List tab. You can filter the list using the Filter options.
2. Right-click the relevant VSI in the list and select CFM MA List.
The CFM MA List window opens, displaying the CFM configuration details. All parameters in this
window are read-only.

Ribbon Communications Inc. Proprietary 203

 Cards and Modules

Notes
◦ To view the DM and SLM configuration of the CFM, select the DM and SLM tabs in the
MA Parameters tab.
◦ To view the DM and SLM configuration of the Remote MEP, select the DM and SLM tabs
in the Remote MEP tab.

View BD Tunnel Configuration: AoC10_L2

You can view the configuration of a BD tunnel.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
2. Select the BD Tunnel List tab.
The list of defined BD tunnels appears. You can filter the list using the Filter options.

Ribbon Communications Inc. Proprietary 204

 Cards and Modules

3. Right-click the relevant BD tunnel in the list and select BD Tunnel Properties.
The BD Tunnel window opens, displaying the configuration details. All parameters in this window are
read-only.

View Tunnel XC Configuration: AoC10_L2

You can view the configuration of a tunnel XC.
Start
1. In the Network Explorer tab, right-click the switch element below the AoC10_L2 card and select
Services.
2. Select the Tunnel XC List tab.
The list of defined tunnel XCs appears. You can filter the list using the Filter options.

Ribbon Communications Inc. Proprietary 205

 Cards and Modules

3. Right-click the relevant tunnel XC in the list and select View Tunnel XC.
A window opens, displaying the tunnel XC configuration details. All parameters in this window are
read-only.

Optical Components
Apollo platforms support a wide range of passive optical cards, including C/DWDM Mux/DeMuxes, OADMs,
splitters/couplers, filters, and Dispersion Compensating Fibers (DCFs). These platforms can be deployed
together with Artemis passive optical platforms (that also include a wide range of similar optical cards),
offering a low cost, high modularity, and very high density solution. This leaves the photonic slots in the
Apollo platforms available for active cards, such as optical amplifiers, ROADMs, service cards, and fabric.
Apollo supports the following optical components:
• Multidegree ROADM Cards
• Mux-DeMux Cards
• OADM Cards
• Optical Filters, Splitters, and Couplers
• Optical Amplifiers
• OTDR
• OTDR_8
• OTDR_30_1625_XFP
• OTDR1610_8s, OTDR1610M_8s, OTDR1625M_8s, OTDR1626_8s

Ribbon Communications Inc. Proprietary 206

 Cards and Modules

• DCF
• OMSP
• OLP_S2

Note
For detailed descriptions of the supported optical components, see the Apollo Reference Manual.

Multidegree ROADM Cards

A comprehensive suite of third-generation WSS ROADM solutions are available, to suit different operator
needs. WSS advanced technology is available for full inter-ring connectivity between access rings and the
metro backbone while providing advanced protection and restoration capabilities. In the current release of
Apollo platforms, ROADM cards are implemented with WSS on the add side.
Apollo supports the following ROADM cards.

Ribbon Communications Inc. Proprietary 207

 Cards and Modules

Supported ROADM Cards

ROADM Card Description

ROADM_2A A 2-degree double slot ROADM card that supports 44 channels with
100 GHz spacing in the C band.

ROADM_2A50 A 2-degree wide double-slot ROADM card that supports 88 channels

with 50 GHz spacing in the C band.

ROADM_4A 4-degree double slot ROADM card that supports 44 channels with 100
GHz spacing in the C band.

ROADM_4A50 A 4-degree double-slot ROADM card that supports Flex-Grid operation

over the extended C-band, and can also be configured for 96/48
channels with 50/100 GHz spacing.

ROADM_4F A 4-degree double-slot ROADM card that supports Flex-Grid operation

over the extended C-band, and can also be configured for 96/48
channels with 50/100 GHz spacing.

ROADM_4FS A 4-degree single-slot mini-integrated ROADM card that supports Flex-

Grid operation over the extended C-band, and can also be configured
for 96/48 channels with 50/100 GHz spacing. The ROADM_4FS
includes 2 pluggable CFP2 MSA amplifiers (booster and pre-amp), as
well as a built-in OSC.

ROADM_9A50 A 9-degree double-wide slot ROADM card that supports 88 channels

with 50 GHz spacing in the C band.

ROADM_9F A 9-degree double-slot ROADM card that supports 88 channels with

50 GHz spacing in the C band.

ROADM_9FS A 9-degree single-slot ROADM card that supports Flex-Grid operation

over the extended C-band, and can also be configured for 96/48
channels with 50/100 GHz spacing. A noise loading attribute 'Flex-
Noise' is available from V12. Available values are True/False (default is
false).
Only one OTS degree port Flex-Noise can be enabled.

ROADM_9TF A 9-degree double-slot ROADM card, with twin WSS, that supports 96
channels with 50 GHz spacing; HW ready for Flex-Grid in the C band.
There are 2 modes of operation:
• Equalization (Default): Normal (current) operation
• Transparent: In this mode:
◦ Both input and output WSSs create an XC with 0dB
attenuation.
◦ The VOA state-machine is ignored.
◦ The threshold values for low input, LOS and LOC are modified.

Ribbon Communications Inc. Proprietary 208

 Cards and Modules

ROADM Card Description

ROADM_20CF A long double-slot card that has 20 ports with duplex LC connectors,
marked 1 to 20. It can be configured to operate as a ROADM with a
variable number of Degree and Client ports, applicable in four modes:
4x16, 6x14, 8x12, and 10x10).

ROADM_20TF A long double-slot card. In the current release, this card operates as a
Fix-Grid ROADM that supports 88 channels with 50 GHz spacing.
There are 2 modes of operation:
• Equalization (Default): Normal (current) operation
• Transparent: In this mode:
◦ Both input and output WSSs create an XC with 0dB
attenuation.
◦ The VOA state-machine is ignored.
◦ The threshold values for low input, LOS and LOC are modified.

TFA_8 A Tunable Filter Array card that provides the colorless functionality for
the ROADM cards, which enables the operator to control the color of
the drop ports.

ROADM_8x24CDCF A 4-slot (double-wide and double-long) ROADM card with 8 degree

ports and 24 colorless directionless contentionless (CDC) client ports.
The ROADM_8x24CDCF supports Flex-Grid operation over the
extended C-band, and can be configured for 96/48 fixed grid channels
with 50/100 GHz spacing.

You can control the line output power of a specific channel in any of the ROADM cards by configuring a
power offset in the range between -3dB to +12dB in steps of 1dB.
You can configure Ptarget Reduction with values from 0-3dB in steps of 0.5dB (default 0dB) on the line port
of the following cards:
• ROADM_9F
• ROADM_9FS
• ROADM_4F
• ROADM_4FS
• ROADM_9TF
• ROADM_20TF
For detailed descriptions of the supported ROADM cards, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 209

 Cards and Modules

ROADM Cards - Port Configuration Rules

Card Number of Port Label Port Number Port Role Port Type
Ports

ROADM_2A 1 Line 0 Line OTS

1 Local 1 Local

1 Express 2 Express

ROADM_2A50 1 Line 0 Line OTS

1 Local 1 Local

1 Express 2 Express

ROADM_4A 1 Line 0 Line OTS

1 Local/Deg1 1 Local

3 Deg2-Deg4 2,…,4 Degree

ROADM_4A50 1 Line 0 Line OTS

1 Local/Deg1 1 Local

3 Deg2-Deg4 2,…,4 Degree

ROADM_4F 1 Line 0 Line OTS

1 Local/Deg1 1 Local OTS

3 Deg2-Deg4 2,…,4 Degree OTS or OCHP

ROADM_4FS 1 Line 0 Line OTS

4 Deg1-Deg4 1,...,4 Degree OTS or OCHP

1 OSC100M 5 OSC100M OSC100M

1 Pre-amp Amp- 11 Pre-amp OTS

in Amp-in

Ribbon Communications Inc. Proprietary 210

 Cards and Modules

Card Number of Port Label Port Number Port Role Port Type
Ports

1 Pre-amp Amp- 12 Pre-amp OTS

out Amp-out

1 OSC-1510 out 13 OSC-1510 OSChannel

out

1 Booster Amp- 21 Booster OTS

in Amp-in

1 Booster Amp- 22 Booster OTS

out Amp-out

1 OSC-1510 in 23 OSC-1510 in OSChannel

ROADM_9A50 1 Line 0 Line OTS

1 Local/Deg1 1 Local

8 Deg2-Deg9 2,…,9 Degree

ROADM_9F 1 Line 0 Line OTS

9 Deg1-Deg9 1,…,9 Degree OTS or OCHP

ROADM_9FS 1 Line 0 Line OTS

9 Deg1-Deg9 1,…,9 Degree OTS or OCHP

ROADM_9TF 1 Line 0 Line OTS

9 Deg1-Deg9 1,…,9 Degree OTS or OCHP

ROADM_20CF_ 4 Deg1-Deg4 1,…,4 Degree OTS

4x16
16 C5-C20 5,…,20 Client OTS or OCHP

ROADM_20CF_ 6 Deg1-Deg6 1,…6 Degree OTS

6x14
14 C7-C20 7,…20 Client OTS or OCHP

Ribbon Communications Inc. Proprietary 211

 Cards and Modules

Card Number of Port Label Port Number Port Role Port Type
Ports

ROADM_20CF_ 8 Deg1-Deg8 1,…8 Degree OTS

8x12
12 C9-C20 9,…20 Client OTS or OCHP

ROADM_20CF_ 10 Deg1-Deg10 1,…10 Degree OTS

10x10

10 C11-C20 11,…20 Client OTS or OCHP

ROADM_20TF 1 Line 0 Line OTS

20 Deg1-Deg20 1,...20 Degree OTS or OCHP

TFA_8 1 Line 0 Line OTS

8 P1, P2…, P8 1,…,8 Add/Drop OCHP

ROADM_8x24C 8 Deg1-Deg8 1,...,8 Degree OTS

DCF
24 C9-C32 9,...,32 Client OTS or OCHP

Notes
• To define the port configuration for a ROADM card, see Configure Ports.
• The Flex-Noise attribute can be configured for one OTS degree port when using the
ROADM_9FS card that supports Flex-Grid noise loading operation over the extended C-
band.

Mux-DeMux Cards
A range of passive Mux/DeMux cards are available for Apollo platforms. The DWDM Mux/DeMux cards are
based on flat-top technology, enabling back-to-back connectivity with lower attenuation compared to other
technologies. With this configuration, minimal (if any) regeneration is required for the back-to-back Mux/
DeMux connectivity. Mux/DeMux cards are available for DWDM with 8, 16, 44, 48, 88, or 96 channels.
Apollo supports the following Mux/DeMux cards:

Ribbon Communications Inc. Proprietary 212

 Cards and Modules

• MXD8: A DWDM Mux/DeMux card for 8 channels in the C band (Ch. 21-Ch. 28) with 100 GHz spacing
and E/W configuration.
• MXD16: A DWDM Mux/DeMux card for 16 channels in the C band (Ch. 21-Ch. 36) with 100 GHz
spacing and E/W configuration.
• MXD16_AG: A DWDM Mux/DeMux card for 16 channels in the C band (Ch. 21-Ch. 36) with 100 GHz
spacing and E/W configuration. This card can only be hosted on a logical Artemis (Artemis L).
• MXD16_AG_BE: A DWDM Mux/DeMux card for 16 channels in the C band (Ch. 45-Ch. 60) with 100
GHz spacing and E/W configuration. This card is a stand-alone 1/2 U blue zone MXD with an upgrade
port for RED band MXD. The upgrade port has a built in R/B filter that connects to MXD16_AG red
zone MXD and enables 32ch 100GHZ spacing in the C band. This card can only be hosted on a
logical Artemis (Artemis L).
• MXD16_AFT: A DWDM Mux/DeMux card for 16 channels in the C band (Ch. 21-Ch. 36) with 100 GHz
spacing and E/W configuration. This card can only be hosted on a logical Artemis (Artemis L).
• MXD32W_C: A passive 32 C-band channel (150GHz) stand-alone 1U unit installed with 96xx and/or
94xx. It is used for cascading CIM8 140G baud and future 800G ZR signals. MXD32W_C technology
is flat top AWG for C band channels with BW 150GHz.
• MXD44/MXD44_P: A DWDM Mux/DeMux card for 44 channels in the C band (Ch. 17-Ch. 60) with 100
GHz spacing and E/W configuration.
• MXD44E: Provides a cost-effective solution to support 88-channel networks. The solution is based on
two 44-Channel Mux/DeMux cards with 100 GHz spacing with channels shifted 50 GHz, relatively to
each other.
• MXD48_P: A DWDM Mux/DeMux shelf for 48 channels in the Extended-C band (Ch. 14-Ch. 61) with
100 GHz spacing and E/W configuration.
• MXD48W_C: A passive 48 C-band channel (100GHz) Mux/Demux stand-alone 1U unit installed with
96xx and/or 94xx. Used to replace current MXD44/MXD48P 100GHz fix grid to enable cascading of
CIM8 90Gbaud and future 800G ZR+WL with improved reach. MXD48W_C technology is flat top
AWG for C band channels with BW 100GHz.
• MXD88/MXD88_P: A DWDM Mux/DeMux card for 88 channels in the C band (Ch. 17-Ch. 60) with 50
GHz spacing and E/W configuration.
• MXD96_P: A DWDM Mux/DeMux shelf for 96 channels in the Extended-C band (Ch. 13.5-Ch. 61) with
50 GHz spacing and E/W configuration.
• CMXD8: A CWDM Mux/DeMux with 8channels (20nm spacing).
• D_MD_40: A DWDM Mux/DeMux card for 40 channels with 100GHz spacing.
• MXD4_B: A Band Mux/DeMux for up to four bands into a transmission fiber. It has 4 Band ports and a
single line port. Each of its four Band ports enables the multiplexing/DeMultiplexing of the 100 Gbps
Band transceivers (OTR100_ER10DR_Bx and OTR100_ZR10DR_Bx).
For detailed descriptions of the supported Mux/DeMux cards, see the Apollo Reference Manual.
The Mux/DeMux card ports are automatically configured upon card assignment. You can view the port
configuration for a Mux/DeMux card from Chassis view (via the Configuration > Artemis Chassis View
menu options).

Ribbon Communications Inc. Proprietary 213

 Cards and Modules

Mux/DeMux Cards - Port Configuration Rules

Card Number of Port Label Port Port Role Port Sub-IF Type
Ports Number Type

MXD8 1 Line 0 Line OTS OMS + 8 *

OCH

8 Ch-21,…,Ch-28 1,…,8 Add/Drop OCHP OCH

MXD16 1 Line 0 Line OTS OMS + 16 *

OCH

16 Ch-21,…,Ch-36 1,…,16 Add/Drop OCHP OCH

MXD16_AG 1 Line 0 Line OTS OMS + 16 *

OCH

16 Ch-21,…,Ch-36 1,…,16 Add/Drop OCHP OCH

MXD16_AG 1 Line 0 Line OTS OMS + 16 *

_BE OCH

16 Ch-45,…,Ch-60 1,…,16 Add/Drop OCHP OCH

1 Ch-36.5 17 Extension OTS OMS

port

MXD16_AF 1 Line 0 Line OTS OMS + 16 *

T OCH

16 Ch-21,…,Ch-36 1,…,16 Add/Drop OCHP OCH

MXD32W_ 1 Line 0 Line OTS OMS + 32 *

C OCH

32 Ch-14,…,Ch-60 1,…,32 Add/Drop OCHP OCH

.5

MXD44/ 1 Line 0 Line OTS OMS + 44 *

MXD44_P OCH

44 Ch-17,…,Ch-60 1,…,44 Add/Drop OCHP OCH

MXD44E 1 Line 0 Line OTS OMS + 88 *

OCH

Ribbon Communications Inc. Proprietary 214

 Cards and Modules

Card Number of Port Label Port Port Role Port Sub-IF Type
Ports Number Type

44 Ch-17,…,Ch-60 1,…,44 Add/Drop OCHP OCH

MXD48_P 1 Line 0 Line OTS OMS + 44 *

OCH

48 Ch-14,15,…,Ch 1,…,48 Add/Drop OCHP OCH

-61

MXD48W_ 1 Line 0 Line OTS OMS + 48 *

C OCH

48 Ch-14,…,Ch-61 1,…,48 Add/Drop OCHP OCH

MXD88/ 1 Line 0 Line OTS OMS + 88 *

MXD88_P OCH

88 Ch-17,…,Ch-60 1,…,88 Add/Drop OCHP OCH

.5

MXD96_P 1 Line 0 Line OTS OMS + 88 *

OCH

96 Ch-13.5, 14, 1,…,96 Add/Drop OCHP OCH

14.5,…,Ch-61

CMXD8 1 Line 0 Line OTS OMS + 8 *

OCH

8 Ch-47 - Ch-61 1,2,…,8 Add/Drop OCHP OCH

1 OSC1310 9 OSC OSChann N/A

el

D_MD_40 1 Line 0 Line OTS OMS + 40 *

OCH

40 Ch-21,…,Ch-60 1,…,40 Add/Drop OCHP OCH

MXD4_B 1 Line 0 Line OTS OMS + 4 *

OCH

4 Band 1,…,4 Add/Drop OCHP OCH

Ribbon Communications Inc. Proprietary 215

 Cards and Modules

OADM Cards
The passive Optical ADM (OADM) cards perform the channel add-and-drop function.
Apollo supports the following OADM cards:
• FOADMx where x stands for 2, 4, or 850:
◦ FOADM2: Fixed OADM with two add/drop channels, for 100GHz spacing networks.
◦ FOADM4: Fixed OADM with four add/drop channels, for 100GHz spacing networks.
◦ FOADM850: Fixed OADM with eight add/drop channels, for 50GHz spacing networks.
• FOADM450 (applied only to FOADM4 actual type): Fixed OADM with four add/drop channels, for 50
GHz spacing networks
• FOADMxFlex where x stands for 2, 4, or 850:
◦ FOADM2Flex: Fixed OADM with two add/drop channels, with flexible spacing networks.
◦ FOADM4Flex: Fixed OADM with four add/drop channels, with flexible spacing networks.
◦ FOADM850Flex: Fixed OADM with eight add/drop channels, with flexible spacing networks.
• COADM4_x: Fixed OADM with four add/drop channels for CWDM networks.
• OADMC4_xx: Passive OADM with four flexible (colorless) add/drop channels, for 100GHz spacing
networks.
• OADMC8_xx: Passive OADM with eight flexible (colorless) add/drop channels, for 100GHz spacing
networks.
OADM card assignment requires defining an additional mandatory attribute, First Channel (see Card
Assignment).
The OADM card ports are automatically configured upon card assignment. You can view the port
configuration for an OADM card from Chassis view (via the Configuration > Artemis Chassis View menu
options).
For detailed descriptions of the supported OADM cards, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 216

 Cards and Modules

OADM Cards - Port Configuration Rules

Card Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

FOADM2_xx 1 Line 0 Line OTS OMS + 48 *

OCH

1 Exp 1 Express OTS OMS + 48 *

OCH

2 Ch-xx - Ch- 2,…,3 Add/Drop OCHP OCH

xx+1

FOADM4_xx 1 Line 0 Line OTS OMS + 48 *

OCH

1 Exp 1 Express OTS OMS + 48 *

OCH

4 Ch-xx - Ch- 2,…,5 Add/Drop OCHP OCH

xx+3

FOADM450 1 Line 0 Line OTS OMS + 48 *

OCH

1 Exp 1 Express OTS OMS + 48 *

OCH

4 Ch-xx, Ch- 2,…,3 Add/Drop OCHP OCH

xx+0.5, Ch-
xx+1,CH-
xx+3

FOADM850_ 1 Line 0 Line OTS OMS + 94 *

xx OCH

1 Exp 1 Express OTS OMS + 94 *

OCH

7 Ch-xx, Ch- 2,…,8 Add/Drop OCHP OCH

xx+0.5, Ch-
xx+1,CH-
xx+3

Ribbon Communications Inc. Proprietary 217

 Cards and Modules

Card Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

FOADM2Fle 1 Line 0 Line OTS OMS + Flex *

x OCH

1 Exp 1 Express OTS OMS + Flex *

OCH

2 Ch-xx - Ch- 2,…,3 Add/Drop OCHP OCH

xx+1

FOADM4Fle 1 Line 0 Line OTS OMS + Flex *

x OCH

1 Exp 1 Express OTS OMS + Flex *

OCH

4 Ch-xx - Ch- 2,…,5 Add/Drop OCHP OCH

xx+3

FOADM850 1 Line 0 Line OTS OMS + Flex *

Flex OCH

1 Exp 1 Express OTS OMS + Flex *

OCH

4 Ch-xx, Ch- 2,…,8 Add/Drop OCHP OCH

xx+0.5, Ch-
xx+1,CH-
xx+3

COADM4_x 1 Line 0 Line OTS OMS + 4 *

OCH

1 Exp 1 Express OTS OMS + 4 *

OCH

4 Ch-xx, Ch- 2,3,4,5 Add/Drop OCHP OCH

yy, Ch-zz,
Ch-tt

OADMC4_xx 1 Line 0 Line OTS OMS + 44 *

OCH

1 Exp 5 Express OTS OMS + 44 *

OCH

Ribbon Communications Inc. Proprietary 218

 Cards and Modules

Card Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

4 Ch-xx, Ch- 1,…,4 Add/Drop OCHP OCH

xx+1, ...,
Ch-xx+3

OADMC8_xx 1 Line 0 Line OTS OMS + 44 *

OCH

1 Exp 9 Express OTS OMS + 44 *

OCH

8 Ch-xx, Ch- 1,…,8 Add/Drop OCHP OCH

xx+1, ...,
Ch-xx+7

Optical Filters, Splitters, and Couplers

Apollo supports the following optical filters, splitters, and couplers:
• CT_1310_2: An optical card that includes two separate CT filters with a 1310 nm OSC port each.
• CT_1510_2: An optical card that includes two separate CT filters with a 1510 nm OSC port each.
• CT_1510-1490: An optical card that includes two separate CT filters of 1510 nm OSC port and a 1490
nm OSC port.
• CT_1510-1490-OTDR: An optical card that includes two separate CT and OTDR filters of 1510 nm
OSC port and a 1490 nm OSC port.
• CT_1590-1511-OTDR: An optical card that includes two separate CT and OTDR filters of 1511.8 nm
OSC port 3 and a 1511.05 nm OSC port 8 with 1590 nm OSC in ports 2 and 7.
• CT_1610: An optical card that includes two separate CT and OTDR filters of 1610.93 nm OSC port 1
and a 1610.8 nm OSC port 3.
• CT_OTDR_2: An optical card that includes two separate CT and OTDR filters with a 1510 nm OSC
port each. The card Muxes/DeMuxes the OTDR signal, C-Band, and OSC signals.
• C_OTDR_2: An optical card that includes two separate CT and OTDR filters each. The card Muxes/
DeMuxes the OTDR signal with the combined C-Band and OSC signals.
• SP_SM_4: A quad splitter/coupler for single mode (SM) fibers with 50% ratio card that includes four
identical splitter/coupler units.
• SP_MM_4: A quad splitter/coupler for multi-mode (MM) fibers with 50% ratio card that includes four
identical splitter/coupler units.
• SP_CE4_2: A double splitter/coupler card for four services with 25% ratio.
• SP_CE8_1: A 1 x 8 splitter/coupler card, used for CDC reception of coherent channels in a mixed
network (network that contains both coherent and non-coherent channels).
• SP_CE16-1: Includes two independent splitter/coupler sections: a 1 x 16 bidirectional splitter/coupler
unit. It is used for CD reception in coherent networks.
• SP_CE32_1: Includes two independent splitter/coupler sections: a 1 x 32 bidirectional splitter/coupler
unit and a 1 x 2 bidirectional splitter/coupler unit. It is used for CDC reception in coherent networks.
• R/B_2: A Red/Blue filter card for use in single-fiber bidirectional network applications (supports up to
16 100Ghz spaced channels).
• R/B_21: A Red/Blue filter card for use in single-fiber bidirectional network applications (supports up to
21 100Ghz spaced channels).
• RB_1510_1590_OTDR_2: A Red/Blue filter card for use in single-fiber bidirectional network
applications (supports up to 21 100Ghz spaced channels). The card includes an OSC filter (1510 and
1590 nm and 1610 nm OTDR filter.

Ribbon Communications Inc. Proprietary 219

 Cards and Modules

• CLT_1510/1590: A CLT filter card for use in bidirectional network applications.

The ports of the optical filters, splitters, and couplers are automatically configured upon card assignment.
For detailed descriptions of the supported optical filters, splitters, and couplers, see the Apollo Reference
Manual.

Ribbon Communications Inc. Proprietary 220

 Cards and Modules

Optical Filters, Splitters, and Couplers - Port Configuration Rules

Component Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

CT_1310_2 4 Line-x, C- 0,13,4 Line OTS OMS

band-x

2 1310-x 25 OSC OSChann N/A

el

CT_1510_2 4 Line-x, C- 0,13,4 Line OTS OMS

band-x

2 1510-x 25 OSC OSChann N/A

el

CT_1510-149 4 Line-x, C- 0,13,4 Line OTS OMS

0 band-x

2 1490-x and 25 OSC OSChann N/A

1510-x el

CT_1510-149 4 Line-x, C- 0,14,5 Line OTS OMS

0-OTDR band-x

2 1490-x and 25 OSC OSChann N/A

1510-x el

2 OTDR 1610 37 OTDR OTDR N/A

Tap Tap

CT_1590-151 4 Line-x, C- 0,15,6 Line OTS OMS

1-OTDR band-x

4 1511.8-x, 2,37,8 OSC OSChann N/A

1511.05-x, el
1590-x

2 OTDR 1610 49 OTDR OTDR N/A

Tap Tap

CT_1610 2 1610.93-x , 13 OSC OSChann N/A

1610.8-x el

2 PO 02

Ribbon Communications Inc. Proprietary 221

 Cards and Modules

Component Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

CT_OTDR_2 4 Line-x, C- 0,15,6 Line OTS OMS

band-x

2 OSC1510-x 27 OSC OSChann N/A

el

4 OTDR 1610 3, 48, 9 OTDR OTDR N/A

Tap Tap

C_OTDR_2 2 Line-x 04 Line OTS OMS

2 C-band+OSC- 15 Line OTS N/A

x

4 OTDR 1610 2,36,7 OTDR OTDR N/A

Tap Tap

SP_SM_4/ 12 Userx 0 User PO OS

SP_MM_4 Serv-Ax, Serv- 1,2 Service
Bx 3
4,5
6
7,8
9
10,11

SP_CE4_2 10 Line-x, 0 Line OTS OMS + 88 *

P1-x, P2-x, 1,2,3,4 Add/Drop OCH
P3-x, P4-x 5
6,7,8,9

SP_CE8_1 1 Line 0 Line OTS OMS + 88 *

OCH

8 P1, P2…, P8 1,…,8 Add/Drop OCHP OCH

SP_CE16_1 1 Line 0 Line OTS OMS + 88 *

OCH

16 P1, P2…, P16 1,…,16 Add/Drop OCHP OCH

Ribbon Communications Inc. Proprietary 222

 Cards and Modules

Component Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

SP_CE32_1 1 Line 33 Line OTS OMS + 88 *

OCH

2 P1, P2 34, 35 Add/Drop OTS OMS + 88 *

OCH

1 Line 0 Line OTS OMS + 88 *

OCH

32 P1, P2…, P32 1,…,32 Add/Drop OCHP OCH

R/B_2 6 Line-x 03 Line OTS OMS

Red-In-1 Blue- 1,24,5 Add/Drop OTS OMS

Out-1
Red-Out-1
Blue-In-1

CLT_1510 4 Line-x, C- 0,13,4 Line OTS OMS

band-x

2 OSC-1510 25 OSC OSChann N/A

el

CLT_1590 4 Line-x, C- 0,13,4 Line OTS OMS

band-x

2 OSC-1590 25 OSC OSChann N/A

el

Optical Amplifiers
Apollo supports dynamic variable and fixed gain amplifiers. The variable gain EDFAs are typically used in
regional and long-haul networks. Using dynamic EDFA technology, these amplifiers automatically adjust
themselves to the attenuation of the fiber span for which they are compensating, providing optimized
amplification over the entire spectral band.
Fixed gain amplifiers are offered as a low-cost alternative for specific configuration requirements, such as a
booster after ROADM nodes.
Refer also to:
• Configure Amplifiers
Apollo supports the following optical amplifiers.

Ribbon Communications Inc. Proprietary 223

 Cards and Modules

Optical Amplifiers

Optical Amplifier Description

OA_PA A fixed gain EDFA-based amplifier optimized as a preamplifier for metro

applications.

OA_FB A fixed gain EDFA-based amplifier optimized as a power booster for

terminal and ROADM sites with up to 44 DWDM channels.

OA_FB-R A new hardware version of the OA_FB optical amplifier that can operate
in the ACC (Automatic Current Control) mode. It is optimized to work in
OSC signal amplifier application for the OA_HRSF. The card occupies
one slot in the Apollo platforms.

OA_ML A variable gain EDFA-based amplifier with-mid stage access (MSA),

optimized for low gain spans before In-Line and ROADM sites in
Regional/LH applications, supporting up to 44/88 DWDM channels.

OA_M A variable gain EDFA-based amplifier with MSA, optimized for high gain
spans before In-Line and ROADM sites in Regional/LH applications,
supporting up to 44/88 DWDM channels.

OA_L A variable gain single-stage EDFA optimized for medium gain spans in
coherent networks applications, supporting up to 44/88 DWDM channels.

OA_LF A variable gain single-stage EDFA optimized as an ILA for coherent

networks with short span applications, supporting up to 96 DWDM
channels.

OA_VLF A single-stage variable gain EDFA that operates over extended C-band.
The operating gain range is 8 to 18dB. This amplifier is optimized for
coherent flex grid networks. It is a reduced cost single ILA/pre-amp/
booster.

OA_LFS A variable gain single-stage EDFA optimized as an ILA for coherent

networks with short span applications, supporting up to 96 DWDM
channels. The OALFs is a 23dBm medium gain amplifier that includes C/
T (OSC) filter on the line side.

OA_HF A variable gain single-stage EDFA optimized as an ILA for coherent

networks with long span applications, supporting up to 96 DWDM
channels.

OA_HFS 23dBm A high power fixed gain EDFA-based amplifier optimized for terminal and
ROADM sites in E/W configuration, supporting up to 96 DWDM channels
at a speed of 23dBm.

Ribbon Communications Inc. Proprietary 224

 Cards and Modules

Optical Amplifier Description

OA_DLF A dual EDFA card that includes two independent EDFA amplifiers in a
single package. The two EDFAs are defined as pre-amp and Booster
amplifiers. The pre-amp EDFA amplifies the optical signal received from
the line, and the Booster amplifies the light transmitted to the line. The
pre-amp EDFA in the OA_DLF is optimized as an ILA for coherent
networks with short-span applications.

OA_DLHF A dual EDFA card that includes two independent EDFA amplifiers in a
single package. The two EDFAs are defined as pre-amp and Booster
amplifiers. The pre-amp EDFA amplifies the optical signal received from
the line, and the Booster amplifies the light transmitted to the line. The
pre-amp EDFA in the OA_DLHF is optimized as an ILA for coherent
networks with long-span applications

OA_FHBS A high power fixed gain EDFA-based amplifier optimized for terminal and
ROADM sites in E/W configuration, supporting up to 88 DWDM
channels.

OA_MHS A high-power variable gain EDFA-based amplifier with MSA, optimized

for in-line sites in regional/LH applications, E/W configuration, supporting
up to 88 DWDM channels.

OA_HRS A Raman optical amplifier especially optimized for long-haul multispan

and undersea applications. OA_HRS is intended for use in conjunction
with EDFA amplifiers over G.652, G.654, and G.655 fibers.

OA_HRSF A Raman optical amplifier card that provides low-noise amplification for
Apollo networks. It provides a mean to improve the system OSNR, but
specifically employed on ultra-long links (>40dB loss). It also enables the
generation and termination of the optical supervision channel (OSC).
This card includes an OTDR Tap port that will be able to connect to an
OTDR port of the OTDR_8 card (from V8.0).

OA_EHRS A hybrid Raman-EDFA optical amplifier specially optimized for DCF-less

coherent networks. It combines a distributed low-noise Raman
amplification and a lumped high-Gain, high-power EDFA amplification in
a single module. This card includes an OTDR Tap port that will be able to
connect to an OTDR port of the OTDR_8 card (from V8.0).

OA_EHRSF A hybrid Raman-EDFA optical amplifier specially optimized for long

spans in coherent network applications. OA_EHRSF supports operation
in Flex-Grid. It combines a distributed low-noise Raman amplification and
a lumped high-Gain, high-power EDFA amplification in a single module.
This amplifier has a tilt offset range from -1 to +1 from V12.

Ribbon Communications Inc. Proprietary 225

 Cards and Modules

Optical Amplifier Description

OA_EHRSFB A hybrid Raman-EDFA optical amplifier specially optimized for long

spans in coherent network applications. OA_EHRSFB supports operation
in Flex-Grid. It combines a distributed low-noise Raman amplification and
a lumped high-Gain, high-power EDFA amplification in a single module.
OA_EHRSFB also includes a Variable Optical Attenuator (VOA) that
controls the OSC power injected into the transmission fiber, thereby
minimizing possible interaction between the OSC and the data channels.
This amplifier has a tilt offset range from -1 to +1 from V12.

OA_LEHRS A hybrid Raman-EDFA optical amplifier specially optimized for DCF-less

coherent networks. It combines a distributed low-noise Raman
amplification and a lumped high-Gain, high-power EDFA amplification in
a single module.

OA_LEHRSF A hybrid Raman/EDFA optical amplifier supporting operation in Flex-Grid,

for both ILA and pre-amp configurations in DCF-less coherent networks.
These amplifiers are optimized for low-gain 100/200G coherent regional
and long-haul in-line sites to increase network reach, providing optimized
dynamic gain for short spans (15 to 26 dB). The OA_LEHRSF combines
a distributed low-noise Raman amplification and a high-power EDFA
amplification in a single module, providing low-noise figure, wide gain,
and high output power, while improving the system OSNR.

OA_LEHRSFB A hybrid Raman/EDFA optical amplifier supporting operation in Flex-Grid,

for both ILA and pre-amp configurations in DCF-less coherent networks.
These amplifiers are optimized for low-gain 100/200G coherent regional
and long-haul in-line sites to increase network reach, providing optimized
dynamic gain for short spans (15 to 26 dB). The OA_LEHRSFB
combines a distributed low-noise Raman amplification and a high-power
EDFA amplification in a single module, providing low-noise figure, wide
gain, and high output power, while improving the system OSNR. The
difference between this amplifier and the OA_LEHRSF is that OSC
attenuation is moved from Rx to Tx.
This amplifier has a tilt offset range from -1 to +1 from V12.

OA_USPBF A high-gain power booster amplifier with an output power of 26 dBm. It

can be used in dispersion-managed 10G networks, cascaded to MSA
ILA, or in DCF-less coherent networks, cascaded to non-MSA ILA. It
supports multichannel applications and is capable of amplifying the
Extended-C-band.

Ribbon Communications Inc. Proprietary 226

 Cards and Modules

Optical Amplifier Description

OA_DVLF The OA_DVLF is a dual EDFA card that includes two independent EDFA
amplifiers in a single package. The two EDFAs are defined as pre-amp
and booster amplifiers. The pre-amp EDFA amplifies the optical signal
received from the line, and the booster amplifies the light transmitted to
the line. The pre-amp EDFA in the OA_DVLF is optimized for short-span
applications. For safety reasons the OA_DVLF is designed to operate in
E/W configurations and it includes built-in C/T filters. The card occupies
one slot in the OPT96xx and OPT9904X platforms and includes an
1510nm OSC filter and a pluggable 100 Mbps 1510nm OSC SFP. The
OA_DVLF card operates over the extended C-band spectral range.

OA_DPR A low-cost Red Band, dual EDFA card that includes two independent
EDFA amplifiers in a single package. The two EDFAs are defined as pre-
amp and Booster amplifiers. The OA_DPR can operate only in the Red
Band (Freq. 192.10 to 193.60) and support 16 (100 GHz spacing), or 32
channels (50 GHz spacing). For safety reasons the OA_DPR is designed
to operate in E/W configurations and includes built-in C/T filters. The card
occupies one slot in the OPT96xx platforms, and includes an 1510nm
OSC filter and a pluggable 100 Mbps 1510nm OSC SFP.

OA_SGC A dual C-band EDFA module that enables connection with L-band
networks. Each module is a high-power switch-gain amplifier, specifically
designed for smooth upgrades to a full C+L-band network. Each module
can operate at two different configurable gain ranges. The OA_SGC
includes two built-in C/L/1510nm/1626nm filters that enable the smooth
transition to C+L-band channel support, as well as optional OTDR
monitoring (1626nm) and OSC transmission with two 1510nm OSC
SFPs. The OA_SGC amplifier also includes enhanced tilt compensation
capabilities to cope with the extra tilt generated in a C+L-band network
by SRS.

OA_SGEC A dual C-band EDFA module that enables connection with L-band
networks. Each module is a high-power switch-gain amplifier, specifically
designed for smooth upgrades to a full C+L-band network. Each module
can operate at two different configurable gain ranges. The OA_SGEC
includes two built-in C/L/1510nm/1626nm filters that enable the smooth
transition to C+L-band channel support, as well as optional OTDR
monitoring (1626nm) and OSC transmission with two 1510nm OSC
SFPs. The OA_SGEC amplifier also includes enhanced tilt compensation
capabilities to cope with the extra tilt generated in a C+L-band network
by SRS, and support for Optical Chanel Monitoring (OCM) and Dynamic
Gain Equalizer (DGE) for each amplifier in the card.

OA_DFBL A dual EDFA card that includes two independent EDFA amplifiers in a
single package. The two EDFAs are defined as pre-amp and Booster
amplifiers. The pre-amp EDFA amplifies the optical signal received from
the line, and the Booster amplifies the light transmitted to the line.

Ribbon Communications Inc. Proprietary 227

 Cards and Modules

Optical Amplifier Description

OA_LSGC A bidirectional C-band EDFA module with optimized lower gain and OSC
VOA control compared to OA-LSGC. It has the capability of switching
between the two gain modes (low gain and high gain). The OA_LSGC
includes two built-in C/L/1510nm/1626nm filters that enable the smooth
transition to C+L-band channel support by connecting L-band amplifier,
as well as optional OTDR monitoring (1626nm) and OSC transmission
with two 1510nm OSC SFPs. This amplifier also has the capability to
suppress the non-linearity by controlling the output power of the amplifier.
The OA_LSGC amplifier also includes enhanced tilt compensation
capabilities to cope with the extra tilt generated in a C+L band network by
SRS.

OA_LSGEC A bidirectional C-band EDFA module with optimized lower gain and OSC
VOA control compared to OA-LSGEC. It has the capability of switching
between the two gain modes (low gain and high gain). The OA_LSGEC
includes two built-in C/L/1510nm/1626nm filters that enable the smooth
transition to C+L-band channel support by connecting L-band amplifier,
as well as optional OTDR monitoring (1626nm) and OSC transmission
with two 1510nm OSC SFPs. This amplifier also has the capability to
suppress the non-linearity by controlling the output power of the amplifier.
The OA_LSGEC amplifier also includes enhanced tilt compensation
capabilities to cope with the extra tilt generated in a C+L band network by
SRS and support for Optical Channel Monitoring (OCM) and Dynamic
Gain Equalizer (DGE) for each amplifier in the card.

OPA_FBS A pluggable CFP2 form-factor amplifier, hosted by the ROADM_4FS

module, for use as a booster in the designated booster module slot. The
OPA_FBS is a 20.5dBm single-stage variable gain pluggable EDFA that
operates over the extended C-band. The operating gain range is 15 to
28dB. A 1510nm OSC channel may be added via the OSCin port.

OPA_LFS A pluggable CFP2 form-factor amplifier, hosted by the ROADM_4FS

module, for use as a low-gain pre-amp in the designated pre-amp
module slot. The OPA_LFS is a 20.5dBm single-stage variable gain
pluggable EDFA that operates over the extended C-band. The operating
gain range is 15 to 28dB. A 1510nm OSC channel may be dropped via
the OSCout port.

OPA_VLFS A pluggable CFP2 form-factor amplifier, hosted by the ROADM_4FS

module, for use as a low-gain pre-amp in the designated pre-amp
module slot. The OPA_LFS is a 20.5dBm single-stage variable gain
pluggable EDFA that operates over the extended C-band. The operating
gain range is 8 to 18dB and the tilt range is -1.5 to 0dB. A 1510nm OSC
channel may be dropped via the OSCout port.

Ribbon Communications Inc. Proprietary 228

 Cards and Modules

Optical Amplifier Description

OPA_HFS A pluggable CFP2 form-factor amplifier, hosted by the ROADM_4FS

module, for use as a high-gain pre-amp in the designated pre-amp
module slot. The OPA_HFS is a 20.5dBm single-stage variable gain
pluggable EDFA that operates over the extended C-band. The operating
gain range is 25 to 37dB. A 1510nm OSC channel may be dropped via
the OSCout port.

OPA_SCB_XFP A pluggable XFP form-factor, hosted by the 9901x cage (up to two
modules per cage). The OPA_SCB_XFP is a single-channel EDFA that
operates over the Extended C band. The operating power range (Not
Gain range, this EDFA only works in APC mode) is 7 dBm to 15dBm.

Depending on the amplifier type, you might need to define additional mandatory attributes during card
assignment (see Card Assignment).
For detailed descriptions of the supported optical amplifiers, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 229

 Cards and Modules

Optical Amplifiers - port configuration rules

Amplifier Number of Port Label Port Port Port Sub-IF

Ports Number Role Type Type

OA_PA 2 Amp-In, Amp-Out 1, 2 Line OTS OMS

1 OSC100M 0 OSC OSC100 N/A

M

OA_FB 2 Amp-In, Amp-Out 1, 2 Line OTS OMS

1 OSC100M 0 OSC OSC100 N/A

M

OA_FB-R 2 Amp-In, Amp-Out 1, 2 Line OTS OMS

OA_ML 4 Amp-In, Amp-Out, 1,2 Line OTS OMS

Mid-stage-Out, Mid- 3,4
stage-In

1 OSC100M 0 OSC OSC100 N/A

M

OA_M 4 Amp-In, Amp-Out, 1,2 Line OTS OMS

Mid-stage-Out, Mid- 3,4
stage-In

1 OSC100M 0 OSC OSC100 N/A

M

OA_L 2 Amp-In, Amp-Out 1, 2 Line OTS OMS

1 OSC100M 0 OSC OSC100 N/A

M

OA_LF 2 Amp-In, Amp-Out 1, 2 Line OTS OMS

1 OSC100M 0 OSC OSC100 N/A

M

OA_VLF 2 Amp-In, Amp-Out 1, 2 Line OTS OMS

1 OSC100M 0 OSC OSC100 N/A

M

Ribbon Communications Inc. Proprietary 230

 Cards and Modules

Amplifier Number of Port Label Port Port Port Sub-IF

Ports Number Role Type Type

OA_HF 2 Amp-In, Amp-Out 1, 2 Line OTS OMS

1 OSC100M 0 OSC OSC100 N/A

M

OA_HFS 3 Amp-In, Exp-Out, Line 1,3,2 Line OTS OMS

23dBm
2 OSC100M 0 OSC OSC100 N/A
OSC1510 4 M
OSChan
nel

OA_DLF 2 Node, Line 1, 2 Line OTS OMS

1 OSC1510 3 OSC OSChan N/A

nel

1 OSC100M 0 OSC OSC100 N/A

M

OA_DLHF 2 Node, Line 1, 2 Line OTS OMS

1 OSC1510 3 OSC OSChan N/A

nel

1 OSC100M 0 OSC OSC100 N/A

M

OA_FHBS 3 Amp-In, Exp-Out, Line 1,3,2 Line OTS OMS

2 OSC100M 0 OSC OSC100 N/A

OSC1510 4 M
OSChan
nel

OA_MHS 5 Amp-In, Exp-Out, Line, 1,5,2 Line OTS OMS

Mid-stage-Out, Mid- 3,4
stage-In

2 OSC100M 0 OSC OSC100 N/A

OSC1510 6 M
OSChan
nel

Ribbon Communications Inc. Proprietary 231

 Cards and Modules

Amplifier Number of Port Label Port Port Port Sub-IF

Ports Number Role Type Type

OA_HRS 2 Node, Line 1,2 Line OTS OMS

2 OSC2M 0 OSC OSC2M N/A

OSC1510 3 OSChan
nel

OA_HRSF 2 Node, Line 1,2 Line OTS OMS

2 OSC2M 0,3 OSC OSC2M N/A

OSC1528 OSChan
nel

1 OTDR1610 4 OTDR OTDR N/A

Tap Tap

OA_EHRS 3 Line, Amp-Out, Exp-In 1,2,3 Line OTS OMS

2 OSC100M 0 OSC OSC100 N/A

OSC1528 4 M
OSChan
nel

OA_EHRS 3 Line, Amp-Out, Exp-In 1,2,3 Line OTS OMS

F
2 OSC100M 0 OSC OSC100 N/A
OSC1528 4 M
OSChan
nel

1 OTDR1610 5 OTDR OTDR N/A

Tap Tap

OA_LEHR 3 Line, Amp-Out, Exp-In 1,2,3 Line OTS OMS

S
2 OSC100M 0 OSC OSC100 N/A
OSC1528 4 M
OSChan
nel

OA_LEHR 3 Line, Amp-Out, Exp-In 1,2,3 Line OTS OMS

SF

Ribbon Communications Inc. Proprietary 232

 Cards and Modules

Amplifier Number of Port Label Port Port Port Sub-IF

Ports Number Role Type Type

2 OSC100M 0 OSC OSC100 N/A

OSC1528 4 M
OSChan
nel

1 OTDR1610 5 OTDR OTDR N/A

Tap Tap

OA_USPB 3 Amp-In, Exp-Out, Line 1,3,2 Line OTS OMS

F
1 OSC1510 4 OSC OSChan N/A
nel

OA_DVLF 2 Node, Line 1, 2 Line OTS OMS

1 OSC 1510 3 OSC OSChan N/A

nel

1 OSC100M 0 OSC OSC100 N/A

M

OA_DPR 2 Node, Line 1,2 Line OTS OMS

1 OSC1510 3 OSC OSChan N/A

nel

1 OSC100M 0 OSC OSC100 N/A

M

OA_DFBL 2 Node, Line 1,2 Line OTS OMS

1 OSC1510 3 OSC OSChan N/A

nel

1 OSC100M 0 OSC OSC100 N/A

M

OA-LSGxC 2 Line-W, Line-E 2, 8 Line OTS OMS

2 L-band W, L-band E 5, 11 L-band OTS OMS

ports

4 OTDR 3, 4, 9, 10 OTDR- OTDR- N/A

Tap Tap

Ribbon Communications Inc. Proprietary 233

 Cards and Modules

Amplifier Number of Port Label Port Port Port Sub-IF

Ports Number Role Type Type

2 OSC-100M 0, 6 OSC100 OSC100 N/A

M M

2 OSC-1510 1, 7 OSC OSC N/A

Channel Channel

2 Monitor to L-band 13, 15 PO PO N/A

(W2E), Monitor to L-
band (E2W)

OPA_FBS 2 Amp-In, Amp-Out 21,22 Line OTS OMS

1 OSC1510 Out 23 OSC OSChan N/A

nel

OPA_LFS 2 Amp-In, Amp-Out 11,12 Line OTS OMS

1 OSC1510 Out 13 OSC OSChan N/A

nel

OPA_VLFS 2 Amp-In, Amp-Out 11,12 Line OTS OMS

1 OSC1510 Out 13 OSC OSChan N/A

nel

OPA_HFS 2 Amp-In, Amp-Out 11,12 Line OTS OMS

1 OSC1510 Out 13 OSC OSChan N/A

nel

OPA_SCB 2 Amp-In, Amp-Out 20,21 Line PO, uni- OS

_XFP out

Note
To define the port configuration for an optical amplifier, see Configure Ports.

Configure Amplifiers
You can configure amplifiers according to your requirements.
Start

Ribbon Communications Inc. Proprietary 234

 Cards and Modules

1. In the Network Explorer, right-click on the amplifier you want to configure and select Properties and
click Configuration.

2. Configure the amplifier as follows:

◦ In the Amplifier Mode dropdown list, select from:
• Automatic: Gain is automatically set by RCP using RCP protocol, adapted to the maximum
number of channels.
• Constant Gain: Only uses the gain that is set in the Initial Gain field.
• Semi-Automatic: Similar to Automatic but instead of configuring Max Num Channels, you
configure Required Pout/ch.
3. In the Amplifier State dropdown list, select from:
◦ ON: Enables you to turn the amplifier on.
◦ OFF: Enables you to turn the amplifier off, even in cases where it has full connectivity.

Note
In the following steps set the values for Initial Gain, Max Num Channels, Initial Tilt or
Required Pout/ch, per the specific network planning (Project Book).

4. If you selected Automatic in step 2, continue as follows:

◦ In the Initial Gain field, enter the value for the initial gain. This value differs according to the type
of amplifier. For more information refer to the Apollo System Specifications.
◦ In the Max Num Channels field, enter the value for the maximum number of channels. The value
can range from 1 to 88.
◦ Continue with step 7.
5. If you selected Constant Gain in step 2, continue as follows:
◦ In the Initial Gain field, enter the value for the initial gain. This value differs according to the type
of amplifier. For more information refer to the Apollo System Specifications.
◦ In the Initial Tilt field, enter the initial tilt in dB. The value can be between -2 and 0.
◦ Continue with step 7.
6. If you selected Semi-Automatic in step 2, continue as follows:
◦ In the Initial Gain field, enter the value for the initial gain. This value differs according to the type
of amplifier. For more information refer to the Apollo System Specifications.
◦ In the Required Pout/ch field, enter the value for the required Pout/ch in dBm. The value can be
from -5 to 12 dBm.
7. In the Response to LOS dropdown list, select the action you want to take in the event of a LOS. You
can select from:

Ribbon Communications Inc. Proprietary 235

 Cards and Modules

◦ Immediate shutdown: Shuts down the amplifier immediately on LOS.

◦ 50msec delay till shutdown: Waits 50msec before shutting down the amplifier on LOS.
8. In the Transmission Fiber Type dropdown list, for an SRS configuration change, select the fiber type
from the available values: g652 (default), g654, g655-leaf, g655-tw-rs, g655-tw-reach, None (when no
fiber is connected).
9. In the Insertion Loss dropdown list, for an SRS configuration change, select the relevant step
required. Available steps are 0-10 in steps of 0.5. Default=0.5 for normal EDFAs and 0 for booster.
10. Click Apply to accept the configuration settings.
11. To view the status of the amplifier during operation, click the Operation tab.

Note
SRS configuration changes can only be performed on the following amplifiers:
◦ OA_L
◦ OA_LF
◦ OA_HF
◦ OA_VLF
◦ OA_LFS
◦ OA_HFS
◦ OA_DLHF
◦ OA_DLF
◦ OA_DVLF
◦ OA_USPBF
◦ OA_LEHRSFB
◦ OA_EHRSFB
◦ OA_EHRSF
◦ OA_LEHRSF
◦ OPA_VLFS
◦ OPA_FBS
◦ OPA_LFS
◦ OPA_HFS
◦ OPA_SCB_XFP

OTDR
The Optical Time Domain Reflectometer (OTDR) is an optoelectronic device used to test the characteristic of
an optical fiber. The OTDR injects a series of optical pulses into the tested fiber and examines the light
scattered or reflected back from the end of the fiber. The strength of the return pulses is measured and
integrated as a function of time.
OTDR functionality is supported in any Apollo amplifier that supports 100 Mbps OSC with an SFP, by simply
replacing the regular OSC SFP with the OTDR1_L5 transceiver.
The OTDR is implemented in the Apollo platforms by an OSC SFP that has also the capability to operate as
an OTDR. This application provides a low-cost and compact OTDR device, specifically designed to
determine the location of a fiber cut. The SFP used for the OTDR application is OTDR1_L5, which is a 1510
nm, 100 Mbps OSC SFP with OTDR capabilities.
The OTDR1_L5 provides the following main functions:
• Operates normally as a 100 Mbps OSC SFP
• OTDR functionality triggered by management commands (see OTDR Management)
For more information about the OTDR card, see the Apollo Reference Manual.

Ribbon Communications Inc. Proprietary 236

 Cards and Modules

OTDR_8
An Optical Time-Domain Reflectometer (OTDR) is an optoelectronic device used to characterize an optical
fiber. It injects a series of optical pulses into the fiber under test and extracts, from the same end of the fiber,
light that is scattered or reflected back from points along the fiber. The scattered or reflected light that is
gathered back is used to analyze the optical fiber characteristics.
The purpose of an OTDR is to detect, locate, and measure elements at any location on a fiber optical link.
The OTDR_8 test results are processed and enable to display a graphical representation of the entire fiber
optic link (see Run OTDR_8 Tests). The OTDR provides the user a trace (graphic representation) of the
fiber's attenuation as a function of distance from the OTDR connection point.
The OTDR_8 is a low-cost dedicated OTDR test card for the Apollo OPT96xx family that occupies a double
(long) slot in the supported platforms. It can monitor up to 8 fibers (one at a time) and provide a maximum
reach on 40 dB fibers. The OTDR_8 operates at 1610 nm (outside the range of the C-band), which enables it
to perform in-service tests.
For more information about the OTDR_8 card, see the Apollo Reference Manual.

OTDR_8 card - port configuration rules

Number of Ports Port Label Port Number Port Role Port Type Sub-IF Type

8 P1, P2,P8 1,, 8 OTDR OTDR N/A

OTDR_30_1625_XFP
The FXP OTDR module monitors the Rx fiber. The OTDR port is connected to the Rx fiber via a dedicated
OTDR filter, which is an unmanaged fiber jumper. This module is supported only in the OPT9901X platform,
which can include up to two pluggable XFP form-factor OTDR modules on ports 20 and 21 in four modes:
ADM100, CPE100, DCMR100, and RADM100.
OTDR_30_1625_XFP features 30dB dynamic range and 1625nm operating wavelength.
The OTDR scan may be either a reference test or a regular test, however, the Raman pre-installation test in
not applicable in this module.

OTDR_30_1625_XFP Card - Port Configuration Rules

Number of Port Port Line- Number of Port Port Type Sub-IF

Ports Label Number Port Scanned Spans Role Type
Peer

2 P20, • 20 for 22 or 23 1 (default), 2, 3, 4, OTDR OTDR, N/A

P21 u0_0 5 uni-out
• 21 for
u0_1

OTDR1610_8s, OTDR1610M_8s, OTDR1625M_8s, OTDR1626_8s

An Optical Time-Domain Reflectometer (OTDR) is an optoelectronic device used to characterize an optical
fiber. It injects a series of optical pulses into the fiber under test and extracts, from the same end of the fiber,
light that is scattered or reflected back from points along the fiber. The scattered or reflected light that is
gathered back is used to analyze the optical fiber characteristics.

Ribbon Communications Inc. Proprietary 237

 Cards and Modules

The purpose of an OTDR is to detect, locate, and measure elements at any location on a fiber optical link.
The OTDR1610_8s/OTDR1625M_8s/OTD1626_8s is a low-cost dedicated OTDR test card for the Apollo
OPT96xx family that occupies a single slot in the supported platforms (the OTDR1626_8s is not supported
by the 9904x cage). It can monitor up to 8 fibers (one at a time) and provide a maximum reach on 40 dB
fibers.
• The OTDR1610_8s operates at 1610 nm (outside the range of the C-band), which enables it to
perform in-service tests.
• The OTDR1625M_8S cards operate at 1625 nm (outside the range of both the C-band and the L-
band), which enables them to perform in-service testing of the optical fiber, ideal for metro
applications.
• The OTDR1626 _8s is for combined C + L band networks and operates at 1626 nm. The
OTDR1610_8s/OTDR1625M_8s/OTDR1626_8s test results are processed and enable to display a
graphical representation of the entire fiber optic link (see Run OTDR_8 Tests).
• The OTDR provides the user a trace (graphic representation) of the fiber's attenuation as a function of
distance from the OTDR connection point.
• The OTDR1626_8s only works with the L band ready card OTDR TAP ports, for example: OA_SGC or
OA_SGEC only.
For more information about the OTDR1610_8s/OTDR1625M_8s/OTDR1626_8s card, see the Apollo
Reference Manual.

OTDR1610_8s/OTDR1626_8s Card: Port Configuration Rules

Number of Port Label Port Number Port Role Port Type Sub-IF Type
Ports

8 P1, P2,P8 1,, 8 OTDR OTDR N/A

DCF
Apollo supports the following Dispersion Compensation Fiber (DCF) cards:
• DCF652_xx: A DCF card suitable for G. 652 compliant fibers. The card is available for compensation
for various distances (5, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100, 110, or 120km).
• DCF655_xx: A double-wide slot DCF card that is suitable for G. 655 compliant fibers. The card is
available for compensation for various distances (40 km, 80 km, or 120km).
The marking xx in the card name indicates the compensated distance in km.
For detailed descriptions of the supported DCF cards, see the Apollo Reference Manual.
DCF cards are passive modules that can be installed in any service slot or in Artemis cages. DCF card
assignment requires defining an additional mandatory attribute, Length (see Card Assignment).
DCF card ports are automatically configured upon card assignment.

DCF cards - port configuration rules

Card Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

DCF652_xx 2 OUT, IN 0,1 Line OTS OMS

DCF655_xx 2 OUT, IN 0,1 Line OTS OMS

Ribbon Communications Inc. Proprietary 238

 Cards and Modules

OMSP
The OMSP card provides Optical Multiplexer Section Protection (OMSP). The OMSP modules switch the
traffic to the protection path when a failure occurs on the main path, and vice versa.
For more information about the OMSP card, see the Apollo Reference Manual.

OMSP card - port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

3 Common 0 Common OTS OMS

Path-A, Path- 1,2 Path

B

OLP_S2
The OLP_S2 is an Optical Line Protection (OLP) card that provides protection for two services of Apollo
DWDM networks, while increasing the network's reliability and availability in a cost-effective manner. The
card enables protection against fiber cuts, signal failures, loss of signal quality or power degradation, and
card failures at the DWDM layer and saves duplicating the network infrastructure.
The card was designed as an integrated solution for Apollo platforms that saves the use of high-cost external
OEM protection units. It protects Apollo service cards such as transponders, combiners, AoC, and FIO cards.
The card occupies one slot in the platforms. The OLP_S2 is intended to work with SM (Single Mode) fibers.
For more information about the OLP_S2 card, see the Apollo Reference Manual.

OLP_S2 card - port configuration rules

Number of Port Label Port Port Role Port Type Sub-IF Type
Ports Number

6 Common x 03 Common OCHP, OTS or OCH, OMS or OS

PO
Path-Ax, Path-Bx 1,2,4,5 Path

Pluggable Transceiver Modules

Apollo supports pluggable optical transceivers (SFP, SFP+, XFP, QSFP, QSFP28, QSFP-DD, CFP, and
CFP2) for all services, in both colored and noncolored interfaces. Transceiver modules are used for the
entire spectrum of interfaces, including intra-office, short range, and long range. The standardized modular
design of the transceiver components facilitates network maintenance and upgrades since interchangeable
transceiver components are utilized throughout the product line. Instead of replacing an entire circuit board, a
single module can be removed or replaced, for a considerable cost savings.
SFP+ and XFP transceivers are available in colored and noncolored, tunable, and fixed versions. The
tunable SFP+/XFP transceivers support 50GHz spacing and are available for long-haul network
configurations. QSFP+ transceivers support 40GbE with 4x10G fanout, QSFP28 transceivers support
100GbE/OTU4, QSFP-DD transceivers support up to 400GbE, CFP transceivers are used for client side

Ribbon Communications Inc. Proprietary 239

 Cards and Modules

(100GbE/OTU4) or line coherent interfaces, and CFP2 transceivers are used for 100GbE/OTU4 client or fan-
out (10GbE or 40GbE) applications.
For detailed descriptions of the supported pluggable transceiver modules, see the Apollo Reference Manual.

Assign Cards
You can assign cards to slots.
Start
1. From the Network Explorer tab, right-click the NE and select Assign/Replace Card.
The Assign/Replace Card window opens.

Ribbon Communications Inc. Proprietary 240

 Cards and Modules

2. For each new card, select the slot and card type to assign to the slot.
3. To view slots in which the assigned card is different from the actual card, click Display mismatch of
Assigned vs Actual.
4. To copy the actual cards to the assigned cards, select the slots of the relevant cards and click Copy
Actual to Assigned.
5. Click Apply.
The cards are assigned.

Ribbon Communications Inc. Proprietary 241

 Cards and Modules

Important
When you assign a new card, most of the mandatory attributes are defined automatically for
the card. For some card types, you must define additional mandatory attributes as follows:
◦ OADM Cards: The First Channel attribute must also be defined.
◦ Amplifiers: Additional attributes must also be defined, depending on the amplifier type.
◦ DCF Cards: The Length attribute must also be defined.
◦ TR100/TR100L: The Operation Mode attribute must also be defined.
If the mandatory attributes are not defined for the card, card assignment will fail.
◦ Unsupported cards are not recognized by the system until the next system upgrade and
card restart.

Replace Cards
You can replace assigned cards.
Start
1. To replace one card:
◦ From the Network Explorer tab, right-click on the card to replace and select Replace Card.
The Replace Card window opens.

◦ Select the new card and click Set.

The card is replaced.
2. To replace one or more cards for the same NE:
◦ From the Network Explorer tab, right-click the NE and select Assign/Replace Card.
The Assign/Replace Card window opens.
◦ Change the cards as required and click Apply. For more assignment options, see Assign cards.
The cards are replaced.

Ribbon Communications Inc. Proprietary 242

 Cards and Modules

Unassign a Card
You can unassign a card.

Note
To unassign an HIO10_20 or HIO100_2 card, you must first delete all of its GE ports.

Start
1. From the Network Explorer tab, right-click the card and select Unassign Card.
A confirmation message appears.
2. Click Yes.
The card is removed from the slot.

View the Card Description

This procedure describes how to view a detailed, textual description of a component card.
Start
• In the Network Explorer tab (or in Chassis view), right-click on the card and select Description.
A description of the card appears.

View Card Properties

You can view the card properties.
Start
• In the Network Explorer tab (or in Chassis view), right-click the component card and select
Properties.
The card properties appear. The tabs available depend on the type of card.
See also:
• Optical Card Properties
• xRCP-RCP Card Properties
• CTM Card Properties

Optical Card Properties

The following configuration and status information about Optical cards is displayed in its Properties tab. The
specific properties depend on the actual card type.

Ribbon Communications Inc. Proprietary 243

 Cards and Modules

Optical card properties

Field Description

Chassis (read only) Host name of the NE or the IP address of the NE's
management interface.

Slot Number (read only) Card slot location.

Configured Card Type Type of component card.

Actual Card Type (read only) Actual type of component card that is plugged in the shelf.

Operation State (read only) Operational state of the card.

Severity Profile Select the profile to be assigned to the card.

Alarm Master Mask Set the value to true to enable Alarm Master Mask mode.

L2 Mode Must be enabled to create an L2 service on an HIO400A

card.
Possible values:
• Enabled
• Disabled (default)
• NA

xRCP-RCP Card Properties

The following configuration and status information about the RCP card is displayed in its Properties tab.

Ribbon Communications Inc. Proprietary 244

 Cards and Modules

xRCP/RCP card properties

Field Description

Name (read only) Name of the component card.

Chassis (read only) Host name of the NE or the IP address of the NE's
management interface.

Card Type (read only) Specific card type: xRCP or RCP.

Status (read only) Status of the component card, for example, Active.

Last State Change (read only) Date and time of the last state change.

State Change Reason (read only) Reason for the last state change, for example, Boot.

Primary RCP Defines the primary RCP card: RCP A or RCP B.

Enable High Availability (for OPT96xx only) In OPT96xx platforms, high availability is disabled for
RCP cards by default. Selecting this option, enables high
availability for RCP cards. See Enable High Availability
for RCP cards (OPT96xx).

Timeout before standby takeover (Active Number of seconds to wait after detecting a failure of the
RCP card) active RCP before the standby RCP switches to active.

Serial Number (read only) Serial number of the component card.

Board Revision (read only) Board revision level of the component card.

Architecture Revision (read only) Architecture revision level of the component card.

Hardware Configuration (read only) Hardware configuration version of the component card.

Boot Firmware Revision (read only) N/A

Hardware Option (read only) N/A

Card Role (read only) Type of component card, for example, Route Control
Processor.

Slot Number (read only) Card slot location.

Ribbon Communications Inc. Proprietary 245

 Cards and Modules

Field Description

DC Power Consumption (read only) DC power consumption of the xRCP/RCP.

Note: This field will appear for OPT96xx only if it is
configured during STMS installation to appear.

Power Source (read only) List of xPFM/PFMs that feed the xRCP/RCP card.
(for OPT99xx only)

CTM Card Properties

The following configuration and status information about CTM cards (where applicable) is displayed in its
Properties tab.

Note
The CTM resides on the RCP card and is installed only when node synchronization is required. It is
not shown in the Chassis view.

Ribbon Communications Inc. Proprietary 246

 Cards and Modules

CTM card properties

Field Description

Name (read only) Name of the component card.

Chassis (read only) Host name of the NE or the IP address of the NE's
management interface.

Board Revision (read only) Board revision level of the component card.

Slot Number (read only) Card slot location, CTM_A or CTM_B.

CTM Card Type (read only) Type of CTM displayed, for example, CTM.

CTM Card Operational state (read only) Operational state of CTM displayed, for example,
Active.

Last Switchover (read only) Date and time of the last switchover from active to
Standby or Never.

Auto Enable Select if auto enable is required.

Locked Out Select if the clock synchronization is to be locked out.

Primary CTM Select the primary CTM card, CTM A or CTM B.

Timeout Enter the amount of time for timeout.

View Card Performance Statistics

In addition to a variety of real-time counter tabs, the property sheet for a component card may display a
number of related performance statistics tabs.

Note
For information about viewing real-time and historical counter data, see the STMS Performance
Management Guide.

The following table describes each of the performance statistics tabs and indicates the types of component
cards for which the tabs are displayed.

Ribbon Communications Inc. Proprietary 247

 Cards and Modules

Performance statistics information

Tab Card types Description

File System Stats RCP Displays graphs of file system usage data.

Temperature Stats NPB, RCP Displays graphs of temperature sensor

data.

Counters

CPU Usage NPB, RCP Displays the following CPU usage data:
• User Time
• System Time
• Idle Time

Memory Usage NPB, RCP Displays the following memory usage

data:
• Total Memory Available
• Used Memory
• Total Swap Available
• Used Swap

OS Processes NPB, RCP Displays the following OS processes data:

• Total Processes, Running Processes,
• Sleeping Processes, Stopped
Processes,
• Zombie Processes

Note
Performance statistics for NPBs are displayed per slice.

This section describes how to view performance statistics for a component card.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the component card and then
Properties.
2. Click the relevant performance statistics tab.

Ribbon Communications Inc. Proprietary 248

 Cards and Modules

xRCP-RCP Card Operations

You can perform the following operations for an xRCP/RCP card:
• Restart an xRCP/RCP: Restart the system software for an xRCP/RCP card.
• Reboot an xRCP/RCP: Perform a system-wide reboot of the xRCP/RCP card.
• Configure xRCP-RCP Redundancy: Configure xRCP/RCP redundancy in a dual xRCP/RCP system.

Restart an xRCP-RCP Card

You can restart the system software on an xRCP/RCP card rather than perform a system-wide reboot of it.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the xRCP/RCP card you want to restart
and select Actions > Restart.
A confirmation message appears.
2. Click Yes.
The system software on the xRCP/RCP is restarted.

Reboot an xRCP-RCP Card

Rebooting an xRCP/RCP card performs a system-wide reboot of the xRCP/RCP card.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the xRCP/RCP card you want to reboot
and select Actions > Reboot.
A confirmation message appears.
2. Click Yes.
The xRCP/RCP card is rebooted.

Ribbon Communications Inc. Proprietary 249

 Cards and Modules

Configure xRCP-RCP Redundancy

In a system with two xRCP/RCP cards installed, you can configure redundancy for the xRCP/RCP cards. By
placing the secondary xRCP/RCP card in warm-standby mode, redundancy can minimize downtime during
system software upgrades or in the event that the active xRCP/RCP fails.
When the NE switches from the active to the standby xRCP/RCP card, the standby xRCP/RCP card loads
the configuration file from its flash drive and starts the routing processes. As part of assuming control of the
NE, it resets all of the NPBs, briefly disrupting traffic.
Each xRCP/RCP card has a management interface, a console port, and an auxiliary port. When an xRCP/
RCP switchover occurs, the management interface, console port, and auxiliary port of the NE also switch to
the corresponding ports on the standby xRCP/RCP.
As a result:
• The management interface resets when it switches to the standby xRCP/RCP card. If you are logged
in remotely, you lose connectivity to the NE and have to log in again. Assuming you have the same IP
address configured for the standby xRCP/RPC card, the IP address of the management interface
remains the same.
• The console and auxiliary ports for the active xRCP/RCP card switch to the standby xRCP/RCP card.
If you are logged in via the console port, you need to switch your monitor to the console port to the
standby xRCP/RCP card to communicate with the active xRCP/RCP card.
See also:
• Define the Primary xRCP-RCP Card
• Enable High Availability for RCP Cards: OPT96xx
• Perform a Manual Configuration Synchronization
• Perform a Manual Switchover

Define the Primary xRCP-RCP Card

The primary xRCP/RCP card is the xRCP/RCP card that the NE uses as the active one by default. In a dual-
xRCP/RCP system, you can designate either xRCP/RCP card as primary. By default, the xRCP/RCP card in
slot A is designated as the primary xRCP/RCP. This section describes how to define the primary xRCP/RCP.
Start
1. In the Network Explorer tab (or in Chassisview), right-click the xRCP/RCP card and select
Properties.
The xRCP/RCP card properties appear.
2. From the Primary RCP dropdown list, select the xRCP/RCP card you want to define as primary.
3. Click Apply.

Enable High Availability for RCP Cards: OPT96xx

High availability is disabled for RCP cards in an OPT96xx platform by default. You can enable high
availability as required.
Configuration synchronization is also enabled when you enable high availability. It automatically
synchronizes the configuration file on the active RCP with the configuration file on the standby RCP every
time the configuration on the active RCP changes. For automatic synchronization, the RCPs must be running
the same software version.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the active RCP and select Properties.
The RCP properties appear.
2. Select the Enable High Availability checkbox.

Ribbon Communications Inc. Proprietary 250

 Cards and Modules

3. In the Timeout before standby takeover (secs) field, type the number of seconds to wait after
detecting a failure of the active RCP before the standby RCP switches to active. Valid values range
from 10-10,000 seconds (default 30).

Note
The Timeout before standby takeover (secs) field is only available if you enable high
availability.

4. Click Apply.

Perform a Manual Configuration Synchronization

You can synchronize the configuration files on the active and standby xRCP/RCP cards manually .
Start
1. In the Network Explorer tab (or in Layout view), right-click the NE for which you want to synchronize
the configuration files and select Actions > Synchronize Standby RCP Configuration.
A confirmation message appears.
2. Click Yes.
The configuration files are synchronized on the active and standby xRCP/RCP cards.

Perform a Manual Switchover

You can perform a manual switchover from the active xRCP/RCP card to the standby xRCP/RCP card.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the active RCP card and select Actions
> RCP Switchover.
A confirmation message appears.
2. Click Yes.
The NE switches from the active xRCP/RCP card to the standby xRCP/RCP card.

Ribbon Communications Inc. Proprietary 251

 Ports and Interfaces

Ports and Interfaces

STMS enables you to manage ports and interfaces. Interfaces are implemented through ports on the
supported service cards.
See also:
• Supported Ports and Interfaces
• Terminology
• Supported Interfaces
• Interface Name
• Logical Interface Numbering
• Router ID and Primary Address
• Primary Interface
• IP Addresses and Interfaces
• View Port Properties
• Enable or Disable a Port
• Configure Ports
• Loopback Interfaces
• Define TR10_4EN-TR10_12EN Encryption Settings
• Define TR10_12ENB Encryption Settings
• Define TM200EN-TM100_2EN Encryption Settings
• Define TM200ENB-TM100_2ENB Encryption Settings
• Define HIO400EN-MIO200EN Encryption Settings
• OTDR Management
• Run OTDR_8 Tests
• Upload SOR Files from an NE
• View ONCP Data
• Configure LOS Threshold
• Define Performance Margin Threshold
• View Configured VPPs
• Define the OSPF Area for an OSC Port
• Define the OSPF Area for an OTU Port
• Define OSPF-TE Authentication for GMPLS Routing Instances
• Define OSPF Areas for DCN Routing Instances
• Define Spectral Pre-Emphasis
• Define Fast State of Polarization Tracking
• Port Maintenance

Supported Ports and Interfaces

The following types of ports and interfaces are supported:

Ribbon Communications Inc. Proprietary 252

 Ports and Interfaces

Supported Ports and Interfaces

Interface Category Port Type Abbreviation

Ethernet/GbE ety (ety1g, ety1ge, ety10g, ety10goc, ety40g, ety100g)

gbe (ge, ge10)
For example, the interface name ge-u2/2.3 corresponds to a GbE interface located
on port 2 of an NPB card in slot u2 that has a logical unit number of 3.

Fiber Channel fc (fc1200, fc800, fc400, fc200, fc100, fc1600, fc3200)

Logical gre0
For example, the interface name gre0.53 corresponds to a GRE interface that has
a logical unit number of 53.
lo0
For example, the interface name lo0.0 corresponds to the primary logical loopback
interface on the device.
ml
For example, the interface name ml-bundle_1.0 corresponds to a multilink
interface using the multilink bundle named bundle_1, with a unit number of 0.
t
For example, the interface name t-ge-u7/11.0 corresponds to a tunnel interface on
port 11 of the 20-port GbE card in slot u7, with a unit number of 0.

Management osc (osc100, osc2m, oschannel)

OTN and other ochp

photonic interfaces odu (odu-slot, odu1, odu2, odu2e, odu2f, odu3, odu3e, odu4, oduf-gfp, odua,
oduc2)
oms (cwdm, dwdm, non-colored)
ots
otu (otu1, otu2, otu2e, otu3e, otu4, otua, otuc2)
po
spo

SDH stm (stm64, stm16, stm4, stm1, stm1e)

e1
For example, the interface name e1-u6/2:3-3:7-2.0 corresponds to an interface
located on port 2 of an MSM card in slot u6 that has been channelized to E-1,
starting at channel 3, TUG-3 group 3, TUG-2 group 7, TU-12 2. This interface has
a logical unit number of 0.

Ribbon Communications Inc. Proprietary 253

 Ports and Interfaces

Interface Category Port Type Abbreviation

SONET oc (oc192, oc48, oc12, oc3, oc3e)

ds (ds, ds1)
For example, the interface name ds1-u7/1:1:5-4.0 corresponds to an interface
located on port 1 of an MSM card in slot u7 that has been channelized to a VT
group, starting at channel 1, VT group of 5, and a tributary of 4 within the group.
The interface has a logical unit number of 0.
A second example illustrates a DS-1 channel group interface. The interface name
ds-u5/2:2:7-4:3.0 corresponds to an interface located on port 2 of an MSM card in
slot u5 that has been channelized to a DS-1channel group, starting at DS-3
channel 2, VT Group 7, and a tributary of 4 within that group, with the first DS-0
starting at 3. The interface has a logical unit number of 0.

Video video270
sdi360m
hdsdi1485g

Packet ge10
ge10-otu2e
ge100
ge100-otu4

Terminology
The following terms are used when describing interfaces:
• Logical interface: Virtual interface on a physical interface or sub-interface. One interface or sub-
interface can support multiple logical interfaces. Multiple logical interfaces are supported by applying
tagging, such as VLAN-IDs, to packets arriving from or sent to different destinations.
• Concatenated interface: SDH/SONET interface where all of the time-slots are used together. For
instance, a concatenated OC-12 interface cannot be channelized to smaller data streams.
• Channelized interface: Single SDH/SONET interface can support multiple SDH/SONET sub-
interfaces or channels. The time-slots are divided into channelized interfaces, creating multiple
interfaces on one physical interface. Channelized interfaces are also called sub-interfaces.
• Gigabit Ethernet interface: Correspond to Gigabit Ethernet ports. Support multiple logical interfaces
per physical interface and can support multiple VLANs.
• 10 Gigabit Ethernet interface: Correspond to 10 Gigabit Ethernet ports. Support multiple logical
interfaces per physical interface and can support multiple VLANs.
• 10 Mbps Ethernet interface: Correspond to 10/100/1000BaseT Ethernet ports. 10 Mbps Ethernet is
carried over a twisted pair copper cable.
• 100 Mbps Ethernet (FE) interface: Correspond to 10/100/1000BaseT Ethernet ports. 100 Mbps
Ethernet is carried over a twisted pair copper cable.
• 1000 Mbps Ethernet interface: Correspond to 10/100/1000BaseT Ethernet ports. 1000 Mbps
Ethernet is carried over four CAT5 shielded twisted pair copper cables.

Supported Interfaces
Interfaces are implemented through ports on the various types of service cards. This section describes the
interfaces supported through ports on service cards installed in the chassis slots.

Ribbon Communications Inc. Proprietary 254

 Ports and Interfaces

• OTN Interfaces
• FC Interfaces
• Video Interfaces
• Management Interfaces
• Physical Optical Interfaces
• SDH Interfaces
• SONET Interfaces
• Channelized Interfaces
• Concatenated Interfaces
• 1 GbE and 10 GbE Interfaces
• 10, 100, and 1000 Mbps Ethernet Interfaces
• Logical Interfaces

OTN Interfaces
Optical Transport Network (OTN) technology offers a range of rates up to 200Gbps. OTN interfaces are
supported through the following types of ports:
• Optical Transmission Section (OTS) ports for equipment with more than one frequency, supporting
OMS and xOCH interfaces. Used, for example, in amplifiers or DCF cards, or in OADM or Mux/DeMux
cards for channelization purposes.
• Optical Channel ports (OCHP), for single-channel OCH interfaces.
• Optical Transport Unit (OTU) ports, for port rates ranging from OTU1 to OTU4, for comparable ODUk
interfaces ranging from ODU1 to ODU4. Used, for example, in OTU2 ports in TR10_4 cards, or for
ODU interfaces multiplexed to an OTUk port in an AoC10 or FIO10_5 card. Also used for ODUSlot
interface for ports with interface rates under 2.5G.
• OTUC2 port with a rate of 200Gbps for ODUC2 interfaces. It provides PT22 multiplexing via the HO
ODO (ODUC2) interface, which is divided into two ODU4 interfaces (marked as TPN1 and TPN2),
each with 100G.
PT21 ODU multiplexing is supported. It provides the following benefits:
• Support of lower granularity ODU0 - 1.25Gbps (PT21).
• Flat ODU hierarchy means that ODUk can sit directly on an ODU4 trail.
• High order ODU trails can include ODUk trails of various rates. Rates do not need to be of a single,
uniform type.
• New ODU interfaces provide greater efficiency of resource usage.

Cards and sub-interfaces supporting PT21 granularity

Card Port Type PT21 Sub-interface Rate Supported

FIO10_5B OTU2 ODU2 (client/line)

Aoc10B/Aoc10C OTU2 ODU1 (client), ODU2 (line)

FIO100 OTU4 ODU4 (line)

PT22 multiplexing is supported via the OTUC2 port.

Ribbon Communications Inc. Proprietary 255

 Ports and Interfaces

Cards and sub-interfaces supporting PT22 granularity

Card Port Type PT22 High Order (HO) Sub- PT22 Lower PT21 Sub-
interface Rate Supported hierarchy sub- interfaces
interface

TM400 OTUC2 ODUC2 (line) 2 x ODU4 For each ODU4 (as

in other cards)

FC Interfaces
Fiber Channel (FC) technology, supported by the OPT96xx platforms, offers a range of rates up to FC10G.
FC interfaces are supported through the following types of ports:
• FC-1G ports using ODU0 and ODUSlot interfaces
• FC-2G ports using ODU1 interfaces
• FC-4G ports using 2xODU1 interfaces
• FC-8G ports using ODU2 interfaces
• FC10G ports using ODU2f interfaces
• FC16G ports using ODU Flex FC1600 interfaces
• FC32G ports using ODU Flex FC3200 interfaces

Video Interfaces
Constant Bit Rate (CBR) technology is supported through the following types of ports:
• VIDEO270 ports with a rate of 270 Mbps, using ODU0 and ODUSlot interfaces.
• HDSDI1485 ports with a rate of 1.485 Gbps, using ODU1 interfaces (future).

Management Interfaces
Optical Supervisory Channel (OSC) technology is supported for an industry-standard range of management
channel ports:
• 1510 nm OSC port for DWDM applications.
• 1310 nm OSC port for CWDM applications.
• 100 Mbps (FE) OSC port.
• 2 Mbps OSC port.

Physical Optical Interfaces

Physical Optical (PO) technology is supported for splitter/coupler ports using Optical Section (OS) interfaces.

SDH Interfaces
SDH/SONET technologies are supported for the following port types:
• STM1/OC3, STM1e/OC3e, and STM4/OC12 ports using ODU0 and ODUSlot interfaces.
• STM16/OC48 ports using ODU1 interfaces.
• STM64/OC192 ports using ODU2 or ODU2e interfaces. Used, for example, in TR10_4 or CMR40
cards.
SDH interfaces correspond to SDH ports. SDH interfaces can correspond either to the bandwidth of an entire
SDH port or a channelized portion of the physical SDH port. By default, SONET/SDH PHY cards ports use
SDH framing.

Ribbon Communications Inc. Proprietary 256

 Ports and Interfaces

The following figure illustrates the SDH mappings supported by different PHY cards and the channelization
paths taken by those cards.

SDH Mappings

For SDH ports, you can configure E-1 interface type.

TUG-3 channels
One STM-1 interface can be channelized into three Tributary Unit Groups, level 3 (TUG-3) channels, each
supporting a Tributary Unit, level 3 (TU-3) channel.

Note
The TUG-3 channel follows the Administrative Unit, level 4 (AU-4) path. AU-4 channels are equivalent
to STM-1 channels. There is no direct way to configure a TUG-3 or TU-3 interface on the device.

TU-3 interfaces have a rate of 49.536 Mbps and carry DS-3 frames.
TUG-2 channels
Tributary Unit Group, level 2 channels can be channelized from TUG-3 channels. One STM-1 contains 21
TUG-2 channels. Each TUG-2 supports three Tributary Unit, level 12 channels. The rate for TU-12 channels
is 2.304 Mbps. TU-12s carry E-1 frames.
E-1 interfaces
TU-2 interfaces can be channelized into 3 DS-1 interfaces (63 per STM-1). E-1 interfaces have a rate of
2.048 Mbps.

SONET Interfaces
SDH/SONET technologies are supported for the following port types:
• STM1/OC3, STM1e/OC3e, and STM4/OC12 ports using ODU0 and ODUSlot interfaces.
• STM16/OC48 ports using ODU1 interfaces.
• STM64/OC192 ports using ODU2 or ODU2e interfaces. Used, for example, in TR10_4 or CMR40
cards.
SONET interfaces correspond to SONET ports. SONET interfaces can correspond either to the bandwidth of
an entire SONET port or a channelized portion of the physical SONET port. By default, SONET/SDH PHY
cards ports use SDH framing.
The following figure illustrates the SONET mappings and the channelization paths those cards take.

Ribbon Communications Inc. Proprietary 257

 Ports and Interfaces

SONET mappings

For SONET ports, you can configure the following interface types:
• DS-1
• VT-Group
DS-1 interfaces
DS-3 interfaces can be channelized into 28 DS-1 interfaces. DS-1 interfaces are equivalent to T1 interfaces
or 1.544 Mbps.
Virtual tributary group channel
Virtual Tributary (VT) groups provide an alternative method for channelizing an STS-1 channel. There are
seven VT groups per STS-1 channel, and each can be channelized further.
However, the amount of tributaries per group varies depending on the type of VT group. Currently, the device
supports the VT1.5 type, which has four tributaries per VT group. Each tributary is equivalent to a DS-1
interface or 1.544 Mbps.
DS-1 channel group interfaces
DS-1 channel groups are DS-1 interfaces that contain a bundle of selected DS-0 time slots. DS-1 interfaces
contain 24 DS-0 time slots. Each DS-1 can support multiple channel groups of non-overlapping bundles of
DS-0 time slots.

Channelized Interfaces
A single SDH/SONET interface can support multiple SDH/SONET sub-interfaces or channels. The time-slots
are divided up into channelized interfaces, creating multiple interfaces on one physical interface.
Channelized interfaces are also called sub-interfaces.

Ribbon Communications Inc. Proprietary 258

 Ports and Interfaces

Concatenated Interfaces
A concatenated interface is an SDH/SONET interface in which all of the time-slots are used together. By
definition, a concatenated interface cannot be channelized - they are two contradictory uses of the interface.
For instance, a concatenated OC12 interface cannot be channelized to smaller data streams.

1 GbE and 10 GbE Interfaces

Gigabit Ethernet (GbE) interfaces work with corresponding (appropriate capacity) GbE ports. A range of
interface options are supported, including 1GbE, 10GbE, 40GbE, and 100GbE. GbE interfaces support
multiple logical interfaces per physical interface and can support multiple VLANs. Supported port types
include:
• ETY1G/ETY1Ge Layer 1 GbE ports, using ODU0 and ODUSlot interfaces.
• ETY10G Layer 1 10GbE ports, using ODU2 or ODU2e interfaces.
• ETY10Goc Layer 1 10GbE overclocking ports, using ODU2e interfaces.
Multilink Bundles
Multilink bundles allow you to group interfaces into a larger bundle. This feature is available for GbE
interfaces, but not for 10GbE interfaces. For GbE interfaces, you can group together physical interfaces to
create larger Ethernet links. Ethernet bundling is based on the 802.3ad standard.
Generating MAC Addresses for GbE Interfaces
The device generates MAC addresses for GbE interfaces by using the physical card slot number, the NPB
card slice, the port number, a special value designated for our equipment, and an additional unique number
stored on the device's chassis.

10, 100, and 1000 Mbps Ethernet Interfaces

• 10 Mbps Ethernet interfaces correspond to 10/100/1000Base-T Ethernet ports. 10 Mbps Ethernet is
carried over a twisted pair copper cable.
• 100 Mbps Ethernet (FE or Fast Ethernet) interfaces correspond to 10/100/1000Base-T Ethernet ports.
100 Mbps Ethernet is carried over a twisted pair copper cable.
• 1000 Mbps Ethernet interfaces correspond to 10/100/1000Base-T Ethernet ports. 1000 Mbps Ethernet
is carried over four CAT5 shielded twisted pair copper cables.

Logical Interfaces
A logical interface is a virtual interface on a physical interface or sub-interface. One interface or sub-interface
can support multiple logical interfaces. Multiple logical interfaces are supported by applying tagging, such as
VLAN-IDs, to packets arriving from or sent to different destinations. The logical interface number
corresponds to the logical unit number which can be any number from 0 through 999,999.
• GRE Interfaces: Generic Routing Encapsulation (GRE) interfaces are software-only interfaces.
Logical GRE interfaces are dependent on the GRE routing protocol and are used to create endpoints
for GRE routing tunnels.
• Logical Loopback Interfaces: Logical loopback interfaces are software-only interfaces that are
internal to the device. Logical loopback interfaces are virtual interfaces that are never down and allow
for routing protocol adjacencies to remain up, even if the outbound interface is down. For example,
you can use a logical loopback interface as a neighbor address for a BGP session.
• Tunnel Interfaces: Tunnel interfaces are a type of virtual interface but they are associated with a
physical port on an NPB card that has a loopback enabled. Tunnel interfaces are used to terminate
L2TPv2 tunnels onto the device.

Ribbon Communications Inc. Proprietary 259

 Ports and Interfaces

Interface Name
Each type of interface has a naming scheme, and there are common name elements between interface
types.
The interface naming scheme is as follows:
type-slot/port:channel:(<2channel | group-unit>:channel-group).logical

where:
• type is the type of interface.
• slot is the chassis slot into which the NPB or MSM card is inserted.
• port is the port number on the NPB or MSM card.
• channel is the channel.
• 2channelis the DS-1/E-1 channel number, if needed.
• group-unit is the group and unit number.
• channel-group is the channel of the first DS-0 channel in the channel group interface.
• logical is the logical interface number.

Note
For multilink bundles, the interface name is in the form ml-bundlename where bundlename is
the user-defined name of the bundle. For tunnel interfaces, a t- is prepended to the interface
name

Logical Interface Numbering

The logical interface number corresponds to the logical unit number, which can be any number from 0
through 999,999. An interface can have any number of logical interfaces.
The following section illustrates interface numbering conventions.
• Gigabit Ethernet interface: Corresponds to a Gigabit Ethernet interface port 2 on an NPB card in slot
NPB2 that has a logical unit number of 3, for example, ge-u2/2.3.
• DS-1 Interfaces: Correspond to an interface located on port 1 of an MSM card in slot U7 that has
been channelized to a VT group, starting at channel 1, a VT group of 5, and a tributary of 4 within that
group. The interface has a logical unit number of 0, for example, ds1-u7/1:1:5-4.3.

Note
There can only be one logical interface which is used for CES.

• E-1 Interface: Corresponds to an interface located on port 2 of an MSM card in slot U6 that has been
channelized to E-1, starting at channel 3, TUG-3 group 3, TUG-2 Group 7, TU-12 2. This interface has
a logical unit number of 0, for example, e1-u6/2:3-3:7-2.10.

Note
There can only be one logical interface which is used for CES.

• DS-1 Channel Group Interface: There are a number of names for DS-1 and E-1 channel group
interfaces, all beginning with ds. The DS-1 channel group via VT-Group corresponds to an interface
located on port 2 of an MSM card in slot U5 that has been channelized to a DS-1 channel group,
starting at DS-3 channel 2, VT Group 7, and a tributary of 4 within that group, with the first DS-0
starting at 3. The interface has a logical unit number of 14. For example, ds-u5/2:2:7-4:3.14.

Ribbon Communications Inc. Proprietary 260

 Ports and Interfaces

• GRE Interface: Corresponds to a GRE interface that has a logical unit number of 53, for example,
gre0.53.
• Loopback Interface: Corresponds to the primary logical loopback interface on the device, for
example, lo0.0.
• Tunnel Interface: Corresponds to a tunnel interface on port 11 of the 20-Port Gigabit Ethernet card in
slot NPB7. The unit number is 0. For example, t-ge-u7/11.0.
• Multilink Bundle Interface: Corresponds to a multilink interface that uses the multilink bundle named
bundle_1. The unit number is 0. For example, ml-bundle_1.0.

Router ID and Primary Address

The router ID is the primary IP address of the router. The router uses the primary address as the source
address for traffic originating at unaddressed interfaces. BGP and OSPF also use the primary address to
form adjacencies with remote peers.
If a router ID is not configured, the address of the primary loopback (lo0.0) becomes the router ID.

Note
For detailed information about router ID selection and configuration, see the STMS User Guide.

Primary Interface
The primary interface of a router is the interface the router uses to send packets when a specific interface is
not specified and the destination address does not imply a specific interface.
The default primary interface is the lowest addressed interface that is multicast-capable. If no such interface
exists, the default interface is the point-to-point (P2P) interface with the lowest address.

IP Addresses and Interfaces

Follow these rules when assigning IP addresses to interfaces:
• Only one IP address can be assigned to a logical interface.
• IP addresses assigned to broadcast interfaces, such as Ethernet interfaces, cannot have a
subnetwork mask of 32.
• IP addresses assigned to logical loopback interfaces can only have a subnetwork mask of 32.
• Reserved IP addresses cannot be assigned to interfaces.
• Broadcast and network IP addresses cannot have all 1s in the host position
(e.g., 1.1.1.255/24 or 1.1.1.0/24).
• One IP address cannot be assigned to multiple interfaces.

View Port Properties

This section explains how to view port configuration details.
Start
• In the Network Explorer tab (or in Chassis view), right-click the port and select Properties.
The port properties appear in the right pane. The tabs that appear depend on the type of port. For
example, when viewing an optical port with a transceiver, a Transceiver tab is available under the
Properties tab.

Ribbon Communications Inc. Proprietary 261

 Ports and Interfaces

Enable or Disable a Port

You can enable/disable a port.
Start
1. In the Network Explorer tab (or inChassisview), right-click the port you want to enable/disable.
2. (Optional) If a given port has not yet been configured (or if the port configuration has been deleted via
lsh), right-click the port and select Configure from the shortcut menu.
3. Select Actions > Enable or Disable.

Configure Ports
This procedure provides the general guidelines for configuring ports.
See also:
• Configure TM200EN and TM100_2EN Card Ports
• Configure Frequencies for an OCHP Port
• Configuring an OCHP Port for Alien Transmission

Important
For port configuration rules specific to each card, see the relevant card description in Cards and
Modules.

Note
For TM200EN/TM100_2EN card ports, see Configure TM200EN and TM100_2EN Card Ports.

Start

Ribbon Communications Inc. Proprietary 262

 Ports and Interfaces

1. From Chassis view, right-click the card and select Configure Port.
The Port Configuration window opens.

2. In the Select column, select the checkboxes of the ports you want to define.
3. In the New Type column, select the port interface type for each port.

Note:
You can view the port configuration rules for the TM200EN/TM100_2EN card by clicking
Configure Port Rules.

4. For the AoC10_L2 card only, select the Port Mode for each port.
5. For a TM800/TM1200 card, select the Line-Rate for each port.
6. For GE ports on HIO10_20/HIO100_2 cards, select the Interface Type.
7. In the Configured Transceiver column, the options vary according to the selected port type:
◦ For ports with pluggable transceivers, you can select the transceiver type (for example: all client
ports, OTU2/2e/2f/1, OSC).
◦ For ports with built-in transceivers, the transceiver type is set and cannot be changed (for example:
OTU4).
◦ For ports without transceivers, the transceiver type is empty (for example: OTS, OCHP).
8. The Actual Transceiver Type column shows the actual transceiver installed. For newly assigned
ports, you can copy the actual transceivers to the configured transceivers by selecting the relevant
ports and clicking Copy Actual Transceiver to Configured.
9. For OCHP ports, select the relevant frequency in the Tx Frequency column. You can either select the
value from the dropdown list or click select and select it in the Frequency Selection window.
You can configure both Tx and Rx frequencies for OCHP ports via the Port Properties view, as
described in Configure Frequencies for an OCHP Port.
10. (Optional) Select a Severity Profile or PM Profile for the port. (For more information, see Severity
Profiles and PM Profiles in the STMS Performance Management Guide.)
11. Click Finish.

Ribbon Communications Inc. Proprietary 263

 Ports and Interfaces

Note
From STMS V10, there is support for the TM400ENB card including FC6400 client port type.
This is applicable for port types 33, 35 and 36 for the OTRMRS56_SR/LR transceiver.

Configure TM200EN and TM100_2EN Card Ports

This section describes how to configure TM200EN/TM100_2EN card ports.
Start
1. From Chassis view, right-click the card and select Configure Port.
The Port Configuration window opens.

2. In the Select column, select the checkboxes of the ports you want to define.
3. In the New Type column, select the port interface type for each port.

Note
You can view the port configuration rules by clicking Configure Port Rules.

4. The number of ODU4-1 TSs and ODU4-2 TSs for each port you define are updated according to the
port type selected. To view the number of ODU4 TSs used per port type, click ODU4 TSs.
The ODU4TSs window opens.

Ribbon Communications Inc. Proprietary 264

 Ports and Interfaces

5. Check the Sum information for the ODU4-1 TSs/ODU4-2 TSs to verify that they do not exceed the
maximum capacity.

6. (Optional) Select a Severity Profile or PM Profile for the port. (For more information, see Severity
Profiles and PM Profiles in the STMS Performance Management Guide.)

Configure Frequencies for an OCHP Port

You can configure Tx and Rx frequencies for OCHP ports. When configuring a new OCHP port, you can only
define the Tx frequency for the port. To configure both Tx and Rx frequencies, you must open the port
properties view.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the OCHP port and select Properties.
The port properties appear.
2. Click the OCHP Attributes tab.
The OCHP attributes appear.

Ribbon Communications Inc. Proprietary 265

 Ports and Interfaces

3. In the Misc Attributes section, configure the Rx Frequency and Tx Frequency fields. You can either
select the value from the dropdown menus or click Select and select the frequencies in the
Frequency Selection window:

If Flex Grid View is enabled in the User Preferences, do one of the following:
◦ Configure the Rx Frequency, Tx Frequency, Rx Bandwidth and Tx Bandwidth attributes using
the dropdown menus.
OR
◦ Click Select next to the Rx Bandwidth and Tx Bandwidth attributes, and configure the attributes
using the grid in the Frequency Selection window (which is different in Flex Grid mode):

Ribbon Communications Inc. Proprietary 266

 Ports and Interfaces

You must select the relevant cells in the grid and click Select to save.
4. Click Apply.

Configuring an OCHP Port for Alien Transmission

To enable Apollo equipment to communicate with alien (non-Apollo/external/third-party) equipment, you must
configure an OCHP port (on the relevant Mux/DeMux, TFA, or ROADM) that will be able to send and receive
transmissions to/from the alien equipment. This section describes how to configure an OCHP port for alien
transmission.
For alien transmission up to 200GHz, you configure Alien Lambda. For alien transmission over 200GHz and
up to 500GHz, you configure Alien Spectrum.

Configure Alien Lambda

Start
1. Configure an OCHP port on the relevant Mux/DeMux, TFA, or ROADM.
2. In the Network Explorer tab (or in Chassis view), right-click the port and select Properties.
The port properties appear.

Ribbon Communications Inc. Proprietary 267

 Ports and Interfaces

3. Click the OCHP Attributes tab.

The OCHP attributes appear.

4. For Alien Lambda, select Enable.

5. In the Misc Attributes section, select the relevant frequencies for the Rx Frequency and Tx
Frequency fields (see Configure Frequencies for an OCHP Port).
6. Click Apply.
7. Define the rest of the OCHP attributes (preferably as many as possible).

Important
It's possible to configure the OCHP port with minimal attribute definitions only; however, it is
recommended that you define as many attributes as possible, as it will enable STMS to better
manage the alien lambda transmissions.

8. Click Apply.
The changes are saved.

Configure Alien Spectrum

You can only configure Aline Spectrum if If Flex Grid View is enabled in the User Preferences. For more
information on User Preferences, see the STMS Getting Started and Administration Guide.
Start
1. Configure an OCHP port on the relevant Mux/DeMux, TFA, or ROADM.
2. In the Network Explorer tab (or in Chassis view), right-click the port and select Properties.
The port properties appear.

Ribbon Communications Inc. Proprietary 268

 Ports and Interfaces

3. Click the Alien tab.

The Alien tab appears.

4. For Alien Spectrum, select Enable.

5. Click Apply.
The changes are saved.

Configure OCH sub-if as Alien Spectrum

Start
1. In the Network Explorer tab (or in Chassis view), right-click the sub interface, and select Properties.
The sub-if properties appear.
2. Click the Alien Spectrum tab.
The Alien Spectrum tab appears.

Ribbon Communications Inc. Proprietary 269

 Ports and Interfaces

3. In the Typical/weakest channel Properties area configure the properties described in the following
table.

Typical/weakest channel properties

Attribute Name Description Default Range Step Size

Bandwidth (GHz) BW = n x 12.5GHz where 50 50 - 200 GHz 12.5

n = 4, 5, … 16

TX OSNR (dB) The transmitted channel 40 15-50 dB 1

OSNR at the network input

Tx Acc Power (mW) The transmitted channel 0 0-50 1

accumulated power at the
network input

OSNR tolerance 17 10-35 1

(dB)

Acc Power Nonlinear tolerance 25 10-70 (mW) 1mW

Tolerance (mW)

4. Click Apply.
The changes are saved.

Ribbon Communications Inc. Proprietary 270

 Ports and Interfaces

Loopback Interfaces
You can configure one or more logical loopback interfaces on the loopback interface (lo0) of an NE. You can
also configure protocol families for the logical loopback interfaces.
The loopback interface for an NE is displayed under the primary RCP card in the Network Explorer tab. Any
loopback logical interfaces that are configured (e.g., lo0.0, lo0.1, lo0.2) are contained in the Loopback
Interfaces folder.

Notes
• The logical loopback interface lo0.0 is referred to as the primary logical loopback interface.
• This feature is not currently available on 9200 series NEs.

See also:
• Enable or Disable a Loopback Interface
• Create a Logical Loopback Interface
• Enable or Disable a Logical Loopback Interface
• Enter a Description for a Logical Loopback Interface
• Delete a Logical Loopback Interface
• View the Interfaces in a Loopback Interface Folder
• View Logical Loopback Interface Properties

Enable or Disable a Loopback Interface

This section describes how to enable/disable a loopback interface (lo0).
Start
• In the Network Explorer tab, right-click the loopback interface (lo0) and select Actions >Enable or
Disable.

Create a Logical Loopback Interface

This section describes how to create a logical loopback interface.
Start
1. In the Network Explorer tab, right-click the corresponding Loopback Interfaces folder and select
Create Loopback Interface.
The Input window opens.
2. Enter the unit number for the loopback interface and press ENTER.
A new logical loopback interface is created.

Enable or Disable a Logical Loopback Interface

This section describes how to enable/disable a logical loopback interface.
Start
1. In the Network Explorer tab, click the Loopback Interfaces folder.
2. In the Admin column, select/clear the checkbox that corresponds to the logical loopback interface you
want to enable/disable.
3. In the list, right-click the logical loopback interface you want to enable/disable and select Properties.
The properties of the logical loopback interface appear.
4. In the Logical Interface tab, in the Administrative Status list, select Enabled or Disabled.
5. Click Apply.

Ribbon Communications Inc. Proprietary 271

 Ports and Interfaces

Enter a Description for a Logical Loopback Interface

You can specify a text description for a logical loopback interface. Typically, this description defines the
usage of the interface.
Start
1. In the Network Explorer tab, click the Loopback Interfaces folder.
2. In the Description column, double-click the cell that corresponds to the logical loopback interface for
which you want to enter a description.
3. In the cell, enter a description of the interface and press <Enter>.
or
4. In the Network Explorer tab, click the Loopback Interfaces folder.
The logical loopback interfaces contained in the folder are listed in the View panel.
5. In the list, right-click the logical loopback interface for which you want to specify a description and
select Properties.
The properties of the logical loopback interface appear.
6. In the Logical Interface tab, in the Description field, enter a description of the interface.
7. Click Apply.

Delete a Logical Loopback Interface

This section describes how to delete a logical loopback interface.
Start
1. In the Network Explorer tab, click the Loopback Interfaces folder.
The logical loopback interfaces contained in the folder are listed in the View panel.
2. In the list, right-click the logical loopback interface that you want to delete and click Delete.
The logical loopback interface is deleted.

View the Interfaces in a Loopback Interface Folder

The logical loopback interfaces contained in a particular Loopback Interfaces folder in the Network
Explorer tab are listed in an Interfaces table.
Start
• In the Network Explorer tab, click the corresponding Loopback Interfaces folder.
The logical loopback interfaces contained in the folder appear in the View panel.

The Loopback Interfaces table contains the following columns.

Ribbon Communications Inc. Proprietary 272

 Ports and Interfaces

Loopback Interfaces table

Field Description

Name (read only) Name of the logical loopback interface.

Admin Administrative status of the logical loopback interface:

• Enabled
• Disabled

Oper (read only) Operational status of the logical loopback interface:

• Up: Operational.
• Down: Not operational.
• Blank: Not known.

IP Addr IP address (including IP mask) for an INET protocol family.

ISO Addr ISO address for an ISO protocol family.

Description Description of the logical loopback interface.

View Logical Loopback Interface Properties

You can view the properties for a logical loopback interface.
Start
1. In the Network Explorer tab, click the corresponding Loopback Interfaces folder.
The logical loopback interfaces contained in the folder appear in the View panel.
2. In the list, right-click the logical loopback interface for which you want to view the properties and select
Properties.
The properties of the logical loopback interface appear.

Ribbon Communications Inc. Proprietary 273

 Ports and Interfaces

Logical loopback interface properties

Field Description

Name (read only) Name of the logical loopback interface.

Chassis (read only) Host name of the NE or the IP address of the NE's
management interface.

Operational Status (read only) Operational status of the logical interface:

• Up: Operational.
• Down: Not operational.
• Unknown: Not known.

Interface Type The type of logical interface, displayed as Loopback

(read only) (loopback interface).

Interface Index (read only) SNMP ifIndex number.

Time since state change (read only) Time since the last change in operational status.

Layer2 Protocol Name of Layer 2 protocol.

Encapsulation Logical interface encapsulation, displayed as None.

Cross Connected (read only) Whether the logical loopback interface is cross-connected.

Customer Customer assigned to the loopback interface.

Description Description of the logical loopback interface.

Administrative Status Administrative status of the logical loopback interface:

• Enabled
• Disabled

Define TR10_4EN-TR10_12EN Encryption Settings

Traffic data entering or exiting the ODU2 sub-interface of the OTU2/OTU2e/OTU2f line of TR10_4EN/
TR12_EN cards is encrypted. You can define the encryption settings for each OTU2/OTU2e/OTU2f line port
of a TR10_4EN card. For the TR10_12EN card you can only define the encryption settings if an XC is
created between the line and client ports of the card.
This section describes how to define encryption settings for an OTU2/OTU2e/OTU2f line port.
Start
1. In the Network Explorer tab, click L1 Interfaces below the relevant OTU2/OTU2e/OTU2f line port of
the TR10_4EN/TR12_EN card.
The L1 Interfaces List appears.

Ribbon Communications Inc. Proprietary 274

 Ports and Interfaces

2. Right-click the relevant ODU2 interface and select Properties.

The ODU2 properties window opens.
3. In the Properties tab, select the ODU Attributes tab.

4. In the Encryption Data pane, define the following:

◦ Peer IP: Select the NE peer IP for secure communication with the NE.
◦ GCM Mode: Select Monitor or Standard mode.
◦ DH Group: Select the DH group (see Define Diffie Hellman (DH) Groups) to define the encryption
keys.

Ribbon Communications Inc. Proprietary 275

 Ports and Interfaces

5. Click Close.

Note
If the peer IP was already defined via NMS (during the creation of an LP/ODU trail), the Peer
IP attribute will be read-only.

The encryption settings for the respective line port is saved.

Define TR10_12ENB Encryption Settings

You can define the encryption settings for the TR10_12ENB card if an XC is created between the line and
client ports of the card.
Start
1. In the Network Explorer tab, click L1 Interfaces below the relevant OTU2/OTU2e/ line port of the
TR10_12ENB card.
The L1 Interfaces List appears.

2. Right-click the relevant ODU2/ODU2e interface and select Properties.

The ODU2 properties window opens.
3. In the Properties tab, select the ODU Attributes tab.

Ribbon Communications Inc. Proprietary 276

 Ports and Interfaces

4. In the Encryption Data pane, define the following:

◦ Peer IP: Select the NE peer IP for secure communication with the NE.
◦ Encryption: Select Enable to enable encryption.
◦ DH Group: Select the DH group (see Define Diffie Hellman (DH) Groups) to define the encryption
keys.
◦ Key Rotation: Select the frequency at which the transmitter key will be rotated.
◦ Peer Interface: Enter the client interface in the remote peer system to which the traffic from the
local client interface will be carried in an encrypted form.
◦ GCM Mode: Select Standard mode.
5. Click Close.

Note
If the peer IP was already defined via NMS (during the creation of an LP/ODU trail), the Peer
IP attribute will be read-only.

The encryption settings for the respective line port is saved.

Define TM200EN-TM100_2EN Encryption Settings

You can define encryption settings for the TM200EN/TM100_2EN cards if an XC is created between the line
and client ports of the card.
There are various guidelines you must follow when configuring TM200EN/TM100_2EN ports. See Configure
Ports.
Start
1. In the Network Explorer tab, right-click the relevant card and select Ports Encryption.
The Ports Encryption window opens.

Ribbon Communications Inc. Proprietary 277

 Ports and Interfaces

2. Define the following settings for client ODUs that have XCs:
◦ Encryption: Select Enable to enable encryption.
◦ GCM Mode: Select Monitor or Standard mode.
◦ Peer IP: Select the NE peer IP for secure communication with the NE.
◦ DH Group: Select the DH group (see Define Diffie Hellman (DH) Groups) to define the encryption
keys.
3. (optional) To define the same NE peer IP for the client ODUs cross-connected to the same line port,
select the Select Peer IP radio button in the row with the defined peer IP, and click Set selected Peer
IP to all Enable ODUs of same line.
The peer IP is updated for the relevant client ODUs.
4. Click Apply.
The encryption settings are saved.

Define TM200ENB-TM100_2ENB Encryption Settings

You can define encryption settings for the TM200ENB/TM100_2ENB cards if an XC is created between the
line and client ports of the card.
There are various guidelines you must follow when configuring TM200ENB/TM100_2ENB ports. See
Configure ports.
Start
1. In the Network Explorer tab, right-click the relevant card and select Ports Encryption.
The Ports Encryption window opens.

2. Define the following settings for client ODUs that have XCs:
◦ Encryption: Select Enable to enable encryption.
◦ GCM Mode: Select Standard mode.
◦ Peer Interface: Enter the client interface in the remote peer system to which the traffic from the
local client interface will be carried in an encrypted form.
◦ Peer IP: Select the NE peer IP for secure communication with the NE.
◦ Key Rotation: Select the frequency at which the transmitter key will be rotated.
◦ DH Group: Select the DH group (see Define Diffie Hellman (DH) Groups) to define the encryption
keys.
3. (optional) To define the same NE peer IP for the client ODUs cross-connected to the same line port,
select the Select Peer IP radio button in the row with the defined peer IP, and click Set selected Peer
IP to all Enable ODUs of same line.
The peer IP is updated for the relevant client ODUs.

Ribbon Communications Inc. Proprietary 278

 Ports and Interfaces

4. Click Apply.
The encryption settings are saved.

Define HIO400EN-MIO200EN Encryption Settings

You can define encryption settings for the HIO400EN/MIO200EN cards on the OTU4.OTUC2 line ports of the
card.
There are various guidelines you must follow when configuring HIO400EN/MIO200EN ports. See Configure
ports.
Start
1. In the Network Explorer tab, right-click the relevant card and select Ports Encryption.
The Ports Encryption window opens.

2. Define the following settings for client ODUs that have XCs:
◦ Encryption: Select Enable to enable encryption.
◦ GCM Mode: Select Standard mode.
◦ Peer IP: Select the NE peer IP for secure communication with the NE.
◦ DH Group: Select the DH group (see Define Diffie Hellman (DH) Groups) to define the encryption
keys.
3. Click Apply.
The encryption settings are saved.

OTDR Management
OTDR is an optoelectronic device used to test the characteristic of an optical fiber. The OTDR injects a
series of optical pulses into the tested fiber and examines the light scattered or reflected back from the end
of the fiber. The strength of the return pulses is measured and integrated as a function of time.
OTDR functionality is supported in any Apollo amplifier that supports 100 Mbps OSC with an SFP, by simply
replacing the regular OSC SFP with the OTDR1_L5 transceiver. For more information, see OTDR.
You can manage OTDR using two commands:
• Start OTDR Calibration: You must run this command after installing a new fiber span and after the
fiber span is modified or repaired. This command activates the OTDR testing of the fiber span
connected to the SFP output. At the end of the calibration test, the OTDR creates a list of numbers
that represent the location of points with high reflection. This Reference list is stored by the RCP and
used to evaluate the fiber characteristics in a real test.
• Start OTDR Test: This command activates the OTDR test, which locates fiber cuts by comparing the
farthest reported point with the points in the Reference list (created by the calibration test). The test
results indicate the distance to fiber cut in kilometers.
For more information, see the Apollo Reference Manual.

Start OTDR Calibration

The Start OTDR Calibration command activates the OTDR testing of the fiber span connected to the SFP
output. You must run this command after installing a new fiber span and after the fiber span is modified or
repaired.

Ribbon Communications Inc. Proprietary 279

 Ports and Interfaces

Start
1. In the Network Explorer tab (or in Chassisview), right-click the relevant OSC port and select
Properties.
The port properties appear.
2. In the Main tab, select OTDR1_L5 from the Configured Transceiver Type dropdown list and click
Apply.
The transceiver type is updated and the OTDR buttons are enabled.

3. Click Start OTDR Calibration.

The Start OTDR Calibration command runs.
A Reference list containing the location of points with high reflection is created.
A confirmation message appears upon completion.

Start OTDR Test

The Start OTDR Test command activates the OTDR test, which locates fiber cuts by comparing the farthest
reported point with the points in the Reference list (created by the calibration test).
Start
1. In the Network Explorer tab (or in Chassisview), right-click the relevant OSC port and select
Properties.
The port properties appear.
2. In the Main tab, select OTDR1_L5 from the Configured Transceiver Type dropdown list and click
Apply.
The transceiver type is updated and the OTDR buttons are enabled.

Ribbon Communications Inc. Proprietary 280

 Ports and Interfaces

3. Click Start OTDR.

The Start OTDR command runs.
◦ If the farthest reported point is different from any of the points in the Reference list by at least +/-25
m (82 feet), it is considered a fiber cut. A message appears indicating the distance to fiber cut (in
km).
◦ If the farthest reported point is equal to one of the reference points +/-25 m (82 feet), the farthest
point is reported as a fiber cut with a warning message stating that the results are inconclusive,
and that the fiber cut is indicated as a reference point.
◦ If no reflection is detected, a message appears, stating there is no information.
◦ If the Reference list does not exist (for example, because the OTDR calibration test was not
performed), the farthest point is reported with a warning message stating that the results are
inconclusive and that the OTDR calibration test was not performed.
◦ In case of time-out or any other hardware failure, a message appears, stating that the OTDR test
failed.

Run OTDR_8 Tests

The OTDR_8 card is an OTDR card that can monitor up to 8 fibers (one at a time). It enables running tests to
detect, locate, and measure elements at any location on a fiber optical link.
For more information about the OTDR_8 card, see OTDR_8.
Start
1. If it isn't already defined, create fiber connectivity between the OTDR_8 port and the OTDRTAP port of
either an OTDR filter card or a Raman amplifier card (with an OTDRTAP port).
2. Right-click the NE on which the OTDR_8 card is assigned and select Properties.
3. In the Main tab, for OTDR File Transfer, define the Protocol and enter the STMS User ID and
Password.

Note
The STMS receives OTDR_8 test results in an SOR file from the NE. These settings enable
the SOR file transfer between the NE and the STMS.

Ribbon Communications Inc. Proprietary 281

 Ports and Interfaces

4. Right-click the OTDR_8 port and select Properties.

The OTDR_8 port properties appear.
5. Open the Scan tab.
The OTDR test attributes appear.

6. If this is the first time you are running an OTDR test on this port, define the fiber span and OTDR
parameters in the Fiber Properties and OTDR parameters tabs. If not, just check that they are
defined correctly.
For a description of the attributes, see the tables below.

Ribbon Communications Inc. Proprietary 282

 Ports and Interfaces

7. In the Scan tab, click the relevant test button:

◦ Regular Test: Runs the regular OTDR test. Results are compared with the Reference test.
◦ Reference Test: Runs the Reference test, which serves as a baseline for comparing future tests
on the port. Usually performed during initial setup or after changes to test conditions or
configurations.
◦ RAMAN Pre-Installation Test: Used for pre-installation qualifying of Raman spans.

Note
You can view the Reference test results and last test results by clicking the Reference Test
Results and Last Test Results buttons.

A confirmation prompt appears.

Upon confirmation, the test starts to run. The test results appear in a new window.

Ribbon Communications Inc. Proprietary 283

 Ports and Interfaces

Fiber properties

Attribute Description

Span Length Expected OTDR Span that will be used by the NE to calculate the Target
Dynamic Range for OTDR tests (except for the Raman Pre-Installation test
that always zooms in on the first 10km)

Peer OTDR Tap Card Type of card linked to the OTDR port. Raman for a Raman amplifier card or
Other for any OTDR filter card.

Fiber Attenuation Expected value that will be used by the NE to calculate the Target Dynamic
Coefficient Range for OTDR tests.

High Reflection Fiber Default is No. When Yes is selected, it enables operating the OTDR with
non-default test parameters, in order to achieve higher dynamic range (only
used for problematic links, for which the default settings do not provide the
expected results).

Alarm Sensitivity Default is High. When false alarms are received repeatedly for a specific
port/link, you can change the alarm sensitivity to Medium or Low. This will
change the thresholds that trigger the alarms, in order to minimize the
trigger of false alarms.
CAUTION: This can result in the masking of REAL alarm cases.

Fiber degradation alarm Defines the tolerable increase of event loss relative to the measured
threshold reference. A fiber degradation alarm will be raised when the event loss
increases above the defined threshold.

IOR (index of refraction) The index of refraction of the monitored fiber. The event distance calculation
is based on the speed of light in the fiber, which is determined by the IOR.
An accurate IOR leads to an accurate speed of light, which results in an
accurate calculated distance.

Ribbon Communications Inc. Proprietary 284

 Ports and Interfaces

OTDR parameters

Attribute Description

Configuration mode Defines the configuration mode. Select one of the following:
• Manual: Expert mode, which enables you to define the OTDR
parameters manually.
• Automatic: The I/O defines the OTDR parameters automatically.

Range Defines the OTDR monitored range, in kilometers.

Pulse width Defines the relevant pulse width according to the range selected.

Resolution Defines the measurement resolution.

Acquisition time Defines the duration of the OTDR measurement.

Upload SOR Files from an NE

OTDR_8 test results are stored in SOR files on the NE. When you discover an NE that has SOR files, you
can upload the last SOR files from the NE.
Start
• In the Network Explorer tab, right-click the NE and select Actions > Upload all OTDR last SOR
files.
The SOR files are uploaded.

View ONCP Data

You can view ONCP data if it exists for an optical port, in table or graph format.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the port and select Properties.
The port properties appear in the right pane.
2. Select the Optical Parameters tab.
The ONCP data appears in table format in the ONCP Data/Info for Input Channels and ONCP Data/
Info for Output Channels areas.

Occasionally, the STMS is unable to display ONCP data for all the available channels in the
Optical Parameters tab. To see all the available channels, open the Optical Parameters
directly from the port, which opens the tab in its own window. Expand the window until all the
channels are visible.

Ribbon Communications Inc. Proprietary 285

 Ports and Interfaces

3. To view the ONCP data in graph format, click Input Graph or Output Graph respectively.

Note
The Input Graph or Output Graph buttons are only enabled if ONCP data exists for the input/
output channels.

A window opens, displaying the ONCP data in graph format.

Configure LOS Threshold

You can configure LOS threshold for an OTS port.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the OTS port and select Properties.
The port properties appear in the right pane.
2. Select the Ots Attributes tab.
3. In the Los threshold field, enter a value between -24 dBm and -40 dBm.
4. Click Apply.

Define Performance Margin Threshold

The performance margin estimation is based on the equivalence between Bit-error-rate (BER) and system
performance (expressed as Q-value).
The known pre-FEC BER value that leads to FEC breach is expressed as Q0(dB), the Q-value that
corresponds to FEC breach.
A specific performance margin, XdB, means a Q-value of Q0+XdB. This Q-value is then translated into its
equivalent pre-FEC BER value (pre-FEC BER threshold).

Ribbon Communications Inc. Proprietary 286

 Ports and Interfaces

An alarm is raised when the actual pre-FEC BER crosses the defined pre-FEC BER threshold.
For example, assume a transceiver with FEC breach of 1.50E-2, which is equivalent to Q-value 6.73dB, i.e.
Q0 = 6.73dB. A 3dB performance margin means Q0 = 9.73dB, which is equivalent to 1.08E-3.
In this case, an alarm is raised when the measured pre-FEC BER is worse than 1.08E-3.
You can define the performance margin threshold for the following ports:
• OTU4 port with FEC-Mode FEC/SD-FEC/SD-FEC15/SD-FEC25
• OTUCn port with FEC-ModeSD-FEC15/SD-FEC25
• OTU2/2e/3e2 port with FEC-Mode FEC/EFEC7
You can also define the he Q-Factor and Q-Margin PM counters for the following transceivers: and the cards
that support these transceivers:
• OTR600/400
• OTR200P2_CFO/OTR100P2_CFO
• OTR200P2_CF/OTR100P2_CF
• OTR400P2_CF26
• OTR400P2_CFA1
• OTR100PT_CF
• OTR400E/600E
Q factor and Q margin are not supported on OTU2 /3 line rates (OTU2/2e/3e2 port with FEC-Mode FEC/
EFEC7).
Start
1. In the Network Explorer tab, right-click the relevant OTU port and select Properties.
The port properties appear.
2. In the OTU Attributes tab, define the following attributes in the High Pre-FEC BER section:
◦ Monitor: Enables/disables High Pre-FEC BER.
◦ Performance Margin: Automatically defines the Set threshold and Clear threshold.
The rest of the attributes are read-only.
3. Click Apply.
The performance margin threshold is set.

View Configured VPPs

Virtual packet ports (VPPs) are automatically created in the STMS when an ODU Flex trail is created from
LightSOFT. You can only view the configured VPPs from the STMS.
Start
1. In the Network Explorer tab, right-click the VPP folder under the relevant OTU4 port and select
Show List.
The list of VPPs appears.

2. To view a specific VPP's configuration, right click the VPP in the list and select Properties.
The VPP Configuration window opens, displaying the VPP's configuration settings.

Ribbon Communications Inc. Proprietary 287

 Ports and Interfaces

Define the OSPF Area for an OSC Port

You can define the OSPF area for an OSC port. When you define multiple authentication keys per area, you
can also designate a key as the Primary Authentication Key. If you do not configure a Primary
Authentication Key, the system automatically uses the authentication key with the highest KeyID value.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the OSC port and select Properties.
The OSC port properties appear.
2. Click the OSC Attributes tab.
3. From the OSPF Area dropdown list, select the OSPF area.
The Authentication Type is selected automatically for the OSPF area selected.

4. Define the key attributes.

See the table below for a description of the fields.
5. Click Apply.
The OSPF area is defined for the port.

Ribbon Communications Inc. Proprietary 288

 Ports and Interfaces

Authentication Keys fields

Field Description

Key Value Random string of characters. The minimum length is based on the
selected CryptoAlgorithm. For HMAC-MD5, the length is up to 16
bytes, and for HMAC-SHA256, the length is up to 256 bytes.

Key ID Unique numeric value. The minimum value is 0 and the maximum
value is 255.

Primary Key ID The Key IDof the primary authentication key.

Define the OSPF Area for an OTU Port

You can define the OSPF area for an OTU port. When defining an OSPF are you can choose to use one of
the following authentication types:
• None: No authentication is required.
• Cryptographic: The sequence number for authentication is 32 bit.
• Extended: The sequence number for authentication is 64 bit.
When you define multiple authentication keys per area, you can also designate a key as the Primary
Authentication Key. If you do not configure a Primary Authentication Key, the system automatically uses
the authentication key with the highest KeyID value.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the OTU port and select Properties.
The port properties appear.
2. Click the OTU Attributes tab.

3. Under Management Options, from the OSPF Area dropdown list, select the OSPF area .
4. From the Authentication Type dropdown list, select the required authentication type. You can select
from:
◦ None: No authentication is required.
◦ Cryptographic: The sequence number for authentication is 32 bit.
◦ Extended: The sequence number for authentication is 64 bit.
5. In the GMPLS Attrs Area, click Authentication Keys to define the authentication keys.
The Authentication Keys window appears.

Ribbon Communications Inc. Proprietary 289

 Ports and Interfaces

6. Click Add to add a new authentication key.

See the table below for a description of the fields.
7. Click Save to save the authentication key.
8. Repeats steps 6 and 7 if you want to add additional authentication keys.
9. In the Primary Authentication Key field, enter the KeyID of the primary authentication key.
10. Click Apply to save your configuration.
The OSPF area is defined for the port.

Authentication Keys fields

Field Description

KeyID Unique numeric value. The minimum value is 0 and the maximum
value is 255.

KeyValue Random string of characters. The minimum length is based on the

selected CryptoAlgorithm. For HMAC-MD5, the length is up to 16
bytes, and for HMAC-SHA256, the length is up to 256 bytes.

CryptoAlgorithm Choose between Keyed-MD5 and HMAC-SHA256. The default is

Keyed-MD5.

Ribbon Communications Inc. Proprietary 290

 Ports and Interfaces

Define OSPF-TE Authentication for GMPLS Routing

Instances
GMPLS routing instances is the routing instance associated with WSON and ASON topologies and path
computation. You can configure OSPF-TE authentication for GMPLS instances for up to 256 authentication
keys.
When defining an OSPF are you can choose to use one of the following authentication types:
• None: No authentication is required.
• Cryptographic: The sequence number for authentication is 32 bit.
• Extended: The sequence number for authentication is 64 bit.
When you define multiple authentication keys per area, you can also designate a key as the Primary
Authentication Key. If you do not configure a Primary Authentication Key, the system automatically uses
the authentication key with the highest KeyID value.
Start
1. In the Network Explorer tab, right-click the NE and select Properties.
The NE properties appear.
2. Select the CP Attrs tab.
The Configuration tab appears.
3. In the CP Attrs area, confirm that the Gmpls mode is set to either ASON or WSON.

4. In the GMPLS Attrs Area, from the Authentication Type dropdown list, select the required
authentication type. You can select from:
◦ None: No authentication is required.
◦ Cryptographic: The sequence number for authentication is 32 bit.
◦ Extended: The sequence number for authentication is 64 bit.
5. In the GMPLS Attrs Area, click Authentication Keys to define the authentication keys.
The Authentication Keys window appears.

Ribbon Communications Inc. Proprietary 291

 Ports and Interfaces

6. Click Add to add a new authentication key.

See the table below for a description of the fields.
7. Click Save to save the authentication key.
8. Repeats steps 6 and 7 if you want to add additional authentication keys.
The Area field is system generated.
9. In the Primary Authentication Key field, enter the KeyID of the primary authentication key.
10. Click Apply to save your configuration.

Authentication Keys fields

Field Description

KeyID Unique numeric value. The minimum value is 0 and the maximum
value is 255.

KeyValue Random string of characters. The minimum length is based on the

selected CryptoAlgorithm. For HMAC-MD5, the length is up to 16
bytes, and for HMAC-SHA256, the length is up to 256 bytes.

CryptoAlgorithm Choose between Keyed-MD5 and HMAC-SHA256. The default is

Keyed-MD5.

Ribbon Communications Inc. Proprietary 292

 Ports and Interfaces

Define OSPF Areas for DCN Routing Instances

DCN routing instance is the routing instance for routing management messages and control plane
messages. You can define the authentication method for up to 10 OSPF areas for DCN routing. Each area
can be configured with up to 256 authentication keys.

Note
The area 1.1.1.1 is predefined and always appears with the None authentication type set as default.
This area may be removed if no interface is associated with it (including dcn0.0).

When defining an OSPF are you can choose to use one of the following authentication types:
• None: No authentication is required.
• Cryptographic: The sequence number for authentication is 32 bit.
• Extended: The sequence number for authentication is 64 bit.
When you define multiple authentication keys per area, you can also designate a key as the Primary
Authentication Key. If you do not configure a Primary Authentication Key, the system automatically uses
the authentication key with the highest KeyID value.
Start
1. In the Network Explorer tab (or in Chassis view), right-click the NE and select Properties.
The NE port properties appear.
2. Click the DCN Settings tab.

3. Click Add to add a new OSPF area.

Ribbon Communications Inc. Proprietary 293

 Ports and Interfaces

4. In the Area field, enter the ID of the area.

5. From the Authentication Type dropdown list, select the required authentication type. You can select
from:
◦ None: No authentication is required.
◦ Cryptographic: The sequence number for authentication is 32 bit.
◦ Extended: The sequence number for authentication is 64 bit.
6. In the Primary Authentication Key field, enter the KeyID of the primary authentication key.
If you don't know the primary authentication key at this time, continue with the next step to define the
authentication keys for this area, and then come back and enter a value in this field.
7. Click Add to add lines for configuring authentication keys for this area.

Ribbon Communications Inc. Proprietary 294

 Ports and Interfaces

8. Complete the authentication key fields, as described in the table below. You can define up to 256
authentication keys per OSPF area.
9. Click Save to save the authentication keys for this area.

Note
If you want to delete authentication keys for the selected area, select the authentication key
you want to delete, and click Delete Selected.

10. Repeat steps 3 through 9 for each OSPF area you want to configure.

Note
If you want to edit or delete an OSPF area from the DCN Settings tab, select the area nd then
click Edit or Delete Selected, depending on what you want to do.

Authentication Keys fields

Field Description

KeyID Unique numeric value. The minimum value is 0 and the maximum
value is 255.

KeyValue Random string of characters. The minimum length is based on the

selected CryptoAlgorithm. For HMAC-MD5, the length is up to 16
bytes, and for HMAC-SHA256, the length is up to 256 bytes.

CryptoAlgorithm Choose between Keyed-MD5 and HMAC-SHA256. The default is

Keyed-MD5.

Define Spectral Pre-Emphasis

The transmitted signal gets distorted when you increase the high frequencies of its spectrum. Since the
narrow effective bandwidth mostly attenuates the high spectrum frequencies, pre-emphasis of these
frequencies at the transmitter reduces the transmission penalty.
You can define the Spectral Pre-emphasis attribute for the OTUC2 port on the following cards:
• TM200EN

Ribbon Communications Inc. Proprietary 295

 Ports and Interfaces

• TM200ENB
• TR200_2
• HIO400
Start
1. In the Network Explorer tab (or in Chassis view), right-click the OTUC2 port and select Properties.
The OTUC2 port properties appear.
2. In the Main tab, scroll to the Laser Info area.

3. From the Tx Spectral Pre-emphasis dropdown list, select from the following options:
◦ Default (When the OTU Spectral bandwidth is greater than 62.5GHz)
◦ Normal
◦ Mild
◦ Strong1 (When the OTU Spectral bandwidth equals 50GHz)
◦ Strong2
4. Click Apply.
The Spectral Pre-emphasis is defined for the port.

Define Fast State of Polarization Tracking

In extreme cases, such as during lightening storms, the polarization in the fiber rotates at a very high rate.
When this occurs, the receiver may fail to track the fast State of Polarization (SOP) rotations, and hits may
occur.
To prevent this type of scenario you can configure the transceiver to enable fast SOP tracking on the
following cards:
• TM200EN
• TM200ENB
• TR200_2
• HIO400
• TM1200 (inbuilt otr600x2 transceiver)
• TM800 (inbuilt otr400x2 transceiver)
• OTR400P2_CFA2
• OTR400P2, CFA2T
• OTR200P2_CFA2
• OTR400P2_CFA2BD
Start
1. In the Network Explorer tab (or in Chassis view), right-click the OTUC2 port and select Properties.
The OTUC2 port properties appear.
2. In the Main tab, scroll to the Laser Info area.

3. From the State of Polarization dropdown list, select from the following options:
◦ Standard (default): Does not enable fast SOP tracking.
◦ Enhanced: Enables fast SOP tracking.

Ribbon Communications Inc. Proprietary 296

 Ports and Interfaces

4. Click Apply.
The State of Polarization is defined for the port.

Port Maintenance
You can run the following maintenance operations on ports:
• Run an Optical Loopback Command
• Run a Send BDI Command
• Run a Send CSF Command
• Set Test Mode
• Run a Delay Measurement Operation
• Run a PRBS Detection Test

Run an Optical Loopback Command

Notes
• For ROADM_9F/ROADM_20F/ROADM_20CF cards, an Optical Loopback command can
only run on one channel at a time.
• Before running the Optical Loopback command for ROADM_9F/ROADM_20TF cards , you
must activate Tx-Rx-Loop on one of the degree ports of the card by right-clicking the relevant
port and selecting Maintenance Actions > Tx-Rx-Loop. Then physically connect the fiber of
this degree port to itself.

You can run an Optical Loopback maintenance command on a port.

Start
• In the Network Explorer tab (or in Chassis view), right-click the relevant port and select Maintenance
Actions > Loopback.

Notes
◦ For ROADM_9F/ROADM_20TF cards, you must select the CH in the line port in order to
run the loopback command, as the optical loop runs on the OCH sub-interface of the
OTS port.
◦ For ROADM_20CF cards, you must select the CH in the client port order to run the
loopback command, as the optical loop runs on the OCH sub-interface of the OTS or
OCHP port.

The Loopback command starts to run. The maintenance icon appears next to the port.

Run a Send BDI Command

This section describes how to run a Send BDI command on a port.
Start
• In the Network Explorer tab (or in Chassis view), right-click the relevant port and select Maintenance
Actions > Send BDI > Enable.

Note
If the Send BDI command is not available for the selected port, it will not appear in the
Maintenance Actions menu.

Ribbon Communications Inc. Proprietary 297

 Ports and Interfaces

The Send BDI command starts to run. The maintenance icon appears next to the port.

Run a Send CSF Command

This section describes how to run a Send CSF command on a port.
Start
• In the Network Explorer tab (or in Chassis view), right-click the relevant port and select Maintenance
Actions > Send CSF > Enable.

Note
If the Send CSF command is not available for the selected port, it will not appear in the
Maintenance Actions menu.

The Send CSF command starts to run. The maintenance icon appears next to the port.

Set Test Mode

You can set the Test mode for a port.
Start
• In the Network Explorer tab (or in Chassis view), right-click the relevant port and select Maintenance
Actions > Test Mode > Test.

Note
If Test mode is not available for the selected port, it will not appear in the Maintenance
Actions menu.

Test mode is set for the port. The maintenance icon appears next to the port.

Run a Delay Measurement Operation

You can activate the Delay Measurement operation from LightSOFT or from the STMS. You can run a Delay
Measurement operation for ODUk ports only.
Start
1. In the Network Explorer tab, right-click the ODUk port that will be the Source port (start of the trail),
and select Properties.
The port properties appear.
2. In the Maintenance Actions section (of the Main tab), set the Delay Measurement Role attribute to
Source and click Apply.
3. In the Network Explorer tab, right-click the ODUk port that will be the Loop port (end of the trail), and
select Properties.
The port properties appear.
4. In the Maintenance Actions section (of the Main tab), set the Delay Measurement Role attribute to
Loop and click Apply.

The Delay Measurement operation starts running. The maintenance icon appears next to the
ports.

Ribbon Communications Inc. Proprietary 298

 Ports and Interfaces

5. To view the Delay Measurement result, open the Properties of the Source port.
In the Main tab, the delay measurement appears in the Round Trip Delay Measurement field. If it
doesn't, click Refresh.
6. To stop the Delay Measurement operation, set the Delay Measurement Role attribute for both ODUk
ports to None.

Run a PRBS Detection Test

The PRBS generator enables you to run a PRBS detection test on ODUs of terminated OTUk ports.
To perform a PRBS test, you must enable PRBS for outgoing and incoming traffic, and then check that a
message can be sent and received.
Start
1. Right-click the relevant ODU and select Properties.
The ODU properties appear.

2. Under Maintenance Attributes:

◦ From the Pattern Type Tx dropdown list, select PRBS31.
◦ From the Pattern Type Rx dropdown list, select PRBS31.
3. In the Sub-Interfaces list, right-click the ODU sub-if and select Properties.
The ODU Sub-if properties appear.
4. Click the PM Counters tab.
The ODU Sub-if PM counters appear.

Ribbon Communications Inc. Proprietary 299

 Ports and Interfaces

5. From Modes, select if you want the values shown in Octets or Mbps.
6. For Current 15mins PM counters, check the TSE_OutOfsync PM counter.
If the TSE_OutOfsync PM counter was incremented, the test is successful.

Note
If you export the report, the values are always shown on Octets irrespective of your settings on this
page. This also applies to scheduled reports.

Ribbon Communications Inc. Proprietary 300

 L1-XCs

L1-XCs
L1-XCs provide connections between transport entities (signals from tributaries or interfaces). Incoming
signals or tributaries are connected to outgoing signals or tributaries of compatible bandwidth. For example,
you can configure L1-XCs between two OTU2 ports (using ODU2 as the L1-XC endpoints), or between an
OTU2 port and up to four different OTU1 ports (using ODU1 as the L1-XC endpoints). (Detailed connectivity
rules and guidelines are provided later in this section.)
L1-XC connectivity can be configured between:
• Endpoints residing on one or more service cards with Fabric Interface Control (FIC). Cross
connections between cards run through the ODU-XC fabric, via the backplane. For example:
◦ Between endpoints on FIOMR_16 and FIO10_5 cards
◦ Between endpoints on FIOMR_16 and FIO40 cards
• Tributaries on a single service card without FIC. For example:
◦ ODUk L1-XCs on L1 service cards (transponders or AoC cards)
◦ OCH L1-XC on a Mux/DeMux card
To configure an L1-XC on a device, the physical port properties must first be configured, including slots,
cards, and supporting ports. The assumption in this chapter is that the equipment and the L1 interfaces have
already been configured.
You can create and configure L1-XCs for equipment that is already installed or for equipment that is not yet
installed. When you add the pre-configured equipment to the system (by inserting the appropriate card), the
software detects the L1-XCs and applies the configuration. You can also retrieve and modify certain L1-XC
configuration settings under certain circumstances, as described later in this section. Configurable L1-XCs
can be deleted as long as they are not in use by a trail.
See also:
• L1-XC Compatibility Guidelines
• L1-XC Modes
• L1-XC Leg Directionality
• ODU-XC Fabric Support
• L1-XC Protection
• Managing L1-XCs
• L1-XC Connection Tables

L1-XC Compatibility Guidelines

L1-XCs can be configured between matching endpoints supporting the signal rates described in the following
table. Note that the two endpoints must be compatible in terms of rates and payloads, where relevant.

Ribbon Communications Inc. Proprietary 301

 L1-XCs

Supported signal rates for L1-XC endpoints

Endpoint Card Type Connection Guidelines

OMS • Photonic cards • Between two OTS ports

• Passive optics
cards

OCH • Photonic cards • Between two OTS or OCHP ports (any combination)
• Passive optics • Input and output wavelengths between
cards two OCH endpoints must be identical.

ODUk, • L1 service cards ODUk cross connections can be configured between ports on the
including: with FIC same card, for cards without FIC, or between ports residing on
ODU1 • L1 service cards the same or different cards, for cards with FIC. Cards must
without FIC reside within the same NE, on the main platform.
ODU2
Incoming signals or tributaries are connected to outgoing signals
ODU2e or tributaries of compatible bandwidth. Multiplexing signals is
ODU2f supported for greater bandwidth efficiency. For example, up to
four different ODU1s can be multiplexed to an ODU2.
ODU3e

ODUSlot • L1 service cards Proprietary rate developed for lower-rate ports supporting less
with FIC than 1.25 Gbps bandwidth, such as STM1 and ETY1G.
• L1 service cards Up to two adjacent ODUSlot endpoints based in the low-rate
without FIC ports on the client side can be connected to two ODUSlot
endpoints contained within a single ODU1interface at the
network side.
If one of the ODUSlot connections to an ODU1 interface has
been configured as a protected type, then the NE automatically
configures the second ODUSlot connection to that ODU1 as the
protection connection. If the main ODUSlot connection is deleted,
then the NE automatically deletes the protection connection.

ODUFlex L1 service cards - ODUflex (CBR) supports any possible client bit rate as a service
AoC10B, AoC10C, in circuit transport networks. CBR clients use a bit-sync mapping
AoC25B, into ODUflex (239/238xthe client rate).
FIOMR_16B, XC-leg endpoints should use the same ODUFlex type (e.g.
CMR100M ODUF-FC400, ODUF-FC800).
Changes in ODUFlex (CBR) XC rate are the same as in fixed
ODUk.
ODUF-BBE is defined per ODUF type (e.g. ODUF-FC400-BBE,
ODUF-FC800-BBE).

Ribbon Communications Inc. Proprietary 302

 L1-XCs

Endpoint Card Type Connection Guidelines

OS Splitter/coupler cards Relevant for OS interfaces between passive optics ports only.
used for port When a splitter/coupler card is assigned, the NE implicitly
protection configures the card ports and interfaces and creates the
appropriate number of L1-XCs necessary to provide protection
for that card. Each L1-XC is configured with two unidirectional
legs.

L1-XC Modes
L1-XCs are automatically configured in one of the following modes:
• Configurable: L1-XCs that are explicitly created, edited, and deleted by users working through the
management plane. (In V2.0, configurable L1-XCs will also be created by the Control Plane.) Not all
attributes can be edited at any time. Some modifications are traffic-affecting, while others are not.
• Fixed: L1-XCs that are created automatically by the NE without operator intervention. Fixed-mode L1-
XCS are used to connect two endpoints with a unidirectional connection at a single fixed connectivity
rate. Examples include cross connections in amplifiers or in passive optics cards such as DCFs or
Mux/DeMuxes.
Operators are not allowed to create or delete fixed-mode L1-XCs. Operators are allowed to edit non-traffic-
affecting attributes such as trail ID and customer name. When these cross connections are used by a trail,
the relevant trail information is so noted by the L1-XC to prevent inadvertent deletion of a cross connection in
use.

L1-XC Leg Directionality

L1-XCs are actually containers that can hold multiple cross connect legs, where each leg represents a single
connection configured between two endpoints. A protected L1-XC can include up to four legs. An unprotected
L1-XC can include an unlimited number of legs. L1-XC legs are defined with directionality:
• Unidirectional, with up to two independent L1-XC legs configured, one in each direction, between two
endpoints. The direction is indicated by identifying the two endpoints as the starting (from-tp) and
destination (to-tp) endpoints. Note that L1-XCs configured in fixed mode always have unidirectional
legs.
• Bidirectional, with a single two-way L1-XC leg configured between the two endpoints. While the two
endpoints in a bidirectional leg are also identified as the from-tp and to-tp endpoints, these names are
not significant in the classic sense, since this is a bidirectional leg on which traffic is running back and
forth in both directions between the two endpoints. The to-tp endpoint is significant in terms of
protection configurations, since that is the endpoint the NE uses as the basis when creating the
associated protection group.
Note that L1-XC leg directionality depends on the underlying hardware capabilities. Ports that do not support
bidirectionality cannot be configured with bidirectional L1-XC legs.
Directionality of the L1-XC leg is not dependent upon or affected by the direction of the fiber connectivity
configured for the same ports.
Directionality of the L1-XC leg is not dependent upon or affected by the direction of the trails configured for
the same ports, with one exception: a unidirectional trail must be configured over a unidirectional L1-XC.

ODU-XC Fabric Support

ODU-XCs are configured using fabric cards (such as FM1000 cards) to create connections between L1
service cards with FIC (such as FIO10_5, FIO40, and FIOMR_16). The ODUk cross connections are created

Ribbon Communications Inc. Proprietary 303

 L1-XCs

over an ODU-XC fabric, via the backplane. Cards must reside within the same NE on the main platform. The
following figure illustrates a typical ODU-XC configuration.

ODU-XC cross connect configuration

Incoming signals or tributaries are connected to outgoing signals or tributaries of compatible bandwidth. For
example, the following cross connections are currently supported:
• ODU1<->ODU1
• ODU2<->ODU2
• ODU2e<->ODU2e
• ODUSlot<->ODUSlot
ODUSlot is a proprietary rate developed for lower-rate ports supporting less than 1.25 Gbps bandwidth, such
as STM1 and ETY1G. Up to two adjacent ODUSlot endpoints based in the low-rate ports on the client side
can be connected to two ODUSlot endpoints contained within a single ODU1interface at the network side.
Note that throughout the network the ODUSlots are aggregated into ODU1s. Only at the trail edges they are
split into ODUSlot cross connections.
If one of the ODUSlot connections to an ODU1 interface has been configured as a protected type, then the
NE automatically configures the second ODUSlot connection to that ODU1 as the protection connection. If
the main ODUSlot connection is deleted, then the NE automatically deletes the protection connection.
• ODUi<->ODUktrib[m] (where i<k)
For example, the following figure illustrates a cross connection where i=2, k=3, and the ODU2
endpoint is a tributary [0] of an OTU3 port.

ODUi<->ODUktrib[m] (where i<k)

• ODUitrib[n]<->ODUitrib[m]
For example, the following figure illustrates a cross connection between two tributaries of two OTU2
ports.

Ribbon Communications Inc. Proprietary 304

 L1-XCs

ODUitrib[n]<->ODUitrib[m]

Multiplexing is supported for greater bandwidth efficiency. For example, up to four different ODU1s can be
multiplexed to an ODU2.

L1-XC Protection
L1-XCs can support a range of connectivity protection options, both unprotected and protected. During L1-
XC configuration, the NE determines whether any of the protected configurations would be applicable for the
new L1-XC. If so, the NE automatically creates an appropriate protection group object that includes the
relevant L1-XC legs.
If an L1-XC is configured with protection (and is therefore a member of a protection group), all maintenance
actions applied to that L1-XC are automatically applied to both the main cross connection and the protection
group entity. Some maintenance operations may also be applied directly to the protection group by the user.
See also:
• Unprotected Configurations
• Protected Configurations
• Define Y-Protection

Unprotected Configurations
• 1-way unprotected P2P: This is the simplest type of connection. A single L1-XC leg is configured as
a unidirectional P2P connection from an input endpoint port to a compatible output endpoint port of
equal bandwidth. There is no protection built into this connection, and the corresponding L1-XC leg
running in the opposite direction can be used for a completely different service.

1-way unprotected P2P

This type of cross connection is used, for example, when connecting local tributaries on a board or
tributaries from client to line or from line to line.
• 1-way unprotected P2MP: Multiple L1-XC legs are configured as a group of unidirectional P2MP
connections that all originate at the same input port (from-tp), with each one terminating at a different
endpoint (to-tp).

Ribbon Communications Inc. Proprietary 305

 L1-XCs

1-way unprotected P2MP

This type of cross connection is used, for example, when connecting an input port to multiple output
ports for multicast or broadcast applications.
• 2-way unprotected P2P: A single L1-XC leg is configured as a bidirectional P2P connection between
two compatible endpoint ports of equal bandwidth.

2-way unprotected P2P

Note that a bidirectional cross connection may also consist of two unidirectional cross connections
managed together.

Protected Configurations
When the L1-XC structure would support a protection configuration, the NE automatically creates the
appropriate protection group entity.
• 1-way protected P2P: Two unidirectional L1-XC legs that both end at the same endpoint (to-tp).
Each protected L1-XC is associated with a single protection group.

1-way protected P2P

This type of cross connection is used, for example, when creating unidirectional connections between
two source tributaries and a single destination tributary.
• 2-way protected P2P: Two bidirectional L1-XC legs that both end at the same endpoint. Each
protected L1-XC is associated with a single protection group.

Ribbon Communications Inc. Proprietary 306

 L1-XCs

2-way protected P2P

This type of cross connection is used, for example, when creating bidirectional connections between
two source tributaries and a single destination tributary. Note that while the terms source and
destination are not meaningful in the classic sense for a bidirectional leg on which traffic is running
back and forth in both directions, the destination endpoint is significant in terms of protection
configurations, since that is the endpoint the NE uses as the basis when creating the associated
protection group.
• 1-way protected P2MP: Up to four unidirectional L1-XC legs can be configured to create a group of
connections that all originate at different endpoints (from-tp) but all end at the same endpoint (to-tp).
Each protected L1-XC is associated with a single protection group.
This type of cross connection is used, for example, for ROADM-Add applications with multiple drop
points.
• 2-way protected P2MP: Up to four bidirectional L1-XC legs can be configured to create a group of
connections that all originate at different endpoints (from-tp) but all end at the same endpoint (to-tp).
Each protected L1-XC is associated with a single protection group.

2-way protected P2MP

Ribbon Communications Inc. Proprietary 307

 L1-XCs

This type of cross connection is used, for example, for ROADM applications with multiple add/drop
points. Since there are multiple legs protecting the line port, the operator must specify which is the
main leg.
• 1-way fully protected XC: Four unidirectional L1-XC legs can be configured to create a group of
connections that all run between the same set of four endpoints, providing full traffic protection. Each
unidirectional L1-XC leg participates in two different protection group entities.
• 2-way fully protected XC: Four bidirectional L1-XC legs can be configured to create a group of
connections that all run between the same set of four endpoints, providing comprehensive traffic
protection. Each bidirectional L1-XC leg participates in two different protection group entities.

2-way fully protected XC

Define Y-Protection
You can define Y-protection for an LP service running between two cards.
The following example shows a high-level overview of the stages in creating a new Y-protected service.

Y-protection for service running between NE-1 and NE-2

This example illustrates creating a Y-protected LP service running between two TR10_12 cards, installed on
two different NEs, one at each end of the service. With Y-protection, three ports on each card participate in
the service configuration; one as a client port and two as line ports. Any available port on the TR10_12 card
can be used for any of the participating port roles, client or line.
Y-protection between two NEs includes two distinct paths running between the two pairs of line ports on the
NE endpoints. The signal is transmitted and received on both lines. Only one of the signals received by the

Ribbon Communications Inc. Proprietary 308

 L1-XCs

card is processed and forwarded to the client side. The choice of which signal to process is based on PM
parameters for the signal.
Start
1. Assign the first card to the appropriate slot in the NE.
2. Configure a client port and two line ports on the card.
3. Assign the second card, installed on the second NE endpoint.
4. Configure a client port and two line ports on the second card.
5. Perform the following procedures from LightSOFT (see the LightSOFT User Guide):
◦ Create LEs for both cards installed, one on each endpoint NE.
◦ Create a fiber connectivity topology link between one set of line ports.
◦ Create a fiber connectivity topology link between the second set of line ports.
◦ Provision an underlying trail between the first set of line ports.
◦ Provision an underlying trail between the second set of line ports.
◦ Provision an LP trail for the new service.

Managing L1-XCs
The L1-XC is a container that can hold one or more L1-XC legs, with any combination of directionalities,
within a single L1-XC container. Each leg is identified by a unique index number, endpoints, and direction.
The leg endpoints identify the origination and destination points for the L1-XC leg. The directionality identifies
whether this leg is unidirectional, running in one direction only, or bidirectional, running in both directions
between the two endpoints.
You can view, create, edit, and delete L1-XCs, subject to certain guidelines and rules.
• View L1-XCs
• Create L1-XCs
• Modify an L1-XC
• Delete L1-XCs

View L1-XCs
You can view the XCs that exist for all NEs managed by the STMS. Alternatively, use the filter parameters to
filter the results to display only the XCs for a specific card or rate.
Start
1. Right click the NE icon in the Network Explorer tab and select Show XCs.
The XC Manager window opens, listing in detail all the XCs defined for the NE.

Ribbon Communications Inc. Proprietary 309

 L1-XCs

2. If you want to filter the results, select your criteria in the Filter Parameters area, and click Apply.
The relevant XCs are displayed in the Results area.
For ASON/WSON trails, the XC Owners parameter indicates whether the XC is managed by the Control
Plane or STMS. For information about XC owners, see View XC Resource Ownership.

Create L1-XCs
To configure an L1-XC on a device, the physical port properties must first be configured. You can then
configure the underlying equipment, including chassis, cards, and supporting ports. The procedure varies
slightly depending on whether the cards support PT20 or PT21 granularity. PT21 granularity is available on
newer cards, and enables you to select various types of interfaces (see OTN).
See also:
• L1-XC Attributes
• L1-XC Protection Groups
Start
1. From the main menu, select Tools > XC Manager.
The XC Manager window opens.
2. At the bottom of the Results area, click Create.
The Optic XC Configuration window opens.

Ribbon Communications Inc. Proprietary 310

 L1-XCs

3. In the XC Parameters area, enter the following information:

◦ In the NE field, select the NE from the dropdown list.
◦ In the Name field, enter a name for the XC.
◦ In the XC Rate field, select the rate that you require for the XC.
◦ For the Frequency field, click Select and select the DWDM or CWDM frequency.
◦ In the Bandwidth field, select the required bandwidth. If Alien Spectrum is disabled, you can
select a bandwidth of up to 200, If Alien Spectrum is enabled, you can select a bandwidth of up to
500,
◦ Alien Spectrum is is Enabled when the sub-interfaces in the XC are selected.

Note
If Alien Spectrum is enabled, you must configure the Channel properties for the Sub-
interfaces. See Configuring an OCHP Port for Alien Transmission for a description of the
Channel properties.

◦ In the Type field, select the XC type (e.g. P2P Unidirectional, P2MP).
◦ In the Leg Directionality field, select the XC directionality (Unidirectional or Bidirectional).
◦ Enter information for all other fields as required (see L1-XC Attributes).
4. In the tree:
◦ (PT21 only) If any of the endpoints display [PT21] label next to the HO-ODU, right-click the sub-
interface and select Add LO-ODU rate (where LO-ODU rate is the rate defined in XC Rate field of
the XC Parameters area).
A new sub-interface appears in the tree of the selected rate.
◦ (PT20 and PT20) Select the From tp sub-interface and To tp sub-interface and then click Add
Leg. In the XC Details area the XC Leg Info tab shows XC leg details and the Endpoints Info tab
shows details of the From tp and To tp sub-interfaces.

Ribbon Communications Inc. Proprietary 311

 L1-XCs

5. (PT21 only) In Endpoints Info tab, select From tp entry and then to select the timeslot(s) you want to
use:
◦ Click Edit TS.
A window opens, showing the available timeslots and their availability. It also specifies the number
of timeslots that you should select.

◦ Select the timeslot(s) that you want to use and click Finish.
6. Click Activate.
The XCs are activated and available for use.

L1-XC Attributes
You can define the following additional attributes for L1-XCs.

Ribbon Communications Inc. Proprietary 312

 L1-XCs

L1-XC attributes

Attribute/Keyword Options Usage guidelines

NE Select the name of the NE

Name <string> Unique value for each L1-XC, identifying the cross
connection entity.
• Set by the user when the user creates a
configurable L1-XC.
• Assigned automatically by the NE when the NE
creates a fixed L1-XC.

Trail ID • <numeric> • Identifies the trail using this cross connection,

• NULL when in use.
(default) • Null if not in use by any trail.
• This value can be edited.

Connection Mode • configurable • All L1-XCs created explicitly by the user are
(default for user- configurable.
created L1-XCs) • All L1-XCs created automatically by the NE are
• fixed fixed.
(default for NE-created • This value cannot be edited once the L1-XC
L1-XCs) has been created.

Ribbon Communications Inc. Proprietary 313

 L1-XCs

L1-XC leg attributes

Attribute/ Options Usage guidelines

Keyword

Index <numeric> Unique value for each L1-XC leg. Assigned automatically
by the NE.

From Tp <string> Unique string identifying the origination point for this L1-
XC leg. Identifies the endpoint location, using the format:
endpoint-slot/port/interface-index.

To Tp <string> Unique string identifying the destination point for this L1-
XC leg. Identifies the endpoint location, using the format:
endpoint-slot/port/interface-index.

Directionality unidirectional This attribute identifies whether this leg is unidirectional,

bidirectional running in one direction only, or bidirectional, running in
both directions between the two endpoints.
Note that each L1-XC can include multiple legs, where:
• A mixture of directionalities can be configured for the
various legs.
• Only one leg can be bidirectional.
• Two disjoint bidirectional legs can be included within
the same L1-XC.
• Multiple legs can be unidirectional.
This attribute is only assigned when the L1-XC container
includes multiple legs with different directionalities. Note
that when this attribute is assigned for each leg, the
directionality attribute of the L1-XC container is left empty.

L1-XC Protection Groups

Protection groups are entities created to protect various types of objects, such as equipment or ports. If an
L1-XC is configured with the relevant legs, the NE automatically creates the appropriate protection group of
type traffic.
All maintenance operations completed for the L1-XC are automatically applied to the protection group. Some
maintenance operations for the protection group are applied explicitly by the user.
To modify an L1-XC protection group, see Modify a traffic protection group.

Modify an L1-XC
You cannot edit attributes of L1-XCs created in fixed mode. Operators are allowed to edit many of the
attributes of L1-XCs created in configurable mode. Some of these editing actions are traffic-affecting, and
some are not. If a modification to an L1-XC would be traffic-affecting, a warning message is displayed.
See also:
• Non-Traffic-Affecting Modifications
• Traffic-Affecting Modifications

Ribbon Communications Inc. Proprietary 314

 L1-XCs

The following modifications do NOT affect traffic:

• Connection labels: Assigning a different user label to the L1-XC.
• Trail ID: Associating this L1-XC to a specific trail, or removing the association by resetting the value to
null. Note that modifications to one L1-XC within a trail are non-traffic-affecting for any other L1-XCs
assigned to the same trail.
• Adding a leg: Adding an additional leg to a P2MP L1-XC container is non-traffic-affecting for any
other legs in the same L1-XC. Similarly, changing a unidirectional P2P L1-XC leg to a leg in a P2MP
L1-XC by adding legs is non-traffic-affecting for the original leg.
• Deleting a leg: Deleting a leg from a multi-leg L1-XC, when that leg is not the active leg of a protected
L1-XC and at least one leg remains to carry traffic, is non-traffic-affecting.
• Changing a unidirectional leg to bidirectional: Reconfiguring an L1-XC leg that was originally
unidirectional so that it now carries traffic in both directions, (or alternatively, adding a second
unidirectional leg so that traffic can be carried in both directions) is non-traffic-affecting. For example,
if traffic used to run from Point A to Point B, switching the configuration so that the traffic now only runs
in both directions between Point A and Point B.
Changes to the endpoints and direction of a cross connection are often traffic-affecting. The following
modifications affect traffic:
• Switching origin and destination endpoints: Replacing the from-tp endpoint with the to-tp endpoint
in a unidirectional L1-XC leg (and vice versa) is traffic-affecting. For example, if traffic used to run from
PointA to PointB, switching the configuration so that the traffic now runs from PointB to PointA.
• Changing a bidirectional leg to unidirectional: Reconfiguring an L1-XC leg that was originally
bidirectional so that it now carries traffic in one direction only is traffic-affecting. For example, if traffic
used to run back and forth between PointA and Point B, switching the configuration so that the traffic
now only runs from PointA to PointB.
• Changing a subset of the cross connection endpoints: Changing some (but not all) of the
endpoints of a cross connection is traffic-affecting. For example, if traffic used to run from PointA to
PointB, switching the configuration so that the traffic now runs from PointA to PointC.
• Deleting the active leg in a protected L1-XC: If an L1-XC has been configured for protection,
deleting the active leg and moving the traffic to one of the protection legs is traffic-affecting.

Note
If a modification to an L1-XC would be traffic-affecting, a warning message is displayed.

Non-Traffic-Affecting Modifications
The following modifications do not affect traffic.
• Connection labels: Assigning a different user label to the L1-XC.
• Trail ID: Associating this L1-XC to a specific trail, or removing the association by resetting the value to
null. Note that modifications to one L1-XC within a trail are non-traffic-affecting for any other L1-XCs
assigned to the same trail.
• Adding a leg: Adding an additional leg to a P2MP L1-XC container is non-traffic-affecting for any other
legs in the same L1-XC. Similarly, changing a unidirectional P2P L1-XC leg to a leg in a P2MP L1-XC
by adding legs is non-traffic-affecting for the original leg.
• Deleting a leg: Deleting a leg from a multi-leg L1-XC, when that leg is not the active leg of a protected
L1-XC and at least one leg remains to carry traffic, is non-traffic-affecting.
• Changing a unidirectional leg to bidirectional: Reconfiguring an L1-XC leg that was originally
unidirectional so that it now carries traffic in both directions, (or alternatively, adding a second
unidirectional leg so that traffic can be carried in both directions) is non-traffic-affecting. For example,
if traffic used to run from Point A to Point B, switching the configuration so that the traffic now only runs
in both directions between Point A and Point B.

Ribbon Communications Inc. Proprietary 315

 L1-XCs

Traffic-Affecting Modifications
Changes to the endpoints and direction of a cross connection are often traffic-affecting. Note that if a
modification to an L1-XC would be traffic-affecting, a warning message is displayed.
• Switching origin and destination endpoints: Replacing the from-tp endpoint with the to-tp endpoint in a
unidirectional L1-XC leg (and vice versa) is traffic-affecting. For example, if traffic used to run from
PointA to PointB, switching the configuration so that the traffic now runs from PointB to PointA.
• Changing a bidirectional leg to unidirectional: Reconfiguring an L1-XC leg that was originally
bidirectional so that it now carries traffic in one direction only is traffic-affecting. For example, if traffic
used to run back and forth between PointA and Point B, switching the configuration so that the traffic
now only runs from PointA to PointB.
• Changing a subset of the cross connection endpoints: Changing some (but not all) of the endpoints of
a cross connection is traffic-affecting. For example, if traffic used to run from PointA to PointB,
switching the configuration so that the traffic now runs from PointA to PointC.
• Deleting the active leg in a protected L1-XC: If an L1-XC has been configured for protection, deleting
the active leg and moving the traffic to one of the protection legs is traffic-affecting.

Delete L1-XCs
You can only delete configurable L1-XCs that are not currently associated with and in use by a trail. You
cannot delete L1-XCs created in configurable mode if they are currently in use by a trail (i.e., trail-id is not
null). You cannot delete L1-XCs created in fixed mode. These cross connections are created and deleted
automatically by the NE.
When an L1-XC is deleted, the delete action is shown in the Activity Log.
To change the wavelength of an OCH L1-XC, or to change the payload of an ODUk L1-XC, you must delete
the original L1-XC and recreate it with the new attribute values.

L1-XC Connection Tables

The following tables list in detail the L1-XC options available for each type of port and interface.

Ribbon Communications Inc. Proprietary 316

 L1-XCs

ODUk L1-XC options for OTU ports

OTU1 OTU2 OTU2e OTU2f OTU3 OTU3e OTU4

(future)

OTU1 ODU1-XC ODU1-XC N/A N/A ODU1-XC ODU1-XC ODU1-XC

OTU2 ODU1-XC ODU2-XC N/A N/A ODU2-XC ODU2-XC ODU2-XC

ODU1-XC ODU1-XC ODU1-XC ODU1-XC
ODU0-XC ODU0-XC ODU0-XC ODU0-XC

OTU2e N/A N/A ODU2e- N/A ODU2e-XC ODU2e- ODU2e-

XC XC XC

OTU2f N/A N/A N/A ODU2f- N/A N/A N/A

XC

OTU3 ODU1-XC ODU3-XC N/A N/A ODU3-XC N/A ODU3-XC

ODU2-XC ODU2-XC ODU2-XC
ODU1-XC ODU1-XC ODU1-XC
ODU0-XC ODU0-XC ODU0-XC

OTU3e ODU1-XC ODU2-XC ODU2e- N/A N/A ODU3-XC ODU2-XC

ODU1-XC XC ODU2-XC ODU1-XC
ODU0-XC ODU1-XC ODU0-XC
ODU0-XC

OTU4 ODU1-XC ODU2-XC ODU2e- N/A ODU3-XC N/A ODU4-XC

ODU1-XC XC ODU2-XC ODU3-XC
ODU0-XC ODU1-XC ODU2-XC
ODU0-XC ODU1-XC
ODU0-XC
ODUF-
GFP

Ribbon Communications Inc. Proprietary 317

 L1-XCs

ODUk L1-XC options for Ethernet ports

OTU1 OTU2 OTU2e OTU2f OTU3 OTU3e OTU4

(future)

ETY 1Gx ODUSlot- ODUSlot- N/A N/A N/A N/A N/A

XC XC

ETY 1Ge ODU0-XC ODU0-XC N/A N/A ODU0-XC ODU0- ODU0-

XC XC

ETY 1G ODU0-XC ODU0-XC N/A N/A ODU0-XC ODU0- ODU0-

XC XC

ETY 10G N/A ODU2-XC N/A N/A ODU2-XC ODU2- ODU2-

XC XC

ETY N/A N/A ODU2e- N/A ODU2e-XC ODU2e- ODU2e-

10GOC XC XC XC

ETY 40G N/A N/A N/A N/A ODU3-XC N/A N/A

ETY 100G N/A N/A N/A N/A N/A N/A ODU4-

XC

Ribbon Communications Inc. Proprietary 318

 L1-XCs

ODUk L1-XC options for Ethernet ports (continued)

ETY1Gx ETY1Ge ETY1G ETY10G ETY10GO ETY40G ETY100

C G

ETY 1Gx ODUSlot-XC N/A N/A N/A N/A N/A N/A

ETY 1Ge N/A ODU0- N/A N/A N/A N/A N/A

XC

ETY 1G N/A N/A ODU0- N/A N/A N/A N/A

XC

ETY 10G N/A N/A N/A ODU2- N/A N/A N/A

XC

ETY N/A N/A N/A N/A ODU2e- N/A N/A

10GOC XC

ETY 40G N/A N/A N/A N/A N/A ODU3- N/A

XC

ETY 100G N/A N/A N/A N/A N/A N/A ODU4-

XC

ODUk L1-XC options for SDH ports

OTU1 OTU2 OTU2 OTU2 OTU3 OTU3e OTU4 STM1

e f

STM1 ODU0- ODU0-XC N/A N/A ODU0- ODU0-XC ODU0-XC ODU0-XC

XC XC

STM1e ODU0- ODU0-XC N/A N/A ODU0- ODU0-XC ODU0-XC N/A

XC XC

STM4 ODU0- ODU0-XC N/A N/A ODU0- ODU0-XC ODU0-XC N/A

XC XC

STM16 ODU1- ODU1-XC N/A N/A ODU1- ODU1-XC ODU1-XC N/A

XC XC

STM64 N/A ODU2-XC N/A N/A ODU2- ODU2-XC ODU2-XC N/A

XC

Ribbon Communications Inc. Proprietary 319

 L1-XCs

ODUk L1-XC options for SDH ports (continued)

STM1e STM4 STM16 STM64

STM1 N/A N/A N/A N/A

STM1e ODU0-XC N/A N/A N/A

STM4 ODU0-XC ODU0-XC N/A N/A

STM16 N/A N/A ODU1-XC N/A

STM64 N/A N/A N/A ODU2-XC

ODUk L1-XC options for SONET ports

OTU1 OTU2 OTU OTU2f OTU3 OTU3e OTU4 OC3

2e (future)

OC3 ODU0- ODU0- N/A N/A ODU0-XC ODU0-XC ODU0-XC ODU0-

XC XC XC

OC3e ODU0- ODU0- N/A N/A ODU0-XC ODU0-XC ODU0-XC N/A

XC XC

OC12 ODU0- ODU0- N/A N/A ODU0-XC ODU0-XC ODU0-XC N/A

XC XC

OC48 ODU1- ODU1- N/A N/A ODU1-XC ODU1-XC ODU1-XC N/A

XC XC

OC19 N/A ODU2- N/A N/A ODU2-XC ODU2e- ODU2e-XC N/A

2 XC XC

Ribbon Communications Inc. Proprietary 320

 L1-XCs

ODUk L1-XC options for SONET ports (continued)

OC3e OC12 OC48 OC192

OC3 N/A N/A N/A N/A

OC3e ODU0-XC N/A N/A N/A

OC12 N/A ODU0-XC N/A N/A

OC48 N/A N/A ODU1-XC N/A

OC192 N/A N/A N/A ODU2-XC

ODUk L1-XC options for FC ports

OTU1 OTU2 OTU2e OTU2f OTU3 OTU3e OTU4

(future)

FC100 ODU0- ODU0-XC N/A N/A ODU0-XC ODU0-XC ODU0-XC

XC

FC200 ODU1- ODU1-XC N/A N/A ODU1-XC ODU1-XC ODU1-XC

XC

FC400 N/A ODUF- N/A N/A ODUF- ODUF- ODUF-

FC400 FC400 FC400 FC400

FC800 N/A ODUF- N/A N/A ODU2-XC ODUF- ODUF-

FC800 FC800 FC800

FC120 N/A N/A ODU2e- ODU2f- ODU2e-XC ODU2e-XC ODU2e-XC

0 XC XC

FC160 N/A N/A N/A N/A ODUF- ODUF- ODUF-

0 FC1600 FC1600 FC1600

FC320 N/A N/A N/A N/A ODUF- ODUF- ODUF-

0 FC3200 FC3200 FC3200

Ribbon Communications Inc. Proprietary 321

 L1-XCs

ODUk L1-XC options for FC ports (continued)

FC100 FC200 FC400 FC800 FC1200 FC1600 FC3200

FC100 ODU0- N/A N/A N/A N/A N/A N/A

XC

FC200 ODU1- N/A ODU1-XC N/A N/A N/A N/A

XC

FC400 N/A N/A ODUF- N/A N/A N/A N/A

FC400

FC800 N/A N/A N/A ODUF- N/A N/A N/A

FC800

FC1200 N/A N/A N/A N/A ODU2e- N/A N/A

XC

FC1600 N/A N/A N/A N/A N/A ODUF- N/A

FC1600

FC3200 N/A N/A N/A N/A N/A N/A ODUF-

FC3200

ODUk L1-XC options for CBR ports

OTU1 OTU2 OTU2e OTU2f OTU3 OTU3e

VIDEO270 ODU0-XC ODU0-XC N/A N/A ODU0-XC ODU0-XC

HDSDI1485 ODU1-XC ODU1-XC N/A N/A ODU1-XC ODU1-XC

HDSDI3G N/A ODUF-SDI3G- N/A N/A ODUF-SDI3G- ODUF-SDI3G-

XC XC XC

Ribbon Communications Inc. Proprietary 322

 L1-XCs

ODUk L1-XC options for CBR ports (continued)

OTU4 VIDEO270 HDSDI1485 HDSDI3G

VIDEO270 ODU0-XC ODU0-XC N/A N/A

HDSDI1485 ODU1-XC N/A ODU1-XC N/A

HDSDI3G ODUF-SDI3G-XC N/A N/A ODUF-SDI3G-XC

Ribbon Communications Inc. Proprietary 323

 Packet Configuration

Packet Configuration
OPT99xx supports packet-switching via the HIO10_20, HIO10_40, HIO100_2, HIO500, and MIO200 cards.
The following packet ports are supported:
• GE10
• GE10-OTU2E
• GE100
• GE100-OTU4
After you assign the data cards and configure the packet ports, you can perform the following configuration
operations:
• Configure L2 parameters for a packet port
• Configure Link OAM for a packet port
• View Link OAM Events and Statistics
• Configure the Link OAM thresholds
In addition, the OPT99xx uses a central switch. You can configure various switch settings, as described in
Switch Configuration.

Configure L2 Port Parameters

You can configure L2 parameters for a packet port.
Start
1. In the Network Explorer tab, right-click the relevant packet port and select Properties.
The port properties appear in the right pane.
2. In the Properties tab, select the L2 Parameters tab.
The L2 parameters appear.

3. Define the parameters as required and click Apply.

See the following table. The parameters displayed vary according to the configured port type.

Ribbon Communications Inc. Proprietary 324

 Packet Configuration

L2 Parameters

Parameter Description

Type (read-only) The port mode, which can be either VLAN-Tagged or I-NNI.

Description Description of the PIF.

Ethernet Attributes

Max Packet Length The maximum packet size that can be received or
transmitted on the port.

Strict Scheduling Mode Enables/disables strict scheduling on the PIF.

MAC Filter Defines whether the reserved MAC address is filtered or not.

TPID Profile Name The TPID profile associated to PIF.

VLAN-Tagged Attributes

Untagged Frame Handling The method used for untagged frame handling: Forward or
Block.

Priority Tagged Frame The method used for priority tagged frame handling:
Forward or Block.

All to One Handling Enables/disables the all-to-one-handle-bundling on the PIF.

PVID The C-VLAN ID assigned to untagged frames received on

this port (PVID translation).

Untagged Default CoS The untagged default CoS, which ranges from 0-7.

I-NNI Attributes

Tx DEI Marking Enables/disables Tx DEI marking.

PIR

PIR Defines whether rate limit exists on the PIF. If exists, the rate
limit is defined in MBps.

Statistics

Ribbon Communications Inc. Proprietary 325

 Packet Configuration

Parameter Description

Statistics-Enable Enables/disables the collection of PM counters on the PIF.

Configure Link OAM

Configuring Link Operation, Administration, and Maintenance (OAM) enables you to monitor a link for critical
events. You can also set the remote device to Loopback mode in order to perform testing on the link.
Start
1. In the Network Explorer tab, right-click the relevant port and select Properties.
The port properties appear in the right pane.
2. In the Properties tab, select the Link OAM Configuration tab.
The Link OAM parameters appear.

3. Select the Enable OAM checkbox.

4. Define the Local Mode and Remote Mode.
5. To set the remote device to Loopback mode, select the Loopback checkbox.

View Link OAM Events and Statistics

You can view Link OAM events and statistics.
Start
1. In the Network Explorer tab, right-click the relevant port and select Properties.
The port properties appear in the right pane.
2. In the Properties tab, select the Link OAM Events and Statistics Panel tab.
The Link OAM local and remote events and statistics appear.

Ribbon Communications Inc. Proprietary 326

 Packet Configuration

Configure Link OAM Thresholds

You can configure the Link OAM thresholds for the packet ports configured on the HIO10_20 and HIO100_2
cards.
Start
1. In the Network Explorer tab, select the relevant card.
The card properties appear in the right pane.
2. Select the Link OAM Threshold tab.
The default Link OAM thresholds appear for the ports configured on the card.

3. Change the thresholds as required and click Apply.

The Link OAM thresholds are saved.

Switch Configuration
You can perform the following operations on the L2 switch:
• Configure Switch Properties
• Configure a VLAN ID Range Profile
• Configure a Port TPID Profile
• Configure a CoS Group Profile
• Configure a QoS Profile
• Configure a Policer Profile
• Configure a WRED Profile
• Configure a Slow Path Policer Profile

Ribbon Communications Inc. Proprietary 327

 Packet Configuration

• Configure a LAG
• Configure Slow Path
• View Configured VSIs
• View VSI Properties
• View VSI Statistics

Configure Switch Properties

You can configure switch properties.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane. The Switching Mode is set to PB by default.

Ribbon Communications Inc. Proprietary 328

 Packet Configuration

2. Define the switch parameters and click Apply. See the following table.

Ribbon Communications Inc. Proprietary 329

 Packet Configuration

Switch properties

Parameter Description

Switching Mode PB by default.

Ethernet (PB) Network ID PB network ID.

LACP System Priority Defines the system priority for LACP (higher value = lower priority).
If both systems have the same System Priority, the system with the
lowest LAG MAC address is preferred.

CoS Defines the priority levels of COS profiles used for data traffic. You can
transfer COS profiles between the High Priority List and Low Priority
List.

WRED Latency Defines the delay of WRED auto profiles per CoS.

Statistics Enable Enables/disables the collection of PM counters on the switch.

Configure a VLAN ID Range Profile

You can configure up to 28 VLAN ID Range profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type. The VLAN ID Range Profile is selected in the tree by default.

3. Click Create .
The Create Profile window opens.

Ribbon Communications Inc. Proprietary 330

 Packet Configuration

4. Enter the profile name and define the range settings.

5. Click Apply.
The profile is created.

Notes

◦ To edit a profile, click Edit and modify the profile details.

◦ To delete a profile, select the profile in the list and click Delete .

Configure a Port TPID Profile

You can configure up to 2 Port TPID profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Select the PortTPID Profile type in the tree.

The Port TPID profiles appear.

4. Click Create .
The Create Profile window opens.

5. Enter the profile name and define the profile settings.

6. Click Apply.
The profile is created.

Ribbon Communications Inc. Proprietary 331

 Packet Configuration

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .

Configure a CoS Group Profile

You can configure up to 8 CoS Group profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Select the CoS Group Profile type in the tree.

The CoS Group profiles appear.

4. Click Create .
The Create Profile window opens.

Ribbon Communications Inc. Proprietary 332

 Packet Configuration

5. Enter the profile name and select the checkboxes for the CoSs to include in the profile.
6. Click Apply.
The profile is created.

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .

Configure a QoS Profile

The QoS profile is composed of the following profiles:
• Priority to CoS profile
• CoS to Priority profile
• DSCP to CoS profile
See also:
• Create a Priority to CoS Profile
• Create a CoS to Priority Profile
• Create a DSCP to CoS Profile
A default set of profiles is configured. Up to 11 QoS Group profiles can be configured on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

Ribbon Communications Inc. Proprietary 333

 Packet Configuration

3. Select the QoS Profile type in the tree.

The QoS profiles appear.

4. Create the profiles to include in the QoS profiles as required:

◦ Create a Priority to CoS Profile
◦ Create a CoS to Priority Profile
◦ Create a DSCP to CoS Profile

5. Click Create .
The Create Profile window opens.

6. Enter the profile name, and enable DSCP classification and/or DEI Bit remarking as required.
7. Select the profiles to include in the QoS profile.
8. Click Apply.
The profile is created.

Ribbon Communications Inc. Proprietary 334

 Packet Configuration

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .
◦ You can't edit or delete the default profile.

Create a Priority to CoS Profile

You can configure up to 11 Priority to CoS profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Expand the QoS Profile type in the tree.

4. Select the Priority to CoS Profile type.

The Priority to CoS profiles appear.

5. Click Create .
The Create Profile window opens.

Ribbon Communications Inc. Proprietary 335

 Packet Configuration

6. Enter the profile name and select the CoS for each priority level.
7. Click Apply.
The profile is created.

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .
◦ You can't edit or delete the default profile.

Create a CoS to Priority Profile

You can configure up to 11 CoS to Priority profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Expand the QoS Profile type in the tree.

Ribbon Communications Inc. Proprietary 336

 Packet Configuration

4. Select the CoS to Priority Profile type.

The CoS to Priority profiles appear.

5. Click Create .
The Create Profile window opens.

6. Enter the profile name and select the priority level for each CoS.
7. Click Apply.
The profile is created.

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .
◦ You can't edit or delete the default profile.

Ribbon Communications Inc. Proprietary 337

 Packet Configuration

Create a DSCP to CoS Profile

You can configure up to 11 DSCP to CoS profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Expand the QoS Profile type in the tree.

4. Select the DSCP to CoS Profile type.

The DSCP to CoS profiles appear.

5. Click Create .
The Create Profile window opens.

Ribbon Communications Inc. Proprietary 338

 Packet Configuration

6. Enter the profile name and define the DSCP to CoS mapping.
7. Click Apply.
The profile is created.

Ribbon Communications Inc. Proprietary 339

 Packet Configuration

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .
◦ You can't edit or delete the default profile.

Configure a Policer Profile

You can configure up to 894 Policer profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Select the Policer Profile type in the tree.

The Policer profiles appear.

4. Click Create .
The Create Profile window opens.

Ribbon Communications Inc. Proprietary 340

 Packet Configuration

5. Enter the profile name and define the profile settings.

6. Click Apply.
The profile is created.

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .

Configure a WRED Profile

You can configure up to 11 WRED profiles on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Select the WRED Profile type in the tree.

The WRED profiles appear.

Ribbon Communications Inc. Proprietary 341

 Packet Configuration

4. Click Create .
The Create Profile window opens.

5. Enter the profile name and define the profile settings.

6. Click Apply.
The profile is created.

Ribbon Communications Inc. Proprietary 342

 Packet Configuration

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .
◦ You can't edit or delete the default profile.

Configure a Slow Path Policer Profile

You can configure up to 15 Slow Path profile on a switch.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Profiles tab.
The configured profiles appear by type.

3. Select the Slow Path Policer Profile type in the tree.

The Slow Path Policer profiles appear.

4. Click Create .
The Create Profile window opens.

Ribbon Communications Inc. Proprietary 343

 Packet Configuration

5. Enter the profile name and define the profile settings.

6. Click Apply.
The profile is created.

Notes

◦ To edit a profile, select the profile in the list, click Edit , and modify the profile
details.

◦ To delete a profile, select the profile in the list and click Delete .
◦ You can't edit or delete the default profiles.

Configure a LAG
Two or more links can be aggregated together to form a Link Aggregation Group (LAG). A LAG is treated by
MAC clients as a single link.
A LAG can be configured for GE10, GE100, GE10-OTU2E, and GE100-OTU4 ports, with VLAN_Tagged or I-
NNI interfaces.
A single LAG can include a maximum of 8 ports.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the LAG tab.
The list of configured LAGs appears.

3. Click Create .
The Create LAG window opens.

Ribbon Communications Inc. Proprietary 344

 Packet Configuration

4. In the Aggregation Group field, enter the LAG name.

5. Select the Port Type and Interface Type.
The cards appear in the Individual Port List. To view the relevant ports, expand the cards.

6. Select and transfer two ports or more from the Individual Port List to the LAG Details list. You can
select ports from the same card or different cards.
7. Define the LAG parameters in both the LAG Details list and at the bottom of the window. See the
table below.

Ribbon Communications Inc. Proprietary 345

 Packet Configuration

8. Click Apply.
The LAG is created.

Ribbon Communications Inc. Proprietary 346

 Packet Configuration

LAG parameters

Parameter Description

Master Port Defines the master port.

Port Name (read-only) The port name.

Distribution Enable Enables/disables distribution for the port.

LACP Enable Enables/disables LACP for the port.

• If LACP is Disabled, LACPDU will not be sent/received.
• If LACP is Enabled, LACPDU will be sent/received based on LACP
Mode.

LACP Mode Defines the LACP mode for the port as one of the following:
• Active: LACPDU will be sent/received.
• Passive: LACPDU will be sent/received only if the partner's LACP
Mode is Active (the partner sends LACPDUs).

Actor Port Priority Defines the port priority (higher value= lower priority).

LACPDU Timeout Defines the LACPDU time interval:

• Short = 1 second
• Long = 30 seconds

Min Active Links Defines the minimum number of active links in a LAG. If the number of
active links is below this value, an alarm is triggered.

Max Active Links Defines the maximum number of active links in a LAG. If the number of
active links is above this value, the low-priority port goes into standby
status to support 1:1 protection.

Actor Key Defines the unique identifier of the LAG within the PE. It must be unique
per switch.

Mac Address The MAC address automatically associated with the LAG. (Read-only)

Alarm Master Mask The alarm master mask.

Severity Profile The severity profile.

PM Monitor Enables/disables PM monitoring for the LAG.

Statistics Enable Enables/disables the collection of PM counters on the LAG.

Ribbon Communications Inc. Proprietary 347

 Packet Configuration

Notes

• To edit a LAG, select the LAG in the list, click Edit , and modify the LAG settings.

• To delete a LAG, select the LAG in the list and click Delete .
• You can't delete VPP LAGs if they exist. You can edit VPP LAG properties, but you can't add
or remove a slave.

Configure Slow Path

You can configure Slow Path.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Properties.
The switch properties appear in the right pane.
2. Select the Slow Path tab.

3. If Slow Path is not already configured, click Create . Only one Slow Path instance can be
configured.
The Create Slow Path window opens.

4. Define the parameters and click Apply.

The Slow Path configuration appears in the Configuration tab.

Notes
◦ To edit the Slow Path configuration, select the Slow Path entry in the list, click Edit

, and modify the details.

◦ To delete the Slow Path configuration, select the Slow Path entry in the list and click

Delete .

Ribbon Communications Inc. Proprietary 348

 Packet Configuration

5. To view queue priority settings for the Slow Path, select the State tab and expand the queue priority
rows.

6. To view Slow Path statistics, select the Statistics tab, and select the relevant slot.

View Configured VSIs

You can view configured VSIs.
Start
• In the Network Explorer tab, right-click the switch for the relevant NE and select Services.
The configured VSIs appear in the VSI List tab. Up to 250 VSIs can be configured on a switch.

You can filter the list using the Filter options.

View VSI Properties

You can view VSI properties.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Services.
The configured VSIs appear in the VSI List tab.

Ribbon Communications Inc. Proprietary 349

 Packet Configuration

You can filter the list using the Filter options.

2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens, displaying the VSI properties.

3. To view alarms for the VSI, select the Alarms tab.

The VSI alarms appear. You can select to view either current alarms or non-reported alarms by
selecting the relevant tab.
4. To view PM counters for the VSI, select the Statistics tab. See View VSI PM counters.

View VSI Statistics

You can view VSI PM statistics.
Start
1. In the Network Explorer tab, right-click the switch for the relevant NE and select Services.
The configured VSIs appear in the VSI List tab.

Ribbon Communications Inc. Proprietary 350

 Packet Configuration

You can filter the list using the Filter options.

2. Right-click the relevant VSI in the list and select VSI Properties View.
The VSI window opens, displaying the VSI properties.

3. Select the Statistics tab.

The statistics configuration information appears in the Configuration tab.

You can enable or disable statistics or extended statistics collection for the relevant ports in the
Statistics-Enable and Extended-Statistics-Enable columns.
4. Select the Statistics Table tab.
5. From the Display dropdown list, select the port for which you want to view PM counters.
The PM counters for the selected port appear.

Ribbon Communications Inc. Proprietary 351

 Packet Configuration

Ribbon Communications Inc. Proprietary 352

 Protection

Protection
Each Apollo platform can support one or more of the following protection types:
• Equipment protection: Protection of fabric modules and the AoC10_L2 card.
• Port protection: Protection of one or more physical ports, by the corresponding port of an adjacent
card (OPT96xx) or any card (OPT99xx).
• Traffic protection: L1 cross-connection (L1-XC) protection (e.g., ODU).
• ROADM protection: To maintain constant input to a Subsea EDFA,
• Network traffic protection: configured at the NMS or EMS-level.
• Dual Node Interconnection (DNI) protection: configured at the NMS or EMS-level.
Refer also to:
• Equipment Protection
• Port Protection
• Traffic Protection
• ROADM Protection
• Protection Maintenance
• View Protection Alarms
• FM Fabric Status

Equipment Protection
Equipment protection is used to protect equipment such as cards. You can configure the following types of
equipment protection:
• FM Protection
• Fast IOP Protection for AoC10_L2 cards only

FM Protection
FM protection provides protection for the following fabric modules:
• FM1000 in OPT9624
• xFM in OPT99xx
On shelves with fabric modules, a protection group is automatically created with N:1 protection scheme. For
example, in OPT9624, the protection scheme is 3:1, where there are three active FM1000 cards and one
standby FM1000.
When there are four active FMs, in case one FM has a failure, the standby FM becomes one member of the
active group. If there are less than three active 3 FMs, there is no protection and no service.
FM protection is non-revertive. FM protection switching is minimally traffic-affecting (<10msec).

Fast IOP Protection

You can configure Fast IOP protection for AoC10_L2 cards. Fast IOP is a protection mechanism that
performs automatic switchover in case of card failure or partial failure/malfunction. You can also perform the
switchover manually as required.
To configure IOP protection, you must assign two AoC10_L2 cards, then define one card as the protected
(Main) card and the other card as the protecting (Standby) card. The Main card is initially active, so it
receives and transmits traffic from/to CPEs (connected over LAN ports). The Standby card is initially inactive,
so it only receives traffic from CPEs.
Fast IOP is activated automatically by a trigger such as active card failure, or manually by the user. Upon the
trigger, if the current active card has a higher severity fault than the current inactive card, then a switchover
occurs, and the roles of the cards are switched. For example, if the Main card is active and the Standby card

Ribbon Communications Inc. Proprietary 353

 Protection

is inactive, and BIT Failed is detected on the Main card, a switchover is performed. The Standby card
becomes the active card, and it will automatically begin to receive and transmit traffic from/to CPEs.
Fast IOP is non-revertive. Also, Fast IOP can't be configured if I-MoE is configured (and vice versa).
After configuring Fast IOP for the AoC_L2 cards, you can define fiber connectivity for the cards (optional). If
you define fiber connectivity, you must define it for both cards.
See also:
• Create a Protection Group of AoC10_L2 Cards
• Delete Fast IOP Protection for AoC10_L2 Cards

Create a Protection Group of AoC10_L2 Cards

To configure Fast IOP Protection for AoC10_L2, you must create a protection group of the cards. The
AoC10_L2 cards must be assigned to slots 0 and 1 on an OPT9603 NE.
Start
1. In the Network Explorer tab, right-click on the AoC10_L2 card and select Show/Configure
Protection.
The Protection Group Properties window opens.

2. The selected card is defined as the Main card by default. You can change the Main card by selecting
the relevant radio button in the Main Unit column.
3. Define the following parameters as required:
◦ Hold-Off Time: The amount of time the system should wait after a signal failure is generated
before performing protection switching. Protection switching is only activated if a signal failure is
still present at the end of the hold-off time. The hold-off time value can be set between 0-10
seconds, and can be defined in 100ms intervals. The default value is 0.
◦ Alarm Mask Master: Enabling the alarm mask master causes all alarms for the specified
protection group to be masked. Masked alarms do not appear in the show chassis alarms
command, or in the relevant STMS/NMS. The alarm mask master is disabled by default.
◦ Severity Profile: The name of the severity profile assigned to the protection group. The value is a
string of up to 255 characters. The default value is default.
4. Click Apply.
Fast IOP is configured for the AoC10_L2 cards. In the Network Explorer tab, appears next to the
Main card and appears next to the Standby (protecting) card.

Ribbon Communications Inc. Proprietary 354

 Protection

5. Define Fiber Connectivity (optional). If you define fiber connectivity, you must define it for both the
Main card and the Standby card.

Important
When defining fiber connectivity for the Standby card, make sure that the Report to
LightSOFT option is deselected.

Note
See Perform Protection Maintenance and View Protection Alarms for additional related
actions.

Delete Fast IOP Protection for AoC10_L2 Cards

You can delete the Fast IOP Protection configured for AoC10_L2 cards (see Create a Protection Group of
AoC10_L2 Cards).
Start
1. In the Network Explorer tab, right-click on the AoC10_L2 card and select Show/Configure
Protection.
The Protection Group Properties window opens.

2. Select the Lockout Unit checkbox (for either card) and click Apply.
The Main card becomes the active card.

Note
The Lockout Unit operation switches the active role to the Main card regardless of the Main
card's presence. This operation is traffic-affecting, so you must verify that the Main card is
present and alarm-free before running it.

3. Verify that the Main card is functioning.

Ribbon Communications Inc. Proprietary 355

 Protection

4. Click Delete Protection.

Fast IOP protection is deleted for the cards. The Standby card's configuration is automatically deleted,
and the Switching Mode is set to PB.

Port Protection
NE port protection is used to protect against card or module failures. It enables service continuation in the
event of failure or extraction of the service source/sink card or module/transceiver.
Port protection is supported on the following ports:
• L1 Service ports in OPT96xx and OPT99xx. See IOP Protection for L1 Ports.
• Physical packet ports in OPT99xx. See IOP Protection for Physical Packet Ports.
On a single protection card pair, you can choose to protect selected service ports or all service ports, using
protection groups. A protection group defines a protection switching relationship between the ports, where
one or more standby (backup) ports provide protection for one or more active ports.
For each protection group, the two client ports (preferably one on each card) are connected to the client's
equipment via an external splitter/coupler, and send traffic to both lines via the splitter. The main port laser is
set to ON, and the protecting port laser remains OFF. In the event of a failure, a protection switch is achieved
by changing the laser state on both ports, so that the new active port laser is set to ON.
You must explicitly configure a port protection group, associating the two ports. Configuration is performed on
the main port, and the relevant configuration parameters are copied to the protecting port.
Refer also to:
• Port Association Guidelines
• IOP Protection for L1 Ports
• IOP Protection for Physical Packet Ports

Port Association Guidelines

To associate client ports for protection, use the following guidelines:
• The ports use only optical transceivers.
• The ports must be configured with the same port type.
• The port on the left/top card is automatically configured as the main port, and the configuration is
copied to the protecting port on the right/bottom card. Any subsequent configuration changes are
performed on the main port, and then copied to the protecting port.
• Once a protection group is created, the role of protection group members can't be changed.
Additional guidelines for OPT99xx:
• Port protection can be configured on the same card or on two different cards (do not have to be
adjacent).
Additional guidelines for OPT96xx:
• Ports in a protected pair must have the same port number.
• The relevant cards must be located in adjacent slots, as follows:

Ribbon Communications Inc. Proprietary 356

 Protection

OPT96xx adjacent slots

Platform Type Slot numbers

OPT9608/ Single 0:2, 1:3, 4:6, 5:7

OPT9608D
Wide Card pairs are a subgroup of the regular cards: 0:2, 4:6

Double 2:3, 6:7

Quad 2:6

OPT9624 Single 0:2, 1:3, 4:6, 5:7, 12:14...21:23

Wide Card pairs are a subgroup of the regular cards 0:4, 12:16...1:5

Double 0:1, 4:5...20:21

Quad 0:4

OPT9603 Single 1:2

IOP Protection for L1 Ports

In IOP protection configuration, for each client traffic protection group in transmit (ingress) direction the trail is
split into two independent routes (bridging) and the service is sent to two client ports on two different cards.
On the egress side a selection is made between the two incoming routes, according to the incoming signal
and BIT quality.
When supporting both traffic protection and IOP, switching criteria vary according to the XC objects and/or
equipment failure. For example, ODU failures in case of OTN, or BIT failures in case of IOP.
• Create a Protection Group of L1 Ports: OPT99xx
• Create a Protection Group of L1 Ports: OPT96xx

Create a Protection Group of L1 Ports: OPT99xx

You can define IOP Protection for L1 Ports in OPT99xx by creating a protection group.

Note
When port protection is configured, you can only create a protected XC. Creation of P2P XCs is
disabled.

Refer also to:

• Create a Protection Group for RADM100: OPT9901X
Start
1. Right-click on the relevant port and select Show/Configure Protection.

Ribbon Communications Inc. Proprietary 357

 Protection

Note
The Show/Configure Protection option is only available for ports that support protection.

The Protection Group Properties window opens.

2. In the Unit column, select the associated port for protection. The port can have a different number,
and can be on the same or on a different card.
3. In the Main Unit column, select the unit that will function as the Main unit.

Note
By default, the first port you select is defined as the master port as well as the main port
(unit). You can change the associated port to the main port, but the first port will remain the
master port. The master port is the configurable port, and its data is copied by the NE to the
slave port (where the data can't be modified). The name of the protection group is the name
of the master port (appears in the window title). The main port is the active port. If revertive
protection is enabled, it is the port to which the NE returns after failure and recovery.

Note
Changing the main unit is not traffic-affecting. However, in some circumstances, it may
cause a protection switch event (traffic affecting <50msec).

4. Define the following parameters as required:

Ribbon Communications Inc. Proprietary 358

 Protection

◦ Revertive: Define protection as either revertive or non-revertive. (The default value is No for non-
revertive.)
• Revertive: The main path has priority over the protection path. In the event of a failure, when
the main path is restored, the protected path reverts to the main path.
• Non-revertive: The main and protection paths have equal precedence. Therefore, there is no
need to return to the main path after recovery.
◦ WTR Period: The Wait to Restore (WTR) period is the number of minutes a failed unit should be
without fault before it can be used again as the active unit. WTR is used to prevent frequent
protection switching due to an intermittent fault. The WTR value can be between 0-12 minutes.
The default value is 5 minutes.
◦ Alarm Mask Master: Enabling the alarm mask master causes all alarms for the specified
protection group to be masked. Masked alarms do not appear in the show chassis alarms
command, or in the relevant STMS/NMS. The alarm mask master is disabled by default.
◦ Severity Profile: The name of the severity profile assigned to the protection group. The value is a
string of up to 255 characters. The default value is default.
5. Click Apply.
The protection group is created.

Create a Protection Group for RADM100: OPT9901X

1. Set Mate IP and redundancy side on both of the chassis as follows:
◦ NE 1

Ribbon Communications Inc. Proprietary 359

 Protection

◦ NE 2

Only 9901x displays the RADM100.

2. Assign the card type as RADM100.

Note
You must connect the DAC cable between both chassis on port 22 and the Ethernet cable on
the MSM ports.

Ribbon Communications Inc. Proprietary 360

 Protection

3. Create Client ports in both chassis on identical ports. In this case, both chassis have a Ety10GoC
client port created on port 5.

4. Select Show/Configure Protection to create port protection.

Ribbon Communications Inc. Proprietary 361

 Protection

5. Apply the configuration. The port protection is created successfully.

6. Follow step 2 in Perform Protection Maintenance.

Create a Protection Group of L1 Ports: OPT96xx

You can define IOP Protection for L1 Ports in OPT96xx by creating a protection group.
Start
1. Right-click on the relevant port and select Show/Configure Protection.
The Protection Group Properties window opens, displaying the two associated ports.

The main unit is defined by the following system defaults:

◦ In OPT9608/OPT906D, the left port is defined as the main unit by default.
◦ In OPT9624, the upper port is defined as the main unit by default.

Ribbon Communications Inc. Proprietary 362

 Protection

◦ In OPT9603, u1 is defined as the main unit by default.

Note
Changing the main unit is not traffic-affecting. However, in some circumstances, it may
cause a protection switch event (traffic affecting <50msec).

2. Define the following parameters as required:

◦ Revertive: Define protection as either revertive or non-revertive. (The default value is No for non-
revertive.)
• Revertive: The main path has priority over the protection path. If the main path has equal or
better signal than the protection path, it is used. In the event of a failure, when the main path is
restored, the protected path reverts to the main path.
• Non-revertive: The main and protection paths have equal precedence. Switching between
paths only occurs if the active path's signal quality is lower than the non-active path.
◦ WTR Period: The Wait to Restore (WTR) period is the number of minutes a failed unit should be
without fault before it can be used again as the active unit. WTR is used to prevent frequent
protection switching due to an intermittent fault. The WTR value can be between 0-12 minutes.
The default value is 5 minutes.
◦ Hold-Off Time: The amount of time the system should wait after a signal failure is generated
before performing protection switching. Protection switching is only activated if a signal failure is
still present at the end of the hold-off time. The hold-off time value can be set between 0-10
seconds, and can be defined in 100ms intervals. The default value is 0.
◦ Alarm Mask Master: Enabling the alarm mask master causes all alarms for the specified
protection group to be masked. Masked alarms do not appear in the show chassis alarms
command, or in the relevant STMS/NMS. The alarm mask master is disabled by default.
◦ Severity Profile: The name of the severity profile assigned to the protection group. The value is a
string of up to 255 characters. The default value is default.
3. Click Apply.
The protection group is created.

IOP Protection for Physical Packet Ports

IOP protection provides an alternative resiliency mechanism for connectivity between the customer
equipment and packet-switching Apollo shelf (OPT99xx). The solution is relevant for Ethernet ports using
optical transceivers only.
The following diagram shows the IOP protection solution.

IOP protection for physical packet ports

Ribbon Communications Inc. Proprietary 363

 Protection

The active port (A) represents the actual port that is active, and can be either the main/protected port or the
standby/protecting port in the protection group.
Only the active port (A) receives and transmits packets, whereas the packets received by the inactive port
(IA) are discarded, and Tx laser is turned off.
The ports connected to the splitter coupler can reside on different cards or on the same card (e.g. for shelves
that don't have redundant IO cards).
When a failure is detected on the active port, the inactive port becomes active.
The following cards and ports support IOP protection:
• OPT99xx cards: HIO10_20, HIO100_2
• Physical packet port types: GE10, GE10-OTU2e, GE100, GE100-OTU4
Perform the following steps to configure IOP protection for physical packet ports.
1. Configure two ports using the following guidelines:
◦ The ports must have the same port type and interface type.
◦ The ports are on the same IO card or different IO cards.
2. Define Fiber Connectivity between the ports and splitter coupler.
3. Create a protection group consisting of the main/protected port and the standby/protecting port using
the following guidelines:
◦ Both ports do not have any services on them.
◦ The ports are not LAG members.
◦ TX laser is ON for the active port, and OFF for the inactive port.

Refer also to:

• Create a Protection Group of Physical Packet Ports
• Modify a Protection Group of Physical Packet Ports

Create a Protection Group of Physical Packet Ports

Configure IOP Protection for Physical Packet Ports in OPT99xx by creating a port protection group.
You can create a port protection group.
Start
1. Right-click on the relevant port and select Show/Configure Protection.

Note
The Show/Configure Protection option is only available for ports that support protection.

The Protection Group Properties window opens.

Ribbon Communications Inc. Proprietary 364

 Protection

2. In the Unit column, select the associated port for protection. The port can have a different number,
and can be on the same or on a different card.
3. In the Main Unit column, select the unit that will function as the Main unit.

Note
By default, the first port you select is defined as the master port as well as the main port
(unit). You can change the associated port to the main port, but the first port will remain the
master port. The master port is the configurable port, and its data is copied by the NE to the
slave port (where the data can't be modified). The name of the protection group is the name
of the master port (appears in the window title). The main port is the active port. If revertive
protection is enabled, it is the port to which the NE returns after failure and recovery.

4. Define the following parameters as required:

◦ Revertive: Define protection as either revertive or non-revertive. (The default value is No for non-
revertive.)
• Revertive: The main path has priority over the protection path. In the event of a failure, when
the main path is restored, the protected path reverts to the main path.
• Non-revertive: The main and protection paths have equal precedence. Therefore, there is no
need to return to the main path after recovery.
◦ WTR Period: The Wait to Restore (WTR) period is the number of minutes a failed unit should be
without fault before it can be used again as the active unit. WTR is used to prevent frequent
protection switching due to an intermittent fault. The WTR value can be between 0-12 minutes.
The default value is 5 minutes.
◦ Alarm Mask Master: Enabling the alarm mask master causes all alarms for the specified
protection group to be masked. Masked alarms do not appear in the show chassis alarms
command, or in the relevant STMS/NMS. The alarm mask master is disabled by default.
◦ Severity Profile: The name of the severity profile assigned to the protection group. The value is a
string of up to 255 characters. The default value is default.
5. Click Apply.
The protection group is created.

Ribbon Communications Inc. Proprietary 365

 Protection

Modify a Protection Group of Physical Packet Ports

You can change the protecting port in a protection group of physical packet ports at any time.
Start
1. Right-click on the relevant port and select Show/Configure Protection.
The Protection Group Properties window opens.

2. In the Unit column, select the associated port for protection. The port can have a different number,
and can be on the same or on a different card.
3. Click Apply.
The protection group is updated.

Traffic Protection
Traffic protection, also called SNCP protection, is a bridge or switch point within a trail. A traffic protection
group is created automatically by the NE, and can only be modified by the user.
In the transmit direction, the trail is split into two independent routes (bridging), and the service is sent to two
client ports on the egress side of the NE. On the receive (egress) side, a selection is made between these
two incoming routes (switching), according to protection switching criteria that are based on incoming signal
quality and module (e.g. SFP, XFP) extraction.
SNCP protection is supported on:
• ODU-XC endpoints in OPT99xx and OPT96xx
• OCH-XC endpoints in OPT96xx only
L1-XCs can support a range of connectivity protection options, both unprotected and protected. During L1-
XC configuration, the NE determines whether any of the protected configurations would be applicable for the
new L1-XC. If the possibility of protection exists within the L1-XC configuration, the NE automatically creates
an appropriate traffic protection group object that includes the relevant L1-XC legs. In v12.1 and higher, a
traffic protection group is created automatically for all applicable protected configurations. The XCs can be
created implicitly during the assignment process or explicitly by the user.
Traffic protection can be configured as revertive or non-revertive.
• Modify a Traffic Protection Group of L1-XCs: OPT99xx
• Modify a Traffic Protection Group of L1-XCs: OPT96xx

Ribbon Communications Inc. Proprietary 366

 Protection

Modify a Traffic Protection Group of L1-XCs: OPT99xx

If an L1-XC is configured with the relevant legs, the NE automatically creates a traffic protection group. You
can modify a traffic protection group as required.
Start
1. Right click the NE icon in the Network Explorer tab and select Show XCs.
The XC Manager window opens, listing the XCs defined for the NE.
2. Select the relevant XC and select the Protection Group tab (in the bottom pane).
The list of defined traffic protection groups appears.
3. Select the protection group you want to modify and click Edit.
The Edit Protection Group window opens, displaying the two associated L1-XCs.

4. You can change the XC defined as the main unit by selecting the relevant radio button in the Main
Unit column.

Notes
◦ The L1-XC leg with the lowest index is defined as the main unit by default.
◦ Changing the main unit is traffic-affecting.

5. You can change the value in the Hold-Off Time column for each XC separately. The hold-off time is
the amount of time the system should wait after a signal failure is generated before performing
protection switching. Protection switching is only activated if a signal failure is still present at the end
of the hold-off time. Its value can be set between 0-10 seconds, and can be defined in 100ms
intervals. The default value is 0.
If each XC has a different value, a "Mixed" value appears for the Hold-Off Time in the Protection
Group tab of the XC Manager window.
6. Modify the following parameters as required:
◦ Revertive: Define protection as either revertive or non-revertive. (The default value is No for non-
revertive.)
• Revertive: The main path has priority over the protection path. If the main path has equal or
better signal than the protection path, it is used. In the event of a failure, when the main path is
restored, the protected path reverts to the main path.
• Non-revertive: The main and protection paths have equal precedence. Switching between
paths only occurs if the active path's signal quality is lower than the non-active path.

Ribbon Communications Inc. Proprietary 367

 Protection

◦ WTR Period: The Wait to Restore (WTR) period is the number of minutes a failed unit should be
without fault before it can be used again as the active unit. WTR is used to prevent frequent
protection switching due to an intermittent fault. The WTR value can be between 0-12 minutes.
The default value is 5 minutes.
◦ Alarm Mask Master: Enabling the alarm mask master causes all alarms for the specified
protection group to be masked. Masked alarms do not appear in the show chassis alarms
command, or in the relevant STMS/NMS. The alarm mask master is disabled by default.
◦ Severity Profile: The name of the severity profile assigned to the protection group. The value is a
string of up to 255 characters. The default value is default.
7. Click Apply.
The protection group settings are updated.

Modify a Traffic Protection Group of L1-XCs: OPT96xx

If an L1-XC is configured with the relevant legs, the NE automatically creates a traffic protection group. You
can modify a traffic protection group as required.
Start
1. Right click the NE icon in the Network Explorer tab and select Show XCs.
The XC Manager window opens, listing the XCs defined for the NE.
2. Select the relevant XC and select the Protection Group tab (in the bottom pane).
The list of defined traffic protection groups appears.
3. Select the protection group you want to modify and click Edit.
The Edit Protection Group window opens, displaying the two associated L1-XCs.

4. You can change the XC defined as the main unit by selecting the relevant radio button in the Main
Unit column.

Notes
◦ The L1-XC leg with the lowest index is defined as the main unit by default.
◦ Changing the main unit is traffic-affecting.

5. Modify the following parameters as required:

◦ Revertive: Define protection as either revertive or non-revertive. (The default value is No for non-
revertive.)

Ribbon Communications Inc. Proprietary 368

 Protection

• Revertive: The main path has priority over the protection path. If the main path has equal or
better signal than the protection path, it is used. In the event of a failure, when the main path is
restored, the protected path reverts to the main path.
• Non-revertive: The main and protection paths have equal precedence. Switching between
paths only occurs if the active path's signal quality is lower than the non-active path.
◦ WTR Period: The Wait to Restore (WTR) period is the number of minutes a failed unit should be
without fault before it can be used again as the active unit. WTR is used to prevent frequent
protection switching due to an intermittent fault. The WTR value can be between 0-12 minutes.
The default value is 5 minutes.
◦ Hold-Off Time: The amount of time the system should wait after a signal failure is generated
before performing protection switching. Protection switching is only activated if a signal failure is
still present at the end of the hold-off time. The hold-off time value can be set between 0-10
seconds, and can be defined in 100ms intervals. The default value is 0.
◦ Alarm Mask Master: Enabling the alarm mask master causes all alarms for the specified
protection group to be masked. Masked alarms do not appear in the show chassis alarms
command, or in the relevant STMS/NMS. The alarm mask master is disabled by default.
◦ Severity Profile: The name of the severity profile assigned to the protection group. The value is a
string of up to 255 characters. The default value is default.
6. Click Apply.
The protection group settings are updated.

ROADM Protection
To maintain constant input to Subsea EDFA, any failure/change in the data channel on the ROADM line OUT
must be compensated by ASE power (Noise channel). This is achieved by sending the full load (88) noise
channels (from the ASE source) manually from an amplifier (usually OA_FB).
If there is a partial data channel failure, the ROADM-Protection replaces the failed channels with ASE-
Channels maintaining the full load in the undersea EDFAs.

Undersea ROADM protection

See also:
• Configure an ASE Leg
ROADM protection is supported on the following cards:
• ROADM-4A
• ROADM-4F
• ROADM-9A
• ROADM-9A50
• ROADM-9F
• ROADM-9FS
• ROADM-4FS

Ribbon Communications Inc. Proprietary 369

 Protection

Configure an ASE Leg

This section describes how to configure an ASE leg in STMS.
Start
1. In Network Explorer, select the ROADM card on which you want to create an ASE leg.
2. Right-click the card, and select Create XCs.

Ribbon Communications Inc. Proprietary 370

 Protection

The XC Configuration window appears.

3. In the XC Parameters area, enter the following information:

◦ In the NE field, select the NE from the dropdown list.
◦ In the Name field, enter a name for the XC.
◦ In the XC Rate field, select the rate that you require for the XC.
◦ For the Frequency field, click Select and select the required frequency.
◦ In the Type field, select the XC type.
◦ In the Leg Directionality field, select Bidirectional.
◦ Enter information for all other fields as required.
4. In the tree, select the From tp sub-interface and To tp sub-interface.

Ribbon Communications Inc. Proprietary 371

 Protection

5. Click Add Leg.

The leg is created and appears in the XC Details area at the bottom of the window.

6. In the XC Details area, from the Trail Path Type dropdown list, select ASE.
7. In the NMS, create a Trail from NMS or add one more leg to ASE XC to create an implicit protection
group.

Ribbon Communications Inc. Proprietary 372

 Protection

The following is an example where the trail was created in the NMS.

8. In the trail, copy the Trail Route ID to the ASE leg.

Note
The ASE leg can only be added from STMS.

An Implicit protection group is created, as shown in the following example.

Ribbon Communications Inc. Proprietary 373

 Protection

9. Select the protection group, and click Edit.

The Edit Protection Group window appears.

10. In the Main Unit column, change the ASE Leg to Main Leg where your data trail is created (one time
operation).
11. Click Apply.

Protection Maintenance
You can use maintenance commands to force switching between main or protection units, when required.
Maintenance commands are executed based on priority. If the maintenance command has a higher priority
than the current command, the current command is cleared, and then the maintenance command is
activated. If a command with a higher priority than the maintenance command exists, the maintenance
command is not executed, and a rejection message is displayed.

Note
Maintenance commands are executed according to priority level. When performing maintenance
commands via ShadeTree, enter the command and commit the change separately for each action, to
ensure the commands hierarchy is maintained.

The following protection maintenance operations are available:

• Protection Lockout: A protection lockout command prevents protection switching from main to the
specified protecting unit, regardless of the state of the main unit. (For fabric cards, this command
prevents the system from using the card as part of an active FM set.)
Lockout clears all externally initiated switch commands and WTR at the protected unit to which the
command was addressed. If any service traffic is using the protecting unit at the time that the
command is applied, service traffic is switched back to the main unit, regardless of its condition.

Ribbon Communications Inc. Proprietary 374

 Protection

Note
Lockout can only be applied to a one unit in a protection group at any given time. Lockout is
persistent and has the highest priority of any FM switchover criteria.

• Forced Switch: A forced switch to protection command forces a switch from main to protection units.
It takes priority over any service failure (SF) or service degraded (SD) alarm. Switching occurs,
regardless of the status of the protecting unit.
A manual switch cannot be performed if a lockout command or forced switch command has already
been applied.

Note
The manual switch over command can be overridden by any service failure (SF), or service
degraded (SD) alarm, or a command of higher priority.

• Manual Switch: Manual switch enables you to switch from the currently active unit to the other unit,
unless a higher priority request has been received. This command has a lower priority than Signal
Failure or Signal Degraded errors, and a higher priority than WTR. A manual switch cannot be
performed if a lockout command is already applied. A message is displayed if the command cannot be
executed.

Note
The manual switch over command can be overridden by an error or a command of higher
priority.

The following manual operations can also trigger a switchover, if required:

◦ Resetting a module: For equipment protection, if a module is reset, the other three modules are
automatically switched to active.
◦ Powering off a module: For equipment protection, if a module is powered off, the other three
modules are automatically switched to active.
See also:
• Perform Protection Maintenance

Perform Protection Maintenance

This section describes how to perform protection maintenance.
Start
1. Do one of the following:
◦ For equipment protection, right-click on the relevant card and select Show/Configure Protection.
The Protection Group Properties window opens.
◦ For port protection, right-click on the relevant port and select Show/Configure Protection.
The Protection Group Properties window opens.
◦ For traffic protection, in the XC Manager, select a protection group (from the Protection Group
tab) and click Edit.
The Edit Protection Group window opens.
2. Perform one of the following maintenance operations:
◦ To run a Protection Lockout command for a unit, select the checkbox in the Lockout Unit column
for the relevant unit and click Apply.
◦ To run a Forced Switch to Protection command, select the checkbox in the Force Switch Unit
column for the relevant unit and click Apply.

Ribbon Communications Inc. Proprietary 375

 Protection

◦ To perform a manual switch, change the unit that is not defined as the main unit to be the main unit
and click Manual Switch.

View Protection Alarms

You can view protection alarms.
Start
1. Right-click on the relevant port and select Show/Configure Protection.
The Protection Group Properties window opens.
2. Select the Alarms tab.
The protection alarms appear.

FM Fabric Status
You can view the status of the FM fabric modules. You can also view a more detailed status, that includes
details about the FM cards that are currently working. The detailed FM fabric status can aid troubleshooting,
and it also enables you to view the connectivity between the fabric card and the I/O module. In the event that
there is a loss of connectivity between a fabric card and the I/O module, all errors related to the fabric
module are displayed in the detailed status, including link failure alarms.
The status includes the following information:

FM fabric status information

Parameter Description

Status The status of the fabric module (Active/Standby):

Condition The condition of the fabric module:

<none>: module is working.
Failing: there is currently an error on the module, and it is not working.
Failed: the module is working, but there was a problem on the module in the
past.

Alarm Status The status of the most severe alarm on the module.

Description The description of the module type.

Ribbon Communications Inc. Proprietary 376

 Fiber Connectivity

Fiber Connectivity
Fiber connectivity defines the characteristics of the connectivity between ports connected via physical fibers.
Defining fiber connectivity provides the following benefits:
• Power equalization: fiber connectivity is mandatory for ports participating in power equalization to
pass power control parameters to one another (for example, ports residing in passive optics cards,
optics cards and WDM ports on L1 service cards). From V9.0, the laser is not shut down if fiber
connectivity missing, but it is indicated to you with a fiberconnectivitymissing alarm.
• Diagnostic information: provided via ONCP (Optics Network Control Parameters).
• Top Down Trail application: Links and trails can be created in the NMS and their configuration sent to
STMS. The STMS can then send the configuration to the NE.
Fibers can be connected in one of the following ways:
• Intra-fiber connectivity (internal): fibers are connected with an NE. For example connectivity between
cards residing in the same chassis, or between an Apollo card and an Artemis (passive) optical card.
Fiber connectivity parameters defined on one port are automatically copied to the peer port.
• Inter-fiber connectivity (external): Fiber connectivity between two different NEs. Fiber connectivity
parameters must be defined on the NEs at both endpoints of the fiber.
The following figure illustrates the two types of fiber connectivity.

Fiber Connectivity

Fiber connectivity must be defined on the following ports:

• OTUk
• OTS
• OCHP

Note
Power equalization and Gain equalization do not happen if fiber connectivity is not configured
on the OTUk, OTS, and OCHP ports.

Ribbon Communications Inc. Proprietary 377

 Fiber Connectivity

See also:
• Fiber Connectivity Prerequisites and Guidelines
• Define Fiber Connectivity
• Define Fiber Connectivity for an NE Managed by a Different STMS
• Define Fiber Connectivity for Alien (non-Apollo) Equipment
• View Fiber Connectivity for an NE
• Fiber and Port Connectivity Rules

Fiber Connectivity Prerequisites and Guidelines

The following prerequisites and guidelines should be adhered to when configuring fiber connectivity.
• Before configuring fiber connectivity, configure the relevant ports.
• For a bidirectional port, up to two unidirectional fibers can be defined per port. For a unidirectional
port, only a single fiber of the applicable direction can be applied.
• When configuring intra-fiber connectivity, it is not necessary to explicitly configure both peer ports.
Configure fiber connectivity parameters on one peer port and the NE automatically configures fiber
connectivity parameters on the other port.
• It is possible to define fiber connectivity without specifying a frequency value. For inter-connectivity, if
the frequency value is defined at one end, the NE automatically configures the frequency value in the
corresponding peer port during configuration.
• Apollo ports are bidirectional, and XDM ports are unidirectional. When creating fiber connectivity
between Apollo and XDM NEs, it is important to create the topology link in LightSOFT so that the fiber
connectivity in the Apollo NE is automatically created as unidirectional.
If you create fiber connectivity between Apollo and XDM NEs in the STMS before they are created in
LightSOFT, you must define two unidirectional fiber connectivity links. Otherwise, the topology link
creation over the port in LightSOFT will fail.

Define Fiber Connectivity

Fiber connectivity configuration is part of the chassis configuration.
Start
1. From the NE Chassis view, right-click on the port for which fiber connectivity needs to be defined, and
select Create Fiber Connectivity.
2. Select the fiber directionality (Unidirectional In, Unidirectional Out, or Bidirectional) and
connectivity type (Internal or External).
The Configure Fiber Connectivity window opens.
The connectivity type and directionality can be changed from this window if needed.

Ribbon Communications Inc. Proprietary 378

 Fiber Connectivity

3. Select the fiber rate from the Rate dropdown list.

4. If you selected OCH or OTS rate, define the A>Z (input) and Z>A (output) frequencies:
◦ Click Select.
The Frequency Selection window opens.
◦ Select the frequency and click Finish.
5. Define a Label (optional).
6. If the operation needs to be reported to LightSOFT, select Report to LightSOFT.
7. Define the parameters in the Power Equalization Parameters area:
◦ Fiber type: The fiber type, e.g. g652, multimode, etc.
◦ A>Z (input) and Z>A (output) fiber loss: Default value = 0; possible values = 0-100; resolution =
0.1
◦ Fiber length: Intra-fiber connectivity values 0-500; resolution = 0.1
◦ Allowed fiber loss margin: The margin of fiber loss allowed before an alarm is raised (in dB).
Default: intra-fiber connectivity = 0.1; inter-fiber connectivity = 3, and resolution = 0.1. Possible
intra-fiber connectivity values = 0-7.
◦ PMD (Polarized Mode Dispersion): For intra-fiber connectivity, default = 0. For inter-fiber
connectivity, PMD range = 0-40, resolution = 0.1. Default PMD varies according to fiber length:
<10km=0; >10km=0.7sqrt.)
8. From the graphical network tree, select the Z-end (peer) NE, slot, and port.
9. Click Apply.

Notes
◦ When deleting fiber connectivity, configuration must be deleted on both peers.
◦ Modifying fiber connectivity does not affect xc connectivity.

Ribbon Communications Inc. Proprietary 379

 Fiber Connectivity

Define Fiber Connectivity for an NE Managed by a

Different STMS
You can define fiber connectivity for an NE managed by a different STMS.
Start
1. From the NE Chassis view, right-click on the port for which fiber connectivity needs to be defined, and
select Create Fiber Connectivity > Bidirectional > External.
The Configure Fiber Connectivity window opens.

2. Select the fiber rate from the Rate dropdown list.

3. If you selected OCH or OTS rate, define the A>Z (input) and Z>A (output) frequencies:
◦ Click Select.
The Frequency Selection window opens.
◦ Select the frequency and click Finish.
4. Define a Label (optional).
5. If the operation needs to be reported to LightSOFT, select Report to LightSOFT.
6. Define the parameters in the Power Equalization Parameters area:
◦ Fiber type: The fiber type, e.g. g652, multimode, etc.
◦ A>Z (input) and Z>A (output) fiber loss: Default value = 0; possible values = 0-100; resolution =
0.1
◦ Fiber length: Intra-fiber connectivity values 0-500; resolution = 0.1
◦ Allowed fiber loss margin: The margin of fiber loss allowed before an alarm is raised (in dB).
Default: intra-fiber connectivity = 0.1; inter-fiber connectivity = 3, and resolution = 0.1. Possible
intra-fiber connectivity values = 0-7.
◦ PMD (Polarized Mode Dispersion): For intra-fiber connectivity, default = 0. For inter-fiber
connectivity, PMD range = 0-40, resolution = 0.1. Default PMD varies according to fiber length:
<10km=0; >10km=0.7sqrt.)
7. For the Z-end (NE on the other STMS), select Unmanaged.
8. Enter the peer NE IP address, slot, port, EMS, and NE ID.

Ribbon Communications Inc. Proprietary 380

 Fiber Connectivity

9. Click Apply.
The fiber connectivity is defined.

Define Fiber Connectivity for Alien (non-Apollo)

Equipment
You can define fiber connectivity for NEs that are not configured on Apollo equipment and managed by
STMS, such as the XDM platform, or for third-party equipment. Alien lambdas are transmitted by third-party
WDM transceivers. These transceivers are connected directly to the Apollo equipment, but are not managed
by STMS.
Start
1. Open the Create Fiber Connectivity window (see Define Fiber Connectivity).

2. For the Connectivity type, select External.

3. For Directionality, select Unidirectional or Bidirectional.
4. For the Z-End, select Unmanaged.
5. For the Peer NE, select Unspecified.

Note
All other attributes should be defined as null and cannot be modified.

View Fiber Connectivity for an NE

You can view the fiber connectivity settings for an NE.
Start
• Right click on the NE in the Network Explorer tab and select Show Fiber Connectivity.
The Fiber Connectivity Manager window opens, showing the fiber connectivity settings defined for
the NE.

Ribbon Communications Inc. Proprietary 381

 Fiber Connectivity

Fiber and Port Connectivity Rules

The following table describes the fiber connectivity rules for OTN technology.

Ribbon Communications Inc. Proprietary 382

 Fiber Connectivity

Fiber connectivity rules for OTN technology

OTU1 OTU2 OTU2e OTU2f OTU3 OTU3e OTU4 OTS OCHP

OTU1 Y N N N N N N N Y

OTU2 N Y N N N N N N Y

OTU2e N N Y N N N N N Y

OTU2f N N N Y N N N N Y

OTU3 N N N N Y N N N Y

OTU3e N N N N N Y N N Y

OTU4 N N N N N N Y N Y

OTS N N N N N N N Y N

OCHP Y Y Y Y Y Y Y N N

PO Y Y Y Y Y Y Y Y N

OSC100M N N Y N N N N N N

OSC2M N N N Y N N N N N

OSChannel N N N N N N N N N

Ribbon Communications Inc. Proprietary 383

 Fiber Connectivity

Fiber connectivity rules for OTN technology (continued)

PO OSC100M OSC2M OSChannel

OTU1 Y N N N

OTU2 Y N N N

OTU2e Y N N N

OTU2f Y N N N

OTU3 Y N N N

OTU3e Y N N N

OTU4 Y N N N

OTS Y N N N

OCHP N N N N

PO N N N N

OSC100M N N N Y

OSC2M N N N Y

OSChannel N Y Y N

Ribbon Communications Inc. Proprietary 384

 Fiber Connectivity

Fiber connectivity rules for OTUCn ports

OTUC2 OTS OCHP P OSC100M OSC2M OSC1G OSChannel

O

OTUC2 Y N Y Y N N N N

OTS N Y N Y N N N N

OCHP Y N Y Y N N N N

PO Y Y Y Y N N N N

OSC100M N N N N N N N Y

OSC2M N N N N N N N Y

OSC1G N N N N N N N Y

OSChannel N N N N Y Y Y N

The following table shows the fiber connectivity rules for SDH technology.

Fiber connectivity rules for STM technology

STM1 STM1e STM4 STM16 STM64 PO

STM1 Y N N N N Y

STM1e N Y N N N Y

STM4 N N Y N N Y

STM16 N N N Y N Y

STM64 N N N N Y Y

PO Y Y Y Y Y N

The following table shows the fiber connectivity rules for SONET technology

Ribbon Communications Inc. Proprietary 385

 Fiber Connectivity

Fiber connectivity rules for SONET technology

OC3 OC3e OC12 OC48 OC192 PO

OC3 Y N N N N Y

OC3e N Y N N N Y

OC12 N N Y N N Y

OC48 N N N Y N Y

OC192 N N N N Y Y

PO Y Y Y Y Y N

The following table shows the fiber connectivity rules for FC technology.

Fiber connectivity rules for FC technology

FC100 FC200 FC400 FC800 FC1200 FC1600 FC3200 PO

FC100 Y N N N N N N Y

FC200 N Y N N N N N Y

FC400 N N Y N N N N Y

FC800 N N N Y N N N Y

FC1200 N N N N Y N N Y

FC1600 N N N N N Y N Y

FC3200 N N N N N N Y Y

The following table shows the fiber connectivity rules for Ethernet technology.

Ribbon Communications Inc. Proprietary 386

 Fiber Connectivity

Fiber connectivity rules for Ethernet technology

GE GE1 GE10- GE10 GE100- ETY1 ETY1G ETY10 ETY40

0 OTU2e 0 OTU4 G e G G

GE Y N N N N Y Y(note) N N

GE10 N Y N N N N N Y N

GE10- N N Y N N N N N N
OTU2e

GE100 N N N Y N N N N N

GE100- N N N N Y N N N N
OTU4

ETY1G Y N N N N Y N N N

ETY1Ge Y(note) N N N N N Y N N

ETY10G N Y N N N N N Y N

ETY10GO N Y N N N N N N N
C

ETY40G N N N N N N N N Y

ETY100G N N N N N N N N N

OCHP N Y Y Y Y N N N N

PO Y Y Y Y Y Y Y Y Y

Ribbon Communications Inc. Proprietary 387

 Fiber Connectivity

Fiber connectivity rules for Ethernet technology (continued)

ETY100G ETY10GOC OCHP PO

GE N N N Y

GE10 N Y Y Y

GE10-OTU2e N N Y Y

GE100 N N Y Y

GE100-OTU4 N N Y Y

ETY1G N N N Y

ETY1Ge N N N Y

ETY10G N N N Y

ETY10GOC N Y N Y

ETY40G N N N Y

ETY100G Y N N Y

OCHP N N Y Y

PO Y Y Y Y

Fiber connectivity can also be defined between GE10-OTU2e and OTU2e ports, and between GE100-OTU4
and OTU4 ports.

Note
Only GE ports that reside on NPB cards and have electrical connectors (i.e. the expected type has a
suffix starting with e) can connect to this port

The following table shows the fiber connectivity rules for CBR technology.

Ribbon Communications Inc. Proprietary 388

 Fiber Connectivity

Fiber connectivity rules for CBR technology

VIDEO270 HDSD1485 PO

VIDEO270 Y N Y

HDSD1485 N Y Y

PO Y Y N

Ribbon Communications Inc. Proprietary 389

 Customer Management

Customer Management
You can perform the following customer management operations using the STMS:
• Create a Customer
• Modify Customer Information
• Customer Import and Export
◦ Import Customer Information
◦ Export Customer Information
• Customer Reports
◦ Generate a Customer Report: STMS
◦ Generate an Interface Utilization Report: STMS
• Delete a Customer
• View Customer Information

Create a Customer
This section describes how to create a customer.
Start
1. In the Customer Explorer tab, right-click the Customers folder, and click Create Customer.
The Create Customer window opens.

2. In Company Name field, type a name for the customer.

3. (Optional) In the corresponding fields, type additional customer information.

Ribbon Communications Inc. Proprietary 390

 Customer Management

4. Click Finish.

Modify Customer Information

You can modify the information for a customer.
Start
1. In the Customer Explorer tab, right-click the corresponding customer folder, and select Properties.
The property sheet for that customer opens.
2. In the corresponding fields, type the customer information, or leave the information unchanged.
3. Click Apply.

Customer Import and Export

Customer information can be imported from, or exported to, XML files in the reports directory on the STMS
server. The default directory for customer XML files is the /reports directory in the STMS root directory.
• Import Customer Information
• Export Customer Information

Import Customer Information

You can import customer information from XML files in the reports directory on the STMS server. The default
directory for customer XML files is the /reports directory in the STMS root directory.
Start
1. In the Customer Explorer tab, right-click the Customers folder, and click Import Customers.
The Customer Import window opens.
2. Enter the file name of the XML file from which you want to import customer information.
3. Click OK.
The customer information contained in the specified file is added to the Customers folder in the
Customer Explorer tab.

Export Customer Information

You can export customer information to XML files in the reports directory on the STMS server. The default
directory for customer XML files is the /reports directory in the STMS root directory.
Start
1. In the Customer Explorer tab, right-click the Customers folder, and click Export Customers.
The Customer Export window opens.

2. Enter the file name of the XML file to which you want to export customer information.
3. Click OK.
Information for all customers in the Customers folder is saved to the specified XML file.

Ribbon Communications Inc. Proprietary 391

 Customer Management

Customer Reports
The STMS provides a variety of reporting options, including detailed customer reports. You can generate the
following types of customer reports:
• Customer Report: Displays pertinent information about the logical interfaces and E-Line services
assigned to customers. It can be generated for all customers in the Customers folder or a single
customer. See Generate a Customer Report.
• Interface Utilization: Displays utilization information about the interfaces assigned to a customer for a
specified interval. It can be generated for a single customer. See Generate an Interface Utilization
Report.
All of the generated customer reports are saved in HTML format to the reports directory on the STMS server.
The default reports directory is the /reports directory in the STMS root directory.

Note
For information about STMS reporting options, see the STMS Performance Management Guide.

Generate a Customer Report: STMS

You can generate a customer report.
Start
1. Do one of the following:
◦ To save a report for all customers, in the Customer Explorer tab, right-click the Customers folder
and click Customer Report.
◦ To save a report for a single customer, in the Customer Explorer tab, right-click the corresponding
customer folder, point to Reports, and then click Customer Report.
The Generate Report window opens.
2. Type a file name for the report.
3. Click Save.

Generate an Interface Utilization Report: STMS

You can generate an Interface Utilization report.
Start
1. In the Customer Explorer tab, right-click the corresponding customer folder, point to Reports, and
click Interface Utilization.
The Generate Report window opens.
2. Type a file name for the report.
3. Click OK.
The Report Interval window opens.

4. In the Start date field, type a start date (in the form MM/DD/YYYY) or click the Calendar button ( )
and select a start date.
5. From the corresponding Time list, select a start time.

Ribbon Communications Inc. Proprietary 392

 Customer Management

6. In the End date field, type an end date (in the form MM/DD/YYYY) or click the Calendar button ( )
and select an end date.
7. From the corresponding Time list, select an end time.
8. Click OK.

Delete a Customer
You can delete a customer.
Start
• In the Customer Explorer tab, right-click the corresponding customer you want to delete, and click
Delete.
When you delete a customer, the interface and services that were assigned to that customer are
moved to the Carrier Resources folder.

View Customer Information

You can view customer information.
Start
• In the Customer Explorer tab, right-click the customer folder and select Properties.
The customer information appears.

Ribbon Communications Inc. Proprietary 393

 Customer Management

Customer information

Field Description

Customer Name Name of customer

Street 1 Street address

Street 2 Additional address information

City City name

State State or province name

Zip Zip or postal code

Country Country name

Name Name of customer contact

Email E-mail address

Phone Telephone number

Fax Fax number

URL Web address

Ribbon Communications Inc. Proprietary 394

 Apollo Workflows

Apollo Workflows
This chapter provides examples of typical workflows which are available when working with the LightSOFT
NMS in conjunction with Apollo systems.
This is intended to help the LightSOFT user to work with the NMS and does not represent an exclusive list of
all the workflows available in the LightSOFT environment.
• Apollo Workflow: Add ROADM Degrees
• Apollo Workflow: Add WSON-Protected Trail
• Apollo Workflow: Change Bandwidth
• Apollo Workflow: Configure an Alien Lambda Running Over an Apollo Network
• Apollo Workflow: Configure Client-Port Protection
• Apollo Workflow: Configure ERP Ring 8032 Protection
• Apollo Workflow: Configure Multi-Route OCH Protection
• Apollo Workflow: Configure OTN Services
• Apollo Workflow: Configure Y-Protection
• Apollo Workflow: Edit Optical Trail: Frequency
• Apollo Workflow: Migrate Optical Trail: Insert Site

Apollo Workflow: Add ROADM Degrees

This workflow provides a high level overview of the steps to add a new degree to create an additional
direction for the network site.
In this simple workflow scenario, a typical optical site (Site A) is already connected to two other sites (Site B
and Site C).
Site A would now like to add a degree to the network configuration, adding a new direction to Site D and
thereby expanding the network capacity.
We are adding a new ROADM card, to be connected to a corresponding ROADM at another site, as well as
connected internally to the other local site ROADM cards.

Note
This workflow describes a generic procedure, using the ROADM20TF card in the example. Other
ROADMs could be used similarly, with or without ROADM collectors (ROADM_20CF or
ROADM_8X24CDCF) or ROADMs with Mux/DeMux modules attached to for local add/drop.

For this workflow example, we are focusing on two of these sites - Site A and Site D.
We are adding a new ROADM20TF card to Site A, thereby adding a new direction for traffic transmission, in
this case "southward" from Site A to Site D.
The new card will be connected externally to the corresponding ROADM card in Site D, as well as internally
to the other ROADM cards in Site A.
This configuration is illustrated in the following figure.

Ribbon Communications Inc. Proprietary 395

 Apollo Workflows

Add ROADM degrees

To add a new ROADM card to Site A

Start
1. Assign New ROADM Card in Site A.
2. Configure ports on new ROADM card.
3. Create a Logical Element for a New ROADM Card.
4. Create Links Between LEs.

Ribbon Communications Inc. Proprietary 396

 Apollo Workflows

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Assign New ROADM Card in Site A

This procedure is the first step in adding a new degree to a site (see Add degrees).
In this step you add a new ROADM card to the platform in Site A.
Start
1. Working from the LightSOFT level, click the Topology Layer dropdown list.
2. Select the appropriate topology view from the list. In this example, select the Physical (EMS) layer.
The appropriate topology view is displayed.

3. In the main window map or the tree view, select the EMS for which you want to add the ROADM.
4. Right-click the relevant object.
5. Select Open to open a GCT window to STMS at the EMS level.
The EMS main window opens.
6. At the STMS level, right-click on the appropriate slot in the NE and select Assign Card.

Ribbon Communications Inc. Proprietary 397

 Apollo Workflows

The Assign Card window opens.

The supported card types appear in the Choose Card Type pane.
7. Select the correct ROADM card type and click Set.
The new ROADM card is assigned.

Ribbon Communications Inc. Proprietary 398

 Apollo Workflows

8. Verify new slot assignments in the EMS main window portrayal of the platform slot layout (optional).

Ribbon Communications Inc. Proprietary 399

 Apollo Workflows

Tip
Make a note of the selected slots as you will need this later in the procedure for subsequent
steps at the LightSOFT level.

Configure Port on New ROADM Card

This procedure is the second step in adding a new degree to a site (see Add degrees).
At this point you continue to work in the STMS chassis view.
The new ROADM_20TF card is in place in the platform.
You now configure the port needed on the new ROADM card.
Start
1. In the chassis view, right-click the new ROADM card and select Configure Port.

The Port Configuration window opens.

2. Select the checkboxes of the ports you want to define.
In this example we are selecting ports u16/1, u16/2, u16/3.
3. Set the port type to OTS.
4. Click Finish.

Ribbon Communications Inc. Proprietary 400

 Apollo Workflows

Tip
Make a note of the selected ports and wavelengths as you will need this later in the procedure
for subsequent steps at the LightSOFT level.

Create a Logical Element for a New ROADM Card

This procedure is the third step in adding a new degree to a site (see Add degrees).
The card configured in the NE at the STMS EMS level must be added to the topology map at the LightSOFT
NMS level.
Physical cards are represented by logical elements (LEs) on the LightSOFT map.
An LE must be created for the ROADM card added to the endpoint NE.
In this example, we are adding a fourth ROADM LE to the three that were already defined for Site A visible
on the map.
Start
1. In the Topology Layer dropdown list, select the Optical technology layer.
2. In the map, right-click the relevant endpoint NE on the topology map and select Create LE.

Ribbon Communications Inc. Proprietary 401

 Apollo Workflows

The Create Logical Element window opens.

3. In the LE Name field, enter a name for the LE.
We recommend choosing meaningful names that clearly identify each LE module. In this example we
are naming the LE: Site_A_ROADM20TF_4.

Ribbon Communications Inc. Proprietary 402

 Apollo Workflows

4. Click Apply.

The LE is created and the cursor displays a representative LE icon ( ).

5. Move the cursor to the required location on the map, and click once to drop the LE in place.

Create Links Between LEs

This procedure is the fourth step in adding a new degree to a site (see Add degrees).
At this point the topology map displays the complete set of LEs.
The next step is to configure topology links for the underlying infrastructure.
You need:
• Three new 'internal' links, running between the new Site A ROADM card and the other three ROADMs
configured in Site A.
• A new 'external' link, running between the new Site A ROADM card and a corresponding ROADM card
in Site D.

Ribbon Communications Inc. Proprietary 403

 Apollo Workflows

Tip
Create the links in a methodical sequence, starting at one end and creating all links along the
way until you reach the other end.
For example, in this case:

You create each link needed in this topology by repeating the following steps.
Start
1. In the main LightSOFT toolbar, select the Topology tab.
2. In the Topology Layer dropdown list, select the Optical technology layer.
3. On the topology map, select the new ROADM card. In this example we are working with
Site_A_ROADM20TF_4 in Site A.
4. Holding the <Shift> key, select one of the other ROADM cards in Site A.
The following figure highlights the link between the new card and Site_A_ROADM20TF_3.

5. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots, and ports.

Ribbon Communications Inc. Proprietary 404

 Apollo Workflows

6. Select the appropriate OTS ports on the two ROADM cards as the link endpoints.
Tip - Verify with the notes you took earlier in this workflow.
7. Click Apply to create the new topology link.
8. Repeat these steps to create new internal links between the new ROADM card and the other local
ROADM cards in the same site (Site A).
9. To create the new external topology link between the new ROADM card in Site A and the
corresponding ROADM card in Site D, complete the same steps:
◦ On the topology map, select the new ROADM card in Site A, Site_A_ROADM20TF_4.
◦ Holding the <Shift> key, select the LE representing the corresponding ROADM card in Site D,
Site_D_ROADM.

Ribbon Communications Inc. Proprietary 405

 Apollo Workflows

10. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.

Ribbon Communications Inc. Proprietary 406

 Apollo Workflows

11. Select the appropriate OTS ports on the two ROADM cards as the link endpoints.
12. Click Apply to create the new topology link.
The new topology is now all in place and ready for use.

Ribbon Communications Inc. Proprietary 407

 Apollo Workflows

Apollo Workflow: Add WSON-Protected Trail

This workflow provides a high level overview of the stages in adding WSON-protected OTN channels to an
NE.
The workflow includes provisioning one of the services to be used.
An OMS trail can contain up to 88 OCH trails. Using only a single OMS Data Link (DL), all 88 trails are
protected.
1+R protection means that in the event of a problem on the main path, the system finds an alternative path
using existing available resources and restoring traffic dynamically in a few seconds.
Recovery paths are protected in the same way. New recovery paths can be implemented as long as
additional paths satisfying current criteria are found.
In this workflow example, we add a WSON-protected OTN channel to the network.
This workflow focuses on the WSON-specific steps. We assume that the underlying infrastructure
(ROADM_4FS, ROADM_20CF, TM200_2 cards, filters and amplifiers, client and line ports, LEs, topology
links, OCH trails) are already in place.
For this workflow example, we work with three NEs (NE1, NE2, NE3), each one with the appropriate cards
and ports configured. Topology links and OMS trails are already provisioned, linking the three NEs into a
simple structure, as illustrated in the following figure.

Add WSON-protected trail

For a general introduction to and explanation of ASON/WSON trail protection, see ASON-WSON Trail
Protection.
To configure WSON protected trails:
1. Create OMS (DL) trails.

Ribbon Communications Inc. Proprietary 408

 Apollo Workflows

2. Create a WSON-protected OCH trail.

3. Provision an LP trail for the new service.

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Create OMS DL Trails: NMS

This procedure is the first step in configuring WSON-protected trails in an Apollo network. See Add WSON-
protected trails.
Since this workflow focuses on the WSON-specific steps, we are assuming that the underlying infrastructure
(ROADM_4FS, ROADM_20CF, TR200_2 cards, filters and amplifiers, ports, LEs, and topology links) is
already in place.
WSON protection requires an underlying infrastructure of OMS trails, serving as data links throughout the
optical topology. This includes links between sites, and within the same site between different cards.

Ribbon Communications Inc. Proprietary 409

 Apollo Workflows

The OMS (DL) links required for this workflow example are illustrated in the following figure.

In this workflow example we create a topology based on the OMS (DL) trails running between the ROADM
card line ports in the three participating NEs (NE1, NE2, NE3):
• Between Line Port 0 on the first ROADM_4FS card in NE1 and Line Port 0 on the first
ROADM_4FS card in NE2
• Between Port 3 on the first ROADM_4FS card in NE2 and Port 1 on the ROADM_20CF collector
card in NE2
• Between Port 2 on the ROADM_20CF collector card in NE2 and Port 3 on the second ROADM_4FS
card in NE2
• Between Line Port 0 on the second ROADM_4FS card in NE2, and Line Port 0 on the first
ROADM_4FS card in NE3
• Between Port 3 on the first ROADM_4FS card in NE3 and Port 3 on the second ROADM_4FS card
in NE3
• Between Line Port 0 on the second ROADM_4FS card in NE3, and Line Port 0 on the second
ROADM_4FS card in NE1
• Between Port 3 on the second ROADM_4FS card in NE1 and Port 2 on the ROADM_20CF collector
card in NE1
• Between Port 1 on the ROADM_20CF collector card in NE1 and Port 3 on the first ROADM_4FS
card in NE1
This section provides a simple example of the workflow steps. For a more detailed explanation of each step,
see Provision OMS trails.
For an explanation of the trail options, see Basic trail parameters pane and Advanced trail parameters pane.

Ribbon Communications Inc. Proprietary 410

 Apollo Workflows

Create OMS (DL) Trails

Start
1. In the LightSOFT main window, select the Optical topology layer:
◦ Access the Topology Layer dropdown list.
◦ Select the appropriate topology view from the list. In this example, select the Optical layer.
The appropriate topology view is displayed.
2. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
If nothing was preselected in the main window, the map shows all the objects, otherwise the map
contains only the selected objects and the links between them.
3. Select the Trail Parameters tab.
4. In the Basic Trail Parameters pane, edit one or more of the following parameters:
◦ Rate: OMS
◦ Directionality: Bidirectional
◦ Label and Customer names, as relevant
◦ Protection: Unprotected
5. To create a WSON DL, in the Advanced Protection pane, select the Build WSON Data Links
checkbox.
6. In the Advanced Trail Parameters pane, edit one or more of the trail parameters, as needed.

Note
If trail parameters are not specified, LightSOFT sets default values.
In most cases, the default values are fine for this workflow.
Protection fields that are not relevant to the trail being provisioned are grayed out.

7. In the Comments field, type a free text comment about the trail.
8. Select endpoints to define the path on which the trail is created. (This function is enabled only after a
trail rate is selected.)
9. Right-click an LE in the map, and choose Select Endpoint.
The Endpoint Selection window opens.
The ports that are free and conform to the selected trail rate are available for selection.
10. Select endpoint ports. Since we are creating WSON DLs, you must select ROADM ports.
Typically one endpoint is sufficient.
In this workflow example, start by selecting Line Port 0 on the first ROADM_4FS card on NE1.
The corresponding Line Port 0 on the first ROADM_4FS card on NE2 is selected.
The selected endpoints are reflected in the Endpoints List pane.

11. Click Complete service .

12. Click Activate service .

Clicking Complete finds and verifies the path and shows the results in the map, but does not create
the trail until Activate is performed.
13. Repeat this procedure to create a second OMS (DL) trail between Port 3 on the first ROADM_4FS
card in NE2 and Port 1 on the ROADM_20CF collector card in NE2.
14. Repeat this procedure to create a third OMS (DL) trail between Port 2 on the ROADM_20CF
collector card in NE2 and Port 3 on the second ROADM_4FS card in NE2.
15. Repeat this procedure to create a fourth OMS (DL) trail between Line Port 0 on the second
ROADM_4FS card in NE2 and Line Port 0 on the first ROADM_4FS card in NE3.
16. Repeat this procedure to create a fifth OMS (DL) trail between Port 3 on the first ROADM_4FS card
and Port 3 on the second ROADM_4FS card in NE3.
17. Repeat this procedure to create a sixth OMS (DL) trail between Line Port 0 on the second
ROADM_4FS card in NE3 and Line Port 0 on the second ROADM_4FS card in NE1.
18. Repeat this procedure to create a seventh OMS (DL) trail between Port 3 on the second
ROADM_4FS card in NE1 and Port 2 on the ROADM_20CF collector card in NE1.

Ribbon Communications Inc. Proprietary 411

 Apollo Workflows

19. Repeat this procedure to create an eight OMS (DL) trail between Port 1 on the ROADM_20CF
collector card in NE1 and Port 3 on the first ROADM_4FS card in NE1.

Tips
Note the slot, card, port, and wavelength settings selected at this stage. You will need the
information when configuring settings at the LightSOFT level.

Create WSON-Protected OCH Trail: NMS

This procedure is the second step in configuring WSON-protected trails in an Apollo network. See Add
WSON-protected trails.
Once the underlying OMS DL trails are created, you can create the OCH trail that will be using the OMS DLs,
and configure WSON (1+R) protection for that trail.
In this workflow example we are creating a single WSON-protected OCH trail running between the TR200_2
line ports in NE1 and NE2.
The WSON-protected trail runs over the topology links and OMS (DL) trails configured previously. If the main
OCH trail running directly between NE1 and NE2 goes down, a restoration path is provisioned, in this case
running through NE3.
This section provides a simple example of the workflow steps.
For a more detailed explanation of each step, see Provision OCH trails.
For an explanation of the trail options, see Basic trail parameters pane and Advanced trail parameters pane.
Start
1. On the Topology map, drag the mouse to select the network topology structure that you just
configured.
2. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
3. Select the Trail Parameters tab.
4. In the Basic Trail Parameters area select:
◦ Rate: OCH
◦ Directionality: Bidirectional
◦ Label and Customer names, as relevant
5. In the Advanced Protection pane select the ASON/WSON checkbox.
6. In the Protection field select 1+R (Bronze) (for this workflow example).
7. In the Advanced Protection area, Reversion field select Auto (for this workflow example), and set
WTR to 2 minutes.
8. Select the two LEs on the map that are to be the two endpoints for the new OCH trail running between
NE1 and NE2.
This process can also be completed separately for each endpoint but is more efficient to configure
both endpoints simultaneously.
9. Right-click and choose Select Endpoint.
The Select Endpoint window opens, listing both LEs with their ports displayed in a tree structure.
Enabled nodes represent ports that are available for selection as endpoints.
The Tx and Rx channels configured for each port (if any) are listed next to the port in the tree.
10. Select the appropriate Add/Drop mode. Default mode for bidirectional trails is Add&Drop.
11. Select the protection scheme for the endpoint; in this example, Main.
12. Select the two ports with matching channel values to serve as trail endpoints; in this example, Line
Port 0 on the TR200_2 cards in NE1 and NE2.
Selecting an endpoint displays the Tx channel in the Selected Port Details field.
13. If the port channels are configured appropriately, click Select Port to choose those endpoints. For this
example we are assuming the wavelengths and spectral bandwidth were set correctly to match.

Ribbon Communications Inc. Proprietary 412

 Apollo Workflows

14. Click anywhere in the Select Endpoint window to close the Channel Selector window and the
Select Endpoint window.
The selected endpoints are reflected in the Endpoints List pane.
15. Select the Endpoints & Path tab.
16. In the Path Completion Method pane, select the Auto-Complete (default) path completion method
(for this workflow).
PathFinder automatically suggests an optimal path for the trail based on the minimum user selections,
in accordance with applicable user preferences.

17. Click Complete service .

18. Click Activate service .

Clicking Complete finds and verifies the path and shows the results in the map, but does not create
the trail until Activate is performed.
A status window displayed at the end of the Complete/Activate stage indicates the state of the new
trail and provides links to more information.

Tips
Note the slot, card, port, and wavelength settings selected at this stage. You will need the
information when configuring settings at the LightSOFT level.

Provision an LP Trail for the New Service: NMS

This procedure is the third (and final) step in configuring WSON-protected trails in an Apollo network. See
Add WSON-protected trails.
Once the underlying OMS (DL) and OCH trails are created, you can provision the LP trail to be used by new
services running over these WSON-protected trails.
In this example, because we have configured WSON protection, the network map displays the LP trail with a
single (main/pink) path running directly between NE1 and NE2.
If WSON protection is activated, the map displays a dotted pink path route running from NE1, through NE3,
and on to NE2. When service is restored, the original pink route between NE1 and NE2 is also restored on
the map display.
This section provides a simple example of the workflow steps.
Start
1. On the Topology map, drag the mouse to select the network topology structure that you just
configured, nodes and links.
2. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
3. In the Trail Parameters pane:
◦ Set the trail rate to LP.
◦ Choose Bidirectional.
◦ Choose the Unprotected protection option.
◦ In the Advanced Protection section, clear all checkboxes.
◦ Select the appropriate Capacity option.
◦ Choose ODU-Structured and select the appropriate rate from the drop-down field, to match the
rate configured for the client ports.
In this example, the rate would be 10GBE.
◦ Select the client ports as the new trail endpoints.
In this workflow example we are working with Client Port 2 on the TR200_2 card configured in
NE1, and the corresponding Client Port 2 on the TR200_2 card configured in NE2.

Ribbon Communications Inc. Proprietary 413

 Apollo Workflows

4. Click Complete .
Pathfinder identifies the appropriate main and protection paths, utilizing the network resources that
you have already provisioned in previous steps.

5. Click Activate .
The new LP trail is provisioned and ready for use as needed.
6. Verify the new LP trail by opening the Trail List table and locating the newly configured trail (optional).
7. Select one of the participating LEs.
8. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
9. Check the state of the new trail to verify that it is OK.
10. Select the trail in the trail list to see the trail path highlighted in the topology map.

Note
For further assistance, contact your local customer support representative.

Apollo Workflow: Change Bandwidth

This workflow provides a high level overview of the stages in changing the bandwidth allowed over a 10G
OTN service. In this workflow example, we increase the bandwidth that can be carried from 1.25G to 2.5G.
The workflow includes provisioning the underlying infrastructure and relevant service. An underlying topology
infrastructure must be created at the STMS level.
For this workflow example, we work with two OPT9904X platforms, each one with an MIO200 card
configured with a GE10 client port and 100G line ports.

Change bandwidth

Start
1. Configure client and line ports on MIO200 cards on both NEs.
2. Create topology links between line ports.
3. Provision underlying OCH trail between line ports.
4. Provision ODU4 trail.
5. Provision ODUF-GFP trail.
6. Create P2P service between GE10 client ports.
7. Increase BW for ODUF-GFP to 5Gbps.

Ribbon Communications Inc. Proprietary 414

 Apollo Workflows

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Configure Client and Line Ports on MIO200 Cards - Both NEs:

EMS
This procedure is the first step in changing (increasing) bandwidth (BW) in an Apollo network. See Change
Bandwidth.
An underlying topology infrastructure must be created at the STMS level, including two OPT9904X platforms,
each populated with an MIO200 card.
These cards should be configured with the appropriate client and line ports.
Start
1. Select the Physical (EMS) topology layer.
2. Open a GCT window to the STMS at the EMS level.
◦ In the Main window map or the tree view, right-click the relevant NE object.
◦ Select Open.
The EMS main window opens.
3. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.
4. Select a slot for the MIO200 card.
The supported card types appear in the right pane.

Ribbon Communications Inc. Proprietary 415

 Apollo Workflows

5. Select the card type and click Finish.

The card is assigned.
6. Verify new slot assignments in the STMS main window portrayal of the platform slot layout (optional).
7. From the Chassis view, right-click the MIO200 card and select Configure Port.
The Port Configuration window opens.
8. In the Select column, select the checkboxes of the MIO200 ports you want to define.
9. Configure the GE10 client port, with the appropriate port type, transceiver, and wavelength.
The other default attributes can be maintained.
10. Configure the 100G line port, with the appropriate port type, transceiver, and wavelength.
The other default attributes can be maintained.
11. Choose the appropriate DWDM channel to be used.
12. Set the port mode to VLAN_TAGGED.
13. The Actual Transceiver Type column shows the actual transceiver installed.
14. For newly assigned ports, you can copy the actual transceivers to the configured transceivers by
selecting the relevant ports and clicking Copy Actual Transceiver to Configured.
15. Repeat these steps for the MIO200 card ports on the second NE.

Tip
Client and line port configuration on the two MIO200 cards must match.
Make a note of the card and port configuration details (slot number, port number, type, rate,
transceiver, wavelength).
You will need this later in the procedure for subsequent steps at the LightSOFT level.

Create Topology Links Between Line Ports: NMS

This procedure is the second step in changing (increasing) bandwidth (BW) in an Apollo network. See
Change Bandwidth.
The cards configured in the NEs at the STMS EMS level must be added to the topology map at the
LightSOFT level.
The physical cards are represented by logical elements (LEs) on the LightSOFT map.
An LE must be created for each card installed, in each endpoint NE. These LEs are then connected with
fiber connectivity topology links.
Start
1. In the Topology Layer dropdown list, select the technology layer in which you want to create the LEs.
2. In the map, right-click the first endpoint NE on the topology map and select Create LE.
The Create Logical Element window opens.
You are now going to create an LE for each of the cards you just configured in that NE.
3. In the LE Name field, enter a name for the LE.
4. Keep the Auto Create LE checkbox checked to automatically assign each LE a meaningful name that
identifies the NE source, slot, and card type.
The port selection area of the window becomes active.
5. In the LE Type dropdown list, select the type of LE you want to create.
The icon for that LE type is displayed next to the dropdown list.
6. In the Primary LE area, select the cards, slots, or ports that the secondary LE represents, and click
Add .
The selected elements are moved to the Secondary LE area.
7. Click Apply.
The LE is created and the cursor displays a representative LE icon ( ).
8. Move the cursor to the required location on the map, and click once to drop the LE in place.
9. Right-click the second endpoint NE on the topology map and create a second set of LEs.

Ribbon Communications Inc. Proprietary 416

 Apollo Workflows

10. Create a fiber connectivity topology link between the two line ports on the MIO200 cards in the two
platforms.
11. On the topology map, select the LE object for the MIO200 card in the first NE.
12. Holding the <Shift> key, select the LE object for the MIO200 card in the second NE.
13. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
For an internal link, the two panes show details of the same object.
14. Select the appropriate 100G line ports on the LE as the link endpoints.
15. Click Apply to create the new topology link.
The new link is highlighted in pink on the topology map view.
16. Verify the links by opening the Link List table and locating the newly configured links (optional).
17. In the main window, select the relevant objects.
18. In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).

Tips
◦ It might be easier to locate the link if you filter the table and/or focus on the Frequency
column.
Or you can look at the end of the table - new links are usually added at the bottom of the
table list.
◦ Refer to your notes from the previous steps to verify the slot number and channel
frequency of the card that you just configured.
They should match the values listed for that slot, card, port in the Available Automatic
Split Selection table.

Provision Underlying OCH Trail Between Line Ports: NMS

This procedure is the third step in changing (increasing) bandwidth (BW) in an Apollo network. See Change
Bandwidth.
An OCH trail must be provisioned between the two line ports before we can provision a higher-level trail or
service to run between the client endpoints.
Start
1. Select the Optical topology layer.
2. In the main window select the 2 LEs that will serve as the endpoints of the new OCH trail (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. In the Basic Trail Parameters pane, set the following parameters:
◦ Set the trail rate to OCH.
◦ Choose the Unprotected option.
◦ Choose the Bidirectional option.
◦ Edit Label and Customer names (optional).
In this example, the default values can be kept for the other fields.
If necessary, you can edit as relevant for your network configuration.
6. Select the relevant endpoints on the two NEs.
In this example we select the relevant 100G line ports on the selected MIO200 cards.

Ribbon Communications Inc. Proprietary 417

 Apollo Workflows

7. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.
8. Click Activate .
The new OCH trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
9. Verify the new OCH trails by opening the Trail List table and locating the newly configured trails
(optional).
10. Select one of the participating LEs.
11. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
12. Check the state of the new trails to verify that they are all OK.
13. Select one or more trails in the trail list to see the trail path[s] highlighted in the topology map.

Tips
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at the
STMS level.

Provision ODU4 Trail: NMS

This procedure is the fourth step in changing (increasing) bandwidth (BW) in an Apollo network. See Change
Bandwidth.
At this point you are provisioning an ODU4 trail over the topology infrastructure you have just configured.
Start
1. Select the Optical topology layer.
2. Select the 2 LEs that will serve as the endpoints of the new trail.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. Set the trail rate to ODU.
6. Choose the Unprotected option.
7. Choose the Bidirectional option.
8. Configure Capacity based on the underlying line port configuration at the STMS level. In this workflow
example, ODU4.
9. Right-click an LE in the map and choose Select Endpoint.
The Endpoint Selection window opens.
The ports that are free and conform to the selected trail rate and capacity are available for selection.
10. Select the relevant endpoints on the two NEs. In this workflow example, the 100G line ports on the
MIO200 cards.

11. Click Complete .

Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.
12. Click Activate .
The new ODU trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
13. Verify the new ODU trails by opening the Trail List table and locating the newly configured trails
(optional).
14. Select one of the participating LEs.

Ribbon Communications Inc. Proprietary 418

 Apollo Workflows

15. Right-click and select Show Trails.

The Trail List window opens showing only trails associated with the selected LE.
16. Check the state of the new trails to verify that they are all OK.
17. Select one or more trails in the trail list to see the trail path(s) highlighted in the topology map.

Tips
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at the
STMS level.

Provision ODUF-GFP Trail: NMS

This procedure is the fifth step in changing (increasing) bandwidth (BW) in an Apollo network. See Change
Bandwidth.
For a detailed explanation of ODU packet trails, see ODU Packet Trails.
Start
1. Select the Optical topology layer.
2. Select the 2 LEs that will serve as the endpoints of the new trail.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. Set the Rate to ODU.
6. Set the Capacity to ODUF-GFP.
7. Set the Trail Role to Primary.
8. Set the Bandwidth (for this workflow example) to 3.75Gbps.
9. Enter a unique Group Name attribute value.

10. Click Complete .

Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.
11. Click Activate .
The new ODU trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
12. Verify the new ODU trails by opening the Trail List table and locating the newly configured trails
(optional).
13. Select one of the participating LEs.
14. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
15. Check the state of the new trails to verify that they are all OK.
16. Select one or more trails in the trail list to see the trail path(s) highlighted in the topology map.

Tips
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at the
STMS level.

Create P2P Service Between GE10 Client Ports: NMS

This procedure is the sixth step in changing (increasing) bandwidth (BW) in an Apollo network. See Change
Bandwidth.

Ribbon Communications Inc. Proprietary 419

 Apollo Workflows

In this step you create a P2P service between the GE10 client ports on the MIO200 cards in the two NEs.
This workflow focuses on the steps essential for this specific example.
For more information about creating a P2P service, see Configure PB P2P services between cards.
Start
1. In the Services tab, L2VPN group, click the Create an L2VPN Service icon.
2. In the Create an L2VPN Service process, select the P2P service type and select PB endpoints.
The Provider Bridge Network tab shows the PB network.
In this workflow example we select the GE10 client ports we configured on the MIO200 cards.
3. To assign C-VLAN values, from the Endpoints List in the Endpoints tab, select each UNI port entry
in turn and configure the C-VLAN values.
For this workflow example, set the customer VLAN to 100, with No Rate Limit.
4. Repeat the endpoint configuration for the second service endpoint on the second NE.

Tip
If endpoints have the same or similar attributes and settings, after they are selected and you
have fully configured one endpoint, you can copy and paste some/all attributes and settings to
other endpoints.
In the Endpoint List pane, do the following:
◦ Right-click a configured endpoint line, and select Copy Details.
◦ Select one or more endpoint lines into which to copy the attributes and settings.
◦ Right-click, select Paste Details, and then All Details or a specific configuration aspect.
See Endpoint shortcut options.

Increase BW for ODUF-GFP to 5Gbps: NMS

This procedure is the seventh (and final) step in changing (increasing) bandwidth (BW) in an Apollo network.
See Change Bandwidth.
At this point you will increase the bandwidth allowance for the ODUF-GFP trail to 5Gbps.
Start
1. In the Trail List, locate the ODUF-GFP trail.
2. Right-click on the trail and select BW Resizing.
3. Increase the Bandwidth from the current value of 3.75Gbps to a new value of 5Gbps.
4. Click Apply.
LightSOFT starts the HAO increase bandwidth protocol configuration of all the NEs in the selected
trail.
While the resizing is actually in process, the BW Resizing window appears with a progress bar.

Ribbon Communications Inc. Proprietary 420

 Apollo Workflows

Apollo Workflow: Configure an Alien Lambda Running

Over an Apollo Network
This workflow provides a high level overview of the stages in configuring an alien lambda.
This particular example illustrates the configuration of a frequency that originates in an external or 3rd party
"Alien" network, travels through an existing Apollo network, and continues onward towards a second external
or 3rd party "Alien" network.
Each stage in the workflow includes a link to the specific procedure.
Different procedures may be completed at various network levels.
For example, a port is configured at the STMS level while an E2E service is configured at the NMS level.
This topology includes the minimal components required to configure an alien lambda configuration.
In this configuration, an OCH trail is configured between 2 Apollo NEs.
Each NE includes a card (typically a ROADM, Mux/DeMux, TFA) in which an OCHP port is configured to
handle the alien lambda.
In this example we are working with a TFA card. Two UMEs are also configured, each one representing the
external or 3rd party (alien) network at one end of the network.

Alien Network Topology

Ribbon Communications Inc. Proprietary 421

 Apollo Workflows

Tip
Multi-route OCH protection is implemented by configuring parallel OCH trails running between
different NEs, configured with the same card and port attributes.
To add multi-route OCH protection to this workflow, refer to the Configure MOCH Protection
workflow, designate the additional NEs, cards, and ports as relevant, and add the steps there that
are specific to multi-route OCH protection.

Start
1. Configure Unmanaged Elements with Same Frequency and Spacing: NMS.
2. Configure TFA OCHP Port with Frequency: STMS.
3. Create Fiber Connectivity via LightSOFT Between the NE-TFA: STMS.
4. Enable Alien Lambda on the Same TFA Port: STMS
5. Provision an OCH Trail: NMS.

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Configure Unmanaged Elements with Same Frequency and

Spacing: NMS
This procedure is the first step in the configuration of an alien lambda in an Apollo network. See Configure an
Alien Lambda Running over an Apollo Network.
The two alien/third-party network transceivers in this configuration are represented in LightSOFT by two
unmanaged elements (UMEs).
These UMEs must now be defined and added to the topology map.
Afterwards you configure the topology links between the OCHP ports on the NEs at each end of the Apollo
network, and the UMEs representing the alien networks.

Alien Network Topology

Start
1. Select the Optical topology layer.
2. In the Topology Layer dropdown list, select the optical topology layer.
3. In the Topology ribbon, in the Create group, click Create UME.
The Create UME window opens.
You are now going to create two UMEs, one for each alien network at each end of the Apollo network.

Ribbon Communications Inc. Proprietary 422

 Apollo Workflows

4. For the Technology Layer, select OTN.

5. For the UME Type, select Terminal OTN.
6. For the Number of UMEs, select 2.
7. For UME Name, enter a logical meaningful name for this UME (in this case Alien EP).
When the two UMEs are placed on the network map, they will be named Alien EP_1 and Alien EP_2.
8. For Ports Configuration, in the Colored tab, select the appropriate values.
In this example, OTU2 is set to 1, OCH Band is set to C Band - 50GHz, and the OCH Channel is
193.0.
These values correspond to the settings that were configured at the STMS level.

9. Click Apply.
The UMEs are created and the cursor displays a representative icon.
10. Move the cursor to the appropriate location on the side of the first NE on the map, and click once to
drop the first UME icon in place.
11. Move the cursor to the appropriate location on the side of the second NE on the map, and click once
to drop the second UME icon in place.
12. On the topology map, select the first UME.
13. Hold the <Shift> key, and select the first endpoint NE with the port that you just configured for an alien
lambda.
14. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures for the 2 selected objects, showing the objects,
slots and ports.

Ribbon Communications Inc. Proprietary 423

 Apollo Workflows

15. To display the channel frequency configured for each port next to that port in the NE object tree, click
the View menu and select Show Frequency.
This simplifies selection of the correct port.
16. Select the appropriate ports on the endpoint NE and the UME objects.
In this example, select OCHP Port 7 on the TFA card in the NE, and the corresponding OTU4 port on
the UME.
Both display the same frequency set, matching the port channel you configured at the STMS level.
17. Click Apply to create the new topology link.
18. Repeat this procedure for the UME and NE at the second end of the network.
19. Verify the links by opening the Link List table and locating the newly configured link (optional).
◦ In the main window, select the relevant objects.
◦ In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).

Tips
• Refer to your notes from the previous steps to verify the channel frequency and other
attributes of the port that you just configured at the STMS level.
• It might be easier to locate the link if you filter the table and/or focus on the Frequency
column.
You can also look at the end of the table - new links are usually added at the bottom of the
table list.

Configure TFA OCHP Port with Frequency: STMS

This procedure is the second step in configuring an alien lambda in an Apollo network. See Configure an
Alien Lambda Running Over an Apollo Network.
To enable Apollo equipment to communicate with alien (non-Apollo/external/third-party) equipment, you must
configure an OCHP port (on the relevant Mux/DeMux, TFA,ROADM) that will be able to send and receive
transmissions to/from the alien equipment.
Start
1. Configure in a TFA port 7 Rx and Tx frequency to 193.0.
In this example we are working with TFA cards.

Ribbon Communications Inc. Proprietary 424

 Apollo Workflows

2. In the Network Explorer tab (or in Chassis view), right-click the port and select Properties.
In this example we are working with Port 7 on the TFA card.
The port properties appear.
3. Click the OCHP Attributes tab.
The OCHP port attributes appear.

4. For Alien Lambda, select Enable.

5. In the Misc Attributes section, select the relevant frequencies for the Rx Frequency and Tx
Frequency fields.
In this example we are working with 193.0.

Ribbon Communications Inc. Proprietary 425

 Apollo Workflows

6. Click Apply.
7. Define the rest of the OCHP attributes (preferably as many as possible).

Important
It is possible to configure the OCHP port with minimal attribute definitions only. However, it is
recommended that you define as many attributes as possible, to enable more accurate ONCP
calculations and more efficient power equalization.

Ribbon Communications Inc. Proprietary 426

 Apollo Workflows

8. Click Apply.
The changes are saved.
9. Repeat the OCHP port attribute configuration for the second NE endpoint.

Create Fiber Connectivity via LightSOFT Between the NE-TFA:

STMS
This procedure is the third step in configuring an alien lambda in an Apollo network. See Configure an Alien
Lambda Running Over an Apollo Network.
Alien lambdas are transmitted by third-party WDM transceivers.
These transceivers are connected directly to Apollo equipment, but are not managed by the STMS.
STMS network operators must configure fiber connectivity for the NEs that are configured on third-party
equipment.
There are two possible methods to create the fiber connectivity:
• directly from LightSOFT (recommended)
• from LightSOFT using the GUI cut-through and configuring in the STMS
Start - from LightSOFT
1. Select the Optical layer.
2. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.

Ribbon Communications Inc. Proprietary 427

 Apollo Workflows

The two panes display hierarchical tree structures showing the objects, slots and ports.
3. To define the link ports and parameters, in the Select Type field, select a port type from the dropdown
list.
The ports that are not of the selected type are disabled.
4. Select a port from each pane to be defined as the link endpoints.
See Endpoint Selection for Links.
5. In the Label field, optionally change the default label (a concatenation of the port names).
6. To build the server trail automatically (only used in very specific cases), select the Build VC-4 Server
Trail checkbox.
7. Click Apply.
Start - Using GCT to STMS
1. Select the Physical (EMS) topology layer.
2. Access the Topology Layer dropdown list.
3. Select the appropriate topology view from the list.
In this example, select the Physical (EMS) layer.

The appropriate topology view is displayed.

4. Open a GCT window to the STMS.
◦ In the main window map or the tree view, right-click the relevant network element object
representing the first NE endpoint.
◦ Select Open.
The STMS main window opens.
5. From the NE Chassis view, right-click on the port for which fiber connectivity needs to be defined.
In this example we are using Port 7 on the TFA card.
6. Select Create Fiber Connectivity.
7. Select the fiber directionality (Bidirectional) and connectivity type (External).

Ribbon Communications Inc. Proprietary 428

 Apollo Workflows

The Create Fiber Connectivity window opens.

8. Configure fiber connectivity for the connection to the alien transceiver, in the General tab:
◦ For Connectivity type, select External.
◦ For Directionality, select Bidirectional.
◦ For Rate, select OCHP.
◦ For A-->Z Frequency and Z-->A Frequency, select the appropriate value.
In this example we are working with 191.7.
◦ For the A-End, the selected port is highlighted in the tree.
◦ For the Z-End, select Unmanaged.
◦ For the Peer NE, select Unspecified.

Ribbon Communications Inc. Proprietary 429

 Apollo Workflows

9. In the Advanced tab:

◦ For WDM Type, select DWDM.
◦ For Spacing, select the appropriate value.

10. Repeat fiber connectivity configuration for the second NE endpoint.

Ribbon Communications Inc. Proprietary 430

 Apollo Workflows

Tips
◦ Note the slot, card, port, and wavelength settings selected at this stage. You will need
this information when configuring settings at the LightSOFT level.
◦ It is possible to configure the fiber connectivity with minimal attribute definitions only.
However, it is recommended that you define as many attributes as possible, to enable
more accurate ONCP calculations and more efficient power equalization.

Enable Alien Lambda on the Same TFA Port: STMS

This procedure is the fourth step in the configuration of an alien lambda in an Apollo network. See Configure
an Alien Lambda Running Over an Apollo Network.
Start
1. Enable an alien lambda on the TFA ports under STMS and fill in the basic attributes: Alien
Lambda, Center Frequency, Spectral Bandwidth as shown below.

Ribbon Communications Inc. Proprietary 431

 Apollo Workflows

2. Scroll down to the Input Signal Attributes and insert the relevant values.

3. Click Apply.

Provision an OCH Trail: NMS

This procedure is the last step in configuring an alien lambda in an Apollo network. See Configure an Alien
Lambda Running Over an Apollo Network.
In a typical optical network, components are configured into a hierarchy of OMS, OCH, ODU, LP trails, as
illustrated in the following figure.

Hierarchy of Optical Trails

At this point all the necessary underlying infrastructure has been created, and we are ready to create a new
OCH trail to transport the alien lambdas across the Apollo network.
LightSOFT provisions and configures any necessary underlying trails automatically.

Ribbon Communications Inc. Proprietary 432

 Apollo Workflows

Start
1. On the Topology map, drag the mouse to select the network topology structure that you just
configured, including the UMEs, endpoint NEs, and topology links.
2. Select the Trails ribbon.
3. Select Create Trail.
The Create Trail window opens.

4. In the Trail Parameters pane:

◦ Set the trail rate to OCH.
◦ Set protection to Unprotected.
◦ Set directionality to Bidirectional.
5. Select endpoints:
◦ Right-click the first UME and choose Select Endpoint.
◦ Select the port with the correct channel setting as the first trail endpoint.
In this example it is an OTU4 port with 193.0 Tx frequency.
◦ Right-click the second UME and choose Select Endpoint.
◦ Select the transponder port with the correct channel setting as the second trail endpoint.

6. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources (which in this
example we just provisioned) are available along that route, and verifies that the trail can be created
successfully.

7. Click Activate .
The new OCH trail is provisioned and ready for use as needed, and is visible in the trails list pane.

Any cross-connects necessary for the new trail are created automatically.

Ribbon Communications Inc. Proprietary 433

 Apollo Workflows

8. Verify the new OCH trail by opening the Trail List table and locating the newly configured trail
(optional).
9. Select one of the participating LEs.
10. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
11. Check the state of the new trail to verify that it is OK.
12. Select the trail in the trail list to see the trail path highlighted in the topology map.

Tip
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at the
STMS level.

Apollo Workflow: Configure Client-Port Protection

This workflow provides a high-level overview of the stages in creating a new service with client-port
protection.
The network topology in this example includes 2 NEs, each of which has 2 TM200EN cards installed.
Within each NE, the 2 client ports (one on each TM200EN card) are configured as a protection group, with
one port providing protection for the other (main) port.

Tip
Some of the procedures required at initial network configuration are not always necessary during
ongoing standard network operation.
In addition, some steps may be needed only under certain circumstances, such as for specific
types of cards or configuration contexts.

In this example, a service with client-port protection runs between two NE endpoints.
Each NE has 2 TM200EN cards installed.
Within each NE, the 2 client ports (one on each TM200EN card) are configured as a protection group, with
one client port providing protection for the other (main) client port. Two distinct paths run between the line
ports on the TM200EN cards.

Ribbon Communications Inc. Proprietary 434

 Apollo Workflows

In this example, the NE at one end links to a CPE through two separate cards, one splitter and one coupler.
• The CPE, splitter, and coupler cards at this end are all UMEs.
• The NE at the second end links to a UME CPE through a single splitter/coupler card installed on the
second NE.

Configure client-port protection

Configure Client-Port Protection (Initial Configuration)

Start
1. Discover the participating Network Elements (NEs).
2. Configure cards on the Network Element (NE) at one service endpoint.
3. Configure ports on TM200EN cards on the first NE.
4. Configure protection group for 2 client ports on the first NE.
5. Repeat the card, port, and protection group configuration on the second endpoint NE.
6. Create the Logical Elements (LEs).
7. Create topology links between the line ports on the two NEs.
8. Create UME equipment for one end of the service.
9. Create topology links between the client ports and UMEs at one end of the service.
10. Create UME equipment for the second end of the service.
11. Create topology links between the client ports and UME at the second end of the service.
12. Provision OCH trails between the line ports.
13. Provision ODU trails between the line ports [AoC and combiner cards only].
14. Provision an LP trail for the new service.

Ribbon Communications Inc. Proprietary 435

 Apollo Workflows

Configure Client-Port Protection (Standard Operation)

Start
1. Select the physical (EMS) topology layer.
2. Configure new client ports on TM200EN cards on the first NE.
3. Configure protection group for 2 client ports on the first NE.

Ribbon Communications Inc. Proprietary 436

 Apollo Workflows

4. Repeat the new client port and protection group configuration on the second endpoint NE.
5. Return to the optical topology layer.
6. Create the Logical Elements (LEs).
7. Create topology links between the line ports on the two NEs.
8. Create UME equipment for one end of the service.
9. Create topology links between the client ports and UMEs at one end of the service.
10. Create UME equipment for the second end of the service.
11. Create topology links between the client ports and UME at the second end of the service.
12. Provision OCH trails between the line ports.
13. Provision an LP trail for the new service.

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Ribbon Communications Inc. Proprietary 437

 Apollo Workflows

Discover the Participating Network Elements: EMS

This procedure is the first step in configuring client-port protection during initial network configuration (see
Configure client-port protection).
Trails and services run between NEs. If they are not yet visible on the network map, you must drill down to
the EMS level and discover the NEs over which they will run.
Start
1. Access the Topology Layer dropdown list.
2. Select the appropriate topology view from the list. In this example, select the Physical (EMS) layer.
The appropriate topology view is displayed.

3. In the network map, select the EMS for which you want to create an ME.

4. In the main window Topology tab, in the Create group, click ME .

The Create NE window for the selected EMS opens.
5. If the participating NE is not yet included in the EMS level, discover the new NE.
You can discover NEs using the STMS discovery utility.
This utility (also referred to as the discover command) enables you to discover NEs and create STMS
groups (or subdomains).
This enables you to discover several NEs at a time:
◦ Log in to the system in which the STMS server has been installed.
◦ Open a shell prompt.
◦ Change the working directory to the directory in which you installed the STMS software.
◦ At the prompt, type:
./bin/discover option argument
where:
• option is a valid command option (or set of options).
• argument is a valid argument (or arguments) associated with the command option.
◦ Click ENTER.
6. At the CLI prompt, type the following command:
set network-element opt96xx ne-id <ne ID number>
7. Repeat the preceding steps, discovering all NEs that are needed for the service that do not yet exist in
the network topology.

Configure Cards on the Network Element at One Service

Endpoint: EMS
This procedure is the second step in configuring client-port protection during initial network configuration.
See Configure client-port protection.
In this example, the first NE is configured with 2 TM200EN cards.
One client port and one line port will be configured on each card.

Ribbon Communications Inc. Proprietary 438

 Apollo Workflows

Configure cards on the network element at one service endpoint

Start
1. Open a GCT window to the STMS at the EMS level.
2. In the Main window map or the tree view, right-click the relevant object.
3. Select Open.
The EMS main window opens.
4. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.
5. Select the slot for the card.
The supported card types appear in the right pane.
6. Select the card type and click Finish.
The card is assigned.
7. Verify new slot assignments in the STMS main window portrayal of the platform slot layout (optional).

Tip
Make a note of the slot number. You will need it later in the procedure for subsequent steps at
the LightSOFT level.

Ribbon Communications Inc. Proprietary 439

 Apollo Workflows

Limitations
◦ The two NE endpoints must be configured with four cards of the same type, two in each
NE. (In our example we are using four TM200EN cards.)
◦ When working with OPT9600 platforms, the two cards in each NE must sit in adjacent
slots, with the longer card edges side-by-side. This enables faster switchover to
protection via the backplane.
◦ In OPT9624 platforms, client-port protection can be configured in the following slot pairs:
• (0,2)
• (4,6)
• (8,10)

Configure Ports on TM200EN Cards on the First NE: EMS

This procedure is the third step in configuring client-port protection during initial network configuration.
This is the first step during the standard operation (see Configure Client-Port Protection).
At this point you configure one line port and one client port on each of the two TM200EN cards installed on
the first NE.
Any available port on the TM200EN card can be used for any of the participating port roles, client or line.
The two client ports (one on each card) are configured as a protection group, with one port as the main client
port and the other port as the protection client port.

Ribbon Communications Inc. Proprietary 440

 Apollo Workflows

Configure ports on TM200EN cards on the first NE

Note
The two client ports on the two TM200EN cards must be configured identically, using the same port
number, and choosing the same type, transceiver, and wavelengths, as relevant.

Start
1. Open a GCT window to the STMS at the EMS level.
2. In the Main window map or the tree view, right-click the relevant object.
3. Select Open.
The EMS main window opens.
4. In the Chassis view, right-click one TM200EN card and select Configure Port.
The Port Configuration window opens.
5. In the Select column, select the checkboxes of the ports you want to define.
6. To configure the client port:
◦ Select a port number.

Ribbon Communications Inc. Proprietary 441

 Apollo Workflows

◦ Set the port type, transceiver, wavelength, as appropriate.

◦ The other default attribute values can be maintained.
7. To configure the line port:
◦ Select a port number.
◦ Set the port type, transceiver, wavelength, as appropriate.
◦ The other default attribute values can be maintained.
8. In the Chassis view, right-click the second TM200EN card and select Configure Port.
9. In the Select column, select the checkboxes of the ports you want to define.
10. Configure the client port.
Note: Client port configuration on the second card must be identical to the client port configuration on
the first card (port number, port type, transceiver, wavelength).
11. Configure the line port:
◦ Select a port number.
◦ Set the port type, transceiver, wavelength, as appropriate.
◦ The other default attribute values can be maintained.

Tip
• Make a note of the port configuration details (port number, type, rate, transceiver,
wavelength).
You will need this later in the procedure for subsequent steps at the LightSOFT level.
• In this example, we selected client port U0/0, assigning type ETY10G with transceiver
OTP10_SR, and line port U0/9, assigning type OTU4 with transceiver OTR100P2_CF and
wavelength 34.0.

Configure Protection Group for 2 Client Ports on the First NE:

EMS
This procedure is the fourth step in configuring client-port protection during initial network configuration.
This is the second step during standard operation (see Configure Client-Port Protection).
You now configure a protection group that associates the 2 client ports on the adjacent cards.
Through this protection group, one client port is defined as the main port and the other client port is defined
as the protection port, providing an alternate path in case of failure in the main client port.
Start
1. Right-click the client port in the first TM200EN card and select Show/Configure Protection.
The Protection Group Properties window opens, displaying the two associated ports.
2. Set the protection group properties as appropriate for your network configuration.
3. Select the main unit.
The other port provides protection.
4. Revertive mode:
◦ Select Yes to automatically revert back to the main path when the failure is corrected.
◦ Select No to continue use of protection path until an operator manually restores traffic to the main
path.
5. Wait to Restore (WTR):
◦ If revertive mode is set to Yes, then set the amount of time to wait before restoration.
Default value is 5 minutes.
6. Hold Off Timer:
◦ Set the number of seconds to wait before switching to protection after an error is detected.
Default value is 0 seconds.
For example, if your network has configured multiple protection mechanisms, it might be more
efficient to wait before switching to protection here in case the error is resolved through another
mechanism.

Ribbon Communications Inc. Proprietary 442

 Apollo Workflows

7. Keep the other default settings.

8. Click Apply.
The protection group is created.

Repeat Card Port and Protection Group Configuration on the

Second Endpoint NE: EMS
This procedure is the fifth step in configuring client-port protection during initial network configuration.
This is the third step during standard operation (see Configure Client-Port Protection).
In this example, the second NE is configured with 2 TM200EN cards, providing two client ports that are
configured as a protection group, similar to the configuration of the first NE.
The second NE also includes a single splitter/coupler card, used to link to the CPE at this end.
At this point we simply repeat the preceding card and port configuration steps for the cards installed on the
second NE endpoint.

Repeat card port and protection group configuration

Ribbon Communications Inc. Proprietary 443

 Apollo Workflows

Notes
• The two NE endpoints must be configured with four cards of the same type, two in each NE.
In our example we are using four TM200EN cards.
• When working with OPT9600 platforms, the two cards in each NE must sit in adjacent slots,
with the longer card edges side-by-side. This enables faster switchover to protection via the
backplane.
• In OPT9624 platforms, client-port protection can be configured in the following slot pairs:
◦ (0,2)
◦ (4,6)
◦ (8,10)
• The two client ports on the two cards within an NE must be configured identically, using the
same port number, and choosing the same type, transceiver, wavelength, as relevant.
• The client port configuration can differ between NEs, (for example, different transceivers),
depending on the network requirements.
• The line port configuration can differ between NEs and within the same NE, (for example,
colored or not), depending on the network requirements.

Start
1. If this is an initial network configuration and the second set of cards has not yet been assigned, assign
2 TM200EN cards to slots in the second NE.
2. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.
3. Select the slot for the card.
The supported card types appear in the right pane.
4. Select the card type and click Finish.
The card is assigned.
5. Verify new slot assignments in the STMS main window portrayal of the platform slot layout (optional).
6. In the Chassis view, right-click one TM200EN card and select Configure Port.
The Port Configuration window opens.
7. In the Select column, select the checkboxes of the ports you want to define.
8. Configure the client port:
◦ Select a port number.
◦ Set the port type, transceiver, wavelength, as appropriate.
The other default attribute values can be maintained.
9. Configure the line port:
◦ Select a port number.
◦ Set the port type, transceiver, wavelength, as appropriate.
The other default attribute values can be maintained.
10. In the Chassis view, right-click the second TM200EN card and select Configure Port.
The Port Configuration window opens.
11. In the Select column, select the checkboxes of the ports you want to define.
12. Configure the client port:
◦ Select a port number.
◦ Set the port type, transceiver, wavelength, as appropriate.
The other default attribute values can be maintained.
13. Configure the line port:
◦ Select a port number.
◦ Set the port type, transceiver, wavelength, as appropriate.
The other default attribute values can be maintained.
Note: Client port configuration on the second card must be identical to the client port configuration on
the first card (port number, port type, transceiver, wavelength).
14. Right-click the client port in the first TM200EN card and select Show/Configure Protection.
The Protection Group Properties window opens, displaying the two associated ports.

Ribbon Communications Inc. Proprietary 444

 Apollo Workflows

15. Set the protection group properties as appropriate for your network configuration.
16. Select the main unit. The other port provides protection.
17. Revertive mode:
◦ Select Yes to automatically revert back to the main path when the failure is corrected.
◦ Select No to continue use of protection path until an operator manually restores traffic to the main
path.
18. Wait to Restore (WTR):
◦ If revertive mode is set to Yes, then set the amount of time to wait before restoration.
Default value is 5 minutes.
19. Hold Off Timer:
◦ Set the number of seconds to wait before switching to protection after an error is detected.
Default value is 0 seconds.
For example, if your network has configured multiple protection mechanisms, it might be more
efficient to wait before switching to protection here in case the error is resolved through another
mechanism.
20. Keep the other default settings.
21. Click Apply.
The protection group is created.
22. Assign an appropriate splitter-coupler card to an available slot in the second NE.
The splitter/coupler card must be appropriate for the client ports that we have just configured on this
NE.

Tip
◦ Make a note of the slot numbers and port configuration details (port number, type, rate,
transceiver, wavelength). You will need this information later in the procedure for
subsequent steps at the LightSOFT level.
◦ In this example, we selected client port U0/0, assigning type ETY10G with transceiver
OTP10_SR, and line port U0/9, assigning type OTU4 with transceiver OTR100P2_CF
and wavelength 34.0.

Create Logical Elements: NMS

This procedure is the sixth step in configuring client-port protection during initial network configuration.
This is the fourth step during standard operation (see Configure Client-Port Protection).
The cards configured in the NEs at the STMS EMS level must be added to the topology map at the
LightSOFT NMS level.
The physical cards are represented by logical elements (LEs) on the LightSOFT map.
An LE must be created for each card installed, at each endpoint NE.
Start
1. If you are currently working in STMS, return to the LightSOFT level.
2. In the Topology Layer dropdown list, select the technology layer in which you want to create the LEs.
3. In the map, right-click the first endpoint NE on the topology map and select Create LE.
The Create Logical Element window opens.
You are now going to create an LE for each of the cards you just configured in that NE.
4. In the LE Name field, enter a name for the LE.
5. Clear the Auto Create LE checkbox so that you can explicitly create each separate LE and assign
each one a meaningful name.
Recommended names identify the NE source, slot, and card type, together with the appropriate map
icon.
Alternatively, you can keep the Auto Create Optical LE option checked, to automatically assign each

Ribbon Communications Inc. Proprietary 445

 Apollo Workflows

LE a meaningful name that identifies the NE source, slot, and card type.
The port selection area of the window becomes active.
6. In the LE Type dropdown list, select the type of LE you want to create (options vary according to the
LE's technology).
The icon for that LE type is displayed next to the dropdown list.
7. Click the arrow adjacent to the LE icon and select the directionality you require.
8. If the primary LE is part of a group, to add the secondary LE to the same group, check the Add to LE
group checkbox.
9. In the Primary LE area, select the cards, slots, or ports that the secondary LE represents, and click
Add .
The selected elements are moved to the Secondary LE area.
10. Click Apply.
The LE is created and the cursor displays a representative LE icon ( ).
11. Move the cursor to the required location on the map, and click once to drop the LE in place.
12. Right-click the second endpoint NE on the topology map and create a second set of LEs.
In this example, the second NE configuration includes two TM200EN cards and a splitter/coupler card.
You must therefore create 3 LEs for this NE, one for each of these cards.

Tip
Refer to your notes from the previous steps to verify the slot number and channel frequency
of the card that you just configured. They should match the values listed for that slot, card, and
port in the Available Automatic Split Selection table.

Create Topology Links Between the Line Ports on the Two NEs:
NMS
This procedure is the seventh step in configuring client-port protection during initial network configuration.
This is the fifth step during the standard operation (see Configure Client-Port Protection).
Client-port protection between two NEs includes two distinct paths running between the two line ports
(configured on the two TM200EN cards) on each NE.
In this example, these are simple paths running directly between each set of line ports. This is only a simple
example - in a real network configuration each path could be direct or more complex, traversing additional
optical equipment, as appropriate.
The following procedure creates a fiber connectivity topology link between the line port on the first TM200EN
card on the first NE and the line port on the first TM200EN card on the second NE.
Start
1. On the topology map, select the LE object for the first TM200EN card in the first NE.
2. Hold the <Shift> key, and select the LE object for the first TM200EN card in the second NE.
3. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
For an internal link, the two panes show details of the same object.
4. Select the appropriate ports on the LE as the link endpoints.
5. Click Apply to create the new topology link.
The new link is highlighted in pink on the topology map view.
6. Repeat the above procedure to create a second fiber connectivity topology link between the line port
on the second TM200EN card on the first NE and the line port on the second TM200EN card on the
second NE.
7. Verify the links by opening the Link List table and locating the newly configured links.
8. In the main window, select the relevant objects.

Ribbon Communications Inc. Proprietary 446

 Apollo Workflows

9. In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).

Tip
It might be easier to locate the link if you filter the table and/or focus on the Frequency column.
You can also look at the end of the table - new links are usually added at the bottom of the
table list.

Create UME Equipment for One End of the Service: NMS

This procedure is the eighth step in configuring client-port protection during initial network configuration.
This is the sixth step during the standard operation (see Configure Client-Port Protection).
In this workflow example, the NE at one end links to a CPE through two separate cards, a splitter and a
coupler.
The NE at the second end links to a CPE through a single splitter/coupler card. In this example, the
equipment at the first end, including the CPE, the splitter, and the coupler, are all UMEs.

Create UME equipment for one end of the service

Start
1. In the main window Topology tab, in the Create group, click UME.
The Create UME window opens.
2. Select the appropriate UME type (Splitter), assign a meaningful name to the UME, and configure as
needed.
3. Click Apply.

A Create UME position holder icon appears at the cursor position.

4. Drag the new UME icon to the required location in the map, and click to place it at that location.
5. Repeat this procedure to create a UME for the corresponding Coupler to be used by the first NE.
6. Repeat this procedure to create a UME for the Terminal OTN CPE to be used as the service endpoint
accessed through the first NE.

Ribbon Communications Inc. Proprietary 447

 Apollo Workflows

7. Set the port configuration value appropriately.

In this example we selected 10GbE to correspond to the port rates selected in the other service
equipment.

Create Topology Links Between the Client Ports and UMEs at

One End of the Service: NMS
This procedure is the ninth step in configuring client-port protection during initial network configuration.
This is the seventh step during the standard operation (see Configure Client-Port Protection).
In this workflow example, the NE at one end links to a CPE through two LEs, one splitter and one coupler.
This section describes creating the topology links between the CPE, the splitter and coupler components,
and the client ports on the two TM200EN cards on the first NE.
The client ports on the LEs will be transmitting traffic to the CPE through links to the sink ports on the
coupler.
Traffic from the CPE will be transmitted to the client ports on the LEs through the source ports on the splitter.
The two client ports on the NE form a protection group, where one port is the main and the other one is the
protection port.

Two client ports on the NE form a protection group

Start
1. On the topology map, select the Splitter UME object defined for one end of the service.
2. Hold the <Shift> key, and select the LE object for the first TM200EN card in the first NE.
3. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
For an internal link, the two panes show details of the same object.
4. Select the appropriate ports as the link endpoints.

Ribbon Communications Inc. Proprietary 448

 Apollo Workflows

5. Click Apply to create the new topology link.

6. Create a second topology link, running between the other source port on the splitter UME and the
client port on the second TM200EN card on the first NE.
7. Create a third topology link, running between a sink port on the coupler UME and the client port on the
first TM200EN card on the first NE.
8. Create a fourth topology link, running between the other sink port on the coupler UME and the client
port on the second TM200EN card on the first NE.
9. Create a fifth topology link, running between the CPE UME and the sink port on the splitter UME.
10. Create a sixth topology link, running between the source port on the coupler UME and the CPE UME.
11. Verify the links by opening the Link List table and locating the newly configured links (optional).
12. In the main window, select the relevant objects.
13. In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).

Tip
It might be easier to locate the link if you filter the table and/or focus on the Frequency column.
You can also look at the end of the table - new links are usually added at the bottom of the
table list.

Create UME Equipment for the Second End of the Service: NMS
This procedure is the tenth step in configuring client-port protection during initial network configuration.
This is the eighth step during the standard operation (see Configure Client-Port Protection).
In this workflow example, the NE at the second end links to a CPE through a single splitter/coupler LE.
The NE at the first end links to a CPE through two separate LEs, one splitter and one coupler.
In this example, the CPE at the second end is a UME.
The steps described here would also be appropriate for a CPE located on an Artemis unit.

Ribbon Communications Inc. Proprietary 449

 Apollo Workflows

Create UME equipment for the second end of the service

Start
1. Set the port configuration value appropriately.
In this example we selected 10GbE to correspond to the port rates selected in the other service
equipment.
2. In the main window Topology tab, in the Create group, click UME.
The Create UME window opens.
3. Select the appropriate UME type (Terminal OTN), assign a meaningful name to the UME, and
configure as needed.
4. Click Apply.

A Create UME position holder icon appears at the cursor position.

5. Drag the new UME icon to the required location in the map, and click to place it at that location.

Create Topology Links Between the Client Ports and UME at the
Second End of the Service: NMS
This procedure is the eleventh step in configuring client-port protection during initial network configuration.
This is the ninth step during the standard operation (see Configure Client-Port Protection).
In this workflow example, the NE at the second end links to a UME CPE through a single splitter/coupler LE.
This section describes creating the topology links between the CPE, the splitter/coupler component, and the
client ports on the two TM200EN cards on the second NE.

Ribbon Communications Inc. Proprietary 450

 Apollo Workflows

Create topology links between the client ports and UME at the second NE

Start
1. On the topology map, select the LE object for the first TM200EN card in the second NE.
2. Hold the <Shift> key, and select the LE object for the Splitter/Coupler card in the second NE.
3. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
For an internal link, the two panes show details of the same object.
4. Select the appropriate ports as the link endpoints (client port on the TM200EN card, service port on
the splitter/coupler card).
5. Click Apply to create the new topology link.
6. Create a second topology link, running between the client port on the second TM200EN card on the
second NE, and a service port on the splitter/coupler card.
7. Create a third topology link, running between the CPE UME and the user port (9) on the splitter/
coupler card.
8. Verify the links by opening the Link List table and locating the newly configured links (optional).
9. In the main window, select the relevant objects.
10. In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).

Tip
It might be easier to locate the link if you filter the table and/or focus on the Frequency column.
You can also look at the end of the table - new links are usually added at the bottom of the
table list.

At this point you have completed the topology/link configuration section of this workflow.

Ribbon Communications Inc. Proprietary 451

 Apollo Workflows

Provision OCH Trails Between the Line Ports: NMS

This procedure is the twelfth step in configuring client-port protection during initial network configuration.
This is the tenth step during the standard operation (see Configure Client-Port Protection).
In this example:
• Client-port protection is for a new service, to be provisioned on a LightPath (LP) trail running over an
OCH trail. The underlying OCH trails must therefore be provisioned.
• The underlying OCH trail runs directly between the TM200EN card line ports, with no other network
objects in between, simplifying OCH trail creation.
• There is no need for an underlying OMS trail, since there is no multi-channel element involved.
The following procedure provisions an OCH trail between the line port on the first TM200EN card in the first
NE, and the line port on the first TM200EN card in the second NE.
Start
1. Select the Optical topology layer.
2. In the main window select the 2 LEs that will serve as the endpoints of the new OCH trail (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. In the Basic Trail Parameters pane, set the following parameters:
◦ Set the trail rate to OCH.
◦ Choose the Unprotected option.
◦ Choose the Bidirectional option.
◦ Edit Label and Customer names (optional).
In this example, the default values can be maintained for the other fields.
If necessary, you can edit as relevant for your network configuration.
6. Select the relevant endpoints on the two NEs.
In this example we select the relevant line ports on the selected TM200EN cards.

7. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.
8. Click Activate .
The new OCH trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
9. Repeat this procedure to provision a second OCH trail between the line port on the second
TM200EN card in the first NE, and the line port on the second TM200EN card in the second NE.

Ribbon Communications Inc. Proprietary 452

 Apollo Workflows

10. Verify the new OCH trails by opening the Trail List table and locating the newly configured trails
(optional).
11. Select one of the participating LEs.
12. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
13. Check the state of the new trails to verify that they are all OK.
14. Select one or more trails in the trail list to see the trail path(s) highlighted in the topology map.

Tips
◦ At this point all trails appear in the 'Main' trail color (default pink) since we have not yet
defined either one as a 'Protection' trail.
◦ To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured
at the STMS level.

Provision ODU Trails Between the Line Ports - AoC and

Combiner Cards Only: NMS
This procedure is the thirteenth step in configuring client-port protection during initial network configuration
(see Configure Client-Port Protection).
When configuring client-port protection using AoC or combiner cards, you must also provision ODU trails
between the line ports.
The underlying ODU trails configured in this step run directly between the same sets of card ports as the
OCH trails configured in the previous step.

Note
Provisioning underlying ODU trails is not necessary when using transponder cards, or when using any
multi-purpose card that is currently configured as a transponder.
In this example, the TM200EN cards are configured as muxponders, and therefore require this step as
well.

Start
1. Select the Optical topology layer.
2. Select the 2 LEs that will serve as the endpoints of the new ODU trail, and click Create Trail.
3. In the main window select the objects containing the relevant objects (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
4. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
5. Select the Trail Parameters tab.
6. Set the trail rate to ODU.
7. Choose the Unprotected option.
8. Choose the Bidirectional option.
9. Configure Capacity based on the underlying line port configuration at the STMS level. In this
example, ODU4.
10. Right-click an LE in the map and choose Select Endpoint.
The Endpoint Selection window opens.
The ports that are free and conform to the selected trail rate and capacity are available for selection.
11. Select the relevant endpoints on the two NEs, i.e. the relevant line ports on the selected cards.

Ribbon Communications Inc. Proprietary 453

 Apollo Workflows

12. Click Complete .

Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.
13. Click Activate .
The new ODU trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
14. Repeat the above steps with the second set of LEs.
15. Verify the new ODU trails by opening the Trail List table and locating the newly configured trails
(optional).
16. Select one of the participating LEs.
17. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
18. Check the state of the new trails to verify that they are all OK.
19. Select one or more trails in the trail list to see the trail path[s] highlighted in the topology map.

Tips
◦ At this point all trails appear in the 'Main' trail color (default pink) since we have not yet
defined either one as a 'Protection' trail.
◦ To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured
at the STMS level.

Provision an LP Trail for New Service: NMS

This procedure is the fourteenth (and final) step in configuring client-port protection during initial network
configuration.
This is the eleventh (and final) step during the standard operation (see Configure Client-Port Protection).
At this point you are ready to create a new LP service.
The service will be provisioned with client-port protection, through redundant client-port configuration on the
two TM200EN cards at each end of the service.
Start
1. On the Topology map, drag the mouse to select the network topology structure that you have just
configured, nodes and links.
2. Select the Trails ribbon.
3. Select Create Trail.
The Create Trail window opens.
4. In the Trail Parameters pane set the trail rate to LP.
5. Choose Bidirectional.
6. Choose the Current & Underlying protection option.
7. In the Advanced Protection section, clear all checkboxes.
8. Select the appropriate Capacity option.
9. Choose ODU-Structured and select the appropriate rate from the drop-down field, to match the rate
configured for the client ports.
In this example, the rate would be 10GBE.
10. Select the two UME CPEs as the new trail endpoints.

11. Click Complete .

Pathfinder identifies the appropriate main and protection paths, utilizing the network resources that
you have already provisioned in previous steps.

Ribbon Communications Inc. Proprietary 454

 Apollo Workflows

In this example Pathfinder chooses a path through the OMS and OCH trails running between the line
ports on the TR10_12 cards in each NE.
12. Click Activate .
The new LP trail is provisioned and ready for use as needed.
In this example, because we have configured protection, the LP trail includes two path options.
One path is defined as the main (pink), and the second one is the protection (light blue) path.

13. Verify the new LP trail by opening the Trail List table and locating the newly configured trail (optional).
14. Select one of the participating LEs.
15. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
16. Check the state of the new trail to verify that it is OK.
17. Select the trail in the trail list to see the trail path highlighted in the topology map.

Note
For further assistance, contact your local Customer Support representative.

Apollo Workflow: Configure ERP Ring 8032 Protection

This workflow provides a high level overview of the stages in adding ERP ring (8032) protection.
ERP PB ring service is normally used to prevent loops in PB network access rings.
When working with ERP, LightSOFT configures participating nodes according to the following guidelines:
• One link in the ring is designated as the RPL. As long as there are no failures in the ring, the RPL is
maintained in a closed state. This ensures a loop-free topology.
• A node adjacent to the RPL - the RPL Owner - is responsible for blocking and unblocking the RPL in
case of failure (and subsequent recovery) in the network.
• ERP endpoints must use comparable equipment.
For a general introduction to and explanation of ERP ring protection, see Configure ERP protection.
The workflow includes provisioning the underlying infrastructure and relevant service. An underlying topology
infrastructure must be created at the STMS level.
For this workflow example, we are working with three NEs (NE1, NE2, NE3), each one with an AoC10_L2
card configured with one client port (0) and two line ports (18, 19).
Start
1. Assign client and line ports on AoC10_L2 card.
2. Create LEs for the AoC10_L2 cards.
3. Add topology links and OCH trails between AoC10_L2 line ports.
4. Create OTN LP between AoC10_L2 line ports.
5. Create ERP service between AoC10_L2 cards.
6. Create MP2MP service between client ports.
7. Verify RPL port [optional].

Ribbon Communications Inc. Proprietary 455

 Apollo Workflows

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Assign Client and Line Ports on AoC10_L2 Cards: EMS

This procedure is the first step in configuring ERP ring protection (see Configure ERP ring protection).
This workflow describes a specific example of an AoC10_L2 card and port configuration in three NEs at the
STMS level.
For more information, see Assign cards and Configure ports in the STMS User Guide.
Start
1. In the main window, select the Optical topology layer.
2. Access the Topology Layer dropdown list.
3. Select the appropriate topology view from the list. In this example, select the Optical layer.
The appropriate topology view is displayed.
4. In the network map, open a GCT window to STMS at the EMS level.
5. In the Main window map or the tree view, right-click the relevant NE object.
In this workflow example we are configuring three NEs named NE1, NE2, NE3.
6. Select Open.
The EMS main window opens.
7. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.

Ribbon Communications Inc. Proprietary 456

 Apollo Workflows

8. Select the slot for the AoC10_L2 card.

For this workflow example, select slot U7.
The supported card types appear in the right pane.
9. Select the AoC10_L2 card type and click Finish.
The card is assigned.
10. Verify new slot assignments in the STMS main window portrayal of the platform slot layout (optional).
11. From the Chassis view, right-click the AoC10_L2 card and select Configure Port.
The Port Configuration window opens.
• Client port 0, with port type GE and port mode UNI
• Line ports 18 and 19, with port type GE10-OTU2e and port mode I-NNI.
• In the Select column, select the checkboxes of the client and line ports you want to define.
For this workflow example, assign:
The Configured Transceiver column lists the transceiver options relevant for this port configuration
1. Select the appropriate option.
2. The Actual Transceiver Type column shows the actual transceiver installed.
For newly assigned ports, you can copy the actual transceivers to the configured transceivers by
selecting the relevant ports and clicking Copy Actual Transceiver to Configured.
3. Select the relevant wavelength in the Tx Wavelength column. You can either select the value from the
dropdown list or click select and select it in the Wavelength Selection window.
4. Repeat these steps for the AoC10_L2 cards in each participating NE. In this workflow example we
are using three NEs (NE1, NE2, NE3).

Tip
Make a note of the NE name and slot, port, and wavelength/channel numbers. You will need
this information later in the procedure for subsequent steps at the LightSOFT level.

Create LEs for the AoC10_L2 Cards: NMS

This procedure is the second step in configuring ERP ring protection (see Configure ERP ring protection).
The cards configured in the NEs at the STMS EMS level must be added to the topology map at the
LightSOFT NMS level.
The physical cards are represented by logical elements (LEs) on the LightSOFT map.
An LE must be created for each card installed, in each endpoint NE.
Start
1. In the Topology Layer dropdown list, select the technology layer in which you want to create the LEs.
2. In the map, right-click the NE on the topology map that has the new AoC10_L2 card, and select
Create LE.
The Create Logical Element window opens.
You are now going to create an LE for the AoC10_L2 card you just configured in that NE.
3. In the LE Name field, enter a name for the LE.
In this workflow example we use NE1, NE2, NE3.
4. Keep the Auto Create LE checkbox checked, to automatically assign each LE a meaningful name
that identifies the NE source, slot, and card type.
5. Select the Add to LE Group checkbox, and click Apply.
6. LightSOFT calculates the secondary LEs that can be created and lists them in the Available
Automatic Split Selection table window.
7. Click OK.
The selected LEs are created and the cursor displays a representative icon ( ).
8. Move the cursor to the required location in the map and click once to drop the LE in place.
The new LEs are distributed between the cursor position and the master LE and a message opens.

Ribbon Communications Inc. Proprietary 457

 Apollo Workflows

9. Click OK.
10. Repeat these steps for the AoC10_L2 cards in each participating NE.
In this workflow example we are using three NEs (NE1, NE2, NE3).

Tip
Refer to your notes from the previous steps to verify the slot number and channel frequency
of the card that you just configured. They should match the values listed for that slot, card, and
port in the Available Automatic Split Selection table.

Add Topology Links and OCH Trails Between AoC10_L2 Line

Ports: NMS
This procedure is the third step in configuring ERP ring protection (see Configure ERP ring protection).
A link represents a fiber connection between two ports. The underlying topology links and OCH trails have to
be configured.
In this workflow example we are creating a 'ring' topology running between the line ports on the AoC10_L2
cards in the three participating NEs (NE1, NE2, NE3).
In this step we are creating three topology links and three OCH trails:
• Between Port 18 on the AoC10_L2 card in NE1 and Port 19 on the AoC10_L2 card in NE2
• Between Port 18 on the AoC10_L2 card in NE2 and Port 19 on the AoC10_L2 card in NE3
• Between Port 18 on the AoC10_L2 card in NE3 and Port 19 on the AoC10_L2 card in NE1
Start
1. Select the Optical topology layer.
2. Create a fiber connectivity topology link between line port 18 on the AoC10_L2 card in NE1 and line
port 19 on the AoC10_L2 card in NE2.
3. On the topology map, select the LE object for the AoC10_L2 card in the first NE.
4. Hold the <Shift> key, and select the LE object for the AoC10_L2 card in the second NE.
5. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
6. Select the appropriate ports (port 18 on NE1, port 19 on NE2) as the link endpoints.
7. Click Apply to create the new topology link.
The new link is highlighted in pink on the topology map view.
8. Repeat this procedure [in step 2] to create a second topology link between line port 18 on the
AoC10_L2 card in NE2 and line port 19 on the AoC10_L2 card in NE3.
9. Repeat this procedure [in step 2] to create a third topology link between line port 18 on the
AoC10_L2 card in NE3 and line port 19 on the AoC10_L2 card in NE1.
10. Verify the links by opening the Link List table and locating the newly configured links (optional):
◦ In the main window, select the relevant objects.
◦ In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).

Tip
It might be easier to locate the link if you filter the table and/or focus on the Frequency
column. You can also look at the end of the table - new links are usually added at the
bottom of the table list.

11. Create an OCH trail between line port 18 on the AoC10_L2 card in NE1 and line port 19 on the
AoC10_L2 card in NE2.
12. In the main window select the LEs that will serve as the endpoints of the new OCH trail (optional).

Ribbon Communications Inc. Proprietary 458

 Apollo Workflows

13. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
14. Select the Trail Parameters tab.
15. In the Basic Trail Parameters pane, set the following parameters.
◦ Set the trail rate to OCH.
◦ Choose the Unprotected option.
◦ Choose the Bidirectional option.
◦ Edit Label and Customer names (optional).
In this example, the default values can be maintained for the other fields.
If necessary, you can edit as relevant for your network configuration.
16. Select the relevant endpoints on the two NEs.
In this example we select the relevant line ports on the selected AoC10_L2 cards.

17. Click Complete .

18. Click Activate .
19. Repeat this procedure [in step 6] to create a second OCH trail between line port 18 on the AoC10_L2
card in NE2 and line port 19 on the AoC10_L2 card in NE3.
20. Repeat this procedure [in step 6] to create a third OCH trail between line port 18 on the AoC10_L2
card in NE3 and line port 19 on the AoC10_L2 card in NE1.
21. Verify the new OCH trails by opening the Trail List table and locating the newly configured trails
(optional):
◦ Select one of the participating LEs.
◦ Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
◦ Check the state of the new trails to verify that they are all OK.
◦ Select one or more trails in the trail list to see the trail path(s) highlighted in the topology map.

Tips
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at
the STMS level.

Create OTN LP Between AoC10_L2 Line Ports: NMS

This procedure is the fourth step in configuring ERP ring protection (see Configure ERP ring protection).
At this point you are ready to provision a new OTN LP service, running between the AoC10_L2 line ports on
the three participating NEs.
LP trails are end-to-end optical trails representing the client input signal, typically traversing between client
equipment endpoints.
In this workflow example we are creating a 'ring' topology running between the line ports on the AoC10_L2
cards in the three participating NEs (NE1, NE2, NE3).
In this step we are creating three OTN LPs:
• Between Port 18 on the AoC10_L2 card in NE1 and Port 19 on the AoC10_L2 card in NE2
• Between Port 18 on the AoC10_L2 card in NE2 and Port 19 on the AoC10_L2 card in NE3
• Between Port 18 on the AoC10_L2 card in NE3 and Port 19 on the AoC10_L2 card in NE1
Start
1. On the Topology map, drag the mouse to select the network topology structure that you have just
configured for the three participating NEs.
2. In the Trails ribbon, select Create Trail.
The Create Trail window opens.

Ribbon Communications Inc. Proprietary 459

 Apollo Workflows

3. In the Trail Parameters pane, set the trail rate to LP.

4. Choose Bidirectional.
5. Choose the Unprotected protection option.
6. Disable RSTP.
7. Enable View on Ethernet Layer.
8. Select two line ports on two AoC10_L2 LEs as the new trail endpoints.

9. Click Complete .
10. Click Activate .
11. Repeat this procedure [in step 4] to create a second OTN LP trail between line port 18 on the
AoC10_L2 card in NE2 and line port 19 on the AoC10_L2 card in NE3.
12. Repeat this procedure [in step 4] to create a third OTN LP trail between line port 18 on the
AoC10_L2 card in NE3 and line port 19 on the AoC10_L2 card in NE1.
13. Verify the new LP trail by opening the Trail List table and locating the newly configured trail (optional):
◦ Select one of the participating LEs.
◦ Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
◦ Check the state of the new trail to verify that it is OK.
◦ Select the trail in the trail list to see the trail path highlighted in the topology map.

Create ERP Service Between AoC10_L2 Cards: NMS

This procedure is the fifth step in configuring ERP ring protection (see Configure ERP ring protection).
At this point you are ready to create ERP service between the AoC10_L2 cards. ERP PB service is created
for PB rings consisting of EoS or ETY I-NNI links. In this workflow example we are working with the "ring"
topology running between the line ports on the AoC10_L2 cards in the three participating NEs (NE1, NE2,
NE3):
• Between Port 18 on the AoC10_L2 card in NE1 and Port 19 on the AoC10_L2 card in NE2
• Between Port 18 on the AoC10_L2 card in NE2 and Port 19 on the AoC10_L2 card in NE3
• Between Port 18 on the AoC10_L2 card in NE3 and Port 19 on the AoC10_L2 card in NE1
Start
1. On the network map, drag the mouse to select the network topology structure that you just configured.
2. In the main window Services tab, click Create L2VPN Service.
The Create L2VPN Service window opens.
3. In the Basic Parameters pane:
◦ In the Service Group dropdown list, select Infrastructure.
◦ In the Type dropdown list, select ERP PB Ring.
Keep the default values for the other parameters and options.
4. In the Networks tab, open the Provider Bridge Network pane to select links for this service. Only
appropriate links are available for selection.
5. Choose the three I-NNI links we configured for this example.
The selected links are listed in the S-VLAN registered I-NNI Links box.
All the E-NNI ports are listed in the External S-VLAN ID for E-NNI Ports box. The Selected RPL
port option also appears in the pane.

Ribbon Communications Inc. Proprietary 460

 Apollo Workflows

6. By default, LightSOFT assigns the first endpoint of the first link selected as the RPL port, and the
others as Ring ports.
7. If you want to manually select an RPL Port while creating the service:
◦ Click on the relevant link to expand it.
◦ Open the Select Link and RPL port for ERP PB ring service window.
◦ Specify the RPL port by clicking the port at the end of the link.
8. In the Provider Bridge Network pane, insert an S-VLANID value.
This is the same S-VLAN ID value for the E-NNI port listed in the External S-VLAN ID pane.

9. Click Complete service .

10. Click Activate service .
11. To view and check the new ERP service (optional):
◦ Open the L2VPN service list window and select the service.
◦ Click on the ERP/RSTP map to see the service in the map view.
◦ Click on the map view.
◦ Select either ERP or RSTP from the drop-down list in the upper left-hand corner.
The forwarding links for the ERP and the RPL owner node are displayed.

Create MP2MP Service Between Client Ports: NMS

This procedure is the sixth step in configuring ERP ring protection (see Configure ERP ring protection).
At this point you are ready to create a MP2MP service between the client ports on the participating NEs.
For this workflow example we are focusing on the minimal set of required steps.
There are many more optional attributes that can be configured, depending on the network context. See
Create an L2VPN service.
Start
1. In the main window Topology Layer dropdown list, select the ETH/MPLS layer.
2. In the main window map region, select the LEs (NE1, NE2) containing the endpoints of the intended
service.
If you select LEs in advance, they (rather than all the objects in the current view) will be displayed
when you open the Create L2VPN Service window.
3. In the main window Services tab, click Create L2VPN Service.
The Create L2VPN Service window opens.
4. In the Service Details tab, in the Basic Parameters pane identify the new service:
◦ In the Label field, enter a name for the new service.
◦ In the Customer field, enter a string that identifies the customer linked to this new service.
5. From the Service Group dropdown list, select Customer.
For this example, keep the default service type of MP2MP, as well as the other default settings.
6. To configure the service endpoints, in the Create L2VPN Service window map view, select the
participating LEs.

Ribbon Communications Inc. Proprietary 461

 Apollo Workflows

To select multiple nodes, click each node while holding down the SHIFT key or hold down the left
mouse button and drag to select a group of nodes included within a virtual region.
7. Right-click and choose Select Endpoint.
A filtered version of the port tree is displayed, including only the available slots of the relevant ports.
LightSOFT automatically displays only compatible endpoints, graying out the others.
8. Expand the tree and select an endpoint port. For this example, select the client port (0) we
configured on NE1.
9. Click Select to complete the selection.
The port details are listed in the Endpoints tab Endpoint List pane.
10. To assign C-VLAN values for all UNI ports in the list of endpoints:
◦ From the Endpoints List in the Endpoints tab, select each UNI port entry in turn and configure
the C-VLAN values (100 in this workflow example).
◦ Select the All/Other checkbox.
11. In the Policers section, select No Rate Limit for CoS0.
12. Repeat the preceding steps for the second service endpoint, in this example the client port 0 on NE2.
13. Repeat the preceding steps for the third service endpoint, in this example the client port 0 on NE3.

Tip
If endpoints have the same or similar attributes and settings, after they are selected and you
have fully configured one endpoint, you can copy and paste some/all attributes and settings to
other endpoints.
In the Endpoint List pane, do the following:
◦ Right-click a configured endpoint line, and select Copy Details.
◦ Select one or more endpoint lines into which to copy the attributes and settings.
◦ Right-click, select Paste Details, and then All Details or a specific configuration aspect.

14. In the Networks tab, enable Automatic S-VLAN Registration.

Note
A service can only be completed after two or more endpoints are defined. A port only becomes
a configured service endpoint after activation.

15. Click Complete service .

16. Click Activate service .

Verify RPL Port: EMS

This procedure is the seventh and final (optional) step in configuring ERP ring protection (see Configure ERP
ring protection).
Start
1. At the STMS level, in the Network Explorer tab, right-click the switch element below the AoC10_L2
card and select Services.
The list of defined VSIs appears in the VSI List tab.
2. You can filter the list using the Filter options.
3. Right-click the relevant (ERP) VSI in the list and select VSI Properties View.
The VSI window opens, displaying the configuration details.
The information that appears in this window changes according to the VSI type and configuration.
4. Select ERP Instance Status and confirm that it is set to RPL.

Ribbon Communications Inc. Proprietary 462

 Apollo Workflows

Apollo Workflow: Configure Multi-Route OCH Protection

This workflow provides a high-level overview of the stages in configuring multi-route OCH protection.
This particular example illustrates configuring multi-route OCH protection running between two different NEs,
where each NE includes a transponder, a TFA and four ROADM modules.

Tip
Some of the procedures required at initial network configuration are not always necessary during
ongoing standard network operation.
In addition, some steps may be needed only under certain circumstances, such as for specific
types of cards or configuration contexts.
Two versions of this workflow are included here:
• The first workflow includes all the steps required at initial configuration, as well as steps that
are only required under certain circumstances.
• The second workflow includes only the simpler set of steps generally required during
standard operation.

This topology includes the minimal components required to configure a prototype of multi-route OCH trail
protection.
In this configuration, a multi-route OCH trail is configured between 2 NEs.
Each NE includes a transponder, a TFA and 4 ROADMs, providing 3 alternative routes for the traffic flow.
With multi-route OCH protection, multiple alternative routes are available for traffic flow at each connection
point in the OCH trail.
This provides protection since the traffic is always flowing redundantly across more than one route. This is a
directionless topology.

Ribbon Communications Inc. Proprietary 463

 Apollo Workflows

When working with transponders, client and line ports are typically configured at the same time, since there
is generally a 1:1 correspondence between the client ports and the line ports.
However, while you could configure all the client and line ports needed on a combiner at the same time, this
is not the typical approach.
When working with combiners, the line ports are usually configured initially, and the client ports are only
configured at a later stage, as needed.
Therefore, even though the sample configuration used for this workflow uses transponders, we are including
in the initial network configuration workflow an optional 'client-port-configuration' step, generally only
appropriate when working with combiners.

Configure Multi-Route OCH Protection (Initial Configuration)

Start
1. Discover the participating Network Elements (NEs).
2. Assign cards (TRP, TFA, ROADMs) on the first endpoint NE.
3. Configure cards and ports on the first endpoint NE.
4. Repeat the card and port configuration on the second endpoint NE.
5. Create the Logical Elements (LEs).
6. Create links between LEs.
7. Provision underlying OMS trails.
8. Provision a multi-route OCH trail.
9. Configure client ports if not configured previously (combiner cards).
10. Provision an LP trail based on the multi-route OCH trail.

Ribbon Communications Inc. Proprietary 464

 Apollo Workflows

Configure Multi-Route OCH Protection (Standard Operation)

Start
1. Configure new line ports on the first endpoint NE.
2. Repeat the new line port configuration on the second endpoint NE.
3. Create the Logical Elements (LEs).
4. Create links between LEs.
5. Provision underlying OMS trails.
6. Provision a multi-route OCH trail.
7. Provision an LP trail based on the multi-route OCH trail.

Ribbon Communications Inc. Proprietary 465

 Apollo Workflows

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Discover the Participating Network Elements - OCH: EMS

This procedure is the first step in configuring MOCH protection during initial network configuration (see
Configure multi-route OCH protection).
Trails and services run between NEs. If they are not yet visible on the network map, you must drill down to
the EMS level and discover the NEs over which they will run.
Start
1. Access the Topology Layer dropdown list.
2. Select the appropriate topology view from the list. In this example, select the Physical (EMS) layer.
The appropriate topology view is displayed.

3. In the network map, select the EMS for which you want to create an ME.

Ribbon Communications Inc. Proprietary 466

 Apollo Workflows

4. In the main window Topology tab, in the Create group, click ME .

The Create NE window for the selected EMS opens.
5. If the participating NE is not yet included in the EMS level, discover the new NE.
You can discover NEs using the STMS discovery utility.
This utility (also referred to as the discover command) enables you to discover NEs and create STMS
groups (or subdomains).
This enables you to discover several NEs at a time.
6. Log in to the system in which the STMS server has been installed.
7. Open a shell prompt.
8. Change the working directory to the directory in which you installed the STMS software.
9. At the prompt, type:
./bin/discover option argument
where:
◦ option is a valid command option (or set of options).
◦ argument is a valid argument (or arguments) associated with the command option.
10. Click ENTER.
11. At the CLI prompt, type the following command: set network-element opt96xx ne-id <ne ID
number>
12. Repeat the preceding steps, discovering all NEs that are needed for the service that do not yet exist
in the network topology.

Assign Cards - TRP TFA ROADMs - on the First Endpoint NE:

EMS
This procedure is the second step in configuring MOCH protection during initial network configuration (see
Configure multi-route OCH protection).
Repeat the following steps at the EMS level for all participating cards (transponder, TFA, 4 ROADMs) on the
first endpoint NE.
Start
1. Open a GCT window to STMS at the EMS level.
2. In the main window map or the tree view, right-click the relevant object.
3. Select Open.
The EMS main window opens.
4. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.
5. Select the slot for the card.
The supported card types appear in the right pane.
6. Select the card type and click Finish.
The card is assigned.
7. Verify new slot assignments in the EMS main window portrayal of the platform slot layout (optional).

Tip
Make a note of the selected slots as you will need this later in the procedure for subsequent
steps at the LightSOFT level.

Ribbon Communications Inc. Proprietary 467

 Apollo Workflows

Configure Cards and Ports on the First Endpoint NE: EMS

This procedure is the third step in configuring MOCH protection during initial network configuration.
This is the first step during standard operation (see Configure multi-route OCH protection).
You now configure line and client ports (as needed) on each participating card.
Start
1. Open a GCT window to STMS at the EMS level.
2. In the main window map or the tree view, right-click the relevant object.
3. Select Open.
The EMS main window opens.
4. In the chassis view, right-click the transponder card and select Configure Port.
The Port Configuration window opens.
5. In the Select column, select the checkboxes of the ports you want to define.
6. To configure the client port:
◦ Set the port type to OTU2e.
◦ Select the appropriate transceivers for each port.
Transceivers must be tunable - colorless and directionless is also recommended.
◦ Select the appropriate Tx frequency.

Ribbon Communications Inc. Proprietary 468

 Apollo Workflows

7. To configure the line port (0):

◦ Set the port type to ETY10GOC.
◦ Select the appropriate transceivers for each port.
Transceivers must be tunable - colorless and directionless is also recommended.
◦ Select the appropriate Tx frequency.
8. In the chassis view, right-click the relevant port on the TFA card and open the Port Properties widow.
◦ Select the OCHP tab.
◦ Set the Rx and Tx frequencies.
The frequency selected here must match the frequency selected for the transponder.

9. Configure 3 client ports on each participating ROADM card:

◦ The client port type is OTS.
◦ Select a channel frequency.
◦ The line port on each ROADM card is configured by default.

Tip
Make a note of the selected ports and frequencies as you will need this later in the
procedure for subsequent steps at the LightSOFT level.

Ribbon Communications Inc. Proprietary 469

 Apollo Workflows

Repeat the Card and Port Configuration on the Second

Endpoint NE: EMS
This procedure is the fourth step in configuring MOCH protection during initial network configuration.
This is the second step during standard operation (see Configure multi-route OCH protection).
Repeat the preceding card and port configuration steps for the TRP, TFA, ROADM cards on the second NE
endpoint.
Start
1. Assign the appropriate cards to the relevant slots in the NE.
2. Verify new slot assignments in the EMS main window portrayal of the platform slot layout (optional).
3. In the chassis view, right-click the transponder card and open the Port Configuration window.
4. Set the line port (0) to ETY10GOC.
5. Set the client port to OTU2e.
6. Select the appropriate transceivers for each port.
Transceivers must be tunable - colorless and directionless is also recommended.
7. Select the appropriate Tx frequency.
8. In the chassis view, right-click the relevant port on the TFA card and open the Port Properties
window.
9. Select the OCHP tab.
10. Set the Rx and Tx frequencies.
The frequency selected here must match the frequency selected for the transponder.
11. Configure 3 client ports on each participating ROADM card.
The client port type is OTS.
12. Select a channel frequency.
The line port on each ROADM card is configured by default.

Tip
Make a note of the selected slots, ports, and frequency as you will need this later in the
procedure for subsequent steps at the LightSOFT level.

Create the Logical Elements - MOCH: NMS

This procedure is the fifth step in configuring MOCH protection during initial network configuration.
This is the third step during standard operation (see Configure multi-route OCH protection).
The cards configured in the NE at the STMS EMS level must be added to the topology map at the LightSOFT
NMS level.
The physical cards are represented by logical elements (LEs) on the LightSOFT map.
An LE must be created for each card installed, in each endpoint NE.
Start
1. If you are currently working in STMS, return to the LightSOFT level.
2. In the Topology Layer dropdown list, select the technology layer in which you want to create the LEs.
3. In the map, right-click the first endpoint NE on the topology map and select Create LE.
The Create Logical Element window opens.
You are now going to create an LE for each of the cards you just configured in that NE.
4. In the LE Name field, enter a name for the LE.
5. Clear the Auto Create LE checkbox so that you can explicitly create each separate LE and assign
each one a meaningful name.
Recommended names identify the NE source, slot, card type, together with the appropriate map icon.
The port selection area of the window becomes active.

Ribbon Communications Inc. Proprietary 470

 Apollo Workflows

6. In the LE Type dropdown list, select the type of LE you want to create (options vary according to the
LE's technology).
The icon for that LE type is displayed next to the dropdown list.
7. Click the arrow adjacent to the LE icon and select the directionality you require.
8. If the primary LE is part of a group, to add the secondary LE to the same group, check the Add to LE
group checkbox.
9. In the Primary LE area, select the cards, slots or ports that the secondary LE represents, and click
Add .
The selected elements are moved to the Secondary LE area.
10. Click Apply.
The LE is created and the cursor displays a representative LE icon ( ).
11. Move the cursor to the required location on the map, and click once to drop the LE in place.
12. Right-click the second endpoint NE on the topology map to create a second set of LEs.

Tip
Refer to your notes from the previous steps to verify the slot number and channel frequency
of the card that you just configured.
They should match the values listed for that slot, card, and port in the Available Automatic
Split Selection table.

In this workflow example, you are creating an LE for each new ROADM, TFA and transponder card in each
endpoint NE.
The LE object for the transponder represents the pair (line/client) of participating ports.
Right-click the parent NE and select Properties to see a list of all the secondary LEs created from this NE.
The LE icons on the topology map should be facing in the correct direction for the configuration you are
defining.
For example, if two ROADM cards are linked between degree-side ports, the degree sides of the icons
should be facing each other.

Change or Adjust an LE Icon

Start
1. Right click the icon and select Properties.
2. Click the drop-down box next to the LE Type field and select the appropriate icon.
For example:

Ribbon Communications Inc. Proprietary 471

 Apollo Workflows

Create Links Between LEs: NMS

This procedure is the sixth step in configuring MOCH protection during initial network configuration.
This is the fourth step during standard operation (see Configure multi-route OCH protection).
At this point the topology map displays the complete set of LEs that will be participating in the new protection
configuration.
The next step is to configure the links that provide the underlying infrastructure for the OHC trails.

Tip
Create the links in a methodical sequence, starting at one end and creating all links along the way
until you reach the other end.
For example, in this case:
• Start with the first NE and create the following links:
◦ One link between the transponder and the TFA.
◦ One link between the line (0) port of the TFA and the line (0) port of the first ROADM.
◦ A full mesh of (6) links between client (degree) ports of the 4 participating ROADMs.
A mesh topology between the participating ROADMs enables a true colorless/
directionless configuration.
• Continue with the second NE and create the same set of links.
• Create three links running between the ROADMS on the two NEs.
A figure at the end of this section illustrates this topography, with the underlying link infrastructure
necessary to configure multi-route OCH protection that provides three separate routes to carry all
traffic in a redundant flow.

Start
1. In the main LightSOFT toolbar, select the Topology tab.
2. On the topology map, select the first LE object.
3. Holding the <Shift> key, select the second LE object.
4. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
For an internal link, the two panes show details of the same object.
5. To display the frequency configured for each port next to that port in the NE object tree, click the View
menu and select Show Frequency.
This simplifies selection of the correct port.
6. Select the appropriate ports on the two LEs as the link endpoints.
Choose ports with the correct channel/frequency values.
7. Verify with the notes you took earlier in this workflow.

Ribbon Communications Inc. Proprietary 472

 Apollo Workflows

When you choose a transponder port with a specific channel configuration, the corresponding TFA
port is automatically configured to the correct channel setting.
You can verify the channel settings for the TFA port by selecting the TFA LE, opening a GCT to the
STMS level, and checking the channel assigned to the TFA port.
8. Click Apply to create the new topology link.
9. Verify the link by opening the Link List table and locating the newly configured link.
10. In the main window, select the relevant objects.
11. In the Topology tab, in the Lists group, click Link List or LE List. The Link List or LE List window
opens, displaying entries for the selected object(s).

Tip
It might be easier to locate the link if you filter the table and/or focus on the Frequency column.
You can also look at the end of the table - new links are usually added at the bottom of the
table list.

Provision Underlying OMS Trails: NMS

This procedure is the seventh step in configuring MOCH protection during initial network configuration.
This is the fifth step during standard operation (see Configure multi-route OCH protection).
In a typical optical network, components are configured into a hierarchy of OMS, OCH, ODU, LP trails, as
illustrated in the following figure.

Ribbon Communications Inc. Proprietary 473

 Apollo Workflows

Hierarchy of optical trails

In our workflow example, the new multi-route-protected OCH trails will be provisioned over underlying OMS
trails.
Rather than provisioning the necessary OMS trails manually, either one at a time or in a group, these trails
can be configured automatically.
Start
1. On the Topology map, drag the mouse to select the network topology structure that you have
configured, nodes and links.
2. In the main LightSOFT toolbar, select the Trails tab.
3. Select Trail Consistency (TCI).
The Trail Consistency Indicator window opens.
4. Check Classified and click the Start toolbar button.
LightSOFT automatically identifies the appropriate (P2P) links that are available in the selected
topology and uses them to create and enable all OMS trails that can be configured along the selected
topology.
The new link and trail data must all be added to the NMS and EMS databases for internal consistency.
5. Verify that the new OMS trails have been created (optional).
At this point you need to verify that the underlying trails have all been created successfully.
6. Select one of the participating LEs.
7. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
8. Check the state of the new trails to verify that they are all OK.
9. Select one or more trails in the trail list to see the trail path(s) highlighted in the topology map.

Provision a Multi-Route OCH Trail: NMS

This procedure is the eighth step in configuring MOCH protection during initial network configuration.
This is the sixth step during standard operation (see Configure multi-route OCH protection).
At this point all the necessary underlying infrastructure has been created, and we are ready to create a new
trail with multi-route OCH protection.
Start
1. On the Topology map, drag the mouse to select the network topology structure that you have
configured, nodes and links.
2. In the main LightSOFT toolbar, select the Trails tab.
3. Select Create Trail.
The Create Trail window opens.
4. In the Trail Parameters pane:
◦ Set the trail rate to OCH.

Ribbon Communications Inc. Proprietary 474

 Apollo Workflows

◦ Set protection to Multi-route.

◦ Set directionality to Bidirectional.
◦ Check Multi-route and set the number of main routes to 3 (for this example).
5. Right-click the transponder LE from the first NE and choose Select Endpoint.
6. Select the transponder port with the correct channel setting as the first trail endpoint.
7. Right-click the transponder LE from the second NE and choose Select Endpoint.
8. Select the transponder port with the correct channel setting as the second trail endpoint.

9. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources (which in this
example we have provisioned) are available along that route, and verifies that the trail can be created
successfully.

10. Click Activate .

The new OCH trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
11. Verify the new OCH trail by opening the Trail List table and locating the newly configured trail
(optional).
12. Select one of the participating LEs.
13. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
14. Check the state of the new trail to verify that it is OK.
15. Select the trail in the trail list to see the trail path highlighted in the topology map.

Tip
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at the
STMS level.

Configure Client Ports If Not Configured Previously - Combiner

Cards: EMS
This procedure is the ninth step in configuring MOCH protection during initial network configuration (see
Configure multi-route OCH protection).
This particular example illustrates configuring multi-route OCH protection running between two different NEs,
where each NE includes a transponder, a TFA, and four ROADM modules.
When working with transponders, client and line ports are typically configured at the same time, since there
is generally a 1:1 correspondence between the client ports and the line ports.
However, while you could configure all the client and line ports needed on a combiner at the same time, this
is not the typical approach.
When working with combiners, the line ports are usually configured initially, and the client ports are only
configured at a later stage, as needed.
Therefore, even though the sample configuration used for this workflow uses transponders, we are including
in this diagram an optional 'client-port-configuration' step, generally only appropriate when working with
combiners.
Start
1. Double-click an NE to open a GCT window to the EMS level.
2. In the chassis view, right-click the combiner card and open the Port Configuration window.
3. Configure the client ports on each participating card.
In this example:
◦ The client port type is OTS.

Ribbon Communications Inc. Proprietary 475

 Apollo Workflows

◦ Select a channel frequency.

Tip
Make a note of the selected slots, ports, and frequencies.
You will need this later in the procedure for subsequent steps at the LightSOFT level.

Provision an LP Trail Based on the Multi-Route OCH Trail: NMS

This procedure is the tenth (and final) step in configuring MOCH protection during initial network
configuration.
This is the seventh (and final) step during standard operation (see Configure multi-route OCH protection).
At this point you are ready to create a new LP service.
The service will be provisioned with multi-route OCH protection utilizing the new underlying OCH trails
running between the two endpoint NEs.
Start
1. On the Topology map, drag the mouse to select the network topology structure that you have
configured, nodes and links.
2. In the main LightSOFT toolbar, select the Trails tab..
3. Select Create Trail.
The Create Trail window opens.
4. In the Trail Parameters pane:
◦ Set the trail rate to LP.
◦ Choose the Unprotected protection option.
◦ Set the Capacity to Any.
5. Select the two transponder LEs as two endpoints, choosing the two transponder line ports.

6. Click Complete .
Pathfinder identifies the most appropriate options and find the OCH trails that you have defined.
The completion is successful and the capacity is changed to 10GbE automatically to match the
capacity of the underlying line ports.
Protection is based on the underlying multi-route OCH protection.
7. Click Activate .
The new LP trail is provisioned and ready for use as needed.
8. Verify the new LP trail by opening the Trail List table and locating the newly configured trail (optional).
9. Select one of the participating LEs.
10. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
11. Check the state of the new trail to verify that it is OK.
12. Select the trail in the trail list to see the trail path highlighted in the topology map.

Note
For further assistance, contact your local customer support representative.

Apollo Workflow: Configure OTN Services

This workflow provides a high level overview of the stages in adding an OTN service to an NE.
This workflow includes provisioning the underlying topology infrastructure at the STMS level, and then
configuring the relevant trails at the NMS level.

Ribbon Communications Inc. Proprietary 476

 Apollo Workflows

For this workflow example, we are working with two OPT9904X platforms, each one with an MIO200 card
configured with an ETY10GOC (10GbE) client port and 100G line ports.
Each stage in the workflow includes a link to the specific procedure.
Different procedures may be completed at various network levels. For example, a port is configured at the
STMS level while an E2E service is configured at the NMS level.

Adding an OTN service to an NE

Start
1. Configure client and line ports on MIO200 cards on both NEs.
2. Create topology links between line ports.
3. Provision underlying OCH trail between line ports.
4. Provision ODU4 trail.
5. Provision an LP trail for the new service.

Ribbon Communications Inc. Proprietary 477

 Apollo Workflows

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Configure Client and Line Ports on MIO200 Cards on Both NEs:

EMS
This procedure is the first step in configuring an OTN service (see Configure OTN services).
An underlying topology infrastructure must be created at the STMS level, including two OPT9904X platforms,
each populated with an MIO200 card.
These cards should be configured with the appropriate client and line ports.
Start
1. Select the Physical (EMS) topology layer.
2. Open a GCT window to STMS at the EMS level.
3. In the main window map or the tree view, right-click the first participating NE object.
4. Select Open.
The EMS main window opens.
5. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.
6. Select a slot for the MIO200 card.
The supported card types appear in the right pane.
7. Select the card type and click Finish.
The card is assigned.
8. Verify new slot assignments in the STMS main window portrayal of the platform slot layout (optional).
9. From the chassis view, right-click the MIO200 card and select Configure Port.
The Port Configuration window opens.
10. In the Select column, select the checkboxes of the MIO200 ports you want to define.
11. Configure the ETY10GOC client port, with the appropriate port type, transceiver, and frequency.
The other default attributes can be maintained.

Ribbon Communications Inc. Proprietary 478

 Apollo Workflows

12. Configure the 100G line port, with the appropriate OTU4 port type, transceiver, and frequency.
The other default attributes can be maintained.
13. Choose the appropriate DWDM channel to be used.
14. The Actual Transceiver Type column shows the actual transceiver installed.
For newly assigned ports, you can copy the actual transceivers to the configured transceivers by
selecting the relevant ports and clicking Copy Actual Transceiver to Configured.
15. Repeat these steps for the MIO200 card ports on the second NE.

Tip
Client and line port configuration on the two MIO200 cards must match. Make a note of the
card and port configuration details (platform, slot, card, port, type, rate, transceiver, frequency)
as you will need this later in the procedure for subsequent steps at the LightSOFT level.

Create Topology Links Between Line Ports - OTN: NMS

This procedure is the second step in configuring an OTN service (see Configure OTN services).
The cards configured in the NEs at the STMS EMS level must be added to the topology map at the
LightSOFT NMS level.
The physical cards are represented by logical elements (LEs) on the LightSOFT map.
An LE must be created for each card installed, in each endpoint NE.
These LEs are then connected with fiber connectivity topology links.
Start
1. In the Topology Layer dropdown list, select the technology layer in which you want to create the LEs.
2. In the map, right-click the first endpoint NE on the topology map and select Create LE.
The Create Logical Element window opens.
You are now going to create an LE for each of the cards you just configured in that NE.
3. In the LE Name field, enter a name for the LE.
4. Keep the Auto Create LE checkbox checked to automatically assign each LE a meaningful name that
identifies the NE source, slot, and card type.
The port selection area of the window becomes active.
5. In the LE Type dropdown list, select the type of LE you want to create.
The icon for that LE type is displayed next to the dropdown list.
6. In the Primary LE area, select the cards, slots, or ports that the secondary LE represents, and click
Add .
The selected elements are moved to the Secondary LE area.
7. Click Apply.

8. The LE is created and the cursor displays a representative LE icon ( ).

9. Move the cursor to the required location on the map, and click once to drop the LE in place.
10. Repeat the preceding step with the second endpoint NE on the topology map and create a second
set of LEs.
You are now going to create a fiber connectivity topology link between the two line ports on the
MIO200 cards in the two platforms.
11. On the topology map, select the LE object for the MIO200 card in the first NE.
12. Holding the <Shift> key, select the LE object for the MIO200 card in the second NE.
13. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
For an internal link, the two panes show details of the same object.
14. Select the appropriate 100G line ports on the LE as the link endpoints.

Ribbon Communications Inc. Proprietary 479

 Apollo Workflows

15. Click Apply to create the new topology link.

The new link is highlighted in pink on the topology map view.
16. Verify the links by opening the Link List table and locating the newly configured links (optional).
17. In the main window, select the relevant objects.
18. In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).

Tips
◦ It might be easier to locate the link if you filter the table and/or focus on the Frequency
column. You can also look at the end of the table - new links are usually added at the
bottom of the table list.
◦ Refer to your notes from the previous steps to verify the slot number and channel
frequency of the card that you just configured. They should match the values listed for
that slot, card, and port in the Available Automatic Split Selection table.

Provision the Underlying OCH Trail Between Line Ports: NMS

This procedure is the third step in configuring an OTN service (see Configure OTN services).
An OCH trail must be provisioned between the two line ports before we can provision a higher-level trail or
service to run between the client endpoints.
Start
1. Select the Optical topology layer.
2. In the main window select the 2 LEs that will serve as the endpoints of the new OCH trail (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. In the Basic Trail Parameters pane, set the following parameters:
◦ Set the trail rate to OCH.
◦ Choose the Unprotected option.
◦ Choose the Bidirectional option.
◦ Edit Label and Customer names (optional).
In this example, the default values can be maintained for the other fields. If necessary, you can edit as
relevant for your network configuration.
6. Select the relevant endpoints on the two NEs.
In this example we are selecting the relevant 100G line ports on the selected MIO200 cards.

7. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.

8. Click Activate .
The new OCH trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
9. Verify the new OCH trails by opening the Trail List table and locating the newly configured trails
(optional).
10. Select one of the participating LEs.
11. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
12. Check the state of the new trails to verify that they are all OK.
13. Select one or more trails in the trail list to view the trail path(s) highlighted in the topology map.

Ribbon Communications Inc. Proprietary 480

 Apollo Workflows

Tips
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at the
STMS level.

Provision the ODU4 Trail: NMS

This procedure is the fourth step in configuring an OTN service (see Configure OTN services).
At this point you are provisioning an ODU4 trail over the topology infrastructure you have configured.
Start
1. Select the Optical topology layer.
2. Select the two LEs that will serve as the endpoints of the new trail.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
The map contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. Set the trail rate to ODU.
6. Choose the Unprotected option.
7. Choose the Bidirectional option.
8. Configure Capacity based on the underlying line port configuration at the STMS level. In this workflow
example, it is ODU4.
9. Right-click an LE in the map and choose Select Endpoint.
The Endpoint Selection window opens.
The ports that are free and conform to the selected trail rate and capacity are available for selection.
10. Select the relevant endpoints on the two NEs. In this workflow example, the 100G line ports on the
MIO200 cards.

11. Click Complete .

Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.

12. Click Activate .

The new ODU trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
13. Verify the new ODU trails by opening the trail list table and locating the newly configured trails
(optional).
14. Select one of the participating LEs.
15. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
16. Check the state of the new trails to verify that they are all OK.
17. Select one or more trails in the trail list to view the trail path(s) highlighted in the topology map.

Tips
To verify that you have selected the correct endpoints, check the port rates and channels.
They should match the values selected when the underlying equipment was configured at the
STMS level.

Provision an LP Trail for the New Service - OTN: NMS

This procedure is the fifth (and final) step in configuring an OTN service (see Configure OTN services).
At this point you are ready to create a new LP service running over the infrastructure you have created.

Ribbon Communications Inc. Proprietary 481

 Apollo Workflows

Start
1. On the Topology map, drag the mouse to select the network topology structure that you have
configured, nodes and links.
2. In the main LightSOFT toolbar, select the Trails tab.
3. Select Create Trail.
The Create Trail window opens.
4. In the Trail Parameters pane, set the trail rate to LP.
5. Choose Bidirectional.
6. Choose the Unprotected protection option.
7. Select the appropriate Capacity option.
In this example, the rate is Any.
8. Select the client ports as the new trail endpoints.
In this workflow example we are working with the corresponding ETY10GOC client ports configured
on the MIO200 cards installed in NE1 and NE2.

9. Click Complete .
Pathfinder identifies the appropriate main and protection paths, utilizing the network resources that
you have already provisioned in previous steps.

10. Click Activate .

The new LP trail is provisioned and ready for use as needed.
11. Verify the new LP trail by opening the Trail List table and locating the newly configured trail (optional).
12. Select one of the participating LEs.
13. Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
14. Check the state of the new trail to verify that it is OK.
15. Select the trail in the trail list to view the trail path highlighted in the topology map.

Note
For further assistance, contact your local customer support representative.

Apollo Workflow: Configure Y-Protection

This workflow provides a high-level overview of the stages in creating a new Y-protected service.
This particular example illustrates creating a Y-protected LP service running between two TR10_12 cards,
installed on two different NEs, one at each end of the service.

Tip
Some of the procedures required at initial network configuration are not always necessary during
ongoing standard network operation.
In addition, some steps may be needed only under certain circumstances, such as for specific
types of cards or configuration contexts.
Two versions of this workflow are included here:
• The first workflow includes all the steps required at initial configuration, as well as steps that
are only required under certain circumstances.
• The second workflow includes only the simpler set of steps generally required during
standard operation.

With Y-protection, three ports on each card participate in the service configuration, one as a client port and
two as line ports.

Ribbon Communications Inc. Proprietary 482

 Apollo Workflows

Any available port on the TR10_12 card can be used for any of the participating port roles, client or line.

Configure Y-Protection

Y-protection between two NEs includes two distinct paths running between the two pairs of line ports on the
NE endpoints.
The signal is transmitted and received on both lines.
Only one of the signals received by the card is processed and forwarded to the client side. The choice of
which signal to process is based on PM parameters for the signal.
In this workflow example:
• The first path we are configuring runs from a line port on NE-1 to a line port on NE-2, running through
a set of Mux/DeMux objects (in this case TFA8 modules).
Therefore, it is necessary to create a fiber connectivity topology link along this path that includes the
LE ports and Mux/DeMux objects participating in this path.
• The second path in this example is a simpler path running directly between the second set of line
ports.
This is a prototypical example - the steps described here can be applied to other network
configurations as well.
• Each stage in the workflow includes a link to the specific procedure.
Different procedures may be complete at various network levels. For example, a port is configured at
the EMS level while an E2E service is configured at the NMS level.

Note
In our workflow example, the new Y-protected network service is provisioned on a LightPath
(LP) trail.
The LP trail runs over an OCH trail, which requires an underlying OMS trail.

Configure Y-protection (initial configuration)

Start
1. Discover the participating Network Elements (NEs).

Ribbon Communications Inc. Proprietary 483

 Apollo Workflows

2. Configure a TR10_12 card on the Network Element (NE) at one service endpoint.
3. Configure three ports on the TR10_12 card.
4. Repeat the card and port configuration on the second endpoint NE.
5. Create the Logical Elements (LEs).
6. Create a topology link between one set of line ports.
7. Create a direct topology link between the second set of line ports.
8. Provision an underlying OMS trail (if necessary).
9. Provision an underlying OCH trail between the first set of line ports.
10. Provision an underlying OCH trail between the second set of line ports.
11. Provision an LP trail for the new service.

Configure Y-protection (standard operation)

Start
1. Configure three ports on the TR10_12 card on the Network Element (NE) at one service endpoint.

Ribbon Communications Inc. Proprietary 484

 Apollo Workflows

2. Configure three ports on the TR10_12 card on the Network Element (NE) at second service endpoint.
3. Create the Logical Elements (LEs).
4. Create a topology link between one set of line ports.
5. Create a direct topology link between the second set of line ports.
6. Provision an underlying OCH trail between the first set of line ports.
7. Provision an underlying OCH trail between the second set of line ports.
8. Provision an LP trail for the new service.

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Discover the Participating Network Elements - Y-Protection:

EMS
This procedure is the first step in configuring Y-protection during initial network configuration (see Configure
Y-protection).
Trails and services run between NEs. If they are not yet visible on the network map, you must drill down to
the EMS level and discover the NEs over which they will run.
Start
1. Access the Topology Layer dropdown list.

Ribbon Communications Inc. Proprietary 485

 Apollo Workflows

2. Select the appropriate topology view from the list. In this example, select the Physical (EMS) layer.
The appropriate topology view is displayed.

3. In the network map, select the EMS for which you want to create an ME.

4. In the main window Topology tab, in the Create group, click ME .

The Create NE window for the selected EMS opens.
5. If the participating NE is not yet included in the EMS level, discover the new NE.
You can discover NEs using the STMS discovery utility.
This utility (also referred to as the discover command) enables you to discover NEs and create STMS
groups (or subdomains).
This enables you to discover several NEs at a time.
6. Log in to the system in which the STMS server has been installed.
7. Open a shell prompt.
8. Change the working directory to the directory in which you installed the STMS software.
9. At the prompt, type:
./bin/discover option argument
where:
◦ option is a valid command option (or set of options).
◦ argument is a valid argument (or arguments) associated with the command option.
10. Click ENTER.
11. At the CLI prompt, type the following command: set network-element opt96xx ne-id <ne ID
number>
12. Repeat the preceding steps, discovering all NEs that are needed for the service that do not yet exist in
the network topology.

Configure a TR10_12 Card on the NE at One Service Endpoint:

EMS
This procedure is the second step in configuring Y-protection during initial network configuration (see
Configure Y-protection).
In this example, Y-protection is configured for a service running between two TR10_12 cards, installed on
two different NEs, one at each end of the service.
With Y-protection, three ports on each card participate in the service configuration, one as a client port and
two as line ports.
Any available port on the TR10_12 card can be used for any of the participating port roles, client or line.

Ribbon Communications Inc. Proprietary 486

 Apollo Workflows

Configure a TR10_12 Card on the NE

Start
1. Open a GCT window to STMS at the EMS level.
2. In the main window map or the tree view, right-click the relevant object.
3. Select Open.
The EMS main window opens.
4. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.
5. Select the slot for the card.
The supported card types appear in the right pane.
6. Select the card type and click Finish.
The card is assigned.
7. Verify new slot assignments in the STMS main window portrayal of the platform slot layout (optional).

Tip
Make a note of the slot number as you will need this later in the procedure for subsequent
steps at the LightSOFT level.

Configure Three Ports on the TR10_12 Card: EMS

This procedure is the third step in configuring Y-protection during initial network configuration.
This is the first step during standard operation (see Configure Y-protection).
At this point you configure three ports on each card participating in the service, one as a client port and two
as line ports.
Any available port on the TR10_12 card can be used for any of the participating port roles, client or line.
Start
1. Open a GCT window to STMS at the EMS level.
2. In the main window map or the tree view, right-click the relevant object.
3. Select Open.
The EMS main window opens.

Ribbon Communications Inc. Proprietary 487

 Apollo Workflows

4. In the chassis view, right-click the card and select Configure Port.
The Port Configuration window opens.
5. In the Select column, select the checkboxes of the ports you want to define.
6. To configure the client port:
◦ Set the port type to ETY10GOC.
◦ Choose an appropriate transceiver.
◦ The other default attribute values can be kept.
7. To configure one line port:
◦ Set the port type to OTU2e to enable overclocking.
◦ Choose an appropriate transceiver.
◦ Select a frequency based on network configuration and availability.
◦ The other default attribute values can be kept.
8. To configure a second line port:
◦ Set the port type to OTU2e to enable overclocking.
◦ Choose an appropriate transceiver.
◦ Select a frequency based on network configuration and availability.
◦ The other default attribute values can be kept.

Tip
Make a note of the frequency as you will need this later in the procedure for subsequent
steps at the LightSOFT level.

Repeat Card and Port Configuration on Second Endpoint NE:

EMS
This procedure is the fourth step in configuring Y-protection during initial network configuration; this is the
second step during standard operation (see Configure Y-protection).
Repeat the preceding card and port configuration steps for the second TR10_12 card, installed on the
second NE endpoint.
Start
1. Open a GCT window to STMS at the EMS level.
2. In the main window map or the tree view, right-click the relevant object.
3. Select Open.
The EMS main window opens.
4. From the Network Explorer tab, right-click the NE and select Assign Card.
The Assign Card window opens.
5. Select the slot for the card.
The supported card types appear in the right pane.
6. Select the card type and click Finish.
The card is assigned.
7. Verify new slot assignments in the STMS main window portrayal of the platform slot layout (optional).
8. From the chassis view, right-click the card and select Configure Port.
The Port Configuration window opens.
9. In the Select column, select the checkboxes of the ports you want to define.
10. To configure the client port:
◦ Set the port type to ETY10GOC.
◦ Choose an appropriate transceiver.
◦ The other default attribute values can be kept.
11. To configure one line port:
◦ Set the port type to OTU2e to enable overclocking.
◦ Choose an appropriate transceiver.
◦ Select a frequency based on network configuration and availability.

Ribbon Communications Inc. Proprietary 488

 Apollo Workflows

◦ The other default attribute values can be kept.

12. To configure a second line port:
◦ Set the port type to OTU2e to enable overclocking.
◦ Choose an appropriate transceiver.
◦ Select a frequency based on network configuration and availability.
◦ The other default attribute values can be kept.

Tip
Make a note of the slot numbers and frequency as you will need this later in the procedure
for subsequent steps at the LightSOFT level.

Create the Logical Elements - Y-Protection: NMS

This procedure is the fifth step in configuring Y-protection during initial network configuration.
This is the third step during standard operation (see Configure Y-protection).
The cards configured in the NE at the STMS EMS level must be added to the topology map at the LightSOFT
NMS level.
The physical cards are represented by logical elements (LEs) on the LightSOFT map.
A (secondary) LE must be created for each card installed, in each endpoint (primary) NE.
Start
1. In the Topology Layer dropdown list, select the technology layer in which you want to create the LEs.
2. In the map, right-click the first endpoint NE on the topology map and select Create LE.
The Create Logical Element window opens.
You are now going to create an LE for each of the cards you just configured in that NE.
3. In the LE Name field, enter a name for the LE.
4. Clear the Auto Create LE checkbox so that you can explicitly create each separate LEs and assign
each one a meaningful name.
Recommended names identify the NE source, slot, and card type, together with the appropriate map
icon.
The port selection area of the window becomes active.
5. In the LE Type dropdown list, select the type of LE you want to create (options vary according to the
LE's technology).
The icon for that LE type is displayed next to the dropdown list.
6. Click the arrow adjacent to the LE icon and select the directionality you require.
7. If the primary LE is part of a group, to add the secondary LE to the same group, check the Add to LE
group checkbox.
8. In the Primary LE area, select the cards, slots, or ports that the secondary LE represents, and click
Add .
The selected elements are moved to the Secondary LE area.
9. Click Apply.
The LE is created and the cursor displays a representative LE icon ( ).
10. Move the cursor to the required location on the map, and click once to drop the LE in place.
11. Right-click the second endpoint NE on the topology map create a second set of LEs.

Tip
Refer to your notes from the previous steps to verify the slot number and channel frequency
of the card that you have configured.
They should match the values listed for that slot, card, and port in the Available Automatic
Split Selection table.

Ribbon Communications Inc. Proprietary 489

 Apollo Workflows

Create a Topology Link Between One Set of Line Ports: NMS

This procedure is the sixth step in configuring Y-protection during initial network configuration.
This is the fourth step during standard operation (see Configure Y-protection).
Y-protection between two NEs includes two distinct paths running between the two pairs of line ports on each
NE.
In this workflow example, the first path we are configuring runs from a line port on NE-1 to a line port on
NE-2 through a set of Mux/DeMux objects (in this case TFA8 modules).
Therefore, we must create a fiber connectivity topology link along this path that includes the LE ports and
Mux/DeMux objects participating in this path.
In this example, the second path will be a simpler path running directly between the second set of line ports.
This is only a simple example - in a real network configuration the second path could be direct or more
complex, as appropriate for the network.
Start
You are going to create a fiber connectivity topology link between the LE port on the first NE and the
appropriate Mux/DeMux.
1. On the topology map, select the LE object from the first NE.
2. Holding the <Shift> key, select the appropriate Mux/DeMux object.
3. In the main window Topology tab, in the Create group, click Topology Link.
The Create Topology Link window opens.
The two panes display hierarchical tree structures showing the objects, slots and ports.
For an internal link, the two panes show details of the same object.
4. To display the channel frequency configured for each port next to that port in the NE object tree, click
the View menu and select Show Frequency.
This simplifies selection of the correct port.
5. Select the appropriate ports on the LE and Mux/DeMux as the link endpoints.
◦ If you are working with a passive optical component, you must choose a port with the correct
channel value.
◦ If you are working with an active optical component, the channel frequency will reset automatically,
if necessary.
6. Click Apply to create the new topology link.
The new link is highlighted in pink on the topology map view.
7. Verify the link by opening the Link List table and locating the newly configured link.
8. In the main window, select the relevant objects.
9. In the Topology tab, in the Lists group, click Link List or LE List.
The Link List or LE List window opens, displaying entries for the selected object(s).
10. Repeat these steps to create a topology link between the LE port on the second NE and the
appropriate Mux/DeMux.
11. Repeat these steps to create the complete topology link between the first NE and the second NE.

Tip
It might be easier to locate the link if you filter the table and/or focus on the Frequency column.
Or you can look at the end of the table - new links are usually added at the bottom of the table
list.

Create a Direct Topology Link Between the Second Set of Line

Ports: NMS
This procedure is the seventh step in configuring Y-protection during initial network configuration.

Ribbon Communications Inc. Proprietary 490

 Apollo Workflows

This is the fifth step during standard operation (see Configure Y-protection).
Y-protection between two NEs includes two distinct paths running between the two pairs of line ports on each
NE.
In this example, the second path is a simple path running directly between the second set of line ports.
This is only a simple example - in a real network configuration the second path could be direct or more
complex, as appropriate for the network.
Start
You are going to create a fiber connectivity topology link between the LE port on the first NE and the LE port
on the second NE.
1. On the topology map, select the LE object from the first NE.
2. Holding the <Shift> key, select the LE object from the second NE.
3. In the main window Topology tab, in the Create group, click Topology Link.
4. Select the appropriate ports on the LE as the link endpoints.
5. Create the new topology link.
The new link is highlighted in pink on the topology map view.
6. Verify the link by opening the Link List table and locating the newly configured link.

Tip
It might be easier to locate the link if you filter the table and/or focus on the Frequency column.
Or you can look at the end of the table - new links are usually added at the bottom of the table
list.

Provision an Underlying OMS Trail: NMS

This procedure is the eighth step in configuring Y-protection during initial network configuration (see
Configure Y-protection).
In a typical optical network, components are configured into a hierarchy of OMS, OCH, ODU, LP trails, as
illustrated in the following figure.

Hierarchy of OMS, OCH, ODU, LP trails

In our workflow example, the new Y-protected network service is provisioned on a LightPath (LP) trail.
The LP trail runs over an OCH trail, which requires an underlying OMS trail.
If the current network configuration does not include an available OMS trail to serve as an underlying
resource for the OCH and LP trails, the OMS trail must be provisioned.
Start
1. Select the Optical topology layer.

Ribbon Communications Inc. Proprietary 491

 Apollo Workflows

2. In the main window select the objects containing the relevant objects (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
If nothing was preselected in the main window, the map shows all the objects, otherwise the map
contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. In the Basic Trail Parameters pane, set the following parameters:
◦ Set the trail rate to OMS.
◦ Choose the Unprotected option.
◦ Edit Label and Customer names (optional).
In this example, the default values can be maintained for the other fields.
If necessary, you can edit as relevant for your network configuration.
6. Select the relevant endpoints on the two NEs.

7. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.

8. Click Activate .
The new OMS trail is provisioned and ready for use as needed.

Provision an Underlying OCH Trail Between the First Set of Line

Ports: NMS
This procedure is the ninth step in configuring Y-protection during initial network configuration.
This is the sixth step during standard operation (see Configure Y-protection).
In our workflow example, the new Y-protected network service will be provisioned on a LightPath (LP) trail
running over an OCH trail.
The underlying OCH trail must be provisioned.
Start
1. Select the Optical topology layer.
2. In the main window select the objects containing the relevant objects (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
If nothing was preselected in the main window, the map shows all the objects, otherwise the map
contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. In the Basic Trail Parameters pane, set the following parameters:
◦ Set the trail rate to OCH.
◦ Choose the Unprotected option.
◦ Edit Label and Customer names (optional).
In this example, the default values can be kept for the other fields.
If necessary, you can edit as relevant for your network configuration.
6. Select the relevant endpoints on the two NEs.

7. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.

Ribbon Communications Inc. Proprietary 492

 Apollo Workflows

8. Click Activate .
The new OCH trail is provisioned and ready for use as needed.
9. Verify the new OCH trail by opening the Trail List table and locating the newly configured trails
(optional):
◦ Select one of the participating LEs.
◦ Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
◦ Check the state of the new trail to verify that it is OK.
◦ Select one or more trails in the trail list to see the trail path(s) highlighted in the topology map.

Tip
To verify that you have selected the correct endpoints, check the port rates and channels (in
this example, OTU2e and 193.0).
They should match the values selected when the underlying equipment was configured at
the STMS level.

Provision an Underlying OCH Trail Between the Second Set of

Line Ports: NMS
This procedure is the tenth step in configuring Y-protection during initial network configuration.
This is the seventh step during standard operation (see Configure Y-protection).
The underlying OCH trail running between the second set of line ports runs directly between the TR10_12
card ports, with no other network objects in between.
This simplifies OCH trail creation, and there is no need for an underlying OMS trail, since there is no multi-
channel element involved.
Start
1. Select the Optical topology layer.
2. In the main window select the objects containing the relevant objects (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
If nothing was preselected in the main window, the map shows all the objects, otherwise the map
contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. In the Basic Trail Parameters pane, set the following parameters:
◦ Set the trail rate to OCH.
◦ Choose the Unprotected option.
In this example, the default values can be maintained for the other fields.
If necessary, you can edit as relevant for your network configuration.
6. Select the relevant endpoints on the two NEs.

7. Click Complete .
Pathfinder identifies the most efficient path route, confirms that the necessary resources are available
along that route, and verifies that the trail can be created successfully.

8. Click Activate .
The new OCH trail is provisioned and ready for use as needed.
Any cross-connects necessary for the new trail are created automatically.
9. Verify the new OCH trail by opening the Trail List table and locating the newly configured trail
(optional):

Ribbon Communications Inc. Proprietary 493

 Apollo Workflows

◦ Select one of the participating LEs.

◦ Right-click and select Show Trails.
The Trail List window opens showing only trails associated with the selected LE.
◦ Check the state of the new trail to verify that it is OK.
◦ Select the trails in the trail list to see the trail path highlighted in the topology map.

Tip
To verify that you have selected the correct endpoints, check the port rates and channels (in
this example, OTU2e and 193.0).
They should match the values selected when the underlying equipment was configured at
the STMS level.

Provision LP Trail for a New Service: NMS

This procedure is the eleventh (and final) step in configuring Y-protection during initial network configuration.
This is the eighth (and final) step during standard operation (see Configure Y-protection).
At this point you are ready to create a new LP service.
The service will be provisioned with Y-protection utilizing the new underlying OCH trails running between the
two endpoint NEs.
Start
1. Select the Optical topology layer.
2. In the main window select the objects containing the relevant objects (optional).
When PathFinder searches for trails, it relates to the relevant topology, not only the displayed
elements.
3. In the Trails tab, in the General group, click Create Trail.
The Create Trail window opens.
If nothing was preselected in the main window, the map shows all the objects, otherwise the map
contains only the selected objects and the links between them.
4. Select the Trail Parameters tab.
5. In the Basic Trail Parameters pane, edit one or more of the following parameters, as needed:
◦ Set the trail rate to LP.
◦ Choose the Current protection option.
◦ Clear the DNI selection.
◦ Select the appropriate Capacity option:
• To select the appropriate rate on the endpoints, choose Any.
• To select a specific rate, choose ODU-Structured and select the appropriate rate from the
drop-down field.
In this example, the rate would be 10GBE.
In this example, the default values can be maintained for the other fields.
If necessary, you can edit as relevant for your network configuration.
6. Select the relevant endpoints on the two NEs.
In this example we are selecting one Client port on each endpoint NE.
The Client port is the 10GbE ETY port on the TR10_12 card in each endpoint NE.
The port is marked purple since in a Y-protected service this port is common to both the main and
protection paths.
7. Click Complete .
Pathfinder identifies the appropriate main and protection paths, utilizing the network resources that
you have already provisioned in previous steps.
In this example Pathfinder chooses a path through the OMS and OCH trails running between the line
ports on the TR10_12 cards in each NE.

Ribbon Communications Inc. Proprietary 494

 Apollo Workflows

8. Click Activate .
The new LP trail is provisioned and ready for use as needed.
In this example, because we have configured protection, the LP trail includes two path options.
One path is defined as the main (pink), and the second one is the protection (light blue) path.
This is illustrated in the following screenshot.

9. Verify the new LP trail (optional):

◦ In the main window Trails tab, in the General group, click Trail List.
◦ Filter the trail list table to display only LP trails.

◦ Click Configure Columns , located in the top right corner of the table.
The Configure Columns selection panel opens.

◦ Select the checkboxes of the Payload and Protection Channel columns to add them to the
table display.

◦ To save, click .
The Configure Columns panel closes and you return to the list table.
◦ Locate the new LP trail. By default it appears at the bottom of the list.
In this example:
◦ The Label value (set by default) identifies the trail endpoints (NE, slot, rate, etc.).
◦ The Rate is LP.
◦ The Trail State is OK.
◦ The Payload is 10-GbE.
◦ The Main Channel is 193.0.
◦ The Protection Channel is 192.1.

Ribbon Communications Inc. Proprietary 495

 Apollo Workflows

Note
For further assistance, contact your local customer support representative.

Apollo Workflow: Edit Optical Trail: Frequency

This workflow provides a high level overview of the steps to edit an optical trail (frequency), in both directions
(bi-directional).
These are the two routes involved in this workflow:
• Original route: The route running from Site B through Site A to Site C (bi-directional).
• New route: The route running from Site B through Site A to Site D (bi-directional).
All steps in this workflow are performed at the LightSOFT level.
This is a sample workflow to illustrates the steps involved in editing an optical trail.

Note
In the steps of this workflow, we refer to frequencies either using the abbreviation CF, or in the context
of the corresponding representative optical trail, the OCH trail.

Ribbon Communications Inc. Proprietary 496

 Apollo Workflows

Editing an optical trail

Start
1. Open list of optical trails.
2. Select the OCH Trail to Edit.
3. Choose the New Route: Manual or Automatic.

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Ribbon Communications Inc. Proprietary 497

 Apollo Workflows

Open List of All Optical Trails

This procedure is the first step in editing an optical trail (see Edit Optical Trail: Frequency).
In this step you open a list of optical trails in the network.
Start
1. Working from the LightSOFT level, click the Topology Layer dropdown list.
2. Select the appropriate topology view from the list. In this example, select the Optical layer.
The appropriate topology view is displayed.
3. In the main window map, right-click the relevant link.
4. Select Show Trails > OCH to display the OCH trails relevant for that link.

The Trail List window opens, displaying only the OCH trails relevant for the selected link.

Select the OCH Trail to Edit

This procedure is the second step in editing an optical trail (see Edit Optical Trail: Frequency).
At this point you choose the OCH trail to edit.
In this step, we begin with the trail list window open listing all OCH trails relevant for the selected link.
Start
1. Right-click on the OCH trail you wish to edit. In this example there is only one OCH trail listed in the
window.
2. Select Edit > Edit Highlighted to open an edit window for that trail.

Ribbon Communications Inc. Proprietary 498

 Apollo Workflows

Choose the New Route: Manual or Automatic

This procedure is the third step in editing an optical trail (see Edit Optical Trail: Frequency).
At this point the Edit Trail window is open and you are ready to edit the selected trail.
In this step you delete the original OCH trail endpoint and replace it with a new endpoint.
This step can be completed either manually or automatically, using the automatic tools provided by
LightSOFT. In this workflow example we will present both options.

Edit the OCH trail

Start
1. To remove the original endpoint (Site C), select the Endpoints & Path tab.
2. Right-click the endpoint LE to be removed. In this workflow example in Site C.
3. Select Remove from the right-click menu.

Ribbon Communications Inc. Proprietary 499

 Apollo Workflows

4. To add a new endpoint (Site D), right-click the new endpoint LE to be added. In this workflow example
in Site D.
5. Select Select Endpoint from the right-click menu.

The Select Endpoint window opens.

6. Choose the relevant OCH port, and click X to close the window.

Ribbon Communications Inc. Proprietary 500

 Apollo Workflows

The endpoint on Site D is added to the endpoints list.

Manually remove the old path and choose the new path
Start
LightSOFT can automatically remove the old path and create the new path, in which case you don't need to
follow this procedure.
1. In the network map window, click on the old links to manually deselect these links and remove the old
path.
2. Then click on the new links required for the new path and select them for the new path.

Ribbon Communications Inc. Proprietary 501

 Apollo Workflows

3. Continue with the next step to complete the new trail.

Complete the new trail

Start
1. Click Complete for LightSOFT to check and verify the trail creation.
If you have not manually removed and added a link to the trail, LightSOFT automatically takes care of
it.

When the 'complete' process has been completed and the trail has been validated successfully, a
message window opens on the network map window.
2. Click OK to close the message window.
3. Click Activate to apply your changes and activate the new trail.

Ribbon Communications Inc. Proprietary 502

 Apollo Workflows

When the activation process has been completed, a message window opens on the network map
displaying the activation results.
The Endpoints & Path tab lists the new trail endpoints.

Apollo Workflow: Migrate Optical Trail: Insert Site

This workflow provides a high level overview of the steps to migrate an optical trail, adding an additional site
to the trail configuration. Optical trail migration is generally done when replacing ROADM modules, perhaps

Ribbon Communications Inc. Proprietary 503

 Apollo Workflows

when upgrading from one type of ROADM to another, or when inserting a new ROADM site or removing an
old site.
All steps in this workflow are performed at the LightSOFT level. In this sample workflow, we are focusing on
inserting a new ROADM site (Site A) between two existing ROADM sites (Site B and Site C).

Cautions
• The optical trail in this workflow example is currently carrying existing (provisioned) traffic.
Note that this is a traffic-affecting procedure.
• All trails that are participating in the migration process must be P2P trails. Any incomplete,
inconsistent, or flex trails must be fixed before beginning migration.
• Trail migration is not supported for WSON trails.

Current and target optical trails

Start
1. Set Original Trail Links to Maintenance Mode.
2. Create New Topology Links.
3. Replace Paths.
4. Validate and Complete Migration.

Ribbon Communications Inc. Proprietary 504

 Apollo Workflows

Note
Details for all procedures referenced in this document are available in the LightSOFT and STMS
Documentation Suites.

Set Original Trail Links to Maintenance Mode

This procedure is the first step in migrating an optical trail (see Migrate optical trail: insert site).
In this step we select the links to be replaced from the original trail path and put them into Maintenance
mode.
Start
1. Working from the LightSOFT level, click the Topology Layer dropdown list.
2. Select the appropriate topology view from the list. In this example, select the Optical layer.
The appropriate topology view is displayed.
3. In the Trails tab, click Migrate Trails.

Ribbon Communications Inc. Proprietary 505

 Apollo Workflows

The Migrate Trails window opens.

4. In the Migrate Trails window, in the topology map pane, click the path containing the original links.
The Select Old/New Links window opens, displaying the selected path and listing all links in the path.
In this workflow example, the path consists of only one link.
5. Mark the link that we will be removing as 'maintenance' with a check in the Maintenance column, and
click X to close the window.

Create New Topology Links

This procedure is the second step in migrating an optical trail (see Migrate optical trail: insert site).
In this step we create the new topology links between the sites that will be part of the new trail. In this
example we are creating three new links:

Ribbon Communications Inc. Proprietary 506

 Apollo Workflows

• An external link, from the ROADM LE in Site B, which was the starting point of the original path, to a
ROADM LE in Site A, which is being inserted into the path.
• An internal link, between two ROADM LEs in Site A.
• An external link, from the second ROADM in Site A to the ROADM LE in Site C , which was the
ending point of the original path.
Start
1. On the Migrate Trails window topology map, select the ROADM LE in Site B which is the path
starting point.
2. Hold the <Shift> key, and select the ROADM LE in Site A through which the new path will be running.

3. Click Create Topology Link in the Migrate Trails window toolbar.

The Create Topology Link window opens. The two panes display hierarchical tree structures
showing the objects, slots, and ports.
4. In this workflow example, the first link is an external link running between ROADM modules in Site B
and Site A, configured as follows:
◦ Select the OTS Line ports to connect the two ROADMs externally.
◦ Click Apply.

Ribbon Communications Inc. Proprietary 507

 Apollo Workflows

5. Repeat these steps to create a second, internal link running between two ROADM modules in Site A.
◦ Select the first ROADM LE in Site A.
◦ Select the second ROADM LE in Site A.
◦ Click Create Topology Link. The Create Topology Link window opens, displaying two hierarchical
tree structures showing the details of the two ROADM modules in the same site.
◦ Select the OTS Degree ports to connect the two ROADMs internally.
◦ Click Apply.
6. Repeat these steps to create the third, external link running between the second ROADM module in
Site A and a ROADM module in Site C.
◦ Select the second ROADM LE in Site A.
◦ Select the ROADM LE in Site C.
◦ Click Create Topology Link. The Create Topology Link window opens.
◦ Select the OTS Line ports to connect the two ROADMs externally.
◦ Click Apply.

Ribbon Communications Inc. Proprietary 508

 Apollo Workflows

Replace Paths
This procedure is the third step in migrating an optical trail (see Migrate optical trail: insert site).
In this step we replace the old path (running along the original topology links) with a new path, running along
the new topology links.
Start

1. In the Migrate Trails window, in the Replacement Paths List pane, click Add a Path .

A new path entry is added to the Replacement Paths List area.

2. Click the new path in the Replacement Paths List to select it.

3. In the Migrate Trails window, in the topology map pane, click the old link from the original path.
The Select Old/New Links window opens, displaying the selected path and listing all links in the path.
In this workflow example, the path consists of only one link.
4. Mark the link that we will be removing as 'Old' with a check in the Old column, and click X to close the
window.

Ribbon Communications Inc. Proprietary 509

 Apollo Workflows

5. In the Migrate Trails window, in the topology map pane, hold the <Shift> key and select the three new
links that we just created.
An abbreviated Select Old/New Links window opens, displaying 4 option buttons.
6. Select Add all as new, and click X to close the window.

A new path, consisting of the new links we configured between Site B, Site A, and Site C, has now been
defined.

Validate and Complete Migration

This procedure is the fourth step in migrating an optical trail (see Migrate optical trail: insert site).
In this step we validate the migration plan defined in the preceding steps, to ensure that all is in order and the
migration can be completed as planned. Notice that at this stage, the 'old' links from the original path are
displayed on the map in yellow, and the 'new' links are displayed in green.
Start

1. In the Migrate Trails window toolbar, click Validate Optical Trail Migration .

Ribbon Communications Inc. Proprietary 510

 Apollo Workflows

If the validation does not succeed, a message appears and the next step would be to check why the
validation failed.
If the validation succeeds, (as it does in this workflow), a Validation Succeeded message appears in
the Status/Results area on the Migrate Trails window toolbar, and a message window opens asking if
you wish to proceed with the actual migration.

2. Click Yes to begin the actual optical trail migration.

A second confirmation window opens, to confirm that the migration process should take place even
though the process will be traffic affecting.

Ribbon Communications Inc. Proprietary 511

 Apollo Workflows

3. Click Yes to proceed.

While the migration process is in progress, a progress bar is displayed in the Status/Results area on
the Migrate Trails window toolbar.

If the migration succeeds, a Migration Succeeded message appears in the Status/Results area on
the Migrate Trails window toolbar. The statuses of the trails are listed under the map area.

4. To delete the old (no longer in use) links, after the migration is complete, click Delete .
If the deletion succeeds, a Delete Succeeded message appears in the Status/Results area on the
Migrate Trails window toolbar.

Ribbon Communications Inc. Proprietary 512

 Apollo Workflows

The new topology is now in place and in use, with the migrated trail running through the new ROADM
modules that were added from Site A.

Ribbon Communications Inc. Proprietary 513