TL1 Command Reference Manual

®
mTera Universal Transport Platform
FP5.0
SONET

Revision B, January 2018

76.MTFP50/30

Coriant is continually striving to reduce the adverse environmental

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

FCC Notification Federal Communications Commission (FCC) Rules require that you be notified of the following:
Statement This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of
the FCC Rules. These limits are designed to provide reasonable protection against harmful interference when the
equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency
energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio
communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case
the user will be required to correct the interference at their own expense.
Changes or modifications not expressly approved by Coriant Operations, Inc., in writing can void the user’s authority to
operate the equipment.

Industry Canada Industry Canada interference-causing equipment regulations require that you be notified of the following:
Notification Statement This Class A digital apparatus complies with Canadian ICES-003.
Cet appareil numérique de la classe A est conforme à la norme NMB-003 du Canada.

Voluntary Control Council for

Interference (VCCI)

Copyright Statement This manual is protected by U.S. and international copyright laws, conventions, and treaties. Your right to use this
manual is subject to limitations and restrictions imposed by applicable licenses and copyright laws. Unauthorized
reproduction, modification, distribution, display or other use of this manual may result in criminal and civil penalties.

Trademark Notice The following trademarks and service marks are owned by Coriant Operations, Inc., or its affiliates in the United States
® ® ® ®
and/or other countries: CORIANT , , CORIANT DYNAMIC OPTICAL CLOUD , CORIANT TRANSCEND ,
® ™ ™ ™
mTera , Nano , Pico , TECHNOLOGY THAT TRANSFORMS THE WAY THE WORLD COMMUNICATES , YOUR
® ®
NETWORKING PARTNER , and XIEON NETWORKS . Any other company or product names may be trademarks of
their respective companies.

Important Notice on Product This product may present safety risks due to laser, electricity, heat, and other sources of danger.
Safety Only trained and qualified personnel may install, operate, maintain or otherwise handle this product and only after
having carefully read the safety information applicable to this product.
The safety information is provided in the “Safety Instructions”, part of this document or documentation set.

The same text in German:

Wichtiger Hinweis zur Von diesem Produkt können Gefahren durch Laser, Elektrizität, Hitzeentwicklung oder andere Gefahrenquellen
Produktsicherheit ausgehen.
Installation, Betrieb, Wartung und sonstige Handhabung des Produktes darf nur durch geschultes und qualifiziertes
Personal unter Beachtung der anwendbaren Sicherheitsanforderungen erfolgen.
Die Sicherheitsanforderungen finden Sie unter „Sicherheitshinweise“ dieses Dokuments oder dieses
Dokumentationssatzes.

Copyright © Coriant 2018. All rights reserved.

Page 2
TL1 Command Reference Manual Contents

Contents Page
Section 1 Introduction 30-1
Acronyms, Abbreviations, and Definitions........................................................ 30-1

Section 2 TL1 Message Structure and Functionality 30-6

Input Command Message Structure ................................................................ 30-6
Strings .............................................................................................................. 30-9
Time Format................................................................................................... 30-10
Acknowledgments .......................................................................................... 30-11
Output Response Message Structure ............................................................ 30-12
Parameter Order in Output Response Format ............................................... 30-14
Autonomous Messages.................................................................................. 30-15
TL1 Help Function .......................................................................................... 30-17
Access Identifiers ........................................................................................... 30-25

Section 3 Error Codes for TL1 Output Responses 30-52

Error Conditions ............................................................................................. 30-53
Supported Error Codes .................................................................................. 30-54
Comment Block Format For Control Plane Commands ................................. 30-79

Section 4 TL1 Provisionable Parameters 30-81

Default Attribute Values on Entity Creation .................................................... 30-81

Section 5 Alarm and Condition Tables 30-91

Equipment Alarm Table.................................................................................. 30-91
Facility Alarm Profile Table ............................................................................ 30-96
Logical Entity Alarm Profile Table ................................................................ 30-115
Condition Type ............................................................................................. 30-117
Direction Field Table .................................................................................... 30-126

Section 6 Guidelines for TL1 Input Command Messages 30-134

TL1 Input Command Headings .................................................................... 30-134
TL1 Command Interfaces............................................................................. 30-136
Conventions Used in this Manual................................................................. 30-136
Security and Administration ......................................................................... 30-138

Section 7 Telnet Session 30-142

Setting up a TL1 Telnet Session .................................................................. 30-142

Section 8 Activate Commands 30-152

ACT-USER ................................................................................................... 30-152

76.MTFP50/30, Rev B January 2018 Page 30-i

Contents TL1 Command Reference Manual

Contents Page
Section 9 Allow Commands 30-155
ALW-BKUPSCHED-MEM ............................................................................ 30-155
ALW-MSG-ALL ............................................................................................ 30-157
ALW-PKT-SNMPV2 ..................................................................................... 30-158
ALW-PMFILE-{X} ......................................................................................... 30-159
ALW-PMREPT-{X} ....................................................................................... 30-162

Section 10 Cancel Commands 30-164

CANC-USER ................................................................................................ 30-164

Section 11 Copy Commands 30-166

COPY-RFILE................................................................................................ 30-166

Section 12 Delete Commands 30-174

DLT-AAA ...................................................................................................... 30-174
DLT-BL ......................................................................................................... 30-176
DLT-CALL .................................................................................................... 30-178
DLT-CONN................................................................................................... 30-180
DLT-CRS-OCH ............................................................................................ 30-182
DLT-CRS-ODUk........................................................................................... 30-184
DLT-CRS-STSn ........................................................................................... 30-187
DLT-DA ........................................................................................................ 30-190
DLT-DB ........................................................................................................ 30-191
DLT-EPG...................................................................................................... 30-193
DLT-EQPT ................................................................................................... 30-195
DLT-EXDPATH ............................................................................................ 30-198
DLT-EXPPATH ............................................................................................ 30-199
DLT-FFP-HGE ............................................................................................. 30-201
DLT-FFP-OCn {OC3,OC12,OC48,OC192,OC768} ..................................... 30-203
DLT-FFP-STMn (STM1/STM4/STM16/STM64) ........................................... 30-205
DLT-FFP-TGLAN ......................................................................................... 30-207
DLT-FIBR-EQPT .......................................................................................... 30-209
DLT-FTPSERVER........................................................................................ 30-212
DLT-GCC ..................................................................................................... 30-213
DLT-IPPG..................................................................................................... 30-215
DLT-LABELSET ........................................................................................... 30-216
DLT-MGTETH .............................................................................................. 30-217
DLT-MGTINBANDETH ................................................................................ 30-219
DLT-NODE ................................................................................................... 30-220
DLT-NP ........................................................................................................ 30-222
DLT-NTPPEER ............................................................................................ 30-223
DLT-OCH ..................................................................................................... 30-224
DLT-ODUF ................................................................................................... 30-226
DLT-ODU0 ................................................................................................... 30-228
DLT-ODU1 ................................................................................................... 30-230
DLT-ODU2 ................................................................................................... 30-232
DLT-ODU2E................................................................................................. 30-234
DLT-ODU3 ................................................................................................... 30-236
DLT-ODU4 ................................................................................................... 30-238

Page 30-ii January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual Contents

Contents Page
DLT-ODUC2................................................................................................. 30-240
DLT-ODUC3................................................................................................. 30-242
DLT-OSCX ................................................................................................... 30-244
DLT-OSPF ................................................................................................... 30-246
DLT-OSPFADJ............................................................................................. 30-248
DLT-OSPFAREA.......................................................................................... 30-250
DLT-OSPFRP .............................................................................................. 30-252
DLT-OSPFRPMAP....................................................................................... 30-254
DLT-PPP ...................................................................................................... 30-255
DLT-RFILE ................................................................................................... 30-257
DLT-RSVP ................................................................................................... 30-258
DLT-SESSION ............................................................................................. 30-260
DLT-STAT-RTE............................................................................................ 30-262
DLT-SYNC ................................................................................................... 30-264
DLT-TL ......................................................................................................... 30-265
DLT-TNALNKMAP ....................................................................................... 30-267
DLT-TRAPIP ................................................................................................ 30-269
DLT-TSL....................................................................................................... 30-270
DLT-TTP-{x} ................................................................................................. 30-271
DLT-USER-SECU ........................................................................................ 30-273
DLT-VCG ..................................................................................................... 30-274
DLT-{X} ........................................................................................................ 30-276

Section 13 Edit Commands 30-279

ED-AAA........................................................................................................ 30-279
ED-ALMPF-{X} ............................................................................................. 30-281
ED-BL........................................................................................................... 30-284
ED-BL-MEMBER.......................................................................................... 30-286
ED-CALL ...................................................................................................... 30-290
ED-CPPF ..................................................................................................... 30-299
ED-CRS-OCH .............................................................................................. 30-303
ED-CRS-ODUk ............................................................................................ 30-305
ED-CRS-STSn (STS1/3C/12C/48C/192C) .................................................. 30-315
ED-DA .......................................................................................................... 30-320
ED-DB .......................................................................................................... 30-322
ED-DHCP..................................................................................................... 30-323
ED-EQPT ..................................................................................................... 30-326
ED-EXDPATH .............................................................................................. 30-332
ED-EXPPATH .............................................................................................. 30-335
ED-E1........................................................................................................... 30-339
ED-FFP-HGE ............................................................................................... 30-342
ED-FFP-OCn {OC3/OC12/OC48/OC192}.................................................... 30-344
ED-FFP-STMn (STM1/STM4/STM16/STM64)............................................. 30-346
ED-FFP-TGLAN ........................................................................................... 30-348
ED-FGE........................................................................................................ 30-350
ED-FTPSERVER ......................................................................................... 30-352
ED-GBEP ..................................................................................................... 30-354
ED-GCC ....................................................................................................... 30-357
ED-HGE ....................................................................................................... 30-359
ED-IP............................................................................................................ 30-361
ED-IPPG ...................................................................................................... 30-363
ED-LABELSET............................................................................................. 30-365

76.MTFP50/30, Rev B January 2018 Page 30-iii

Contents TL1 Command Reference Manual

Contents Page
ED-LINKPF .................................................................................................. 30-367
ED-MGTETH ................................................................................................ 30-373
ED-MGTINBANDETH .................................................................................. 30-375
ED-NE .......................................................................................................... 30-377
ED-NODE..................................................................................................... 30-387
ED-NP .......................................................................................................... 30-389
ED-NTPPEER .............................................................................................. 30-391
ED-OCH ....................................................................................................... 30-393
ED-OCn/STMn ............................................................................................. 30-405
ED-ODUF ..................................................................................................... 30-410
ED-ODU0 ..................................................................................................... 30-415
ED-ODU1 ..................................................................................................... 30-420
ED-ODU2 ..................................................................................................... 30-425
ED-ODU2E................................................................................................... 30-431
ED-ODU3 ..................................................................................................... 30-435
ED-ODU4 ..................................................................................................... 30-439
ED-ODUC2 .................................................................................................. 30-443
ED-ODUC3 .................................................................................................. 30-445
ED-OMS....................................................................................................... 30-447
ED-OTU1/OTU2/OTU4/OTUC2/OTUC3/TGLAN ......................................... 30-453
ED-OSC ....................................................................................................... 30-459
ED-OSCX..................................................................................................... 30-461
ED-OSPF ..................................................................................................... 30-463
ED-OSPFADJ .............................................................................................. 30-465
ED-OSPFAREA ........................................................................................... 30-467
ED-OSPFRP ................................................................................................ 30-469
ED-OTS........................................................................................................ 30-472
ED-PID ......................................................................................................... 30-477
ED-PMPF-{X} ............................................................................................... 30-480
ED-PPG-ODUk ............................................................................................ 30-482
ED-PPG-STSn ............................................................................................. 30-486
ED-PPP........................................................................................................ 30-488
ED-PPPPF ................................................................................................... 30-490
ED-PROXY .................................................................................................. 30-492
ED-RSVPADJ .............................................................................................. 30-493
ED-SECU-SYS............................................................................................. 30-495
ED-SLOT...................................................................................................... 30-498
ED-SLPF ...................................................................................................... 30-500
ED-SLPOLICY ............................................................................................. 30-506
ED-SNMP..................................................................................................... 30-508
ED-SNMP-COMMPREFIX ........................................................................... 30-510
ED-STAT-RTE ............................................................................................. 30-512
ED-STSn (for STS1/STS3C/STS12c/STS48C/STS192C) ........................... 30-514
ED-SYNC ..................................................................................................... 30-517
ED-TCPIP .................................................................................................... 30-520
ED-TL........................................................................................................... 30-524
ED-TSL ........................................................................................................ 30-529
ED-TTP-{x}................................................................................................... 30-532
ED-T1........................................................................................................... 30-534
ED-USER-SECU .......................................................................................... 30-537
ED-VCG ....................................................................................................... 30-545
ED-WARNING.............................................................................................. 30-548
ED-WCG ...................................................................................................... 30-550

Page 30-iv January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual Contents

Contents Page
Section 14 Enter Commands 30-552
ENT-AAA...................................................................................................... 30-552
ENT-BL ........................................................................................................ 30-554
ENT-CALL.................................................................................................... 30-558
ENT-CRS-OCH ............................................................................................ 30-567
ENT-CRS-ODUk .......................................................................................... 30-571
ENT-CRS-STSn (STS1/3C/12C/48C/192C) ................................................ 30-578
ENT-DA........................................................................................................ 30-594
ENT-EPG ..................................................................................................... 30-596
ENT-EQPT ................................................................................................... 30-598
ENT-EXDPATH ............................................................................................ 30-606
ENT-EXPPATH ............................................................................................ 30-609
ENT-E1 ........................................................................................................ 30-613
ENT-FFP-HGE ............................................................................................. 30-616
ENT-FFP-OCn{3,12,48,192} ........................................................................ 30-618
ENT-FFP-STMn (STM1/STM4/STM16/STM64) .......................................... 30-620
ENT-FFP-TGLAN ......................................................................................... 30-623
ENT-FGE ..................................................................................................... 30-625
ENT-FIBR-EQPT.......................................................................................... 30-627
ENT-FTPSERVER ....................................................................................... 30-633
ENT-GBEP ................................................................................................... 30-635
ENT-GCC ..................................................................................................... 30-638
ENT-HGE ..................................................................................................... 30-641
ENT-IPPG .................................................................................................... 30-643
ENT-LABELSET........................................................................................... 30-645
ENT-MGTETH.............................................................................................. 30-648
ENT-MGTINBANDETH ................................................................................ 30-650
ENT-NODE .................................................................................................. 30-652
ENT-NP........................................................................................................ 30-654
ENT-NTPPEER ............................................................................................ 30-656
ENT-OCH ..................................................................................................... 30-658
ENT-OCn/STMn/STSn ................................................................................. 30-670
ENT-ODUF................................................................................................... 30-677
ENT-ODU0 ................................................................................................... 30-683
ENT-ODU1 ................................................................................................... 30-688
ENT-ODU2 ................................................................................................... 30-694
ENT-ODU2E ................................................................................................ 30-700
ENT-ODU3 ................................................................................................... 30-705
ENT-ODU4 ................................................................................................... 30-709
ENT-ODUC2 ................................................................................................ 30-713
ENT-ODUC3 ................................................................................................ 30-715
ENT-OTU1/OTU2/OTU4/OTUC2/OTUC3/TGLAN....................................... 30-717
ENT-OSCX................................................................................................... 30-725
ENT-OSPF ................................................................................................... 30-727
ENT-OSPFADJ ............................................................................................ 30-729
ENT-OSPFAREA ......................................................................................... 30-731
ENT-OSPFRP .............................................................................................. 30-733
ENT-OSPFRPMAP ...................................................................................... 30-737
ENT-PPP...................................................................................................... 30-739
ENT-RSVP ................................................................................................... 30-741
ENT-STAT-RTE ........................................................................................... 30-743
ENT-SYNC ................................................................................................... 30-745
ENT-TL......................................................................................................... 30-747

76.MTFP50/30, Rev B January 2018 Page 30-v

Contents TL1 Command Reference Manual

Contents Page
ENT-TNALNKMAP....................................................................................... 30-761
ENT-TRAPIP ................................................................................................ 30-763
ENT-TSL ...................................................................................................... 30-765
ENT-TTP-{x}................................................................................................. 30-769
ENT-T1......................................................................................................... 30-771
ENT-USER-SECU........................................................................................ 30-774
ENT-VCG ..................................................................................................... 30-780

Section 15 Inhibit Commands 30-783

INH-BKUPSCHED-MEM .............................................................................. 30-783
INH-MSG-ALL .............................................................................................. 30-785
INH-PKT-SNMPV2 ....................................................................................... 30-786
INH-PMFILE-{X}........................................................................................... 30-787
INH-PMREPT-{X}......................................................................................... 30-790

Section 16 Initialize Commands 30-793

INIT-REG-{X} ............................................................................................... 30-793
INIT-SYS ...................................................................................................... 30-797

Section 17 Install Commands 30-800

INSTALL-CEF .............................................................................................. 30-800
INSTALL-SW................................................................................................ 30-802

Section 18 Measure Commands 30-804

MEAS-OPTPWR::{X} ................................................................................... 30-804

Section 19 Operate Commands 30-812

OPR-ACO-ALL ............................................................................................. 30-812
OPR-ADMREROUTE................................................................................... 30-813
OPR-ARC-{X}............................................................................................... 30-820
OPR-CPSW ................................................................................................. 30-823
OPR-EXT-CONT.......................................................................................... 30-826
OPR-FINDRTE............................................................................................. 30-827
OPR-LPBK-{X} ............................................................................................. 30-834
OPR-PING ................................................................................................... 30-837
OPR-PROTNSW-{x} .................................................................................... 30-839
OPR-SYNCSW ............................................................................................ 30-842
OPR-TRACE-ROUTE .................................................................................. 30-844
OPR-UPG-ABORT....................................................................................... 30-846
OPR-UPG-COMMIT..................................................................................... 30-848
OPR-UPG-EXECUTE .................................................................................. 30-850
OPR-UPG-PATCHAPPLY ........................................................................... 30-852

Section 20 Report - Autonomous Messages 30-853

REPT^ALM................................................................................................... 30-853
REPT^ALM^ENV ......................................................................................... 30-860

Page 30-vi January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual Contents

Contents Page
REPT^BKUP ................................................................................................ 30-864
REPT^DBCHG ............................................................................................. 30-866
REPT^EVT ................................................................................................... 30-870
REPT^EVT^CALL ........................................................................................ 30-877
REPT^EVT^FXFR ........................................................................................ 30-882
REPT^EVT^OPEDATA ................................................................................ 30-889
REPT^EVT^SESSION ................................................................................. 30-891
REPT^PM..................................................................................................... 30-893

Section 21 Release Commands 30-896

RLS-ARC-{X} ............................................................................................... 30-896
RLS-CPSW .................................................................................................. 30-899
RLS-EXT-CONT........................................................................................... 30-901
RLS-LPBK-{X}.............................................................................................. 30-902
RLS-PROTNSW-{x} ..................................................................................... 30-905
RLS-SYNCSW ............................................................................................. 30-908

Section 22 Retrieve Commands 30-909

RTRV-AAA ................................................................................................... 30-909
RTRV-ALM-{X}............................................................................................. 30-911
RTRV-ALM-ENV .......................................................................................... 30-917
RTRV-ALMGEN ........................................................................................... 30-921
RTRV-ALMPF-{X} ........................................................................................ 30-923
RTRV-AO ..................................................................................................... 30-927
RTRV-ARC-{X}............................................................................................. 30-929
RTRV-ATTN-OCH........................................................................................ 30-933
RTRV-ATTR-CONT ..................................................................................... 30-935
RTRV-ATTR-ENV ........................................................................................ 30-937
RTRV-BER ................................................................................................... 30-941
RTRV-BKUPSCHED-MEM .......................................................................... 30-944
RTRV-BL ...................................................................................................... 30-947
RTRV-BL-MEMBER ..................................................................................... 30-950
RTRV-CALL ................................................................................................. 30-952
RTRV-CALL-DETAIL ................................................................................... 30-959
RTRV-CEF ................................................................................................... 30-962
RTRV-COND-{X}.......................................................................................... 30-964
RTRV-CONN................................................................................................ 30-971
RTRV-CONN-INFO ...................................................................................... 30-975
RTRV-CONN-ROUTE .................................................................................. 30-978
RTRV-CPPF................................................................................................. 30-984
RTRV-CRS-OCH ......................................................................................... 30-986
RTRV-CRS-ODUk........................................................................................ 30-989
RTRV-CRS-STSn (STS1/STS3C/STS12C/STS48C/STS192C).................. 30-996
RTRV-DA ................................................................................................... 30-1000
RTRV-DB ................................................................................................... 30-1002
RTRV-DGNCP ........................................................................................... 30-1004
RTRV-DHCP .............................................................................................. 30-1006
RTRV-DISP-OCH....................................................................................... 30-1009
RTRV-ENGIDMAP ..................................................................................... 30-1011
RTRV-EPG................................................................................................. 30-1012
RTRV-EQPT .............................................................................................. 30-1014

76.MTFP50/30, Rev B January 2018 Page 30-vii

Contents TL1 Command Reference Manual

Contents Page
RTRV-ETH ................................................................................................. 30-1023
RTRV-EXDPATH ....................................................................................... 30-1025
RTRV-EXPPATH ....................................................................................... 30-1028
RTRV-EXT-CONT ...................................................................................... 30-1031
RTRV-E1 .................................................................................................... 30-1033
RTRV-FFP-HGE ........................................................................................ 30-1037
RTRV-FFP-OCn{OC3/OC12/OC48/OC192} .............................................. 30-1039
RTRV-FFP-STMn (STM1/STM4/STM16/STM64) ...................................... 30-1042
RTRV-FFP-TGLAN .................................................................................... 30-1044
RTRV-FIBR-EQPT ..................................................................................... 30-1046
RTRV-FPGAVER ....................................................................................... 30-1049
RTRV-FPGAVERMAP ............................................................................... 30-1053
RTRV-FTPSERVER................................................................................... 30-1055
RTRV-GAIN-OTS ....................................................................................... 30-1057
RTRV-GCC ................................................................................................ 30-1059
RTRV-HDR ................................................................................................ 30-1062
RTRV-INTIP-SLOT .................................................................................... 30-1063
RTRV-INV .................................................................................................. 30-1065
RTRV-IP..................................................................................................... 30-1070
RTRV-IPPG................................................................................................ 30-1072
RTRV-LABELSET ...................................................................................... 30-1074
RTRV-LADJ-TL .......................................................................................... 30-1076
RTRV-LEDS............................................................................................... 30-1078
RTRV-LINKPF............................................................................................ 30-1083
RTRV-LOG................................................................................................. 30-1085
RTRV-MGTETH ......................................................................................... 30-1090
RTRV-MGTINBANDETH ........................................................................... 30-1093
RTRV-NE ................................................................................................... 30-1095
RTRV-NETYPE .......................................................................................... 30-1100
RTRV-NODE .............................................................................................. 30-1102
RTRV-NODEIDMAP .................................................................................. 30-1104
RTRV-NP ................................................................................................... 30-1106
RTRV-NP-STATS ...................................................................................... 30-1108
RTRV-NTPPEER ....................................................................................... 30-1110
RTRV-OCH ................................................................................................ 30-1113
RTRV-ODUF .............................................................................................. 30-1127
RTRV-ODU0 .............................................................................................. 30-1132
RTRV-ODU1 .............................................................................................. 30-1137
RTRV-ODU2 .............................................................................................. 30-1142
RTRV-ODU2E............................................................................................ 30-1149
RTRV-ODU3 .............................................................................................. 30-1153
RTRV-ODU4 .............................................................................................. 30-1157
RTRV-ODUC2............................................................................................ 30-1162
RTRV-ODUC3............................................................................................ 30-1164
RTRV-OMS ................................................................................................ 30-1166
RTRV-OPEDATA ....................................................................................... 30-1171
RTRV-OPTPWR-OTS ................................................................................ 30-1173
RTRV-OSC ................................................................................................ 30-1175
RTRV-OSCX .............................................................................................. 30-1177
RTRV-OSPF .............................................................................................. 30-1179
RTRV-OSPFADJ........................................................................................ 30-1181
RTRV-OSPFAREA..................................................................................... 30-1184
RTRV-OSPFRP ......................................................................................... 30-1186
RTRV-OSPFRPMAP.................................................................................. 30-1189

Page 30-viii January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual Contents

Contents Page
RTRV-OTS ................................................................................................. 30-1190
RTRV-PM-{X}............................................................................................. 30-1195
RTRV-PMDAY ........................................................................................... 30-1221
RTRV-PMFILESCHED-{X}......................................................................... 30-1222
RTRV-PMMODE-{X} .................................................................................. 30-1225
RTRV-PMPF-{X} ........................................................................................ 30-1229
RTRV-PMPFUSE-{X} ................................................................................. 30-1232
RTRV-PMSCHED-{X} ................................................................................ 30-1234
RTRV-PPG-ODUk...................................................................................... 30-1238
RTRV-PPG-STSn ...................................................................................... 30-1243
RTRV-PPP ................................................................................................. 30-1246
RTRV-PPPPF ............................................................................................ 30-1248
RTRV-PROXY............................................................................................ 30-1250
RTRV-PTHTRC-OCH ................................................................................ 30-1251
RTRV-PTHTRC-ODUF .............................................................................. 30-1254
RTRV-PTHTRC-ODU0 .............................................................................. 30-1256
RTRV-PTHTRC-ODU1 .............................................................................. 30-1258
RTRV-PTHTRC-ODU2 .............................................................................. 30-1260
RTRV-PTHTRC-ODU2E ............................................................................ 30-1263
RTRV-PTHTRC-ODU3 .............................................................................. 30-1266
RTRV-PTHTRC-ODU4 .............................................................................. 30-1268
RTRV-PTHTRC-OTS ................................................................................. 30-1270
RTRV-PTHTRC-OTU1 ............................................................................... 30-1273
RTRV-PTHTRC-OTU2 ............................................................................... 30-1275
RTRV-PTHTRC-OTU4 ............................................................................... 30-1277
RTRV-PTHTRC-OTUC2 ............................................................................ 30-1279
RTRV-PTHTRC-OTUC3 ............................................................................ 30-1281
RTRV-RFILE .............................................................................................. 30-1283
RTRV-RSVP .............................................................................................. 30-1286
RTRV-RSVPADJ........................................................................................ 30-1288
RTRV-RTE-ALL ......................................................................................... 30-1290
RTRV-SECU-SYS ...................................................................................... 30-1294
RTRV-SESSION ........................................................................................ 30-1296
RTRV-SLOT............................................................................................... 30-1298
RTRV-SLPF ............................................................................................... 30-1303
RTRV-SLPOLICY....................................................................................... 30-1308
RTRV-SNMP .............................................................................................. 30-1310
RTRV-SNMP-COMM ................................................................................. 30-1312
RTRV-SNMP-COMMPREFIX .................................................................... 30-1314
RTRV-STAT-RTE....................................................................................... 30-1316
RTRV-SW .................................................................................................. 30-1318
RTRV-SWVER ........................................................................................... 30-1320
RTRV-SWVERMAP ................................................................................... 30-1323
RTRV-SYNC .............................................................................................. 30-1325
RTRV-T1 .................................................................................................... 30-1328
RTRV-TCA-{X} ........................................................................................... 30-1332
RTRV-TCAMODE-{X} ................................................................................ 30-1336
RTRV-TCE-TL............................................................................................ 30-1339
RTRV-TCPIP.............................................................................................. 30-1342
RTRV-TH-{X} ............................................................................................. 30-1345
RTRV-TL .................................................................................................... 30-1349
RTRV-TNALNKMAP .................................................................................. 30-1356
RTRV-TOD................................................................................................. 30-1358
RTRV-TRAPIP ........................................................................................... 30-1360

76.MTFP50/30, Rev B January 2018 Page 30-ix

Contents TL1 Command Reference Manual

Contents Page
RTRV-TSL.................................................................................................. 30-1362
RTRV-TTP-{x} ............................................................................................ 30-1366
RTRV-UPG-STATE.................................................................................... 30-1368
RTRV-USER-SECU ................................................................................... 30-1371
RTRV-VCG ................................................................................................ 30-1376
RTRV-VCG-MEMBER ............................................................................... 30-1381
RTRV-WARNING ....................................................................................... 30-1384
RTRV-WCG ............................................................................................... 30-1386
RTRV-{X} ................................................................................................... 30-1388

Section 23 Schedule Commands 30-1398

SCHED-BKUP-MEM .................................................................................. 30-1398
SCHED-PMFILE-{X} .................................................................................. 30-1401
SCHED-PMREPT-{X} ................................................................................ 30-1404

Section 24 Set Commands 30-1407

SET-ATTN-OCH ........................................................................................ 30-1407
SET-ATTR-CONT ...................................................................................... 30-1409
SET-ATTR-ENV ......................................................................................... 30-1411
SET-DAT .................................................................................................... 30-1415
SET-GAIN-OTS.......................................................................................... 30-1417
SET-OPTPWR-OTS................................................................................... 30-1419
SET-OPTTH-OCH...................................................................................... 30-1421
SET-PMDAY .............................................................................................. 30-1423
SET-PMMODE-{X}..................................................................................... 30-1424
SET-SID ..................................................................................................... 30-1427
SET-TCAMODE-{X} ................................................................................... 30-1429
SET-TH-{X} ................................................................................................ 30-1432

Section 25 Start Commands 30-1435

STA-ALMGEN............................................................................................ 30-1435
STA-BER.................................................................................................... 30-1437

Section 26 Stop Commands 30-1443

STP-ALMGEN............................................................................................ 30-1443
STP-BER.................................................................................................... 30-1444

Section 27 Switch Commands 30-1449

SW-DX-EQPT ............................................................................................ 30-1449

Page 30-x January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 1. Introduction

1. Introduction

1.01 This manual describes the TL1 command language of the mTera(R)
Universal Transport Platform.

Reason for Issue 1.02 This manual is reissued at Revision B to describe functionality for mTera
UTP FP5.0.x.

Acronyms, Abbreviations, and Definitions

1.03 Table 1.1 shows acronyms most commonly used in this document. This
table is not intended to define all the command/response parameters contained
herein. Refer to Section 2 for a list of all equipment and facilities.

Table 1.1 Acronyms Defined

Acronym Definition
ACO Alarm Cutoff

ACT Active

AID Access Identifier

AIP Alarm Interface Panel

AIS Alarm Indication Signal

ANR Abnormal

APS Automatic Protection Switching

ARC Alarm Reporting Control

atag Autonomous Message Tag

ATPS Auto Transmit Power Shutdown

AU Autonomous (Primary state qualifier possible value)

AUMA Autonomous-and-Management (Primary state qualifier possible value)

BER Bit Error Rate

BKUPMEM Backup Memory

CDCP Colorless/Directionless/Contentionless Pluggable

CEF Capability Extension File

ctag Correlation Tag

DATALINK Data Link

DAPI Destination Access Point Identifier

DCC Data Communication Channel

76.MTFP50/30, Rev B January 2018 Page 30-1

1. Introduction TL1 Command Reference Manual

Table 1.1 Acronyms Defined (Continued)

Acronym Definition
DCM Dispersion Compensation Module

DEA Deactivated (Secondary state possible value)

DPRING Dedicated Protection Ring

EQ Equipped

ES Errored Seconds

ESL Errored-Seconds Line

ESM Ethernet Switching Module

ESP Errored-Seconds Path

ESS Errored Seconds Section

ETH Ethernet facility interface

FCL Failure Count-Line

FCP Failure Count-Path

FEND Far End

FEPM Far End Performance Monitoring

FFP Facility Protection Group

FLT Fault

FP Feature Package

FSM Main Fiber Shuffle

GBEP Gigabit Ethernet facility

GFP Generic Framing Procedure

GMPLS Generalized Multi-protocol Label Switching

HGE Hundred Gigabit Ethernet Facility

INHALM Inhibit Alarm

INHLPBK Inhibit Loopback

INHSWPR Inhibit Protection Switching

IPG Inter-Packet Gap

IPPG IP Protection Group

IS In-Service

LOF Loss of Frame

LOS Loss of Signal

LPBK Loopback

LSP Label Switched Path

MA Management (Primary state qualifier possible value)

Page 30-2 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 1. Introduction

Table 1.1 Acronyms Defined (Continued)

Acronym Definition
MAANR Management-and-Abnormal (Primary state qualifier possible value)

MEA Mismatch of Equipment and Attributes (Secondary state possible

value)

MFAB mTera Fabric module

MFAB2 mTera Fabric module, 2nd generation

MT Maintenance (Secondary state possible value)

mTera Multi-Terabit shelf

NE Network Element - equipment on the network that originates/terminates

data traffic or amplifies the WDM optical signal

NEND Near End

NR Normal

OADMRS Route and Select Optical Add/Drop Multiplexer

OADMRS9 Route and Select Optical Add/Drop Multiplexer - 9

OCC Optical Carrier Card

OCH Optical Channel

OCHOS Optical Channel Optical Signal

OC-3 Optical Carrier level 3

OC-12 Optical Carrier level 12

OC-48 Optical Carrier level 48

OC-192 Optical Carrier level 192

ODU Optical Data Unit

OMD Optical Multiplexer/Demultiplexer

OOS Out-of-Service

OSC Optical Supervisory Channel facility

OSM-1S OTN Switching Module 1(SFP)

OSM-2C OTN Switching Module 2(CFP)

OSM-2S OTN Switching Module 2(SFP+)

OSM-4S OTN Switching Module 4(SFP+)

OSM-4C OTN Switching Module 4 (CFP2)

OSM-5C OTN Switching Module 5 (CFP2)

OSM-4F OTN Switching Module 4 (FLEXRATE)

OTUk Optical Transport Unit level k

OTS Optical Transmission Section (also used in “7100 OTS” to mean

Optical Transmission System)

PID Password Identifier

76.MTFP50/30, Rev B January 2018 Page 30-3

1. Introduction TL1 Command Reference Manual

Table 1.1 Acronyms Defined (Continued)

Acronym Definition
PM Performance Monitoring

PRSWWK Protect Switch to Working

PSI Payload Structure Identifier

PST Primary State

PSTQ Primary State Qualifier

PWR Power

RFI Remote Failure Indication

SAIM Shelf Alarm Interface Module

SAPI Source Access Point Identifier

SDM Shelf Display Module

SE Symbol Errors

SEFSS Severely Errored Frame Seconds Section

SEIM Shelf Ethernet Interface Module

SESL Severely Errored Seconds Line

SESP Severely Errored Seconds Path

SESS Severely Errored Seconds Section

SFM ShelfIO Filler Module

SGEO Supporting Entity Outage

SID System Identity

SIOM Shelf Input/Output Module

SLM Signal Label Mismatch

SNCP SubNetwork Connection Protection

SONET Synchronous Optical Network

SST Secondary State

STBY Standby

STIM Shelf Timing Interface Module

STM1 Synchronous Transport Module level 1

STM4 Synchronous Transport Module level 4

STM16 Synchronous Transport Module level 16

STM64 Synchronous Transport Module level 64

STPM Shelf Timing and Processor Module

STPM8 Shelf Timing and Processor Module: 8-slot mTera shelf

STS1 Synchronous Transport Signal level 1

Page 30-4 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 1. Introduction

Table 1.1 Acronyms Defined (Continued)

Acronym Definition
STS3C Synchronous Transport Signal level 3C

STS12C Synchronous Transport Signal level 12C

STS48C Synchronous Transport Signal level 48C

STS192C Synchronous Transport Signal level 192C

SYNC Synchronization

TCA Threshold Crossing Alert

TCP/IP Transmission Control Protocol/Internet Protocol

TGLAN Ten Gigabit LAN Ethernet facility

TRM Transponder

TTI Trail Trace Identifier

TTP Trail Termination Point

UTP Universal Transport Platform

VC3 Virtual container Level 3 (51 Mb/s)

VC4 Virtual container Level 4 (155 Mb/s)

VC4-4C Virtual container Level 4-4C (622 Mb/s)

VC4-16C Virtual container Level 4-16C (2.4 Gb/s)

VC4-64C Virtual container Level 4-64C (9.9 Gb/s)

WKSWPR Working Switch to Protect

76.MTFP50/30, Rev B January 2018 Page 30-5

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

2. TL1 Message Structure and Functionality

2.01 This section outlines the structure and the functionality of TL1 messages.
For additional information on TL1 message structure and functionality see
Telecordia GR-831-CORE, OTGR: Operations Application Messages-Language
For Operations Application Messages, Issue 1, November 1996. The TL1
messages described in this section include:
• input commands

• time format

• acknowledgments

• output responses

• autonomous messages

• TL1 Help function

• TL1 Verbs and Modifiers

• TL1 Access Identifiers

2.02 This section also includes tables listing the verbs, modifiers, and access
identifier formats used by the network elements.

Input Command Message Structure

2.03 A TL1 input command message originates from an operations system or
from a terminal session and is directed to a specific network element (NE). The
input command communicates the specific action that is to be executed at the
network element (NE). This section discusses the structure of a TL1 input
command and the functionality of its component parts. Refer to Figure 2.1.

Figure 2.1 Input Command General Structure

<verb>[-<mod1>[-<mod2>]]:[<tid>]:[<aid>]:<ctag>:
[<general block>]:<p1a>,<p1b>:<p2a>,<p2b>:...;

2.04 The verb and modifiers (mod1, mod2) make up the command code. The
command code determines the action to be taken at the NE as a result of receiving
the input command message. Each command must begin with a command code
consisting of a mandatory verb followed by up to two optional modifiers. Verbs and
modifiers are separated by hyphens.
2.05 The target identifier (tid), access identifier (aid), correlation tag block
(ctag), and general block make up the staging parameter blocks. The staging
parameter blocks provide information that uniquely identifies an object entity within
the NE. The staging block also specifies how the input command is executed.

Page 30-6 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

2.06 The last part of the TL1 input command is referred to as the message
payload. This part of the message may consist of either zero or more data blocks.
Each data block can have an unlimited number of data items or parameters. Each
data block is delimited by colons (:) and the last data block is terminated by a
semicolon (;).
2.07 Refer to the Input Command Elements Defined table below for more
information on the elements which make up the command code, the staging
blocks, and the message payload.

Table 2.1 Input Command Elements Defined

Element Description
verb The verb identifies the action to be taken at the NE as a result of receiving a TL1 message
from an operations system. A list of the TL1 verbs used in the NE is provided in Table 2.6,
page 30-18.

[mod1 The command code modifiers are optional depending upon the specific command and the
[mod2]] application domain. In normal TL1 command usage, the first modifier identifies the object of
the verb where the action is to be applied in the network element. The second modifier
further modifies the object of the verb and is interpreted differently for different operation
domains. The first modifiers are provided in Table 2.7, page 30-19. The second modifiers
are provided in Table 2.8, page 30-22.

[tid] The target identifier (tid) block identifies the end-target network element to which the input
command is directed.The tid can have either a null value or a string of up to 35
1
alphanumeric characters . The tid block is null when the target network element is directly
connected to the workstation or operations system that generated the TL1 command.
Where appropriate, the tid assumes a default value equal to the system identification (sid)
code.
Note: the tid value supports the hyphen ( - ), period (.) and underscore ( _ ) but does not
support spaces.

[aid] The access identifier (aid) block normally contains one or more parameters that uniquely
identifies the entity within the target network element to be acted upon by the input
command message. The general format of the aid is an alphanumeric string separated by
dashes. The aid is limited to 20 alphanumeric characters including the segment
deliminators. Aid formats are provided in Table 2.9, page 30-25. AIDs have to be entered in
either upper or lower case format.

ctag The correlation tag block (ctag) correlates a TL1 input command to its associated TL1
response. The ctag can be up to six alphanumeric characters long.

general block The general block consists of support parameters with values that affect the way the input
command is executed in the network element (NE). The general block can be empty,
position defined, or name defined. It can contain delayed activation order number, date, and
time, plus contingency flag, and an indirect data retrieval indicator. The general block may
be omitted altogether if no blocks follow it in the input command. The general parameter
block is not needed by NEs that perform signal transport.

<p1a>,<p1b>:< In this example there are three data blocks, each containing two parameter items. The
p2a>,<p2b>:<p3 parameter items within a data block may either be name-defined or position-defined.
a>,<p3b>;

76.MTFP50/30, Rev B January 2018 Page 30-7

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.1 Input Command Elements Defined (Continued)

Element Description
(-) The hyphen (-) is required to attach mod1 to the verb and mod2 to mod1.
(:) Colons (:) are used to separate data blocks which are also referred to as parameter blocks.
(,) Commas (,) are used to define and separate the parameter items within a parameter block.
(;) The semi colon (;) either terminates or gives an end point to the command.
([ ]) Brackets ([ ]) indicate the parameter is optional.
(|) The infix ( | ) operator means alternative, either the preceding or succeeding symbol may
‘’ occur, but not both in succession.
The ‘’ encloses a literal character.

Note 1: NE supports TID string up to 35 characters. If ex-Telecordia’s management system is to be used to

manage the NE, only use a TID string up to 20 characters as defined in GR-831-CORE.

Page 30-8 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Strings
2.08 Strings are case sensitive. Any value entered is taken exactly as typed.
2.09 All string parameters must be entered between quotes. The allowed
characters are listed in TL1 Quoted Allowable Characters table below.

Table 2.2 TL1 Quoted Allowable Characters

ASCII Characters Allowed in Quoted Text Strings
A-Z a-z 0-9 ! # $ %

' ( ) * + - .

/ _ ~ ^ <space> & =

@ [ ] ` { | }

\n \\

Note: `\n' is interpreted as a carriage return by the network element's TL1 parser.
Note: `" is interpreted as a back slash by the network element's TL1 parser.

76.MTFP50/30, Rev B January 2018 Page 30-9

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Time Format
2.10 As a general note, the time format on the NE for all Acknowledgments,
Output Responses and Autonomous Messages is displayed in Network Element
Local Time. This means that there is no offset displayed in the time stamps. The
time is still displayed in accordance to the Time Zone and the Daylight Saving
policies that have been set at the time of commissioning the NE in the Basic
Commissioning commands. These Time Zones and Daylights Saving policies can
be modified at any time from the EMS (Element Manager) when the Network
Element is communicating with the EMS. TL1 simply displays the current time
aligned with these set policies in the format YY-MM-DD HH:MM:SS (in 24 hour
format).
2.11 Time and date can also be changed on the NE using the SET-DAT
command.

Page 30-10 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Acknowledgments
2.12 There are three types of TL1 output messages: acknowledgments, output
response messages, and autonomous messages. This section describes the
structure of an acknowledgment message and the functionality of its component
parts. Refer to Figure 2.2.

Figure 2.2 Acknowledgment General Structure

<acknowledgment code>^<ctag><cr><lf>

2.13 An acknowledgment is a brief output message generated in response to

an input command message. In general, an acknowledgment is followed by an
output response. An acknowledgment message is generated when a response to
an input command cannot be transmitted within a time period of 2seconds of its
receipt. The general form of a normal TL1 acknowledgment consists of an
acknowledgment code and ctag. Refer to the Acknoledge Message Elements
Defined table below for additional information on acknowledgment messages.

Table 2.3 Acknowledgment Message Elements Defined

Element Definition
acknowledgment code The acknowledgment code identifies the reason for the acknowledgment. The NEs
use two acknowledgment codes: In Progress (IP) and Repeat Later (RL).

The NE sends an IP acknowledgment message when the system experiences a

delay of greater than 2 seconds. This acknowledgment implies the command is
being executed. The IP acknowledgments must be followed by either a completed
or denied output response message.

If the NE is unable to process the command due to unavailable system resources

caused by system overload, excessive queue lengths or busy programs, the RL
acknowledgment is sent. The command can be entered again later.

ctag The correlation tag block (ctag) correlates a TL1 command to its associated TL1
response. The ctag can be up to six alphanumeric characters long.

(^) The (^) indicates a space.

(<) The bold less than (<) character is the acknowledgment terminator.
(cr) Carriage returns are represented by cr.
(lf) Line feeds are represented by lf.

76.MTFP50/30, Rev B January 2018 Page 30-11

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Output Response Message Structure

2.14 A TL1 output response message is the response to a TL1 input command.
This section describes the structure of a TL1 output response message and the
functionality of its component parts. Refer to Figure 2.3.

Figure 2.3 Output Response General Message Structure

<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^
<hour>:<minute>:<second>
<cr><lf>M^^<ctag>^<completion code>
((<cr><lf>^^^<unquoted line>)|(<cr><lf>^^^<quoted line>)|
(<cr><lf>^^^<comment>))<cr><lf>(;|>)

2.15 The M, ctag, and completion code make up the response identification.
The response identification indicates whether a specific input message command
has been successfully executed. The NE support two types of output response
messages: completed and deny.
2.16 The text block consists of the unquoted line, the quoted line, and
comments. The text block is an optional component which provides information
specific to the particular output response message. Each component of the text
block may appear zero or more times within the same text block.
2.17 The last block in the output response message is the termination block.
Refer to the Output Response Message Parameters Defined table for more
information on the parameters which make up the header, response identification,
text block, and termination block.

Table 2.4 Output Response Message Parameters Defined

Parameter Definition
sid The sid is restricted to a maximum of 35 alphanumeric characters and identifies the
1
NE generating the message .

year-month-day The year, month, and day construct represents the date the command was executed.
The three date components are separated by hyphens (-). The year is specified by
two digits, and the month and day are each specified by two digits. For example, 01-
08-02 represents the second day of August in 2001.

hour:minute: The hour, minute, and second construct represents the time when the command is
second executed. The three time components are separated by colons (:). The hour
component can have a value of 00 to 23. The minute and second components can
have a value of 00 to 59. Two digits are used to specify each component. For
example, 15:05:00 represents five minutes past three hours in the afternoon.

M The character M signifies that the message is a response to an input command

message.

ctag The output response message has the same correlation tag (ctag) value as the
corresponding input command message for enabling the operations system to
associate the received output response message with a previously sent command.

completion code The completion code indicates whether or not the input command was completed
successfully. The NE uses completed (compld) and deny as completion codes.

The completion code (compld) indicates the input command has been successfully
executed.

The deny completion code represents total denial of the input command.

Page 30-12 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.4 Output Response Message Parameters Defined (Continued)

Parameter Definition
unquoted line The unquoted line consists of the name or position-defined parameters separated by
required white space (ws), and optional commas. Most commonly, an error code
occurs in the unquoted line. A list of all the error codes used by the NE is shown in
Table 3.4, page 30-57.

quoted line The quoted line consists of parsable text. The quoted line text is preceded and
followed by the double-quote character (“). The syntax of the parsable text is
equivalent to that of an input command message, for example, a series of colon-
delimited parameter blocks.

comment The comment component is used to allow free format text. The free form text must
always be preceded by a forward slash and asterisk (/*), and followed by an asterisk
and forward slash (*/).

(;) The form of the terminator is represented by the semicolon (;). The semicolon is used
to indicate the termination of the output response message.

(>) The “greater than” sign indicates that more output associated with this response
follows under another header. If the size of an output response message exceeds
4096 bytes, the output information is partitioned into multiple output response
messages. A continuation message, or subsequent message, needs to have another
header and response identification with the same <ctag>, along with an additional
<text block>. Each message is terminated by the greater than (>) character, except
the last message, which is terminated by the semicolon (;) character for indicating the
completion of the response. The (>) terminator is also used for intermediate
responses in a timed measurement series.

Note 1: NE supports SID string up to 35 characters. If ex-Telecordia’s management system is to be used to

manage the NE, only use a SID string up to 20 characters as defined in GR-831-CORE.

76.MTFP50/30, Rev B January 2018 Page 30-13

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Parameter Order in Output Response Format

2.18 The order in which name-defined parameters appear in the response
format in this document is only indicative and therefore may be sometimes different
from the actual response displayed by the real system. However, position-defined
parameter is always displayed in the same order.

Page 30-14 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Autonomous Messages
2.19 An autonomous message is sent from the 7100 OTS, 7100 Nano or mTera
NE to the appropriate operations system without having an explicit input command
message associated with it. This section describes the structure of autonomous
messages and the functionality of its component parts.
2.20 Conditions to initiate autonomous messages are either provisioned by the
user through the management station or set by default. Autonomous messages
occur as a result of one or more of the following conditions:
• reporting of alarms and events

• reporting of performance monitoring threshold crossing information

• reporting of a change in the NE database

• periodic reporting of selected conditions

Figure 2.4 Autonomous Message General Structure

<cr><lf><lf>^^^<sid>^<year>-<month>-<day>^<hour>:<minute>:<second>
<cr><lf><almcde>^<atag>^<verb>[^<mod1>[^<mod2>]]
((<cr><lf>^^^<unquoted line>)|(<cr><lf>^^^<quoted line>)|
(<cr><lf>^^^<comment>))+
<cr><lf>(;|>)

2.21 The sid, year, month, day, hour, minute, and second make up the header.
The header represents information common to all autonomous messages.
Throughout the document the header information is explicitly omitted and replaced
by the label "<header>".
2.22 The autonomous message identifier consists of the alarm code (almcde),
the atag, the verb, and modifiers (mod1 and mod2). This block identifies the
severity and the nature of the autonomous message.
2.23 The text block consists of the unquoted line, the quoted line, and
comments. The text block is an optional component which provides information
specific to the particular autonomous message. Each component of the text block
may appear one or more times within the text block.
2.24 The last block in the autonomous message is the terminator block. Refer
to the Autonomous Message Parameters Defined table for more information on the
parameters which make up the header, message identifier, text block, and
terminator block.

Table 2.5 Autonomous Message Parameters Defined

Parameter Definition
sid The sid is restricted to a 35 alphanumeric character maximum and identifies the NE
1
generating the message .

year-month-day The year, month, and day construct represents the date the command was executed.
The three date components are separated by hyphens (-). For example 01-08-03
represents the third day of August in 2001.

76.MTFP50/30, Rev B January 2018 Page 30-15

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.5 Autonomous Message Parameters Defined (Continued)

Parameter Definition
hour:minute: The hour, minute, and second construct represents the time when the command is
second executed. The three time components are separated by colons (:). The hour
component can have a value of 00 to 23. The minute and second components have a
value of 00 to 59. Two digits are used to specify each component. For example,
15:05:00 represents five minutes past three hours in the afternoon.

almcde The alarm code (almcde) indicates the severity of the autonomous message. Valid
values for almcde in decreasing order of severity are as follows:
*C (critical alarm)
** (major alarm)
*^ (minor alarm)
A^ (Automatic message or no alarm)
Critical, major, and minor correspond to the reporting of alarmed events. The non-
alarm message designation is used when the NE is reporting non-alarmed events,
periodic measurements, or results of previously scheduled diagnostics or audits. If
multiple alarms are reported in the same message, the alarm code with the highest
severity is reported.

atag The autonomously generated correlation tag (atag) is found in every autonomous
message. This number is a sequential number assigned by the NE. With every new
autonomous message the atag increases by one. The maximum number allowed is
999999999. After this number is reached, the atag restarts at zero.

verb The verb used in all autonomous messages is report (REPT).

[mod1 [mod2]] The autonomous message can have up to two optional modifiers. The first is used to
modify the verb. The second modifier is used to specify the object generating the
message. Refer to Table 2.7, page 30-19 and Table 2.8, page 30-22.

unquoted line The unquoted line consists of the name or position-defined parameters separated by
required whitespace (ws), and optional commas.

quoted line The quoted line consists of parsable text. The quoted line text is preceded and
followed by the double-quote character (“). The syntax of the parsable text is
equivalent to that of an input command message, for example, a series of colon-
delimited parameter blocks.

comment The comment component is used to allow free format text. The free form text is
always preceded by a forward slash and asterisk (/*) and followed by an asterisk and
forward slash (*/).

(;) The form of the terminator is represented by the semicolon (;) symbol. The semicolon
is used to indicate the termination of the output response message.

+ Post-fix operator means the preceding symbol or group of symbols may occur one or
more times.

(>) The “greater than” sign indicates that more output associated with this response is
followed under another header.

Note 1: NE supports SID string up to 35 characters. If ex-Telecordia’s management system is to be used to

manage the NE, only use a SID string up to 20 characters as defined in GR-831-CORE.

Page 30-16 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

TL1 Help Function

2.25 The TL1 application of the NE contains a useful help function. The help
function enables the user to know all possible TL1 commands that the Network
Element supports along with a description of the command structure and an
example for each command. The help function can be invoked at several levels
according to what input has been given at the command prompt. The help function
can be invoked by typing a question mark "?" directly at the command prompt to
retrieve the entire list of supported commands or at any time when entering the
VERB of a command to retrieve a more specific list of commands based on the
entered value of the VERB.

TL1 Help Function at the Command Prompt

2.26 To retrieve a list of all possible commands supported on the NE, type a
question mark "?" directly at the command prompt. This help structure displays all
possible command names. Following is an example of the output display.
At the command prompt enter "?":
CORIANT>?
Response is:
Ambiguous command, possible matches are:
ACT-USER
ALW-BKUPSCHED-MEM
ALW-MSG-ALL
ALW-PMREPT-ALL
ALW-PMREPT-EQPT
ALW-PMREPT-GBEP
ALW-PMREPT-OC12
ALW-PMREPT-OC192
ALW-PMREPT-OC3
ALW-PMREPT-OC48
ALW-PMREPT-OCH
ALW-PMREPT-OMS
ALW-PMREPT-OSC
---Type ? to continue or q to quit---........

TL1 Help Function at the VERB

2.27 A user can retrieve a limited number of commands that start with a
common portion of a VERB. This help function can be called by typing a question
mark "?" following any part of the typed VERB and displays all commands that
correspond to the entered portion of the VERB. The help structure displays all
command names and command structure. Following is an example of the output
display:

76.MTFP50/30, Rev B January 2018 Page 30-17

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

If a user enters "SET-?" at the command prompt, a display of all

commands that commence with the letters "SET" as part of their verb is
displayed:
>SET-?
Response is:
Ambiguous command, possible matches are:
SET-ATTN-OCH
SET-ATTR-CONT
SET-ATTR-ENV
SET-DAT
SET-GAIN-OTS
SET-OPTPWR-OTS
SET-OPTTH-OCH
SET-PMDAY
SET-PMMODE-EQPT
SET-PMMODE-GBEP
SET-PMMODE-OC12
SET-PMMODE-OC192
SET-PMMODE-OC3
SET-PMMODE-OC48
---Type ? to continue or q to quit---
To see the details of a specific command the user can enter, for example:
>SET-ATTN-OCH?
Response is:
SET-ATTN-OCH:[TID]:<och_aid>:[CTAG]:::ATTN=<attn>;

TL1 Message Verbs, Modifiers, and Access Identifiers

2.28 The verbs, modifiers, and access identifier formats used in the TL1
messages are provided in the tables that appear in this section.

Verbs
2.29 Table 2.6 lists all the verbs used in the TL1 messages.

Table 2.6 Verbs

Verb/Definition Verb/Definition
ACT Activate MEAS Measure

ALW Allow OPR Operate

CANC Cancel REPT1 Report

Page 30-18 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.6 Verbs (Continued)

Verb/Definition Verb/Definition
CPY Copy RLS Release

DISC Disconnect RTRV Retrieve

DLT Delete SCHED Schedule

ED Edit SET Set

ENT Enter STA Start

INH Inhibit STP Stop

INIT Initialize SW Switch

INSTALL Install

1. Found in autonomous messages only.

Modifiers
2.30 The first and second modifiers, including their definitions, are given in the
First Modifiers and Second Modifiers tables below. The first modifiers occur after
the verb. The verb and first modifier are separated by a hyphen. The second
modifier occurs after the first modifier. The first and second modifiers are separated
by a hyphen. Not all TL1 messages have a second modifier.

Table 2.7 First Modifiers

Name Definition
AAA Authentication Authorization and Accounting

ACO Alarm Cut Off

AO Autonomous Output

ALM Alarm

ALMPF Alarm Profile

ARC Alarm Reporting Control

ATTN Attenuation

ATTR Attribute

AUD Audit

BER Bit Error Rate

BKUP Backup

BKUPSCHED Backup Schedule

CEF Capability Extension File

CMD Command

CNAMETIDMAP Community Name to TID mapping

76.MTFP50/30, Rev B January 2018 Page 30-19

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.7 First Modifiers (Continued)

Name Definition
COND Performance Monitoring Condition

CRS Cross-Connection

DAT Date

DB Database

DBCHG Database Change

DX Duplex

EQPT Equipment

EVT Event

EXT External

FFP Facility Protection Group

FGE Forty Gigabit Ehternet

FTPSERVER FTP Server

HDR Header

GAIN Gain

GBEP Gigabit Ethernet

GCC General Communication Channel

HGE Hundred Gigabit Ethernet

IF Interface

INTIP Internal IP address

INV Inventory

LPBK Loopback

LEDS Light Emitting Diodes

LOG Log

MGTETH Management Ethernet Port

MSG Message

NE Network Element

NETYPE Network Element Type

NTPPEER Network Timing Protocol Peer

OC3 Optical Carrier Level 3 (SONET)

OC12 Optical Carrier Level 12 (SONET)

OC48 Optical Carrier Level 48 (SONET)

OC192 Optical Carrier Level 192 (SONET)

OCH Optical Channel

Page 30-20 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.7 First Modifiers (Continued)

Name Definition
ODUF Optical Data Unit, level flex (2.5 to 5 Gb/s)

ODU0 Optical Data Unit, level 0 (1.25 Gb/s)

ODU1 Optical Data Unit, level 1 (2.5 Gb/s)

ODU2 Optical Data Unit, level 2 (10 Gb/s)

ODU2E Optical Data Unit, level 2e (10.4 Gb/s)

ODU3 Optical Data Unit, level 3 (40.3 Gb/s)

ODU4 Optical Data Unit, level 4 (104.8 Gb/s)

ODUC2 Optical Data Unit level C2

ODUC3 Optical Data Unit level C3

OMS Optical Multiplex Section

OPTPATH Optical Path

OPTPWR Optical Power

OSC Optical Supervisory Channel

OSCX Optical Supervisory Channel Extended

OTS Optical Transmission Section

OTU1 Optical Transport Unit, level 1 (2.7 Gb/s)

OTU2 Optical Transport Unit, level 2 (10.7 Gb/s)

OTU4 Optical Transport Unit, level 4 (111.8 Gb/s)

OTUC2 Optical Transport Unit, level C2

OTUC3 Optical Transport Unit, level C3

PID Password ID

PM Performance Monitoring

PMDAY Performance Monitoring time-of-day

PMFILE Performance Monitoring binary File

PMFILESCHED Performance Monitoring binary File Schedule

PMMODE Performance Monitoring Mode

PMREPT Performance Monitoring Report

PMSCHED Performance Monitoring Schedule

PROTNSW Protection Switch

PTHTRC Path Trace

REG Register

RFILE Remote File

SECU Security

76.MTFP50/30, Rev B January 2018 Page 30-21

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.7 First Modifiers (Continued)

Name Definition
SESSION Session

SID System Identifier

SLOT Slot

SNMP Simple Network Management Protocol

STM1 Synchronous Transport Mode Level One (SDH)

STM4 Synchronous Transport Mode Level Four (SDH)

STM16 Synchronous Transport Mode Level Sixteen (SDH)

STM64 Synchronous Transport Mode Level Sixty-four (SDH)

STS1 Synchronous Transport Signal Level 1

STS3C Synchronous Transport Signal Level 3C

STS12C Synchronous Transport Signal Level 12C

STS48C Synchronous Transport Signal Level 48C

STS192C Synchronous Transport Signal Level 192C

SW Software

SYS System

TCA Threshold Crossing Alert

TCAMODE Threshold Crossing Alert Mode

TGLAN 10 Gigabit Ethernet LAN

TH Threshold

TOD Time Of Day Clock

UPG Upgrade

USER User

WARNING Warning message

Table 2.8 Second Modifiers

Name Definition
ABORT Abort

ALL All

BFM Blank Filler Module

CDCP Colorless/Directionless/Contentionless Pluggable

COMMIT Commit

CONT External Contacts

DCM Dispersion Compensation Module

Page 30-22 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.8 Second Modifiers (Continued)

Name Definition
ENV Environmental Alarms

ETH Ethernet port

EXECUTE Execute

FAN Fan

FSM Main Fiber Shuffle

FXFR Transfer

GBEP Gigabit Ethernet facility

HGE Hundred Gigabit Ehternet

INSTALL Install

MEM Memory

OADMRS Route and Select Optical Add/Drop Multiplexer

OADMRS9 Route and Select Optical Add/Drop Multiplexer - 9

OC3 Optical Carrier Level 3 facility

OC12 Optical Carrier Level 12 facility

OC48 Optical Carrier Level 48 facility

OC192 Optical Carrier Level 192 facility

OCC Optical Carrier Card

OCH Optical Channel

ODUF Optical Data Unit, level flex (2.5 to 5 Gb/s)

ODU0 Optical Data Unit, level 0 (1.25 Gb/s)

ODU1 Optical Data Unit, level 1 (2.5 Gb/s)

ODU2 Optical Data Unit, level 2 (10 Gb/s)

ODU2E Optical Data Unit, level 2e (10.4 Gb/s)

ODU3 Optical Data Unit, level 3 (40.3 Gb/s)

ODU4 Optical Data Unit, level 4 (104.8 Gb/s)

ODUC2 Optical Data Unit, level C2

ODUC3 Optical Data Unit, level C3

OMD Optical Multiplexer Demultiplexer

OMS Optical Multiplex section facility

OSC Optical Supervisory Channel facility

OTS Optical Transmission Section facility

OTU1 Optical Transport Unit, level 1 (2.7 Gb/s)

OTU2 Optical Transport Unit, level 2 (10.7 Gb/s)

76.MTFP50/30, Rev B January 2018 Page 30-23

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.8 Second Modifiers (Continued)

Name Definition
OTU4 Optical Transport Unit, level 4 (111.8 Gb/s)

OTUC2 Optical Transport Unit, level C2

OTUC3 Optical Transport Unit, level C3

PID Password Identifier

ROUTER Router

SECU Security

SESSION Session

SFP Small Form Pluggable Module

SFPP Small Form Pluggable Module Plus (SFP+)

SH Shelf

STM1 Synchronous Transport Mode Level 1

STM4 Synchronous Transport Mode Level 4

STM16 Synchronous Transport Mode Level 16

STM64 Synchronous Transport Mode Level 64

STS1 Synchronous Transport Signal Level 1

STS3C Synchronous Transport Signal Level 3C

STS12C Synchronous Transport Signal Level 12C

STS48C Synchronous Transport Signal Level 48C

STS192C Synchronous Transport Signal Level 192C

SYS System

TGLAN 10 Gigabit LAN Ethernet facility

Page 30-24 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Access Identifiers
2.31 The Aid Formats table below contains a complete list of all entity AIDs and
their format. An example AID is provided for each entity. AIDs are case insensitive.

Note: Please refer to ED-NE commands for a list of supported configurations.

Table 2.9 AID Formats

Entity Name Entity AID Format Format Values
Blank Filler Module BFM EntityID-ShelfID-SlotID EntityID = BFM
ShelfID = 20
Example: BFM-20-7 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

Colorless/ CD4D8 EntityID-ShelfID-SlotID EntityID = CD4D8

Directionless 4 ShelfID = 50 to 58 (PWS)
Degrees 8 Add/Drops Example: CD4D8-50-3 SlotID = 2 to 4, 6 to 8 (PWS)

Colorless/ CDCP EntityID-ShelfID-SlotID- EntityID = CDCP

Directionless/ SubslotID ShelfID = 20
Contentionless SlotID = 1 to 7, 10 to 16
Pluggable Example: CDCP-20-1-1 SubslotID = 1 to 3 (OCC)

C Form-factor CFP EntityID-ShelfID-SlotID- EntityID = CFP

Pluggable SubSlotID ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: CFP-20-2-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SubSlotID = 1 to 2 (OSM-2C)

C Form-factor CFP2 EntityID-ShelfID-SlotID- EntityID = CFP2

Pluggable 2 SubSlotID ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: CFP2-20-1-2 SlotID = 1 to 4, 7 to 10 (mTera-8)
SubSlotID = 1 to 4 (if OSM-4C)
SubSlotID = 1 to 5 (if OSM-5C, mTera)
SubSlotID = 1 to 4 (if OSM-5C, mTera-8)

Dispersion DCM EntityID-ShelfID-SlotID- EntityID = DCM

Compensation SubslotID ShelfID = 20
Module SlotID = 1 to 7, 10 to 16 (mTera)
Example: DCM-20-1-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SubslotID = 1 to 3

Fan Module FAN EntityID-ShelfID-SlotID EntityID = FAN

ShelfID = 20
Example: FAN-20-29 SlotID = 29 to 32

Fan Module - 8-slot FAN8 EntityID-ShelfID-SlotID EntityID = FAN8

mTera ShelfID = 20
Example: FAN8-20-16 SlotID = 16, 17

Fiber Shuffle - Main FSM EntityID-ShelfID-SlotID EntityID = FSM

ShelfID = 20
Example: FSM-20-34 SlotID = 34 to 35

76.MTFP50/30, Rev B January 2018 Page 30-25

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
mTera Fabric MFAB EntityID-ShelfID-SlotID EntityID = MFAB
Module Example: MFAB-20-8 ShelfID = 20
SlotID = 8, 9, 17-20 (mTera)
SlotID = 5, 6, 11, 12 (8-slot mTera)

mTera Fabric MFAB2 EntityID-ShelfID-SlotID EntityID = MFAB2

Module - 2nd Example: MFAB2-20-8 ShelfID = 20
Generation SlotID = 8, 9, 17-20 (mTera)
SlotID = 5, 6, 11, 12 (8-slot mTera)
mTera Fabric MFM EntityID-ShelfID-SlotID EntityID = MFM
Filler Module Example: MFM-20-8 ShelfID = 20
SlotID = 8, 9, 17-20 (mTera)
SlotID = 5, 6, 11, 12 (8-slot mTera)
Optical Add/Drop OADMRS EntityID-ShelfID-SlotID EntityID = OADMRS
Multiplexer Route ShelfID = 20
and Select Example: OADMRS-20-1 SlotID = 1 to 7, 10 to 16

Optical Add/Drop OADMRS9 EntityID-ShelfID-SlotID EntityID = OADMRS9

Multiplexer Route ShelfID = 20
and Select - 9 Example: OADMRS9-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

Optical Carrier Card OCC EntityID-ShelfID-SlotID EntityID = OCC

ShelfID = 20
Example: OCC-20-1 SlotID = 1 to 7, 10 to 16

Optical Multiplexer/ OMD EntityID-ShelfID-SlotID- EntityID = OMD

Demultiplexer SubslotID ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: OMD-20-14-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SubslotID = 1 (OMD48S, OMD44-1)
SubslotID = 2 (OMD48O, OMD44-45)

OTN Switching OSM1S EntityID-ShelfID-SlotID EntityID = OSM1S

Module 1 (SFP) ShelfID = 20
Example: OSM1S-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

OTN Switching OSM2C EntityID-ShelfID-SlotID EntityID = OSM2C

Module 2 (CFP) ShelfID = 20
Example: OSM2C-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

OTN Switching OSM2S EntityID-ShelfID-SlotID EntityID = OSM2S

Module 2 (SFP+) ShelfID = 20
Example: OSM2S-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

OTN Switching OSM4C EntityID-ShelfID-SlotID EntityID = OSM4C

Module 4 (CFP2) ShelfID = 20
Example: OSM4C-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (mTera-8)

OTN Switching OSM4F EntityID-ShelfID-SlotID EntityID = OSM4F

Module 4 (Flexrate) ShelfID = 20
Example: OSM4F-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (mTera-8)

Page 30-26 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
OTN Switching OSM4S EntityID-ShelfID-SlotID EntityID = OSM1S
Module 4 (SFP+) ShelfID = 20
Example: OSM4S-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

OTN Switching OSM5C EntityID-ShelfID-SlotID EntityID = OSM5C

Module 5 (CFP2) ShelfID = 20
Example: OSM5C-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

Passive WDM Shelf PWS EntityID-ShelfID EntityID = PWS

Example: PWS-50 ShelfID = 50 to 58

Shelf Alarm SAIM EntityID-ShelfID-SlotID EntityID = SAIM

Interface Module ShelfID = 20
Example: SAIM-20-22 SlotID = 22

Shelf Display Module SDM EntityID-ShelfID-SlotID EntityID = SDM

ShelfID = 20
Example: SDM-20-33 SlotID = 33

Shelf Ethernet SEIM EntityID-ShelfID-SlotID EntityID = SEIM

Interface Module ShelfID = 20
Example: SEIM-20-21 SlotID = 21, 28

ShelfIO Filler SFM EntityID-ShelfID-SlotID EntityID = SFM

Module ShelfID = 20
Example: SFM-20-21 SlotID = 21-23, 26-28

Small Form SFP EntityID-ShelfID-SlotID- EntityID = SFP

Pluggable Module SubslotID ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: SFP-20-7-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SubslotID = 1-32 (OSM-1S)
SubslotID = 7-30 (SSM-2S)

Small Form SFPP EntityID-ShelfID-SlotID- EntityID = SFPP

Pluggable Module SubslotID ShelfID = 20
Enhanced SlotID = 1 to 7, 10 to 16 (mTera)
Example: SFPP-20-3-2 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SubslotID = 1 to 20 (OSM2S)
SubslotID = 1 to 6 (SSM-2S)
SubSlotID = 1 to 40 (OSM4S)

Shelf SH EntityID-ShelfID EntityID = SH

ShelfID = 20
Example:SH-20

Shelf Input Output SIOM EntityID-ShelfID-SlotID EntityID = SIOM

Module ShelfID = 20
Example: SIOM-20-15 SlotID = 15
Equipment Slot SLOT EntityID-ShelfID-SlotID EntityID = SLOT

EntityID-ShelfID-SlotID- ShelfID = 20
SubslotID ShelfID = 50 to 58 (PWS)
SlotID = 1 to 35 (mTera)
Example: SLOT-20-10 SlotID = 1 to 15, 34, 35 (8-slot mTera)
SLOT-20-10-6 (SFP) SlotID = 1 to 8 (PWS)
SubslotID = 1 to 32

76.MTFP50/30, Rev B January 2018 Page 30-27

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Sonet/SDH Switching SSM2S EntityID-ShelfID-SlotID EntityID = SSM2S
Module 2 (SFP/ ShelfID = 20
SFP+) Example: SSM2S-20-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)

Shelf Timing STIM EntityID-ShelfID-SlotID EntityID = STIM

Interface Module ShelfID = 20
Example: STIM-20-26 SlotID = 23, 26
Shelf Timing and STPM EntityID-ShelfID-SlotID EntityID = STPM
Processor Module Example: STPM-20-24 ShelfID = 20
SlotID = 24, 25

Shelf Timing and STPM8 EntityID-ShelfID-SlotID EntityID = STPM8

Processor Module - Example: STPM8-20-13 ShelfID = 20
8-slot mTera SlotID = 13, 14
All Entities ALL EntityID EntityID = ALL
Example: ALL

Alarm Profile Table ALMPF EntityID-TBLID EntityID = ALMPF

Example: ALMPF-99 TBLID = 0, 1-20, 99

Bundled Link BL EntityID-NPID-NodeNum-BLID EntityID = BL

NPID = 1, 3
Example BL-3-2-1 NodeNum = 1 to 512
TLID = 1 to 500

CALL CALL EntityID-NPID-CallNum Entity ID = CALL

NPID = 1, 3
Example: CALL-3-120 CallNum = 1..4294967295.
A maximum of 5000 calls per NE is
supported. Initial allocation of CallNum
is sequential.

External Output CONT EntityID-ContID EntityID = CONT

Contact ContID = 1-2
Example: CONT-1

Control Plane CPPF EntityID-CPPFID EntityID = CPPF

Protocol Profile CPPFID = 1 to 20, 94-99
Example: CPPF-1

Discovery Agent DA EntityID-DAID EntityID = DA

DAID = 1
Example: DA-1

Database DB EntityID-DBID EntityID = DB

DBID = 1
Example: DB-1

Environmental Input ENV EntityID-EnvID EntityID = ENV

Alarm Contact EnvID = 1-5
Example: ENV-1

Page 30-28 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Ethernet facility ETH EntityID-ShelfID-SlotID-PortID EntityID = ETH
ShelfID = 20
Example: ETH-20-14-4 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 2 (OSM-2C)
PortID = 1 to 20 (OSM-2S)
PortID = 1 to 32 (OSM-1S)

Excluded Path EXDPATH EntityID-NPID-PathID EntityID = EXDPATH

NPID = 1, 3
Example: EXDPATH-3-1 PathID = 1 to 512

Explicit Path EXPPATH EntityID-NPID-PathID EntityID = EXPPATH

Example EXPPATH-3-1 NPID = 1, 3
PathID = 1 to 512

Values of 1 to 512 are user created.

40GE Facility FGE EntityID-ShelfID-SlotID-PortID EntityID = FGE

ShelfID = 20
Example: FGE-20-2-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 2 (OSM-2C)

FTP Server FTPSERVE EntityID-FTPSERVERID EntityID = FTPSERVER

R FTPSERVERID=1
Example: FTPSERVER-1

Gigabit Ethernet GBEP EntityID-ShelfID-SlotID-PortID EntityID = GBEP

Facility ShelfID = 20
Example: GBEP-20-7-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 32 (OSM-1S)

GCC0 Entity GCC0 EntityID-ShelfID-SlotID-PortID EntityID = GCC0

ShelfID = 20
Example: GCC0-20-2-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20 (OSM-2S)
PortID = 1 to 2 (OSM-2C)
PortID = 1 to 32 (OSM-1S)
PortID = 1 to 4 (OSM-4C)
PortID = 1 to 2 (OSM-4F)
PortID = 1 to 40 (OSM-4S)
PortID = 1 to 5 (OSM-5C, mTera)
PortID = 1 to 4 (OSM-5C, mTera-8)

76.MTFP50/30, Rev B January 2018 Page 30-29

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
GCC1 Entity GCC1 EntityID-ShelfID-SlotID-PortID[- EntityID = GCC1
<SupportingODU4><Supporting
ODU4 TributaryPort>][- ShelfID = 20
<Supporting SlotID = 1 to 7, 10 to 16 (mTera)
ODUtype><Supporting ODU SlotID = 1 to 4, 7 to 10 (8-slot mTera)
Tributary Port>][-<ODUtype PortID = 1 to 20 (OSM-2S)
><ODUTribPort>] PortID = 1 to 2 (OSM-2C)
PortID = 1 to 4 (OSM-4C)
Example: PortID = 1 to 2 (OSM-4F)
PortID = 1 to 40 (OSM-4S)
GCC1-20-1-1-A4 PortID = 1 to 5 (OSM-5C, mTera)
GCC1 created on ODU1-20-1-1- PortID = 1 to 4 (OSM-5C, mTera-8)
4 on OSM-2S
SupportingODU4 = D(ODU4) (OSM-4F)
GCC1-20-2-1-C1-Z1 SupportingODU4 TributaryPort = 1 to 2
GCC1 created on ODU0-20-2-1- (OSM-4F, 200G16QAM)
C1-1 on OSM-2C SupportingODU4 TributaryPort = 1 to 3
(OSM-4F, 2X150G8QAM)
GCC1-20-2-1-D1-C1-Z1
GCC1 created on ODU0-20-2-1- Supporting ODUtype ID = B(ODU2),
D1-C1-1 on OSM-4F where port C(ODU3) (OSM-2C, OSM-4F, OSM-4C,
1 is configured with OSM-5C)
200G16QAM. The ODU0 is Supporting ODU Tributary Port = 1 to 80
multiplexed into ODU3, which in (OSM-2C, OSM-4F, OSM-4C, OSM-4S,
turn is multiplexed into ODU4#1 OSM-5C)
within the ODUC2.
Supporting ODUtype ID = A(ODU1)
GCC1-20-2-1-D1-C1 (OSM-4S)
GCC1 created on ODU3-20-2-1- Supporting ODU Tributary Port = 1 to 4
D1-1 on OSM-4F where port 1 is (OSM-4S)
configured with 200G16QAM.
The ODU3 is multiplexed into the
first ODU4 of the ODUC2. ODUtype = A(ODU1), B(ODU2),
C(ODU3), E(ODU2e), Z(ODU0),
GCC1-20-2-1-D1 F(ODUF) (OSM-2C, OSM-4F, OSM-4C,
GCC1 created on ODU4-20-2-1- OSM-5C), ODUTribPort = 1 to 80 (OSM-
1 on OSM-4F where port 1 is 2C, OSM-4F, OSM-4C, OSM-5C)
configured with 200G16QAM.
The ODU4 is the first ODU4 of ODUtype = A(ODU1), Z(ODU0),
the ODUC2. F(ODUF) (OSM-2S),ODUTribPort = 1 to
4 (OSM-2S)
GCC1-20-2-1
GCC1 created on ODU4-20-2-1 ODUtype = D(ODU4) (OSM-
on OSM-4F where port 1 is 4F),ODUTribPort = 1 to 3 (OSM-4F)
configured with 100GQPSK.

GCC1-20-2-1-D3
GCC1 created on ODU4-20-2-1-
1 on OSM-4F where port 1 and
port 2 are configured with
2X150G8QAM. The ODU4 is the
third ODU4 of the ODUC3. When
ODUC3 is used, PortID must be
1.

Page 30-30 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
GCC1 Entity (cont’d) Note:
1.For GCC created on ODU associated
with a client port, the ODUTribPort is not
used.
2. ODUtype is not used for the HO ODUk
associated with an OTUk/OCH-P/OCH-
OS.
3.Supporting ODUtype and Supporting
ODU Tributary Port are only used for 2-
stage or 3-stage ODU multiplexing.
4.On the OSM-2C, OSM-4C, OSM-4F
and OSM-5C, when there is no
Supporting ODUType, the ODUTribPort
range is 1 to 80.
When the SupportingODUType is C, and
the supported ODUType is F, Z, E, the
ODUTribPort range is 1 to 32.
When the SupportingODUType is C, and
the supported ODUType is B, the
ODUTribPort range is 1 to 4.
When the SupportingODUType is C, and
the supported ODUType is A, the
ODUTribPort range is 1 to 16.
When the SupportingODUType is B, and
the supported ODUType is F or Z, the
ODUTribPort range is 1 to 8.
When the SupportingODUType is B, and
the supported ODUType is A, the
ODUTribPort range is 1 to 2.
When the SupportingODUType is A, and
the supported ODUType is F or Z, the
ODUTribPort range is 1 to 2.
5.When the port of an OSM-4F is
configured with modulation format
200G16QAM, and when ODUtype is
D(ODU4), the ODUTribPort range is 1 to
2.
6.When the port of an OSM-4F is
configured with modulation format
2X150G8QAM, and when ODUtype is
D(ODU4), the ODUTribPort range is 1 to
3.

76.MTFP50/30, Rev B January 2018 Page 30-31

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
GCC2 Entity GCC2 EntityID-ShelfID-SlotID-PortID[- EntityID = GCC2
<SupportingODU4><Supporting
ODU4 TributaryPort>][- ShelfID = 20
<Supporting SlotID = 1 to 7, 10 to 16 (mTera)
ODUtype><Supporting ODU SlotID = 1 to 4, 7 to 10 (8-slot mTera)
Tributary Port>][-<ODUtype PortID = 1 to 20 (OSM-2S)
><ODUTribPort>] PortID = 1 to 2 (OSM-2C)
PortID = 1 to 4 (OSM-4C)
Example: PortID = 1 to 2 (OSM-4F)
PortID = 1 to 40 (OSM-4S)
GCC2-20-1-1-A4 PortID = 1 to 5 (OSM-5C, mTera)
GCC2 created on ODU1-20-1-1- PortID = 1 to 4 (OSM-5C, mTera-8)
4 on OSM-2S
SupportingODU4 = D(ODU4) (OSM-4F)
GCC2-20-2-1-C1-Z1 SupportingODU4 TributaryPort = 1 to 2
GCC2 created on ODU0-20-2-1- (OSM-4F, 200G16QAM)
C1-1 on OSM-2C SupportingODU4 TributaryPort = 1 to 3
(OSM-4F, 2X150G8QAM)
GCC2-20-2-1-D1-C1-Z1
GCC2 created on ODU0-20-2-1- Supporting ODUtype ID = B(ODU2),
D1-C1-1 on OSM-4F where port C(ODU3) (OSM-2C, OSM-4F, OSM-4C,
1 is configured with OSM-5C)
200G16QAM. The ODU0 is Supporting ODU Tributary Port = 1 to 80
multiplexed into ODU3, which in (OSM-2C, OSM-4F, OSM-4C, OSM-4S,
turn is multiplexed into ODU4#1 OSM-5C)
within the ODUC2.
Supporting ODUtype ID = A(ODU1)
GCC2-20-2-1-D1-C1 (OSM-4S)
GCC2 created on ODU3-20-2-1- Supporting ODU Tributary Port = 1 to 4
D1-1 on OSM-4F where port 1 is (OSM-4S)
configured with 200G16QAM.
The ODU3 is multiplexed into the
first ODU4 of the ODUC2. ODUtype = A(ODU1), B(ODU2),
C(ODU3), E(ODU2e), Z(ODU0),
GCC2-20-2-1-D1 F(ODUF) (OSM-2C, OSM-4F, OSM-4C,
GCC2 created on ODU4-20-2-1- OSM-5C), ODUTribPort = 1 to 80 (OSM-
1 on OSM-4F where port 1 is 2C, OSM-4F, OSM-4C, OSM-5C)
configured with 200G16QAM.
The ODU4 is the first ODU4 of ODUtype = A(ODU1), Z(ODU0),
the ODUC2. F(ODUF) (OSM-2S),ODUTribPort = 1 to
4 (OSM-2S)
GCC2-20-2-1
GCC2 created on ODU4-20-2-1 ODUtype = D(ODU4) (OSM-
on OSM-4F where port 1 is 4F),ODUTribPort = 1 to 3 (OSM-4F)
configured with 100GQPSK.

GCC2-20-2-1-D3
GCC2 created on ODU4-20-2-1-
1 on OSM-4F where port 1 and
port 2 are configured with
2X150G8QAM. The ODU4 is the
third ODU4 of the ODUC3. When
ODUC3 is used, PortID must be
1.

Page 30-32 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
GCC2 Entity (cont’d) Note:
1.For GCC created on ODU associated
with a client port, the ODUTribPort is not
used.
2. ODUtype is not used for the HO ODUk
associated with an OTUk/OCH-P/OCH-
OS.
3.Supporting ODUtype and Supporting
ODU Tributary Port are only used for 2-
stage or 3-stage ODU multiplexing.
4.On the OSM-2C, OSM-4C, OSM-4F
and OSM-5C, when there is no
Supporting ODUType, the ODUTribPort
range is 1 to 80.
When the SupportingODUType is C, and
the supported ODUType is F, Z, E, the
ODUTribPort range is 1 to 32.
When the SupportingODUType is C, and
the supported ODUType is B, the
ODUTribPort range is 1 to 4.
When the SupportingODUType is C, and
the supported ODUType is A, the
ODUTribPort range is 1 to 16.
When the SupportingODUType is B, and
the supported ODUType is F or Z, the
ODUTribPort range is 1 to 8.
When the SupportingODUType is B, and
the supported ODUType is A, the
ODUTribPort range is 1 to 2.
When the SupportingODUType is A, and
the supported ODUType is F or Z, the
ODUTribPort range is 1 to 2.
5.When the port of an OSM-4F is
configured with modulation format
200G16QAM, and when ODUtype is
D(ODU4), the ODUTribPort range is 1 to
2.
6.When the port of an OSM-4F is
configured with modulation format
2X150G8QAM, and when ODUtype is
D(ODU4), the ODUTribPort range is 1 to
3.

76.MTFP50/30, Rev B January 2018 Page 30-33

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
GCC12 Entity GCC12 EntityID-ShelfID-SlotID-PortID[- EntityID = GCC12
<SupportingODU4><Supporting
ODU4 TributaryPort>][- ShelfID = 20
<SupportingODUtype><Supporti SlotID = 1 to 7, 10 to 16 (mTera)
ng ODU Tributary Port>][- SlotID = 1 to 4, 7 to 10 (8-slot mTera)
<ODUtype><ODUTribPort>] PortID = 1 to 20 (OSM-2S)
PortID = 1 to 2 (OSM-2C)
Example: PortID = 1 to 4 (OSM-4C)
PortID = 1 to 2 (OSM-4F)
GCC12-20-1-1-A4 PortID = 1 to 40 (OSM-4S)
GCC12 created on ODU1-20-1- PortID = 1 to 5 (OSM-5C, mTera)
1-4 on OSM-2S PortID = 1 to 4 (OSM-5C, mTera-8)

GCC12-20-2-1-C1-Z1 SupportingODU4 = D(ODU4) (OSM-4F)

GCC12 created on ODU0-20-2- SupportingODU4 TributaryPort = 1 to 2
1-C1-1 on OSM-2C (OSM-4F, 200G16QAM)
SupportingODU4 TributaryPort = 1 to 3
GCC12-20-2-1-D1-C1-Z1 (OSM-4F, 2X150G8QAM)
GCC12 created on ODU0-20-2-
1-D1-C1-1 on OSM-4F where Supporting ODUtype ID = B(ODU2),
port 1 is configured with C(ODU3) (OSM-2C, OSM-4F, OSM-4C,
200G16QAM. The ODU0 is OSM-5C)
multiplexed into ODU3, which in Supporting ODU Tributary Port = 1 to 80
turn is multiplexed into ODU4#1 (OSM-2C, OSM-4F, OSM-4C, OSM-4S,
within the ODUC2. OSM-5C)

GCC12-20-2-1-D1-C1 Supporting ODUtype ID = A(ODU1)

GCC12 created on ODU3-20-2- (OSM-4S)
1-D1-1 on OSM-4F where port 1 Supporting ODU Tributary Port = 1 to 4
is configured with 200G16QAM. (OSM-4S)
The ODU3 is multiplexed into the
first ODU4 of the ODUC2.
ODUtype = A(ODU1), B(ODU2),
GCC12-20-2-1-D1 C(ODU3), E(ODU2e), Z(ODU0),
GCC12 created on ODU4-20-2- F(ODUF) (OSM-2C, OSM-4F, OSM-4C,
1-1 on OSM-4F where port 1 is OSM-5C), ODUTribPort = 1 to 80 (OSM-
configured with 200G16QAM. 2C, OSM-4F, OSM-4C, OSM-5C)
The ODU4 is the first ODU4 of
the ODUC2. ODUtype = A(ODU1), Z(ODU0),
F(ODUF) (OSM-2S),ODUTribPort = 1 to
GCC12-20-2-1 4 (OSM-2S)
GCC12 created on ODU4-20-2-1
on OSM-4F where port 1 is ODUtype = D(ODU4) (OSM-
configured with 100GQPSK. 4F),ODUTribPort = 1 to 3 (OSM-4F)

GCC12-20-2-1-D3
GCC12 created on ODU4-20-2-
1-1 on OSM-4F where port 1 and
port 2 are configured with
2X150G8QAM. The ODU4 is the
third ODU4 of the ODUC3. When
ODUC3 is used, PortID must be
1.

Page 30-34 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
GCC12 Entity Note:
(cont’d) 1.For GCC created on ODU associated
with a client port, the ODUTribPort is not
used.
2. ODUtype is not used for the HO ODUk
associated with an OTUk/OCH-P/OCH-
OS.
3.Supporting ODUtype and Supporting
ODU Tributary Port are only used for 2-
stage or 3-stage ODU multiplexing.
4.On the OSM-2C, OSM-4C, OSM-4F
and OSM-5C, when there is no
Supporting ODUType, the ODUTribPort
range is 1 to 80.
When the SupportingODUType is C, and
the supported ODUType is F, Z, E, the
ODUTribPort range is 1 to 32.
When the SupportingODUType is C, and
the supported ODUType is B, the
ODUTribPort range is 1 to 4.
When the SupportingODUType is C, and
the supported ODUType is A, the
ODUTribPort range is 1 to 16.
When the SupportingODUType is B, and
the supported ODUType is F or Z, the
ODUTribPort range is 1 to 8.
When the SupportingODUType is B, and
the supported ODUType is A, the
ODUTribPort range is 1 to 2.
When the SupportingODUType is A, and
the supported ODUType is F or Z, the
ODUTribPort range is 1 to 2.
5.When the port of an OSM-4F is
configured with modulation format
200G16QAM, and when ODUtype is
D(ODU4), the ODUTribPort range is 1 to
2.
6.When the port of an OSM-4F is
configured with modulation format
2X150G8QAM, and when ODUtype is
D(ODU4), the ODUTribPort range is 1 to
3.

100GE Facility HGE EntityID-ShelfID-SlotID-PortID EntityID = HGE

ShelfID = 20
Example: HGE-20-5-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 2 (OSM-2C)
PortID = 1 to 5 (OSM-5C, mTera)
PortID = 1 to 4 (OSM-5C, mTera-8)

IP Protection Group IPPG EntityID-IPPGID EntityID = IPPG

IPPGID = 1
Example:IPPG-1

Link Protocol Profile LINKPF EntityID-LINKPFID EntityID = LINKPF

LINKPFID = 1 to 20, 91-99
Example LINKPF-1

76.MTFP50/30, Rev B January 2018 Page 30-35

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Label Set LABELSET EntityID-NPID-LSID EntityID = LABELSET
Example: LABELSET-3-1 NPID = 3
LSID = a integer number
(1 to 5500 for MAN type labelset, 20001
to 25000 for AUTO type labelset)

Memory MEM EntityID EntityID = SERVER

Example: SERVER

Management MGTETH EntityID-ShelfID-SlotID-PortID EntityID = MGTETH

Ethernet Port ShelfID = 20
Example: MGTETH-20-21-1 SlotID = 21, 28 (SEIM)
SlotID = 24, 25 (STPM)
SlotID = 13, 14 (STPM-8)
PortID = 1 to 8 (SW/DCN on SEIM)
PortID = 1 (LCI) ( STPM)
PortID = 1(LCI), 2, 5, 6 (STPM-8)
In-Band Management MGTINBAN MGTINBANDETH-ShelfID- EntitiyID = MGTINBANDETH
Ethernet DETH SlotID-PortID ShelfID = 20
SlotID = 1 to 7, 10 to 16
Example: MGTINBANDETH-20- PortID = 1 to 20
1-1

Node NODE EntityID-NPID-NodeNum EntityID = NODE

NPID = 1, 3
Example NODE-3-2 NodeNum = 1 to 512

Network Partition NP EntityID-NPID EntityID = NP

NPID = 1, 3
Example: NP-2

Network Timing NTPPEER EntityID-PeerID EntityID = NTPPEER

Protocol Peer PeerID = 1, 2
Example 1: NTPPEER-1

Optical Carrier Level OC3 EntityID-ShelfID-SlotID-PortID EntityID = OC3

3 Facility ShelfID = 20
Example: OC3-20-1-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 32 (OSM-1S)
PortID = 7 to 30 (SSM-2S)

Optical Carrier Level OC12 EntityID-ShelfID-SlotID-PortID EntityID = OC12

12 Facility ShelfID = 20
Example: OC12-20-4-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 o 32 (OSM-1S)
PortID = 7 o 30 (SSM-2S)

Optical Carrier Level OC48 EntityID-ShelfID-SlotID- EntityID = OC48

48 Facility {PortID|Vport-n} ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: OC48-20-3-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
OC48-20-3-99-7 PortID = 1 to 32 (OSM-1S)
PortID = 7 to 30 on SSM-2S
Vport = 99 (SSM-2S)
n = 7-30 (SSM-2S)

Page 30-36 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Optical Carrier Level OC192 EntityID-ShelfID-SlotID- EntityID = OC192
192 Facility {PortID|Vport-n} ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: OC192-20-3-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
OC192-20-3-99-1 PortID = 1 to 20 (OSM-2S)
PortID = 1 to 40 (OSM-4S)
Vport = 99 (SSM-2S)
n = 1-6 (SSM-2S)

Optical Channel OCH EntityID-ShelfID-SlotID- EntityID = OCH

SubslotID-PortID
ShelfID = 20
Example: OCH-20-1-1-1 ShelfID = 50 to 58 (PWS)
SlotID = 1 to 7, 10 to 16 (mTera)
EntityID-ShelfID-SlotID-PortID SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SlotID = 2 to 4, 6 to 8 (PWS)
Example: OCH-20-1-1 SubslotID = 1 to 3 (CDCP)
SubslotID = 1 (OMD48S, OMD44-1)
SubslotID = 2 (OMD48O, OMD44-45)
PortID = 1 to 44 (OMD44-1)
PortID = 45 to 88 (OMD44-45)
PortID = 19140 to 19610 in increments of
10 (OMD48S)
PortID = 19135 to 19605 in increments of
10 (OMD48O)
PortID = 9-14 (CDCP)
PortID = 3 to 6, 9 to 12 (CD4D8)

Optical Channel OCH-L For the Line side OCH: EntityID = OCH
Type = L
EntityID-Type-ShelfID-SlotID-
PortID-Num ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: OCH-L-20-1-21-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 21 (OADMRS-20)
PortID = 1 (OADMRS-9)
Num = 1 to 96

Optical Channel OCH-P EntityID-Type-ShelfID-SlotID- EntityID = OCH

PortID Type = P
ShelfID = 20
Example: OCH-P-20-5-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 2 (OSM-2C)
PortID = 1 to 20 (OSM-2S)
PortID = 1 to 40 (OSM-4S)

Optical Channel OCH-OS EntityID-ShelfID-SlotID-PortID EntityID = OCHOS

ShelfID = 20
Example: OCH-OS-20-1-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (mTera-8)
PortID = 1 to 2 (OSM-4F)
PortID = 1 to 4 (OSM-4C)

76.MTFP50/30, Rev B January 2018 Page 30-37

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
ODUflex facility ODUF EntityID-ShelfID-SlotID-PortID[- EntityID = ODUF
<SupportingODU4 ShelfID = 20
ODU4TribPort][-SupportODU SlotID = 1 to 7, 10 to 16 (mTera)
ODUTribPort][-TribID] SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20 (OSM-2S)
Example: ODUF-20-3-1-1 PortID = 1 to 2 (OSM-2C)
PortID = 1 to 2 (OSM-4F)
ODUF-[20]-[1-7,10-16]-[1-40]-[1- PortID = 1 to 4 (OSM-4C)
80] PortID = 1 to 40 (OSM-4S)
ODUF-[20]-[1-7,10-16]-[1-5]- PortID = 1 to 5 (OSM-5C, mTera)
[B,C][1-80]-[1-32] PortID = 1 to 4 (OSM-5C, mTera-8)
SupportODU4 = D (D represents an
ODUF-20-[1-7,10-16]-[1-2]-D[1- ODU4 on the OSM-4F when modulation
2]-[B,C][1-80]-[1-32] format 2X150G8QAM or 200G16QAM is
For ODUF mux into ODU2/ODU3 used)
into an ODU4 of ODUC2. ODU4TribPort = 1 to 2 (OSM-4F, for
200G16QAM)
ODUF-20-[1-7,10-16]-1-D[1-3]- ODU4TribPort = 1 to 3 (OSM-4F, for
[B,C][1-80]-[1-32] 2X150G8QAM)
For ODUF mux into ODU2/ODU3
into an ODU4 of ODUC3. When SupportODU = B, C (B represents an
mux into ODUC3, PortID must be ODU2 on the OSM-2C/OSM-4C/OSM-
1. 4F/OSM-5C, C represents an ODU3 on
the OSM-2C/OSM-4C/OSM-4F/OSM-
For commands supporting AID 5C)
Ranging in the AID block, AID ODUTribPort = 1 to 80 on OSM-2C/
can be ranged across all OSM-4C/OSM-4F/OSM-5C (represents
segments of the AID using "&&": the tributary port value for the
intermediate ODU2 or ODU3)
EntityID-ShelfID-SlotID- TribID = 1 to 8(when ODUF into ODU2)
PortID&&[EntityID][-ShelfID][- TribID = 1, 2 (when ODUF into ODU1)on
SlotID]-PortID OSM-4S
EntityID-ShelfID-SlotID-PortID- TribID = 1 to 80 (when ODUF to ODU4)
TribID&&[EntityID][-ShelfID][- TribID = 1 to 32 (when ODUTribPort = C)
SlotID][-PortID]-TribID TribID = 1 to 8 (when ODUTribPort = B)

SupportODU = A (A represents an ODU1

on the OSM-4S)
ODUTribPort = 1 to 4 on OSM-4S
(represents the tributary port value for
the intermediate ODU1)

Note that for an ODU associated with an

OTUk or Client port, the TribID is not
used

Page 30-38 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
ODU0 facility ODU0 EntityID-ShelfID-SlotID-PortID[- EntityID = ODU0
<SupportingODU4 ShelfID = 20
ODU4TribPort][-SupportODU SlotID = 1 to 7, 10 to 16 (mTera)
ODUTribPort][-TribID] SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20(OSM-2S)
Example: ODU0-20-3-1-B1-1 PortID = 1 to 32(OSM-1S)
PortID = 1 to 2(OSM-2C)
ODU0-[20]-[1-7,10-16]-[1-32] PortID = 1 to 2 (OSM-4F)
ODU0-[20]-[1-7,10-16]-[1-40]-[1- PortID = 1 to 4 (OSM-4C)
80] PortID = 1 to 40 (OSM-4S)
ODU0-[20]-[1-7,10-16]-[1-5]- PortID = 1 to 5 (OSM-5C, mTera)
[B,C][1-80]-[1-32] PortID = 1 to 4 (OSM-5C, mTera-8)
SupportODU4 = D (D represents an
ODU0-20-[1-7,10-16]-[1-2]-D[1- ODU4 on the OSM-4F when modulation
2]-[B,C][1-80]-[1-32] format 2x150G8QAM or 200G16QAM is
For ODU0 mux into ODU2/ODU3 used)
into an ODU4 of ODUC2. ODU4TribPort = 1 to 2 (OSM-4F, for
200G16QAM)
ODU0-20-[1-7,10-16]-1-D[1-3]- ODU4TribPort = 1 to 3 (OSM-4F,for
[B,C][1-80]-[1-32] 2X150G8QAM)
For ODU0 mux into ODU2/ODU3
into an ODU4 of ODUC3. When SupportODU = B, C (B represents an
mux into ODUC3, PortID must be ODU2 on the OSM-2C/OSM-4C/OSM-
1. 4F/OSM-5C, C represents an ODU3 on
the OSM-2C/OSM-4C/OSM-4F/OSM-
For commands supporting AID 5C)
Ranging in the AID block, AID ODUTribPort = 1 to 80 on OSM-2C/
can be ranged across all OSM-4C/OSM-4F/OSM-5C (represents
segments of the AID using "&&". the tributary port value for the
intermediate ODU2 or ODU3)
Explicitly created on all TribID = 1 to 8 (when ODU0 into ODU2)
supporting modules. TribID = 1, 2 (when ODU0 into ODU1)on
OSM-1S/OSM-4S
TribID = 1 to 80 (when ODU0 to ODU4)
TribID = 1 to 32 (when ODUTribPort = C)
TribID = 1 to 8 (when ODUTribPort = B)

SupportODU = A (A represents an ODU1

on the OSM-4S)
ODUTribPort = 1 to 4 on OSM-4S
(represents the tributary port value for
the intermediate ODU1)

Note that for an ODU associated with a

Client port, the TribID is not used
If ODU0 is muxed into ODUk directly,
IntermediateODU is not used.

76.MTFP50/30, Rev B January 2018 Page 30-39

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
ODU1 facility ODU1 EntityID-ShelfID-SlotID-{PortID[- Entity = ODU1
<SupportingODU4 ShelfID = 20
ODU4TribPort][-SupportODU SlotID = 1 to 7, 10 to 16 (mTera)
ODUTribPort][-TribID]|Vport-n} SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20 (OSM-2S)
Example: ODU1-20-3-5-4 PortID = 1 to 32 (OSM-1S)
PortID = 1 to 2 (OSM-2C)
ODU1-[20]-[1-7,10-16]-[1-32] PortID = 1 to 2 (OSM-4F)
ODU1-[20]-[1-7,10-16]-[1-40]-[1- PortID = 1 to 4 (OSM-4C)
80] PortID = 1 to 40 (OSM-4S)
ODU1-[20]-[1-7,10-16]-[1-5]- PortID = 1 to 5 (OSM-5C, mTera)
[B,C][1-80]-[1-16] PortID = 1 to 4 (OSM-5C, mTera-8)
ODU1-[20]-[1-7,10-16]-99-7 SupportODU4 = D (D represents an
ODU4 on the OSM-4F when modulation
ODU1-[20]-[1-7,10-16]-[1-2]-D[1- format 2x150G8QAM or 200G16QAM is
2]-[B,C][1-80]-[1-16] used)
For ODU1 mux into ODU2/ODU3 ODU4TribPort = 1 to 2 (OSM-4F, for
into an ODU4 of ODUC2. 200G16QAM)
ODU4TribPort = 1 to 3 (OSM-4F,for
ODU1-20-[1-7,10-16]-1-D[1-3]- 2X150G8QAM)
[B,C][1-80]-[1-16]
For ODU0 mux into ODU2/ODU3 SupportODU = B, C (B represents an
into an ODU4 of ODUC3.When ODU2 on the OSM-2C/OSM-4C/OSM-
mux into ODUC3, PortID must be 4F/OSM-5C, C represents an ODU3 on
1. the OSM-2C/OSM-4C/OSM-4F/OSM-
5C)
For commands supporting AID ODUTribPort = 1 to 80 on OSM-2C/
Ranging in the AID block, AID OSM-4C/OSM-4F/OSM-5C (represents
can be ranged across all the tributary port value for the
segments of the AID using "&&". intermediate ODU2 or ODU3)
TribID = 1 to 80 (when ODU1 to ODU4)
Explicitly created on all TribID = 1 to 4 (when ODU1 to ODU2)
supporting modules. TribID = 1 to 16 (when ODUTribPort = C)
TribID = 1 to 4 (when ODUTribPort = B)
Vport = 99 (SSM-2S)
n = 7-30 (SSM-2S)

Note that for an ODU associated with a

Client port, the TribID is not used

Page 30-40 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
ODU2 facility ODU2 EntityID-ShelfID-SlotID-{PortID[- EntityID = ODU2
<SupportingODU4 ShelfID = 20
ODU4TribPort][-SupportODU SlotID = 1 to 7, 10 to 16 (mTera)
ODUTribPort][-TribID]|Vport-n} SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20 (OSM-2S)
Examples: PortID = 1 to 2 (OSM-2C)
ODU2-20-3-1 PortID = 1 to 2 (OSM-4F)
PortID = 1 to 4 (OSM-4C)
ODU2-[20]-[1-7,10-16]-[1-40] PortID = 1 to 40 (OSM-4S)
ODU2-[20]-[1-7,10-16]-[1-40]-[1- PortID = 1 to 5 (OSM-5C, mTera)
80] PortID = 1 to 4 (OSM-5C, mTera-8)
ODU2-[20]-[1-7,10-16]-[1-5]-C[1- SupportODU4 = D (D represents an
80]-[1-4] ODU4 on the OSM-4F when modulation
ODU2-[20]-[1-7,10-16]-99-1 format 2x150G8QAM or 200G16QAM is
used)
ODU2-[20]-[1-7,10-16]-[1-2]-D[1- ODU4TribPort = 1 to 2 (OSM-4F, for
2]-C[1-80]-[1-4] 200G16QAM)
For ODU2 mux into ODU3 into ODU4TribPort = 1 to 3 (OSM-4F,for
an ODU4 of ODUC2. 2X150G8QAM)

ODU2-[20]-[1-7,10-16]-1-D[1-3]- SupportODU = C (C represents an

C[1-80]-[1-4] ODU3 on the OSM-2C/OSM-4C/OSM-
For ODU2 mux into ODU3 into 4F/OSM-5C)
an ODU4 of ODUC3.When mux ODUTribPort = 1 to 80 on /OSM-4C/
into ODUC3, PortID must be 1. OSM-4F/OSM-5C (represents the
tributary port value for the intermediate
For commands supporting AID ODU3)
Ranging in the AID block, AID TribID = 1 to 80 (when ODU2 to ODU4)
can be ranged across all TribID = 1 to 4 (when ODUTribPort = C)
segments of the AID using "&&". Vport = 99 (SSM-2S)
n = 1-6 (SSM-2S)

76.MTFP50/30, Rev B January 2018 Page 30-41

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
ODU2e facility ODU2E EntityID-ShelfID-SlotID-PortID[- EntityID = ODU2E
<SupportingODU4 ShelfID = 20
ODU4TribPort][-SupportODU SlotID = 1 to 7, 10 to 16 (mTera)
ODUTribPort][-TribID] SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20 (OSM-2S)
Examples: PortID = 1 to 2 (OSM-2C)
ODU2E-20-3-1-1 PortID = 1 to 2 (OSM-4F)
PortID = 1 to 4 (OSM-4C)
ODU2E-[20]-[1-7,10-16]-[1-40] PortID = 1 to 40 (OSM-4S)
ODU2E-[20]-[1-7,10-16]-[1-5]-[1- PortID = 1 to 5 (OSM-5C, mTera)
80] PortID = 1 to 4 (OSM-5C, mTera-8)
ODU2E-[20]-[1-7,10-16]-[1-5]- SupportODU4 = D (D represents an
C[1-80]-[1-32] ODU4 on the OSM-4F when modulation
format 2x150G8QAM or 200G16QAM is
ODU2E-[20]-[1-7,10-16]-[1-2]- used)
D[1-2]-C[1-80]-[1-32] ODU4TribPort = 1 to 2 (OSM-4F, for
For ODU2e mux into ODU3 into 200G16QAM)
an ODU4 of ODUC2. ODU4TribPort = 1 to 3 (OSM-4F,for
2X150G8QAM)
ODU2E-[20]-[1-7,10-16]-1-D[1-
3]-C[1-80]-[1-32] SupportODU = C (C represents an
For ODU2e mux into ODU3 into ODU3 on the OSM-2C/OSM-4C/OSM-
an ODU4 of ODUC3. When mux 4F/OSM-5C)
into ODUC3, PortID must be 1. ODUTribPort = 1 to 80 on /OSM-4C/
OSM-4F/OSM-5C (represents the
For commands supporting AID tributary port value for the intermediate
Ranging in the AID block, AID ODU3)
can be ranged across all TribID = 1 to 80 (when ODU2E to ODU4)
segments of the AID using "&&". TribID = 1 to 32 (when ODUTribPort = C)

ODU3 Facility ODU3 EntityID-ShelfID-SlotID-PortID[- EntityID = ODU3

<SupportingODU4 ShelfID = 20
ODU4TribPort]-TribID SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
Example: ODU3-20-2-1-1 PortID = 1, 2 (OSM-2C)
PortID = 1 to 2 (OSM-4F)
ODU3-[20]-[1-7,10-16]-[1-2]-D[1- PortID = 1 to 4 (OSM-4C)
2]-[1-80] PortID = 1 to 5 (OSM-5C, mTera)
For ODU3 mux into ODU4 of PortID = 1 to 4 (OSM-5C, mTera-8)
ODUC2. SupportODU4 = D (D represents an
ODU4 on the OSM-4F when modulation
ODU3-[20]-[1-7,10-16]-1-D[1-3]- format 2x150G8QAM or 200G16QAM is
[1-80] used)
For ODU2 mux into ODU3 into ODU4TribPort = 1 to 2 (OSM-4F, for
an ODU4 of ODUC3. When mux 200G16QAM)
into ODUC3, PortID must be 1. ODU4TribPort = 1 to 3 (OSM-4F,for
2X150G8QAM)
For commands supporting AID
Ranging in the AID block, AID TribID = 1 to 80
can be ranged across all
segments of the AID using "&&".

Page 30-42 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
ODU4 Facility ODU4 EntityID-ShelfID-SlotID-PortID[- EntityID = ODU4
ODU4TribPort] ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
Example: ODU4-20-3-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 2 (OSM-2C)
ODU4-[20]-[1-7,10-16]-[1-2]-[1-2] PortID = 1 to 2 (OSM-4F)
For ODU4 of ODUC2 PortID = 1 to 4 (OSM-4C)
PortID = 1 to 5 (OSM-5C, mTera)
ODU4-[20]-[1-7,10-16]-1-[1-3] PortID = 1 to 4 (OSM-5C, mTera-8)
For ODU4 of ODUC3. When mux ODU4TribPort = 1 to 2 (OSM-4F, for
into ODUC3, PortID must be 1. 200G16QAM)
ODU4TribPort = 1 to 3 (OSM-4F,for
For commands supporting AID 2X150G8QAM)
Ranging in the AID block, AID
can be ranged across all
segments of the AID using "&&".

ODUC2 Facility ODUC2 EntityID-ShelfID-SlotID-PortID EntityID = ODUC2

ShelfID = 20
Example: ODUC2-20-2-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (mTera-8)
PortID = 1 to 2 (OSM-4F)

ODUC3 Facility ODUC3 EntityID-ShelfID-SlotID-PortID EntityID = ODUC3

ShelfID = 20
Example: ODUC3-20-2-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (mTera-8)
PortID = 1 (OSM-4F)

Optical Multiplex OMS EntityID-ShelfID-SlotID[- EntityID = OMS

Section Facility SubslotID]-PortID
ShelfID = 20
Example: OMS-20-1-1-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SubslotID = 1 to 3 (CDCP)
PortID = 1 to 21 (OADMRS-20)
PortID = 1, 3 to 11 (OADMRS-9)
PortID = 1 to 8 (CDCP)

Optical Supervisory OSC EntityID-ShelfID-SlotID-PortID EntityID = OSC

Channel Facility
Example: OSC-20-1-21 ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 21 (OADMRS-20)
PortID = 1 (OADMRS-9)

Optical Supervisory OSCX EntityID-ShelfID-SlotID-PortID-N EntityID = OSCX

Channel Facility Example: OSCX-20-1-21-1 ShelfID = 20
Extended SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 21 (OADMRS-20)
PortID = 1 (OADMRS-9)
N = 1, 2 (1 for MCN; 2 for SCN)

OSPF Routing OSPF EntityID-NPID-OSPFID EntityID = OSPF

Controller NPID = 1, 3
Example OSPF-3-1 OSPFID = 1

76.MTFP50/30, Rev B January 2018 Page 30-43

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
OSPF Routing OSPFADJ For Manual Routing Adjacency: EntityID = OSPFADJ
Adjacency NPID = 1, 3
EntityID-NPID-OSPFID- OSPFID = 1
OSPFADJID OSPFADJID = 1 to 40

Example OSPFADJ-2-1-1

For Automatic Routing

Adjacency the AID is set to the
value:

OSPFADJ-AUTO

OSPF Area OSPFARE EntityID-NPID-OSPFID- EntityID = OSPFAREA

A OSPFAREAID NPID = 1, 3
OSPFID = 1
Example OSPFAREA-3-1-1 OSPFAREAID = 1 to 32

OSPF Redistribution OSPFRP EntityID-NPID-OSPFID- EntityID = OSPFRP

Point OSPFRPMAPID-OSPFRPID NPID = 1, 3
OSPFID = 1
Example OSPFRP-3-1-1-1 OSPFRPMAPID = 1 to 3
OSPFRPID = 1 to 100

OSPF Redistribution OSPFRPM EntityID-NPID-OSPFID- EntityID = OSPFRPMAP

Point Map AP OSPFRPMAPID NPID = 1, 3
OSPFID = 1
Example OSPFRDMAP-3-1-1 OSPFRPMAPID = 1 to 3

Optical Transmission OTS EntityID-ShelfID-SlotID-PortID EntityID = OTS

Section Facility ShelfID = 20
Example: OTS-20-1-21 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 21 (OADMRS-20)
PortID = 1 (OADMRS-9)

OTU1 facility OTU1 EntityID-ShelfID-SlotID-PortID EntityID = OTU1

ShelfID = 20
Example: OTU1-20-3-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 32 (OSM-1S)

OTU2 facility OTU2 EntityID-ShelfID-SlotID-PortID EntityID = OTU2

ShelfID = 20
Example: OTU2-20-3-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20 (OSM-2S)
PortID = 1 to 40 (OSM-4S)

OTU4 Facility OTU4 EntityID-ShelfID-SlotID-PortID EntityID = OTU4

ShelfID = 20
Example: OTU4-20-2-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 2 (OSM-2C)
PortID = 1 to 2 (OSM-4F)
PortID = 1 to 4 (OSM-4C)
PortID = 1 to 5 (OSM-5C, mTera)
PortID = 1 to 4 (OSM-5C, mTera-8)

Page 30-44 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
OTUC2 Facility OTUC2 EntityID-ShelfID-SlotID-PortID EntityID = OTUC2
ShelfID = 20
Example: OTUC2-20-2-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (mTera-8)
PortID = 1 to 2 (OSM-4F)

OTUC3 Facility OTUC3 EntityID-ShelfID-SlotID-PortID EntityID = OTUC3

ShelfID = 20
Example: OTUC3-20-2-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (mTera-8)
PortID = 1 (OSM-4F)

Performance PMPF EntityID-PMPFID EntityID = PMPF

Monitoring Profile PMPFID = 0, 1-20, 99
Table Example: PMPF-1

Line Point to Point PPPL EntityID-ShelfID-SlotID-PortID[- EntityID = PPPL

Protocol (SONET) Index] ShelfID = 20
SlotID = 1 to 7, 10 to 16(mTera)
Example: SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PPPL-20-6-1 PortID = 1 to 30,99 on SSM-2S
PPPL-20-6-99-1 Index = 1 to 30

Section Point to PPPS EntityID-ShelfID-SlotID-PortID[- EntityID = PPPS

Point Protocol Index] ShelfID = 20
(SONET) SlotID = 1 to 7, 10 to 16(mTera)
Example: SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PPPS-20-6-1 PortID = 1 to 30,99 on SSM-2S
PPPS-20-6-99-1 Index = 1 to 30

Multiplex Section PPPMS EntityID-ShelfID-SlotID-PortID[- EntityID = PPPMS

Point to Point Index] ShelfID = 20
Protocol SlotID = 1 to 7, 10 to 16(mTera)
(SDH) Example: SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PPPMS-20-6-1 PortID = 1 to 30,99 on SSM-2S
PPPMS-20-6-99-1 Index = 1 to 30

Regenerator PPPRS EntityID-ShelfID-SlotID-PortID[- EntityID = PPPRS

Section Point to Index] ShelfID = 20
Point Protocol SlotID = 1 to 7, 10 to 16(mTera)
(SDH) Example: SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PPPRS-20-6-1 PortID = 1 to 30,99 on SSM-2S
PPPRS-20-6-99-1 Index = 1 to 30

Point to Point PPPPF EntityID-PPPPFID EntityID = PPPPF

Protocol Profile PPPPFID = 1-10,99
Example PPPPF-1

RSVP Signaling RSVP EntityID-NPID-RSVPID EntityID = RSVP

Controller NPID = 1, 3
Example RSVP-3-1 RSVPID = 1

RSVP Signaling RSVPADJ EntityID-NPID-RSVPID- EntityID = RSVPADJ

Adjacency RSVPADJID NPID = 1, 3
RSVPID = 1
Example RSVPADJ-3-1-1 RSVPADJID = 1 to 40

Security SECU EntityID EntityID = SECU

Example: SECU

76.MTFP50/30, Rev B January 2018 Page 30-45

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Service Level Profile SLPF EntityID-SLPFID EntityID = SLPF
PPID = 1 to 20, 99
Example SLPF-1

Service Level Policy SLPOLICY EntityID-SLPOLICYID EntityID = SLPOLICY

SLPOLICYID = 1 to 20
Example SLPOLICY-1

SNMP SNMP EntityID EntityID = SNMP

Example: SNMP

Security Policy SPD EntityID-SPDID EntityID = SPD

Database SPDID = 1 to 1000
Example: SPD-1

Synchronous STM1 EntityID-ShelfID-SlotID-PortID EntityID = STM1

Transport Mode ShelfID = 20
Level 1 Example: STM1-20-1-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 32 (OSM-1S)
PortID = 7 to 30 on SSM-2S

Synchronous STM4 EntityID-ShelfID-SlotID-PortID EntityID = STM4

Transport Mode ShelfID = 20
Level 4 Example: STM4-20-1-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 32 (OSM-1S)
PortID = 7 to 30 on SSM-2S

Synchronous STM16 EntityID-ShelfID-SlotID- EntityID = STM16

Transport Mode {PortID|Vport-n} ShelfID = 20
Level 16 SlotID = 1 to 7, 10 to 16 (mTera)
Example: STM16-20-3-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
STM16-20-3-99-7 PortID = 1 to 32 (OSM-1S)
PortID = 7 to 30 on SSM-2S
Vport = 99 (SSM-2S)
n = 7-30 (SSM-2S)

Synchronous STM64 EntityID-ShelfID-SlotID- EntityID = STM64

Transport Mode {PortID|Vport-n} ShelfID = 20
Level 64 SlotID = 1 to 7, 10 to 16 (mTera)
Example: STM64-20-6-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
STM64-20-6-1-99-1 PortID = 1 to 20 (OSM-2S)
PortID = 1 to 6 on SSM-2S
Vport = 99 (SSM-2S)
n = 1-6 (SSM-2S)

Page 30-46 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Synchronous STS1 EntityID-ShelfID-SlotID- EntityID = STS1
Transport Signal {PortID|Vport-n}-StsID ShelfID = 20
Level 1 SlotID = 1 to 7, 10 to 16 (mTera)
Example: STS1-20-6-1-10 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
STS1-20-6-99-1-10 PortID = 1 to 30 (SSM-2S)
Vport = 99 (SSM-2S)
For commands supporting AID n = 1-30 (SSM-2S)
Ranging in the AID block, AID
can be ranged across ShelfID, StsID = 1 to 192
SlotID, PortID, and StsID
(Entering the complete AID for Notes:
the second value in a range is -StsID=3 max when supporting facility is
not needed): OC3.
-StsID=12 max when supporting facility
EntityID-ShelfID-SlotID-PortID- is OC12.
StsID&&[EntityID][-ShelfID][- -StsID=48 max when supporting facility
SlotID][-PortID]-StsID is OC48.
-StsID=192 max when supporting facility
Example: STS1-20-5-1-10&& is OC192.
STS1-20-6-1-10
STS1-20-5-1-10&&-2-12

Synchronous STS3C EntityID-ShelfID-SlotID- EntityID = STS3C

Transport Signal {PortID|Vport-n}-StsID ShelfID = 20
Level 3C SlotID = 1 to 7, 10 to 16 (mTera)
Example: STS3C-20-7-1-4 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 30 (SSM-2S)
Vport = 99 (SSM-2S)
For commands supporting AID n = 1-30 (SSM-2S)
Ranging in the AID block, AID
can be ranged across ShelfID, StsID = 1, 4, 7, 10, 13,..., 190.
SlotID, PortID, and StsID
(Entering the complete AID for Notes:
the second value in a range is -StsID=1 max when supporting facility is
not needed): OC3.
-StsID=10 max when supporting facility
EntityID-ShelfID-SlotID-PortID- is OC12.
StsID&&[EntityID][-ShelfID][- -StsID=46 max when supporting facility
SlotID][-PortID]-StsID is OC48.
-StsID=190 max when supporting facility
Example: STS3C-20-5-1-4&& is OC192.
STS3C-20-7-1-4
STS3C-20-5-1-4&&-2-7

76.MTFP50/30, Rev B January 2018 Page 30-47

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Synchronous STS12C EntityID-ShelfID-SlotID- EntityID = STS12C
Transport Signal {PortID|Vport-n}-StsID ShelfID = 20
Level 12C SlotID = 1 to 7, 10 to 16 (mTera)
Example: STS12C-20-7-1-37 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
STS12C-20-7-99-1-37 PortID = 1 to 30 (SSM-2S)
Vport = 99 (SSM-2S)
For commands supporting AID n = 1-30 (SSM-2S)
Ranging in the AID block, AID
can be ranged across ShelfID, StsID = 1, 13, 25, 37,..., 181
SlotID, PortID, and StsID
(Entering the complete AID for Notes:
the second value in a range is -StsID=1 max when supporting facility is
not needed): OC12.
-StsID=37 max when supporting facility
EntityID-ShelfID-SlotID-PortID- is OC48.
StsID&&[EntityID][-ShelfID][- -StsID=181 max when supporting facility
SlotID][-PortID]-StsID is OC192.

Example: STS12C-20-7-1-37
&&STS12C-20-7-5-37
STS12C-20-7-1-37&&-2-25

Synchronous STS48C EntityID-ShelfID-SlotID- EntityID = STS48C

Transport Signal {PortID|Vport-n}-StsID ShelfID = 20
Level 48C SlotID = 1 to 7, 10 to 16 (mTera)
Example: STS48C-20-6-11-49 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
STS48C-20-6-99-1-49 PortID = 1 to 30 (SSM-2S)
Vport = 99 (SSM-2S)
For commands supporting AID n = 1-30 (SSM-2S)
Ranging in the AID block, AID
can be ranged across ShelfID, StsID = 1, 49, 97, 145
SlotID, PortID, and StsID
(Entering the complete AID for Notes:
the second value in a range is -StsID=1 max when supporting facility is
not needed): OC48.
-StsID=145 max when supporting facility
EntityID-ShelfID-SlotID-PortID- is OC192.
StsID&&[EntityID][-ShelfID][-
SlotID][-PortID]-StsID

Example: STS48C-20-5-11-49
&&STS48C-20-6-11-49
STS48C-20-5-1-49&&-2-97

Page 30-48 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Synchronous STS192C EntityID-ShelfID-SlotID- EntityID = STS192C
Transport Signal {PortID|Vport-n}-StsID ShelfID = 20
Level 192C SlotID = 1 to 7, 10 to 16 (mTera)
Example: STS192C-20-5-1-1 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
STS192C-20-5-99-1-1 PortID = 1 to 6 (SSM-2S)
Vport = 99 (SSM-2S)
For commands supporting AID n = 1-6 (SSM-2S)
Ranging in the AID block, AID
can be ranged across ShelfID, StsID = 1
SlotID, PortID, and StsID
(Entering the complete AID for
the second value in a range is
not needed):

EntityID-ShelfID-SlotID-PortID-
StsID&&[EntityID][-ShelfID][-
SlotID][-PortID]-StsID

Example: STS192C-20-5-1-1
&&STS192C-20-12-1-1
STS192C-20-5-1-1&&-2-1

E1 Input E1 EntityID-ShelfID-SlotID-PortID EntityID = E1

Synchronization ShelfID = 20
Facility Example: E1-20-23-2 SlotID = 23,26 (mTera)
SlotID = 15 (8-slot mTera)
PortID = 2 (mTera)
PortID = 1,2 (8-slot mTera)

E1 Output E1OUT EntityID-ShelfID-SlotID-PortID EntityID = E1OUT

Synchronization ShelfID = 20
Facility Example: E1OUT-20-23-2 SlotID = 23,26 (mTera)
SlotID = 15 (8-slot mTera)
PortID = 2 (mTera)
PortID = 1,2 (8-slot mTera)

2M Hz Inout 2MH EntityID-ShelfID-SlotID-PortID EntityID = 2MH

Synchronization ShelfID = 20
Facility Example: 2M-20-23-2 SlotID = 23,26 (mTera)
SlotID = 15 (8-slot mTera)
PortID = 2 (mTera)
PortID = 1,2 (8-slot mTera)

T1 Input T1 EntityID-ShelfID-SlotID-PortID EntityID = T1

Synchronization ShelfID = 20
Facility Example: T1-20-23-2 SlotID = 23,26 (mTera)
SlotID = 15 (8-slot mTera)
PortID = 2 (mTera)
PortID = 1,2 (8-slot mTera)

T1 Output T1OUT EntityID-ShelfID-SlotID-PortID EntityID = T1OUT

Synchronization ShelfID = 20
Facility Example: T1OUT-20-23-2 SlotID = 23,26 (mTera)
SlotID = 15 (8-slot mTera)
PortID = 2 (mTera)
PortID = 1,2 (8-slot mTera)

76.MTFP50/30, Rev B January 2018 Page 30-49

2. TL1 Message Structure and Functionality TL1 Command Reference Manual

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Software Load SW EntityID-SWID EntityID = SW
SWID = 1
Example: SW-1

TCP IP TCPIP EntityID-TCPIPID EntityID = TCPIP

TCPIPID = 1
Example: TCPIP-1

10 Gigabit Ethernet TGLAN EntityID-ShelfID-SlotID-PortID EntityID = TGLAN

Facility (LAN) ShelfID = 20
Example: TGLAN-20-3-1 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
PortID = 1 to 20 (OSM-2S)
PortID = 1 to 40 (OSM-4S)

Topological Link TL EntityID-NPID-NodeNum-TLID EntityID = TL

NPID = 1, 3
Example TL-3-2-1 NodeNum = 1 to 512
TLID = 1 to 1500

Time Of Day Clock TOD EntityID EntityID = TOD-SRC

Example: TOD-SRC

TPOOL TPOOL EntityID-ShelfID-SlotID-n EntityID = TPOOL

ShelfID = 20
Example: TPOOL-20-10-5 SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
n = 1 to 32

Note, the TPOOL is an alias to identify

the VCG entity for Control Plane.

Transitional Link TSL EntityID-NPID-NodeNum-TSLID EntityID = TSL

NPID = 1, 3
Example TSL-3-1-1 NodeNum = 1 to 512
TSLID = 1 to 500

STS1 Trail TTPSTS1 EntityID-ShelfID-SlotID-Vport- EntityID = TTPSTS1

Termination Point GroupId-n ShelfID = 20
Example: TTPSTS1-2-10- SlotID = 1 to 7, 10 to 16 (mTera)
99-1-12 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
Vport = 99
GroupId = 1 to 3
n = 1 to 192

STS3C Trail TTPSTS3C EntityID-ShelfID-SlotID-Vport- EntityID = TTPSTS3C

Termination Point GroupId-n ShelfID = 20
Example: TTPSTS3C-2- SlotID = 1 to 7, 10 to 16 (mTera)
10-99-2-10 SlotID = 1 to 4, 7 to 10 (8-slot mTera)
Vport = 99
GroupId = 1 to 3
n = 1, 4, 7, 10, ..., 187, 190

User Identification UID UID Alphanumeric string that contains at least

(for security one (1) numeric character and at most
provisionin Example: Smith1 ten (10) characters. Indicates the login
g) name associated to a login account.

Page 30-50 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 2. TL1 Message Structure and Functionality

Table 2.9 AID Formats (Continued)

Entity Name Entity AID Format Format Values
Virtual Concatenation VCG EntityID-ShelfID-SlotID-n EntityID = VCG
Group Example:VCG-20-1-1 ShelfID = 20
SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
n = 1 to 32

Wavelength WCG EntityID-ShelfID-SlotID EntityID = WCG

Contention Group ShelfID = 20
Example: WCG-20-1 ShelfID = 50 to 58 (PWS)
SlotID = 1 to 7, 10 to 16 (mTera)
SlotID = 1 to 4, 7 to 10 (8-slot mTera)
SlotID = 2 to 4, 6 to 8 (PWS)

76.MTFP50/30, Rev B January 2018 Page 30-51

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

3. Error Codes for TL1 Output Responses

3.01 An error message occurs in response to an input command. It indicates

abnormal (error) conditions within the system that prevent the command action
from successfully executing. An incorrectly entered command can also generate
an error message. Additionally, there are commands that give system output,
much like the retrieve commands, after an error has occurred, as a functional
behavior of the command.
3.02 The Error Message Format Description table below provides the
parameter discriptions for the following message format:
<cr><lf><lf>^^^<sid>^<date>^<time>
<cr><lf>M^^<ctag>^DENY
<cr><lf>^^^<error_code>
<cr><lf>^^^[/* <Additional Text> */]
<cr><lf>;

Table 3.1 Error Message Format Description

Parameter Description
SID Identifies the system.

Date Identifies the date the message was output.

time Identifies the time of day the message was output.

M Indicates an output message.

ctag Correlates the input command with the output response.

DENY Reports that the input command cannot be correctly

executed.

error_code Four-character abbreviation that defines the abnormal/

erroneous condition. Refer to the Error Conditions Section for
all applicable codes.

Additional Text Supplies additional information on the reported abnormal/

erroneous condition.

; Concludes the output message.

3.03 In addition, when there is a response where the Additional Text is longer
than 60 characters it is broken at a clean section such that it does not break a
parameter in the middle. It is separated by a <cr> <lf>.
3.04 In the event an output message exceeds 4096 bytes, the output
information is partitioned into multiple output response messages. A continuation
message (that is, subsequent message) needs to have another header and
response identification with the same <ctag>, along with an additional <text block>.
Each message is terminated by the greater than (>) character, except the last
message, which is terminated by the semicolon (;) character for indicating the
completion of the response. The (>) terminator is also used for intermediate
responses in a timed measurement series.

Page 30-52 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

3.05 The next section describes the input, equipage, status, resource and
privilege error conditions that can generate a deny output response in the network
element. It also provides a list and description of all error codes.

Error Conditions
3.06 When an input command or the action requested is denied, the output
message shows the error condition that triggered the denial. This type of output
message is called the error response.
3.07 The error code is a four-character abbreviation that defines the abnormal
or erroneous condition in the error response. All the error codes are defined and
explained in the Table 3.3.
3.08 There are five categories of error conditions which result in an error
response being generated in the network element:
• equipage errors

• input errors

• privilege errors

• resources errors

• status errors

Equipage Error Conditions

3.09 Equipage error conditions occur when the equipment type does not match
the equipment specified in the input command.

Input Error Conditions

3.10 Incorrectly-entered commands constitute input error conditions. Five basic
errors can generate input error responses:
• command errors

• data errors

• parameter block errors

• parameter name errors

• syntax errors

76.MTFP50/30, Rev B January 2018 Page 30-53

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Privilege Error Conditions

3.11 Privilege error conditions occur if the user identity is illegal, the user has
already logged out and is attempting to logout again or if the user has insufficient
privilege to execute the command. Refer to the Security and Administration User
Privileges table in section 7 for information on user privilege codes.

Resource Error Conditions

3.12 Resource error conditions occur when the NE is unable to service a
command because its resources (memory, disk space, and so on) are not
available.

Status Error Conditions

3.13 Status error conditions occur when there is a discrepancy between the
actual status of an object entity and the status assumed by the input command.
Abnormal operating situations that affect the NE also generate error messages.

Supported Error Codes

3.14 This section details each error code. It provides each code, its definition,
its type and the possible reason why the error occurred as well as the command
that can trigger that error.

Table 3.2 Error Code Definitions

Error
Codes Definitions
IDNC INPUT, DATA NOT CONSISTENT

IDNV INPUT, DATA NOT VALID

IDRG INPUT, DATA RANGE ERROR

IEAE INPUT, ENTITY TO BE CREATED ALREADY EXISTS

IENE INPUT, SPECIFIED OBJECT ENTITY DOES NOT EXIST

IIAC INPUT, INVALID ACCESS IDENTIFIER (AID)

IICM INPUT, INVALID COMMAND

IICT INPUT, INVALID CTAG

IIFM INPUT, INVALID DATA FORMAT

IITA INPUT, INVALID TARGET IDENTIFIER (TID)

IPEX INPUT, PARAMETER EXTRA

Page 30-54 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.2 Error Code Definitions (Continued)

Error
Codes Definitions
IPMS INPUT, PARAMETER MISSING

IPNV INPUT, PARAMETER NOT VALID

PICC PRIVILEGE, ILLEGAL COMMAND CODE

PLNA PRIVILEGE LOGIN NOT ACTIVE

SAAS STATUS, ALREADY ASSIGNED

SABT STATUS, ABORTED

SAOP STATUS, ALREADY OPERATED

SAPR STATUS, ALREADY IN PROTECTION

SDAS STATUS, DIAGNOSIS ALREADY STARTED

SDBE STATUS, INTERNAL DATABASE ERROR

SDNC STATUS, DATA NOT CONSISTENT

SNCC STATUS, NOT A VALID CROSS CONNECT

SNVS STATUS, NOT IN VALID STATE

SOSE STATUS, OPERATING SYSTEM ERROR

SROF STATUS, REQUESTED OPERATION FAILED

SRTO STATUS, REPLY TIMEOUT OCCURED

SSRE STATUS, SYSTEM RESOURCES EXCEEDED

Table 3.3 Error Codes - Common to Most Commands

TL1
Error Description Error Additional Text
Parameter value not supported by the specified IDNV /* Invalid Payload block. Parameter value not
entity. valid for specified AID */
Example: Channel number in legal value range
(between 1 and 96) that is not supported by the
specified card.

Parameter value out of range. IDRG /* Invalid Payload block. Parameter value out
Example: A power or threshold level that is out of of range */
range. A trace parameter that is too long. A
ChannelId that is greater than 96. Entering a
LOSTHRES value higher than the set value for
SWTHRES or entering a SWTHRES value lower than
the set value for LOSTHRES.

Entity specified in a creation command (ENT) is IEAE /* Entity to be created already exists */
already entered.
Example: Try to enter an OC48 that is already
created.

76.MTFP50/30, Rev B January 2018 Page 30-55

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.3 Error Codes - Common to Most Commands (Continued)

TL1
Error Description Error Additional Text
Entity cannot be entered because one of its IENE /* Entity required to perform requested
supporting entities does not exist. operation does not exist */
Example: ENT command for an OCn facility on a
transponder card that is not yet entered.

Entity specified in the AID block of the command does IENE /* Entity specified in the AID block does not
not exist (that is, has not been previously created) exist */
and a command other than ENT is received.
Examples:
EDIT command for a transponder that is not yet
entered.
ENT-CRS-OCH command in which one of the
specified OCH entities is not yet entered.
RTRV command for an OSM2S-20-1 (legal AID since
it is an acceptable equipment type for this slot) when
there is already an equipment provisioned in the slot
and it is a OSM-2C.

Card type specified in the EQPT AID is not supported IIAC /* Invalid AID block. Invalid AID */
in specified slot.
Example: OSM-2S card in slot 18.

Entity cannot be deleted because it is permanently IICM /* Command not valid for specified AID. Entity
assigned by the system. is permanently assigned and can not be
deleted */

Missing or illegal format of CTAG. IICT /* Invalid Correlation Tag */

Parameter value out of range. IIFM /* Invalid Payload block. Invalid Data Format */
Example: An alarm.profile table value that is not in the
range 0-20 or 99.

The TID specified in the command is invalid. IITA /* The Target Identifier is incorrect. */

Parameter does not apply to the specified entity type. IPEX /* Invalid Payload block. Extra parameters. */
Example: TRC for an EQPT entity.

Mandatory parameter not specified in command. IPMS /* Invalid Payload block. Missing mandatory
Example: Missing parameter TYPE in ED-NE field */
command.

A command is sent before the user log in. PLNA /* The user must first login to the network
element. */

Regions are not valid, not restored from database yet SDBE /* Requested operation failed due to internal
or not instantiated. database error */

Entity cannot be deleted because supported entity SNVS /* Operation denied because it could impact
must be deleted first. the traffic. All supported entities need to be first
Example: Cannot delete the transponder card until deleted.*/
the transponder facilities are deleted.

Entity cannot be deleted because it is in-service. SNVS /* Operation denied because it could impact
the traffic. The entity needs to be explicitly
removed from service first. */

Traffic affecting parameters on entity cannot be SNVS /* Operation denied because it could impact
edited without specifying command mode the traffic. Use the forced mode to override
“Forced”. system validation. */
Example: Edit OC-192 with parameter PST=OOS.

Page 30-56 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.3 Error Codes - Common to Most Commands (Continued)

TL1
Error Description Error Additional Text
Attempting to edit an OTN based entity (OCHP, OTUk SNVS /* Operation denied. ODUk and all tributaries
or ODUj) when supported, sub-layer ODUk are must be disconnected before this operation
involved in a valid cross-connect. can be performed.*/

When trying to create an FFP with SNVS /* Operation denied. Cannot set up YCABLE
SCHEME=YCABLE using a facility with PROT set to protection if either specified facility has
YES, NENDALS set to YES or MAINTPROP set to PROT=YES, NENDALS=YES or
END_CALS the command is denied. MAINTPROP=END_CALS. */

When trying to set PROT=YES or SNVS /* Operation denied. The entity is involved in
MAINTPROP=END_CALS on a facility where an FFP facility protection (FFP). */
exist with SCHEME=YCABLE the command is
denied.

Memory allocation failure or any other lack of system SOSE /* Requested operation failed due to operating
resources. system error */
Example: No operating system resources available.
This is a pure software bug.

Internal software bugs that do not fit into the SROF /* Requested operation failed due to internal
descriptions for SDBE or SOSE. software error */
Examples:
Parameter received from agent that cannot be
displayed by TL1 parser.
Not a valid internal state transition. This is a pure
software error, not caused by TL1 user entering
invalid states.
Impossible state transition. Cannot pass from
maintenance cause by remove to deleted. Need to
pass by and edit before or a restore.

Exceed the number of resources supported by the SSRE /* Requested operation failed due to exceeding
system. the number of resources supported */
Example: Try to enter a TL when the maximum
number of TLs are already configured.

Table 3.4 Error Codes - Command Specific

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Try to lock port side facility when the IDNC ED-{x} /*Input data not consistent. Cannot lock
line side facility is connected. port side facility when line side is involved
in connection. Use forced mode*/

Try to provision a GOPT rate which IDNC ED-{x} /* Input data not consistent. Selected
is not a SONET or 8B/10B data rate ENT-{x} PROT value not supported for specified
with PROT=NO. rate(s). */

Try to provision CONNECT IDNC ED-{x} /*Input data not consistent. Can not
parameter when ENT-{x} provision CONNECT parameter when
EXTCONNECT=NO. EXTCONNECT is disabled*/

76.MTFP50/30, Rev B January 2018 Page 30-57

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Try to provision facility not IDNC ENT-{x} /*Input data not consistent. The port
acceptable to OSM1S hardware. specified is within a group of ports which
are reserved for provisioning by the
packet switching domain based on the
existence of an ETH facility or an ODU
with SWITCHTYPE=PKT.*/

Try to set NSA condition to CR. IDNC ED-ALMPF /* Input data not consistent. A condition
cannot be CR and NSA */

Try to edit notification code of TC to IDNC ED-ALMPF /* Input data not consistent. Notification
something other than NA or NR. code of transient conditions can only be
NA or NR */

Try to change notification code of IDNC ED-ALMPF /* Input data not consistent. Notification
CR alarm. code of CR alarms cannot be modified */

Try to edit notification code for non- IDNC ED-ALMPF /* Input data not consistent. Notification
editable condition types code of specified condition type is not
(FSTOPROT, FSTOWKG, provisionable */
LOCKOUT
MANTOPROT, MANTOWKG,
NOREQ, DNR, SDONPROT,
SDONWKG, SFONPROT,
SFONWKG, WTR).

Service modification to an SLPF AID IDNC ED-CALL /* Operation denied. Service modification
which improperly modifies one or of the SLPF parameter or value is
more individual SLPF parameters. restricted. */

Trying to provision the two preferred IDNC ED-CALL /*Operation denied. Preferred restoration
restoration paths of a single paths with the same EXPPATH AID on a
connection path with the same single connection path.*/
explicit path AID.

No DSP supported for this time IDNC ED-NE /* Input data not consistent. DSP is not
zone. supported for specified time zone */

Request to set HWR to an older IDNC ED-NE /* Input data not consistent. Hardware
version than the currently version downgrade not supported */
provisioned.

Requested subnode configuration IDNC ED-NE /* Input data not consistent. Specified
type not supported. subnode type not supported */

Try to place ODU4 facilities OOS IDNC ED-ODU4 /* Input data not consistent. Cannot lock
without the CMDMDE=FRCD supported facility when line side is
parameter. involved in connection. Use forced
mode.*/

Try to edit EXPOTSTRC when no IDNC ED-OTS /* Input data not consistent. Feature not
OSC provisioned. available when no OSC is provisioned */

Try to enable ATPS when no OSC IDNC ED-OTS /* Input data not consistent. Feature not
provisioned. available when no OSC is provisioned */

Try to modify parameter IDNC ED-PPG-ODUk /*Input data not consistent. Cannot modify
BIDIR_SIWTCH when the current parameter BIDIR_SIWTCH when the
protection status is WTR or DNR. current protection status is WTR or
DNR.*/

Page 30-58 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Try to set SSHAUTH to KEY without IDNC ED-TCPIP /* Input data not consistent. If SSHAUTH
creating a host key using the is set to KEY, a host key must be
sshKeyStrength parameter generated using the sshKeyStrength
parameter */

Try to edit neighbor information or IDNC ED-TL /*Input data not consistent. Can't modify
RAID when the TL is InService or neighbor information (NIFINDEX, NNID,
NDISCOVERY is enabled. NSIGADDR and NSIGID) and RAID if
NDISCOVERY=ENABLED or TL is not
OOS.*/

Try to provision a facility with IDNC ENT-{x} /* Input data not consistent. Paired odd
different signal type or clock type and even facilities must be the same
from the paired facilities when signal type and clock type when
OTNMAP=NO. OTNMAP=NO. */

Trying to provision the preferred IDNC ENT-CALL /*Operation denied. Current

restoration path for unprotect or 1p1 ED-CALL protection_level or CP reversion settings
calls or non-CP-revertive calls. in associated SLPF not allowed with
preferred restoration path.*/

User requests a computed IDNC ENT-CALL /*Operation denied. The expp_aid is

restoration path but the expp_aid is missed or already exists for the computed
not provided or already exists. restoration path.*/

Try to create/edit a user with all TL1, IDNC ED-USER-SECU /* Input data not consistent. Cannot
CLI and SNMP privileges as UAP = ENT-USER-SECU provision a user with all TL1, CLI and
A0. SNMP privileges as UAP=A0 */

Cross-connect end points are not on IDNC ENT-CRS-OCH /* Input data not consistent. Cross
different sides. connect endpoints must be on different
sides */

Cross-connect end points are not on IDNC ENT-CRS-OCH /* Input data not consistent. Cross
the same side. connect endpoints must be on the same
side */

Cross-connect end points are not of IDNC ENT-CRS-OCH /* Input data not consistent. Cross
the same wavelength. connect endpoints must have same
wavelength */

Provided FROMCP must match IDNC ENT-CRS-OCH /* Input data not consistent. FROMCP or
TRN equipment in shelf_id and TOCP does not match equipment
slot_id. provisioning */

Provided TOCP must match TRN IDNC ENT-CRS-OCH /* Input data not consistent. FROMCP or
equipment in shelf _id and slot_id. TOCP does not match equipment
provisioning */

Try to provision a OCH cross- IDNC ENT-CRS-OCH /* Input data not consistent. Fiber entity
connection without defined FIBR does not exist for specified connection */
entity.

FROM and TO AID are the same. IDNC ENT-CRS- /* Input data not consistent. Invalid AID
combination */

76.MTFP50/30, Rev B January 2018 Page 30-59

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
The LACPSYSID or LACPSYSPRI IDNC ENT-EQPT /* Input data not consistent. The paired
value chosen are not consistent with module has different LACP values then
the existing values on the paired those chosen. Use defaults and use the
module. ED-EQPT command to change these
values. */

Can not create facility protection IDNC ENT-FFP /* Input data not consistent. The specified
group because facilities have facilities have conflicting configuration
mismatched parameter values parameters. */
(example: different values for
GFPMAPPING, SIGTYPE, NVALUE
or VCAT parameters).

Try to use an OCH facility that has IDNC ENT-FIBR-EQPT /* Input data not consistent. Add/Drop port
already been provisioned. already has OCH facility provisioned.*/

Try to create fiber entity when facility IDNC ENT-FIBR-EQPT /* Input data not consistent. Cannot create
has EXTCHAN set. fiber entity when facility has EXTCHAN
set.*/

When used to provision OCH IDNC ENT-OCH /* Input data not consistent. Cannot create
entities on OADMRS-20 modules, is OCH when a FIBR entity is equipped. */
rejected if the port associated with
the the proposed OCH is already in
use.

Try to create transport TL with IDNC ENT-TL /*Input data not consistent. RESOURCE
NDISCOVERY enabled on a trace settings are not compatible.*/
resource which is set to an
incompatible trace monitoring mode.

Cannot set attenuation if auto Power IDNC SET-ATTN /* Input data not consistent. Cannot set
Management adjust is enabled. attenuation if automatic adjustment is
enabled */

Try to enable TCA reporting when IDNC SET-TCAMODE /* Input data not consistent. Cannot
PM accumulation (PMMODE) is enable TCA reporting when PMMODE is
disabled. OFF */

Try to provision a termination that is IDNC ENT-OCn /* Input data not consistent. Insufficient
too large for the facility (for example, ENT-STMn bandwidth for the specified termination */
provisioning an STS12C on an ENT-GBEP
OC3).
Or try to provision a port side facility
for which there are not enough time
slots available.

Try to cross-connect two facilities, IDNC ENT-CRS-OCH /* Input data not consistent. Cannot create
and at least one of them has cross-connect when external connectivity
EXTCONNECT=YES. is set */

Try to provision PROT to NA on IDNC ED-{x} /* Input data not consistent. PROT may
unsupported module. ENT-{x} not be set to NA. */*

Changing CCT from 2WAYPR to IDNC ED-CRS-ODUk /* Input data not consistent. Invalid CCT
other value when both or ccPath. */
SRC_PROTTYPE and
DEST_PROTTYPE are specified.

Page 30-60 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
For HGE facilities, PRBSTX and IDNC STA-BER /* Input Data Not Consistent. PRBSTX
PRBSRX must always be set to the and PRBSRX must be set to the same
same value. value.*/

For provision or edit ODUj that is IDNC ENT-ODUk /* Input data not consistent. Invalid
demuxed from high order ODUk, the ED-ODUk number of tributary slots specified for
entered Tributary Slot number does given ODUj multiplexing.*/
not match the required TS number.

Specified Patch Load file is not valid IDNV COPY-RFILE with /* Input Data Not Valid. Patch load file not
for the current software release on PDL compatible with existing NE software. */
the NE.

The LACP system identifier chosen IDNV ED-EQPT /* Invalid Payload block. Parameter value
is a multi-cast ethernet address. ENT-EQPT not a valid unicast MAC addr. */

Invalid Network Configuration IDNV ED-NE /* Invalid Payload block. Parameter value
(unsupported value of EONTYPE). not valid. */

User provisions DISPCOMPE-A/B/ IDNV ED-NE /* Invalid Payload block. DISPCOMPE

C/D/E/F/G/H to 90-100-110-120 KM Parameter value not valid. */
without specifying -LL.

ATPS is not supported in this IDNV ED-OTS /* Invalid Payload block. Parameter
configuration. value(s) not valid for specified AID */

A filename was not specified for the IDNV ED-USER-SECU /* Input Data Not Valid. A file name needs
KEYLCN parameter. to be specified in the KEYLCN parameter.
*/

Specified value of CCPATH not IDNV ENT-CRS-OCH /* Invalid Payload block. Parameter value
supported for this OCH. not valid for specified AID */

Specified wavelength value not IDNV ENT-EQPT /* Invalid Payload block. Parameter
supported on this equipment entity. value(s) not valid for specified AID */

Wavelength value is not first IDNV ENT-EQPT /* Invalid Payload block. Parameter
wavelength of the supported range. value(s) not valid for specified AID */

Band value is not the one supported IDNV ENT-EQPT /* Invalid Payload block. Parameter
by current equipment. value(s) not valid for specified AID */

Received editable PST value not IS IDNV ENT-EQPT /* Invalid Payload block. Parameter value
or OOS. ENT-{X} not valid. */
ED-{X}

IP address value validation failed. IDNV ENT-NTPPEER /* Invalid Payload block. Parameter value
not valid. */

Illegal value received for <ph> IDNV INIT-SYS /* Invalid Payload block. Parameter value
parameter. not valid. */

Requested loopback type is not FAC IDNV OPR-LPBK /* Invalid Payload block. Parameter value
or TERM. not valid. */

Invalid sequence number. IDNV RTRV-AO /* Invalid Payload Block. Sequence

Requested does not exist */

Invalid interface number. IDNV RTRV-ADJ- /* Invalid parameter value. Invalid

ROUTER interface name */

76.MTFP50/30, Rev B January 2018 Page 30-61

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Invalid interface number. IDNV RTRV-ADJ- /* Invalid parameter value. Invalid
ROUTER interface name */

Requested period is not current IDNV RTRV-PM /* Invalid Payload block. Parameter
period. value(s) not valid for specified AID */

Requested period is not supported. IDNV RTRV-PM /* Invalid Payload block. Parameter
value(s) not valid for specified AID */

Schedule a PM report which has a IDNV SCHED-PMREPT /* Invalid Payload block. Parameter value
start time < 10 minutes from for start time has to be at least 10 minutes
previous collection interval. after the collection interval */

Parameter value(s) not supported. IDNV SET-TH /* Invalid Payload block. Parameter
SET-PMMODE value(s) not valid for specified AID */
SET-TCAMODE

Cannot reuse the last passwords. IDNV ED-PID /* New password cannot be one of the
ENT-USER-SECU most recently used passwords. */
ED-USER-SECU

Received value of TIMEZONE IDRG ED-NE /* Invalid Payload Block. Parameter value
parameter that is out of range. out of range */

Signal rate out of range. IDRG ENT-{X} /* Invalid Payload Block. Parameter value
out of range */

EXPRATE parameter value out of IDRG ENT-{X} /* Invalid Payload Block. Parameter value
range. ED-{X} out of range */

Wavelength out of legal parameter IDRG ENT-EQPT /* Invalid Payload Block. Parameter value
value range. out of range */

Wavelength out of legal parameter IDRG MEAS-OPTPWR /* Invalid Payload Block. Parameter value
value range. out of range */

Hour parameter out of range. IDRG OPR-ARC /* Invalid Payload Block. Parameter value
out of range */

Minute parameter out of range. IDRG OPR-ARC /* Invalid Payload Block. Parameter value
out of range */

Sequence number greater than IDRG RTRV-AO /* Invalid Payload Block. Parameter value
9999. out of range */

Backup schedule period parameter IDRG SCHED-BKUP- /* Invalid Payload Block. Parameter value
out of range. MEM out of range */

Received negative value for IDRG SCHED-PM /* Invalid Payload Block. Parameter value
parameter <numrept>. out of range */

Offset value too large. IDRG SCHED-PM /* Invalid Payload Block. Parameter value
out of range */

Out-of-range value received for IDRG SET-ATTN /* Invalid Payload Block. Parameter value
attenuation parameter. out of range */

Invalid month value. IDRG SET-DAT /* Invalid Payload Block. Parameter value
out of range */

Page 30-62 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Invalid year value. IDRG SET-DAT /* Invalid Payload Block. Parameter value
out of range */

Invalid day value. IDRG SET-DAT /* Invalid Payload Block. Parameter value
out of range */

Invalid hour value. IDRG SET-DAT /* Invalid Payload Block. Parameter value
out of range */

Invalid minute value. IDRG SET-DAT /* Invalid Payload Block. Parameter value
out of range */

Invalid second value. IDRG SET-DAT /* Invalid Payload Block. Parameter value
out of range */

Output gain parameter value out of IDRG SET-GAIN-OTS /* Invalid Payload Block. Parameter value
range. out of range */

Input gain parameter value out of IDRG SET-GAIN-OTS /* Invalid Payload Block. Parameter value
range. out of range */

Output power parameter value out of IDRG SET-OPTPWR- /* Invalid Payload Block. Parameter value
range. OTS out of range */

Input power parameter value out of IDRG SET-OPTPWR- /* Invalid Payload Block. Parameter value
range. OTS out of range */

Requested hour offset out of range. IDRG SET-PMDAY /* Invalid Payload Block. Parameter value
out of range */

Specified threshold value is out of IDRG SET-TH-{X} /* Invalid Payload Block. Parameter value
range. out of range */

Entity already created. IEAE ENT-{X} /* Entity to be created already exists */

User tries to one tries to enter a IEAE ENT-NODE /* Supporting entity required to perform
NODE and associate it with a requested operation is already assigned
protection pair that has already been */
associated with another NODE. Or
user tries to create a second hub
NODE in a shelf.

Specified cross-connect already IEAE ENT-CRS- /* Entity to be created already exists */

exists.

ENT-EQPT received for card that is IEAE ENT-EQPT /* Entity to be created already exists */
already provisioned.

ENT-EQPT received for implicitly IEAE ENT-EQPT (for MS /* Entity to be created already exists */
created shelf. or PS)

Try to enter an already existing NTP IEAE ENT-NTPPEER /* Entity to be created already exists */
peer.

Supporting entity is not assigned. IENE All ENT commands /* Supporting entity required to perform
requested operation does not exist */

Try to delete a CRS using invalid IENE DLT-CRS- /* Entity specified in the AID block does
AID. not exist */

76.MTFP50/30, Rev B January 2018 Page 30-63

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Try to delete a facility that is already IENE DLT-{X} /* Entity specified in the AID block does
deleted. not exist */

Try to delete an NTPPEER that does IENE DLT-NTPPEER /* Entity specified in the AID block does
not exist. not exist */

Alarm profile not found. IENE ED-ALMPF /* Entity specified in the AID block does
not exist */

Try to edit an NTPPEER that does IENE ED-NTPPEER /* Entity specified in the AID block does
not exist. not exist */

OCH AID specified in command has IENE ED-OCH /* Entity specified in the AID block does
a channel ID that does not RTRV-OCH not exist */
correspond to the wavelength
supported by the equipment.

Specified facility is not provisioned. IENE ENT-{X}, ED-{X} /* Entity specified in the AID block does
DLT-{X}, RTRV-{X} not exist */

Specified entity type is not IENE ENT-{X}, ED-{X} /* Entity specified in the AID block does
provisioned. DLT-{X}, RTRV-{X} not exist */

Cross-connection endpoint entity IENE ENT-CRS- /* Entity specified in the AID block does
does not exist. not exist */

Cross-connect equipment does not IENE ENT-CRS-OCH /* Entity specified in the AID block does
support wavelength specified by the not exist */
AID (for example, NO wavelength 1
supported on this transponder,
therefore specified AID is not valid at
all).

(Intermediate) Supporting IENE ENT-CRS- /* Supporting entity required to perform

equipment not created. requested operation does not exist */

Equipment entity supporting the IENE ENT-CRS- /* Supporting entity required to perform
cross-connect endpoint not created. requested operation does not exist */

Supporting CMM equipment not IENE ENT-CRS-OCH /* Supporting entity required to perform
created. requested operation does not exist */

Cross-connect end point facility IENE ENT-CRS- /* Supporting entity required to perform
supporting card family is set to requested operation does not exist */
UNKNOWN.

Supporting equipment for the facility IENE ENT-CRS- /* Supporting entity required to perform
to be cross-connected not entered. requested operation does not exist */

Cannot find TRN card of needed IENE ENT-CRS-OCH /* Supporting entity required to perform
wavelength for requested cross- requested operation does not exist */
connect facility.

User tries to provision a RSVP IENE ENT-RSVP /* Supporting entity required to perform
controller but the network partition requested operation does not exist */
does not exist or the specified TL
does not exist.

Specified equipment entity does not IENE OPR-ARC /* Entity specified in the AID block does
exist. RLS-ARC not exist */

Page 30-64 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Try to retrieve an NTPPEER that IENE RTRV-NTPPEER /* Entity specified in the AID block does
does not exist. not exist */

No such file or directory. IENE RTRV-RFILE /* Entry matching specified parameter

values does not exist */

ALMPF table ID out of range. IIAC ED-ALMPF /* Invalid AID block. Invalid AID */

PMPF table ID out of range. IIAC ED-PMPF /* Invalid AID block. Invalid AID */
Invalid NTP Peer Identifier. IIAC ENT- NTPPEER /* Invalid AID block. Invalid AID */
ED- NTPPEER
DLT- NTPPEER
RTRV-NTPPEER

Cross-connect not supported for this IIAC ENT-CRS- /* Invalid AID block. Cross-connect not
instance. supported for this AID(s) */

Cross-connect end point facility IIAC ENT-CRS- /* Invalid AID block. Invalid AID */
(IDs) not supported by end point
card family (IDs).

Shelf-slot illegal for AID specified. IIAC ENT-CRS- /* Invalid AID block. Invalid AID */

Try to create STSn cross-connection IDNC ENT-CRS-STSn /*Input data not consistent. Cross-connect
with CCT incompatible with current end points are not valid for the specified
FFP/EPG. FFP-XC combination or EPG-XC
combination*/

Card type not supported in specified IIAC ENT-EQPT /* Invalid AID block. Invalid AID */
slot.

Trying to provision an unsupported IIAC ENT-EQPT (for MS /* Invalid AID block. Invalid AID */
shelf type. or PS)

Invalid shelf id received in IIAC INIT-SYS /* Invalid AID block. Invalid AID */
equipment AID.

Slot ID component in AID is invalid IIAC INIT-SYS /* Invalid AID block. Invalid AID */
for specified shelf type.

No Protection group for the specified IIAC OPR-PROTNSW /* Invalid AID block. No Protection
AID. RLS-PROTNSW Group*/

PWS shelf cannot be created if the IIAC ENT-EQPT /* Invalid AID block. Supporting PWS
shelf prior to it in the daisy chain does not exist. */
does not exist (see ENT-EQPT for
more information)

Tried to enable a backup schedule IICM ALW- /* Cannot allow backup schedule because
when the schedule is not BKUPSCHED- some of its parameters are not
provisioned. MEM provisioned */

Tried to delete an permanently IICM DLT /* Command not valid for specified AID.
assigned entity. Entity is permanently assigned and can
not be deleted */

Tried to use ALL as AID in some IICM DLT/ED/ENT/ /* Command not valid for specified AID.
commands. RTRV The ALL AID can not be used with this
command */

76.MTFP50/30, Rev B January 2018 Page 30-65

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Delete command received for IICM DLT-EQPT /* Command not valid for specified AID.
permanently assigned card. Entity is permanently assigned and can
not be deleted */

Specified equipment entity does not IICM DLT-EQPT /* Command not valid for specified AID.
support delete command. Entity is permanently assigned and can
not be deleted */

Shelf that is Implicit created cannot IICM DLT-EQPT (for MS /* Command not valid for specified AID.
be deleted. or PS) Entity is permanently assigned and can
not be deleted */

Delete file request received. IICM DLT-RFILE /* Command not supported */

Try to edit default ALMPF table 0. IICM ED-ALMPF /* Command not valid for specified AID.
Entity does not support this feature */

Try to edit default ALMPF table 99. IICM ED-ALMPF /* Command not valid for specified AID.
Entity does not support this feature */

Specified entity type does not have IICM ED-ALMPF /* Command not valid for specified entity
ALMPF. type */

PMPF table is in use. IICM ED-PMPF /* Command not valid for specified
AID. */
Command includes SDH IICM ENT-{x} /* Input, Invalid MOD1 */
terminology (VCn, STMnT or E1) RTRV-{x} /* Input, Invalid MOD2 */
when NE is operating in SONET
Mode.

ENT-EQPT received for card that is IICM ENT-EQPT /* Command not valid for specified AID.
implicitly created. Entity is permanently assigned and
cannot be entered */

ENT-EQPT received for implicitly IICM ENT-EQPT (for MS /* Command not valid for specified AID.
created shelf. or PS) Entity is permanently assigned and
cannot be entered */

This request is not supported by the IICM Invalid command /* Input, Invalid MOD1 */
Software Management.

DGN not supported on this entity IICM MEAS-OPTPWR /* Command not valid for specified AID.
type. STA-DTRACE Entity does not support this feature */
STA-BER

ARC not supported on specified IICM OPR-ARC /* Command not valid for specified AID.
equipment. RLS-ARC Entity does not support this feature */

Loopbacks not supported on this IICM OPR-LPBK /* Command not valid for specified AID.
entity type. Entity does not support this feature */

Loopbacks are not supported by this IICM OPR-LPBK /* Command not valid for specified AID.
card. Entity does not support this feature */

Try to manually adjust an EVOA IICM SET-ATTN /* Can not adjust EVOA when no valid
when there is no OCH cross- OCH CRS provisioned */
connection.

Attenuation not supported for OCH IICM SET-ATTN /* Command not valid for specified AID.
entities of this card. Entity does not support this feature */

Page 30-66 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Attenuation not supported for this IICM SET-ATTN /* Command not valid for specified AID.
instance of OCH, although it is Entity does not support this feature */
supported for other instances of the
same card.

Try to adjust output GAIN when IICM SET-GAIN-OTS /* Cannot adjust gain when OTS power
auto-adjust power mode is enabled. adjustment mode is not MANUAL */

Try to adjust output GAIN when IICM SET-GAIN-OTS /* Command not valid for specified AID.
manual gain adjustment not Entity does not support this feature */
supported (for example, no input or
output amplifier provisioned).

Try to adjust input GAIN when IICM SET-GAIN-OTS /* Command not valid for specified AID.
manual gain adjustment not Entity does not support this feature */
supported (for example, no input or
output amplifier provisioned).

Try to adjust output POWER when IICM SET-OPTPWR- /* Cannot adjust power when OTS power
auto-adjust power mode is disabled. OTS adjustment mode is not AUTO */

Try to adjust input POWER when IICM SET-OPTPWR- /* Cannot adjust power when OTS power
auto-adjust power mode is disabled. OTS adjustment mode is not AUTO */

Cannot adjust output power when IICM SET-OPTPWR- /* Command not valid for specified AID.
EVOA not supported. OTS Entity does not support this feature */

Try to set output power on an entity IICM SET-OPTPWR- /* Command not valid for specified AID.
where it is not settable. OTS Entity does not support this feature */

Cannot adjust input power when IICM SET-OPTPWR- /* Command not valid for specified AID.
EVOA not supported. OTS Entity does not support this feature */

PMI not supported on this entity IICM SET-PMMODE /* Command not valid for specified AID.
type. Entity does not support this feature */

STA-BER not supported for IICM STA-BER /* Command not valid for specified AID.
specified facility. Entity does not support this feature */

STA-DTRACE not supported for IICM STA-DTRACE /* Command not valid for specified AID.
specified facility. Entity does not support this feature */

Filename specified in parameter IIFM COPY-RFILE with /* Invalid Payload Block. URL parameter
<srcUrl> on command where it does RFBU should not contain file name */
not apply.

File name component missing in IIFM COPY-RFILE with /* Invalid Payload Block. File name
parameter <srcUrl> on command RFR missing in URL parameter */
where it is mandatory.

Invalid character in NE name. IIFM ED-NE /* Invalid Payload block. String parameter
contains illegal characters */

Invalid character in NE location IIFM ED-NE /* Invalid Payload block. String parameter
name. contains illegal characters */

NE name too long. IIFM ED-NE /* Invalid Payload Block. String parameter
is too long */

NE Location name too long. IIFM ED-NE /* Invalid Payload Block. String parameter
is too long */

76.MTFP50/30, Rev B January 2018 Page 30-67

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Invalid character in trace. IIFM ED-OCH /* Invalid Payload block. String parameter
contains illegal characters */

Trace parameter too long. IIFM ED-OCH /* Invalid Payload Block. String parameter
is too long */

EXPTRC contains invalid IIFM ENT/ED-{X} /* Invalid Payload block. String parameter
characters. contains illegal characters */

EXPTRC string size too long. IIFM ENT/ED-{X} /* Invalid Payload Block. String parameter
is too long */

Invalid character in cross-connect IIFM ENT-CRS- /* Invalid Payload block. String parameter
circuit ID. contains illegal characters */

CKTID string has more than 46 IIFM ENT-CRS- /* Invalid Payload Block. String parameter
characters. is too long */

Equipment name too long. IIFM ENT-EQPT-{X} /* Invalid Payload Block. String parameter
ED-EQPT-{X} is too long */

Invalid character in name. IIFM ENT-EQPT /* Invalid Payload block. String parameter
ED-EQPT contains illegal characters */

IP address string length too short. IIFM ENT-NTPPEER /* Invalid Payload block. Invalid IP
address format */

PEERNAME longer than 32 IIFM ENT-NTPPEER /* Invalid Payload Block. String parameter
characters. ED-NTPPEER is too long */

Invalid switch command value IIFM OPR-PROTNSW /* Invalid Payload Block. Invalid switch
specified. command value specified*/

Invalid ntfcncde, condtype, srveff, IDNV RTRV-ALM-xx /* Invalid Payload block. Invalid data
locn or dirn parameter. RTRV-COND-xx format. */

Invalid ntfcncde value specified. IDNV RTRV-ALM_ENV /* Invalid Payload block. Invalid data
SET_ATTR_ENV format */

Invalid controltype value specified. IIFM RTRV-EXT-CONT /* Invalid Payload Block. Invalid data
Specify a valid control type value. SET-ATTR-CONT format*/

File name specified in backup IIFM SCHED-BKUP- /* Invalid Payload Block. URL parameter
schedule request where there only MEM should not contain file name */
should be a path.

Offset value not multiple of 15 IIFM SCHED-PM /* Invalid Payload block. Offset values is
minutes. not a multiple of time period */

Offset value not multiple of 1 DAY. IIFM SCHED-PM /* Invalid Payload block. Offset values is
not a multiple of time period */

Invalid character in SID. IIFM SET-SID /* Invalid Payload block. String parameter
contains illegal characters */

SID too long. IIFM SET-SID /* Invalid Payload Block. String parameter
is too long */

Cannot set EXPRATE on ED-{X}. IPEX ED-{X} /* Invalid Payload block. Extra parameters
*/

Page 30-68 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Cannot set Expected Signal Rate in IPEX ENT-{X} /* Invalid Payload block. Extra parameters
Facility other than GOPT. ED-{X} */

EXPTRC parameter set for facilities IPEX ENT-{X} /* Invalid Payload block. Extra parameters
that are not SONET. ED-{X} */

MONTRC parameter set for facilities IPEX ENT-{X} /* Invalid Payload block. Extra parameters
that are not SONET. ED-{X} */

Parameter does not apply to the IPEX Any command /* Invalid Payload block. Extra parameters
specified entity type. */
Example: TRC for an EQPT entity.

This request is not supported IPMS COPY-RFILE with /* Invalid Payload block. Missing
because the Directory is not set. SWDL or PDL mandatory parameter */

This request is not supported IPMS COPY-RFILE with /* Invalid Payload block. Missing
because the Filename is not set. SWDL or PDL mandatory parameter */

This request is not supported IPMS COPY-RFILE with /* Invalid Payload block. Missing
because the IP Address is not set. SWDL or PDL mandatory parameter */

This request is not supported IPMS COPY-RFILE with /* Invalid Payload block. Missing
because the PID is not set. SWDL or PDL mandatory parameter */

This request is not supported IPMS COPY-RFILE with /* Invalid Payload block. Missing
because the UID is not set. SWDL mandatory parameter */

Node type value received internally IPMS ED-NE /* Invalid Payload block. Missing
is UNKNOWN. mandatory parameter */

STYPE value received internally is IPMS ED-NE /* Invalid Payload block. Missing
UNKNOWN. mandatory parameter */

Missing TOCP or FROMCP. IPMS ENT-CRS- /* Invalid Payload block. Missing

mandatory field */

Cross-connect TO and FROM IPMS ENT-CRS- /* Invalid Payload block. Missing

mandatory parameters not set. mandatory parameter */

Cross-connect PATH mandatory IPMS ENT-CRS- /* Invalid Payload block. Missing

parameter not set. mandatory parameter */

Missing mandatory wavelength IPMS ENT-EQPT /* Invalid Payload block. Missing

parameter. mandatory field */

Try to provision a parameter not IDNV ED-{x} /* Invalid Payload block. Parameter not
supported by current module ENT-{x} supported by current module Hardware */
hardware.

Try to provision a parameter not IDNV ED-{x} /* Invalid Payload block. Parameter not
supported by current module ENT-{x} supported by current module Firmware */
firmware version.

AAM parameter received for an IPNV ED-OCH /* Invalid Payload block. Parameter not
OCH that does not support it. applicable for specified AID */

MONOTI parameter received for an IPNV ED-OCH /* Invalid Payload block. Parameter not
OCH that does not support it. applicable for specified AID */

76.MTFP50/30, Rev B January 2018 Page 30-69

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Signal rate not supported by this IPNV ENT-{X} /* Invalid Payload block. Parameter not
card. applicable for specified AID */

The Hold Off Timer is not utilized for IPNV ENT-FFP-OCn /* Invalid Payload block. Parameter not
the current scheme selected on the applicable for specified AID */
FFP.

EXPTRC parameter set for facilities IPNV ENT-{X} /* Invalid Payload block. Parameter not
on transponders that do not support ED-{X} applicable for specified AID */
J0 monitoring.

MONTRC parameter set for facilities IPNV ENT-{X} /* Invalid Payload block. Parameter not
on transponders that do not support ED-{X} applicable for specified AID */
J0 monitoring.

Wavelength parameter not IPNV ENT-EQPT /* Invalid Payload block. Parameter not
supported by this card type. applicable for specified AID */

CHAN parameter received for an IPNV ENT-EQPT /* Invalid Payload block. Parameter not
equipment that does not support applicable for specified AID */
wavelength provisioning.

Parameter not supported. IPNV SET-TH /* Invalid Payload block. Parameter not
SET-PMMODE applicable for specified AID */
SET-TCAMODE

Parameter does not apply to the IPNV Any command /* Invalid Payload block. Parameter not
entity specified by the current AID, applicable for specified AID */
although it is a legal parameter for
the entity type.

The ODUk is mapped to an OTUk IPNV ENT-CRS-ODUk /* Invalid Payload block. Parameter
client and has been cross-connected ENT/ED-ODUk value(s) not valid for specified AID */
at the k level. The ODU may only be
non-intrusively monitored and AIS
insertion is not permitted.

The ODUk is mapped to an OTUk IPNV ENT-CRS-ODUk /* Invalid Payload block. Parameter
client and has been cross-connected ENT/ED-ODUk value(s) not valid for specified AID */
at the k level. The ODU may only be
non-intrusively monitored and
setting the PT is not permitted.

The Super FEC type (I.4/I.7 EFEC) IPNV ED-OCH/ENT- /* Invalid Payload block. The provisioned
must be same within a facility group OCH/ED-OTU/ or default Super FEC type for the facility
when edit the Super FEC type or ENT-OTU should be the same within a facility group.
provision by default without specify */
the FEC type.

User attempts to enter a command PICC Any command /* Illegal Command Code */
that they do not have privileges for.

User tries to logout when not logged PICC CANC-USER /* Can't logout if not logged in. */
in.

User tries to login when already PICC ACT-USER /* Already logged in. */
logged in.

Page 30-70 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Password is expired. PIUI Any command /* The password expired. Change
except ACT-USER password. */
and ED-PID

Trying to create a facility on a port SAAS ENT-{x} /* Specified facility already provisioned at
interface of a module when there is a different rate */
already a facility created on that port
with a different rate.

Trying to create a module in a slot SAAS ENT-EQPT /* Multiple slot module conflict. */
that would not physically fit due to
the presence of an adjacent multislot
module.

Duplication of User Id. SAAS ENT-USER-SECU /* The UserID is already defined in the
network element. */

Cross-connect cannot be performed SAAS ENT-CRS-OCH /* Specified wavelength can not be shared
because wavelength is already ENT-FIBR-EQPT by Ring and Spur */
used.

Cross-connect cannot be performed SAAS ENT-CRS-OCH /* Half band required by specified cross
because band already in use for connect already assigned */
other type of cross-connect.

Facility endpoint is already cross- SAAS ENT-CRS- /* Specified facility already cross-
connected. connected */

Specified IP address already SAAS ENT-NTPPEER /* Specified IP address is already

assigned to other NTP peer. assigned */

Specified RTRID is alreay used on SAAS ED-OSPF /* Specified parameter is already used.*/
another OSPF controller ENT-OSPF

Modulation Format cannot be SAAS ED-OCH /* Operation denied because supported

changed on OCH-OS when entities exist, which must be deleted first.
supported facilities exist */

Loopback already active. SAOP OPR-LPBK /* Requested diagnostic already operated

*/

BER injection already enabled on SAOP STA-BER /* Requested diagnostic already operated
this facility. */

Debug trace already inserted on this SAOP STA-DTRACE /* Requested diagnostic already operated
facility. */

Attempting to provision a protection SAPR ENT-FFP /*Protection group already exists*/

group that is already in a protecting
state.

MEAS-OPTPWR request already in SDAS MEAS-OPTPWR /* Diagnostic already started */

progress.

Default Admin user cannot be SDNC DLT-USER-SECU /* Cannot delete the default admin user. */
deleted.

Admin user tries to delete himself or SDNC DLT-USER-SECU /* Failed to delete a user, cannot delete a
tries to delete another user that has user that has an active session*/
an active session.

76.MTFP50/30, Rev B January 2018 Page 30-71

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Attempting to mux an ODU1 to an SDNC ED-ODU1 /* ODUj may not be multiplexed to the
ODU2e (an ODU2 with overclocked ENT-ODU1 corresponding ODUk entity.*/
setting) is denied.

Unterminated ODUk is configured SDNC ENT-ODU2 /* DMSOURCE=ENABLED or TXSAPI,

insertion action parameters: ED-ODU2 TXDAPI, and/or TXOPER are not empty
DMSOURCE=ENABLED or on the corresponding ODUk entity.*/
TXSAPI, TXDAPI, and/or TXOPER

Received RTRV file request when a SDNR RTRV-RFILE /* Status Data Not Ready. Disk access in
disk-on-chip access is in progress progress */
(DELIVERY or INSTALL is in
progress).

The specified cross connect cannot SNCC DLT-CRS /* Cross Connect not found*/
be found. Specify a valid cross- ED-CRS
connection. The <from_id> and RTRV-CRS
<to_id> are not cross-connected
together.

Trying to create a test access SNVS CONN-TAC-STSn /* Operation denied because the
connection if the specified cross- crossconnection is involved in bridge and
connection is involved in bridge and roll operations. */
roll operations.

Trying to delete an ODUk/OTUk/ SNVS DLT-ODUk /* Operation denied because GCC is

OCHP mapping with GCC. DLT-OTUk created on the entity. */
DLT-OCH

Trying to delete an OTUk/OCH-P SNVS DLT-OTUk /* Operation denied because GCC is

with GCC mapping to its supported DLT-OCH created on the ODUk supported by the
ODUk. entity. */

Trying to delete an OCH-P/OCH-OS SNVS DLT-OCH /* Operation denied because it could

when there is external connectivity impact the traffic. The entity must be
or cross connection. disconnected/removed from external
connectivity first. */

Trying to delete FIBR entity when SNVS DLT-FIBR-EQPT /* Cannot delete fiber entity when in use
there is a cross-connection. by cross-connect*/

Trying to delete a pluggable when SNVS DLT-EQPT /* Operation denied because there is
there is explicitly provisioned explicitly provisioned supported entity
supported entity present. present on the entity. */

TOD entity is in external mode. SNVS DLT-NTPPEER /* Specified entity is not in service */

Trying to delete/modify a STS CRS SNVS ED-CRS-STSn /* Operation denied because the
but does not have INCL=YES and it DLT-CRS-STSn crossconnection is redlined. Use
is red-lined. INCL=YES to override system validation.
*/

Traffic affecting transition requested SNVS All ED or DLT /* Operation denied because it could
with no FRCD parameter. commands impact the traffic. Use the forced mode to
override system validation. */

State transition to same state SNVS Any ED command /* Operation denied because the entity is
requested. already in this state. */

Page 30-72 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Transition for explicit assignment SNVS Any ENT or DLT /* Command not valid for specified AID
entity only. command because the entity is permanently
assigned */

Backup request received while SNVS COPY-RFILE with /* Operation denied because the
database is not IS-NR. RFBU database entity is not IS-NR */

Restore request received while SNVS COPY-RFILE with /* Operation denied because it could
database is not OOS-MA. RFR impact the traffic. The entity needs to be
explicitly removed from service first. */

Try to restore database while NE is SNVS COPY-RFILE with /* Operation not allowed in current
in upgrade (Execute) state. RFR upgrade state */

This request is not supported when SNVS COPY-RFILE with /* Operation not allowed in current
upgrade state is not No Upgrade. SWDL or PDL upgrade state */

Tried to delete an entity that is SNVS DLT /* Operation denied because it could
BUSY (for example, cross- impact the traffic. All supported entities
connected). need to be first deleted.*/

Tried to delete an entity that has SNVS DLT /* Operation denied because it could
supported entities that are still impact the traffic. All supported entities
assigned. need to be first deleted.*/

Tried to delete a GCC entity SNVS DLT-GCC /* Operation denied. Specified entity or
associated with a TL owned by supporting entity owned by the control
control plane. plane.*/

Delete database command received SNVS DLT-DB /* Operation denied because it could
while IS. impact the traffic. The entity needs to be
explicitly removed from service first. */

Tried to delete NE database while SNVS DLT-DB /* Operation not allowed in current
NE is in upgrade (Execute) state. upgrade state */

Try to delete a Hub Node and there SNVS DLT-NODE /* Cannot delete a hub node if a
is a Protection Node in the Shelf. protection node exists on the same shelf.
*/

Try to delete an NTPPEER while it is SNVS DLT-NTPPEER /* Operation denied because it could
IS. impact the traffic. The entity needs to be
explicitly removed from service first. */

Try to delete an NTPPEER while it is SNVS DLT-NTPPEER /* Operation denied because it could
not OOS-MA or OOS-AUMA. impact the traffic. The entity needs to be
explicitly removed from service first. */

Trying to delete an OADMRS9 that SNVS DLT-EQPT /* Operation denied. Equipment is

is a COMMCONN source (for targeted as a COMMCONN source. */
example, a PWS)

Trying to delete a PWS when SNVS DLT-EQPT /* Operation denied. Existence of

another PWS in the “daisy chain” successive PWS shelf(s) in daisy chain. */
exists (see ENT-EQPT for more
information)

76.MTFP50/30, Rev B January 2018 Page 30-73

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Try to edit EXPRATE on entity that SNVS ED-{X} /* Operation denied because it could
is not in OOS-MA. impact the traffic. The entity needs to be
explicitly removed from service first. */

Service modification with SNVS ED-CALL /*Operation denied. Retain path not
RETAINPATH parameter for a call applicable for multi-domain calls.*/
that traverses Multi domain

Service modification with CALLID SNVS ED-CALL /*Operation denied. CALLID and NODE
and NODE parameter which do not parameter do not correspond to an
correspond to an existing call. existing call.*/

Trying to assign an explicit SNVS ED-CALL /*Operation denied. User defined

restoration path but the provided ENT-CALL restoration path does not exist.*/
expp_aid doesn't exist.

Trying to create or modify a call SNVS ED-CALL /*Operation denied. MT>1 calls not
which has a preferred restoration ENT-CALL allowed to have preferred restoration path
path containing label info and MT containing label info.*/
value greater than one.

Trying to ARR, BM, revert or make SNVS ED-CALL /* Operation denied. Another call
permanent the call when the call is OPR- operation is already in-progress. */
having another operation in- ADMREROUTE
progress. OPR-CPSW

Try to edit call name on node that is SNVS ED-CALL /*Operation denied. Call name is editable
not source node of the call. at origination node only. */

User requests a computed SNVS ENT-CALL /* Operation Denied. The system failed to
restoration path but the system fails compute the preferred restoration path. */
to compute a path which meets the
diversity constraint.

Attempting to edit the CPPF using SNVS ED-CPPF /* Operation denied. Profile is currently in-
the ED-CPPF command when the use by an OSPF area entity. */
CP protocol profile is currently
referenced from an OSPF area
entity.

Request received to change SNVS ED-NE /* Operation denied because it could

subnode config when NE is not impact the traffic. The entity needs to be
OOS. explicitly removed from service first. */

Request to modify an existing SNVS ED-NE /* Operation denied. Cannot change NE

configuration which has incorrect configuration with unsupported CMM-
CMM-CMM OCH connections. CMM or BMM-BMM connections. */

ED-NE with new NETYPE, STYPE, SNVS ED-NE /* Operation denied because it could
SPANA, SPANB without impact the traffic. Use the forced mode to
CMDMDE=FRCD parameter. override system validation. */

Try to place an NTPPEER entity IS SNVS ED-NTPPEER /* Operation denied because the entity is
that is already IS. already in this state. */

Try to place an NTPPEER entity SNVS ED-NTPPEER /* Operation denied because the entity is
OOS that is already OOS. already in this state. */

Page 30-74 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
OSC entity is not OOS-MA. SNVS ED-OSC /* Operation denied because it could
impact the traffic. The entity needs to be
explicitly removed from service first. */

Try to edit OSPF entity to OOS SNVS ED-OSPF /* Operation denied because it could
without using the CMDMDE=FRCD impact the traffic. Use the forced mode to
parameter. override system validation */

Trying to set the REVERSION as SNVS ED-SLPF /*Operation denied. Current

YES with a protection level which is protection_level not allowed with
not supporting reversion function. REVERSION=YES.*/

Try to reset SNMP service while SNVS ED-SNMP /* Operation denied because it could
SNMP entity is IS-NR. impact the traffic. The entity needs to be
explicitly removed from service first. */

Trying to create SCN TL on GCC SNVS ENT-TL /* Operation denied because the resource
which is enabled on MCN. is used in MCN. */

Trying to create MCN TL on GCC SNVS ENT-TL /* Operation denied because the resource
which is enabled in SCN through is used in SCN. */
creating SCN TL on it.

Trying to create an GCC with an SNVS ENT-GCC /* Operation denied because the provided
entity which is not able to support entity does not support this map. */
GCC.

The entity has some GCC created SNVS ENT-GCC /* Operation denied because the creation
on which can not co-exist with the of GCCs of the entity conflict with the exist
provided one. For example, trying to one. */
create a type of GCC to an entity but
another type of GCC is mapping to
it.

Trying to modify the GCC which is SNVS ENT-GCC /* Operation denied. Entity owned by
associated with a TL owned by control plane. Use CMDMDE or INCL (as
control plane. appropriate) to override system
validation.*/

One of the dynamic validation rules SNVS ENT-CRS- /* System not in valid state */
(against already existing XC) failed.

Generic dynamic validation of cross- SNVS ENT-CRS- /* System not in valid state */
connect failed.

Facility is not provisioned. SNVS ENT-CRS- /* Facility is not provisioned*/

ENT-FFP-

Protection facility not available for SNVS ENT-CRS- /* Protection facility not available
cross-connect. for cross connect */

Entering modules in wrong slots on SNVS ENT-EQPT /*Current NE configuration does not
main shelf or port shelf. support the specified card-slot
combination. */

Trying to create a PWS when the SNVS ENT-EQPT /* Operation denied. Requires
previous PWS in the “daisy previous PWS shelf to be provisioned
chain” does not exist (see ENT- */
EQPT for more information)

76.MTFP50/30, Rev B January 2018 Page 30-75

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
State transition is not valid in current SNVS ENT /* Operation denied. Invalid state
context or not supported. ED transition */
DLT

When setting NENDALS=YES on SNVS ENT-{x} /* Operation denied. Cannot set

facility associated with 1-way circuit, ED-{x} NENDALS when the facility is supporting
the command is denied. 1WAY connection. */

When creating OCH-OS involving SNVS ENT-OCH /* Operation Denied. Second OCH-OS
modulation 2X150G8QAM, the two port is already provisioned. */
needed OCH-OS are not available.

When OCH-OS port#1 on the OSM- SNVS ENT-OCH /* Operation Denied. Parameter value not
4F is configured with modulation ED-OCH valid - Coupled OCH-OS not consistent. */
2X150G8QAM, creating/editing
OCH-OS on port#2 contains
inconsistent parameters.

When creating OCH-OS with SNVS ENT-OCH /* Operation Denied. Coupled OCH-OS
modulation 2X150G8QAM and the ENT-OTUC3 does not exist. */
provisioning order is not followed.

When editing/deleting OCH-OS SNVS ED-OCH /* Operation Denied. Parameter value not
involving modulation 2X150G8QAM, DLT-OCH valid - Coupled OCH-OS still present. */
the two OCH-OS are not de-coupled
from each other.

COLD restart requested on SNVS INIT-SYS /* Operation denied because it could

equipment that is not OOS-MA. impact the traffic. The entity needs to be
explicitly removed from service first. */

Y-Cable FFP of the module is in SNVS INIT-SYS /* Y-Cable FFP is in WTR state. Warm
WTR status. reset could be traffic affected if Y-Cable
FFP is in WTR. Waiting for FFP to finish
the WTR timer or manually switch away
from the WTR state. */

Module is not physically present in SNVS MEAS-OPTPWR /* Operation denied because specified
the shelf. entity is not equipped */

Module is in the shutdown state (for SNVS MEAS-OPTPWR /* Operation denied because the entity is
example, the ejector latch has been shutdown.*/
activated)

Specified equipment is not present. SNVS OPR-ARC /* Operation denied because specified
RLS-ARC entity is not equipped */

Trying to revert the traffic when the SNVS OPR-CPSW /* Operation denied. Call is not revertible
call is not in the right status. or not ready for revert. */

Loopback request received for entity SNVS OPR-LPBK /* Maintenance request denied because
that is in-service. entity is in-service.*/

Loopback request received when SNVS OPR-LPBK /* Maintenance request denied because
not is OOS-MA. entity is in-service.*/

Try to ARR a connection but there is SNVS OPR- /* Operation denied. Routing error.*/
no available resources in the ADMREROUTE
network.

Page 30-76 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
In the case of a given nominal SNVS OPR- /* Operation denied. Current connection is
working/protect connection which ADMREROUTE same as nominal connection now, only
has no link failure reroute ever specifying nominal connection is
happened, all links on the allowed".*/
connection are opearationlly
inservice, CP only allows ARR the
nominal working/protect connection
but deny ARR the current working/
protect connection.

The ARR in NORM mode is denied if SNVS OPR- /*Operation Denied. The operation may
the node received the request has ADMREROUTE interrupt traffic. Use FRCD mode to allow
no capability to perform data plane traffic interruption*/
hitless operations.

Entity state cannot be changed to IS SNVS ED-{X} /* Entity can not be returned to service
because a loopback is active. while loopback active */

Entity state can not be changed to IS SNVS ED-{X} /* Entity can not be returned to service
because diagnostic mode is active. while diagnostic mode active */

Try to adjust EVOA on a OCH which SNVS SET-ATTN-OCH /* Operation denied because it could
is not OOS-MA. impact the traffic. The entity needs to be
explicitly removed from service first. */

Try to initiate more than 1 PRBS test SNVS STA-BER /* Operation denied because a PRBS test
at one time. is already in-progress */

Administrative switch request priority SNVS OPR-PROTNSW /* Operation Denied. Request priority is
is not higher than the current state or not higher than current state. */
previous switch request.

Exercise can only be run on a SNCS OPR-PROTNSW /* Operation Denied. EXER only valid in
bidirectional SNC protection group. bidirectional SNC protection group. */

Trying to release protection switch SNVS RLS-PROTNSW /* Operation denied because the entity is
when no local administrative switch not in a right state. */
request is in effect or not in WTR
state.

Clear can only be executed on local SNVS RLS-PROTNSW /* Operation Denied. Clear can only be
request. executed on local request. */

RLS-PROTNSW cannot be SNVS RLS-PROTNSW /* Operation Denied. RLS-PROTNSW

executed if no manual command is cannot be executed if no manual
outstanding. command is outstanding. */

Attempting to provision an unprotect SNVS ENT-CALL /* Operation denied because attempt to

call service by referencing a provision an unprotect service on an
protected link ends(e.g OTUk TL protected link, service protection level
with two OTUk facilities having Y- needs to be aligned with protection level
Cable FFP enabled. of a NULL link.*/

TL specified in command has no SNVS RTRV-LADJ-TL /*Neighbor discovery information is not

neighbor discovery information. RTRV-TCE-TL available for the specified TL.*/

The CRC check failed for an SNVS OPR-UPG- /*Operation denied because the
upgrade file. EXECUTE system is not in an error free state.*/

76.MTFP50/30, Rev B January 2018 Page 30-77

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Entity cannot be entered because it SSRE ENT-TNALNKMAP /* Status, System Resources Exceeded.
exceeds the number of entities ENT-TL Entity cannot be supported. Maximum
supported by the system. ENT-CALL number of entities already configured. */
Example: Try to enter a TL when the ENT-OSPFADJ
maximum number of TLs are ENT-OSPFAREA
already configured. ENT-STAT-RTE
ENT-GCC

Try to change the IDNC ED-EQPT /* Input data not consistent. Cannot edit
OTN_MAP_GROUP or parameter OTN_MAP_GROUP or
EOS_MAP_GROUP parameter on a EOS_MAP_GROUP when there is any
SSM-2S when there is any pre- pre-provisioned facility or entity
provisioned facility or entity. associated with the module. */

Attempting to provision a protection SAPR ENT-EPG /* Protection group already exists */

group that is already in a protecting
state.

Can not create equipment protection SNVS ENT-EPG /* Operation denied because the specified
group because equipment have working and protection equipment have
mismatched parameter values conflicting configuration parameters. */
(example: different values for
OTN_MAP_GROUP or
EOS_MAP_GROUP parameters).

Can not create equipment protection SNVS ENT-EPG /* Operation denied because the specified
group because equipment has pre- working or protection equipment has pre-
provisioned cross connection that provisioned cross connection in which
involved the entity associated with there is entity associated with virtual port
virtual port 99 of backplane 99. */
(example: ODUk, TTPVCn,
TTPSTSn).

Can not delete equipment protection SNVS DLT-EPG /* Operation denied because the specified
group because working module has working equipment has pre-provisioned
pre-provisioned entity associated entity associated with virtual port 99. */
with virtual port 99 of backplane
(example: ODUk, TTPVCn,
TTPSTSn). Need delete all the entity
associated with virtual port 99 on
working module then the EPG group
could be deleted

Can not provision a facility or entity SNVS ENT-{} /* Operation denied because can not
with virtual port 99 on backplane for ED-{} provision facility or entity associated with
a module that is in Equipment DLT-{} virtual port 99 on protection module. */
Protection Group and provisioned as
protection module.

Can not create equipment protection SNVS ENT-EPG /* Operation denied because the specified
group because equipment has pre- working or protection equipment has pre-
provisioned entity or facility provisioned entity or facility associated
associated with virtual port 99 of with virtual port 99. */
backplane (example: ODUk,
TTPVCn, TTPSTSn).

Page 30-78 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 3. Error Codes for TL1 Output Responses

Table 3.4 Error Codes - Command Specific (Continued)

TL1 Applicable TL1
Error Context Description Error Command Comment / Additional Text
Can not provision a port side facility IDNC ENT-OC/STMn /* The internal 4x Framer slices resource
at front panel on SSM-2S module on the port group have been occupied for
due to the hardware port restrictions. EOS_MAP_GROUP. Only 12x 2.5G
For example only allowed to Framer slices could be used by both front
provision 4x STM16 facilities panel and backplane OC/STMn facilities
because the max allowed bandwidth hence impact the max. supported facility
for that port group on front panel is number even the bandwidth is enough.
10G, provision the fifth facility is The facility cannot be configured without
denied. interrupting existing circuits. */

Can not provision a port side facility IDNC ENT-OC/STMn /* The internal 4x Framer slices resource
at front panel on SSM-2S module on the port group have been occupied for
due to the software resource EOS_MAP_GROUP. Only 12x 2.5G
allocation algorithm when Framer slices could be used by both front
EOS_MAP_GROUP parameter panel and backplane OC/STMn facilities
configured. For example only hence impact the max. supported facility
allowed to provision max. 4xOC3 number even the bandwidth is enough.
facilities when also The facility cannot be configured without
OTN_MAP_GROUP configured interrupting existing circuits. */
even the 10G bandwidth is enough
to support up to 8x OC3/12 facilities.

Can not provision a port side IDNC ENT-OC/STMn /* The internal 4x2.5G Framer slices
STM64/OC192 facility on SSM-2S group on the port group have been
module due to the hardware port fragmented due to provision/de-provision
restrictions. For example with so a 10G facility could not be supported
provision and de-provision there even there bandwidth is enough. The
could be fragment issue for a facility cannot be configured without
continues 4x2.5G Framer slice interrupting existing circuits. */
which are used to support a 10G
facility.

Can not provision a STM/OCn IDNC ENT-OC/STMn /* The port index is physically exclusive
facility associated with virtual port 99 with pre-provisioned facility’s port index. */
on SSM-2S module due to the
physical exclusive of port index 1 v.s
7-10; 2 v.s 11-14; 3 v.s 15-18, 4 v.s
19-22; 5 v.s 23-26; 6 v.s. 27-30 . For
example there is pre-provisioned
STM64-20-1-99-1 facility, then the
provision of any STM16 facility like
STM16-20-1-99-{7-10} is denied.

Comment Block Format For Control Plane Commands

3.15 Additional text for an error message occurs in response to an input control
plane command. It supplies additional information on the reported abnormal/
erroneous condition to allow the user to better understand routing, signaling and
general software errors generated by a control plane managed network.

76.MTFP50/30, Rev B January 2018 Page 30-79

3. Error Codes for TL1 Output Responses TL1 Command Reference Manual

3.16 The Error Message Comment Block For Control Plane Command table
below provides the parameter descriptions for the following message format. All
parameters are optional.
[<cr><lf>^^^RsvpErrorCode-Value=^<rsvp_code>-<rsvp_value>]
[<cr><lf>^^^RouterAreaId=<router_area_id>]
[<cr><lf>^^^NodeID=<node_id>]
[<cr><lf>^^^IntfNodeID=<if_index_node_id>
<cr><lf>^^^IfIndex=<dotted_decimal_if_index>^(0x<hex_if_index>)]
[<cr><lf>^^^ErrorString=<error_string>]
[<cr><lf>^^^CPErrorCode=<cp_error_code>]
[<cr><lf>^^^TID=<sid>]
[<cr><lf>^^^LinkAID=<TL_aid>
[<cr><lf>^^^LinkResource=<linkaid_resource>]
[<cr><lf>^^^TPAID=<tp_aid>]

Table 3.5 Error Message Comment Block For Control Plane Command
Parameter Description
rsvp_code Identifies the RSVP Error Code delivered in the error
message.

rsvp_value Identifies the RSVP Error Value delivered in the error

message.

router_area_id Identifies the Router Area where the error occurred.

node_id Identifies the node where the error was generated.

if_index_node_id Identifies the node of the link where the failure occurred.

dotted_decimal_if_index IfIndex of the link where the failure occurred in dotted decimal
format.

hex_if_index IfIndex of the link where the failure occurred in hex format.

error_string Supplies additional information on the reported abnormal/

erroneous condition for the control plane command. Zero or
more error strings may be delivered.

cp_error_code A Coriant code, in the format of E0001-E9999, to provide

additional troubleshooting information.

sid Identifies the system where the error occurred.

TL_aid Topological link access identifier where the error occurred.

linkaid_resource Resource associated with the LinkAID where the error

occurred.

tp _aid Termination point where the error occurred.

Page 30-80 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 4. TL1 Provisionable Parameters

4. TL1 Provisionable Parameters

Default Attribute Values on Entity Creation

4.01 Many modules and facilities of the mTera UTP network element (NE) are
implicitly created/assigned using default values for the provisionable attributes.
4.02 The Table below shows the default values used for the parameters used
by various modules and facilities.

Table 4.1 Default Values

Used in TL1
Parameter Default Value Commands Purpose
aaaproto RADIUS ENT-AAA Specifies the AAA protocol between the NE and
ED-AAA the AAA server
RTRV-AAA

aaarole AUTH ENT-AAA Specifies the AAA role supported by this AAA
ED-AAA entity.
RTRV-AAA

AttAdjModeEgres AUTO ED-OCH Specifies the Egress attenuation adjustment

s mode.

almmsg ALW ENT-USER-SECU Specifies if REPT^ALM and REPT^ALM-ENV

ED-USER-SECU messages are allowed or inhibited on this user.

almProfile 99 ENT-{x} Specifies the alarm profile table for the

ED-{x} equipment.

almtype MISC RTRV-ALM-ENV Identifies the current name of the alarm

RTRV-ATTR-ENV conditions when unassigned by SET-ATTR-
ENV and the alarm contact is detected.

APAInMode AUTO ED-OTS Specifies the input power adjustment mode.

APAOutMode AUTO ED-OTS Specifies the output power adjustment mode.

AppSrcInterface NA ED-TCPIP Specifies the Application Source Interface. The

RTRV-TCPIP Application Source Interface is used by an
application (for example,RADIUS) to identify the
NE ip address that is used for the application.

arcinterval 8-00 OPR-ARC Specifies the time interval to be used in the

operation of the Alarm Report Control feature
(HH-MM).

arcmode QI OPR-ARC Specifies the mode of Alarm Report Control.

ATPSEnabled ENABLED ED-OTS Specifies the state of the automatic laser

shutdown functionality at the line side interface.

backup_mem_aid SERVER ALW/INH/RTRV/ Specifies the type of backup memory that is the
SCHED- destination.
BKUPSCHED-
MEM

76.MTFP50/30, Rev B January 2018 Page 30-81

4. TL1 Provisionable Parameters TL1 Command Reference Manual

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
bidir_switch disabled ED-PPG-ODUk Specifies if the protection type is unidirectional
or bidirectional.

cbrmap SYNC ED-OCn/STMn Specifies the Mapping mode of constant bitrate

ENT-OCn/STMn/ signal.
STSn

CCT 2WAY ENT-CRS Specifies the cross-connection type.

circuitIdentification "" (empty string) ENT-CRS Specifies an additional field to identify the cross-
connection.

ClkType G709 ENT-OTU2 Specifies the rate of the OTU2 port side facility
For OTU2, G709 = 10.709 Gb/s.

coefficient_k 50 ED-OMS Specifies the K Coefficient which is the

correction factor for power preemphasis
calculation.

ConnectedTo "" (empty string) ENT-{x} Specifies an additional field to identify where a
ED-{x} facility is connected when attribute
ED-OCH ExtConnectivity = YES.

commandMode NORM Most of the ED- Specifies the way in which the command is
commands. executed.

controltype LIGHT SET-ATTR-CONT Specifies the type of contact.

CPName "" (empty string) ENT-EQPT Specifies an additional field to identify the entity.
ED-EQPT

current_request NR RTRV-PPG-ODUk Retrieves the current request,for example,

Local SF-W or remote SF-W-R

datatype DB ALW/INH/RTRV/ Specifies the type of backup memory that is the

SCHED- source.
BKUPSCHED-
MEM

dbchgmsg ALW ENT-USER-SECU Specifies if REPT^DBCHG messages are

ED-USER-SECU allowed or inhibited on this user.

degrade_interval 7 ENT/ED-OCH Indicates the consecutive number of one

ENT/ED-ODUF/ second intervals with the number of detected
ODU0/ODU1/ block errors exceeding the block error threshold
ODU2 for each of those seconds for the purposes of
ED-ODU4 SDBER detection.

dirn BTH ED-ALMPF Specifies the direction of an event/occurrence in

RTRV-ALM the system.
RTRV-ALMPF
RTRV-COND
RTRV-TCA
SCHED-PMREPT
SET-TH

eol_channel_coun 96 ED-OMS Specifies the planned end-of-life channel count

t for the link.

eon_msg ENABLED ED-OSC Specifies if EON traffic is enabled or disabled on

OSC facility.

Page 30-82 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 4. TL1 Provisionable Parameters

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
evtmsg ALW ENT-USER-SECU Specifies if REPT^BKUP, REPT^EVT,
ED-USER-SECU REPT^EVT^FXFR, REPT^EVT-SESSION
messages are allowed or inhibited on this user.

expdapi "" (empty string) ED/ENT/RTRV- Specifies 15 characters representing the

OCH expected DAPI.
ED/ENT/RTRV/-
OTUk
ED/RTRV-ODUk
RTRV-PTHTRC-
OTS
RTRV-PTHTRC-
OTUk
RTRV-PTHTRC-
ODUk
RTRV-PTHTRC-
OTS

expsapi "" (empty string) ED/ENT/RTRV- Specifies 15 characters representing the

OCH expected SAPI.
ED/ENT/RTRV/-
OTUk
ED/RTRV-ODUk
ED/ENT/RTRV-
OTS
RTRV-PTHTRC-
OCH
RTRV-PTHTRC-
OTUk
RTRV-PTHTRC-
ODUk
RTRV-PTHTRC-
OTS

expoper "" (empty string) ED/ENT/RTRV- Specifies 32 characters representing the

OTUk expected value for the Operator Specific area of
ED/RTRV-ODUk the TTI.
ED/ENT/RTRV-
OTS
RTRV-PTHTRC-
ODUk
RTRV-PTHTRC-
OTUk
RTRV-PTHTRC-
OTS

txoper "" (empty string) ED/ENT/RTRV- Specifies 32 characters representing the

OTUk transmitted value for the Operator Specific area
ED/RTRV-ODUk of the TTI.
RTRV-PTHTRC-
ODUk
RTRV-PTHTRC-
OTUk
RTRV-PTHTRC-
ODUk

76.MTFP50/30, Rev B January 2018 Page 30-83

4. TL1 Provisionable Parameters TL1 Command Reference Manual

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
txoper \”<TID>,<ShelfID>, ED/ENT/RTRV- Specifies 32 characters representing the
<SlotID>\” OTS transmitted value for the Operator Specific area
RTRV-PTHTRC- of the TTI.
OTS

extchan NA ED/ENT/RTRV- Specifies if the transponder is connected to

OCH a ROADM module within the same NE
(value =NA) or connected to external
equipment.
exptrc "" (empty string) ENT-OCn Specifies the expected J0 trail trace
ENT-STMn identification.
ED-OCn
ED-STMn

ExtConnectivity NO ENT-{x} Specifies if the following facilities are connected

ED-{x} between 2 modules that are within the same NE
ED-OCH (value = NO) or between 2 modules that are in
two different NEs (value = YES).

fecType SUPER for OCH-P ED-OCH Specifies the type of FEC supported on the
REGULAR for ENT-OTUk OCH-P or OTUk facilities.
OTUk ED-OTUk

fsa_tilt 0 ED-OTS Specifies the Fiber Spectral Attenuation Tilt.

HoldOffProt 0 ED-OCH Specifies the number of milliseconds of hold-off

time before a protection switch occurs on a
GOPT FFP or before laser shutdown on OCH-P
facility.

uout 60 ED-SECU-SYS Specifies the time interval (in days) for disabling
a user account that has not been used during
that interval. Inactive users have their
STATUS=DISABLED once this interval is
reached.

in_pwr_correct 0 ED-OCH Specifies a power correction value for an optical

channel. Applies to the complete optical path
and is set at the ingress point to the MTERA/
HIT7300 link control domain.

irt 60 ED-SECU-SYS Specifies the time interval (in days) for

generating an INACTIVE Event Condition type
for a user account that has not been used
during that interval.

lci_ip_address 169.254.0.1 ED-IP Specifies the IP address of the local craft

interface port on the SPM (LCI port).

lci_ip_network_m 255.255.0.0 ED-IP Specifies the IP network mask applicable.

ask

lci_default_gatew 0.0.0.0 ED-IP Specifies the local craft interface default

ay_ip_address gateway IP address to access the customer
Telecom Network (DCN).

level 1 RTRV-RFILE Identifies whether to retrieve the contents of the

specified directory or all.

Page 30-84 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 4. TL1 Provisionable Parameters

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
location "" (Empty string) ED-NE Specifies the name of the location of this
particular NE.

locn NEND ED-ALMPF Identifies the location in reference to the entity

INIT-REG identified by the aid.
RTRV-ALM
RTRV-ALMPF
RTRV-COND
All PM/TH/TCA
related commands

locn NEND RTRV-PMMODE Identifies the location of the PM montype

SET-PMMODE

lpbktype FACILITY OPR-LPBK Identifies the loopback type.

RLS-LPBK

loginTriesNum 3 ED-SECU-SYS Specifies the maximum number of consecutive

and invalid login attempts before an account is
suspended.

montrc DISABLED ENT-OCn Specifies the monitored trace identification

ENT-STMn mode.
ENT-OTUk
ENT-OCH
ED-ODUk
ED-OCn
ED-STMn
ED-OCH
ED-ODUk
ED-OTUk

montype ALL SCHED-PMREPT When no <montype>is provided, the command

applies to ALL <montype> supported by the
equipment or facility.

msgtype ALL RTRV-PTHTRC- Specifies the type of trace message to be

OCH retrieved.
RTRV-PTHTRC-
OTS
RTRV-PTHTRC-
OTUk
RTRV-PTHTRC-
ODUk

NendALS NO ENT-{x} This parameter, when set to YES, shutdowns

ED-{x} port side laser upon a port side incoming failure
(such as LOS/LOF/LOSYNC).

NendALS may only be set to yes if PROT

(protection) is set to YES.

Two connected devices by fiber cannot both be

configured with NENDALS=YES. When a failure
occurred, both devices would disable their
lasers and traffic recovery would not be
possible.

76.MTFP50/30, Rev B January 2018 Page 30-85

4. TL1 Provisionable Parameters TL1 Command Reference Manual

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
ntfcncde ALL RTRV-ALMPF Indicates the notification code (severity level)
associated with the condition type.

NTPName "" (Empty string) ENT-NTPPEER Specifies the customer entered additional field
to label the NTP Peer.

numrept blank field SCHEDPMREPT Specifies the number of intervals during which a
report occurs.

ochAttAdjModeIng AUTO ED-OMS Specifies is all OCH-L within an OMS are in

ress Automatic or Manual attenuation adjustment
mode within the Ingress WSS when
OTSMODE=MTERA or HIT7300.

ochAttAdjModeEg AUTO ED-OMS Specifies is all OCH-L within an OMS are in

ress Automatic or Manual attenuation adjustment
mode within the Egress WSS when
OTSMODE=MTERA or HIT7300.

odu_switchtype UNUSED RTRV-ODU Specifies ODU ownership.

oms_pwr_correct 0 ED-OCH Specifies a power correction value for an optical

channel for each preemphasis section.

opl 0 SET-OPTPWR- Specifies the target output power level per

OTS channel at the DWDM Line Out interface.

oplAdj DISABLED ED-OTS Specifies the support of manual provisioning of

(OTSMODE= the output power level (opl) on the OTS facility.
MTERA or 7100)

ENABLED ED-OTS
(OTSMODE=
HIT7300)

osnr_pwr_correct 0 ED-OMS Specifies the power correction factor to consider

_100g for 100G wavelengths within the OMS.

osnr_pwr_correct -15 ED-OMS Specifies the power correction factor to consider

_40g for 40G wavelengths within the OMS.

osnr_pwr_correct -40 ED-OMS Specifies the power correction factor to consider

_10g for 10G wavelengths within the OMS.

OTSExpTrc "" (empty string) ED-OTS Specifies the expected OTS trace identification.

OTSMonTrc DISABLED ED-OTS Specifies the monitored OTS trace identification

mode.

ots_trc \”<sid>,<shelfID>,< RTRV-OTS Specifies the sent OTS trace identification.

slotID>\” Where shelfID-slotID is the module AIDs of the
OTS interface where the signal is sent and
<sid> = NE TID

OTUExpTrc "" (empty string) ED-OCH-P Specifies the expected OTU trace identification.

OTUMonTrc DISABLED ED-OCH-P Specifies the monitored OTU trace identification

mode.

Page 30-86 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 4. TL1 Provisionable Parameters

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
OTUTrc Default value for ED-OCH Specifies the sent OTU trail trace identification.
OTU TTI operator
specific is the Example:
concatenation of
the first 20 If TID=CORIANT1 and AID=OCH-P-20-1-1,
characters of NE then the OTUTRC is as follows:
TID + last 8
characters of the CORIANT1(blank)(blank)(blank)(blank)(blank)(
facility AID. Unused blank)(blank)(blank)(blank)(blank)20-1-1
characters within
the first 20 and
within the last 8 are
filled with blanks.

overwrite NO COPY-RFILE Allows restore of a database backup file with a

different system ID than the ID of the target
system.

password_aging 30 ENT-USER-SECU Specifies the Password Aging Interval in days.

ED-USER-SECU

pid_encrypt N ENT-USER-SECU Indicates if a password, snmp authentication

ED-USER-SECU passphrase and snmp privacry passphrase are
ACT-USER sent encrypted.
ED-PID

pmmsg ALW ENT-USER-SECU Specifies if REPT^PM messages are allowed or

ED-USER-SECU inhibited on this user.

pmstate OFF SET-PMMODE Specifies if PM data is being collected or not.

port 22 ENT- Specifies the logical port number associated

FTPSERVER with the FTP server IP address.
ED-FTPSERVER
COPY-RFILE
RTRV-
BKUPSCHED-
MEM
SCHED-BKUP-
MEM

protection NO ENT-{x} Specifies if the facility has been provisioned as

ED-{x} protected or not.

editablePrimarySt IS ENT- Specifies the primary state of the entity being

ate provisioned.

passwordCount 5 ED-SECU-SYS Specifies the number of previously used

passwords remembered by the system for one
UID, which cannot be repeated when changing
to a new password.

pwdcompl YES ED-SECU-SYS This attribute specifies if password complexity

checking is enabled (YES) or disabled (NO).

pwdexpire_login_ 3 ENT-USER-SECU Specifies the number of times that an existing

num ED-USER-SECU password can still be used once it has expired.

pwd_update_waiti 25 ENT-USER-SECU Specifies the number of days that a user must

ng_period ED-USER-SECU wait before they can update their password.

76.MTFP50/30, Rev B January 2018 Page 30-87

4. TL1 Provisionable Parameters TL1 Command Reference Manual

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
radretry 3 ENT-AAA Specifies the number of attempted Access-
ED-AAA Request messages to a single AAA server
RTRV-AAA before failing authentication.

radtimeout 5 ENT-AAA Specifies the response timeout of Access-

ED-AAA Request messages sent to a AAA server in
RTRV-AAA seconds.

raman_tilt_coeff 0 ED-OTS Specifies the Raman Tilt Coefficient.

reset NO ED-SNMP When set to YES this option resets the SNMP
entity to its initial default state and restores the
default SNMP username/password.

rvrtv NO ENT-FFP Specifies if protection switching is revertive or

ED-FFP not.
ED-PPG

scheme YCABLE ENT-FFP Specifies the protection scheme.

SDThreshold 10E-6 ENT-OCn Specifies the threshold for signal degraded.

ED-OCn
ENT-STMn
ED-STMn
ENT-STSn
ED-STSn

SFThreshold 10E-3 ENT-OCn Specifies the threshold for signal failed for
ED-OCn SONET signal.
ENT-STMn
ED-STMn
ENT-STS1
ED-STS1

SFThreshold 10E-4 ENT-ST3C/12c/ Specifies the threshold for signal failed for
48c/192c SONET STSnC concatenated signal.

shelf_mount HRZ ED-EQPT Specifies the orientation of a shelf as horizontal.

ShelfName "" (empty string) ENT-EQPT Specifies an additional field to identify the shelf.
ED-EQPT

sid CORIANT SET-SID Specifies the system identification code to be

assigned to the NE.

sigdir ALL MEAS-OPTPWR Specify the side and direction of a signal.

site "" (empty string) ED-NE Can be used to specify the name or CLLI of the
site where this NE is located.

spanb "" (empty string) ED-NE Specifies the kind of input amplification used in
the B direction (for Network OLT only).

srveff NSA ED-ALMPF Indicates if an alarm is service affecting or non

service affecting.

SsmSupported NO ENT-OCn Indicates if the OCn facility supports SSM

ED-OCn generation.
ENT-STMn
ED-STMn

Page 30-88 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 4. TL1 Provisionable Parameters

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
storusg YES RTRV-RFILE Indicates whether to return the storage usage
and available free storage of the storage entity.

suspensionDurati 60 ED-SECU-SYS Specifies the duration (in seconds) of UID

on suspension following consecutive invalid login
attempts.

tcastate ON SET-TCAMODE Specifies whether or not TCAs are being

reported

tgt_drop_pwr -150 ED-OCH Specifies the target dropped power for a

channel that is being dropped.

txdapi "" (empty string) ED/ENT/RTRV- Specifies 15 characters representing the

OCH transmitted DAPI.
ED/ENT/RTRV/-
OTUk
ED/RTRV-ODUk
ED/ENT/RTRV-
OTS
RTRV-PTHTRC-
OCH
RTRV-PTHTRC-
OTUk
RTRV-PTHTRC-
ODUk
RTRV-PTHTRC-
OTS

txsapi "" (empty string) ED/ENT/RTRV- Specifies 15 characters representing the

OCH transmitted SAPI.
ED/ENT/RTRV/-
OTUk
ED/RTRV-ODUk
ED/ENT/RTRV-
OTS
RTRV-PTHTRC-
OCH
RTRV-PTHTRC-
OTUk
RTRV-PTHTRC-
ODUk
RTRV-PTHTRC-
OTS

tmout Default depends on ENT-USER-SECU Specifies the Session Time Out Interval. If there
User Access ED-USER-SECU are no messages between the user and the NE
Privilege Code over the Time Out interval, the session is logged
(UAP). off.

Default is 15
minutes for A8, 30
minutes for A7 and
A6, 45 minutes for
A4, and 60 minutes
for A2.

76.MTFP50/30, Rev B January 2018 Page 30-89

4. TL1 Provisionable Parameters TL1 Command Reference Manual

Table 4.1 Default Values (Continued)

Used in TL1
Parameter Default Value Commands Purpose
tmper 15-MIN ED-ALMPF Specifies the time-period increments during
RTRV-PMSCHED which PM data are collected.
RTRV-TCA
SCHED-PMREPT
SET-TH

user_status PASSWORD ENT-USER-SECU Specifies the default status for all TL1 Users
AGED ED-USER-SECU except default Admin1 User.

user_status ENABLED ENT-USER-SECU Specifies the default status for default uid
ED-USER-SECU Admin1 User.

warning_msg "" (empty string) ED-WARNING Specifies the warning message to be displayed
in the response to ACT-USER command when
a user logs into the NE.

wtr 300 ENT-FFP Specifies wait-to-restore value (in seconds).

ED-FFP
ED-PPG

Page 30-90 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

5. Alarm and Condition Tables

Equipment Alarm Table

5.01 The NE is pre-equipped with 22 Alarm Profile Tables (Tables 0, 1-20 and
99). The Equipment Alarm Profile Table below shows the default equipment Alarm
Profile Table (Table 99). This table cannot be edited. There is also another Alarm
Profile Table (Table 0) which puts all condition types to NR (Not reported). Table 0
cannot be modified. However there are 20 other tables (Tables 1-20) that are pre-
configured like Table 99 and can be modified using ED-ALMPF command to
modify the severity of a condition type associated to an equipment.
5.02 Note that a default Alarm Profile Table can be assigned to all entities in a
NE when doing basic commissioning by provisioning the SYSALMPF parameter in
the ED-NE command.

Table 5.1 Default Equipment Alarm Profile Table (Table 99)

Transient Condition / Standing Condition

Service Affecting / Non-Service Affecting

OSM-4S/OSM-5C/OSM-4C/OSM-4F/
SSM-2S/OSM-2S/OSM-2C/OSM-1S/

SAIM/SDM/SEIM/SIOM/STIM
Near END / Far END

BFM/SFM/MFM
MFAB/MFAB2
STPM/STPM8

FAN/FAN8

SFP/SFPP
CFP/CFP2

OADMRS

CD4D8
CDCP
SLOT

OMD
PWS

DCM
OCC

SH

CONDTYPE

AGCOOG S N N M
C S E N
A

CONTCOM S N N M M M M M
C S E N N N N N
A

S S N C C C CR
C A E R R R

DBSYNC S N N M
C S E N
A

FAB-FAIL S S N C
C A E R

FAB-INVCONF S S N C
C A E R

76.MTFP50/30, Rev B January 2018 Page 30-91

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.1 Default Equipment Alarm Profile Table (Table 99) (Continued)

Transient Condition / Standing Condition

Service Affecting / Non-Service Affecting

OSM-4S/OSM-5C/OSM-4C/OSM-4F/
SSM-2S/OSM-2S/OSM-2C/OSM-1S/

SAIM/SDM/SEIM/SIOM/STIM
Near END / Far END

BFM/SFM/MFM
MFAB/MFAB2
STPM/STPM8

FAN/FAN8

SFP/SFPP
CFP/CFP2

OADMRS

CD4D8
CDCP
SLOT

OMD
PWS

DCM
OCC

SH
CONDTYPE

FRNGSYNC S N N M
C S E J
A

HLDOVRSYNC S N N M
C S E J
A

IDP S N N M M
C S E J J
A

INHALM S N N M
C S E N
A

MEA S N N M M M
C S E N J J
A

S S N C C C CR C C C C C C C
C A E R R R R R R R R R R

MEA-HWVM S N N M M M M
C S E J J J J
A

S S N C CR C C
C A E R R R

NET S N N M
C S E J
A

NOFILTER S N N M
C S E N
A

PROTNA S N N M MN1
C S E N
A

PWRA S N N M M M M MN
C S E N N N N
A

Page 30-92 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.1 Default Equipment Alarm Profile Table (Table 99) (Continued)

Transient Condition / Standing Condition

Service Affecting / Non-Service Affecting

OSM-4S/OSM-5C/OSM-4C/OSM-4F/
SSM-2S/OSM-2S/OSM-2C/OSM-1S/

SAIM/SDM/SEIM/SIOM/STIM
Near END / Far END

BFM/SFM/MFM
MFAB/MFAB2
STPM/STPM8

FAN/FAN8

SFP/SFPP
CFP/CFP2

OADMRS

CD4D8
CDCP
SLOT

OMD
PWS

DCM
OCC

SH
CONDTYPE

PWRA1 S N N M
PWRA2 C S E N
PWRA3 A

PWRB S N N M M M M MN
C S E N N N N
A

PWRB1 S N N M
PWRB2 C S E N
PWRB3 A

REPLUNIT-MISS S N N M M M M
C S E N N N N
A

S S N C C C C CR C C C
C A E R R R R R R R

RUP-DEGR S N N M M M M MN M M M
C S E N N N N N N N
A

S S N C
C A E R

RUP-FAIL S N N M M M MN
C S E N N N
A

S S N C C C C C CR C C C C
C A E R R R R R R R R R

SBANR S N N M M MN
C S E N N
A

SDF S N N M M M M MN
C S E N N N N
A

76.MTFP50/30, Rev B January 2018 Page 30-93

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.1 Default Equipment Alarm Profile Table (Table 99) (Continued)

Transient Condition / Standing Condition

Service Affecting / Non-Service Affecting

OSM-4S/OSM-5C/OSM-4C/OSM-4F/
SSM-2S/OSM-2S/OSM-2C/OSM-1S/

SAIM/SDM/SEIM/SIOM/STIM
Near END / Far END

BFM/SFM/MFM
MFAB/MFAB2
STPM/STPM8

FAN/FAN8

SFP/SFPP
CFP/CFP2

OADMRS

CD4D8
CDCP
SLOT

OMD
PWS

DCM
OCC

SH
CONDTYPE

SDM-ID S N N M
C S E J
A

THERMAL S N N M M
C S E N N
A

S S N C
C A E R

Note:
1. Applies to SSM-2S when configured as 1+1 EPG protection

Page 30-94 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.2 Equipment TCA Profile Table

Transient Service Near
Condition / Affecting / END /
Standing Non-Service Far STPM
CONDTYPE Condition Affecting END EQPT STPM8
INIT TC NSA NE NA NA

MGMNTSYNC TC NSA NE NA NA

PKTDB-FAIL TC SA NE NA NA

UPG-COMPLD TC NSA NE NA NA

UPG-FAIL TC NSA NE NA NA

76.MTFP50/30, Rev B January 2018 Page 30-95

5. Alarm and Condition Tables TL1 Command Reference Manual

Facility Alarm Profile Table

5.03 The NE is pre-equipped with 22 Alarm Profile Tables (Tables 0, 1-20 and
99). The Facility Alarm Profile Table below shows the default facility alarm profile
table (Table 99). This table cannot be edited. There is also another Alarm Profile
Table (Table 0) which puts all condition types to NR (Not reported). Table 0 cannot
be modified. However there are 20 other tables (Tables 1-20) that are pre-
configured like Table 99 and can be modified using ED-ALMPF command to
modify the severity of a condition type associated to a facility.
5.04 Note that a default Alarm Profile Table can be assigned to all entities in a
NE when doing basic commissioning by provisioning the SYSALMPF parameter in
the ED-NE command.

Table 5.3 Facility Alarm Profile Table (Default Table 99)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH

AIS S N N N
C S E A
A

AIS-L S N N N N N N
C S E A A A A
A

AIS-P S N N N
C S E A
A

AOPE S S N C
C A E R

BDI S N F N
C S E R
A

BDI-O S N F N
C S E R
A

BDI-P S N F N
C S E R
A

BDI-OTU S N F N N
C S E R R
A

BDI-ODU S N F N
C S E R
A

BERSD- S N N M
ODU C S E N
A

Page 30-96 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
BERSD- S N N M M M
OTU C S E N N N
A

BERSD-L7 S N N M M M M
C S E N N N N
A

BERSD-P S N N M
C S E N
A
7
BERSF-L S N N M M M M
C S E N N N N
A

S S N C C C C
C A E R R R R

BERSF-P S N N M
C S E N
A

S S N C
C A E R

CABL_ S N N M
LOS C S E N
A

S S N C C C C
C A E R R R R

CSF-LOS- S N N N N N
GFP C S E A A A
A

CSF- S N N N N N
LOSYNC- C S E A A A
GFP A

CSF-FDI- S N N N N N
GFP C S E A A A
A

CSF-OPU S N N N N N N N N N N
C S E A A A A A A A A
A

CSF-RDI- S N N N N N
GFP C S E A A A
A

FDI-O S N N N N
C S E R R
A

76.MTFP50/30, Rev B January 2018 Page 30-97

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
FDI-P S N N N N
C S E R R
A

FERSD-E S N N M
C S E N
A

FERSF-E S S N C
C A E R

FOP-NR S N N M
C S E N
A

FOP-PM S N N M
C S E N
A

FREQOFF S N N M M M M M
C S E N N N N N
A

GEN-AIS S N N N N
C S E A A
A

LCK-ODU S N N M
C S E N
A

LF S N N N N N
C S E A A A
A

LINKDOW S N N M
N C S E N
A

S S N C
C A E R

LINKFLAP- S S N C
E C A E R

LOA M
J

LOF S S N C C C C
C A E R R R R

S N N M M M M M M
C S E N N N N N N
A

Page 30-98 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
LOF-OTU S S N C C C
C A E R R R

S N N M M
C S E N N
A

LOFD-GFP S S N C C C
C A E R R R

LOFLOM S S N C
C A E R
1

S N N M
C S E N
1
A

LOM S S N C
C A E R

S N N M
C S E N
A

LOOMFI S S N C
C A E R
5

LOM-OTU S S N C C
C A E R R

S N N M M
C S E N N
A

LOP-P S S N C
C A E R

S N N M
C S E N
A
4
LOS S S N C C C C C C C C C C C C C C C C
C A E R R R R R R R R R R R R R R R R

S N N M M M M M M M M M M M M M M
C S E N N N N N N N N N N N N N N
A

76.MTFP50/30, Rev B January 2018 Page 30-99

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
4
LOSYNC S S N C C C C C
C A E R R R R R

S N N M M M M M
C S E N N N N N
A

LPBK S N N M M M M M M M M M M M
FACILITY C S E N N N N N N N N N N N
A

LPBK S N N M M M M M M M M M M M
TERM C S E N N N N N N N N N N N
A

MSIM- S S N C
ODU C A E R
2

S N N M
C S E N
2
A

OCI-OCH S N N M
C S E N
A

OCI-ODU S N N M
C S E N
A

ODU-AIS S N N N
C S E A
A

OPTU S N N M
C S E N
A

OPOVLD S S N C
C A E R

OTU-AIS S N N N N
C S E A A
A

PLM-GFP S N N M M M
C S E N N N
A

PLM-ODU S S N C
C A E R

S N N M
C S E N
A

Page 30-100 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
PLM-P S S N C
C A E R

S N N M
C S E N
A

PMI S N N N
C S E R
A

PROTNA S N N M M M M M M M
C S E N N N N N N N
A

RF S N F N N N
C S E A A A
A

RFI-L S N F N N N N
C S E R R R R
A

RFI-P S N F N
C S E R
A

SYNCREF S N F M M M M M
FAIL8 C S E N N N N N
A

TIM S S N C
C A E R

TIM- S N N M M M M
R(when C S E N N N N
MONTRC= A
ENABLED-
NOAIS)6

TIM- S S N C C C C
R(when C A E R R R R
MONTRC=
ENABLED)
7

TIM-ODU S S N C
C A E R
3

S N N M
C S E N
3
A

76.MTFP50/30, Rev B January 2018 Page 30-101

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
TIM-OTU S S N C C C
C A E R R R

S N N M M M
C S E N N N
A

TRDI-E S N F N
C S E R
A

UNEQ-P S S N C
C A E R

S N N M
C S E N
A

T-BE-FEC- S N N N N N
15M C S E A A A
A

T-BE-FEC- S N N N N N
1D C S E A A A
A

T-BER- S N N N N
FEC-HT- C S E A A
15M A

T-BER- S N N N N
FEC-HT- C S E A A
1D A

T-CD-LT- S N N N N
15M C S E A A
A

T-CD-LT- S N N N N
1D C S E A A
A

T-CD-HT- S N N N N
15M C S E A A
A

T-CD-HT- S N N N N
1D C S E A A
A

T-CV-OTU- S N N N N N
15M C S E A A A
A

T-CV-OTU- S N N N N N
1D C S E A A A
A

Page 30-102 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
T-CVL- S N N N N N N
15M C S E A A A A
A

T-CVL-1D S N N N N N N
C S E A A A A
A

T-CVP- S N N N
15M C S E A
A

T-CVP-1D S N N N
C S E A
A

T-CVS- S N N N N N N N
15M C S E A A A A A
A

T-CVS-1D S N N N N N N N
C S E A A A A A
A

T-DELAY- S N N N
ODU-HT- C S E A
15M A

T-DELAY- S N N N
ODU-HT- C S E A
1D A

T-DELAY- S N N N
ODU-LT- C S E A
15M A

T-DELAY- S N N N
ODU-LT- C S E A
1D A

T-DGD- S N N N N
HT-15M C S E A A
A

T-DGD- S N N N N
HT-1D C S E A A
A

T-EB- S N N N
ODU-15M C S E A
A

T-EB- S N N N
ODU-1D C S E A
A

76.MTFP50/30, Rev B January 2018 Page 30-103

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
T-ES- S N N N
ODU-15M C S E A
A

T-ES- S N N N
ODU-1D C S E A
A

T-ES-OTU- S N N N N N
15M C S E A A A
A

T-ES-OTU- S N N N N N
1D C S E A A A
A

T-ESL-15M S N N N N N N
C S E A A A A
A

T-ESL-1D S N N N N N N
C S E A A A A
A

T-ESP- S N N N
15M C S E A
A

T-ESP-1D S N N N
C S E A
A

T-ESS- S N N N N N N N
15M C S E A A A A A
A

T-ESS-1D S N N N N N N N
C S E A A A A A
A

T-FC-L- S N N N N N N
15M C S E A A A A
A

T-FC-L-1D S N N N N N N
C S E A A A A
A

T-FCP- S N N N
15M C S E A
A

T-FCP-1D S N N N
C S E A
A

Page 30-104 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
T-LOSS- S N N N N N N N N N N N N N N
15M C S E A A A A A A A A A A A A
A

T-LOSS- S N N N N N N N N N N N N N N
1D C S E A A A A A A A A A A A A
A

T-OPR-HT- S N N N N N N
15M C S E A A A A
A

T-OPR-HT- S N N N N N N
1D C S E A A A A
A

T-OPR-LT- S N N N N N N
15M C S E A A A A
A

T-OPR-LT- S N N N N N N
1D C S E A A A A
A

T-OPT-HT- S N N N N
15M C S E A A
A

T-OPT-HT- S N N N N
1D C S E A A
A

T-OPT-LT- S N N N N
15M C S E A A
A

T-OPT-LT- S N N N N
1D C S E A A
A

T-OSNR- S N N N N
LT-15M C S E A A
A

T-OSNR- S N N N N
LT-1D C S E A A
A

T- S N N N
PJCDIFFP- C S E A
15M A

T- S N N N
PJCDIFFP- C S E A
1D A

76.MTFP50/30, Rev B January 2018 Page 30-105

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
T- S N N N
PJCSPDE C S E A
T-15M A

T- S N N N
PJCSPDE C S E A
T-1D A

T- S N N N
PJCSPGE C S E A
N-15M A

T- S N N N
PJCSPGE C S E A
N-1D A

T-SE-15M S N N N N N N
C S E A A A A
A

T-SE-1D S N N N N N N
C S E A A A A
A

T-SEFSS- S N N N N N N N
15M C S E A A A A A
A

T-SEFSS- S N N N N N N N
1D C S E A A A A A
A

T-SES- S N N N
ODU-15M C S E A
A

T-SES- S N N N
ODU-1D C S E A
A

T-SES- S N N N N N
OTU-15M C S E A A A
A

T-SES- S N N N N N
OTU-1D C S E A A A
A

T-SESL- S N N N N N N
15M C S E A A A A
A

T-SESL-1D S N N N N N N
C S E A A A A
A

Page 30-106 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
T-SESP- S N N N
15M C S E A
A

T-SESP- S N N N
1D C S E A
A

T-SESS- S N N N N N N N
15M C S E A A A A A
A

T-SESS- S N N N N N N N
1D C S E A A A A A
A

T-UASL- S N N N N N N
15M C S E A A A A
A

T-UASL- S N N N N N N
1D C S E A A A A
A

T-UASP- S N N N
15M C S E A
A

T-UASP- S N N N
1D C S E A
A

T-UAS- S N N N
ODU-15M C S E A
A

T-UAS- S N N N
ODU-1D C S E A
A

T-UAS- S N N N N N
OTU-15M C S E A A A
A

T-UAS- S N N N N N
OTU-1D C S E A A A
A

T-UASS- S N N N N N N
15M C S E A A A A
A

T-UASS- S N N N N N N
1D C S E A A A A
A

76.MTFP50/30, Rev B January 2018 Page 30-107

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
T-UBE- S N N N N N
FEC-15M C S E A A A
A

T-UBE- S N N N N N
FEC-1D C S E A A A
A

T-DROP- S N N N N N N
15M C S E A A A A
A

T-DROP- S N N N N N N
1D C S E A A A A
A

T-PKT- S N N N N N N
15M C S E A A A A
A

T-PKT-1D S N N N N N N
C S E A A A A
A

T-BCPKT- S N N N N N N
15M C S E A A A A
A

T-BCPKT- S N N N N N N
1D C S E A A A A
A

T-MCPKT- S N N N N N N
15M C S E A A A A
A

T-MCPKT- S N N N N N N
1D C S E A A A A
A

T-CRCAE- S N N N N N N
15M C S E A A A A
A

T-CRCAE- S N N N N N N
1D C S E A A A A
A

T-USPKT- S N N N N N N
15M C S E A A A A
A

T-USPKT- S N N N N N N
1D C S E A A A A
A

Page 30-108 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.3 Facility Alarm Profile Table (Default Table 99) (Continued)

STM1/STM4/STM16
OC3/OC12/OC48

OTUC2/OTUC3
9
NEND/FEND
CONDITION

E1 / T1/2MH

TTPSTSn
10
SA / NSA

MGTETH
OCH-OS

TGLAN
OCH-P
STM64
OC192

OCH-L
TC/SC

GBEP

ODUk
ODUCn

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE

VCG
FGE

OTS
ETH
T-OSPKT- S N N N N N N
15M C S E A A A A
A

T-OSPKT- S N N N N N N
1D C S E A A A A
A

T-FRAG- S N N N N N N
15M C S E A A A A
A

T-FRAG- S N N N N N N
1D C S E A A A A
A

T-JABR- S N N N N N N
15M C S E A A A A
A

T-JABR-1D S N N N N N N
C S E A A A A
A

T-UTIL-HT- S N N N N N N
15M C S E A A A A
A

T-UTIL-HT- S N N N N N N
1D C S E A A A A
A

1. LOFLOM is only applicable to low order ODUj (multiplexed ODUj within ODUk) on OSM modules.
2. MSIM-ODU is only applicable to low order ODUj (multiplexed ODUj within ODUk) on OSM modules. Alarm is not
supported for ODU4 multiplexed into ODUC2 and ODUC3 on OSM-4F.
3. TIM-ODU is only applicable where monitoring of the incoming trace message is supported on the ODUk.
4. GBEP facility supported by an electrical SFP does not support the LOS alarm, and does not support LOSYNC when
TTT+GMP mapped to ODU0.
5. Applies to ODU4 only.
6. Applies to the OC/STMn facility map to ODUk.
7. Applies to the OC/STMn facility terminated to STSn for path switching.
8. Applies to the OC/STMn/E1/T1/2Mh facility that is configured as system reference timing resource.
9. 2MH facilty only support LOS, FREQOFF and SYNCREFFAIL.
10. ODUCn does not support any alarm, it is listed in this table for completeness.

76.MTFP50/30, Rev B January 2018 Page 30-109

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.4 Facility TCA Profile Table

OC3/OC12/OC48

OTUC2/OTUC3
NEND/FEND
CONDITION

SA / NSA

OCH-OS

TGLAN
OCH-P
OC192
OCH-L
TC/SC

GBEP

ODUk

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE
FGE

OTS
T-BE-FEC T N N N N N
C S E A A A
A

T-BER-FEC- T N N N N
HT C S E A A
A

T-CD-LT T N N N N
C S E A A
A

T-CD-HT T N N N N
C S E A A
A

T-CV-OTU T N N N N N
C S E A A A
A

T-CVL T N N N N
C S E A A
A

T-CVP T N N N
C S E A
A

T-CVS T N N N N N
C S E A A A
A

T-DELAY- T N N N
ODU-HT C S E A
A

T-DELAY- T N N N
ODU-LT C S E A
A

T-DGD-HT T N N N N
C S E A A
A

T-EB-ODU T N N N
C S E A
A

T-ES-ODU T N N N
C S E A
A

T-ES-OTU T N N N N N
C S E A A A
A

T-ESL T N N N N
C S E A A
A

Page 30-110 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.4 Facility TCA Profile Table (Continued)

OC3/OC12/OC48

OTUC2/OTUC3
NEND/FEND
CONDITION

SA / NSA

OCH-OS

TGLAN
OCH-P
OC192
OCH-L
TC/SC

GBEP

ODUk

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE
FGE

OTS
T-ESP T N N N
C S E A
A

T-ESS T N N N N N
C S E A A A
A

T-FC-L T N N N N
C S E A A
A

T-FCP T N N N
C S E A
A

T-LOSS T N N N N N N N N N N N N
C S E A A A A A A A A A A
A

T-OPR-HT T N N N N N N
C S E A A A A
A

T-OPR-LT T N N N N N N
C S E A A A A
A

T-OPT-HT T N N N N
C S E A A
A

T-OPT-LT T N N N N
C S E A A
A

T-OSNR-LT T N N N N
C S E A A
A

T-PJCDIFFP T N N N
C S E A
A

T- T N N N
PJCSPDET C S E A
A

T- T N N N
PJCSPGEN C S E A
A

T-SE T N N N N N N
C S E A A A A
A

T-SEFSS T N N N N N
C S E A A A
A

76.MTFP50/30, Rev B January 2018 Page 30-111

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.4 Facility TCA Profile Table (Continued)

OC3/OC12/OC48

OTUC2/OTUC3
NEND/FEND
CONDITION

SA / NSA

OCH-OS

TGLAN
OCH-P
OC192
OCH-L
TC/SC

GBEP

ODUk

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE
FGE

OTS
T-SES-ODU T N N N
C S E A
A

T-SES-OTU T N N N N N
C S E A A A
A

T-SESL T N N N N
C S E A A
A

T-SESP T N N N
C S E A
A

T-SESS T N N N N N
C S E A A A
A

T-UASL T N N N N
C S E A A
A

T-UASP T N N N
C S E A
A

T-UAS-ODU T N N N
C S E A
A

T-UAS-OTU T N N N N N
C S E A A A
A

T-UASS T N N N N
C S E A A
A

T-UBE-FEC T N N N N N
C S E A A A
A

T-DROP T N N N N N N
C S E A A A A
A

T-PKT T N N N N N N
C S E A A A A
A

T-BCPKT T N N N N N N
C S E A A A A
A

T-MCPKT T N N N N N N
C S E A A A A
A

Page 30-112 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.4 Facility TCA Profile Table (Continued)

OC3/OC12/OC48

OTUC2/OTUC3
NEND/FEND
CONDITION

SA / NSA

OCH-OS

TGLAN
OCH-P
OC192
OCH-L
TC/SC

GBEP

ODUk

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE
FGE

OTS
T-CRCAE T N N N N N N
C S E A A A A
A

T-USPKT T N N N N N N
C S E A A A A
A

T-OSPKT T N N N N N N
C S E A A A A
A

T-FRAG T N N N N N N
C S E A A A A
A

T-JABR T N N N N N N
C S E A A A A
A

T-UTIL-HT T N N N N N N
C S E A A A A
A

FSTOPROT T N N N N N N N N
C S E A A A A A A
A

FSTOWKG T N N N N N N N N
C S E A A A A A A
A

LOCKOUT T N N N N N N N N
C S E A A A A A A
A

MANTOPRO T N N N N N N N N
T C S E A A A A A A
A

MANTOWKG T N N N N N N N N
C S E A A A A A A
A

WTR T N N N N N N N N
C S E A A A A A A
A

NOREQ T N N N N N N N N
C S E A A A A A A
A

DNR T N N N N N N N N
C S E A A A A A A
A

SDONPROT T N N N N N N N N
C S E A A A A A A
A

76.MTFP50/30, Rev B January 2018 Page 30-113

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.4 Facility TCA Profile Table (Continued)

OC3/OC12/OC48

OTUC2/OTUC3
NEND/FEND
CONDITION

SA / NSA

OCH-OS

TGLAN
OCH-P
OC192
OCH-L
TC/SC

GBEP

ODUk

OTUk
TYPE

STSn
OMS
OCH

OSC
HGE
FGE

OTS
SDONWKG T N N N N N N N N
C S E A A A A A A
A

SFONPROT T N N N N N N N N
C S E A A A A A A
A

SFONWKG T N N N N N N N N
C S E A A A A A A
A

WKSWPR T N N N N N N N N
C S E A A A A A A
A

PRSWWK T N N N N N N N N
C S E A A A A A A
A

Page 30-114 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Logical Entity Alarm Profile Table

5.05 The NE is pre-equipped with 22 Alarm Profile Tables (Tables 0, 1-20 and
99). The Logical Entity Default Alarm Profile Table below shows the default logical
entity alarm profile table (Table 99). All these condition types are Near End (NEND)
and their direction is NA. Some of these condition types can have their severity
modifed using ED-ALMPF command.
5.06 Note that a default Alarm Profile Table can be assigned to all entities in a
NE when doing basic commissioning by provisioning the SYSALMPF parameter in
the ED-NE command.

Table 5.5 Logical Entity Default Alarm Profile Table (Table 99)

PPPL/PPPS/GCC
PPPMS/PPPRS/
RSVPADJ
NTPPEER
SA/NSA
TC/SC

SW
DB

TL
CONDITION TYPE
ADJ_LOST SC NSA MN

CONF_FAIL SC NSA MJ

MISWIRED SC NSA MJ

MISMATCHED SC NSA MJ

NTPPU SC NSA MN

PROGFLT SC NSA MN

CABS SC NSA MJ

SWPATCH SC NSA NA

SWUPGRD SC NSA NA

SWUPGRD-ACTION-REQD SC NSA NA

SWUPGRD-COMMIT SC NSA MJ

SWUPGRD-WAIT SC NSA MN

Table 5.6 Logical Entity TCA Profile Table

RSVPADJ
NTPPEER
SA/NSA
TC/SC

SECU
SW
DB

CONDITION TYPE
DL-CEF-COMPLD TC NSA NA

PDL-COMPL TC NSA NA

INSTALL-CEF-COMPLD TC NSA NA

INSTALL-CEF-FAIL TC NSA NA

76.MTFP50/30, Rev B January 2018 Page 30-115

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.6 Logical Entity TCA Profile Table (Continued)

RSVPADJ
NTPPEER
SA/NSA
TC/SC

SECU
SW
DB
CONDITION TYPE
INSTALL-CEF-IP TC NSA NA

PATCHAPPLY-IP TC NSA NA

PATCHAPPLY-FAIL TC NSA NA

PATCHAPPLY-COMPL TC NSA NA

SECULOGROLL TC NSA NA

SWDL-COMPL TC NSA NA

SWINST-IP TC NSA NA

SWINST-FAIL TC NSA NA

SWINST-COMPLD TC NSA NA

SWABORT-IP TC NSA NA

SWABORT-FAIL TC NSA NA

SWABORT-COMPLD TC NSA NA

SWABORT-PENDING TC NSA NA

SWEXEC-IP TC NSA NA

SWEXEC-FAIL TC NSA NA

SWEXEC-COMPLD TC NSA NA

SWEXEC-PARTIAL TC NSA NA

SWCOMM-IP TC NSA NA

SWCOMM-FAIL TC NSA NA

SWCOMM-COMPLD TC NSA NA

SWPATCH-ABT TC NSA NA

SWUPGRD-ABT TC NSA NA

INACTIVE TC NSA NA

INTRUSION TC NSA NA

USERLOCK TC NSA NA

Page 30-116 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Condition Type
5.07 The Condition Types and Definitions table below lists the types and
definitions of conditions supported by the NE. Conditions starting with "T-"
indicates a threshold crossing condition. Note that for RUP-DEGR and RUP-FAIL
alarms, the description might be more detailed depending on the specific failure.

Table 5.7 Condition Types and Definitions

Affected
Condition Type Condition Description Source Type
ADJ_LOST Adjacency Lost Coriant RSVPADJ

ADMIN_RRT_FAIL Administratively requested reroute failed Coriant CALL

ADMIN_RRT_NOTATT Administratively requested reroute not Coriant CALL

attempted

ADMIN_RRT_SUCC Administratively requested reroute Coriant CALL

successful

AIS Alarm Indication signal GR-833 Facility

AIS-L Alarm Indication signal - Line GR-833 Facility

AIS-P Alarm Indication signal - Path GR-833 Facility

ALMTYPE Alarm Type GR-833 Facility

(condition type for environment alarms)

AOPE Aggregate Output Power Exceeded Coriant Facility

AGCOOG AGC Out of Gain Coriant Facility

AUTO_DELETED Call Deleted Autonomously Coriant CALL

BDI Backward Defect Indicator ITU G.709 / Facility

G798

BDI-O Backward Defect Indicator - Overhead ITU G.709 / Facility

G798

BDI-ODU Backward Defect Indicator - ODU ITU G.709 / Facility

G798

BDI-OTU Backward Defect Indicator - OTU ITU G.709 / Facility

G798

BDI-P Backward Defect Indicator - Payload ITU G.709 / Facility

G798

BERSF-P Bit Error Rate Signal Fail - Path GR-833 Facility

BERSF-L Bit Error Rate Signal Fail - Line GR-833 Facility

BERSD-P Bit Error Rate Signal Degrade - Path GR-833 Facility

BERSF-P Bit Error Rate Signal Fail - Path GR-833 Facility

BERSD-ODU Bit Error Rate Signal Degrade - Optical Data Coriant Facility
Unit

CABL_LOS Cable Problem - Loss Of Signal Coriant Facility/

Equipment

76.MTFP50/30, Rev B January 2018 Page 30-117

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
CABS Connection Absent Coriant GCC

CONF_FAIL The Neighbor Discovery process was unable ITU-T G.7714 TL

to successfully negotiate

CONTCOM Control Communications Failure Coriant Equipment

Control & Timing Communications Failure
Timing Communications Failure

CSF-LOS-GFP Client Signal Failure - Loss of Signal ITU G.7041 Facility

CSF-LOSYNC-GFP Client Signal Failure - Loss of ITU G.7041 Facility

Synchronization

CSF-FDI-GFP Client Signal Failure - Local fault ITU G.7041 Facility

CSF-OPU Client Signal Fail - Optical Payload Unit ITU G.798 Facility

CSF-RDI-GFP Client Signal Failure - Remote Defect ITU-T G.7041 Facility

Indication (RDI)

DBSYNC Loss of synchronization between active and Coriant Equipment

standby SPMs

DL-CEF-COMPLD Capabiliy Extension File Download Coriant Software

Completed

DNR Do Not Revert Coriant Facility

FAB-FAIL Fabric has Failed Coriant Equipment

FAB-INVCONF Fabric Configuration is Invalid Coriant Equipment

FDI-O Forward Defect Indication - Overhead ITU G.709 / Facility

G.798

FDI-P Forward Defect Indication - Payload ITU G.709 / Facility

G.798

FERSD-E Frame Error Rate Signal Degrade - Ethernet Coriant Facility

FERSF-E Frame Error Rate Signal Failure - Ethernet Coriant Facility

FOP-NR Failure Of Protocol No Response ITU-T G.873.1 Facility

FOP-PM Failure Of Protocol Provisioning Mismatch ITU-T G.873.1 Facility

FREQOFF Frequency Offset Out of Range GR-1244 Facility

FRNGSYNC Free running synchronization mode GR-833 Equipment

FSTOPROT Force switch to protect Coriant Facility

FSTOWKG Force switch to working Coriant Facility

GEN-AIS Generic AIS ITU G.709 / Facility

G.798

HLDOVRSYNC Holdover synchronization mode GR-833 Equipment

IDP ID Prom Failure Custom Equipment

INACTIVE User Inactive <user_id> Coriant Secu

Page 30-118 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
INACTIVE (for digital Certificate EXPIRING X DAYS CERT-1 Coriant Secu
Certificate) or
Certificate EXPIRING SOON X DAYS CERT-
1
or
Certificate EXPIRED CERT-1

(Where X represents the value provisioned

for EXPMN or EXPMJ parameter.)

INHALM Real alarms are currently inhibited Coriant Equipment

INIT Initialization GR-833 Equipment

INSTALL-CEF-COMPLD Capability Extension File Installation has Coriant Software

completed successfully

INSTALL-CEF-FAIL Capability Extension File Installation has Coriant Software

failed

INSTALL-CEF-IP Capability Extension File Installation Coriant Software

inprogress

INTRUSION Unknown account attempt from Coriant Secu

<ip_address>

LCK-ODU Locked ITU G.709 / Facility

G.798

LINKDOWN Management Ethernet Link Down Coriant Facility

LINKFLAP-E Link Flap Fault - Ethernet Coriant Facility

LOCKOUT Lockout of protection Coriant Facility

LF Local Fault IEEE-802.3 Facility

RF Remote Fault IEEE-802.3 Facility

LOA Loss of Alignment ITU-T G.806 Facility

LOF Loss Of Frame GR-833 Facility

LOFLOM Loss of Frame and Loss of Multiframe ITU-T G.798 Facility

LOF-OTU Loss Of Frame ITU G.709 Facility

LOFD-GFP Loss Of Frame Delineation ITU G.7041 Facility

LOM-OTU Loss of Multiframe - OTU ITU-T G.798 Facility

LOOMFI Loss of OPU MultiFrame Identifier ITU-T G.798 Facility

LOP-P Loss Of Pointer - Path GR-833 Facility

LOS Loss Of Signal GR-833 Facility

LOSYNC Loss of Synchronization Coriant Facility

LPBKFACILITY Loopback, Facility GR-833 Facility

LPBKFTERM Loopback, Terminal GR-833 Facility

76.MTFP50/30, Rev B January 2018 Page 30-119

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
MANTOPROT Manual switch to protect Coriant Facility

MANTOWKG Manual switch to working Coriant Facility

MEA Mismatch of Equipment GR-1093 Equipment

MEA-HWVM Mismatch of Equipment - Hardware version Coriant Equipment

Mismatch

MGMNTSYNC Management System Sync Required Coriant Equipment

MGMTRST NE Management Restricted - Database OOS Coriant DB

or Offline

MISMATCHED The TTI information received previously does ITU-T G.7714 TL

not match the TTI information now received.

MISWIRED The Tx and Rx fibers used in a link are not ITU-T G.7714 TL
connected to the same port

MSIM-ODU Multiplex Structure Identifier Mismatch - ODU ITU-T G.798 Facility

NOFILTER No Air Filter Coriant Equipment

NOREQ No Request Coriant Facility

NTPPU NTP Peer Unreachable Coriant NTP

OCI-ODU Open Connection Indication ITU G.709 / Facility

(for Optical Data Unit) G798

OCI-OCH Open Connection Indication ITU G.709 / Facility

(for Optical Channel) G.798

ODU-AIS Alarm Indication Signal - ODU ITU G.709 / Facility

G.798

OPTU Optical Power Target Unreachable Coriant Facility

OPOVLD Optical Power Overload Coriant Facility

OTU-AIS Alarm Indication Signal - OTU ITU G.709/ Facility

G.798

PATCHAPPLY-IP Patch Apply in-progress Coriant Software

PATCHAPPLY-FAIL Patch Apply has failed Coriant Software

PATCHAPPLY-COMPL Patch Apply has completed successfully Coriant Software

PDL-COMPL Patch Download completed Coriant Software

PKTDB-FAIL Packet Database Restore Failed Coriant Equipment

PLM-ODU Payload Label Mismatch - ODU ITU G.798 Facility

PMI Payload Missing Indication ITU G.709 / Facility

G.798

PROGFLT Software fault or failure GR-833 Software

Page 30-120 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
PROTNA Protection Not Available GR-833 Facility/
Equipment/
SWITCHDOMA
IN/Facility

PRSWWK Protect Switch to Working Coriant Facility

PWRA Power Feed A problem GR-833 Equipment

PWRA1 Power Feed A1 problem GR-833 Equipment

PWRA2 Power Feed A2 problem GR-833 Equipment

PWRA3 Power Feed A3 problem GR-833 Equipment

PWRB Power Feed B problem GR-833 Equipment

PWRB1 Power Feed B1 problem GR-833 Equipment

PWRB2 Power Feed B2 problem GR-833 Equipment

PWRB3 Power Feed B3 problem GR-833 Equipment

RAI Remote Alarm Indication T1.231.03 Facility

REPLUNITMISS Replaceable Unit Missing GR-833 Equipment

RESTORE_RRT_FAIL Restoration Reroute failed Coriant CALL

RESTORE_RRT_NOTATT Restoration Reroute not attempted Coriant CALL

RESTORE_RRT_SUCC Restoration Reroute successful Coriant CALL

RFI-L Remote Failure Indication - Line GR-833 Facility

RFI-P Remote Failure Indication - Path GR-833 Facility

RUN Resource Unavailable Coriant Facility

RUP-DEGR Replaceable Unit Problem - Degrade Coriant Equipment

RUP-FAIL Replaceable Unit Problem - Failed Coriant Equipment

or SERDES FPGA reset Failure
or
Fan Failed Scratch Register Read/Write
Failure
or
ALL SERIAL LINKS FROM LINE-CARD
HAVE FAILED

SBANR Software Boot Abnormal Coriant Equipment

SDF Software Download Failure Coriant Equipment

SDM-ID SDM persistent Shelf Number is incorrect Coriant Equipment

SDONPROT Signal degrade on protect Coriant Facility

SDONWKG Signal degrade on working Coriant Facility

SECULOGROLL Security Log Roll Over Coriant Database

SFONPROT Signal fail on protect Coriant Facility

76.MTFP50/30, Rev B January 2018 Page 30-121

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
SFONWKG Signal fail on working Coriant Facility

SWABORT-COMPL Software Abort completed Coriant Software

SWABORT-IP Software Abort in-progress Coriant Software

SWABORT-FAIL Software Abort has failed Coriant Software

SWCOMM-COMPL Software Commit completed Coriant Software

SWCOMM-IP Software Commit in-progress Coriant Software

SWCOMM-FAIL Software Commit has failed Coriant Software

SWDL-COMPL Software Download completed Coriant Software

SWINST-IP Software Installation in-progress Coriant Software

SWINST-FAIL Software Installation has failed Coriant Software

SWINST-COMPLD Software Installation has completed Coriant Software

successfully

SWITCH-THRES Switching Threshold Crossed Coriant Facility

SWEXEC-COMPLD Software Execution has completed Coriant Software

successfully

SWEXEC-FAIL Software Execution has failed Coriant Software

SWEXEC-IP Software Execution in-progress Coriant Software

SWEXEC-PARTIAL Software Execution partially successful Coriant Software

SWINST-COMPLD Software Installation has completed Coriant Software

successfully

SWINST-FAIL Software Installation has failed Coriant Software

SWINST-IP Software Installation in-progress Coriant Software

SWPATCH-ABT Software Patching Aborted Coriant Software

SWPATCH Software Patching In Progress Coriant Software

SWUPGRD-ABT Software Upgrade Aborted Coriant Software

SWUPGRD Software Upgrade In Progress Coriant Software

SWUPGRD-COMMIT Software Upgrade Awaits Commit Coriant Software

SWUPGRD-WAIT Software Upgrade Waiting Coriant Software

SYNCREFFAIL Synchronization Reference Failure GR-253 Facility

THERMAL Power Zone AX/BX Problem where X = 1, 2, Coriant Equipment

3
or
No Module Assigned or Inserted
or
Temperature Exceeded 40 Degrees Celsius
or
Temperature Exceeded 50 Degrees Celsius

Page 30-122 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
TIM Trace identifier Mismatch on OTS G.798 Facility

TIM-R Trace identifier Mismatch - Regen Section G.798 Facility

TIM-ODU Trace identifier Mismatch on ODU G.798 Facility

TIM-OTU Trace identifier Mismatch on OTU G.798 Facility

TRDI-E Tellabs Remote Defect Indicator - Ethernet Coriant Facility

WTR Wait To Restore Coriant Facility

T-BCPKT Broadcast Packets RFC2819 Facility

T-DROP Drop Events RFC2819 Facility

T-CRCAE CRC Alignment Errors RFC2819 Facility

T-FRAG Fragments RFC2819 Facility

T-JABR Jabbers RFC2819 Facility

T-MCPKT Multicast Packets RFC2819 Facility

T-OSPKT Oversize Packets Coriant (Note: Facility

Count Packets
of 9600 octets
and over.)

T-PKT Packets RFC2819 Facility

T-USPKT Undersize Packets RFC2819 Facility

T-UTIL-HT Utilization RFC2819 Facility

T-BE-FEC Bit Error Forward Error Correction Coriant Facility

T-UBE-FEC Uncorrectable Block Error Forward Error Coriant Facility

Correction

T-BER-FEC-HT Bit Error Rate before Forward Error Coriant Facility

Correction - High Threshold

T-CV-OTU Coding Violation Count - OTU G.709 Facility

T-EB-ODU Error Block Count - Optical Data Unit ITU G.798 Facility

T-ES-ODU Errored Second - Optical Data Unit ITU G.798 Facility

T-SES-ODU Severley Errored Second - Optical Data Unit ITU G.798 Facility

T-UAS-ODU Unavailable Second - Optical Data Unit ITU G.798 Facility

T-DELAY-ODU-HT Delay measurement - Optical Data Unit - ITU G.798 Facility

High Threshold

T-DELAY-ODU-LT Delay measurement - Optical Data Unit - Low ITU G.798 Facility
Threshold

T-DGD-HT Differential Group Delay - High Threshold Coriant Facility

T-CD-LT Chromatic Dispersion - Low Threshold Coriant Facility

T-CD-HT Chromatic Dispersion - High Threshold Coriant Facility

76.MTFP50/30, Rev B January 2018 Page 30-123

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
T-OSNR-LT Optical Signal to Noise Ratio - Low Threshold Coriant Facility

T-CVP Coding Violation Count - Path GR-833 Facility

T-CVS Coding Violation Count - Section GR-833 Facility

T-ESL Errored Second Count - Line GR-833 Facility

T-ESP Errored Second Count - Path GR-833 Facility

T-ESS Errored Second Count - Section GR-833 Facility

T-FC-L Failure Count - Line GR-833 Facility

T-FCP Failure Count - Path GR-833 Facility

T-ESS Errored Second Count - Section GR-833 Facility

T-SE Symbol Error During Carrier IEEE 802.3 Facility

T-SEFSS Severely Errored Frame Second Count - GR-833 Facility

Section

T-SESL Severely Errored Second Count - Line GR-833 Facility

T-SESS Severely Errored Second Count - Section GR-833 Facility

T-SESP Severely Errored Second Count - Path GR-833 Facility

T-LOSS Loss of Signal Seconds count GR-833 Facility

T-OPR-HT Optical Power Received level - High GR-833 Facility

Threshold

T-OPT-HT Optical Power Transmission level - High GR-833 Facility

Threshold

T-OPR-LT Optical Power Received level - Low GR-833 Facility

Threshold

T-OPT-LT Optical Power Transmission level - Low GR-833 Facility

Threshold

T-PJCDIFFP Pointer Justification Count Seconds- GR-833 Facility

Difference

T-PJCSPDET Pointer Justification Count Second- Path GR-833 Facility

Detected

T-PJCSPGEN Pointer Justification Count Second- Path GR-833 Facility

Generated

T-UASL Unavailable Second Count - Line GR-833 Facility

T-UASP Unavailable Second Count - Path GR-833 Facility

T-UASS Unavailable Second Count - Section GR-833 Facility

UNEQ-P Unequipped - Path GR-833 Facility

UPG-COMPLD Module has completed software upgrade Coriant Equipment

UPG-FAIL Module has failed software upgrade Coriant Equipment

Page 30-124 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.7 Condition Types and Definitions (Continued)

Affected
Condition Type Condition Description Source Type
USERLOCK User suspended <user_id> Coriant Secu

WKSWPR Working Switch to Protect Coriant Facility

1. A Network interconnection equipment failure is raised when a problem with the NE's ability to update routing
tables is suspected. This is indicated by the fact that the OSPF task is monitored and detected as failed.
2. The TLC, PLC and CAM on the LAG are not subject to a holdoff whereas some failures such as LOS and
LOSync may require a steady state period to clear. Therefore it is possible that the TLC, PLC or CAM on the LAG
clear while the root cause failure on a supporting ETH port persists briefly before clearing.

76.MTFP50/30, Rev B January 2018 Page 30-125

5. Alarm and Condition Tables TL1 Command Reference Manual

Direction Field Table

5.08 The Direction Field Table below describes the alarms that support the
<dirn> parameter. The table displays the alarms support the attribute and also
which specific direction the attribute supports within the two possible values. The
possible values are Port to Line (TDTN-Transmit Direction Toward Network) and
Line to Port (TDTC-Transmit Direction Toward Customer).
5.09 The Direction Field Table below describes the alarms that support the
<dirn> parameter. The table displays the alarms support the attribute and also
which specific direction the attribute supportss. The possible values are TDTN
(Transmit Direction Toward Network, also sometimes thought of as "Port-to-Line"),
TDTC (Transmit Direction Toward Customer, also sometimes thought if as "Line-
to-Port"), RCV (Receive), TRMT (Transmit), and NA (Not Applicable).
5.010 The direction of an OCH-P facility is always TDTC (no matter it is port side
or line side), the direction of an OTU facility is always TDTN (no matter it is port
side or line/system side)

Table 5.8 Direction Field Table

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
GEN-AIS X X

OTU-AIS against OCH-P X

OTU-AIS against OTUk X

AIS-L X X

AIS-P/BERSD-P/BERSF-P/PLM- X
P/RFI-P/LOP-P/UNEQ-P
on STSx

AOPE-OTS, OPTU-OTS, X X
OPOVLD-OTS (on output (on input
AMPs) AMPs)

BDI-ODU X X

BDI-OTU on OCH-P X

BDI-OTU on OTUk X

BERSD-L/BERSF-L/RFI-L on OCn X

BERSD-ODU X X

BERSD-OTU on OCH-P X

BERSD-OTU on OTUk X

CABL_LOS on OCH-L X

CABL_LOS on OCH X

Page 30-126 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.8 Direction Field Table (Continued)

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
CABL_LOS on OCH-P X

CABL_LOS on OMS X

CSF-FDI-GFP/CSF-RDI-GFP X

CSF-LOS-GFP/CSF-LOSYNC- X
GFP

CSF-OPU on client facility X

LCK-ODU,OCI-ODU,ODU-AIS X X

LF X

RF X

LOF X X

LOF-OTU, LOM-OTU on OCH-P X

LOF-OTU, LOM-OTU on OTUk X

LOFD-GFP X

LOFLOM, MSIM-ODU X X

LOOMFI on ODU4 X

LOS (OCH-P) X

LOS-OCH-L X

LOS-OMS X

LOS-OSC & LOF-OSC X

LOS-OTS X

LOS (All Other Facilities) X

LOSYNC X

PLM-GFP X

PLM-ODU on ODUk X X

PROTNA on facilities configured X

for Y-Cable

PROTNA on OC/STMn facilities X

configured for 1P1, STSn
configued as UPSR

PROTNA on ODUk X

76.MTFP50/30, Rev B January 2018 Page 30-127

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.8 Direction Field Table (Continued)

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
SYNCREFFAIL on OCn facilities X
configured for system reference
timing source

TIM on OTS X

TIM-ODU X X

TIM-OTU on OCH-P X

TIM-OTU on OTUk X

TIM-R X

T-BE-FEC X X

T-BE-FEC-15M X X

T-BE-FEC-1D X X

T-BER-FEC-HT X

T-BER-FEC-HT-15M X

T-BER-FEC-HT-1D X

T-CD-LT X

T-CD-LT-15M X

T-CD-LT-1D X

T-CD-HT X

T-CD-HT-15M X

T-CD-HT-1D X

T-CV-OTU X X

T-CV-OTU-15M X X

T-CV-OTU-1D X X

T-CVL X X

T-CVL-15M X X

T-CVL-1D X X

T-CVP X X

T-CVP-15M X X

T-CVP-1D X X

T-CVS X X

Page 30-128 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.8 Direction Field Table (Continued)

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
T-CVS-15M X X

T-CVS-1D X X

T-DELAY-ODU-HT X X

T-DELAY-ODU-HT-15M X X

T-DELAY-ODU-HT-1D X X

T-DELAY-ODU-LT X X

T-DELAY-ODU-LT-15M X X

T-DELAY-ODU-LT-1D X X

T-DGD-HT X

T-DGD-HT-15M X

T-DGD-HT-1D X

T-EB-ODU X X

T-EB-ODU-15M X X

T-EB-ODU-1D X X

T-ES-ODU X X

T-ES-ODU-15M X X

T-ES-ODU-1D X X

T-ES-OTU X X

T-ES-OTU-15M X X

T-ES-OTU-1D X X

T-ESL X X

T-ESL-15M X X

T-ESL-1D X X

T-ESP X X

T-ESP-15M X X

T-ESP-1D X X

T-ESS X X

T-ESS-15M X X

T-ESS-1D X X

76.MTFP50/30, Rev B January 2018 Page 30-129

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.8 Direction Field Table (Continued)

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
T-FC-L X X

T-FC-L-15M X X

T-FC-L-1D X X

T-FCP X X

T-FCP-15M X X

T-FCP-1D X X

T-LOSS X X

T-LOSS-15M X X

T-LOSS-1D X X

T-OPR-HT X

T-OPR-HT-15M X

T-OPR-HT-1D X

T-OPR-LT X

T-OPR-LT-15M X

T-OPR-LT-1D X

T-OPT-HT X

T-OPT-HT-15M X

T-OPT-HT-1D X

T-OPT-LT X

T-OPT-LT-15M X

T-OPT-LT-1D X

T-OSNR-LT X

T-OSNR-LT-15M X

T-OSNR-LT-1D X

T-PJCDIFFP X X

T-PJCDIFFP-15M X X

T-PJCDIFFP-1D X X

T-PJCSPDET X X

T-PJCSPDET-15M X X

Page 30-130 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.8 Direction Field Table (Continued)

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
T-PJCSPDET-1D X X

T-PJCSPGEN X X

T-PJCSPGEN-15M X X

T-PJCSPGEN-1D X X

T-SE X

T-SE-15M X

T-SE-1D X

T-SEFSS X X

T-SEFSS-15M X X

T-SEFSS-1D X X

T-SES-ODU X X

T-SES-ODU-15M X X

T-SES-ODU-1D X X

T-SES-OTU X X

T-SES-OTU-15M X X

T-SES-OTU-1D X X

T-SESL X X

T-SESL-15M X X

T-SESL-1D X X

T-SESP X X

T-SESP-15M X X

T-SESP-1D X X

T-SESS X X

T-SESS-15M X X

T-SESS-1D X X

T-UASL X X

T-UASL-15M X X

T-UASL-1D X X

T-UASP X X

76.MTFP50/30, Rev B January 2018 Page 30-131

5. Alarm and Condition Tables TL1 Command Reference Manual

Table 5.8 Direction Field Table (Continued)

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
T-UASP-15M X X

T-UASP-1D X X

T-UAS-ODU X X

T-UAS-ODU-15M X X

T-UAS-ODU-1D X X

T-UAS-OTU X X

T-UAS-OTU-15M X X

T-UAS-OTU-1D X X

T-UASS X X

T-UASS-15M X X

T-UASS-1D X X

T-UBE-FEC X X

T-UBE-FEC-15M X X

T-UBE-FEC-1D X X

T-DROP X

T-DROP-15M X

T-DROP-1D X

T-PKT X

T-PKT-15M X

T-PKT-1D X

T-BCPKT X

T-BCPKT-15M X

T-BCPKT-1D X

T-MCPKT X

T-MCPKT-15M X

T-MCPKT-1D X

T-CRCAE X

T-CRCAE-15M X

T-CRCAE-1D X

Page 30-132 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 5. Alarm and Condition Tables

Table 5.8 Direction Field Table (Continued)

TDTN TDTC
(Transmit (Transmit
Direction Direction
Towards Towards
Network) = Customer) NA
PORT TO = LINE TO (Direction
LINE PORT RCV TRMT Not
CONDITION TYPE DIRECTION DIRECTION (Receive) (Transmit) Applicable)
T-USPKT X

T-USPKT-15M X

T-USPKT-1D X

T-OSPKT X

T-OSPKT-15M X

T-OSPKT-1D X

T-FRAG X

T-FRAG-15M X

T-FRAG-1D X

T-JABR X

T-JABR-15M X

T-JABR-1D X

T-UTIL-HT X

T-UTIL-HT-15M X

T-UTIL-HT-1D X

76.MTFP50/30, Rev B January 2018 Page 30-133

6. Guidelines for TL1 Input Command Messages TL1 Command Reference Manual

6. Guidelines for TL1 Input Command Messages

6.01 The TL1 input command messages are provided in alphabetical order in
the sections that follow. They are described using these eight headings:
• Verb

• Verb and Modifier

• Command Format

• Proper System Response

• Parameters

• Example

• Error Messages

• Related Commands

6.02 This section explains the content of these headings for the sections that
follow and includes information about:
• TL1 Command Interfaces

• Conventions Used in this Manual

• Security and Administration

TL1 Input Command Headings

Verb Heading
6.03 All commands using the same verb are grouped together in this manual.
The verbs used in the mTera UTP are presented in Verb table in section 2.

Verb and Modifier Heading

6.04 The verb and modifier heading specifies the actual command. The
purpose of the command is provided under this heading.

Command Format
6.05 The command lists all parameters including optional parameters.

Page 30-134 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 6. Guidelines for TL1 Input Command Messages

6.06 The verb and modifier(s) must be entered for every command. The target
identifier must be entered only if the command is being sent to a remote network
element (NE). All punctuation (: ; , =) in the command must be used as shown.
Brackets [ ] around a parameter indicate the parameter is optional. Do not enter
brackets. Additional information regarding TL1 input syntax is provided below in
the Conventions Used in this Manual section.

Proper System Response

6.07 The proper system response is the response which is returned from the
network element (NE) if the command has been executed successfully. The ^, < >,
( ), +, cr, lf do not appear in the response. These characters are used to indicate
spaces (^), carriage returns (cr) and line feeds (lf). The less than (<) and greater
than (>) symbols enclose domains. The plus sign (+) indicates the part of the
response enclosed in parentheses that is repeated one or more times.

Parameters
6.08 All parameters occurring in a command are listed in a parameter table. The
parameter table lists and defines each parameter. The table also provides the
possible domains or values. Values which are system defaults are specified in the
parameter table.
6.09 The behavior of the command is the same whether the optional
parameters are provided with a default value or optional parameters are not
provided.

Example
6.10 An example of the TL1 input command is provided under this heading.

Error Messages
6.11 If the command is not executed successfully, a deny response and error
code are received at the terminal. All error codes are presented in Table 3.3. The
possible error codes associated with each command are also provided in this
section.

Related Commands
6.12 Related commands are commands which have the same modifier(s) and
different verbs. For example, all commands related to provisioning an OC3
termination are listed under this heading.

76.MTFP50/30, Rev B January 2018 Page 30-135

6. Guidelines for TL1 Input Command Messages TL1 Command Reference Manual

TL1 Command Interfaces

6.13 There are two interface modes supported by the 7100 OTS, 7100 Nano
and mTera UTP network elements, the Element Management System (EMS) that
is offered in EMS or Craft Station, and the TL1 command line interface (CLI). A
VT100 terminal or other American National Standards Institute (ANSI) terminal
may be used for the TL1 CLI mode.

Conventions Used in this Manual

6.14 The TL1 general message syntax used in this document has been
obtained from Telecordia GR-831, Operations Application Messages-Language
For Operations Application Messages, Issue 1, November 1996.

General Message Syntax

6.15 The specification characters and notation used throughout this document
are described below in the table Specification Characters and Notation.

Table 6.1 Specification Characters and Notation

Notation Purpose Example

<> Encloses a symbol specifier in the <int-num> may specify an integer

data blocks. number

[] Encloses an optional symbol or a[b]c represents abc or ac since

information unit. b is optional
Do not type [ or ] when entering an
input command.

’’ Encloses a literal character. ’a’ means literal character as

opposed to a symbol
representing a value

::= Separates the left and right sides of a <digit>::=(0|1|...|9) is a grammar

grammar rule. rule representing the symbol
<digit> is 0 or 1 or...9

cr lf Indicates a carriage return and line cr lf

feed.

( ) or { } Encloses a group of symbols for the following operators:

* Post-fix operator; preceding symbol a(bc)* represents:

or group of symbols may occur zero a or abc or abcbc...
or more times.

^ Space; the literal blank character, ^^^ represents:

used only in response to messages. 3 spaces

+ Post-fix operator; preceding symbols a(bc)+ represents:

or group of symbols may occur one or abc or abcbc or abcbcbc...
more times.

Page 30-136 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 6. Guidelines for TL1 Input Command Messages

Table 6.1 Specification Characters and Notation (Continued)

Notation Purpose Example

| Infix operator; either the preceding or a|b|c represents:

succeeding symbol may occur, but a or b or c
not both in succession.

Input Command and Response Messages

6.16 The syntax used in input command and response messages is different.
Format effectors such as spaces (^), line feeds (lf), and carriage returns (cr) are
evident in response messages only. Format effectors, such as carriage returns, are
not used in input commands. In this manual, longer input commands may appear
on two or more lines as a result of space limitation.

TL1 Input Command Case Sensitivity

6.17 The input commands are shown in uppercase and lowercase lettering.
Lettering for command codes, parameter names, and parameter values can be
entered in either uppercase or lowercase.
6.18 The parts of the input command which are shown in uppercase lettering
must be entered as shown. Where lowercase lettering appears, a domain, aid, ctag
or tid must be entered. Refer to the parameter table included with each input
command for the possible values.

Parameter Block Syntax

6.19 Parameters of command messages are grouped into blocks. Blocks are
separated by colons, and parameters within a block are separated by commas.
Parameter blocks can contain either all positioned-defined parameters or all
named-defined parameters. Refer to Figure 6.1.

Figure 6.1 General TL1 Input Command Format

verb-mod1-mod2:[tid block]:aid block:ctag
block::common block:specific block:state block;

Position-Defined Parameters 6.20 In a block of positioned-defined parameters, parameters are entered in a

specific order without names. The order or position of the entry associates each
value with its corresponding parameter. The position is defined using commas as
separators. A parameter entry may be omitted provided the associated comma
separator is retained to indicate the position of the parameter omitted. The last
comma may also be omitted if the last parameter in the block is null. The common
block and state block contain position-defined parameters.

Name-Defined Parameters 6.21 For a block of name-defined parameters, every parameter entry must have
a parameter name and value. Unlike position-defined parameters, successive
entries do not need to be entered in a specific order but they need to be separated
by a comma. For name-defined blocks, parameter entries are omitted by not
entering the parameter name and value. The specific block contains name-defined
parameters.

76.MTFP50/30, Rev B January 2018 Page 30-137

6. Guidelines for TL1 Input Command Messages TL1 Command Reference Manual

Optional Parameter Blocks 6.22 Blocks and parameters of commands which are optional are enclosed in
brackets, [ ]. If a block or a parameter in a block is optional, it does not need to be
included in the TL1 command. Optional blocks and parameters could have a
default value. If a default value exists it is specified as the default value. For
example, in the figure General Tl1 Input Command Format, the tid block is optional.

Security and Administration

6.23 Network Element security consists of the user identifier and a password
identifier. Both identifiers must be accurately entered to gain access to the system.
The user identifier and password identifier are initially assigned by the system
administrator using the ENT-SECU-USER command.
6.24 Each user is also assigned a functional group and authorization level by
the system administrator. The functional group and authorization level make up the
TL1 user access privilege code (UAP). The UAP indicates what TL1 input
commands the user can execute. The six UAPs include administration (A8),
operator (A7), provisioning (A6), service testing (A4), public (A2) and access
blocked (A0). A8 is the highest user level and A0 is the lowest. The A8 user can
perform all TL1 commands. The A7 user can administer all TL1 commands
excluding security commands. The A7 user cannot administer user accounts or
administer digital certificates for IP Security. The A6 can perform all provisioning
commands for equipment and facilities, including Performance monitoring. The A4
user can perform all activate, cancel, operate, release, and retrieve commands.
The A2 user can perform one edit command (ED-PID) and all cancel and retrieve
commands. The A0 can only do ACT-USER, CANC-USER and ED-PID. All users
can receive autonomous messages as determined by the system administrator.
Refer to the table below for more information.

Page 30-138 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 6. Guidelines for TL1 Input Command Messages

Table 6.2 Security and Administration User Privileges

Public (A2) Test (A4) Provisioning (A6) Operator (A7) Admin (A8) & EMS
ACT-USER OPR-ACO-ALL ALW-PMFILE-{X} ALW-BKUPSCHED- ALW-PKT-SNMPV2
ALW-MSG-ALL OPR-ARC-{X} ALW-PMREPT-{X} MEM COPY-RFILE
CANC-USER OPR-CABL- DLT-{X} (facilities) DLT-DB DLT-AAA
ED-PID DETECT DLT-BL DLT-FTPSERVER DLT-SESSION
INH-MSG-ALL OPR-EXT-CONT DLT-CONN DLT-IPPG DLT-USER-SECU
MEAS-OPTPWR OPR-FINDRTE DLT-CRS-OCH DLT-NTPPEER ED-AAA
RTRV-{X} (facilities) OPR-LPBK-{X} DLT-CRS-ODUk DLT-RFILE ED-NE
RTRV-ALM-{X} OPR-PROTNSW-{X} DLT-DA DLT-TRAPIP ED-PROXY
RTRV-ALM-ENV RLS-ARC-{X} DLT-EQPT ED-ALMPF-{X}* ED-SECU-SYS
RTRV-ALMPF-{X}* RLS-EXT-CONT DLT-EXDPATH ED-BL ED-TCPIP
RTRV-ARC-{X}* RLS-LPBK-{X} DLT-EXPPATH ED-BL-MEMBER ED-USER-SECU
RTRV-ATTN-OCH RLS-PROTNSW-{X} DLT-FFP-HGE ED-CALL ED-WARNING
RTRV-ATTR-CONT RTRV-USER-SECU DLT-FFP-OCn ED-CPPF ENT-AAA
RTRV-ATTR-ENV STA-BER DLT-FFP-STMn ED-DB ENT-USER-SECU
RTRV-BER STP-BER DLT-FFP-TGLAN ED-FTPSERVER INH-PKT-SNMPV2
RTRV- DLT-FIBR-EQPT ED-IP RTRV-AAA
BKUPSCHED-MEM DLT-GCC ED-IPPG RTRV-ALMGEN
RTRV-BL DLT-MGTETH ED-LINKPF RTRV-LOG
RTRV-BL-MEMBER DLT-OCH ED-NTPPEER RTRV-SECU-SYS
RTRV-CALL DLT-TSL ED-PMPF RTRV-SESSION
RTRV-CALL-DETAIL ED-{X} (facilities) ED-PPPPF RTRV-USER-SECU
RTRV-CEF ED-CRS-OCH ED-RSVPADJ STA-ALMGEN
RTRV-COND-{X} ED-CRS-ODUk ED-SLPF STP-ALMGEN
RTRV-CONN ED-DA ED-SLPOLICY
RTRV-CONN-INFO ED-EQPT-{X} ED-SNMP
RTRV-CONN- ED-EXDPATH ED-SNMP-
ROUTE ED-EXPPATH COMMPREFIX
RTRV-CPPF ED-FFP-HGE ED-STAT-RTE
RTRV-CRS-OCH ED-FFP-OCn ENT/DLT-RSVP
RTRV-CRS-ODUk ED-FFP-STMn ENT/DLT-STAT-RTE
RTRV-DGNCP ED-FFP-TGLAN ENT/ED/DLT-NP
RTRV-DA ED-FGE ENT/ED/DLT-OSCX
RTRV-DB ED-GCC ENT/ED/DLT-OSPF
RTRV-DISP-OCH ED-MGTETH ENT/ED/DLT-
RTRV-ENGIDMAP ED-OCH OSPFADJ
RTRV-EQPT ED-OMS ENT/ED/DLT-
RTRV-ETH ED-OSC OSPFAREA
RTRV-EXDPATH ED-OSPFRP ENT-FTPSERVER
RTRV-EXPPATH ED-OTS ENT-IPPG
RTRV-EXT-CONT ED-PPG-ODUk ENT-NTPPEER
RTRV-FFP-HGE ED-SLOT ENT-STAT-RTE
RTRV-FFP-OCn ED-TSL ENT-TRAPIP
RTRV-FFP-STMn ED-WCG INH-BKUPSCHED-
RTRV-FFP-TGLAN ENT-BL MEM
RTRV-FIBR-EQPT ENT/DLT-CALL INIT-SYS
RTRV-FTPSERVER ENT-DA INSTALL-CEF
RTRV-GAIN-OTS ENT/DLT-OSPFRP INSTALL-SW
RTRV-GCC ENT/DLT- OPR-PING
RTRV-HDR OSPFRPMAP OPR-TRACE-ROUTE
RTRV-INTIP-SLOT ENT/DLT- OPR-UPG-ABORT
RTRV-INV TNALNKMAP OPR-UPG-COMMIT
RTRV-IP ENT/ED/DLT-NODE
RTRV-IPPG ENT/ED/DLT-TL
RTRV-LADJ-TL ENT-{X} (facilities)
RTRV-LEDS ENT-CRS-OCH
RTRV-LINKPF ENT-CRS-ODUk

76.MTFP50/30, Rev B January 2018 Page 30-139

6. Guidelines for TL1 Input Command Messages TL1 Command Reference Manual

Table 6.2 Security and Administration User Privileges (Continued)

Public (A2) Test (A4) Provisioning (A6) Operator (A7) Admin (A8) & EMS
RTRV-MGTETH ENT-EQPT OPR-UPG-EXECUTE
RTRV-NE ENT-EXDPATH OPR-UPG-
RTRV-NETYPE ENT-EXPPATH PATCHAPPLY
RTRV-NODE ENT-FFP-HGE RTRV-AO
RTRV-NP ENT-FFP-OCn RTRV-SNMP-COMM
RTRV-NP-STATS ENT-FFP-STMn RTRV-SNMP-
RTRV-NTPPEER ENT-FFP-TGLAN COMMPREFIX
RTRV-OCH ENT-FGE RTRV-TCPIP
RTRV-OMS ENT-FIBR-EQPT RTRV-USER-SECU
RTRV-OPEDATA ENT-GCC SCHED-BKUP-MEM
RTRV-OPTPWR- ENT-MGTETH SET-ATTR-CONT
OTS ENT-OCH SET-ATTR-ENV
RTRV-OSC ENT-TSL SET-DAT
RTRV-OSCX INH-PMFILE-{X} SET-SID
RTRV-OSPF INH-PMREPT
RTRV-OSPFADJ INIT-REG-{X}
RTRV-OSPFAREA OPR-ADMREROUTE
RTRV-OSPFRP OPR-CPSW
RTRV-OSPFRPMAP RLS-CPSW
RTRV-OTS RTRV-FPGAVERMAP
RTRV-PM-{X} RTRV-FPGAVER
RTRV-PMDAY RTRV-USER-SECU
RTRV- SCHED-PMFILE-{X}
PMFILESCHED-{X} SCHED-PMREPT-{X}
RTRV-PMMODE-{X} SET-ATTN-OCH
RTRV-PMPF SET-GAIN-OTS
RTRV-PMPFUSE SET-OPTPWR-OTS
RTRV-PMSCHED- SET-OPTTH-OCH
{X}* SET-PMDAY
RTRV-PPG-ODUk SET-PMMODE-{X}
RTRV-PPPPF SET-TCAMODE-{X}
RTRV-PROXY SET-TH-{x}
RTRV-PTHTRC- SW-DX
OCH
RTRV-PTHTRC-
ODUF
RTRV-PTHTRC-
ODU0
RTRV-PTHTRC-
ODU1
RTRV-PTHTRC-
ODU2
RTRV-PTHTRC-
ODU2E
RTRV-PTHTRC-
ODU3
RTRV-PTHTRC-
ODU4
RTRV-PTHTRC-
ODU
RTRV-PTHTRC-
OTUC2
RTRV-PTHTRC-
OTUC3
RTRV-PTHTRC-
OTS
RTRV-RFILE

Page 30-140 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 6. Guidelines for TL1 Input Command Messages

Table 6.2 Security and Administration User Privileges (Continued)

Public (A2) Test (A4) Provisioning (A6) Operator (A7) Admin (A8) & EMS
RTRV-RSVP
RTRV-RSVPADJ
RTRV-RTE-ALL
RTRV-SLOT
RTRV-SLPF
RTRV-SLPOLICY
RTRV-SNMP
RTRV-STAT-RTE
RTRV-SW
RTRV-SWVER
RTRV-SWVERMAP
RTRV-TCA-{X}
RTRV-TCAMODE-
{X}
RTRV-TCE-TL
RTRV-TH-{X}
RTRV-TL
RTRV-TNALNKMAP
RTRV-TOD
RTRV-TRAPIP
RTRV-TSL
RTRV-UPG-STATE
RTRV-USER-SECU
RTRV-WARNING
RTRV-WCG

76.MTFP50/30, Rev B January 2018 Page 30-141

7. Telnet Session TL1 Command Reference Manual

7. Telnet Session

7.01 A TL1 Telnet session can be established three different ways including an
RS-232 maintenance port, a local craft interface 10/100BaseT Ethernet port, and
a Data Communication Channel (DCN) interface 10/100BaseT Ethernet port. All
three of these connections are located on the Horizontal Distribution Panel (HDP)
7.02 The maintenance port is an RS-232 port on the Horizontal Distribution
Panel that can provide serial access to the TL1 interface when no Ethernet
interface is available, or when a modem must be connected to the system in order
to access the network element (NE). This interface requires standard security
access.

Note: The RS-232 port is also used to connect to the NE during initial
configuration or basic commissioning. (For more information about basic
commissioning, refer to Acceptance Testing). The RS-232 port provides
the user interface for entering the TL1 commissioning commands required
at NE start-up, such as configuring IP address, TID, NE type and router/
GNE parameters.

7.03 The local craft interface is a 10/100BaseT Ethernet port located on the
Horizontal Distribution Panel (HDP). Use the Ethernet port if the TL1 agent is
running on the NE. After connecting through the Ethernet port, log onto the system
using the ACT-USER command. When the NE is equipped with SPM modules in
both slots 17 and 18, there are 2 LCI ports available. Use the LCI port of the
ACTIVE SPM.
7.04 The Data Communication Channel (DCN) interface is a 10/100BaseT
Ethernet port on the Horizontal Distribution Panel. Use this Ethernet port when you
are able to connect to the DCN for remote access to the network element. After
connection with Telnet on the Ethernet port, log onto the system using the ACT-
USER command. When the NE is equipped with SPM modules in both slots 17 and
18, there are 2 DCN ports available.
7.05 When connecting a PC to the 7191 Craft Station, connect to the LCI (local)
port on the HDP.

Setting up a TL1 Telnet Session

7.06 The procedures for physically setting up a TL1 telnet session vary
depending on the version of HDP that is located in 60 Amp Main Shelf.

60 Amp Main Shelf 7.07 Set up a TL1 Telnet session by following the steps below.
__ 1. Establish a connection between a Personal Computer (PC) and the
System Processor Module (SPM) using one of the following three
methods.
a. Install a serial cable between RS232 RJ-45 connector (Port#17 or
Port #18 if this is a 60 Amp main shelf) to the serial connector on
the PC.

Page 30-142 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 7. Telnet Session

b. Or, use the Horizontal Distribution Panel (HDP) LCI port, which
can be switched between slots 17 or 18 based on the active
controller. The default IP address and subnet mask the used by
the Ethernet ports are listed in the HDP Ethernet Port 8 Default
Values below.

Table 7.1 HDP Ethernet Port 8 Default Values

HDP Port IP Address Subnet Mask
Ethernet Port 17 or 18 10.0.0.1 255.255.255.252

Using an RJ-45 Ethernet cross-over cable, connect the PC to Port

#17 or #18. Configure IP address 10.0.0.2 on the PC. Refer to
Connecting the Personal Computer to the HDP Using Ethernet
Connection figure below.
c. Or, use the HDP Ethernet Port DCN-1 or DCN-2.

Using an RJ-45 Ethernet cross-over cable, connect the PC to Port

DCN-1 or DCN2. Configure the appropriate IP address on the PC.
Refer to Connection the Personal Computer to DCN Interface
Using Ethernet Connection figure below.

Figure 7.1 Connecting the Personal Computer to the HDP Using Serial Connection

Personal Computer

RS232 slot 17 (RJ45) - connector 1

RS232 slot 18 (RJ45) - connector 2

1 3 5 7 9 11 X X
2 4 6 8 10 12

76.MTFP50/30, Rev B January 2018 Page 30-143

7. Telnet Session TL1 Command Reference Manual

Figure 7.2 Connecting the Personal Computer to STPM Using LCI for mTera Platform

Figure 7.3 Connecting the Personal Computer to DCN Interface for mTera Platform

Page 30-144 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 7. Telnet Session

__ 2. From the Windows 2000 Professional Quick Launch Toolbar, point to

Start, then point Programs, point to Accessories, point to
Communications, and then click Hyperterminal.
The Connection Description dialog box appears. Refer to the TL1
Telnet Hyperterminal Connection figure below.

Figure 7.4 TL1 Telnet Hyperterminal Connection

__ 3. The Connect To dialog box appears.

If using a TCP/IP connection, refer to the figure Connect to Dialog
Box Using TCP/IP Connection and, complete steps 4 through 7.
If using a serial connection, refer to the COM1 Properties Dialog
figure, and COM2 Properties with Selected Parameters figure,
and complete steps 8 through 11.

76.MTFP50/30, Rev B January 2018 Page 30-145

7. Telnet Session TL1 Command Reference Manual

Figure 7.5 Connect to Dialog Box Using TCP/IP Connection

7.08 Complete steps 4 through 7 if you are using a TCP/IP connection. If using
a serial connection, proceed to step 8.
__ 4. In the Connect using box, select the TCP/IP (Winsock).
__ 5. In the Host address box type in the IP address of the network element
to which you are establishing a TL1 session (default is 10.0.0.1).
__ 6. In the Port number box type the default TL1 Telnet port number, 3083.
__ 7. Click OK.

Page 30-146 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 7. Telnet Session

Figure 7.6 COM1 Properties Dialog

7.09 Complete steps 8 through 11 if you are using a serial connection.

__ 8. In the Connect using box, select COM1 or COM2.
__ 9. Click OK. A COMx Properties dialog box appears. Refer to the COM2
Properties with Selected Parameters figure.

76.MTFP50/30, Rev B January 2018 Page 30-147

7. Telnet Session TL1 Command Reference Manual

Figure 7.7 COM2 Properties with Selected Parameters

__ 10. Select the following parameters. Refer to the COM2 Properties with
Selected Parameters figure.
Bits per second = 9600
Data bits = 8
Parity = None
Stop bits = 1
Flow control = None
__ 11. Click OK.
The TL1 Telnet HyperTerminal session dialog box appears. Refer to
the figure in TL1 Telnet Shell Session.

Page 30-148 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 7. Telnet Session

Figure 7.8 TL1 Telnet Shell Session

__ 12. To make certain that the TL1 session is active, enter the following
command.
RTRV-HDR:::ctag;

A "login not active" error message appears. This indicates that the
session is active, but you need to log in. Refer to the figure TL1 Telnet
Session Activation. Proceed to Logging On.

76.MTFP50/30, Rev B January 2018 Page 30-149

7. Telnet Session TL1 Command Reference Manual

Figure 7.9 TL1 Telnet Session Active

Logging On
7.10 Generally, before any command can be processed a user must first login
to the network element. Log on to the system by entering the following command:
ACT-USER::uid:ctag::pid;

Where: pid=Password. Must be between 8 and 12 characters and

contain the following: at least one uppercase
alphabetic character, at least one numeric
character, and at least one special character (! # $
% & @ ^ *). Must not contain 3 consecutive
repetitions of the same character.
uid = Login identity of the user.
System response:

^^^<SID>^<date>^<time>
M^^<ctag>^COMPLD
/* NOTICE: This system is strictly for business use by */
/* authorized personnel. Unauthorized access or use of this
/* system may lead to prosecution */
;

Logging Off
7.11 Log off the system by entering the following command:

Page 30-150 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 7. Telnet Session

CANC-USER::uid:ctag;

Where: uid=Login identity of the user.

System response:

^^^<SID>^<date>^<time>
M^^<ctag>^COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-151

8. Activate Commands TL1 Command Reference Manual

8. Activate Commands

ACT-USER

Command Changes Since Previous Feature Package

• Remove support for pid_encrypt =Y

• Added text to describe FIPS mode compliant users

Description
The ACT-USER command instructs the network element (NE) to log a user onto the system.

When the logon password is entered in the command, only one asterisk (*) appears on the screen, regardless of
how many characters comprise the password.The pid_encrypt parameter is also displayed as an asterisk (*).

Some error messages do not display error codes. Displaying certain error codes could give clues to persons
attempting unauthorized access.

The ACT-USER command does not return specific error codes that may give hints as to what parameter was
incorrect. In most cases (incorrect password, incorrect UID, and so on), the system only returns DENY, with no error
code. A user which is disabled or locked out gets a deny message.

Note that when the command response indicates that the password is expired, the user needs to change its
password using ED-PID command.

Upon a successful login, the command response also indicates the date/time of the last login for the specified user
(using format YY-MM-DD hh:mm::ss where YY = year, MM = month, DD = day, HH is the hour ranging from 0 - 23,
mm = minutes, and ss = seconds), as well as the number of unsuccessful login attempts by this user since the last
successful login. If the user is logging into the NE for the first time, then a specific notice indicating no prior login is
displayed.

Restrictions and Exceptions

When FIPS mode is enabled (ED-SECU-SYS parameter SECURE=FIPS) only FIPS compliant users is allowed
to login. A FIPS compliant user must have the password saved with a FIPS compliant algorithm, (see RTRV-
USERSECU) and the following parameters cannot be set to the value 0.
- Password age (PAGE)
- Password update waiting period (PUWP)
- Session timeout (TMOUT)
- Password expired login number (PELN)

Command Format
ACT-USER:[tid]:<uid>:ctag::<pid>[,<pid_encrypt>];

Proper System Response

<header>

Page 30-152 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 8. Activate Commands

M^^<ctag>^COMPLD<cr><lf>
/* NOTICE: This system is strictly for business use by authorized personnel.
Unauthorized access or use of this system may lead to prosecution.

Last Login Time: YY-MM-DD hh:mm:ss OR No Prior Logins on Record (for first time
Login user)

Unsuccessful attempts since last login: 2 */

Parameters

Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 8.1 ACT-USER Parameters

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. UID

pid one string accord with the conditions Specifies the login password that was assigned in the ENT-
listed in the Definition colum USER-SECU or modified by the ED-USER-SECU.

If the password complexity parameter is set to YES (refer to the

ED-SECU-SYS and RTRVSECU-SYS commands), the
following rules apply for the password:
-Password length must be 8 characters minimum, 12 characters
maximum.
-At least 3 of the 4 following character types must be present:
numeric character, lowercase alphabetical character, uppercase
alphabetical character, special character.
-Special character consists of any of the following: ! # $ % & @ ^
*
-The Password must not include more than 2 consecutive
repetitions of the same character.
-UID (UserId) must not be contained in password (case
insensitive).

If the password complexity parameter is set to NO, then the

<pid> can be between 6 and 12 characters long using any of the
characters mentioned above, with no restriction on upper case
or character repetition.
When the <pid_encrypt>=N, pid has to be 6 to 12 alphanumeric
characters.
When the <pid_encrypt>=A, pid has to be 32 alphanumeric
characters and follow AES encryption algorithm.

pid_encrypt N Optional parameter which indicates if the pid, snmpauthpid and

A snmpprivpid is transmitted with AES encryption (A) or no
Default: N encryption (N) in a TL1 command.
When parameter is omitted, PID is sent without encryption.

Example
The following example logs on to the system with a uid of ADMIN and a pid of SECURITY1$:
ACT-USER::ADMIN:AM0011::*;

76.MTFP50/30, Rev B January 2018 Page 30-153

8. Activate Commands TL1 Command Reference Manual

Possible System Response for first time Login for a User

^^^CORIANT 14-05-15 02:08:15

M AM0011 COMPLD
/* NOTICE: This system is strictly for business use by authorized personnel.
Unauthorized access or use of this system may lead to prosecution

No Prior Logins on Record

Unsuccessful attempts since last login: 0 */

Possible System Response for User with Expired Password

^^^CORIANT 14-06-15 02:08:15

M AM0011 COMPLD
/* NOTICE: This system is strictly for business use by authorized personnel.
Unauthorized access or use of this system may lead to prosecution.

Last Login Time: 14-06-14 07:59:10

Unsuccessful attempts since last login: 0

NOTICE: Your password has expired. You must modify your password immediately. */

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

CANC-USER
ED-PID
ED-WARNING
REPT^EVT^SESSION
RTRV-WARNING
ED-SECU-SYS
RTRV-SECU-SYS

Page 30-154 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 9. Allow Commands

9. Allow Commands

ALW-BKUPSCHED-MEM

Command Changes Since Previous Feature Package

• None.

Description
Use the ALW-BKUPSCHED-MEM command to allow the scheduled backups from the source to the destination at
the times specified in the SCHED-BKUP-MEM command.

Only the NE database can be backed up to a remote server. The name of the remote server for the scheduled
backup is selected in the SCHED-BKUP-MEM command. The ALW-BKUPSCHED-MEM command is denied if no
schedule has been created first.

Command Format
ALW-BKUPSCHED-MEM:[tid]:[<backup_mem_aid>]:ctag::[<datatype>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 9.1 ALW-BKUPSCHED-MEM Parameters

Parameter Value(s) Definition
backup_mem_ SERVER EntityID
aid

datatype DB Specifies the type of backup memory that is the source.

- Enter DB to specify the NE database.
The default is DB.

Example
ALW-BKUPSCHED-MEM:MONTREAL::AM0011::DB;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15

M AM0011 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-155

9. Allow Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
INH-BKUPSCHED-MEM
RTRV-BKUPSCHED-MEM
SCHED-BKUP-MEM

Page 30-156 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 9. Allow Commands

ALW-MSG-ALL

Command Changes Since Previous Feature Package

• None.

Description
ALW-MSG-ALL permits or allows an NE to resume transmission of automatic messages to an OS after having been
in the inhibit mode. This applies to all supported entities.

ALW-MSG commands sent on one OS/NE or user session should not impact other sessions.

Command Format
ALW-MSG-ALL:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
None

Example
ALW-MSG-ALL:MONTREAL::AM0027;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15

M AM0027 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
INH-MSG-ALL
RTRV-USER-SECU

76.MTFP50/30, Rev B January 2018 Page 30-157

9. Allow Commands TL1 Command Reference Manual

ALW-PKT-SNMPV2

Command Changes Since Previous Feature Package

• None.

Description
The ALW-PKT-SNMPV2 command provides the ability to turn on SNMPV2c on the mTera for managing the Packet
Subsystem.
SNMPV2 provides read-only SNMP management of Packet subystem by using community strings. When this
command is running, it automatically creates the default read-only community strings.

Restrictions and Exceptions

• This command is denied if SNMPv2 has already been turned on.

• This command applies to mTera in the DISABLED proxy mode. The proxy mode can be retrieved by
ED-PROXY command.

Command Format
ALW-PKT-SNMPV2:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
None

Example
ALW-PKT-SNMPV2:::AM0011;

Possible System Response

^^^CORIANT 05-11-15 02:08:15
M AM0011 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
INH-PKT-SNMPV2

Page 30-158 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 9. Allow Commands

ALW-PMFILE-{X}

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ALW-PMFILE-{X} command instructs the network element (NE) to resume processing of binary file transfer of
ODUk, OSC, OMS, STS, VC, or OCH-L PM reports that are inhibited.

Reporting can be inhibited by use of the INH-PMFILE-{X} command. This command enables binary file transfer of
historical performance monitoring reports on a per ODUk, AID basis as scheduled via the SCHED-PMFILE-{x}
command. Refer to the RTRV-PM-{X} command for a list of all ODUk, STSn, OSC, OMS, and OCH-L PM supported
by the network elements.
{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): STS1, STS3C, STS12C, STS48C, STS192C, ODUF, ODU0, ODU1, ODU2,
ODU2E, ODU3, ODU4, OSC, OMS, OCH(for OCH-L).

Restrictions and Exceptions

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• The Facility AID {fac_aid} must always correspond to the Facility type {fac_type}.

• This command is not supported for SSM-2S since in this release the performance monitor is not
supported on SSM-2S.

Command Format
ALW-PMFILE-<fac_type>:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-159

9. Allow Commands TL1 Command Reference Manual

Table 9.2 ALW-PMFILE-{X} Parameters

Parameter Value(s) Definition
fac_aid OCH-L-20-[10-16,1-7]-21-[1-96],OCH- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
L-20-[1-16]-1-[1-96] ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-21,OMS-20-[1-
16]-1
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

Page 30-160 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 9. Allow Commands

Table 9.2 ALW-PMFILE-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_type OCH-L Specifies the facility type.
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
OMS
OSC

Example
ALW-PMFILE-ODU1:MONTREAL:ODU1-20-1-1:AM0027;

Possible System Response

^^^MONTREAL 06-06-15 02:08:15

M AM0027 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
INH-PMFILE-{X}
SCHED-PMFILE-{X}
RTRV-PMFILESCHED-{X}

76.MTFP50/30, Rev B January 2018 Page 30-161

9. Allow Commands TL1 Command Reference Manual

ALW-PMREPT-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The ALW-PMREPT-{X} command instructs the network element (NE) to resume processing those PM reports that
are inhibited.

Reporting can be inhibited by use of the INH-PMREPT-{X} command. This command enables performance
monitoring reports on a per AID basis as scheduled via the SCHED-PMREPT-{X} command. Refer to the RTRV-
PM-{X} command for a list of all PM supported by the network elements.

{X} specifies the equipment type or facility type among the following AIDs:

• Facilities (fac_type): ETH, FGE, GBEP, HGE, OC3, OC12, OC48, OC192, OCH (for OCH-P and OCH-
OS), OTU1, OTU2, OTU4, OTUC2, OTUC3, TGLAN.

Restrictions and Exceptions

• When "ALL" is used as second modifier, the AID is optional and defaults to ALL.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• The facility AID must always correspond to the facility type.

• This command does not apply to SSM-2S since in this release it does not support performance monitor.

Command Format
ALW-PMREPT-{<fac_type>|ALL}:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-162 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 9. Allow Commands

Table 9.3 ALW-PMREPT-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
TGLAN-20-[1-16]-[1-40]

Example
ALW-PMREPT-OTU1:MONTREAL:OTU1-20-1-1:AM0027;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15

M AM0027 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
INH-PMREPT-{X}
RTRV-PMSCHED-{X}
SCHED-PMREPT-{X}

76.MTFP50/30, Rev B January 2018 Page 30-163

10. Cancel Commands TL1 Command Reference Manual

10. Cancel Commands

CANC-USER

Command Changes Since Previous Feature Package

• None.

Description
The CANC-USER command instructs the network element (NE) to terminate a login session. Enter this command
on the channel on which the session is established.

This command is also available in "Basic Commissioning" to terminate a login session from the Maintenance port
(RS-232).

Command Format
CANC-USER:[tid]:<uid>:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 10.1 CANC-USER Parameters

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. UID

Example
The following example logs off of the system with a uid of ADMIN:
CANC-USER::ADMIN:AM0011;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

A 3603 REPT EVT SESSION

"CORIANT1: ADMIN,LOGOUT,198.23.112.110,03-15,02-08-15"

Page 30-164 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 10. Cancel Commands

^^^CORIANT1 02-03-15 02:08:15

M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

ACT-USER
REPT^EVT^SESSION

76.MTFP50/30, Rev B January 2018 Page 30-165

11. Copy Commands TL1 Command Reference Manual

11. Copy Commands

COPY-RFILE

Command Changes Since Previous Feature Package

• Updated for OPEPROJ and OPENE data files.

Description
Use the COPY-RFILE command to initiate the file transfer between the target NE and the OS. This command can
be used to copy/retrieve file(s) directly to/from a remote server.

This command can be used to serve different purposes:

• Transfer the complete software package to the network element for a software upgrade,

• Transfer a Patch Load package the network element for software/firmware patching,

• Manually backup or restore the database,

• Transfer a Capability Extension File to the network element,

• Copy limited PM information from the network element,

• Transfer OPE Project and OPE Network Element data files to the network element,

• Retrieve debug and call history logs,

This command creates directories as necessary on the target server or NE if they do not exist.

When the command specifies a Software Download, SWDL, the Software Load Package is copied to the Active
system controller and then automatically copied to the Standby controller. The SWDL command has a restriction
that both Active and Standby controllers must be In-service for the command to be accepted.
Furthermore, the "Installation" of the Software Load Package on the system controllers is automatically performed
thus the OPR-UPG-INSTALL becomes obsolete.

This command is based on specifications defined in NSIF-033-1999.

Restrictions and Exceptions

• URL definitions must be enclosed in double quotes.

• The command COPY-RFILE with the "xfertype" set to SWDL is the only accepted mode in "Basic
Commissioning".

• Host & Directory need to be accessible by FTP server.

• For Database restore (<xfertype>=RFR), after the file is successfully transferred, the NE automatically
resets and the TL1 connection closes. The previously out-of-service database is placed in-service.

• For Database restore (<xfertype>=RFR) on mTera based NEs, the standby STPM must be OOS-MA
prior to command execution.

• Parameter "srcUrl" must be specified if "xfertype" is set to any of the following:

- SWDL
- PDL

Page 30-166 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 11. Copy Commands

- CEF
- APPLOG
- OPEPROJ
- OPENE
• Parameter "destUrl" must be specified if "xfertype" is set to any of the following:

- RFBU
- CPLOG
- PDLOG
- CALLLOG
- APPLOG
- PMFILE
• Parameter "destUrl" includes directory but NOT the file name when xfertype is CALLLOG. When a file
name is provided as part of the destination URL, the request is denied.

• Parameter "overwrite" is applicable when xfertype is RFR, OPEPROJ and OPENE.

• Parameter "seqnum" only applies when xfertype is CALLLOG.

• When xfertype is CALLLOG, NE uploads the files that include the requested sequence number+1
through the current recorded highest sequence number at NE, if the requested sequence number is
greater than or equal to the current recorded lowest sequence number valid/exists at NE and is less
than the current recorded highest sequence number at NE.

• When xfertype is CALLLOG, NE provides an indication (via FXFR status) of "no valid call log starting at
the requested sequence number" if the requested sequence number is equal to the current recorded
highest sequence number at NE.

• When xfertype is CALLLOG, NE uploads the entire history if the requested sequence number does not
exist on the NE.

• When xfertype is CALLLOG and there is no sequence number provided, NE uploads the entire history.

• When upgrading the NE software and explicitly overriding CEF distributed with the new feature
package; first copy the upgrade software with SWDL to the NE, then copy one or more override CEFs.

• tmper/hour can only be specified when xfertype=PMFILE.

• If <tmper>=15-MIN, <hour> must be specified to indicate a specific hour, which gets all 15-MIN history
PM data in the specific hour.

• If <tmper>=1-day, <hour> cannot be provided, which gets all available 1-day history PM data.

• The COPY-RFILE request is not denied if the log does not exist (for example, for PDLOG, CPLOG,
CALLLOG, APPLOG, PMFILE). The REPT^EVT^FXFR indicates if the request failed or succeeded.

• Parameter "srcURL" must end in a [FILE] suffix if "xfertype" is set to any of the following:

- SWDL
- RFR
- PDL
- OPEPROJ
- OPENE

76.MTFP50/30, Rev B January 2018 Page 30-167

11. Copy Commands TL1 Command Reference Manual

• Parameter "srcURL" must end in a [DIRECTORY] suffix (including trailing slash) if "xfertype" is set to
the following:

- APPLOG
• Parameter "destURL" must end in a [FILE] suffix if "xfertype" is set to any of the following:

- CPLOG
- PDLOG
• Parameter "destURL" must end in a [DIRECTORY] suffix (including trailing slash) if "xfertype" is set to
any of the following:

- RFBU
- CALLOG
• When xfertype is SWDL, both the Active and Standby system controller must be In-service, otherwise
the command is denied.

Command Format
COPY-
RFILE:[tid]::ctag::<xfertype>,[<srcUrl>],[<destUrl>],[<overwrite>][,<seqnum>][,<
tmper>][,<hour>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^/* The target NE has initiated the file transfer process. Autonomous message(s)
will follow to provide transfer progress and to indicate the completion status of
the file transfer. */

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-168 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 11. Copy Commands

Table 11.1 COPY-RFILE Parameters

Parameter Value(s) Definition
xfertype SWDL Specifies the type and direction of the file transfer:
RFR - SWDL: Initiates a SoftWare DownLoad (remote server to
RFBU target NE). The NE automatically checks to ensure integrity of
LFR the software generic and the validity of the upgrade path.
PDL - RFR: Initiates a Remote File Restore (remote server to target
CPLOG NE). The NE automatically initiates a controller module warm
PDLOG restart (for example, STPM) at the end of the database file
CALLLOG transfer to complete the restoration process. This transfer
CEF requires the NE database to be put OOS prior to the command
APPLOG execution. The NE automatically checks the validity of the
PMFILE database and its compatibility with the software before
OPENE completing the restoration.
OPEPROJ - RFBU: Initiates a Remote File BackUp (target NE to remote
server). This transfer automatically moves ".CURRENT" file
name of the backup directory to ".BACKUP" and copies the NE
database to "NE_TID_FPx.CURRENT". The remote server has
at most two copies of the backed-up databases for each NE;
".CURRENT", and ".BACKUP".
- LFR: Initiates a Local File Restore from the database backup
on the active controller module. The NE automatically initiates a
controller module warm restart (for example, STPM) at the end
of the database file copy to complete the restoration process.
This transfer requires the NE database to be put OOS before
the command execution. The NE automatically checks the
validity of the database and its compatibility with the software
before completing the restoration.
- PDL: Initiates a software Patch DownLoad (remote server to
target NE). The NE automatically performs checks to ensure the
integrity of the Patch Load Package file and the validity of the
destination, then copies the Patch Load Package to the NE
controller.
- CPLOG: Upload the Control Plane LOG file "ason.log"
(provides messages related to call/connection management,
routing and path computation, resource and link status and so
on) from the NE to the destination URL.
- PDLOG: Uploads the Problem Determination trace LOG file
from the NE to the destination URL.
- CALLLOG: Uploads the call history log files (in the form of zip
file containing one or multiple call history log files) from NE to
the destination URL.
- CEF: Copies a Capability Extension File from the remote
server to the target NE.
- APPLOG: Uploads the application log file (in the form of zip file
that contains one or multiple application log files) from the
specified module to the destination URL.
- PMFILE: Uploads the performance monitoring file from the NE
to the destination URL.
- OPEPROJ: Downloads and installs the OPE Project datafile.
Progress of validation and install provided using REPT-EVT
messages.
- OPENE: Downloads and installs an NE-specific OPE Link
datafile. Progress of validation and install provided using REPT-
EVT messages.

76.MTFP50/30, Rev B January 2018 Page 30-169

11. Copy Commands TL1 Command Reference Manual

Table 11.1 COPY-RFILE Parameters (Continued)

Parameter Value(s) Definition
srcUrl ftp://userid:pwd@ftphost:[portid]/url- Specifies the source of the file transfer:
path - Must be specified when the xfertype is SWDL.
- Must be specified when the xfertype is RFR.
- Must be specified when the xfertype is CEF.
- Not required when the xfertype is RFBU or CPLOG or PDLOG
as the source is automatically known on the NE.
- Must be specified when the xfertype is PDL.
- Must be specified when the xfertype is APPLOG. In
this case, the url must contain the module location
based on the shelf and slot number (for example, ftp://shelf20/
slot17/).
- Must be specified when the xfertype is OPEPROJ or OPENE.

Port number 21 can be used for non-secure FTP file transfer.

Port number 22 is the default value and can be used for secure
FTP (SFTP) file transfer.

- <userid> is a valid user identification on the server (OS, EMS,

or other repository). The default value is "anonymous". Note
also that the following characters are not allowed for <userid>:
@?/\{[()]}
- <pwd> is the corresponding password for the valid <userid> on
the server (OS, EMS, or other repository). Note that the
following characters are not allowed for <pwd>: @ ? / \ { [ ( ) ] }
The default value is an empty string (blank).
- <ftphost>[:<port>] is a valid IP address and optional port
number to access the server.
NOTE: If the NE is a PRNE and the IP address is also in the
same Private Domain (such as Local Craft Interface Port on the
HDP), then the following should be added before the IP address:
"NOPROXY-". See Example.
<url-path> specifies the device/drive/directory/[file] to access the
file to transfer.
- The file name for the software generic, Patch Load Package,
or Capability Extension File to transfer must be provided without
the extension.
- The file name must not be specified when performing a
database backup.
- For a backup to the home (root) directory of the user, <url-
path> should be: /./
- For a download/restore from the home (root directory), <url-
path> should be: device/drive/./[file]

Page 30-170 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 11. Copy Commands

Table 11.1 COPY-RFILE Parameters (Continued)

Parameter Value(s) Definition
destUrl ftp://userid:pwd@ftphost:[portid]/url- Specifies the destination of the file transfer:
path - Must NOT be provided when the xfertype is SWDL. The
destination of a new software generic on the NE is automatically
determined.
- Not required when the xfertype is RFR. The destination of a
database file on the NE is automatically determined.
- Must be specified when the xfertype is RFBU or CPLOG or
PDLOG or APPLOG.
- Not required when the xfertype is PDL. The destination of a
new patch load on the NE is automatically determined.
- Must NOT be provided when the xfertype is OPEPROJ or
OPENE. The destination of a new OPE datafile on the NE is
automatically determined.

Port number 21 can be used for non-secure FTP file transfer.

Port number 22 is the default value and can be used for secure
FTP (SFTP) file transfer.

- <userid> is a valid user identification on the server (OS, EMS,

or other repository). The default value is "anonymous". Note
also that the following characters are not allowed for <userid>:
@?/\{[()]}
- <pwd> is the corresponding password for the valid <userid> on
the server (OS, EMS, or other repository). Note that the
following characters are not allowed for <pwd>: @ ? / \ { [ ( ) ] }
The default value is an empty string (blank).
- <ftphost>[:<port>] is a valid IP address and optional port
number to access the server.
NOTE: If the NE is a PRNE and the IP address is also in the
same Private Domain (such as Local Craft Interface Port on the
HDP), then the following should be added before the IP address:
"NOPROXY-". See Example.
<url-path> specifies the device/drive/directory/[file] to access the
file to transfer.
- The file name for the software generic or Patch Load Package
to transfer must be provided without the extension.
- The file name must not be specified when performing a
database backup.
- For a backup to the home (root) directory of the user, <url-
path> should be: /./
- For a download/restore from the home (root directory), <url-
path> should be: device/drive/./[file]
- <url-path> must NOT include file name when the xfertype is
CALLLOG, <url-path> should be: device/drive/directory.
Otherwise, the request is denied.

76.MTFP50/30, Rev B January 2018 Page 30-171

11. Copy Commands TL1 Command Reference Manual

Table 11.1 COPY-RFILE Parameters (Continued)

Parameter Value(s) Definition
overwrite YES This parameter is used on a file restore (<xfertype>=RFR) and
NO allows restore of a database backup file with a different system
Default: No ID than the ID of the target system. It indicates whether or not
the files should overwrite an existing file located at the
destination. This parameter has the following values:
- YES - Overwrite existing file of same directory location and
filename.
- NO (Default) - Do not overwrite file, fail the file transfer if file
already exists.
Note: This parameter is ignored when the command is used with
the xfertype set to LFR, RFBU, SWDL, CPLOG, PDLOG, CEF,
APPLOG or PDL.

This parameter is also used when transferring an OPE data file

(OPEPROJ or OPENE):
Yes - Overwrite the existing file. Overwriting the existing OPE
file occurs once the file has been validated and installed.
No (Default) - Do not overwrite the file, fail the file transfer if file
already exists.

seqnum [1-4294967295] Specifies the starting sequence number for retrieving call history
log.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

hour Any integer number in the range 0-23 Specifies the hour during which all 15-MIN PM data are
collected.

Examples
Software Download:
COPY-RFILE:NEO1::AM0074::SWDL,"ftp://user1:passwd1@172.112.21.4:22/cdrom/dir1/
FP2.1RevA",,;

Remote File Restore:

COPY-RFILE:NEO1::AM0074::RFR,"ftp://user1:passwd1@172.112.21.4:22/dir2/
CORIANT_FP2_0HP200.BACKUP",,YES;

Remote File Backup:

COPY-RFILE:NEO1::AM0074::RFBU,,"ftp://user1:passwd1@172.112.21.4:21/dir2/",;

or
COPY-RFILE:NEO1::AM0074::RFBU,,"ftp://user1:passwd1@172.112.21.4:22/./",;

backups to the home (for example, root) directory of user1.

Remote File Backup from a PRNE through LCI Port (both PRNE & LCI are in the same Private Domain):
COPY-RFILE:NEO1::AM0074::RFBU,,"ftp://user1:passwd1@NOPROXY-172.112.21.4:21/
dir2/",;

Patch Download:
COPY-RFILE:NEO1:AM0074::PDL,"ftp://user1:passwd1@17.112.21.4:22/loadfiles/
FP6_2_1_NZ118_PATCHLOAD_A",,;

Call History Retrieve:

Page 30-172 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 11. Copy Commands

COPY-RFILE:NEO1:AM0074::CALLLOG,,"ftp://user1:passwd1@17.112.21.4:21/calllogs/
",,1067;

Capability Extension File Download:

COPY-RFILE:NEO1:AM0074::CEF,"ftp://user1:passwd1@17.112.21.4:22/dir2/
FP1_0_PLUGTF_V2_CEF",,;

Application Log Retrieve:

COPY-RFILE:NEO1:AM0074::APPLOG,"ftp://shelf20/slot17/","ftp://
user1:passwd1@17.112.21.4:22/applogs/",;

Retrieves all applicable 15 minute PM data from hour 20:

COPY-RFILE:NEO1:AM0074::PMFILE,,"ftp://user1:passwd1@172.112.21.4:21/dir2/",15-
MIN,20;

Retrieves all applicable, available 1-day PM data:

COPY-RFILE:NEO1:AM0074::PMFILE,,"ftp://user1:passwd1@172.112.21.4:21/dir2/",1-
DAY;

Possible System Response

^^^NEO1 02-03-15 02:08:15

M AM0074 COMPLD

^^^/* The target NE has initiated the file transfer process. Autonomous message(s)
will follow to provide transfer progress and to indicate the completion status of
the file transfer. */<cr><lf>

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

REPT^EVT^FXFR
RTRV-RFILE
ED-DB
INSTALL-SW
OPR-UPG-PATCHAPPLY
INSTALL-CEF
DLT-RFILE

76.MTFP50/30, Rev B January 2018 Page 30-173

12. Delete Commands TL1 Command Reference Manual

12. Delete Commands

DLT-AAA

Command Changes Since Previous Feature Package

• None.

Description
The DLT-AAA command instructs the NE to delete a AAA (Authentication, Authorization and Accounting) server.

Restrictions and Exceptions

• None

Command Format
DLT-AAA:[tid]::ctag:::SERVER=<ipaddress>,PROTO=<aaaproto>,ROLE=<aaarole>;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.1 DLT-AAA Parameters

Parameter Value(s) Definition
ipaddress [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the AAA server.

aaaproto RADIUS Specifies the AAA protocol between NE and the AAA server.

aaarole AUTH Specifies the AAA role supported by this AAA entry.

Example 1
The following example delete the Authentication function:
DLT-AAA:CORIANT1::AM0011:::SERVER="135.252.1.101",PROTO=RADIUS,ROLE=AUTH;

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Page 30-174 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-AAA
ENT-AAA
RTRV-AAA

76.MTFP50/30, Rev B January 2018 Page 30-175

12. Delete Commands TL1 Command Reference Manual

DLT-BL

Command Changes Since Previous Feature Package

• None.

Description
The DLT-BL command instructs the network element (NE) to delete a bundled link (BL).

SYMPROT BL can be deleted with or without TL members. Follow these steps to delete a PROT BL: 1) provision
BL OOS; 2) Delete OSPFRP of BL; 3) Remove TL members of BL; 4) Delete BL.

Restrictions and Exceptions

• A BL has to be manually OOS before it can be deleted.

• SYMPROT BL can be deleted with or without TL members.

• PROT BL can only be deleted when it is empty.

• The NE denies an attempt to delete BL, if a call exists on any TL member of the given BL.

• ABSTRACTNODE type OSPFRP entity must be deleted before PROT BL can be deleted.

• Deletion of a BL is denied if a TNA exists for the BL.

Command Format
DLT-BL:[tid]:<bl_aid>:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.2 DLT-BL Parameters

Parameter Value(s) Definition
bl_aid BL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-BLID

Example
DLT-BL::BL-3-1-1:AM0011;

Possible System Response

^^^CORIANT1 07-05-15 02:08:15
M AM0011 COMPLD
;

Page 30-176 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-BL
ENT-BL
RTRV-BL

76.MTFP50/30, Rev B January 2018 Page 30-177

12. Delete Commands TL1 Command Reference Manual

DLT-CALL

Command Changes Since Previous Feature Package

• None.

Description
The DLT-CALL command instructs the NE Control Plane to release an end-to-end path between network elements.
This command is only relevant for a NE serving as a call end-point. Removing the connections at all nodes is a best
effort activity.

Figure 12.1 End to End Call Example Network

NE NE NE

Call Call
end-point end-point

Restrictions and Exceptions

• None

Command Format
DLT-CALL:[tid]::ctag:::CALLID=<CallId>,NODE=<node_aid>;

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-178 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Table 12.3 DLT-CALL Parameters

Parameter Value(s) Definition
CallId Up to a 55 character string in the This parameter represents the call to be deleted.
following format: [CNTRY-CAR-AP-
]TYPE-ADDRESS-ID. (1)CNTRY -
country code (3 alphabetic characters)
(2)CAR - carrier code (1 to 6
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier

Example
The following example releases a connection:

DLT-CALL:CORIANT1::AM0011:::CALLID="IPV4-192.168.1.1-F423F",NODE=NODE-3-1;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-CALL
RTRV-CALL

76.MTFP50/30, Rev B January 2018 Page 30-179

12. Delete Commands TL1 Command Reference Manual

DLT-CONN

Command Changes Since Previous Feature Package

• None.

Description
The DLT-CONN (Delete Connection) command instructs the NE to delete a control plane connection. The
connection is established during a control plane call.

Restrictions and Exceptions

• CMDMDE=FRCD is required to delete a connection.

• String parameters must be used in quotes.

Command Format
DLT-CONN:[tid]::<ctag>:::NODE=<NodeAID>,CONNID=<ConnId>,CMDMDE=<CommandMode>;

Proper System Response

Proper System Response
<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.4 DLT-CONN Parameters

Parameter Value(s) Definition
NodeAID NODE-[1,3]-[1-512] Specifies the node that the call exists in.

Page 30-180 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Table 12.4 DLT-CONN Parameters (Continued)

Parameter Value(s) Definition
ConnId A double quoted string in the form of: Specifies the connection ID for the connection.
32 bit destination ID-
32 bit extendedTunnelID- Destination_ID: This ID indicates the destination NE, matching
16 bit tunnelID- the value found in the SESSION object of the RSVP PATH
32 bit source ID- message. For ENNIv1, ENNIv2 and INNIv1 this is the SC PC ID
16 bit lspID of the immediate downstream NE. For INNIv2, this is the
ingress NE of the domain.

ExtendedTunnelID: A 32-bit identifier used in the SESSION

objects to scope the TunnelID.

TunnelID: A 16-bit identifier used in the SESSION objects to

identify a reservation session. When the connection is signaled
with SHARED_EXPLICIT, connections with the same
Destination, ExtendedTunnelID and TunnelID is allowed to
share dataplane resources.

Source SC_PC_ID: This ID indicates the signaling controller of

source NE, matching the value found in the
SENDER_TEMPLATE object of the RSVP PATH message.

LSP_ID: A 16-bit identifier used in the SENDER_TEMPLATE

that allows a sender to distinquish different connections that
share resources.

CommandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies do not prevent the command from executing).

Example
DLT-CONN:::CP0100:::NODE=NODE-3-1,CONNID="140300f3-140300f3-11-140300f3-
1",CMDMDE=FRCD;

Possible System Response

CORIANT1 06-05-15 02:08:15
M CP0100 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-CONN

76.MTFP50/30, Rev B January 2018 Page 30-181

12. Delete Commands TL1 Command Reference Manual

DLT-CRS-OCH

Command Changes Since Previous Feature Package

• None

Description
The DLT-CRS-OCH command instructs the network element (NE) to release established OCH-level cross-
connection.

Note: Deletion of an OCH-L to OCH-P/OCH-OS cross-connection terminates the

service going on this facility by shutting down the laser on the
transponder(s) involved in this cross-connection. Note that deletion of an
OCH-L to OCH-L cross-connection is also service affecting.

Restrictions and Exceptions

• CMDMDE=FRCD is required to delete a connection when OCH facility is owned by Control Plane

Command Format
DLT-CRS-OCH:[tid]:<from_och>,<to_och>:ctag:::[CMDMDE=<CommandMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.5 DLT-CRS-OCH Parameters

Parameter Value(s) Definition
from_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

Page 30-182 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Table 12.5 DLT-CRS-OCH Parameters (Continued)

Parameter Value(s) Definition
to_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

CommandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution(any state
inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution(any state
inconsistencies does not prevent the command from executing).

Example
To delete a pass-through cross-connection between OCH-L-20-1-21-7 and OCH-L-20-2-21-7.
DLT-CRS-OCH:MTERA1:OCH-L-20-1-21-7,OCH-L-20-2-21-7:CP0100;

Possible System Response

^^^MTERA1 15-04-16 02:08:15

M CP0100 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-CRS-OCH
ENT-CRS-OCH
RTRV-CRS-OCH

76.MTFP50/30, Rev B January 2018 Page 30-183

12. Delete Commands TL1 Command Reference Manual

DLT-CRS-ODUk

Command Changes Since Previous Feature Package

• Added support of ODUk into ODU4/ODUC3 of OSM-4F.

• Added support for OSM-4S and OSM-5C.

Description
The DLT-CRS-ODUk command instructs the network element (NE) to release (delete) an ODUk cross-connection
between:
an ODUk supporting a client side facility and an ODUk (k = 0, 1) supported on OSM-1S
or an ODUk (k = 0, 1, 2, 2E, F) supported on OSM-2S/OSM-4S
or an ODUk (k = 0, 1, 2, 2E, 3, 4, F) supported on OSM-2C/OSM-4C/OSM-4F/OSM-5C
or an ODUk (k = 1, 2) supported on SSM-2S.

Restrictions and Exceptions

• The FROM and TO terminations must be of type specified in command, and a cross-connection
between them must exist.

• A crossconnect identified as red-lined is not able to be deleted unless the operation is confirmed by
specifying INCL=YES.

• The ODUk CRS cannot be removed unless INCL=YES is used for CP owned ODUk.

Command Format
DLT-CRS-ODUk:[tid]:<src_odu>,<dest_odu>:ctag:::[INCL=<incl>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-184 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Table 12.6 DLT-CRS-ODUk Parameters

Parameter Value(s) Definition
src_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-185

12. Delete Commands TL1 Command Reference Manual

Table 12.6 DLT-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

incl YES Specifies whether or not the command should complete if the
NO specified circuit is red-lined. If YES is specified, then the
command completes no matter what the RDLD status is.

Example
DLT-CRS-ODU2:CORIANT1:ODU2-20-1-3-1,ODU2-20-1-5-3:CP0100;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M CP0100 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-CRS-ODUk
ENT-CRS-ODUk
RTRV-CRS-ODUk

Page 30-186 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-CRS-STSn

Command Changes Since Previous Feature Package

• None.

Description
The DLT-CRS-STSn command instructs the network element (NE) to release established STSn level cross
connection.

Deleting this cross connection remove the association between the facilities. It is service affecting.

Restrictions and Exceptions

• The FROM and TO terminations must be of type specified in command, and a cross-connection
between them must exist.

• Deletion of a protected cross-connection fails if there is a manual switch command initiated (for
example, if the SST of the FFP is either mantoprot, mantowkg, fstowkg, fstoprot, lockout).

• A crossconnect identified as red-lined cannot be deleted unless the operation is confirmed by specifying
INCL=YES.

• Only deletion with INCL=YES is allowed when the cross-connect is owned by control plane.

• Deletion with INCL=NO is denied if the cross-connect is owned by the control plane.

Command Format
DLT-CRS-STSn:[tid]:<from_stsn>,<to_stsn>:ctag:::[INCL=<incl>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-187

12. Delete Commands TL1 Command Reference Manual

Table 12.7 DLT-CRS-STSn Parameters

Parameter Value(s) Definition
from_stsn STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

to_stsn STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID

20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

incl YES Specifies whether or not the command should complete if the
NO specified circuit is red-lined. If YES is specified, then the
command completes no matter what the RDLD status is.

Example
To delete a cross connection associated with STS1-20-7-4-17:

DLT-CRS-STS1:CORIANT1:STS1-20-7-4-17,STS1-20-7-11-177:CP0100;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M CP0100 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-188 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ED-CRS-STSn
ENT-CRS-STSn
RTRV-CRS-STSn

76.MTFP50/30, Rev B January 2018 Page 30-189

12. Delete Commands TL1 Command Reference Manual

DLT-DA

Command Changes Since Previous Feature Package

• None.

Description
The DLT-DA command instructs the network element (NE) to delete the Discovery Agent (DA).

Restrictions and Exceptions

• The Discovery Agent must be out of service prior to deleting the Discovery Agent.

Command Format
DLT-DA:[tid]:<DA_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.8 DLT-DA Parameters

Parameter Value(s) Definition
DA_aid DA-1 EntityID-DAID

Example
DLT-DA:CORIANT1:DA-1:AM0011;

Possible System Response

^^^CORIANT1 06-05-15 02:09:11

M AM0011 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TL
ED-DA
ENT-DA
RTRV-DA

Page 30-190 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-DB

Command Changes Since Previous Feature Package

• None.

Description
The DLT-DB command instructs the network element (NE) to delete its database. As part of this process the
command automatically initiates a warm restart of the System Controller Module and automatically creates a NE
Default Database. This command does not impact traffic until a re-configuration of the NE using the ED-NE
command or a database restoration using the COPY-RFILE command is performed. The restoration of the database
using the COPY-RFILE command may not impact traffic. It depends on the database that is restored on the NE.
Before the NE database can be deleted, it needs to have its primary state OOS (Out-of-Service). To verify the
primary state use the RTRV-DB command. To put the NE database OOS use the ED-DB command.

Restrictions and Exceptions

• Once the database is deleted, the NE is unable to report alarms and accepts a limited set of commands
as the NE Type is set to an "unknown" state until the NE database is fully restored via a database
backup or manually reconfigured following the commissioning procedures.

• The standby Shelf Controller on the primary shelf must be OOS-MA prior to command execution.

Command Format
DLT-DB:[tid]:[<db_aid>]:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.9 DLT-DB Parameters

Parameter Value(s) Definition
db_aid DB-1 EntityID-DBID

Example
DLT-DB:CORIANT1::CP0100;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M CP0100 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-191

12. Delete Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE
ED-DB
ED-NE
RTRV-DB

Page 30-192 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-EPG

Command Changes Since Previous Feature Package

• None.

Description
The DLT-EPG (Delete Equipment Protection Group) command instructs the network element (NE) to release an
equipment protection group (EPG) for a group with two SSM-2S modules in the case of single point failure on
equipment level for the SONET/SDH to OTN adaption and Ethernet Over SONET/SDH adaption.
Traffic is routed through the protectedModule upon completion of this command.

Restrictions and Exceptions

• Deletion of an EPG protection group fails if a manual switch command has been initiated (for example,
if the SST of the EPG is either mantoprot, mantowkg, fstowkg, fstoprot, lockout).

• Deletion of an EPG protection group is denied if there is at least one STS or ODU CRS provisioned.

• Deletion of an EPG protection group is denied if a control plane protection node is associated with a
protection group.

• Deletion of an EPG is denied when one or both OCn that demapped from ODUk is owned by control
plane (that is, in use by a TL).

• Deletion of an EPG protection group fails if one of the mapped ODUk facilities has ODUk TL
provisioned.

Command Format
DLT-EPG:[tid]:<protectedModule>,<protectingModule>:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.10 DLT-EPG Parameters

Parameter Value(s) Definition
protectedModu SSM2S-20-[1-16] EntityID-ShelfID-SlotID
le

protectingMod SSM2S-20-[1-16] EntityID-ShelfID-SlotID

ule

Example
DLT-EPG:CORIANT1:SSM2S-20-1,SSM2S-20-3:CTAG;

76.MTFP50/30, Rev B January 2018 Page 30-193

12. Delete Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-EPG
RTRV-EPG

Page 30-194 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-EQPT

Command Changes Since Previous Feature Package

• Added PWS, CD4D8

• Added support for OSM-4S and OSM-5C.

Description
The DLT-EQPT::{X} command instructs the network element (NE) to delete a selected equipment entity.

Before the unit can be deleted, the module needs to have its primary state OOS-MA (Out-Of-Service). To verify the
primary state you can use the RTRV-EQPT::{X} command.

{X} specifies the equipment type among AIDs provided in the Parameter Table.

Restrictions and exceptions

• Equipment entity deletion should be denied if a cross connect exists on facilities supported by this
module.

• Equipment entity deletion should be denied if an FFP exists on a module that has traffic being supported
through this equipment entity.

• Equipment entity deletion should be denied if a facility supported by this module is externally connected.

• Equipment entity deletion should be denied if there are existing fiber connections provisioned for this
module (through ENT-FIBR-EQPT command).

• Equipment entity deletion should be denied if there is an OCH level crossconnect has been provisioned
for the module.

• Equipment entity deletion should be denied if there are facilities that were explicitly created and are still
supported by this module.

• Equipment entity deletion should be denied if there are protection groups provisioned on the module

• Deleting a pluggable would be denied by the NE if there is any explicitly provisioned supported entity
present.

• Deleting implicitly created modules is denied. This includes the FAN, FAN8, SDM, SIOM, STPM, and
STPM8.

• A single shelf NE does not support deleting a shelf.

• The attempt to delete an OADMRS is denied if its subslot is used as COMMCONN of an extension
SLOT or PWS.

• An attempt to delete an OCC module is denied if any pluggable module entity is supported by the
module.

Command Format
DLT-EQPT:[tid]:<eqpt_aid>:ctag;

Proper System Response

<header>

76.MTFP50/30, Rev B January 2018 Page 30-195

12. Delete Commands TL1 Command Reference Manual

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.11 DLT-EQPT Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CD4D8-[50-58]-[2-4,6-8]
CDCP-20-[10-16,1-7]-[1-3]
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
DCM-20-[1-16]-[1-3]
FSM-20-[35,34]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OMD-20-[1-16]-[1-2]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SSM2S-20-[1-16]
STIM-20-[26,23]

Example
DLT-EQPT:CORIANT1:OSM2S-20-1:CP0100;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M CP0100 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-196 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ED-EQPT
ENT-EQPT
RTRV-EQPT

76.MTFP50/30, Rev B January 2018 Page 30-197

12. Delete Commands TL1 Command Reference Manual

DLT-EXDPATH

Command Changes Since Previous Feature Package

• None.

Description
The DLT-EXDPATH command instructs the Network Element (NE) to delete the existing excluded path.

Restrictions and Exceptions

• The deletion of an excluded path object is denied when it referenced as a WKGXPATH or PROTXPATH
when the call is created.

Command Format
DLT-EXDPATH:[tid]:<exdp_aid>:ctag;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.12 DLT-EXDPATH Parameters

Parameter Value(s) Definition
exdp_aid EXDPATH-[1,3]-[1-512] EntityID-NPID-PathID

Example
DLT-EXDPATH:CORIANT1:EXDPATH-3-1:AM0011;

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-EXDPATH
ENT-EXDPATH
RTRV-EXDPATH

Page 30-198 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-EXPPATH

Command Changes Since Previous Feature Package

• None.

Description
The DLT-EXPPATH command instructs the Network Element (NE) to delete the existing explicit path.

Figure 12.2 Explicit Path Examples

Z Destination Node
Source Node
A

Fully explicit route Partial explicit route

Restrictions and Exceptions

• DLT-EXPPATH command is denied, if the given explicit path is in-use.

• The deleting of an explicit path object is independent of whether it has been referenced as a WKGPATH
or PROTPATH when the call is created.

Command Format
DLT-EXPPATH:[tid]:<expp_aid>:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-199

12. Delete Commands TL1 Command Reference Manual

Table 12.13 DLT-EXPPATH Parameters

Parameter Value(s) Definition
expp_aid EXPPATH-[1,3]-[1-512] EntityID-NPID-PathID

Example
DLT-EXPPATH:CORIANT1:EXPPATH-3-1:AM0011;

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-EXPPATH
ENT-EXPPATH
RTRV-EXPPATH

Page 30-200 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-FFP-HGE

Command Changes Since Previous Feature Package

• Updated for OSM-5C.

Description
The DLT-FFP-HGE command instructs the network element (NE) to release a facility protection group for a pair of
HGE facilities.

The following HGE FFP can be deleted:

• YCable FFP between HGE facilities of two OSM-2C modules.

This command is not applicable to OSM-5C which does not support Y-cable.

Restrictions and Exceptions

• The delete of FFP is denied unless at least one of the facilities within the pair is in the out of service
state.

• Deletion of FFP protection group (Y-Cable) on client facility fails if one of the mapped ODUk facilities
has ODUk TL provisioned.

• Y-cable provisionig applicable only for OSM-2C, the valid PortID of the AID is between [1-2]. If PortID
of [3-5] is entered, the command is denied.

Command Format
DLT-FFP-HGE:[tid]:<protectedId>,<protectingId>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.14 DLT-FFP-HGE Parameters

Parameter Value(s) Definition
protectedId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

protectingId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

Example
DLT-FFP-HGE:CORIANT1:HGE-20-6-1,HGE-20-11-1:AM0074;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-201

12. Delete Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-HGE
RTRV-FFP-HGE

Page 30-202 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-FFP-OCn {OC3,OC12,OC48,OC192,OC768}

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The DLT-FFP-OCn (Delete Facilities Protection Group Optical Carrier) command instructs the network element
(NE) to release a facility protection group for a pair of OCn facilities.

Traffic is routed through the protectedId facility upon completion of this command.

The following FFP can be deleted on an SSM-2S:

• OC3/12/48/192 1+1 APS FFP between two Port side interfaces over the whole mTera shelf including
on any two SSM-2S modules or on the single SSM-2S module.

Restrictions and Exceptions

• Deletion of a protection group fails if a manual switch command has been initiated (for example, if the
SST of the FFP is either mantoprot, mantowkg, fstowkg, fstoprot, lockout).

• Deletion of a 1+1 APS FFP protection group is denied if there is at least one STS CRS provisioned.

• Deletion of a protection group is denied if a control plane protection node is associated with a protection
group.

• Deletion of a protection group fails if SCHEME=YCABLE and both the protected and protecting facilities
are IS. At least one facitily must be taken out of service prior to the deletion of the protection group.

• Deletion of the FFP is denied when one or both OCn of the FFP is owned by control plane (that is, in
use by a TL).

• No pairing relationship is required for the modules that support YCable FFP between OC192 facilities
in mTera shelf. The YCable FFP is supported over the whole mTera shelf.

• Deletion of FFP protection group (Y-Cable) on client facility fails if one of the mapped ODUk facilities
has ODUk TL provisioned.

Command Format
DLT-FFP-OCn:[tid]:<protectedId>,<protectingId>:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-203

12. Delete Commands TL1 Command Reference Manual

Table 12.15 DLT-FFP-OCn {OC3,OC12,OC48,OC192,OC768} Parameters

Parameter Value(s) Definition
protectedId OC12-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-{PortID|Vport-n}
OC12-20-[1-16]-[7-30]
OC192-20-[1-16]-[1-40]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32]

protectingId OC12-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-{PortID|Vport-n}

OC12-20-[1-16]-[7-30]
OC192-20-[1-16]-[1-40]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32]

Example
DLT-FFP-OC48:CORIANT1:OC48-20-9-8,OC48-20-8-1:CTAG;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-OCn
ED-FFP-OCn
RTRV-FFP-OCn

Page 30-204 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-FFP-STMn (STM1/STM4/STM16/STM64)

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The DLT-FFP-STMn (Delete Facilities Protection Synchronous Transport Mode) command instructs the network
element (NE) to release a facility protection group for a pair of STMn facilities.

The following FFP can be deleted on OSM-2S/OSM-4S:

• STM64 Y-cable FFP over the whole mTera shelf for any two OSM-2S or two OSM-4S or a single OSM-
2S/OSM-4S.

The following FFP can be deleted on SSM-2S:

• STM1/4/16/64 1+1 MSP FFP between two Port side interfaces over the whole mTera shelf including on
any two SSM-2S modules or on the single SSM-2S module.

A STMn FFP can be deleted from protected ports on transponders supporting Y-Cable protection.

Traffic is routed through the protectedId facility upon completion of this command.

Restrictions and Exceptions

• Deletion of a protection group fails if there is an outstanding protection switch command in place.

• Deletion of a 1+1 MSP protection group is denied if there is at least one VCn CRS involved in the 1+1
MSP FFP.

• Deletion of a protection group is denied if a control plane protection node is associated with a protection
group.

• Deletion of FFP protection group (Y-Cable) on client facility fails if one of the mapped ODUk facilities
has ODUk TL provisioned.

Command Format
DLT-FFP-STMn:[tid]:<protectedId>,<protectingId>:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.16 DLT-FFP-STMn (STM1/STM4/STM16) Parameters

Parameter Value(s) Definition
protectedId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID
STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

76.MTFP50/30, Rev B January 2018 Page 30-205

12. Delete Commands TL1 Command Reference Manual

Table 12.16 DLT-FFP-STMn (STM1/STM4/STM16) Parameters (Continued)

Parameter Value(s) Definition
protectingId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID
STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

Example
DLT-FFP-STM16:CORIANT1:STM16-20-9-8,STM16-20-8-1:CTAG;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-STMn
ED-FFP-STMn
RTRV-FFP-STMn

Page 30-206 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-FFP-TGLAN

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The DLT-FFP-TGLAN command instructs the network element (NE) to release a facility protection group for a pair
of TGLAN facilities.

The following TGLAN FFP can be deleted:

• YCable FFP between TGLAN facilities over the whole mTera shelf.

Restrictions and Exceptions

• The delete of FFP is denied unless at least one of the facilities within the pair is in the out of service
state.

• Deletion of a protection group fails if a manual switch command has been initiated (for example, if the
SST of the FFP is either mantoprot, mantowkg, fstowkg, fstoprot, lockout).

• Deletion of FFP protection group (Y-Cable) on client facility fails if one of the mapped ODUk facilities
has ODUk TL provisioned.

Command Format
DLT-FFP-TGLAN:[tid]:<protectedId>,<protectingId>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.17 DLT-FFP-TGLAN Parameters

Parameter Value(s) Definition
protectedId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

protectingId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

Example
DLT-FFP-TGLAN:CORIANT1:TGLAN-20-6-1,TGLAN-20-11-1:CTAG;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M AM0074 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-207

12. Delete Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-TGLAN
RTRV-FFP-TGLAN
ED-FFP-TGLAN

Page 30-208 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-FIBR-EQPT

Command Changes Since Previous Feature Package

• Added support for OSM-4S.

Description
The DLT-FIBR-EQPT command instructs the network element (NE) to delete the fiber connection between 2
modules or between patch panel and channel multiplexer modules.

Deleting this fiber connection remove the association between the modules supporting the facilities involved in this
connection. But the physical connection still exists.
This command is used to delete a non-Ribbon Fiber Connection:
• Equipment connection from OMD/CDCP add/drop ports to line interfaces of port modules.

• Equipment connection from OADMRS9 Aux ports to OMD DWDM ports.

• Equipment connections between OADMRS9 Express ports.

This command is used to delete a Ribbon Fiber Connection:

• Equipment ribbon fiber connection from OADMRS MPO ports to fiber shuffle MPO ports.

• Equipment ribbon fiber connection from fiber shuffle MPO ports to CDCP MPO ports.

Restrictions and Exceptions

• If there is OCh cross connection is supported by the fiber connection, the attempt to delete the fiber
connection is denied.

• Port parameters are required only when there is more than one type to choose from. (for example, a
transponder with a single lineside port should not include TOPORT as there is no ambiguity in port
selection).

• For OTN Control Plane, fiber entity on the corresponding OCH-P/OCH-OS cannot be deleted when the
OCH-P/OCH-OS entity is owned by CP or there is an associated OCH-P/OCH-OS TSL created.

• For OTN Control Plane, fiber entity cannot be deleted if the associated OCH/OCH-P/OCH-OS has a
cross connection provisioned by the CP.

• If there is OCh cross connection is supported by the ribbon fiber connection, the attempt to delete the
ribbon fiber connection is denied.

• If there is explicit OCH entity on an add/drop port of OMD, the attempt to delete fiber connection on
OMD DWDM port is denied.

• If there is fiber connection associated with ports of OMD, the attempt to delete the fiber connection on
the DWDM port is denied.

Command Format
DLT-FIBR-EQPT:[tid]:<from_aid>,<to_aid>:ctag:::[FROMPORT=<fromPort>]
[,TOPORT=<toPort>][,FROMRBPORT=<fromRibbonPort>][,TORBPORT=<toRibbonPort>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

76.MTFP50/30, Rev B January 2018 Page 30-209

12. Delete Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.18 DLT-FIBR-EQPT Parameters

Parameter Value(s) Definition
from_aid CDCP-20-[10-16,1-7]-[1-3] EntityID-ShelfID-SlotID-SubslotID
FSM-20-[35,34]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OMD-20-[1-16]-[1-2]

to_aid CDCP-20-[10-16,1-7]-[1-3] EntityID-ShelfID-SlotID-SubslotID

FSM-20-[35,34]
OADMRS9-20-[1-16]
OMD-20-[1-16]-[1-2]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]

fromPort Possible values are: (1) 9 to 14 when Specifies the "FROM" Aux port on an OADMRS9.
"from_aid" is CDCP (2) 3 to 11 when or
"from_aid" is OADMRS9 (3) 19135 to Specifiies the "FROM" Express port on an OADMRS9.
19610 in increments of 5 when or
"from_aid" is an OMD48. (4) 3 to 6, 9 Specifies the "FROM" add/drop port number on an OMD/CDCP/
to 12 when "from_aid" is a CD4D8. CD4D8.

toPort Possible values are: (1) 1 to 2 when Specifies the "TO" Line port of port module.
the "to_aid" is OSM2C. (2) 1 to 20
when the "to_aid" is OSM2S. (3) 1 to 4
when the "to_aid" is OSM4C (4) 1 to 2
when the "to_aid" is OSM4F (5) 3 to
11 when the "to_aid" is OADMRS9 (6)
1,2,7,8 when the "to_aid" is CD4D8 (7)
1 to 40 when the "to_aid" is OSM4S.

fromRibbonPo Possible values are: Specifies the "FROM" Ribbon Fiber MPO port name/number on
rt (1)"columnNumber""MPOName", an FSM.
columnNumber=1 to 21, or
MPOName=V, W, X, Y, Z, when Specifies the "FROM" Ribbon Fiber MPO port name on an
"from_aid" is FSM and "to_aid" is OADMRS.
CDCP. (2) V to Z when "from_aid" is
OADMRS and "to_aid" is FSM.

toRibbonPort Possible values are: (1) Specifies the "TO" Ribbon Fiber MPO port name/number on an
"columnNumber""MPOName", FSM.
columnNumber=1 to 21, or
MPOName=V, W, X, Y, Z, if to_aid is Specifies the "TO" Ribbon Fiber MPO port name on an CDCP.
FSM. (2) V, W if to_aid is CDCP.

Example
DLT-FIBR-EQPT::CDC-20-16-1,OSM2C-20-1:AM0074:::FROMPORT=9,TOPORT=1;

Page 30-210 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Possible System Response

^^^CORIANT100 14-11-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-FIBR-EQPT
ENT-FIBR-EQPT

76.MTFP50/30, Rev B January 2018 Page 30-211

12. Delete Commands TL1 Command Reference Manual

DLT-FTPSERVER

Command Changes Since Previous Feature Package

• None.

Description
The DLT-FTPSERVER command instructs the network element (NE) to delete the FTP server used for PM file
transfer purpose in binary format.

Restrictions and Exceptions

• Only Historical PM file transfer in binary format for STSn or ODUk montypes (for example, Path PM) is
supported.

Command Format
DLT-FTPSERVER:[tid]:<ftpserver_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.19 DLT-FTPSERVER Parameters

Parameter Value(s) Definition
ftpserver_aid FTPSERVER-1 EntityID-FTPSERVERID

Example
DLT-FTPSERVER:CORIANT1:FTPSERVER-1:CTAG1;

Possible System Response

^^^CORIANT1 06-06-15 02:08:15
M CTAG1 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-FTPSERVER
ENT-FTPSERVER
ED-FTPSERVER

Page 30-212 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-GCC

Command Changes Since Previous Feature Package

• Added support for GCC of ODUk of an ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The DLT-GCC command enables the customer to delete a GCC communication channel entity.

Restrictions and Exceptions

• Command must be denied if the primary state of the GCC entity is IS. To put the entity OOS, use the
ED-GCC command.

• Command must be denied if the GCC entity is being used by a topological link as a resource in SCN.
To remove the topological link, use the DLT-TL command.

• Command must be denied if the GCC interface is enabled in MCN through creating MCN TL (partition
1) on it.

• Command must be denied if there is TL created on the GCC in SCN.

• Command must be denied if there is TL created on the GCC in MCN.

Command Format
DLT-GCC:[tid]:[<gcc_aid>]:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-213

12. Delete Commands TL1 Command Reference Manual

Table 12.20 DLT-GCC Parameters

Parameter Value(s) Definition
gcc_aid GCC0-20-[1-16]-[1-32], GCC0-ShelfID-SlotID-PortID
GCC1-20-[1-16]-[1-20], GCC1-ShelfID-SlotID-PortID-{Supporting ODUtype}{Supporting
GCC1-20-[1-16]-[1-4]-[B,C][1-80]- ODU Tributary Port}-{ODUtype}{ODUTribPort}
[A,B,E,Z,F][1-32], GCC1-ShelfID-SlotID-PortID-{Supporting ODU4}{Supporting
GCC1-20-[1-16]-[1-20]- ODU4 TributaryPort}-{Supporting ODUtype}{Supporting ODU
[A,B,C,D,E,Z,F][1-80], Tributary Port}-{ODUtype}{ODUTribPort}
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32], Note:
GCC1-20-[1-16]-[1-2]-[D][1-3]- 1. for GCC created on an ODU associated with a client port, the
[A,B,C,E,Z,F][1-80], ODUTribPort is not used
GCC2-20-[1-16]-[1-20], 2. Supporting ODUtype and Supporting ODU Tributary Port are
GCC2-20-[1-16]-[1-4]-[B,C][1-80]- only used for 2-stage ODU multiplexing.
[A,B,E,Z,F][1-32], 3. GCC2 and GCC12 have same format values as GCC1.
GCC2-20-[1-16]-[1-20]- 4. Supporting ODU4 and Supporting ODU4 Tributary Port are
[A,B,C,D,E,Z,F][1-80], only applicable when LO ODU is multiplexed into ODU4 within
GCC2-20-[1-16]-[1-2]-[D][1-3]-[B,C][1- the ODUC2 or ODUC3 (when the modulation format of the port
80]-[A,B,E,Z,F][1-32], on OSM-4F is configured to 200G16QAM or 2X150G8QAM
GCC2-20-[1-16]-[1-2]-[D][1-3]- respectively).
[A,B,C,E,Z,F][1-80],
GCC12-20-[1-16]-[1-20],
GCC12-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]

Example
DLT-GCC:NE01:GCC0-20-2-1:AM0011;

Possible System Response

^^^NEO1 11-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-GCC
ED-GCC
RTRV-GCC

Page 30-214 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-IPPG

Command Changes Since Previous Feature Package

• None.

Description
The DLT-IPPG command instructs the mTera network element (NE) to delete the IP protection group.

Restrictions and Exceptions

• An IPPG has to be manually OOS before it can be deleted.

• The attempt to delete the IPPG is denied if there is TL created on it.

Command Format
DLT-IPPG:[tid]:<ippg_aid>:ctag;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.21 DLT-IPPG Parameters

Parameter Value(s) Definition
ippg_aid IPPG-1 EntityID-IPPGID

Example
The following example deletes the IPPG:

DLT-IPPG:CORIANT1:IPPG-1;

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M KTRP01 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-IPPG
ENT-IPPG
RTRV-IPPG

76.MTFP50/30, Rev B January 2018 Page 30-215

12. Delete Commands TL1 Command Reference Manual

DLT-LABELSET

Command Changes Since Previous Feature Package

• None.

Description
The DLT-LABELSET command instructs the NE Control Plane to delete a label set object. Deletion of an AUTO or
MAN label set is allowed by the NE if the label set was not used by a CP call.

Restrictions and Exceptions

• The command is denied if the label set (AUTO or MAN) is used by a CP Call.

Command Format
DLT-LABELSET:[tid]:<Labeset_aid>:ctag;

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.22 DLT-LABELSET Parameters

Parameter Value(s) Definition
Labeset_aid LABELSET-3-[d] EntityID-NPID-LSID

Example
DLT-LABELSET:CORIANT1:LABELSET-3-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-LABELSET
ED-LABELSET
RTRV-LABELSET

Page 30-216 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-MGTETH

Command Changes Since Previous Feature Package

• None.

Description
The DLT-MGTETH command instructs the network element (NE) to delete a selected management Ethernet
Facility.

Before the facility can be deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary
state use the RTRV-MGTETH command. To put the facility OOS use the ED-MGTETH command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in administratively out of service.

• This command is only used for mTera shelf.

• Deletion of the LCI MGTETH facility (MGTETH-20-[24,25]-1) is denied.

• Deletion of the DCN MGTETH facility (MGTETH-20-[21,28]-8) is denied.

• Deletion of the MGTETH facility is denied if there is TL associated with it.

• Deletion of the MGTETH facility is denied if its primary state is In-Service.

Command Format
DLT-MGTETH:[tid]:<fac_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.23 DLT-MGTETH Parameters

Parameter Value(s) Definition
fac_aid MGTETH-20-[13,14,21,24,25,28]-[1-8] EntityID-ShelfID-SlotID-PortID

Example
Delete an management ETH facility:

DLT-MGTETH:CORIANT1:MGTETH-20-21-1:MYCTAG;

76.MTFP50/30, Rev B January 2018 Page 30-217

12. Delete Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 08-05-05 02:08:15
M MYCTAG COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-MGTETH
ENT-MGTETH
RTRV-MGTETH

Page 30-218 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-MGTINBANDETH

Command Changes Since Previous Feature Package

• None.

Description
The DLT-MGTINBANDETH command instructs the network element (NE) to delete an inband management
P2PVLAN facility on Packet module.

Restrictions and Exceptions

• The P2P management VLAN can only be created over the interface of CEP,PNP and PPNP port with
type of switch

Command Format
DLT-MGTINBANDETH:[tid]:<mgtinbandeth_aid>:[CTAG];

Proper System Responses

<header>
M^^<ctag>COMPLD<cr>lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.24 DLT-MGTINBANDETH Parameters

Parameter Value(s) Definition
mgtinbandeth_ MGTINBANDETH-20-[10-16,1-7]-[1- EntityID-ShelfID-SlotID-PortID
aid 20]

Example
DLT-MGTINBANDETH:CORIANT1:mgtinbandeth-20-16-18:MYCTAG;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00
M MYCTAG COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-MGTINBANDETH
ED-MGTINBANDETH
RTRV-MGTINBANDETH

76.MTFP50/30, Rev B January 2018 Page 30-219

12. Delete Commands TL1 Command Reference Manual

DLT-NODE

Command Changes Since Previous Feature Package

• None.

Description
The DLT-NODE command instructs the network element (NE) to delete a Node entity.

Restrictions and Exceptions

• Deletion of a node fails unless a node is OOS.

• The hub node must be the last node deleted on a shelf (that is, all protection nodes on a shelf must be
deleted before the hub node is deleted).

• Deletion is denied if the NODE entity is supporting any TL or TSL entities.

Command Format
DLT-NODE:[tid]:<node_aid>:<ctag>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.25 DLT-NODE Parameters

Parameter Value(s) Definition
node_aid NODE-[1,3]-[1-512] EntityID-NPID-NodeID

Example
DLT-NODE::NODE-2-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-220 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ENT-NODE
ED-NODE
RTRV-NODE

76.MTFP50/30, Rev B January 2018 Page 30-221

12. Delete Commands TL1 Command Reference Manual

DLT-NP

Command Changes Since Previous Feature Package

• None.

Description
The DLT-NP (Delete Network Partition) command instructs the network element (NE) to delete a Network Partition.

Restrictions and Exceptions

• Deletion is denied if the Network Partition is supporting any child Node, OSPF or RSVP entities.

Command Format
DLT-NP:[tid]:<np_aid>:<ctag>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.26 DLT-NP Parameters

Parameter Value(s) Definition
np_aid NP-[1,3] EntityID-NPID

Example
DLT-NP:CORIANT1:NP-1:CP0100;

Possible System Response

CORIANT1 06-05-15 02:08:15
M CP0100 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-NP
ED-NP
RTRV-NP
RTRV-NP-STATS

Page 30-222 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-NTPPEER

Command Changes Since Previous Feature Package

• None.

Description
Use the DLT-NTPPEER command to delete an NTP Peer. Before the entity can be deleted, it needs to have its
primary state OOS (Out-Of-Service). To verify the primary state you can use the RTRV-NTPPEER command. To
put the facility OOS you use the ED-NTPPEER command.

Deleting one NTP Peer prevents this NTP Peer from becoming a source of clock synchronization. Deleting both NTP
Peers (when 2 NTP Peers are configured) makes the NE's TOD clock to operate in "Free Run" instead of "External".
This means that the NE is no longer synchronized to an external NTP clock source.

Restrictions and Exceptions

Command Format
DLT-NTPPEER:[tid]:<ntppeer_aid>:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.27 DLT-NTPPEER Parameters

Parameter Value(s) Definition
ntppeer_aid NTPPEER-[2,1] EntityID-PeerID

Example
DLT-NTPPEER:CORIANT1:NTPPEER-2:CP0100;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15
M CP0100 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-NTPPEER
ENT-NTPPEER
RTRV-NTPPEER

76.MTFP50/30, Rev B January 2018 Page 30-223

12. Delete Commands TL1 Command Reference Manual

DLT-OCH

Command Changes Since Previous Feature Package

• Added support for OSM-4S.

Description
The DLT-OCH command instructs the network element (NE) to delete an optical channel facility entity. The following
optical channel facilities can be deleted:
• OCH facility on an OMD, CDCP ADD/DROP port that was explicitly created for connection of an Alien
Transponder (not managed by the NE) to OADMRS/OADMRS9 module.

• OCH-P facility explicitly created on OSM-2S/OSM-2C/OSM-4S module.

• OCH-L facility explicitly created on OADMRS/OADMRS9 module.

• OCH-OS facility explicitly created on OSM-4C/OSM-4F module.

Before the facility can be deleted, its primary state should be administratively OOS (that is, OOS-AU, OOS-MA,
OOS-AUMA, and so on).To verify the primary state use the RTRV-OCH command. The facility must be OOS (via
ED-OCH command) and not involved in a connection before it can be deleted. Use RTRV-CRS-OCH to verify if the
facility is involved in OCH connection.

On mTera, an attempt to de-provision the OCH-P facility is denied when ODUk(k=2/2E/4) is not de-provisioned yet.

Attempt to de-provision the OCH-OS facility is denied when ODUk(k=0/1/2/2E/3/4/F) is not de-provisioned yet.

Restrictions and Exceptions

• The facility must be in a manual OOS state (for example, OOS-MA, OOS-AUMA, and so on) before it
can be deleted.

• Facility can not be deleted if involved in OCH or OCH-P connection, OCH-L to OCH cross connection,
or if the OCH-P is provisioned for direct connection (EXTCHAN = enabled, OCH-L to OCH-P cross
connection).

• OCH-OS facility can not be deleted if involved in OCH-OS cross connection, or if EXTCHAN is not NA.

• An attempt to delete OCH-P entity is denied if the port of the OCH-P is associated with fiber entity (ENT-
FIBR-EQPT).

• Deletion of OCH-P/OCH-OS facility is rejected if GCC is mapped with this facility.

• Deletion of OCH-P/OCH-OS facility is rejected if GCC is mapped with its supporting ODUk.

• Delete of OCH/OCH-P/OCH-L facility is rejected if it is owned by CP.

• OCH-OS does not support CP ownership.

Command Format
DLT-OCH:[tid]:<och_aid>:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Page 30-224 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.28 DLT-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-ShelfID-SlotID[-SubslotID]-PortID
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

Example
DLT-OCH:CORIANT1:OCH-P-20-4-1:AM0074;

Possible System Response

^^^CORIANT1 07-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-OCH
ED-OCH
ENT-OCH

76.MTFP50/30, Rev B January 2018 Page 30-225

12. Delete Commands TL1 Command Reference Manual

DLT-ODUF

Command Changes Since Previous Feature Package

• Added support of ODUF mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S and OSM-5C.

Description
The DLT-ODUF command instruct the network element (NE) to delete a ODUF entity.

Before the facility can be deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary
state use the RTRV-ODUF command. To put the facility OOS use the ED-ODUF command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Facility cannot be deleted if it is involved in a cross-connection with another ODUF.

• The facility cannot be deleted if it appears as the OPADJACENT entity in RTRV-ODUFT. The ODUFT
entity needs to be deleted before this ODUF entity can be deleted.

Command Format
DLT-ODUF:[tid]:<ODUF_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.29 DLT-ODUF Parameters

Parameter Value(s) Definition
ODUF_aid ODUF-20-[1-16]-[1-40]-[1-80], ODUF- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-20]-[B,C][1-80]-[1-32], ODU4TribPort][-SupportODU ODUTribPort]-TribID
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

Example
DLT-ODUF:CORIANT1:ODUF-20-2-3-1:AM0074;

Possible System Response

^^^CORIANT1 07-03-15 02:08:15
M AM0074 COMPLD
;

Page 30-226 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODUF
ENT-ODUF
RTRV-ODUF

76.MTFP50/30, Rev B January 2018 Page 30-227

12. Delete Commands TL1 Command Reference Manual

DLT-ODU0

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F

• Added support for OSM-4S, OSM-5C.

Description
The DLT-ODU0 command instruct the network element (NE) to delete a ODU0 entity.
Before the facility can be deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary
state use the RTRV-ODU0 command. To put the facility OOS use the ED-ODU0 command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Facility cannot be deleted if it is involved in a cross-connection with another ODU0.

• The facility cannot be deleted if it appears as the OPADJACENT entity in RTRV-ODU0T. The ODU0T
entity needs to be deleted before this ODU0 entity can be deleted.

• The deletion of any ODU0 facility is denied if any of the two ODU0 facilities that mapped to the client
FFP protection has ODU0 TL provisioned.

• Delete of ODU0 facility is rejected if it is owned by CP.

Command Format
DLT-ODU0:[tid]:<odu0_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.30 DLT-ODU0 Parameters

Parameter Value(s) Definition
odu0_aid ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]

Example
DLT-ODU0:CORIANT1:ODU0-20-2-5-1:AM0074;

Page 30-228 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Possible System Response

^^^CORIANT1 07-03-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU0
ENT-ODU0
RTRV-ODU0

76.MTFP50/30, Rev B January 2018 Page 30-229

12. Delete Commands TL1 Command Reference Manual

DLT-ODU1

Command Changes Since Previous Feature Package

• Added support of ODU1 mux into ODU4 of the ODUC3 on OSM-4F

• Added support for OSM-4S, OSM-5C.

Description
The DLT-ODU1 command instruct the network element (NE) to delete a ODU1 entity.
Before the facility can be deleted, it needs to have its primary state must be administratively OOS. To verify the
primary state use the RTRV-ODU1 command. To put the facility OOS use the ED-ODU1 command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Facility cannot be deleted when it is involved in a cross connection.

• ODU1 entity on OTNM is implicitly created and may not be deleted.

• The facility cannot be deleted if it appears as the OPADJACENT entity in RTRV-ODU1T. The ODU1T
entity needs to be deleted before this ODU1 entity can be deleted.

• Deletion of ODU1 entity must be rejected if GCC is created on it.

• Delete of ODU1 facility is rejected if it is owned by CP.

• The deletion of any ODU1 facility is denied if any of the two ODU1 facilities that mapped to the client
FFP protection has ODU1 TL provisioned.

• On mTera SSM-2S module that is not in EPG group or a working module that is in EPG group, an
attempt to de-provision ODU1 facility would be denied when the mapped OC48/STM16 facilityis not de-
provisioned yet.

• On mTera SSM-2S working module that is in EPG group, de-provision ODU1 facility would implicitly de-
provision ODU1 facility on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to de-provision ODU1 facility
would be denied.

Command Format
DLT-ODU1:[tid]:<odu1_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-230 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Table 12.31 DLT-ODU1 Parameters

Parameter Value(s) Definition
odu1_aid ODU1-20-[1-16]-[1-32], ODU1-20-[1- EntityID-ShelfID-SlotID--{PortID[-SupportingODU4
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]

Example
DLT-ODU1:CORIANT1:ODU1-20-2-5-1:AM0074;

Possible System Response

^^^CORIANT1 07-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU1
ENT-ODU1
RTRV-ODU1

76.MTFP50/30, Rev B January 2018 Page 30-231

12. Delete Commands TL1 Command Reference Manual

DLT-ODU2

Command Changes Since Previous Feature Package

• Added support of ODU2 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The DLT-ODU2 command instruct the network element (NE) to delete a ODU2 entity.

Before the facility can be deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary
state use the RTRV-ODU2 command. To put the facility OOS use the ED-ODU2 command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Facility cannot be deleted if it is involved in a cross-connection with another ODU2.

• Deletion of ODU2 entity must be rejected if GCC is mapped with it.

• Delete of ODU2 facility is rejected if it is owned by CP.

• The deletion of any ODU2 facility is denied if any of the two ODU2 facilities that mapped to the client
FFP protection has ODU2 TL provisioned.

• On mTera SSM-2S module that is not in EPG group or a working module that is in EPG group, an
attempt to de-provision ODU2 facility would be denied when the mapped OC192/STM64 facilityis not
de-provisioned yet.

• On mTera SSM-2S working module that is in EPG group, de-provision ODU2 facility would implicitly de-
provision ODU2 facility on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to de-provision ODU2 facility
would be denied.

Command Format
DLT-ODU2:[tid]:<ODU2_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-232 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Table 12.32 DLT-ODU2 Parameters

Parameter Value(s) Definition
odu2_aid ODU2-20-[1-16]-[1-40], ODU2-20-[1- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]

Example
DLT-ODU2:CORIANT1:ODU2-20-2-1:AM0074;

Possible System Response

^^^CORIANT1 07-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU2
ENT-ODU2
RTRV-ODU2

76.MTFP50/30, Rev B January 2018 Page 30-233

12. Delete Commands TL1 Command Reference Manual

DLT-ODU2E

Command Changes Since Previous Feature Package

• Added support of ODU2E mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The DLT-ODU2E command instruct the network element (NE) to delete a ODU2E entity.

Before the facility can be deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary
state use the RTRV-ODU2E command. To put the facility OOS use the ED-ODU2E command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Facility cannot be deleted if it is involved in a cross-connection with another ODU2E.

• ODU2E entity on mTera is explicitly created.

• Deletion of ODU2E entity must be rejected if GCC is mapped with it.

• Delete of ODU2E facility is rejected if it is owned by CP.

Command Format
DLT-ODU2E:[tid]:<ODU2E_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.33 DLT-ODU2E Parameters

Parameter Value(s) Definition
ODU2E_aid ODU2E-20-[1-16]-[1-4], ODU2E-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]

Example
DLT-ODU2E:CORIANT1:ODU2E-20-2-1:AM0074;

Page 30-234 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Possible System Response

^^^CORIANT1 07-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU2E
ENT-ODU2E
RTRV-ODU2E

76.MTFP50/30, Rev B January 2018 Page 30-235

12. Delete Commands TL1 Command Reference Manual

DLT-ODU3

Command Changes Since Previous Feature Package

• Added support of ODU3 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-5C.

Description
The DLT-ODU3 command instruct the network element (NE) to delete a ODU3 entity. Before the facility can be
deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary state use the RTRV-ODU3
command. To put the facility OOS use the ED-ODU3 command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Facility cannot be deleted if it is involved in a cross-connection with another ODU3.

• ODU3 entity on OSM-2C/OSM-4C/OSM-4F/OSM-5C is explicitly created.

• Deletion of ODU3 entity must be rejected if GCC is mapped with it.

• Delete of ODU3 facility is rejected if it is owned by CP.

Command Format
DLT-ODU3:[tid]:<ODU3_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.34 DLT-ODU3 Parameters

Parameter Value(s) Definition
ODU3_aid ODU3-20-[1-16]-[1-5]-[1-80], ODU3- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]- ODU4TribPort]-TribID
[D][1-3]-[1-80]

Example
DLT-ODU3:CORIANT1:ODU3-20-2-1-1:AM0074;

Possible System Response

^^^CORIANT1 07-03-15 02:08:15

Page 30-236 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU3
ENT-ODU3
RTRV-ODU3

76.MTFP50/30, Rev B January 2018 Page 30-237

12. Delete Commands TL1 Command Reference Manual

DLT-ODU4

Command Changes Since Previous Feature Package

• Added support for OSM-5C.

Description
The DLT-ODU4 command instruct the network element (NE) to delete a ODU4 entity. Before the facility can be
deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary state use the RTRV-ODU4
command. To put the facility OOS use the ED-ODU4 command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Facility cannot be deleted if it is involved in a cross-connection with another ODU4.

• ODU4 entity on OSM-2C/OSM-4C/OSM-4F/OSM-5C is explicitly created.

• ODU4TribPort field in the AID is applicable only for ODU4 within an ODUC2 or ODUC3 on the OSM-4F.

• The facility cannot be deleted if it appears as the OPADJACENT entity in RTRV-ODU4T. The ODU4T
entity needs to be deleted before this ODU4 entity can be deleted.

• Deletion of ODU4 entity must be rejected if GCC is mapped with it.

• Delete of ODU4 facility is rejected if it is owned by CP.

Command Format
DLT-ODU4:[tid]:<ODU4_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.
Table 12.35 DLT-ODU4 Parameters
Parameter Value(s) Definition
ODU4_aid ODU4-20-[1-16]-[1-5], ODU4-20-[1- EntityID-ShelfID-SlotID-PortID[-Num]|[-ODU4TribPort]
16]-[1-2]-[1-3]

Example
DLT-ODU4:CORIANT1:ODU4-20-2-1:AM0074;

Page 30-238 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Possible System Response

^^^CORIANT1 07-03-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU4
ENT-ODU4
RTRV-ODU4

76.MTFP50/30, Rev B January 2018 Page 30-239

12. Delete Commands TL1 Command Reference Manual

DLT-ODUC2

Command Changes Since Previous Feature Package

• None.

Description
The DLT-ODUC2 command instruct the network element (NE) to delete a ODUC2 entity. Before the facility can be
deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary state use the RTRV-
ODUC2 command. To put the facility OOS use the ED-ODUC2 command.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• ODUC2 entity on OSM-4F is explicitly created.

• Deletion of ODUC2 entity must be rejected if GCC is mapped with it.

Command Format
DLT-ODUC2:[tid]:<ODUC2_aid>:ctag;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.
Table 12.36 DLT-ODUC2 Parameters
Parameter Value(s) Definition
ODUC2_aid ODUC2-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID

Example
DLT-ODUC2:CORIANT1:ODUC2-20-2-1:AM0074;

Possible System Response

^^^CORIANT1 01-03-16 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODUC2

Page 30-240 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

ENT-ODUC2
RTRV-ODUC2

76.MTFP50/30, Rev B January 2018 Page 30-241

12. Delete Commands TL1 Command Reference Manual

DLT-ODUC3

Command Changes Since Previous Feature Package

• New Command.

Description
The DLT-ODUC3 command instruct the network element (NE) to delete a ODUC3 ntity. Before the facility can be
deleted, it needs to have its primary state OOS-MA (out-of-service). To verify the primary state use the RTRV-
ODUC3command. To put the facility OOS use the ED-ODUC3ommand.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• ODUC3 entity on OSM-4F is explicitly created.

• Deletion of ODUC3 ntity must be rejected if GCC is mapped with it.

Command Format
DLT-ODUC3[tid]:<ODUC3aid>:ctag;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.
Table 12.37 DLT-ODUC3 Parameters
Parameter Value(s) Definition
ODUC3_aid ODUC3-20-[1-16]-1 EntityID-ShelfID-SlotID-PortID

Example
DLT-ODUC3CORIANT1:ODUC320-2-1:AM0074;

Possible System Response

^^^CORIANT1 01-03-16 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-242 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ED-ODUC3
ENT-ODUC3
RTRV-ODUC3

76.MTFP50/30, Rev B January 2018 Page 30-243

12. Delete Commands TL1 Command Reference Manual

DLT-OSCX

Command Changes Since Previous Feature Package

• None.

Description
The DLT-OSCX command instructs the network element (NE) to delete an OSCX entity.

Restrictions and Exceptions

• The AID OSCX-*-1 is denied because this entity is automatically created and cannot be deleted.

• This command is denied if the OSCX is being used by a topological link as a resource. To remove the
topological link, use the DLT-TL command.

Command Format
DLT-OSCX:[tid]:<oscx_aid>:<ctag>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.38 DLT-OSCX Parameters

Parameter Value(s) Definition
oscx_aid OSCX-20-[10-16,1-7]-21-[2,1],OSCX- EntityID-ShelfID-SlotID-PortID-N
20-[1-16]-1-[2,1]

Example
DLT-OSCX::OSCX-1-1-21-2:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-244 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ED-OSCX
ENT-OSCX
RTRV-OSCX

76.MTFP50/30, Rev B January 2018 Page 30-245

12. Delete Commands TL1 Command Reference Manual

DLT-OSPF

Command Changes Since Previous Feature Package

• None.

Description
The DLT-OSPF command instructs the system to delete an OSPF routing instance. Before a routing controller can
be deleted, it needs to have its primary state OOS-MA or OOS-AU. To verify the primary state use the RTRV-OSPF
command. To change the primary state use the ED-OSPF command.

Command Format
DLT-OSPF:[tid]:<ospf_aid>:ctag;

Restrictions and Exceptions

• Command is denied if a routing area is configured on the routing controller specified in the command.

• This command is denied if the primary state of the routing controller specified in the command is IS.

• Deletion is denied if the OSPF entity is supporting any child OSPFADJ, OSPFRPMAP or OSPFAREA
entities.

Proper System Response

The completed response indicates that the OSPF routing instance has been deleted.
<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.39 DLT-OSPF Parameters

Parameter Value(s) Definition
ospf_aid OSPF-[1,3]-1 EntityID-NPID-OSPFID

Example
DLT-OSPF:NE01:OSPF-1-1:AM0011;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-246 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ENT-OSPF
ED-OSPF
RTRV-OSPF
DLT-OSPFADJ

76.MTFP50/30, Rev B January 2018 Page 30-247

12. Delete Commands TL1 Command Reference Manual

DLT-OSPFADJ

Command Changes Since Previous Feature Package

• None.

Description
The DLT-OSPFADJ command instructs the network element (NE) to remove a manual OSPF routing adjacency.
Before a manual adjacency can be deleted, it needs to have its primary state OOS(Out-of-Service). To verify the
primary state use the RTRV-OSPFADJ command. To change the primary state use the ED-OSPFADJ command.

Restrictions and Exceptions

• This command is denied if the routing adjacency does not exist.

• This command is denied if the primary state of the routing adjacency specified in the command is IS.

Command Format
DLT-OSPFADJ:[tid]:<ospfadj_aid>:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.40 DLT-OSPFADJ Parameters

Parameter Value(s) Definition
ospfadj_aid OSPFADJ-[1,3]-1-[1-40] EntityID-NPID-OSPFID-OSPFADJID

Example
DLT-OSPFADJ:NE01:OSPFADJ-1-1-2:AM0074;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-OSPFADJ

Page 30-248 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

ED-OSPFADJ
RTRV-OSPFADJ
DLT-OSPFAREA

76.MTFP50/30, Rev B January 2018 Page 30-249

12. Delete Commands TL1 Command Reference Manual

DLT-OSPFAREA

Command Changes Since Previous Feature Package

• None.

Description
The DLT-OSPFAREA command instructs the network element (NE) to remove an OSPF routing area. Before a
routing area can be deleted, it needs to have its primary state OOS(Out-of-Service). To verify the primary state use
the RTRV-OSPFAREA command. To change the primary state use the ED-OSPFAREA command.

Restrictions and Exceptions

• This command is denied if the ospf area specified has topological links assigned to it within the same
network partition.

• This command is denied if the ospf area specified is referenced from a node entity.

• This command is denied if the ospf area specified has adjacencies assigned to it.

• This command is denied if the primary state of the ospf area specified in the command is IS.

Command Format
DLT-OSPFAREA:[tid]:<ospfarea_aid>:ctag;

Proper System Response

The completed response indicates that the ospf area has been removed.
<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.41 DLT-OSPFAREA Parameters

Parameter Value(s) Definition
ospfarea_aid OSPFAREA-[1,3]-1-[1-32] EntityID-NPID-OSPFID-OSPFAREAID

Example
DLT-OSPFAREA:NE01:OSPFAREA-1-1-1:AM0011;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-250 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ENT-OSPFAREA
ED-OSPFAREA
RTRV-OSPFAREA

76.MTFP50/30, Rev B January 2018 Page 30-251

12. Delete Commands TL1 Command Reference Manual

DLT-OSPFRP

Command Changes Since Previous Feature Package

• None.

Description
The DLT-OSPFRP command instructs the network element (NE) to remove a redistribution point.

Restrictions and Exceptions

• System does not allow the delete redistribution point object (ABSTRACTNODE type) when there are
calls provisioned.

• The OSPFRP entity (ABSTRACTNODE type) of a TL can only be deleted when all the following
conditions are met: (a) The associated TL is not a member of a BL. (b) The associated TL is set to OOS.
(c) The associated TL is not supporting any call.

• BL must be OOS before the OSPFRP entity (ABSTRACTNODE type) of a BL can be deleted.

Command Format
DLT-OSPFRP:[tid]:<ospfrp_aid>:ctag;

Proper System Response

The completed response indicates that the redistribution point entry specified has been deleted from the table.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.42 DLT-OSPFRP Parameters

Parameter Value(s) Definition
ospfrp_aid OSPFRP-[1,3]-1-[1-3]-[1-100] EntityID-NPID-OSPFID-OSPFRPMAPID-OSPFRPID

Example
DLT-OSPFRP:NE01:OSPFRP-3-1-1-1:AM0074;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-252 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Related Commands
ENT-OSPFRP
ED-OSPFRP
RTRV-OSPFRP

76.MTFP50/30, Rev B January 2018 Page 30-253

12. Delete Commands TL1 Command Reference Manual

DLT-OSPFRPMAP

Command Changes Since Previous Feature Package

• None.

Description
The DLT-OSPFRPMAP command instructs the network element (NE) to remove a redistribution point map.

Restrictions and Exceptions

• A redistribution point map can only be deleted if it contains no redistribution point entities.

Command Format
DLT-OSPFRPMAP:[tid]:<ospfrpmap_aid>:ctag;

Proper System Response

The completed response indicates that the manual redistribution point entry specified has been deleted from the
table.
<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.43 DLT-OSPFRPMAP Parameters

Parameter Value(s) Definition
ospfrpmap_aid OSPFRPMAP-[1,3]-1-[1-3] EntityID-NPID-OSPFID-OSPFRPMAPID

Example
DLT-OSPFRPMAP:NE01:OSPFRPMAP-3-1-1:AM0074;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-OSPFRPMAP
RTRV-OSPFRPMAP

Page 30-254 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-PPP

Command Changes Since Previous Feature Package

• None.

Description
The DLT-PPP command enables the customer to delete a PPP session over DCC of an OCn port facility.

Restrictions and Exceptions

• Command is denied if the primary state of the PPP session is IS. To put the entity OOS, use the ED-
PPP command.

• Command is denied if the PPP session is being used by a topological link as a resource. To remove the
topological link, use the DLT-TL command.

Command Format
DLT-PPP:[tid]:[<ppp_aid>]:<ctag>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.44 DLT-PPP Parameters

Parameter Value(s) Definition
ppp_aid PPPL-[20]-[1-16]-[1-30], PPPL-[20]-[1- EntityID-ShelfID-SlotID-PortID[-Index]
16]-99-[1-30]
PPPMS-[20]-[1-16]-[1-30], PPPMS-
[20]-[1-16]-99-[1-30]
PPPRS-[20]-[1-16]-[1-30], PPPRS-
[20]-[1-16]-99-[1-30]
PPPS-[20]-[1-16]-[1-30], PPPS-[20]-
[1-16]-99-[1-30]

Example
DLT-PPP:NE01:PPPL-20-3-6:AM0011;

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0011 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-255

12. Delete Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-PPP
ED-PPP
RTRV-PPP

Page 30-256 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-RFILE

Command Changes Since Previous Feature Package

• None.

Description
The DLT-RFILE command is used to remove files from an NE. The command should also remove all directories
once all associated files have been removed.

The use of this command is restricted to removing 'temporary' files transferred or created on the NE. This command
automatically denies the removal of configuration file as well as active software files.

This command can be used to remove a Capability Extension File that has not yet been installed.

Command Format
DLT-RFILE:[tid]::ctag::<fileUrl>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.45 DLT-RFILE Parameters

Parameter Value(s) Definition
fileUrl file://url-path Specifies the file name and directory path to access the file.

Example
DLT-RFILE:CORIANT1::CP0100::"file://root1/dir1/file2";

DLT-RFILE:CORIANT1::CP0100::"file://root1/dir1/FP1_0_PLUGTF_V2";

Possible System Response

^^^CORIANT1 02-04-16 02:08:15
M CP0100 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

COPY-RFILE
RTRV-RFILE
REPT^EVT^FXFR

76.MTFP50/30, Rev B January 2018 Page 30-257

12. Delete Commands TL1 Command Reference Manual

DLT-RSVP

Command Changes Since Previous Feature Package

• None.

Description
The DLT-RSVP command instructs the network element (NE) to delete a RSVP Signaling Controller (RSVP SC)
entity.

RSVP Signaling Adjacency entities (that is, RSVPADJ) are automatically created and deleted by the control plane
software. The control plane attempts to create a signaling adjacency to a neighbor if the signaling controller (RSVP
entity) is IS and at least one TL with signaling enabled is IS to the neighbor. Only one signaling adjacency is created
per neighbor. The control plane deletes a signaling adjacency if the signaling controller is OOS or if the TL with
signaling enabled is put OOS and there are no IS TLs with signaling enabled to the neighbor.

Restrictions and Exceptions

• Deletion of a RSVP Signaling Controller is denied if any connection exists on the same partition as the
RSVP Signaling Controller.

• Deletion is denied if the RSVP entity is supporting any child RSVPADJ entities.

Command Format
DLT-RSVP:[tid]:<rsvp_aid>:<ctag>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.46 DLT-RSVP Parameters

Parameter Value(s) Definition
rsvp_aid RSVP-[1,3]-1 EntityID-NPID-RSVPID

Example
DLT-RSVP::RSVP-2-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Page 30-258 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-RSVP
RTRV-RSVP

76.MTFP50/30, Rev B January 2018 Page 30-259

12. Delete Commands TL1 Command Reference Manual

DLT-SESSION

Command Changes Since Previous Feature Package

• None.

Description
The DLT-SESSION command instructs the network element (NE) to terminate one or all sessions on the NE.

This command is used by an appropriate administrator to log off an ongoing session (for example, the session of an
intruder masquerading as a valid user). Users without administrative privileges may use this command to log off only
their own sessions.

The DLT-SESSION can be used by Admin only to:

• Delete his own session by specifying his own sessionID

• Delete anybody else session by specifying the appropriate session ID

• Delete all sessions but his own by specifying ALL

The session ID is the TCP/IP session ID and it applies to both Raw TCP and Telnet.

Restrictions and Exceptions

• When "ALL" is used as a session ID, the system terminates all active sessions except the one that
originated the command.

Command Format
DLT-SESSION:[tid]:{<session_id>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.47 DLT-SESSION Parameters

Parameter Value(s) Definition
session_id [0-999999999] Specifies the Session ID on which a user is logged in. It is
unique for any active session on the NE.

Example
DLT-SESSION:CORIANT1:423:CP0100;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15
M CP0100 COMPLD
;

Page 30-260 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

RTRV-SESSION

76.MTFP50/30, Rev B January 2018 Page 30-261

12. Delete Commands TL1 Command Reference Manual

DLT-STAT-RTE

Command Changes Since Previous Feature Package

• None.

Description
The DLT-STAT-RTE command instructs the network element (NE) to delete a static route from the IP packets
forwarding table.

Restrictions and Exceptions

• The parameters value set [DEST, NETMASK, INTERFACE] must be used to uniquely identify a static
route entry for a TL associated with a resource of type GCC, PPP or OSCX.

• The parameters value set [DEST, NETMASK, INTERFACE,NEXTHOP] must be used to uniquely
identify a static route entry for a TL associated with a resource of MGTETH or IPPG.

• A value for TL_aid must be specified.

• This command is denied if a value is specified for IFNAME.

• This command is denied if the TL_aid parameter specifies a TL associated with a SINTF-1, OCn or
STMn entity.

• If the only parameter specified is DEST, all static routes to the destination is deleted.

Command Format
DLT-STAT-RTE:[tid]::ctag:::DEST=<destination> [,NETMASK=<netmask>]
[,INTERFACE=<TL_aid>][,IFNAME=<IfName>][,NEXTHOP=<next_hop>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.48 DLT-STAT-RTE Parameters

Parameter Value(s) Definition
destination Format for the IP address is: A double Specifies the host or the network destination where the IP
quoted string representing the IPv4 packet is attempting to reach.
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

netmask [0-255].[0-255].[0-255].[0-255] The netmask is bitwise 'AND'ed with the destination IP address
of the packet and compared with the 'destination' field of this IP
forwarding table entry.

TL_aid TL-1-[1-512]-[1-1500] Specifies the local host interface (TL) through which the IP
packet egresses.

Page 30-262 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Table 12.48 DLT-STAT-RTE Parameters (Continued)

Parameter Value(s) Definition
next_hop [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the next_hop to be taken by the IP
packet en route to the destination.
This parameter is required when ARP is needed to find out the
Ethernet MAC address to send the IP packet. This parameter is
not required if the interface is a point to point Ethernet link.

Example
The following example deletes all the static route(s) to destination network 192.168.2.0:
DLT-STAT-RTE:::AM0011:::DEST="192.168.2.0";

The following example deletes the static route to destination network 192.168.3.0 with a Mask of 255.255.255.0 on
Interface TL-1-5-7
DLT-STAT-RTE:::AM0011:::DEST="192.168.3.0",NETMASK=255.255.255.0,INTERFACE=TL-1-
5-7;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-STAT-RTE
RTRV-STAT-RTE
RTRV-RTE-ALL
ED-STAT-RTE

76.MTFP50/30, Rev B January 2018 Page 30-263

12. Delete Commands TL1 Command Reference Manual

DLT-SYNC

Command Changes Since Previous Feature Package

• None.

Description
The DLT-SYNC command instructs the network element (NE) to delete the synchronization reference.

Command Format
DLT-SYNC:[tid]: <sync_aid>:ctag ::: [CMDMDE=<commandMode>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.49 DLT-SYNC Parameters

Parameter Value(s) Definition
sync_aid SYNC-20-1 EntityID-ShelfID-SYNCID

CommandMod NORM Specifies the way in which the command is executed:

e FRCD 1. Enter NORM to specify a normal mode of execution (any
state inconsistencies prevents the command from executing).
1.1) When the previous external command is clear and
1.2) When there is no reference clock could be used (either not
available or in SF);
2. Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
DLT-SYNC:CORIANT1:SYNC-20-1:AM0074::: CMDMDE=FRCD;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SYNC
ENT-SYNC
ED-SYNC

Page 30-264 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-TL

Command Changes Since Previous Feature Package

• None.

Description
The DLT-TL command instructs the network element (NE) to delete a topological link.

Restrictions and Exceptions

• Deletion of a TL fails unless the TL is OOS and no calls are supported by the TL.

• Deletion of a TL which is a member of a BL fails unless the BL is administrative out-of-service and no

calls are supported by the TL.

• Deletion of a TL fails if one or more entries exist in the TNA table for the TL.

• Deletion of a TL fails if the TL is referenced in a manual OSPF adjacency.

• Deletion of a TL fails if the TL is part of a static route.

• Deletion of a TL fails if an unumbered link references this link as a parent TL.

• Deletion of a TL fails if the TL is referenced by an RSVP entity.

• TPOOL TL cannot be deleted if there are TTP members in the associated VCG.

• On the same node, deletion of an OTS TL fails if there is an associated TSL exists.

• For inter domain TL, the associated OSPFRP entity (ABSTRACTNODE type) must be deleted before
the TL can be deleted.

• Deletion of a TL fails if the TL is referenced by the ED-TCPIP parameter ASINTRFC

Command Format
DLT-TL:[tid]:<tl_aid>:<ctag>;

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.50 DLT-TL Parameters

Parameter Value(s) Definition
tl_aid TL-[1,3]-[1-512]-[1-1500] EntityID-NPID-NodeID-TLID

Example
DLT-TL::TL-2-1-1:AM0011;

76.MTFP50/30, Rev B January 2018 Page 30-265

12. Delete Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TL
ENT-TL
RTRV-TL

Page 30-266 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-TNALNKMAP

Command Changes Since Previous Feature Package

• None.

Description
The DLT-TNALNKMAP command instructs the network element (NE) to delete one or more entries from a TNA Link
Map. The TNA Link Map provides the mapping between a TNA and a TL.

If both parameters are provided, one entry in the table is deleted.

If one parameter is provided, all entries that match the parameter is deleted. This form of the command can be used
to delete all entries associated with a specific link from the TNA Link Map.

Restrictions and Exceptions

• At least one parameter TNA or LinkAID must be provided in the command.

• System denies the removal of TNALNK entry, if there is a call on the TL that is associated with the TNA.

Command Format
DLT-TNALNKMAP:[tid]::<ctag>:::[TNA=<TNA>][,LINKAID=<LinkAID>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.51 DLT-TNALNKMAP Parameters

Parameter Value(s) Definition
TNA Enter type-xxx.xxx.xxx.xxx format: (1) Specifies the TNA.
type is one of the following: IPV4
(2)xxx = 0-255

LinkAID TL-[1,3]-[1-512]-[1-1500] Specifies the AID of the link.

NodeAID NODE-[1,3]-[1-512] Specifies the AID of the node.

Example
DLT-TNALNKMAP:::AM0011:::TNA=IPV4-127.254.233.252,LINKAID=TL-3-1-1;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-267

12. Delete Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TNALNKMAP
RTRV-TNALNKMAP

Page 30-268 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-TRAPIP

Command Changes Since Previous Feature Package

• None.

Description
The DLT-TRAPIP command instructs the network element (NE) to remove the SNMP trap target entry associated
with the given SNMP manager.

Command Format
DLT-TRAPIP:[tid]::ctag:::TRPTGTADDR=<trptgtAddr>[,PORT=<snmpPort>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.52 DLT-TRAPIP Parameters

Parameter Value(s) Definition
trptgtAddr Format for the IP address is: A double Specifies the IP address of the SNMP Manager (Trap Target IP
quoted string representing the IPv4 address).
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

snmpPort Possible values are : SNMP Port = Specifies the SNMP port at which the manager receives the
nnnnn,where n = 0-9. notifications.

Example
DLT-TRAPIP:CORIANT::CP0100:::TRPTGTADDR="192.168.203.12";

DLT-TRAPIP:CORIANT::CP0100:::TRPTGTADDR="192.168.203.15",PORT=1043;

Possible System Response

^^^CORIANT 07-08-16 02:08:15
M CP0100 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TRAPIP
RTRV-TRAPIP

76.MTFP50/30, Rev B January 2018 Page 30-269

12. Delete Commands TL1 Command Reference Manual

DLT-TSL

Command Changes Since Previous Feature Package

• None.

Description
The DLT-TSL command instructs the network element (NE) to delete a transitional link.

Restrictions and Exceptions

• Deletion of a TSL is denied if the TSL is in service.

• The NE denies an attempt to delete TSL, if a call exists on the given TSL.

Command Format
DLT-TSL:[tid]:<tsl_aid>:<ctag>;

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.53 DLT-TSL Parameters

Parameter Value(s) Definition
tsl_aid TSL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-TSLID

Example
DLT-TSL::TSL-3-1-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TSL
ENT-TSL
RTRV-TSL

Page 30-270 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-TTP-{x}

Command Changes Since Previous Feature Package

• None.

Description
The DLT-TTP command instructs the network element (NE) to delete a selected trail termination point.

Only trail termination points that were created via the ENT-TTP command may be deleted with this command.

Before the trail termination point can be deleted, it needs to have its primary state OOS-MA (out-of-service). To
verify the primary state use the RTRV-TTP command. To put the trail termination point OOS use the ED-TTP
command. Also the trail termination point must not be a member of a VCG. Use the RTRV-TTP command to
determine if the TTP is part of a VCG, and the ED-VCG command to remove the TTP from the VCG.

Restrictions and Exceptions

• The TTP must be in the OOS-MA state.

• The TTP must have been created via ENT-TTP (AUTOCFG=NO).

• On mTera SSM-2S working module that is in EPG group, delete TTPSTSn entity associated with virtual
port 99 on backplane would implicitly delete TTPSTSn entity on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to delete TTPSTSn entity
associated with virtual port 99 on backplane would be denied.

Command Format
DLT-TTP-{x}:[tid]:<ttp_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.54 DLT-TTP-{x} Parameters

Parameter Value(s) Definition
ttp_aid TTPSTS1-20-[1-16]-99-[1-3]-[1-192] EntityID-ShelfID-SlotID-Vport-GroupId-n
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

Example
Delete a STS3C TTP:
DLT-TTP-STS3C:CORIANT1:TTPSTS3C-20-13-99-1-4:myctag;

76.MTFP50/30, Rev B January 2018 Page 30-271

12. Delete Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 08-05-05 02:08:15

M^^MYCTAG^COMPLD<cr><lf>

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TTP
ED-VCG
ENT-TTP
RTRV-TTP

Page 30-272 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

DLT-USER-SECU

Command Changes Since Previous Feature Package

• None.

Description
The DLT-USER-SECU command instructs the network element (NE) to delete a user login account from the system.
This command cannot delete a currently-active login account.

When the NE user being deleted has SNMP privilege, this command also instructs the network element (NE) to
delete the SNMPv3 user from the NE.

It also instructs the NE to remove any trap IPs configured by the uid being deleted.

Command Format
DLT-USER-SECU:[tid]:uid:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.55 DLT-USER-SECU Parameters

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. UID

Example
DLT-USER-SECU::SURVEILLANCE:AM0011;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-USER-SECU
ED-USER-SECU
RTRV-USER-SECU
ENT-TRAPIP

76.MTFP50/30, Rev B January 2018 Page 30-273

12. Delete Commands TL1 Command Reference Manual

DLT-VCG

Command Changes Since Previous Feature Package

• None.

Description
The DLT-VCG command instructs the network element (NE) to delete a selected virtual concatenation group.

Before the virtual concatenation group can be deleted, it needs to have its primary state OOS-MA (out-of-service).
To verify the primary state use the RTRV-VCG command. Also the virtual concatenation group cannot be deleted if
it contains any members, or the DLT-VCG command must specify the automatic removal of members option.. Use
RTRV-VCG to determine if there are any members and ED-VCG to remove them if necessary.

Restrictions and Exceptions

• The virtual concatenation group must be OOS-MA.

• The virtual concatenation group must not have any members or the command must specify the
automatic removal of members option.

• When VCGTYPE=MAN, the virtual concatenation group must not have any TTPs added as members.

• Deleting a VCG is denied if the VCG is owned by Control Plane.

Command Format
DLT-VCG:[tid]:vcg_aid:ctag:::[RMVMBR=<rmv_members>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.56 DLT-VCG Parameters

Parameter Value(s) Definition
vcg_aid VCG-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-n

rmv_members YES Specifies how the command should proceed if the VCG has
NO members at the time the deletion is requested.
YES indicates that the members should be removed
automatically as part of the deletion.
NO indicates that the command should fail if there are any
members in the group.

Page 30-274 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

Example
Delete a VCG without automatic member removal.
DLT-VCG:CORIANT1:VCG-20-12-4:myctag;

Possible System Response

^^^CORIANT1 08-05-05 02:08:15

M^^<ctag>^COMPLD<cr><lf>

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-VCG
ENT-VCG
RTRV-VCG

76.MTFP50/30, Rev B January 2018 Page 30-275

12. Delete Commands TL1 Command Reference Manual

DLT-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The DLT-{X} command instructs the network element (NE) to delete a selected facility entity.

Before the facility can be deleted, it needs to have its primary state OOS-MA (Out-of-Service). To verify the primary
state use the RTRV-{X} command. To put the facility OOS use the ED-{X} command.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): E1, FGE, GBEP, HGE, OC3, OC12, OC48, OC192, OTU1, OTU2, OTU4, OTUC2,
OTUC3, STM1, STM4, STM16, STM64, T1, TGLAN, STS1, STS3C, STS12C, STS48C, STS192C.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The facility must be in OOS-MA.

• Deletion should be denied if the facility is involved in a facility protection group (FFP).

• Deletion should be denied if the facility is a synchronization source for mTera system.

• Deletion should be denied if the facility is involved in a cross connect.

• Deletion should be denied for the OCn, STSn, OTUk facilities if the facility is owned by the control plane.

• Deletion of OTUk facility must be rejected if GCC is created on it.

• Deletion of OTUk facility must be rejected if GCC is created on its supporting ODUk.

• On mTera OSM modules, an attempt to de-provision the port facility(OTUk/TGLAN/OCn/STMn/HGE/

GBEP) is denied when ODUk(k=0/1/2/2E/4) is not de-provisioned yet.

• On mTera SSM-2S module, an attempt to de-provision OCn/STMn facility would be denied when the
terminated path entity (STSn) is not de-provisioned yet

• OTUC2 and OTUC3 facilities are only applicable for OSM-4F.

• On mTera SSM-2S working module that is in EPG group, delete OCn/STMn/STSn facility/entity
associated with virtual port 99 on backplane would implicitly provision OCn/STMn/STSn facility/entity
on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to delete OCn/STMn/STSn
facility/entity associated with virtual port 99 on backplane would be denied.

Command Format
DLT-{fac_type}:[tid]:<fac_aid>:ctag;

Proper System Response

<header>

Page 30-276 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 12. Delete Commands

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 12.57 DLT-{X} Parameters

Parameter Value(s) Definition
fac_aid E1-20-[15,23,26]-[1,2] EntityID-ShelfID-SlotID-PortID
E1OUT-20-[15,23,26]-[1,2]
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
T1-20-[15,23,26]-[1,2]
T1OUT-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]

Example
DLT-GBEP:CORIANT1:GBEP-20-11-1:CP0100;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M CP0100 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-277

12. Delete Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-{X}
ENT-{X}
RTRV-{X}

Page 30-278 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

13. Edit Commands

ED-AAA

Command Changes Since Previous Feature Package

• None.

Description
The ED-AAA command instructs the NE to modify a AAA (Authentication, Authorization and Accounting) server.

Restrictions and Exceptions

• SERVER, PROTO and ROLE are parameters to specify an existing AAA configuration. These
parameters cannot be modified by this command.

• The first name-defined parameter entered after the ctag must not have its leading comma.

Command Format
ED-
AAA:[tid]::ctag:::SERVER=<ipaddress>[,PROTO=<aaaproto>][,ROLE=<aaarole>][,SECRET
=<sharedsecret>][,TIMEOUT=<radtimeout>][,RETRY=<radretry>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.1 ED-AAA Parameters

Parameter Value(s) Definition
ipaddress [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the AAA server.

aaaproto RADIUS Specifies the AAA protocol between NE and the AAA server.

aaarole AUTH Specifies the AAA role supported by this AAA entry.

sharedsecret A string consisting of 6 to 32 Specifies the shared secret for the AAA server identified by the
characters. <ipaddress>.

The characters can be: numeric, lowercase alphabetical,

uppercase alphabetical or special characters: ! # $ % & @ ^ *
Note that the following characters are not allowed for
<sharedsecret>: ? / \ { [ ( ) ] }
The sharedsecret is displayed as "*".

76.MTFP50/30, Rev B January 2018 Page 30-279

13. Edit Commands TL1 Command Reference Manual

Table 13.1 ED-AAA Parameters (Continued)

Parameter Value(s) Definition
radtimeout [1-60] Specifies the response timeout of Access-Request messages
sent to a AAA server in seconds.

radretry [1-10] Specifies the number of attempted Access-Request messages

to a single AAA server before failing authentication.

Example
The following example changes the AAA server retry count:
ED-AAA:CORIANT1::AM0011:::SERVER="202.115.2.1", RETRY=5;

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-AAA
DLT-AAA
RTRV-AAA

Page 30-280 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ALMPF-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
Use the ED-ALMPF-{X} command to modify the attributes of any of the alarm profile tables (any created alarm profile
tables 1-20) assigned for equipment, facilities entities.
For each alarm profile table the command can specify:
• Whether an event (condition type) is automatically reported as MJ (Major), or MN (Minor) by
REPT^ALM.

• Whether an event (condition type) is NA (Not Alarmed), but reported as an event by REPT^EVT.

• Whether an event (condition type) is NR (Not Reported).

The alarm profile tables provide the flexibility of providing different levels of alarm and event reporting for assigned
terminations or equipment. In this way it is possible to assign higher priority with tables consisting of stricter
notification codes for condition types than might be necessary for lower priority facilities or equipment. By the same
token, it is also possible to design a varied amount of tables to handle different situations that could arise in the
course of system operation and maintenance.

{X} specifies the equipment type, facility or logical type among the following:
• Equipment: EQPT (representing the following acceptable module AIDs: BFM, CDCP, CFP, CFP2,
DCM, FAN, FAN8, FSM, MFAB, MFAB2, MFM, OADMRS, OADMRS9, OCC, OMD, OSM1S, OSM2S,
OSM2C, OSM4C, OSM4F, OSM4S, OSM5C, SAIM, SDM, SEIM, SIOM, SFM, SFP, SFPP, SH, SLOT,
SSM2S, STIM, STPM, STPM8).

• Facilities (fac_type): MGTETH, ETH, FGE, GBEP, HGE, OC3, OC12, OC48, OC192, OCH (for OCH,
OCH-L, OCH-P, OCH-OS), ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, ODUF, OMS, OSC, OTS,
OTU1, OTU2, OTU4, OTUC2, STS1, STS3C, STS12C, STS48C, STS192C, VCG, TGLAN.

• Logical (logic_type): GCC.

Restrictions and Exceptions

• The Facility AID must always correspond to the Facility type.

• Service Affecting condition types cannot be modified and are all critical (<ntfcncde>=CR). Therefore,
command is denied if an attempt to modify a condition type which is CR, SA is performed. However
some condition types can be both service affecting (SA) and non-service affecting (NSA) depending if
the equipment or facility is protected. In this case only NSA condition type is modified.

• Non Service Affecting condition types can only toggle between Major (MJ), Minor (MN), Not Alarmed
(NA) and Not Reported.

• TCA (for example, condition types starting with "T-") and other Transient conditions (except protection
switch conditions listed below) can only toggle between Not Alarmed and Not Reported.

• Notification code for protection switch conditions (FSTOPROT, FSTOWKG, LOCKOUT, MANTOPROT,
MANTOWKG, NOREQ, DNR, SDONPROT, SDONWKG, SFONPROT, SFONWKG, WTR) can not be
modified and is always Not Alarmed (NA).

76.MTFP50/30, Rev B January 2018 Page 30-281

13. Edit Commands TL1 Command Reference Manual

• For all condition types that begin with "T-" (Performance Monitoring related condition types), the only
valid value for the <dirn> parameter is BTH. For these condition types, BTH should be interpreted as
"all directions", meaning that the changes being made applies to all supported directions for the
condition type (TDTN, TDTC, RCV, TRMT, NA).

• If the optional parameters are not specified, the default value is no change to the current value.

Command Format
ED-ALMPF-{EQPT|<fac_type>|<logic_type>}:[tid]:<almProfile_aid>:ctag::<ntfcncde>,
<condtype>,[<srveff>],[<locn>],[<dirn>][,<tmper>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.2 ED-ALMPF-{X} Parameters

Parameter Value(s) Definition
almProfile_aid ALMPF-[99,1-20,0] EntityID-TBLID

ntfcncde MJ Indicates the notification code (severity level) associated with

MN the condition type.
NA The codes include: major, minor, not alarmed and not reported.
NR

condtype Refer to Alarm and Condition Tables Identifies the current standing conditions which cause alarms
for the possible values of Condition and/or events.
Types.

srveff NSA Indicates if an alarm is service affecting or nonservice affecting:

NSA indicates non-service affecting.

locn NEND Indicates if the alarm or event location is near end or far end.
FEND - NEND: Near End (Condition, alarm, or event occurred at the
near end of the system.)
- FEND: Far End (Condition, Alarm, or event occurred at the far
end of the system.)

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies all applicable directions including TDTC, TDTN
TDTN and NA.
RCV - TDTC specifies Transmit direction toward Customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected. Applies to TCA only (for example, condition types
starting with T-xxx).
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

Page 30-282 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example 1
This command sets the notification code to MJ for all equipment using alarm profile 5 with a MEA condition type and
a service affecting code of NSA:

ED-ALMPF-EQPT:CORIANT1:ALMPF-5:AM0045::MJ,MEA,NSA,,;

Possible System Response

CORIANT1 02-04-16 02:08:15

M AM0045 COMPLD

Example 2
This command sets the notification code to MN for ROUTER entity using alarm profile 1 with a CABL_LOS-NEXT
condition type and a service affecting code of NSA:

ED-ALMPF-ROUTER:CORIANT1:ALMPF-1:AM0045::MN,CABL_LOS-NEXT,NSA,,;

Possible System Response

CORIANT1 02-04-16 02:08:15

M AM0045 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ALMPF-{X}

76.MTFP50/30, Rev B January 2018 Page 30-283

13. Edit Commands TL1 Command Reference Manual

ED-BL

Command Changes Since Previous Feature Package

• None.

Description
The ED-BL command instructs the network element (NE) to edit a bundled link.

Restrictions and Exceptions

• BL must be OOS before NIFINDEX can be modified.

• NIFINDEX cannot be modified when there is a call on the TL.

• When a BL is manually taken out-of-service, existing calls are not affected and no new calls are allowed
on the BL.

• If the optional parameters are not specified, the default value is no change to the current value.

• For an inter domain BL, NIFINDEX and OSPFRP entity (ABSTRACTNODE type) must be set before
BL can be put into IS.

• When LATENCYMODE is DISABLED, LATENCY is not required as an input to ED-BL.

• LATENCY parameter is valid for provisioning only if LATENCYMODE is set to MANUAL.

• If LATENCY parameter value is not supplied when LATENCYMODE is set to MANUAL, it is populated
with the default value.

Command Format
ED-
BL:[tid]:<bl_aid>:ctag:::[BLNAME=<BLName>][,COST=<Cost>][,NIFINDEX=<NeighborIfIn
dex>][,SRLG=<Srlg>][,LATENCYMODE=<LatencyMode>][,LATENCY=<Latency>][,RESCLASS=<R
esourceClass>]:[<editablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.3 ED-BL Parameters

Parameter Value(s) Definition
bl_aid BL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-BLID

BLName A double quoted string consisting of 0 Specifies the Bundled Link name.
to 30 printable characters, not
including the quotes.

Cost [1-4294967295] Specifies the cost for the link.

Page 30-284 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.3 ED-BL Parameters (Continued)

Parameter Value(s) Definition
NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

Srlg A double quoted input string of up to Specifies the Shared Risk Link Groups associated with this BL.
32 comma separated 4 byte hex
strings. Example:
"3E04990A,044D1A0C"

LatencyMode MANUAL Specifies the latency mode for this BL.

DISABLED MANUAL - the latency value is manually provisioned.
DISABLED - the latency parameter is not populated.

Latency [1-65535] Specifies the latency across this BL in Micro-Second.

Default is based on average fiber latency of 5 microseconds (us)
per kilometer and a distance of 40 km per segment between two
NEs.

ResourceClas A double quoted 4 byte hex strings. 32-bit long bit-mapped field with each bit representing a specific
s resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example bit-mapped resource class definitions:

"00000000" - None, used to reset to the default value ""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

editablePrimar IS Specifies the primary state of the entity.

yState OOS Two states are possible: In-Service (IS) and Out-of-Service
(OOS).

Example
ED-BL::BL-3-1-1:AM0011:::COST=100;

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-BL
DLT-BL
RTRV-BL

76.MTFP50/30, Rev B January 2018 Page 30-285

13. Edit Commands TL1 Command Reference Manual

ED-BL-MEMBER

Command Changes Since Previous Feature Package

• None.

Description
The ED-BL-MEMBER command instructs the network element (NE) to add/delete link member(s) to/from the
specified BL group.

1. When adding a TL into a PROT type BL, the TL has the neighbor information (Neighbor Node Id, Neighbor
Signaling Address, Neighbor Signaling Id). The neighbor information are either provisioned manually or discovered
automatically by neighbor discovery feature. For a TL which enabled neighbor discovery, the TL can still be added
into BL if the neighbor information was manually provisioned.

2. There are parameters between TL members and BL need to be matched:

(a) Attributes matching between BL and first TL member:
Since BL forms a logical group for a set of TLs. A BL and its member need to have the same traffic engineering
metric. When a TL member is firstly added into a BL, CP ensures these attributes are matched:
- BL and its TL member must be from/to same Network Partition, same Node.

(b) Attributes matching between two TL members within a BL group:

- Link profile AID.
- Facilities of same signal type.
- Same router area ID.
- NE address type.
- Neighbor information (NNID, NSIGID, NSIGADDR).

(c) Attributes matching between BL and TL members on redistribution:

- child routing area (CRTAREAID).
- parent routing area (PRTAREAID).
- parent node (PLADDR).

3. TL1 command example for creating a PROT bundled link with two OTU2 TLs.
1). Create the first TL, TL as an inter-domain link has same routing areas as that of BL.
ENT-TL:NE01:TL-3-4-
1:ctag:::TLNAME="OTU2_NODE4_TO_NE2_NODE5_1",COST=5,RESCLASS="0000000F",NIFINDEX=0.132.32
.0,LINKPF=LINKPF-1,ROUTING=PASSIVE,LATENCY=1,LATENCYMODE=MANUAL,RESOURCE=OTU2-20-3-
2:OOS;
2). Create OSPFRP for the TL.
ENT-OSPFRP:NE01:OSPFRP-3-1-3-
1:ctag:::CRTAREAID=0.0.0.20,PRTAREAID=0.0.0.200,ENTTYP=ABSTRACTNODE,PLADDR=22.3.20.1,PLIFIN
DEX=246.132.128.0,CLADDR=21.3.246.1,CLIFINDEX=0.132.128.0;

3). Set the TL IS. Only when TL OSPFRP exists (step2), put inter-domain TL into IS.
ED-TL:NE01:TL-3-4-1:ctag::::IS;

4). Create the second TL, TL as an inter-domain link has same routing areas as that of BL.
ENT-TL:NE01:TL-3-4-
2:ctag:::TLNAME="OTU2_NODE4_TO_NE2_NODE5_2",NEADDRT=UNNUM,NDISCOVERY=DISABLED,NEPT
L=TL-3-1-1,COST=5,RESCLASS="0000000F",NIFINDEX=0.132.64.0,NNID=21.3.106.5,LINKPF=LINKPF-
1,NSIGADDR=10.3.106.1,NSIGID=20.3.0.106,ROUTING=PASSIVE,SIGNALING=ENABLED,RAID=0.0.0.200,LA
TENCY=1,LATENCYMODE=MANUAL,RESOURCE=OTU2-20-3-4:OOS;

Page 30-286 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

5). Create OSPFRP for the TL.

ENT-OSPFRP:NE01:OSPFRP-3-1-3-
2:ctag:::CRTAREAID=0.0.0.20,PRTAREAID=0.0.0.200,ENTTYP=ABSTRACTNODE,PLADDR=22.3.20.1,PLIFIN
DEX=246.132.128.0,CLADDR=21.3.246.1,CLIFINDEX=0.132.160.0;

6). Set the TL IS. Only when TL OSPFRP exists (step5), put inter-domain TL into IS.
ED-TL:NE01:TL-3-4-2:ctag::::IS;

7). Create BL with empty.

ENT-BL:NE01:BL-3-4-
1:ctag:::BLNAME="NODE4_TO_NE2_NODE5_BL",BLTYPE=PROT,COST=15,NIFINDEX=144.0.128.163,ROUTI
NG=PASSIVE;

8). Create OSPFRP for the BL.

ENT-OSPFRP:NE01:OSPFRP-3-1-3-
3:ctag:::CRTAREAID=0.0.0.20,PRTAREAID=0.0.0.200,ENTTYP=ABSTRACTNODE,PLADDR=22.3.20.1,PLIFIN
DEX=246.0.128.131,CLADDR=21.3.246.1,CLIFINDEX=144.0.128.131;

9). Add the TLs into the BL, the key attributes (mentioned above in description) of a given member TL must
consistent with the BL.
ED-BL-MEMBER:NE01:BL-3-4-1:ctag:::ADDMEM=TL-3-4-2&TL-3-4-1;

Restriction and Exceptions

• Either ADDMEM or RMVMEM must be specified.

• BL must exist before adding memebers.

• TLs and BL must be from the same node and same partition.

• Up to 2 TLs can be added to a BL.

• The two TLs must have the matching signal type.

• The two TLs must have the matching NE address type (that is, numbered, unnumbered).

• The two TLs must have matching NEPTL, RAID.

• The two TLs must have matching neighbor information(NNID, NSIGID, NSIGADDR).

• The two TLs must have matching link profile AID.

• For adding TL members of a PROT type BL, the GMPLS mode of the link profile referenced by the TL
must be E-NNI mode.

• For adding TL members of a SYMPROT type BL, the GMPLS mode of the link profile referenced by the
TL must be NULL mode.

• The TLs must be from an ODU flexible switching module (for example, OSM-1S, OSM-2S and so on).
For the TL members to be added into a SYMPROT type BL, the client to ODUk/j/flex facility mapping
can be proceeded before or after the ODUk/j/flex TL was provisioned. Any FFP (for example, Y-Cable
FFP) provisioning on the client facilities is denied if this ODUk/j TL was provisioned.

• The TL in the ADDMEM must not have calls.

• TL cannot be removed from BL when there is a call on the TL.

• ABSTRACTNODE type OSPFRP must exist on PROT BL, before TLs can be added.

• ABSTRACTNODE type OSPFRP must exist on TL member(s) to be added into a PROT BL.

76.MTFP50/30, Rev B January 2018 Page 30-287

13. Edit Commands TL1 Command Reference Manual

• TL members must have matching CRTAREAID, PRTAREAID and PLADDR as the BL on the OSPFRP
entity (ABSTRACTNODE type).

• The total characters specified by ADDMEM or RMVMEM cannot exceed 1024 chars.

• When a BL has only one member added, the BL state should be operational OOS with a secondary
state of INCOMP.

• When one TL member of a BL is operational OOS, another TL member is operational IS, the BL state
should be operational IS-ANR, with secondary state as SDEA.

• When one TL member of a BL is operational OOS, another TL member is operational IS, and BL is
administrative OOS, the BL state should be OOS-MAANR, with secondary state as SDEA.

• When both TL members of a BL are operational OOS, the BL state should be operational OOS, with
secondary state as FAF.

Command Format
ED-BL-MEMBER:[tid]:<bl_aid>:ctag:::[,ADDMEM=<Member>][,RMVMEM=<Member>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.4 ED-BL-MEMBER Parameters

Parameter Value(s) Definition
bl_aid BL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-BLID

Member A list of up to 2 TLs. Link members are Specifies the link members to be added/removed to the BL.
separated by a symbol "&", a link This parameter uses the grouping operator "&" for multiple link
member is specified by the AID of TL. members.

For example; To add/remove the TLs TL-3-2-1 and TL-3-2-5 to a

bundled link, enter:
ADDMEM=TL-3-2-1&TL-3-2-5
or
RMVMEM=TL-3-2-1&TL-3-2-5

Example
ED-BL-MEMBER::BL-3-2-1:AM0011:::RMVMEM=TL-3-2-1&TL-3-2-5;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Page 30-288 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-BL
ENT-BL
DLT-BL
RTRV-BL
RTRV-BL-MEMBER

76.MTFP50/30, Rev B January 2018 Page 30-289

13. Edit Commands TL1 Command Reference Manual

ED-CALL

Command Changes Since Previous Feature Package

• Updated SLPF General Parameter Table.

• Support Callname up to 100 characters.

Description
The ED-CALL command instructs the NE Control Plane to change call name or modify an existing call at the call
source/origination node for the following applications:
• Bandwidth Modification

• Preferred Restoration Path Assignment

For the 2-port call, ED-CALL is only used for Preferred Restoration Path Assignment.

Bandwidth Modification
The ED-CALL command instructs the NE Control Plane to modify Control Plane Call at the originating point. This
command is only relevant for the NE serving as a call end-point.

Figure 13.1 MT=1 call before grow

NE NE NE

Call Call
end-point end-point

Figure 13.2 MT=1 call grown to MT=3

NE NE NE

Call Call
end-point end-point

The ED-CALL command has two optional formats when a call is bandwidth modified (grow/degrow):
• (1) Grow/degrow the call with MT value (MULTIPLIER).

• (2) Grow/degrow the call with MT value (MULTIPLIER) and specific labels (by referencing MAN mode
LABELSET).

The MT value is in the legal range (refer to restriction section for details) for grow/degrow cases and can grow/
degrow by more than one (E.g grow from MT=3 to MT=4 or MT=6, or degrow from MT=5 to MT=4 or MT=1).

Page 30-290 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Format (1) is supported by:

• The MT>1 call which has referred to an AUTO label set (at source node). (Grow case: CP picks and
add the label(s) to the bottom of original AUTO label set for the source/intermediate/termination node.
Degrow case: CP eliminates the label(s) from the bottom of original AUTO label set for the source/
intermediate/termination node.)

• The MT=1 call which was provisioned without providing the label for both ingress and egress. (Grow
case: the original label picked for MT=1 together with newly picked labels is populated to an AUTO label
set generated by CP.)

Format (2) is supported by:

• The MT>1 call which has referred to an MAN label set (at source node). (The call that provisioned with
MAN label set changes to use the new label set created by ENT-LABELSET when the call is grown/
degrown. In case an MT>1 call was provisioned by referencing a MAN mode partial label set that only
has either ingress or egress labels, the labels populated by CP in original label set is re-populated to
the new label set after the call has been grown, and the labels populated by CP in original label set is
reset to "" after the call has been grown/degrown.)

The ingress or egress label in relative position is grown/degrown together as a connection pair for source/
intermediate/termination nodes. This is independent of whether the label is specified by a user or picked by CP, and
independent of whether the original label set is in AUTO or MAN mode.

Bandwidth modification is not a hitless operation when used with the SSM-2S module.

Preferred Restoration Path Assignment

The ED-CALL command instructs the NE Control Plane to add, change or remove a preferred restoration path for
a specific connection of the call. The system supports different preference orders of the preferred restoration paths
associated to a connection path. The highly preferred Restoration Path is shown as WKGPRP1 (or PROTPRP1),
and the lowly preferred restoration path is shown as WKGPRP2 (or PROTPRP2).

All preferred restoration path(s) is set to NONE by system when call is serviced modified from REROUTE to
UNPROTECT (or FULLTIME to 1P1TWOSTRIKES) or from CP reversion AUTO/MAN to NO.

Service Modification
The ED-CALL command instructs the NE Control Plane at the call origination (source) node to modify the
parameters associated with an existing call by assigning a new Service Level ProFile (SLPF) Access IDentifier (AID)
to the existing call. The newly assigned SLPF has at least one or more modifiable value(s) that are different from
the current SLPF assigned to the existing call.

With the Service Modification feature, an existing call can transition to a different service protection level. For
example, an existing call currently assigned to an SLPF with PROTLVL set to UNPROTECT can use the ED-CALL
command to assign a different SLPF AID to the existing unprotect call. The newly assigned SLPF may have
PROTLVL set to REROUTE. Upon successful completion of the service modification request, the unprotect call
transitions to a call with dynamic reroute service.

An existing dynamic reroute or full time call can also transition between CP Reversion configurations.For example,
an existing dynamic reroute call currently assigned to an SLPF with CPREVERSION set to NO can use the ED-
CALL command to assign a different SLPF AID to the existing dynamic reroute call. The newly assigned SLPF may
have CPREVERSION set to AUTO. Upon successful completion of the service modification request, the dynamic
reroute call without the CP Reversion feature transitions to a dynamic reroute call with the CP Reversion feature
that automatically reverts the dynamic reroute call upon repair of the failures along the nominal working path.

Service modification applies to both existing SONET/SDH calls and existing OTN calls whose connections have
been established using the shared explicit reservation style. The existing call can be established through a single
domain network or though multi-domain networks, where the origination (source) node is Coriant equipment.

76.MTFP50/30, Rev B January 2018 Page 30-291

13. Edit Commands TL1 Command Reference Manual

Service Modification of SLPF General Parameters

The following table lists if an ED-CALL request for service modification of an existing call is allowed or denied when
the parameter value on the existing SLPF is different than the parameter value in the newly assign SLPF, regardless
of the existing protection level or service modified protection level of the call.

Table 13.5 Service Modification of SLPF General Parameters

SLPF Keyword Allow/Deny
COROUTING Deny

TRANSLINEMSDCC Deny

TRANSSECTIONRSDCC Deny

TRANSOTUGCC0 Deny

TRANSODUGCC12 Deny

PRIO Deny

RESCLASS Deny

LATENCY Deny

RESVSTYLE Deny

PROFNAME Allow

RRTCALLSETUP Allow

RRTMAXREROUTE Allow

RRTBOFFIVAL Deny

RRTBDRYREROUTE Allow

RRTETOEREROUTE Allow

RESCONNA Allow

RESCONNB Allow

CPREVERSION Allow

CPWTR Allow

DIVERSITYCHECK Allow

PROTLVL Allow

DIVERSITY Allowa

REVERSION Allowb

WTR Allowb

Notes:
a) Allowed for specific scenarios. See section
'Service Modification of SLPF DIVERSITY
Parameter' for scenarios where this parameter
can be modified.
b) Allowed for specific scenarios. See section
'Service Modification of SLPF REVERSION and
WTR Parameter' for scenarios where these
parameters can be modified.

Page 30-292 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Service Modification of SLPF PROTLVL Parameter

The following table lists if an ED-CALL request for service modification of an existing call is allowed (X) or denied
(shaded) when the PROTLVL parameter value on the existing SLPF (table row) is modified to the PROTLVL
parameter value on the newly assigned SLPF (table column). If the existing call was entered at the origination
(source) node with the SLPF PROTLVL value set to DONOTOVERRIDE, then the call was set up with the protection
level set to UNPROTECT.
Table 13.6 Service Modification of SLPF PROTLVL Parameter

PROTLVL TO
FROM UNPROTECT REROUTE 1P1TWOSTRIKES FULLTIME 2PORT 2PORTREROUTE

UNPROTECT X X X

REROUTE X X X

1P1TWOSTRIKES X X X X

FULLTIME X X

2PORT X

2PORTREROUTE X

Service Modification of SLPF DIVERSITY Parameter

The following table lists if an ED-CALL request for service modification of an existing call is allowed (X) or denied
(shaded) when:
• the SLPF DIVERSITY parameter value on the existing SLPF is set to SRLG and the DIVERSITY
parameter value on the newly assigned SLPF is set to LINK; or

• the SLPF DIVERSITY parameter value on the existing SLPF is set to SRLG and the DIVERSITY
parameter value on the newly assigned SLPF is set to DONOTOVERRIDE; or

• the SLPF DIVERSITY parameter value on the existing SLPF is set to LINK and the DIVERSITY
parameter value on the newly assigned SLPF is set to SRLG; or

• the SLPF DIVERSITY parameter value on the existing SLPF is set to DONOTOVERRIDE and the
DIVERSITY parameter value on the newly assigned SLPF is set to SRLG.

Table 13.7 Service Modification of SLPF DIVERSITY Parameter

TO 1P1TWOSTRI 2POR- DONOTOVER

FROM UNPROTECT REROUTE KES FULLTIME 2PORT TREROUTE RIDE

UNPROTECT X X X X

REROUTE X X X X

1P1TWOSTRI X X X
KES

FULLTIME

2PORT X

2PORTRERO X
UTE

DONOTOVER X X X X
RIDE

Restrictions are based upon the protection level of the existing call and the protection level setting in the newly
assigned SLPF for the modified call. If the existing call was entered at the origination (source) node with the SLPF
DIVERSITY value set to DONOTOVERRIDE, then the call was initially set up with the diversity set to LINK.

76.MTFP50/30, Rev B January 2018 Page 30-293

13. Edit Commands TL1 Command Reference Manual

A service modification request, where the existing SLPF DIVERSITY parameter is set to LINK and newly assigned
SLPF DIVERSITY parameter is set to DONOTOVERRIDE, is allowed regardless of the protection level of the call.
A service modification request, where the existing SLPF DIVERSITY parameter is set to DONOTOVERRIDE and
newly assigned SLPF DIVERSITY parameter is set to LINK, is allowed regardless of the protection level of the call.

Service Modification of SLPF REVERSION and WTR Parameters

The REVERSION parameter and the WTR parameter are ignored when the PROTLVL parameter value is set to
UNPROTECT, REROUTE or DONOTOVERRIDE in the SLPF. The following table lists if an ED-CALL request for
service modification of an existing call is allowed (X) or denied (shaded) when:
• the REVERSION parameter value on the existing SLPF is set to NO and the REVERSION parameter
value on the newly assigned SLPF is set to YES;

• the REVERSION parameter value on the existing SLPF is set to DONOTOVERRIDE and the
REVERSION parameter value on the newly assigned SLPF is set to YES;

• the REVERSION parameter value on the existing SLPF is set to YES and the REVERSION parameter
value on the newly assigned SLPF is set to NO; or

• the REVERSION parameter value on the existing SLPF is set to YES and the REVERSION parameter
value on the newly assigned SLPF is set to DONOTOVERRIDE; or

• the WTR parameter value on the existing SLPF is set to a values that differs from the WTR parameter
value on the newly assigned SLPF.

Table 13.8 Service Modification of SLPF REVERSION and WTR Parameters

PROTLVL TO
FROM UNPROTECT REROUTE 1P1TWOSTRIKES FULLTIME 2PORT 2PORTREROUTE

UNPROTECT X X X

REROUTE X X X

1P1TWOSTRIKES X X X X

FULLTIME X X

2PORT X

2PORTREROUTE X

Also note that:

• The ED-CALL accepts the REVERSION and WTR parameter according to the allowable PROTLVL
transition. However, the REVERSION parameter and the WTR parameter are ignored when the new
PROTLVL parameter value is set to UNPROTECT, REROUTE, 2PORT, 2PORTREROUTE or
DONOTOVERRIDE in the SLPF, and is only applicable for 1P1TWOSTRIKES and FULLTIME.

• A service modification request, where the existing SLPF REVERSION parameter is set to NO and newly
assigned SLPF REVERSION parameter is set to DONOTOVERRIDE, is allowed regardless of the
protection level of the existing or modified call.

• A service modification request, where the existing SLPF REVERSION parameter is set to
DONOTOVERRIDE and newly assigned SLPF REVERSION parameter is set to NO, is allowed
regardless of the protection level of the existing or modified call.

• A service modification request, where the existing SLPF REVERSION parameter is set to YES and
newly assigned SLPF REVERSION parameter is set to YES, is allowed regardless of the protection
level of the existing or modified call.

Restrictions and Exceptions

• The command of bandwidth modification can only be performed at call source/origination node.

Page 30-294 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

• The command of bandwidth modification can only be allowed when the reservation style of the call
connection is shared explicit.

• The command of preferred restoration path assignment can only be performed at repair nodes
(origination node or domain ingress nodes of the call).

• The value of MULTIPLIER must be greater than the existing value but not bigger than 32 for growing
call case.

• The value of MULTIPLIER must be less than the existing value but bigger than or equal to 1 for
degrowing call case.

• The command is denied if the value of MULTIPLIER is equal to the existing value of the call.

• LABELSET is only allowed when MULTIPLIER is present/entered in the command.

• An attempt to grow/degrow a call by specifying only MULTIPLIER is denied if the call has referred to a
MAN label set.

• An attempt to grow an MT=1 call by specifying MULTIPLIER and LABELSET is denied if the call has
not referred to a MAN label set.

• An attempt to grow/degrow a call by specifying MULTIPLIER and LABELSET is denied if the call has
referred to an AUTO label set.

• An attempt to grow/degrow a call by specifying LABELSET which is AUTO mode is denied.

• An attempt to grow a call is denied if the SET_INGRSS or SET_EGRSS of the new label set (specified
by LABELSET) does not match the value of the original label set.

• An attempt to grow a call from MT=m to MT=n (m<n) is denied if the first m labels in original and new
label set do no match.

• An attempt to degrow a call from MT=n to MT=m (m<n) is denied if the labels in new label set do not
present in original label set or not in the same relative orders as they were in original label set.

• An attempt to assign WKGPRP1/WKGPRP2 to values other than NONE is denied if PROTLVL of the
call is set to 1P1TWOSTRIKES/UNPROTECT or CPREVERSION of the call is set to NO.

• An attempt to assign PROTPRP1/PROTPRP2 to values other than NONE is denied if PROTLVL of the
call is set to 1P1TWOSTRIKES/UNPROTECT/REROUTE or CPREVERSION of the call is set to NO.

• Multiple preferred restoration paths (WKGPRP1, WKGPRP2, PROTPRP1 and PROTPRP2) can be
changed in a single ED-CALL command.

• The request for preferred restoration path assignment is denied if the EXPPATH AID doesn't exist.

• The request to assign the same EXPPATH AID to WKGPRP1 and WKGPRP2 is denied.

• The request to assign the same EXPPATH AID to PROTPRP1 and PROTPRP2 is denied.

• The same EXPPATH AID can be assigned to the preferred restoration paths for the working connection
and for the protect connection.

• The request for bandwidth modification and/or preferred restoration path assignment is denied if the
result call has MT value greater than one and any preferred restoration path containing label info.

• MULTIPLIER and SLPF are mutually exclusive.

• LABELSET and SLPF are mutually exclusive.

• PROTLVL set to UNPROTECT, 1P1TWOSTRIKES or DONOTOVERRIDE on the newly assigned

SLPF when WKGPRP1, WKGPRP2, PROTPRP1 or PROTPRP2 are specified but not set to NONE is
denied.

76.MTFP50/30, Rev B January 2018 Page 30-295

13. Edit Commands TL1 Command Reference Manual

• If CPREVERSION is set to NO or PROTLVL is set to UNPROTECT, 1P1TWOSTRIKES or

DONOTOVERRIDE on the newly assigned SLPF when WKGPRP1, WKGPRP2, PROTPRP1 or
PROTPRP2 are not specified, then WKGPRP1, WKGPRP2, PROTPRP1 or PROTPRP2 is reset to
NONE.

• Simultaneous request for service modification and OPR-CPSW REVERT or MKPERM is denied.

• RETAINPATH is applicable only to existing 1+1 single domain calls when the new SLPF PROTLVL is
set to UNPROTECT, DONOTOVERRIDE, or REROUTE. RETAINPATH set to WRK or PROT is denied
for all other cases.

• ED-CALL with modified timeout value can only be performed on the source/origination node.

• ED-CALL with modified call name can only be performed on the source/origination node.

• The attempt to modify MULTIPLIER or LABELSET is denied if PROTLVL of the call is 2PORT or
2PORTREROUTE.

• The attempt to assign WKGPRP1/WKGPRP2/PROTPRP1/PROTPRP2 to values other than NONE is

denied if PROTLVL of the call is set to 2PORT.

Command Format
ED-
CALL:[tid]::ctag:::CALLID=<CallId>[,CALLNAME=<Callname>],NODE=<node_aid>[,MULTIP
LIER=<MultiplierValue>][,LABELSET=<Labelset_aid>][,SLPF=<slpf_aid>][,RETAINPATH=
<RetainPath>][,WKGPRP1={<expp_aid>|NONE}][,WKGPRP2={<expp_aid>|NONE}][,PROTPRP1=
{<expp_aid>|NONE}][,PROTPRP2={<expp_aid>|NONE}];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.9 ED-CALL Parameters

Parameter Value(s) Definition
CallId Up to a 55 character string in the Required if Diversity is specified as anything other than NONE.
following format: [CNTRY-CAR-AP-
]TYPE-ADDRESS-ID. (1)CNTRY - This parameter represents an existing call. The first three parts
country code (3 alphabetic characters) are optional. If present the CallId is in the global format. If they
(2)CAR - carrier code (1 to 6 are not present the call is in the carrier specific format.
alphanumeric characters. The first
character must be alphabetic) (3)AP - Examples:
access point (1 to 6 alphanumeric Global format - "USA-CAR1-ATT01E-IPV4-192.168.1.1-1895B"
characters. The first character must be Carrier specific format - "IPV4-192.168.1.1-1895B"
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

Callname A double quoted string consisting of 0 Specifies the call name.

to 100 printable characters, not
including the quotes. Refer to section 2 for the applicable characters.

Page 30-296 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.9 ED-CALL Parameters (Continued)

Parameter Value(s) Definition
node_aid NODE-[1,3]-[1-512] Specifies the node access identifier.

MultiplierValue [1-32] This parameter is used to indicate the number of channels of

SignalType used in the call.

Labelset_aid LABELSET-3-[d] This parameter specifies the access identifier of the new label
set that contains the labels for the purpose of call modification.

slpf_aid SLPF-[99,1-20] During service modification, this parameter identifies one of

twenty (20) NE pre-defined service level profiles to be assigned
to the specified call.

A single service level profile can service multiple service level

code-points.

RetainPath WKG During service modification of an existing 1+1 call to an

PROT unprotect or dynamic reroute call, this parameter specifies the
following regardless of any failures along the path:
WKG - During service modification, the nominal working
connection of the unprotect or dynamic reroute call is
established over the current working path of the 1+1 call.
PROT - During service modification, the nominal working
connection of the unprotect or dynamic reroute call is
established over the current protect path of the 1+1 call.

Default is:
- WKG if a failure does not exist along the current working path
of the 1+1 call.
- WKG if a failure exists along both the current working path and
the current protect path of the 1+1 call.
- PROT if a failure exists along the current working path of the
1+1 call and a failure does not exist along the current protect
path of the 1+1 call.

For an MT>1 call, the above rules apply regardless of the

number of failures along the working or protect paths.

expp_aid EXPPATH-[1,3]-[1-512] Specifies the access identifier of the explicit path being refered
for a Preferred Restoration Path.

Example
Grow a call from MT=2 to MT=3 (the MT=2 call has referred to an AUTO label set):
ED-CALL:CORIANT1:AM0011:::CALLID="IPV4-1.1.1.1-A1B2C3D4",NODE=NODE-3-
1,MULTIPLIER=3;

Example
Grow a call from MT=1 to MT=3 (the MT=1 call has referred to a LABELSET-3-1, LABELSET-3-2 has been created
by seeding with LABELSET-3-1 by using ENT-LABELSET command):
ED-CALL:CORIANT1:AM0011:::CALLID="IPV4-1.1.1.1-A1B2C3D4",NODE=NODE-3-
1,MULTIPLIER=3,LABELSET=LABELSET-3-2;

Add a preferred restoration path to the working connection of a call with the preference order of low:
ED-CALL:CORIANT1:AM0011:::CALLID="IPV4-1.1.1.1-A1B2C3D4",NODE=NODE-3-
1,WKGPRP2=EXPPATH-3-2;

76.MTFP50/30, Rev B January 2018 Page 30-297

13. Edit Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CALL
ENT-CALL
RTRV-CALL

Page 30-298 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-CPPF

Command Changes Since Previous Feature Package

• Added OPE option for TRANSNET Optical Path Algorithm.

Description
The ED-CPPF command instructs the network element (NE) to edit a protocol profile. The protocol profile is
referenced from the OSPF Area entity.
In networks with mTera UTP network elements connected to 7100 OTS and 7100 Nano network elements, set the
Optical Path Algorithm (OPTPATHALG) to DISCRETE. In networks with mTera UTP network elements connected
to hiT7300 network elements, set the OPTPATHALG to PMETRIC or OPE.

This command is used to change the Optical Path Algorithm (OPTPATHALG) used by a control plane profile (CPPF)
and thus any TL/TSL referencing the CPPF. When the OPTPATHALG is configured to DISCRETE, the TL or TSL
transitions to INCOMP if the PMD, OSNR, PDL (TL and TSL); and FWMP, RCD, SPMN, XPMN (TL only)
parameters are not available on the TL/TSL. If the OPTPATHALG is configured to OPE, the TL or TSL transitions
to INCOMP if the optical impairment information for the TL/TSL is not included in the OPE file currently installed on
the network element.

Restrictions and Exceptions

• Protocol Profiles 1-20 are editable.

• String parameters must be used in quotes.

• This command is denied if any this profile is referenced from an OSPF area entity and the modification
is not limited to changing GMPLSMODE between INNI-V1, INNI-V2 or INNI-V1PV2 or between ENNI-
V1, ENNI-V2 or ENNI-V1PV2.

• OPTPATHALG may not be configured to OPE if GMPLSMODE for the profile is not INNI-V2.

• LSARMAXFP is not applicable if GMPLSMODE is set to NONE.

• CAPACITYADV is not applicable if GMPLSMODE is set to NONE.

Command Format
ED-
CPPF:[tid]:<cppf_aid>:ctag:::[PFNAME=<ProfileName>][,GMPLSMODE=<GMPLSMode>][,LSA
RMAXFP=<LSARefreshMaxPeriod>][,CAPACITYADV=<CapacityAdvertisement>][,OPTPATHALG=
<OptPathAlg>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.10 ED-CPPF Parameters

Parameter Value(s) Definition
cppf_aid CPPF-[94-99,1-20] EntityID-CPPFID

76.MTFP50/30, Rev B January 2018 Page 30-299

13. Edit Commands TL1 Command Reference Manual

Table 13.10 ED-CPPF Parameters (Continued)

Parameter Value(s) Definition
ProfileName 0 to 31 alphanumeric characters. Specifies the Node name.
Refer to section 2 for the applicable characters.

GMPLSMode OIF-ENNI-V1 Specifies the GMPLS mode.

OIF-ENNI-V2
OIF-ENNI-V1PV2
INNI-V1
INNI-V2
INNI-V1PV2
NONE

LSARefreshM [1-65535] Specifies the LSA refresh period in seconds.

axPeriod

CapacityAdver AVAIL Specifies the forms of link capacity to advertise in the local
tisement AVAIL&FAILED routing area. The Link State Advertisement message is sent to
advertise available capacity or to advertise available and failed
capacity.

AVAIL - The Link State Advertisement is sent to advertise

unused capacity on available links.

AVAIL&FAILED - The Link State Advertisement is sent

separately advertising unused capacity on available links and
unused capacity on failed links.

Available links are administratively in-service and operationally

in-service.
Failed links are:
- administratively in-service and operationally out-of-service;
- administratively out-of-service and operationally in-service; or
- administratively out-of-service and operationally out-of-service.

OptPathAlg Possible values are: Specifies the CP routing algorithm uses the discrete optical
DISCRETE impairment parameters or the PMetric information to compute
PMETRIC the path.
OPE
DISCRETE: Use the discrete optical impairment parameters
that are populated via the ENT-TL command for route
computation. These parameters include PMD, OSNR, FWMP,
PDL, RCD, SPMN and XMMN.

PMETRIC: Use PMetric OMS-based figures of merit information

for route computation.

OPE: Use TRANSNET OPE algorithm for route computation.

Requires OPE data files to be loaded on the network element.

Example
The following example modifies the capacity advertisement parameter to separately
advertise unused capacity on available links and unused capacity on failed links
when sending the Link State Advertisement message.

ED-CPPF::CPPF-9:AM0011:::LSARMAXFP=2000,CAPACITYADV=AVAIL&FAILED;

Page 30-300 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Posible System Response

CORIANT1 11-05-15 02:08:15
M AM0011 COMPLD
;

Default Protocol Profiles

Table 13.11 Protocol Profile (CPPF-94)

Attribute Value
Profile Name NNI V2

LSA Refresh Max Period 1800

GMPLS Mode INNI-V2

CAPACITYADV AVAIL&FAILED

OPTPATHALG DISCRETE

Table 13.12 Protocol Profile (CPPF-95)

Attribute Value
Profile Name NULL

LSA Refresh Max Period 1800

GMPLS Mode NONE

CAPACITYADV AVAIL&FAILED

OPTPATHALG DISCRETE

Table 13.13 Protocol Profile (CPPF-96)

Attribute Value
Profile Name INNI V1

LSA Refresh Max Period 1800

GMPLS Mode INNI-V1

CAPACITYADV AVAIL&FAILED

OPTPATHALG DISCRETE

Table 13.14 Protocol Profile (CPPF-97)

Attribute Value
Profile Name IPv4

LSA Refresh Max Period 1800

GMPLS Mode NONE

76.MTFP50/30, Rev B January 2018 Page 30-301

13. Edit Commands TL1 Command Reference Manual

Table 13.14 Protocol Profile (CPPF-97) (Continued)

Attribute Value
CAPACITYADV AVAIL&FAILED

OPTPATHALG DISCRETE

Table 13.15 Protocol Profile (CPPF-98)

Attribute Value
Profile Name OIF ENNI V2

LSA Refresh Max Period 1800

GMPLS Mode OIF-ENNI-V2

CAPACITYADV AVAIL&FAILED

OPTPATHALG DISCRETE

Table 13.16 Protocol Profile (CPPF-99)

Attribute Value
Profile Name OIF ENNI V1

LSA Refresh Max Period 1800

GMPLS Mode OIF-ENNI-V1

CAPACITYADV AVAIL&FAILED

OPTPATHALG DISCRETE

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-CPPF
ENT-OSPFAREA
RTRV-OSPFAREA

Page 30-302 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-CRS-OCH

Command Changes Since Previous Feature Package

• None

• Added support for OSM-4S, OSM-5C.

Description
The ED-CRS-OCH command instructs the network element (NE) to edit the circuit ID and GRP attributes of the
specified OCH cross connection between an OCH-L facility and an OCH-L/OCH-P/OCH-OS/OCH facility. Refer to
ENT-CRS-OCH command for a description of OCH cross-connections allowed.

Restrictions and Exceptions

• CCPATH parameter cannot be modified

• The first name-defined parameter after the ctag must not have its leading comma.

• Edition of the GRP parameter for a specific OCH CRS applies to all OCH CRS having the same GRP
value.

• An attempt to edit a cross connection is denied if one or both end-points are owned by Control Plane
unless CMDMDE=FRCD

Command Format
ED-CRS-
OCH:[tid]:<from_och>,<to_och>:ctag:::[,CKTID=<circuitIdentification>][,GRP=<grp>
][,CMDMDE=<commandMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.17 ED-CRS-OCH Parameters

Parameter Value(s) Definition
from_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

76.MTFP50/30, Rev B January 2018 Page 30-303

13. Edit Commands TL1 Command Reference Manual

Table 13.17 ED-CRS-OCH Parameters (Continued)

Parameter Value(s) Definition
to_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

circuitIdentifica One to 46 alphanumeric characters. Specifies the circuit ID of the channel being provisioned.
tion <space> character is not allowed in this parameter.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

grp One to 45 alphanumeric characters. Specifies the group ID of the cross-connection being
provisioned.

Refer to section 2 for the applicable characters.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
ED-CRS-OCH:MTERA1:OCH-L-20-1-21-7,OCH-P-20-4-
1:AM0074:::CKTID="BELL1",GRP="1X2356YZ";

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-OCH
ENT-CRS-OCH
RTRV-CRS-OCH

Page 30-304 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-CRS-ODUk

Command Changes Since Previous Feature Package

• Added support of ODUk mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S and OSM-5C.

• Updated to add support for the SRC_WKG and DEST_WKG parameters to support the ability to add
working legs to a crossconnect.

Description
• The ED-CRS-ODU0 commands allow editing properties of the ODU0 crossconnects supported by
OSM-2C/OSM-2S/OSM-1S/OSM-4C/OSM-4F/OSM-4S/OSM-5C modules.

• The ED-CRS-ODU1 and -ODU2 commands allow editing properties of the ODU1 or ODU2
crossconnects supported by OSM-2C/OSM-2S/OSM-1S/OSM-4C/OSM-4F/SSM-2S/OSM-4S/OSM-
5C modules.

• The ED-CRS-ODUF command allows editing properties of the ODUF crossconnects supported by
OSM-2C/OSM-2S/OSM-4C/OSM-4F/OSM-4S/OSM-5C modules.

• The ED-CRS-ODU2E commands allow editing properties of the ODU2E crossconnects supported by
OSM-2S/OSM-2C/OSM-4C/OSM-4F/OSM-4S/OSM-5C modules.

• The ED-CRS-ODU3 or -ODU4 commands allow editing properties of the ODU3 or ODU4
crossconnects supported by OSM-2C/OSM-4C/OSM-4F/OSM-5C modules.

The properties that can be modified are:

- Circuit ID
- Redline Status

The ED-CRS-ODUk command allows to change a protected crossconnect to an unprotected crossconnect and vice
versa. After a crossconnect is changed from protected cross-connect to an unprotected cross-connect, its protection
related parameters are no longer displayed in the RTRV-CRS-ODUk response. However, one DB change
notification should be generated to reflect the protected crossconnect is deleted and another DB change notification
should be generate to reflect an unprotected crossconnect is created.

Restrictions and Exceptions

• The FROM and TO terminations must be of type specified in command, and a cross-connection
between them must exist.

• Neither of the ODUk facilities associated with the cross-connection can be modified.

• A crossconnect identified as red-lined cannot be to be modified unless the operation is confirmed by

specifying INCL=YES.

• An attempt to edit a cross connection is denied if one or both end-points are owned by Control Plane.

• The command must deny cross connection conversion between 1WAY and 2WAY.

• SRC_PROT or DEST_PROT can be used to add a protecting ODUk. Only one leg is allowed to be
added per command entry.

• SRC_WKG or DEST_WKG can be used to add a working ODUk. Only one leg is allowed to be added
per command entry.

• RMV_ODU can be provisioned to remove one ODUk of the protected cross connection.

76.MTFP50/30, Rev B January 2018 Page 30-305

13. Edit Commands TL1 Command Reference Manual

• RMV_ODU can be working ODUk or protecting ODUk.

• RMV_ODU cannot be an unprotected ODUk entity.

• The ODUk to be added must not be involved in an existing cross-connection.

• The ODUk to be added must be associated with a physical port if all other ODUk's in the cross
connection are associated with physical ports.

• If the ODUk entity to be removed from a cross connection is not in administrative out of service state,
the cross-connection conversion is rejected.

• The ODUk to be added as protection or working leg must be administrative out-of-service.

• The system denies an attempt to remove a working or protecting ODUk if an external switch command
for the associated PPG has not been released.

• Any ODUk of the cross connection to be changed must not be associated with any other cross
connection.

• An attempt to specify a value for DEST_PROT is denied when the CCT=1WAYPR. A 1WAYPR
connection has a working and protect source ODUk.

Command Format
ED-CRS-
ODUk:[tid]:<src_odu>,<dest_odu>:ctag:::[SRC_WKG=<src_wkg_odu>][,DEST_WKG=<dest_w
kg_odu>][,SRC_PROT=<src_prot_odu>][,DEST_PROT=<dest_prot_odu>][,CKTID=<circuitId
entification>][,RDLD=<red_lined>][INCL=<incl>][,SRC_PROTTYPE=<src_ProtectionType
>][,DEST_PROTTYPE=<dest_ProtectionType>][,RMV_ODU=<rmv_odu>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-306 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.18 ED-CRS-ODUk Parameters

Parameter Value(s) Definition
src_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-307

13. Edit Commands TL1 Command Reference Manual

Table 13.18 ED-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

Page 30-308 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.18 ED-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
src_wkg_odu ODUF-20-[1-16]-[1-40]-[1-80], Specifies the source working ODU
ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1-
32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

76.MTFP50/30, Rev B January 2018 Page 30-309

13. Edit Commands TL1 Command Reference Manual

Table 13.18 ED-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_wkg_odu ODUF-20-[1-16]-[1-40]-[1-80], Specifies the destination working ODU
ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1-
32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

Page 30-310 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.18 ED-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
src_prot_odu ODUF-20-[1-16]-[1-40]-[1-80], Specifies the ODU that is the crossconnection source. It is used
ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1- only when working and protected ODU have different ODU_IDs.
32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

76.MTFP50/30, Rev B January 2018 Page 30-311

13. Edit Commands TL1 Command Reference Manual

Table 13.18 ED-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_prot_odu ODUF-20-[1-16]-[1-40]-[1-80], Specifies the ODU that is the crossconnection destination. It is
ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1- used only when working and protected ODU have different
32], ODU_IDs.
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

circuitIdentifica One to 46 alphanumeric characters. Specifies the circuit ID of the channel being provisioned.
tion <space> character is not allowed in this parameter.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

red_lined YES Specifies if the circuit is to be red-lined or not.

NO If the circuit is red-lined (YES), then it cannot be modified or
deleted unless the INCL=YES parameter is specified in the ED/
DLT command.

incl YES Specifies whether or not the command should complete if the
NO specified circuit is red-lined. If YES is specified, then the
command completes no matter what the RDLD status is.

Page 30-312 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.18 ED-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
src_Protection SNCI Specifies the Protection Type (SNC/I or SNC/N) that is applied
Type SNCN to the SRC (source) side of the connection.
- SNCI: SubNetwork Connection protection with Inherent
monitoring. Only the server layer is monitored for protection
switching purposes.
- SNCN: SubNetwork Connection protection with Non-intrusive
monitoring. The end-to-end layer and the server layer are
monitored for protection switching purposes.

dest_Protectio SNCI Specifies the Protection Type (SNC/I or SNC/N) that is applied
nType SNCN to the DEST (destination) side of the connection.
- SNCI: SubNetwork Connection protection with Inherent
monitoring. Only the server layer is monitored for protection
switching purposes.
- SNCN: SubNetwork Connection protection with Non-intrusive
monitoring. The end-to-end layer and the server layer are
monitored for protection switching purposes.

rmv_odu ODUF-20-[1-16]-[1-40]-[1-80], AID of the ODUk of the protection path to be removed to change
ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1- protected to unprotected.
32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

Example 1
ED-CRS-ODU2:CORIANT1:ODU2-20-1-3-1,ODU2-20-1-5-3:MV0076:::CKTID="ILEC5";

76.MTFP50/30, Rev B January 2018 Page 30-313

13. Edit Commands TL1 Command Reference Manual

Example 2: Change from one protection only to unprotected by removing its protection
ODUk
ED-CRS-ODU2:CORIANT1:ODU2-20-2-1,ODU2-20-3-2:MV0076:::RMV_ODU=ODU2-20-3-1;

Example 3: Change from 2WAY to 2WAYPR

ED-CRS-ODU2:CORIANT1:ODU2-20-1-3-1,ODU2-20-1-5-3:MV0076:::SRC_WKG=ODU2-20-2-3-1;

Possible System Response

^^^CORIANT1 09-03-15 02:08:15

M MV0076 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-ODUk
ENT-CRS-ODUk
RTRV-CRS-ODUk

Page 30-314 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-CRS-STSn (STS1/3C/12C/48C/192C)

Command Changes Since Previous Feature Package

• Updated to add support for the SRC_WKG and DEST_WKG parameters to support the ability to add
working legs to a crossconnect.

Description
The ED-CRS-STSn command instructs the network element (NE) to edit the circuit ID attribute of the specified STSn
cross connection.

The ED-CRS-STSn command allows to change a protected crossconnect to an unprotected crossconnect and vice
versa. After a crossconnect is changed from protected cross-connect to an unprotected cross-connect, its protection
related parameters no longer appear in the RTRV-CRS-STSn response. However, one DB change notification
should be generated to reflect the protected crossconnect is deleted and another DB change notification should be
generate to reflect an unprotected crossconnect is created.

Refer to ENT-CRS-STSn command for typical provisioning scenarios.

Restrictions and Exceptions

• The FROM and TO terminations must be of type specified in command, and a cross-connection
between them must exist.

• Neither of the STS facilities associated with the cross-connection can be modified.

• A crossconnect identified as red-lined cannot be to be modified unless the operation is confirmed by

specifying INCL=YES.

• INCL=YES must be specified to edit any parameter if the cross-connect is owned by the control plane.

• SRC_PROT or DEST_PROT can be used to add a protecting STSn. Only one leg is allowed to be
added per command entry.

• SRC_WKG or DEST_WKG can be used to add a working STSn. Only one leg is allowed to be added
per command entry.

• RMV_FAC does not apply for a protected cross connection involved in 1+1 FFP or 1+1 EPG.

• RMV_FAC can be provisioned to remove one STSn of the protected cross connection.

• RMV_FAC can be working STSn or protecting STSn.

• RMV_FAC cannot be an unprotected STSn entity.

• The STSn to be added must not be involved in an existing cross-connection.

• If the STSn entity to be removed from a cross connection is not in administrative out of service state,
the cross-connection conversion is rejected.

• The STSn to be added as protection or working leg must be administrative out-of-service.

• The system denies an attempt to remove a working or protecting STSn if an external switch command
for the associated PPG has not been released.

• Any STSn of the cross connection to be changed must not be associated with any other cross
connection.

• An attempt to specify a value for DEST_PROT is denied when the CCT=1WAYPR. A 1WAYPR
connection has a working and protect source STSn.

76.MTFP50/30, Rev B January 2018 Page 30-315

13. Edit Commands TL1 Command Reference Manual

Command Format
ED-CRS-
STSn:[tid]:<from_stsn>,<to_stsn>:ctag:::[SRC_WKG=src_wkg_fac][,DEST_WKG=dest_wkg
_fac][,SRC_PROT=src_prot_fac][,DEST_PROT=dest_prot_fac][,CKTID=<circuitIdentific
ation>][,RDLD=<red_lined>][,INCL=<incl>][,RMV_FAC=rmv_fac];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.19 ED-CRS-STSn (STS1/3C/12C/48C/192C) Parameters

Parameter Value(s) Definition
from_stsn STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

to_stsn STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID

20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

circuitIdentifica One to 46 alphanumeric characters. Specifies the circuit ID of the channel being provisioned.
tion <space> character is not allowed in this parameter.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

Page 30-316 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.19 ED-CRS-STSn (STS1/3C/12C/48C/192C) Parameters (Continued)

Parameter Value(s) Definition
red_lined YES Specifies if the circuit is to be red-lined or not.
NO If the circuit is red-lined (YES), then it cannot be modified or
deleted unless the INCL=YES parameter is specified in the ED/
DLT command.

incl YES Specifies whether or not the command should complete if the
NO specified circuit is red-lined. If YES is specified, then the
command completes no matter what the RDLD status is.

src_prot_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STSn that is the protection STSn associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <src_stsn>. It it used to setup SNCP with CCT=1WAYPR/
STS3C-20-[1-16]-[1-30]-[190,- 2WAYPR.
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

dest_prot_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STSn that is the protection STSn associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <dest_stsn>. It it used to setup SNCP with CCT=1WAYPR/
STS3C-20-[1-16]-[1-30]-[190,- 2WAYPR.
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

76.MTFP50/30, Rev B January 2018 Page 30-317

13. Edit Commands TL1 Command Reference Manual

Table 13.19 ED-CRS-STSn (STS1/3C/12C/48C/192C) Parameters (Continued)

Parameter Value(s) Definition
rmv_fac STS1-20-[1-16]-[1-30]-[1-192], AID of the STSn of the protection path to be removed to change
STS1-20-[1-16]-99-[1-30]-[1-192], protected to unprotected.
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

src_wkg_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STSn that is the working STSn associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <src_stsn>.
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

dest_wkg_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STSn that is the working STSn associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <dest_stsn>.
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

Example 1
ED-CRS-STS1:CORIANT1:STS1-20-11-1-6,STS1-20-11-11-6:AM0074:::CKTID="NEW123";

Page 30-318 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example 2: Change from one protection only to unprotected by removing its protection
ED-CRS-STS1:CORIANT1:STS1-20-1-1-1,STS1-20-11-1-1-1:AM0074:::RMV_FAC=STS1-20-3-
1-1;

Example 3: Change from 2WAY to 2WAYPR

ED-CRS-STS1:CORIANT1:STS1-20-11-1-6,STS1-20-11-11-6:AM0074:::SRC_WKG=STS1-20-12-
1-6;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-STSn
ENT-CRS-STSn
RTRV-CRS-STSn

76.MTFP50/30, Rev B January 2018 Page 30-319

13. Edit Commands TL1 Command Reference Manual

ED-DA

Command Changes Since Previous Feature Package

• None.

Description
The ED-DA command instructs the network element (NE) to modify the Discovery Agent (DA).

The ED-DA command is limited to changing the Primary State.

Restrictions and Exceptions

None.

Command Format
ED-DA:[tid]:<DA_aid>:ctag::::[<editablePrimaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.20 ED-DA Parameters

Parameter Value(s) Definition
DA_aid DA-1 EntityID-DAID

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
ED-DA:CORIANT1:DA-1:AM0011::::OOS;

Possible System Response

^^^CORIANT1 06-05-15 02:09:11
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-320 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Related Commands
ENT-TL
DLT-DA
ENT-DA
RTRV-DA

76.MTFP50/30, Rev B January 2018 Page 30-321

13. Edit Commands TL1 Command Reference Manual

ED-DB

Command Changes Since Previous Feature Package

• None.

Description
The ED-DB command instructs the network element (NE) to edit the attributes of the network element database.
The only attribute of the database at the moment is the database state. The state of the database can be discovered
by using the command RTRV-DB.

Command Format
ED-DB:[tid]:[<db_aid>]:ctag:::[:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.21 ED-DB Parameters

Parameter Value(s) Definition
db_aid DB-1 EntityID-DBID

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
ED-DB:CORIANT1::AM0074::::OOS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-DB
RTRV-DB

Page 30-322 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-DHCP

Command Changes Since Previous Feature Package

• None

Description
The ED-DHCP command instructs the network element (NE) to edit the attributes of the DHCP server functionality
on PGNEs. It allows to enable or disable DHCP server function, edit the alarm profile, specify the minimum/
maximum IP address in the range of IP addresses that can be assigned to DHCP client (for example, PRNE), and
modify the state.

The ED-DHCP command also instructs the network element (NE) to edit the attributes of the DHCP client
functionality on PRNEs. It allows the edit of the alarm profile and modify the state. Refer to the ED-NET command
to enable/disable DHCP client.

The ED-DHCP command is also used for enabling/disabling the L2 DHCP Relay Option 82 on the Port-shelf with
Packet Subsystem.

The ED-DHCP command is also used for enabling/disabling the FlatIP DHCP Relay Agent function and setting the
DHCP Server IP address of the FlatIP DHCP Relay Agent. The FlatIP DHCP relay agent AID is DHCPRELAY-99.

Restrictions and Exceptions

• Enabling/disabling DHCP Server is only applicable to eontypes: PGNEs in configurations with SPM
controller module (HW3.x) or in configurations with SPM-N. DHCP Server should NOT be enabled on
a 7100 subnetwork with a mix of HW2.x and HW3.x systems or with a mix of HW2.x and 7100 Nano
systems.

• If node is a PGNE, then the default range of IP address can be automatically provided based on NE
type. The default range can be modified.

• The range of DHCPSERVER IP addresses cannot encapsulate addresses: 224-255.xxx.xxx.xxx,

169.254.xxx.xxx, 127.xxx.xxx.xxx, 0-1.xxx.xxx.xxx.

• The range of the IP addresses cannot encapsulate local IP addresses.

• The following parameters are only applicable for DHCP server: DHCPSRVR, MINADD, MAXADD.

• The following parameters are only applicable for DHCP Relay: OPT82. The other parameters are not
applicable to OPT82. The command is denied, if any other parameter is provided for configuring
DHCPRELAY.

• The MINADD & MAXADD values for DHCPSERVER-2...13 must have the first three octets be the
NESUBNET and port shelf number, with the fourth octet being a range of up to 80 values.

• The first name-defined parameters entered after the ctag must not have its leading comma.
Name-defined parameters can be entered in any order.

• Command is denied for DHCPSERVER-2...13 if entries in the NEIDMAP already exist within the IP
address range bounded by MINADD/MAXADD values.

• Provisioning of DHCPSERVER-2...13 is only allowed for packet equipped port shelves.

• Disabling the DHCP Server is allowed only when the DHCP Server didn't allocate any IP address and
the state is out-of-service; or when the commandMode is set to FRCD and the state is out-of-service.

• The command is denied, if OPT82 is provided for configuring DHCPSERVER or DHCPCLIENT.

76.MTFP50/30, Rev B January 2018 Page 30-323

13. Edit Commands TL1 Command Reference Manual

• Command to enable DHCP server function on a packet subsystem is denied, if L2 DHCP relay function
is enabled.

• Command to enable L2 DHCP relay function is denied, if DHCP server function on a packet subsystem
is enabled.

• The attempt to set the DHCPSRVRADDR of a DHCP relay agent other than DHCPSERVER-99 is
denied.

• The attempt to enable the DHCPRELAY-99 dhcp option 82 function without setting the
DHCPSRVRADDR is denied.

Command Format
ED-DHCP:[tid]:{<dhcp_server_aid>|<dhcp_client_aid>|<dhcp_relay_aid>}:ctag:::
[,ALMPF=<almProfile>][,MINADD=<minIPAddr>][,MAXADD=<maxIPAddr>]
[,DHCPSRVR=<dhcpSrvr>][,OPT82=<option82>][,DHCPSRVRADDR=<dhcpserver_address>][:<
editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.22 ED-DHCP Parameters

Parameter Value(s) Definition
dhcp_aid DHCPRELAY-[1-13,99] EntityID-DHCPID

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

minIPAddr Possible values are: IP address. Specifies the minimum IP address that can be assigned by the
IPaddress = 10.0.yyy.zzz Where: DHCP server. Applies only when AID specified is DHCP server
yyy=1 for PGNE-1 and 2 for PGNE-2, AID.
zzz = 2-127
DHCPSERVER address range can not encapsulate following
addresses:
Invalid addresses --------------- Prefix/Len Rep.
224-255.xxx.xxx.xxx ------------ 224/3
169.254.xxx.xxx ----------------- 169.254/16
127.xxx.xxx.xxx ------------------ 127/8
0-1.xxx.xxx.xxx ------------------- 0/7

Page 30-324 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.22 ED-DHCP Parameters (Continued)

Parameter Value(s) Definition
maxIPAddr Possible values are: IP address. Specifies the maximum IP address that can be assigned by the
IPaddress = 10.0.yyy.zzz Where: DHCP server. Applies only when AID specified is DHCP server
yyy=1 for PGNE-1 and 2 for PGNE-2, AID.
zzz = 3-128 DHCPSERVER address range can not encapsulate following
addresses:
Invalid addresses --------------- Prefix/Len Rep.
224-255.xxx.xxx.xxx ------------ 224/3
169.254.xxx.xxx ----------------- 169.254/16
127.xxx.xxx.xxx ------------------ 127/8
0-1.xxx.xxx.xxx ------------------- 0/7

dhcpSrvr ENABLED Enable/Disable the DHCP server. Applies only when AID
DISABLED specified is DHCP server AID.

option82 ENABLED - ENABLED: Enables L2 DHCP Option 82 Relay functionality on

DISABLED the specific port shelf.
- DISABLED: Disables L2 DHCP Option 82 Relay functionality
on the specific port shelf.

dhcpserver_ad [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the DHCP server.

dress

editablePrimar IS Indicates the primary state of the entity.

yState OOS Possible values for PST:
- IS: In-Service.
- OOS: Out-of-Service.

commandMod NORM Specifies the way in which the command is executed.

e FRCD Applies only when AID specified is DHCP server AID.
Enter NORM to specify a normal mode of execution (any state
inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
ED-DHCP:CORIANT1:DHCPSERVER-1:AM0074:::,DHCPSRVR=ENABLED,
MINADD=10.0.1.2,MAXADD=10.0.1.128;

ED-DHCP:CORIANT1:DHCPRELAY-2:AM0074:::,OPT82=ENABLED;

ED-DHCP:CORIANT1:DHCPRELAY-2:AM0074:::,OPT82=DISABLED;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-DHCP
RTRV-DHCPIPADDR

76.MTFP50/30, Rev B January 2018 Page 30-325

13. Edit Commands TL1 Command Reference Manual

ED-EQPT

Command Changes Since Previous Feature Package

• Added support for PWS

• Added support for OSM-4S, OSM-5C.

Description
The ED-EQPT::{X} command instructs the network element (NE) to edit the primary state of the selected equipment
entity. It allows also modification of other parameters such as Module/Shelf name, Alarm Profile.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered must not have its leading comma.

• CMDMDE=FRCD is required to place an SFP/SFPP/CFP module Out-of-Service (OOS-MA) when the

traffic might be impacted.

• The system prevents of the PKT_SHELF_TYPE modification during software upgrade.

• The active shelf controller, ex. STPM, cannot be edit the OOS. Use SW-DX-EQPT first, and then ED
the standby STPM OOS.

• The value of DISPCOMPRL must be less than the value of DISPCOMPRH.

• The difference between the values of DISPCOMPRL and DISPCOMPRH must be at least 1000.

• The DISPCOMPRL and DISPCOMPRH parameters are only supported on CFPs with the part numbers
81.71T-CDWDMS-R6 or 82.71T-CDWDMS-R6.

• The DISPCOMPRL and DISPCOMPRH parameters can only be changed if the CFP is OOS.

• An attempt to configure COMMCONN to NA for a PWS shelf is denied if the shelf following it in the daisy
chain exists and does not have COMMCONN configured as NA.

• PWS shelves 50, 53, and 56 must have COMMCONN set to NA or an OADMRS-9 Comm subslot AID.

• An attempt to configure COMMCONN to a value other than NA for PWS shelves 51, 52, 54, 55, 57 or
58 is denied if COMMCONN is not specified to connect to the PWS shelf that is one less (for example,
PWS-51 must specify COMMCONN as PWS-50).

Table 13.23 PWS Daisy Chains

Daisy Chain

1 2 3
50 53 56

PWS Shelf Number 51 54 57

52 55 58

Page 30-326 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

• On SSM-2S, there are three port groups corresponding to three independent physical Framers. Each
port group support max. 40G SONET/SDH Framer include the OCn/STMn facility on front panel
physical port and the OCn/STMn facility demapped from ODUk (k=1/2) on backplane; support max. 20G
OTN mapping capacity in the combination of any ODU2 or ODU1 when the parameter
OTN_MAP_GROUP for that port group checked per the provision of the module; support max. 10G
EOS mapping capacity on backplane when EOS_MAP_GROUP for that port group checked per the
provision of the module. But the bandwidth include front panel OCn/STMn facility and backplane OCn/
STMn facility demapped from ODUk and TTPSTSn/TTPVCn for EOS on backplane, does not exceed
40G. The OCn/STMn interface (based on pluggable 6xSFPP+ and 24xSFP optics) on front panel
physical port and the entity (ODU1/ODU2/OCn/STMn/STSn/VCn/TTPSTSn/TTPVCn) provisioned on
backplane is grouped in the way below:
- The first port group (connecting with 1st Framer):
Port 1-2: 2xSFP+ for 10G OC192/STM64 clients
Port 7-14: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 7-14 (for example,
ODU1-<shelf>-<slot>-<99>-<7-14>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 1-2 (for example,
ODU2-<shelf>-<slot>-<99>-<1-2>)
TTPSTSn/VCn with the port group number 1 (for example, TTPSTSn-<shelf>-<slot>-<99>-<1>-<1-
192>)
- The second port group (connecting with 2nd Framer):
Port 3-4: 2xSFP+ for 10G OC192/STM64 clients
Port 15-22: 8xSFP for <=2.5G OCn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 15-22 (for example,
ODU1-<shelf>-<slot>-<99>-<15-22>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 3-4 (for example,
ODU2-<shelf>-<slot>-<99>-<3-4>)
TTPSTSn/VCn with the port group number 2 (for example, TTPSTSn-<shelf>-<slot>-<99>-<2>-<1-
192>)
- The third port group (connecting with 3rd Framer):
Port 5-6: 2xSFP+ for 10G OC192/STM64 clients
Port 23-30: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 23-30 (for example,
ODU1-<shelf>-<slot>-<99>-<23-30>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 5-6 (for example,
ODU2-<shelf>-<slot>-<99>-<5-6>)
TTPSTSn/VCn with the port group number 3 (for example, TTPSTSn-<shelf>-<slot>-<99>-<3>-<1-
192>)

• The system denies the change of OTN_MAP_GROUP or EOS_MAP_GROUP parameter on a SSM-2S

when there is any pre-provisioned OCn/STMn facility or ODUk/STSn/VCn/TTPSTSn/TTPVCn/VCG
entity.

Command Format
ED-
EQPT:[tid]:<eqpt_aid>:ctag:::[,CMDMDE=<commandMode>][,ALMPF=<almProfile>][,SHELF
NAME=<ShelfName>][,CPNAME=<CPName>][,MOUNT=<shelf_mount>][,EXTATTN=<ExternalAtte
nuator>][,OTN_MAP_GROUP=<OTN_Map_Group>][,EOS_MAP_GROUP=<EOS_Map_Group>][,DISPCO
MPRL=<dispcomprl>][,DISPCOMPRH=<dispcomprh>]:[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

76.MTFP50/30, Rev B January 2018 Page 30-327

13. Edit Commands TL1 Command Reference Manual

Parameters Applicability when Entering the Command

Table 13.24 ED-EQPT Parameter Applicability

DCM SFPP
OMD SFP
OSM5C CFP
OSM4S CFP2
OSM4C SAIM
OSM4F SDM
OSM2C SEIM
OSM2S SIOM
OSM1S STIM FAN
OCC MFAB FAN8
CDCP MFAB2 BFM
DEF FSM STPM OADM SFM
a b
PARAMETER SSM2S CD4D8 STPM8 RS MFM SH PWS
CPNAME ND O O O O O
ALMPF ND O O O O O O O
SHELFNAME ND O O
COMMCONN ND O
CMDMDE ND O O O O
EXTATTN ND O
MOUNT ND O
OTN_MAP_GROU ND O
P

EOS_MAP_GROU ND O
P

DISPCOMPRL ND Oc
c
DISPCOMPRH ND O
PST PD O O O O O O
a. M indicates a MANDATORY parameter and O indicates an OPTIONAL parameter for the specified module
b. ND: Name Defined or PD: Position Defined.
c. Applies to CFP only.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-328 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.25 ED-EQPT Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CD4D8-[50-58]-[2-4,6-8]
CDCP-20-[10-16,1-7]-[1-3]
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
DCM-20-[1-16]-[1-3]
FAN-20-[29-32]
FAN8-20-[16,17]
FSM-20-[35,34]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OMD-20-[1-16]-[1-2]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SIOM-20-15
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

ShelfName Is a string of length 0 to 47 characters. Specifies an additional field to identify the shelf.
Refer to section 2 for the applicable characters.

CPName Is a string of length 0 to 47 characters. Specifies an additional field to identify the entity.
Refer to section 2 for the applicable characters.

shelf_mount HRZ Indicates how a shelf is physically oriented/mounted.

VRT
Default: HRZ

76.MTFP50/30, Rev B January 2018 Page 30-329

13. Edit Commands TL1 Command Reference Manual

Table 13.25 ED-EQPT Parameters (Continued)

Parameter Value(s) Definition
ExternalAttenu [0-20] 1 to 20 dB indicates the value of any external attenuator that is
ator connected to the input of an Input Amplifier.
0 indicates that no external attenuator is present.

OTN_Map_Gr [0-3] Specifies a single value, or a group of values, or a range of

oup values identifying which port groups is used within the
supporting SSM-2S module to do OTN adaption. The granularity
is 20G, which means when a port group is selected it reserves
20G ODU mapping capacity. 1 means 1st port group selected, 2
means 2nd port group selected, 3 means 3rd port group
selected, 1&2&3 means all the three port groups selected and
on a SSM-2S module it could support 60G OTN mapping. 0
means non port group is selected so no resource reserved for
OTN mapping.

Use & for grouping.

Use && for ranging.

Default is 0 in FP4.0.

EOS_Map_Gr [0-3] Specifies a single value, or a group of values, or a range of

oup values identifying which port groups is used within the
supporting module to do EoS adaption. The granularity is 10G,
which means when a port group is selected it reserves 10G
Ethernet over SONET/SDH mapping capacity. 1 means 1st port
group selected, 2 means 2nd port group selected, 3 means 3rd
port group selected, 1&2&3 means all the three port groups
selected and on a SSM-2S module it could support 30G EOS
mapping.0 means non port group is selected so no resource
reserved for EOS mapping.

Use & for grouping.

Use && for ranging.

Default is 1&2&3 in FP4.0.

dispcomprl AUTO, -40000 to +39000 Specifies the low end of the range for the chromatic dispersion
picoseconds/nanometer (ps/nm) in 1 search.
ps/nm increments.
When set to AUTO for the CFP parts 81.71T-CDWDMS-R6 and
82.71T-CDWDMS-R6, the low end of the range for the
chromatic dispersion search is set to -40000 picoseconds/
nanometer (ps/nm)

dispcomprh AUTO, -39000 to +40000 Specifies the high end of the range for the chromatic dispersion
picoseconds/nanometer (ps/nm) in 1 search.
ps/nm increments.
When set to AUTO for the CFP parts 81.71T-CDWDMS-R6 and
82.71T-CDWDMS-R6, the high end of the range for the
chromatic dispersion search is set to +40000 picoseconds/
nanometer (ps/nm)

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example 1: Modification of CPNAME

ED-EQPT:CORIANT1:STPM-20-24:AM0074:::CPNAME="PROCESSOR UNIT":IS;

Page 30-330 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Example 2: Edit OTN/EOS Mapping Resource on SSM-2S

Edit SSM-2S module to reserve port group #1, #2, #3 for OTN mapping; and port group #1 and #2 for EOS mapping.
ED-EQPT:CORIANT1:SSM2S-20-1:AM0074:::CPNAME="SONET/SDH Switching
Module 2 (SFP/SFP+)",OTN_MAP_GROUP=1&&3,EOS_MAP_GROUP=1&2:IS;

Possible System Response

^^^CORIANT1 02-03-16 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EQPT::{X}
ENT-EQPT::{X}
RTRV-EQPT::{X}

76.MTFP50/30, Rev B January 2018 Page 30-331

13. Edit Commands TL1 Command Reference Manual

ED-EXDPATH

Command Changes Since Previous Feature Package

• None.

Description
The ED-EXDPATH command instructs the Network Element (NE) to edit the excluded path according to the users'
needs and designs.

Loose hop has to be L-areaID-nodeID[-IfIndex], strict hop has to be S-areaID-nodeID[-IfIndex] when a routing
element is provided. L and S must be explicitly input.

Since a Call can traverse a huge network, the number of excluded path route elements might be over hundreds. The
mTera network elements provide a link list manipulations command set to allow the management/definition of the
excluded path instance. This can be done in:
• INSRTBEFORE: insert a set of excluded path route elements before the given excluded path route
element.

• INSRTAFTER: insert a set of excluded path route elements after the given excluded path route element.

• RMV: remove the given excluded path route elements.

Restrictions and Exceptions

• The modifying of an excluded path object is denied when it referenced as a WKGXPATH or
PROTXPATH when the call is created.

• EXDPATHNAME is a name string that can be optionally entered, the suggestion is each path should
have clearly denoted name.

• Only one excluded path route element from the existing route can be specified for INSRTBEFORE,
INSRTAFTER parameters, otherwise the command is denied.

• The input parameters INSRTBEFORE, INSRTAFTER and RMV are mutually exclusive.

• RMV contains one or multiple excluded path route element(s) that are continguous.

• Maximum 36 excluded path route elements are supported per excluded path object, the total characters
added by the excluded path's route elements cannot exceed 1692 chars, these limitations apply to the
usage of "xrouteElements" parameter.

• S or L is mandatory in every excluded path route element.

Command Format
ED-
EXDPATH:[tid]:<EXDP_aid>:ctag:::[EXDPATHNAME=<EXDPathName>][,INSRTBEFORE=<xroute
Element>][,INSRTAFTER=<xrouteElement>][,SUBROUTE=<xrouteElements>][,RMV=
<xrouteElements>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Page 30-332 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.26 ED-EXDPATH Parameters

Parameter Value(s) Definition
exdp_aid EXDPATH-[1,3]-[1-512] EntityID-NPID-PathID

EXDPathNam 0 to 31 alphanumeric characters. Specifies the string name of excluded path.

e
Refer to section 2 for the applicable characters.

xrouteElement Contains a excluded route element Identify a specific excluded path route element.
that are used to identify the insertion
or appending posisition. A excluded
route element is in form of (S|L)-
areaIDnodeID[-IfIndex].

xrouteElement Contains a list of excluded path route Specifies the excluded path route elements that form the
s element that are separated by comma. excluded path in a specific format.
A excluded path route element is
inform of (S|L)-areaID-nodeID[- Maximum 36 excluded path route elements are supported per
IfIndex]. IfIndex is 8 hexadecimal excluded path object.
digits. Maximum 1692 chars are allowed for the total characters added
by the excluded path route elements.

S means the excluded path route element(s) is(are) strict. It

says that the route elements specified MUST be excluded;
L means the excluded path route element(s) is(are) loose. It
says that the route elements specified SHOULD be avoided.
L and S must be explicitly input.

Two forms of excluded path route element:

(S|L)-areaID-nodeID: L-1.1.1.10-123.224.187.198
(S|L)-areaID-nodeID-Ifindex: S-1.1.1.10-123.224.187.198-
040FAA0C

Example
The following example shows inserting route element after excluded path already existed:

ED-EXDPATH:CORIANT1:EXDPATH-3-1:AM0011:::EXDPATHNAME="WKGXPATH-1",INSRTAFTER="S-
1.1.1.20-111.0.0.110-030FBB02",SUBROUTE="S-1.1.1.20-111.0.0.111-040FBB03";

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EXDPATH
ENT-EXDPATH

76.MTFP50/30, Rev B January 2018 Page 30-333

13. Edit Commands TL1 Command Reference Manual

RTRV-EXDPATH

Page 30-334 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-EXPPATH

Command Changes Since Previous Feature Package

• None.

Description
The ED-EXPPATH command instructs the Network Element (NE) to edit the explicit path according to the users'
needs and designs.

Loose hop has to be L-node-IfIndex[-Label], strict hop has to be S-nodeId-IfIndex[-Label] when a routing element is
provided. L and S must be explicitly input.

Figure 13.3 Explicit Path Examples

Z Destination Node
Source Node
A

Fully explicit route Partial explicit route

An S hop may be an initial hop in an explicit path if it is the first hop out of the origination node at that hop's OSPF
hierarchical level. The S hop of S-D-1 in explicit path 1 is an example of this case in the following figure.

Figure 13.4 Explicit path with S hop as initial hop

B C

Source
A
node Destination
2 3 2 3 Z node
1 1 4
D 4 E

explicit path 1: S-D-1,S-E-1

An S hop may be the first hop specified within a given level's domain if it is the first hop within that level's domain -
that is, it is the hop out of the origination node (or originating abstract node) at that hop's OSPF hierarchical level,
or it is the hop out of the ingress node of that hop's domain (at that hop's hierarchical level). Note: if specifying
ingress hops instead of egress hops, the first hop may in fact be an ingress hop at the far end of the link out of the
origination/ingress node.

76.MTFP50/30, Rev B January 2018 Page 30-335

13. Edit Commands TL1 Command Reference Manual

In following example, explicit path 2 and explicit path 3 are actually indicating the same path route. The S hop of S-
E-4 in explicit path 2 is the first hop within the intermediate domain while the S hop of S-F-1 in explicit path 3 is the
far end of the same hop.

Figure 13.5 An example of explicit path over multiple domains

explicit path 2: L-D-3,S-E-4,S-F-4 explicit path 3: L-D-3,S-F-1,S-F-4

B 1
1 4
E F 4
A 2 3
3
2 Destination
2 3
Source D node
1 4
node Z
C G H

E_NNI E_NNI

If any hops are provided within a non-originating child area, they must be preceded by an L or S hop in the parent
area to enter that domain. In the example above, the L hop of L-D-3 is necessary to allow hops to be specified within
the intermediate domain.

Except as noted above, S hops at a given OSPF hierarchical level (within a given domain) must be preceded by an
S or L hop at that same level (that is,, an immediately preceding link at that same level - not just immediately
preceding in the routeElements field). Note, however, that other hops in child areas may appear between these hops
at their given level.

Except as noted above, there is no restriction on what must precede an L hop.

The order of the hops in the EXPPATH is required to be met in any route generated by a call using the EXPPATH.

Since a Call can traverse a huge network, the number of route elements might be over hundreds. The mTera
network elements provide a link list manipulations command set to allow the management/definition of the explicit
path instance. This can be done in:
• INSRTBEFORE: insert a set of route elements before the given route element.

• INSRTAFTER: insert a set of route elements after the given route element.

• RMV: remove the given route elements.

Restrictions and Exceptions

• ED-EXPPATH command is denied, if the explicit path is in-use.

• The modifying of an explicit path object is independent of whether it has been referenced as a
WKGPATH or PROTPATH when the call is created.

• EXPPATHNAME is a name string that can be optionally entered, the suggestion is each path should
have clearly denoted name.

• Only one route element from the existing route can be specified for INSRTBEFORE, INSRTAFTER
parameters, otherwise the command is denied.

Page 30-336 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

• The input parameters INSRTBEFORE, INSRTAFTER and RMV are mutually exclusive.

• Maximum 36 route elements are supported per explicit path object, the total characters added by the
explicit path's route elements cannot exceed 1692 chars, these limitations apply to the usage of
"routeElements" parameter.

• S or L is mandatory in every route element.

• RMV contains one or multiple route element(s) that are continguous.

• The ODUk/j/flex label is always a multiple of 8 hexadecimal digits.

Command Format
ED-
EXPPATH:[tid]:<expp_aid>:ctag:::[EXPPATHNAME=<expPathName>][,INSRTBEFORE=<routeE
lement>][,INSRTAFTER=<routeElement>][,SUBROUTE=<routeElements>][,RMV=
<routeElements>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.27 ED-EXPPATH Parameters

Parameter Value(s) Definition
expp_aid EXPPATH-[1,3]-[1-512] EntityID-NPID-PathID

routeElement Contains a route element that are Identify a specific route element.
used to identify the insertion or
appending posisition. A route element
is inform of (S|L)-nodeIDIfIndex[-
Label] (1)IfIndex is 8 hexadecimal
digits. (2)Label is 8 hexadecimal digits
for non ODUk labels or G.709 V2
ODUk labels; Label is a multiple of 8
hexadecimal digits for G.709 V3
ODUk/j/flex labels.

76.MTFP50/30, Rev B January 2018 Page 30-337

13. Edit Commands TL1 Command Reference Manual

Table 13.27 ED-EXPPATH Parameters (Continued)

Parameter Value(s) Definition
routeElements Contains a list of route element that Specifies route elements that form the explicit path in a specific
are separated by comma. A route format.
element is inform of (S|L)-nodeID- Maximum 36 route elements are supported per explicit path
IfIndex[-Label] (1)IfIndex is 8 object.
hexadecimal digits. (2)Label is 8 Maximum 1692 chars are allowed for the total characters added
hexadecimal digits for non ODUk by the explicit path's route elements.
labels or G.709 V2 ODUk labels; Label Only one route element allowed for INSRTBEFORE &
is a multiple of 8 hexadecimal digits for INSRTAFTER.
G.709 V3 ODUk/j/flex labels.
S means the route element(s) is(are) strict. The path between a
strict route element and its preceding route element MUST
include only network route elements from the strict route
element and its preceding abstract route element.
L means the route element(s) is(are) loose. The path between a
loose route element and its preceding route element MAY
include other network route elements that are not part of the
strict route element or its preceding abstract route element.
Two forms of route element:
(S|L)-Node-Ifindex: L-123.224.187.198-040FAA0C
S-Node-Ifindex-label: S-123.224.187.198-040FAA0C-000A0000

exppathName 0 to 31 alphanumeric characters. Specifies the string name of explicit path.

Default: "" (empty string)
Refer to section 2 for the applicable characters.

Example
The following example shows inserting route element after explicit path already existed.
ED-EXPPATH:CORIANT1:EXPPATH-3-
1:AM0011:::EXPPATHNAME="WorkingPath1",INSRTAFTER="S-111.0.0.110-
030FBB02",SUBROUTE="S-111.0.0.111-040FBB03";

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EXPPATH
ENT-EXPPATH
RTRV-EXPPATH

Page 30-338 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-E1

Command Changes Since Previous Feature Package

• None

Description
Command instructs the network element (NE) to edit the attributes of a E1 (2.048 Mb/s) facility entity providing an
External Synchronization reference.

Restrictions and Exceptions

• When no parameter is specified, the behavior is to not change its current setting.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• E1 Line Code & Format & termination & SaBit can only be edited if the E1 or E1OUT facility is in OOS-
MA or if the command is forced (CMDMDE = FRCD).

• When both Input Synchronization and Output Synchronization facility are created in one port, E1 Format
& termination can only be edited if the both E1 and E1OUT facility are in OOS-MA or if the command is
forced (CMDMDE = FRCD).

• almProfile and qualityLevelOverride are only applicable on the Input Synchronization aid (E1/2MH).

• tx_ref and loopPrevention are only applicable on the Output Synchronization aid (E1OUT).

• Parameter qualityLevelOverride cannot be Disable for 2MH and unframed E1.

Command Format
ED-
E1:[tid]:E1_aid:ctag:::[,LINECDE=<LineCode>][,FMT=<FrameFormat>][,TXREF=<tx_ref>
][,ALMPF=<almProfile>][,SABIT=<SaBit>][,QLOVERRIDE=<qualityLevelOverride>][,TERM
=<terminationE1>][,CMDMDE=<commandMode>][,LOOPPRVT=<loopPrevention>]:[<editableP
rimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters

Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.28 ED-E1 Parameters

Parameter Value(s) Definition
e1_aid 2MH-20-[15,23,26]-[1,2] EntityID-ShelfID-SlotID-PortID
E1-20-[15,23,26]-[1,2]
E1OUT-20-[15,23,26]-[1,2]

76.MTFP50/30, Rev B January 2018 Page 30-339

13. Edit Commands TL1 Command Reference Manual

Table 13.28 ED-E1 Parameters (Continued)

Parameter Value(s) Definition
LineCode AMI Indicates the line code for a E1 facility.
HDB3 Possible values are High Density Bipolar 3 coding (HDB3) or
Alternate Mark Inverted (AMI).

FrameFormat NOCRC4 Indicates the digital signal frame format of a E1 facility.

CRC4
UNFRAMED

tx_ref NA, Indicates the derived source signal timing the output
SYNC-20-1, synchronization reference. Applicable only to output
OC3-20-[1-16]-[1-32], synchronization references.
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

SaBit 4 Specifies which one of the Sa4 to Sa8 bits, is allocated for
5 Synchronization Status Messages.
6
7
8

qualityLevelOv DISABLED Specifies the synchronization signal quality level that is

erride PRC associated with the specified E1 facility instead of the value
SSU-A received in the synchronization status message within the E1
SSU-B signal. This allows the override of quality level that was received
SEC within the E1.
DNU When set to DISABLED, the system uses the quality level
received in the synchronization status message of the E1.

terminationE1 75 Sets the termination for the E1 facility.

120

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

loopPrevention DISABLED Specifies the loop prevention function of the entity.

ENABLED Enable: The SSM of output synchronization is forced to DNU
when the tx_ref is SYNC-20-1 and the SYNC-20-1 source is the
same input synchronization port
Disable: The SSM of output synchronization follows the tx_ref
and squelch result. It does not consider the status of the tx_ref
entity.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Page 30-340 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.28 ED-E1 Parameters (Continued)

Parameter Value(s) Definition
tx_sqlch AIS Indicates output synchronization reference when squelch is
DNU applied. Applicable only to output synchronization references.
SQLCH ²AIS : Force AIS in the output synchronization signal
SSM ²DNU: The SSM of the output synchronization set to DNU, this
parameter is only available when the Frame Format is NOCRC4
or CRC4
²SQLCH: Shutdown the output synchronization signal
²SSM: The SSM function shuts down the output synchronization
signal transmission if the tx-ref signal with a quality that is lower
than the configurable threshold.

ql_min PRC Indicates the QL threshold of the derived source signal timing
SSU-A the output synchronization reference when it is SSM squelch
SSU-B mode. Applicable only to output synchronization references.
SEC
DNU

Example
ED-E1:CORIANT1:E1-20-23-2:CT0074:::LINECDE=AMI,FMT=NOCRC4,TERM=75:IS;

Possible System Response

^^^CORIANT1 15-03-15 02:08:15

M CT0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-E1
ENT-E1
DLT-{x}

76.MTFP50/30, Rev B January 2018 Page 30-341

13. Edit Commands TL1 Command Reference Manual

ED-FFP-HGE

Command Changes Since Previous Feature Package

• None.

Description
The ED-FFP-HGE command instructs the network element (NE) to edit the attributes of a facility protection group
for a pair of HGE (100GE) facilities.

The following HGE FFP is allowed in an mTera UTP:

• Y-Cable, using any OSM-2C modules in an mTera shelf.

Restrictions and Exceptions

• This command is only supported when the supporting module is a OSM-2C.

• Neither of the facilities associated with the protection group nor the protection scheme can be modified.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• The system denies an attempt to set RVRTV to YES if the current secondary state of the FFP is DNR.

Command Format
ED-FFP-
HGE:[tid]:<protectedId>,<protectingId>:ctag:::[HOLDOFFPROT=<HoldOffProt>][,RVRTV
=<rvrtv>][,WTR=<wtr>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.29 ED-FFP-HGE Parameters

Parameter Value(s) Definition
protectedId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

protectingId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive.

Page 30-342 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.29 ED-FFP-HGE Parameters (Continued)

Parameter Value(s) Definition
wtr [300-3600] Wait To Restore. Valid values: 300-3600 seconds. After
expiration of the timer, the working line is restored and a no
request state is transmitted.
This parameter applies when rvrtv=YES.

Example
ED-FFP-HGE:CORIANT1:HGE-20-6-1,HGE-20-11-1:CTAG-1:::RVRTV=NO;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG-1 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-FFP-HGE
ENT-FFP-HGE
RTRV-FFP-HGE

76.MTFP50/30, Rev B January 2018 Page 30-343

13. Edit Commands TL1 Command Reference Manual

ED-FFP-OCn {OC3/OC12/OC48/OC192}

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The ED-FFP-OCn command instructs the network element (NE) to edit the attributes of a facility protection group
for a pair of OCn facilities.

The following FFP can be edited on an SSM-2S:

• OC3/12/48/192 1+1 APS FFP between two Port side interfaces over the whole mTera shelf including
on any two SSM-2S modules or on the single SSM-2S module.

The following FFP can be edited on an OSM-2S/OSM-4S:

• OC192 Y-Cable FFP over the whole mTera shelf including on any two OSM-2S or two OSM-4S
modules or on the single OSM-2S/OSM-4S module.

Restrictions and Exceptions

• Neither of the facilities associated with the protection group nor the protection scheme can be modified.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• The system denies an attempt to set RVRTV to YES if the current secondary state of the FFP is DNR.

• This command is supported when the supporting module is a OSM-2S/OSM-4S for Y-Cable protection,
or when the supporting module is a SSM-2S for OC3/12/48/192 1+1 APS FFP protection.

• Parameter HOLDOFFPROT apply also for SSM-2S 1+1 APS FFP protection.

• This command not apply for the OCn facility associated with virtual port 99 on SSM-2S, instead use
ENT/ED-EPG commands on SSM-2S for the Equipment Protection Group provision or edit when the
adaption point protection is needed in the application of SONET to OTN bridge.

Command Format
ED-FFP-
OCn:[tid]:<protectedId>,<protectingId>:ctag:::[,HOLDOFFPROT=<HoldOffProt>][,RVRT
V=<rvrtv>][,WTR=<wtr>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-344 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.30 ED-FFP-OCn {OC3/OC12/OC48/OC192} Parameters

Parameter Value(s) Definition
protectedId OC12-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID
OC192-20-[1-16]-[1-40]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]

protectingId OC12-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID

OC192-20-[1-16]-[1-40]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO YES: revertive
NO: not revertive.
Default value is no change to current value.

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
switch's back immediately. After expiration of the timer, the
working line is restored and a no request state is transmitted.

300-3600 seconds for Y-CABLE scheme.

Example
ED-FFP-OC48:CORIANT1:OC48-20-5-8,OC48-20-5-11:CTAG-1:::RVRTV=NO;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG-1 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-OCn
DLT-FFP-OCn
RTRV-FFP-OCn

76.MTFP50/30, Rev B January 2018 Page 30-345

13. Edit Commands TL1 Command Reference Manual

ED-FFP-STMn (STM1/STM4/STM16/STM64)

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The ED-FFP-STMn command instructs the network element (NE) to edit the attributes of a facility protection group
for a pair of STMn facilities.

The following FFP can be edit on OSM-2S/OSM-4S:

• STM64 Y-cable FFP over the whole mTera shelf for any two OSM-2S or two OSM-4S or a single OSM-
2S/OSM-4S.

The following FFP can be edit on SSM-2S:

• STM1/4/16/64 1+1 MSP FFP between two Port side interfaces over the whole mTera shelf including on
any two SSM-2S modules or on the singleSSM-2S module.

Restrictions and Exceptions

• This command is supported when the supporting module is a OSM-2S/OSM-4S for Y-Cable protection.

• This command is supported when the supporting module is a SSM-2S for STM1/4/16/64 1+1 MSP FFP
protection.

• Neither of the facilities associated with the protection group nor the protection scheme can be modified.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• The system denies an attempt to set RVRTV to YES if the current secondary state of the FFP is DNR.

• Parameter HOLDOFFPROT apply also for SSM-2S 1+1 MSP FFP protection.

• This command not apply for the STMn facility associated with virtual port 99 on SSM-2S, instead use
ENT/ED-EPG commands on SSM-2S for the Equipment Protection Group provision or edit when the
adaption point protection is needed in the application of SDH to OTN bridge.

Command Format
ED-FFP-
STMn:[tid]:<protectedId>,<protectingId>:ctag:::[HOLDOFFPROT=HoldOffProt][,RVRTV=
<rvrtv>] [,WTR=<wtr>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-346 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.31 ED-FFP-STMn (STM1/STM4/STM16/STM64) Parameters

Parameter Value(s) Definition
protectedId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID
STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

protectingId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID

STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

rvrtv YES Revertive state:

NO YES: revertive
NO: not revertive.
Default value is no change to current value.

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
switch’s back immediately. After expiration of the timer, the
working line is restored and a no request state is transmitted.

300-3600 seconds for Y-CABLE scheme.

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

Example
ED-FFP-STM64:CORIANT1:STM64-20-5-8,STM64-20-12-1:CTAG-1:::RVRTV=NO;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG-1 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-STMn
DLT-FFP-STMn
RTRV-FFP-STMn

76.MTFP50/30, Rev B January 2018 Page 30-347

13. Edit Commands TL1 Command Reference Manual

ED-FFP-TGLAN

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The ED-FFP-TGLAN command instructs the network element (NE) to edit the attributes of a facility protection group
for a pair of TGLAN facilities.

The following TGLAN FFP are allowed in an mTera UTP:

• Y-Cable, using any of two OSM-2S modules or a single OSM-2S module, is supported. For OSM-2S in
mTera shelf, no pairing slots defined and Y-Cable FFP on TGLAN could be supported over the whole
shelf.

• Y-Cable, using any of two OSM-4S modules or a single OSM-4S module, is supported. For OSM-4S in
mTera shelf, no pairing slots defined and Y-Cable FFP on TGLAN could be supported over the whole
shelf.

• Pairing rules must be followed for Y-Cable to function correctly in paired configuration.

Restrictions and Exceptions

• Neither of the facilities associated with the protection group nor the protection scheme can be modified.

• The system denies an attempt to set RVRTV to YES if the current secondary state of the FFP is DNR.

Command Format
ED-FFP-
TGLAN:[tid]:<protectedId>,<protectingId>:ctag:::[HOLDOFFPROT=<HoldOffProt>][,RVR
TV=<rvrtv>][,WTR=<wtr>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.32 ED-FFP-TGLAN Parameters

Parameter Value(s) Definition
protectedId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

protectingId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive.

Page 30-348 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.32 ED-FFP-TGLAN Parameters (Continued)

Parameter Value(s) Definition
wtr [300-3600] Wait To Restore. Valid values: 300-3600 seconds. After
expiration of the timer, the working line is restored and a no
request state is transmitted.
This parameter applies when rvrtv=YES.

Example
ED-FFP-TGLAN:CORIANT1:TGLAN-20-6-1,TGLAN-20-11-1:CTAG-1:::RVRTV=NO;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-FFP-TGLAN
ENT-FFP-TGLAN
RTRV-FFP-TGLAN

76.MTFP50/30, Rev B January 2018 Page 30-349

13. Edit Commands TL1 Command Reference Manual

ED-FGE

Command Changes Since Previous Feature Package

• None.

Description
The ED-FGE command instructs the Network Element (NE) to edit the attributes of a FGE (40 Gbps Ethernet)
facility.

The FGE facility can be edited on the following modules:

• OSM-2C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• NENDALS can only be set to YES if PROT=YES for the facility.

Command Format
ED-
FGE:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PROT=<protection>][,NENDALS=<N
endALS>][,CMDMDE=<commandMode>][:<editablePrimaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.33 ED-FGE Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Page 30-350 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.33 ED-FGE Parameters (Continued)

Parameter Value(s) Definition
protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.

Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending an maintenance
signal when there is a signal failure detected on the line side of a
transponder.

Setting the value to NO does not shut down the laser. When this
value is set standard maintenance signaling is used.

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOSYNC).
Note: This parameter cannot be used (for example, default to
NO) for 1-WAY Line-to-Port Connection.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
ED-FGE:CORIANT1:FGE-20-2-1:MYCTAGE:::ALMPF=99;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FGE
DLT-{X}
RTRV-{X}

76.MTFP50/30, Rev B January 2018 Page 30-351

13. Edit Commands TL1 Command Reference Manual

ED-FTPSERVER

Command Changes Since Previous Feature Package

• None.

Description
The ED-FTPSERVER command instructs the network element (NE) to modify the properties of the FTP server
used for PM file transfer purpose in binary format.

Restrictions and Exceptions

• Only Historical PM file transfer in binary format for STSn or ODUk montypes (for example, Path PM) is
supported.

• The parameter pwd is optional for configuring SFTP server that is,, when port = 22. However, it is
mandatory when configuring FTP server.

• Password can be blanked out only by deleting the FTP server using DLT-FTPSERVER and reentering
it using ENT-FTPSERVER.

Command Format
ED-FTPSERVER:[tid]:[<ftpserver_aid>]:ctag::[<userid>],[<pwd>],[<ipaddress>],
[<port>],[<urlPath>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.34 ED-FTPSERVER Parameters

Parameter Value(s) Definition
ftpserver_aid FTPSERVER-1 EntityID-FTPSERVERID

userid A string consisting of 6 to 32 Specifies a valid user Identification on the FTP server.
characters.
Note that the following characters are not allowed for <userid>:
@?/\{[()]}

pwd A string consisting of 6 to 32 Specifies the corresponding password for the valid <userid> on
characters. the FTP server.

Note that the following characters are not allowed for <pwd>:
@?/\{[()]}

The password is displayed as "*".

Page 30-352 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.34 ED-FTPSERVER Parameters (Continued)

Parameter Value(s) Definition
ipaddress Format for the IP address is: A double Specifies the IP address of the FTP server.
quoted string representing the IPv4
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

port 21,22 Specifies the logical port number associated with the FTP server
IP address.

urlPath Possible values are: xxx/yyy/zzz Specifies the device/drive/directory to put the file on FTP server.

Example
ED-FTPSERVER:CORIANT1:FTPSERVER-1:CTAG1::user1,*,,,;

Possible System Response

^^^CORIANT1 06-06-15 02:08:15

M CTAG1 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-FTPSERVER
ENT-FTPSERVER
DLT-FTPSERVER

76.MTFP50/30, Rev B January 2018 Page 30-353

13. Edit Commands TL1 Command Reference Manual

ED-GBEP

Command Changes Since Previous Feature Package

• None.

Description
The ED-GBEP command instructs the network element (NE) to edit the attributes of a GBEP facility.

The GBEP facilities can be edited on the following devices:

• OSM-1S

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

Command Format
ED-
GBEP:[tid]:<fac_aid>:ctag:::[,PROT=<protection>][,NENDALS=<NendALS>][,ALMPF=<alm
Profile>][,CMDMDE=<commandMode>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Applicable Parameters When Editing the Command

Table 13.35 Parameters Applicability When Entering the Command

Supporting
a
PARAMETER DEF Transponder
ALMPF ND All
b
PROT ND OSM1S

NENDALS ND OSM1Sb

CMDMDE ND All

editablePrimaryState PD All

a. ND: Name Defined or PD: Position Defined.

b. Not supported when eletrical SFP

Page 30-354 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.36 ED-GBEP Parameters

Parameter Value(s) Definition
fac_aid GBEP-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID

protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.

Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending a maintenance
signal (for example, AIS or LF depending on the type of facility
provisioned) when there is a signal failure detected on the line
side of a transponder.

Setting the value to NO does not shut down the laser on port
side of the transponder. When this value is set standard
maintenance signaling is used.

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOSYNC).

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example: Provisioning a GBEP on OSM-1S Port Side Facility.

1. ENT-GBEP::GBEP-20-3-5:ctag1:::PROT=NO:IS;

2. ED-GBEP::GBEP-20-3-5:ctag2:::PROT=YES;

Example: TL1 Retrieval Commands

RTRV-GBEP:CORIANT7100:GBEP-20-3-5:AM0181:::;

CORIANT1 06-03-15 02:07:21

M AM0181 COMPLD

"GBEP-20-3-5::CPTYPE=\"OSM1S - OTN Switching Module 1(SFP)

\",PROT=YES,NENDALS=NO,ALMPF=99:IS-NR,"

Possible System Response

^^^CORIANT1 06-03-15 02:08:15
M AM0074 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-355

13. Edit Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ENT-GBEP
RTRV-{X}

Page 30-356 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-GCC

Command Changes Since Previous Feature Package

• Added support for GCC of ODUk of an ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

• Added support for ZTC proxy over GCC links.

Description
The ED-GCC command instructs the network element (NE) to modify the attributes of GCC entity.

Restrictions and Exceptions

• The CMDMDE=FRCD must be used to edit any parameters if the GCC entity is owned by the control
plane.

• The CMDMDE=FRCD must be used to edit any parameters if the GCC is enabled in MCN.

Command Format
ED-
GCC:[tid]:<gcc_aid>:ctag:::[PPPPF=<ppppf_aid>][,ALMPF=<almProfile>][,CMDMDE=<com
mandMode>][,ZTCPROXY=<proxy_state>]:[<EditablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.37 ED-GCC Parameters

Parameter Value(s) Definition
ppppf_aid PPPPF-[99,1-10] Specifies the access identifier of the PPP protocol profile.

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

proxy_state ENABLED Specifies the ZTC proxy state of the interface.

DISABLED When the ZTC proxy state is ENABLED, the NE can be the ZTC
proxy of the ZTC DUC attached to the port.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

76.MTFP50/30, Rev B January 2018 Page 30-357

13. Edit Commands TL1 Command Reference Manual

Table 13.37 ED-GCC Parameters (Continued)

Parameter Value(s) Definition
gcc_aid GCC0-20-[1-16]-[1-32], GCC0-ShelfID-SlotID-PortID
GCC1-20-[1-16]-[1-20], GCC1-ShelfID-SlotID-PortID-{Supporting ODUtype}{Supporting
GCC1-20-[1-16]-[1-4]-[B,C][1-80]- ODU Tributary Port}-{ODUtype}{ODUTribPort}
[A,B,E,Z,F][1-32], GCC1-ShelfID-SlotID-PortID-{Supporting ODU4}{Supporting
GCC1-20-[1-16]-[1-20]- ODU4 TributaryPort}-{Supporting ODUtype}{Supporting ODU
[A,B,C,D,E,Z,F][1-80], Tributary Port}-{ODUtype}{ODUTribPort}
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32], Note:
GCC1-20-[1-16]-[1-2]-[D][1-3]- 1. for GCC created on an ODU associated with a client port, the
[A,B,C,E,Z,F][1-80], ODUTribPort is not used
GCC2-20-[1-16]-[1-20], 2. Supporting ODUtype and Supporting ODU Tributary Port are
GCC2-20-[1-16]-[1-4]-[B,C][1-80]- only used for 2-stage ODU multiplexing.
[A,B,E,Z,F][1-32], 3. GCC2 and GCC12 have same format values as GCC1.
GCC2-20-[1-16]-[1-20]- 4. Supporting ODU4 and Supporting ODU4 Tributary Port are
[A,B,C,D,E,Z,F][1-80], only applicable when LO ODU is multiplexed into ODU4 within
GCC2-20-[1-16]-[1-2]-[D][1-3]-[B,C][1- the ODUC2 (when the modulation format of the port on OSM-4F
80]-[A,B,E,Z,F][1-32], is configured to 200G16QAM).
GCC2-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC12-20-[1-16]-[1-20],
GCC12-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]

Example
ED-GCC:NE01:GCC0-20-2-1:AM0074:::CMDMDE=FRCD:OOS;

Possible System Response

^^^NEO1 11-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-GCC
DLT-GCC
RTRV-GCC

Page 30-358 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-HGE

Command Changes Since Previous Feature Package

• None.

Description
The ED-HGE command instructs the Network Element (NE) to edit the attributes of a HGE (100 Gbps Ethernet)
facility.

The HGE facility can be edited on the following modules:

• OSM-2C, OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• NENDALS can only be set to YES if PROT=YES for the facility.

Command Format
ED-
HGE:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PROT=<protection>][,NENDALS=<N
endALS>][,CMDMDE=<commandMode>][:<editablePrimaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.38 ED-HGE Parameters

Parameter Value(s) Definition
fac_aid HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

76.MTFP50/30, Rev B January 2018 Page 30-359

13. Edit Commands TL1 Command Reference Manual

Table 13.38 ED-HGE Parameters (Continued)

Parameter Value(s) Definition
protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.

Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending an maintenance
signal when there is a signal failure detected on the line side of a
transponder.

Setting the value to NO does not shut down the laser on the line
or port side of the transponder. When this value is set standard
maintenance signaling is used.

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOSYNC).
Note: This parameter cannot be used (for example, default to
NO) for 1-WAY Line-to-Port Connection.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
ED-HGE:CORIANT1:HGE-20-2-1:MYCTAGE:::ALMPF=99;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-HGE
DLT-{X}
RTRV-{X}

Page 30-360 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-IP

Command Changes Since Previous Feature Package

• None.

Description
The ED-IP command enables the editing of the default IP address, IP network mask and IP default gateway for the
NE local craft interface such that the port can be connected on the Telecom Network (DCN) to transfer a software
load.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

Command Format
ED-IP:[tid]::ctag:::[,IPADDRESS=<lci_ip_address>][,IPNETMASK=<lci_ip_network_
mask>][,IPDFLTGATEWAY=<lci_default_gateway_ip_address>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.39 ED-IP Parameters

Parameter Value(s) Definition
lci_ip_address [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the local craft interface(LCI) port.

lci_default_gat [0-255].[0-255].[0-255].[0-255] Specifies the local craft interface default gateway IP address to
eway_ip_addr access the customer Telecom Network (DCN).
ess

lci_ip_network [0-255].[0-255].[0-255].[0-255] Specifies the IP network mask applicable.

_mask

Example
ED-IP:::AM0074:::IPADDRESS=172.112.121.4,IPNETMASK=255.255.255.0,
IPDFLTGATEWAY=172.112.121.12;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-361

13. Edit Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-IP

Page 30-362 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-IPPG

Command Changes Since Previous Feature Package

• None.

Description
The ED-IPPG command instructs the mTera network element to edit the attributes of an IP protection group on NP-
1.

Restrictions and Exceptions

• If the IPPG is associated with a TL, an attempt to change the IPPG state to OOS is denied unless FRCD
command mode is specified.

Command Format
ED-
IPPG:[tid]:<ippg_aid>:ctag:::[IPPGNAME=<IppgName>][,CMDMDE=<commandMode>][:<edit
ablePrimaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.40 ED-IPPG Parameters

Parameter Value(s) Definition
ippg_aid IPPG-1 EntityID-IPPGID

IppgName A double quoted string consisting of 0 Specifies the IPPG name.

to 30 printable characters, not
including the quotes. Refer to section 2 for the applicable characters.
Default: "" (empty string)

commandMod NORM Specifies the way in which the command is executed:.

e FRCD Enter NORM to specify a normal mode of execution (any state
inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
The following example changes the IPPG Name and Editable Primary State:
ED-IPPG:CORIANT1:IPPG-1:KTRP01:::IPPGNAME="DCN PROTECTION GROUP":IS;

76.MTFP50/30, Rev B January 2018 Page 30-363

13. Edit Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M KTRP01 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-IPPG
ENT-IPPG
RTRV-IPPG

Page 30-364 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-LABELSET

Command Changes Since Previous Feature Package

• None.

Description
The ED-LABELSET command instructs the Network Element (NE) to edit a label set object.

When a label(s) is added l into the label set object, label(s) appends at the end of the existing label set.

When a label(s) is removed from the label set object, label(s) removal can be performed in any order when the label
set is not used by a call, for removing multiple labels, the labels to be removed must be contiguous.

Restrictions and Exceptions

• The command is denied if the label set is already used by a CP Call.

• The ADD operation is denied if the specified interface(s) already exist(s) in the label set object.

• The ADD operation appends all the interfaces at the end of the existing label set object.

• The RMV operation deletes all the given interfaces in the existing label set object if interface matched,
otherwise the NE denies the command.

• The input parameter INGRSS or EGRSS must contain contiguous labels for the RMV operation.

• The "IfIndex" must be consistent/same with existing entry(ies) of Interfaces parameter.

• The "IfIndex" only and "IfIndex-Label" mixing entries are not allowed for Interfaces parameter.

• The INGRSS and EGRSS parameter is double quoted string.

• The INGRSS value can only be changed, if the SET_INGRSS is equal to "Y", otherwise the NE denies
the command.

• User can only change EGRSS value, if the SET_EGRSS is equal to "Y", otherwise the NE denies the
command.

• If INGRSS and EGRSS parameters are specified simultaneously, they should have the same number
of the interface entry(ies).

Command Format
ED-
LABELSET:[tid]:<Labelset_aid>:<ctag>:::OPER=<OperationType>[,INGRSS=<Interfaces>
][,EGRSS= <Interfaces>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-365

13. Edit Commands TL1 Command Reference Manual

Table 13.41 ED-LABELSET Parameters

Parameter Value(s) Definition
Labelset_aid LABELSET-3-[d] EntityID-NPID-LSID

OperationType ADD This parameter specifies the operation type when a label set is
RMV created.
1. ADD - Add interface(s) to the label set;
2. RMV - Remove interface(s) from the label set.

Interfaces A double quoted item sequence for the This parameter specifies the interfaces being added or deleted,
interfaces. Each item of interfaces is in depends on OperationType direction.
form of IfIndex-Label format: (1). Example:
interface is 8 hex numbers. (2). label is "110ABB11-00040000,110ABB11-00050000"
8 hex numbers.

Example
The following example shows inserting route element after label set already exisited.
ED-LABELSET:CORIANT1:LABELSET-3-1:AM0011:::OPER=ADD,INGRSS="110ABB11-
00040000,110ABB11-00050000",EGRSS="210CBB11-00040000,210CBB11-00050000";

Possible System Response

CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-LABELSET
ENT-LABELSET
RTRV-LABELSET

Page 30-366 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-LINKPF

Command Changes Since Previous Feature Package

• None.

Description
The ED-LINKPF command instructs the network element (NE) to edit a link profile. The link profile is referenced from
the TL and TSL entities.

System Interworking Considerations:

• When interworking between 7100 OTS/Nano and mTera UTP systems, the GMPLSMODE needs to be
set the same on both ends of the TDM link. It may be set to either INNI-V1 or INNI-V2.

• When interworking between 7100 OTS/Nano and mTera UTP systems in a network that also includes
hiT7300 systems, the GMPLSMODE should be set to INNI-V2 on the links between the 7100 OTS/Nano
and the mTera UTP.

• When interworking between mTera UTP and hiT7300 systems, the GMPLSMODE should be set to
INNI-V2-HTL and the ARUSUPPORT should be set to DISABLED on the links between the mTera UTP
and hiT7300 systems.

Restrictions and Exceptions

• The RtrDeadIntv must be a multiple of the HelloIntv.

• Link Profiles 1-20 are editable.

• This command is denied if this profile is referenced from a TL or TSL entity.

• The ARUSUPPORT is ENABLED for all default link profiles regardless of GMPLSMODE setting.

• The ARUSUPPORT can only be changed if and only if the link profile is not referenced from a TL or TSL
entity.

Command Format
ED-LINKPF:[tid]:<linkpf_aid>:ctag:::[PFNAME=<ProfileName>][,NAT=<NAT>]
[,HELLOINTV=<HelloIntv>][,RTRDEADINTV=<RtrDeadIntv>][,RETRANSINTV=<Retransmissio
nInterval>][,DEFSLPROF=<DefaultSLProfile>][,SLPOLICY=<SLPolicy>][,GMPLSMODE=<GMP
LSMode>][,ARUSUPPORT=<ARUSupport>][,G709MODE=<G709Mode>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.42 ED-LINKPF Parameters

Parameter Value(s) Definition
linkpf_aid LINKPF-[91-99,1-20] EntityID-LINKPFID

76.MTFP50/30, Rev B January 2018 Page 30-367

13. Edit Commands TL1 Command Reference Manual

Table 13.42 ED-LINKPF Parameters (Continued)

Parameter Value(s) Definition
ProfileName 0 to 31 alphanumeric characters. Specifies the Node name.
Refer to section 2 for the applicable characters.

NAT ENABLED Specifies if Network Address Translation (NAT) is enabled.

DISABLED

HelloIntv [1-255] Specifies the Hello Interval in seconds.

RtrDeadIntv [4-1024] Specifies the Router Dead Interval in seconds.

Retransmissio [1-255] Specifies the retransmission interval in seconds.

nInterval

DefaultSLProfil SLPF-[99,1-20] Specifies the default Service Level Profile.

e

SLPolicy SLPOLICY-[1-20] Specifies the default Service Level Profile

Enter NONE to set clear the value of this parameter.

GMPLSMode OIF-ENNI-V1 Specifies the GMPLS mode supported.

OIF-ENNI-V2
INNI-V1
INNI-V2
INNI-V2-HTL
NONE

ARUSupport ENABLED Specifies if the A-bit, R-bit and U-bit are set in the RSVP
DISABLED Protection Object.

ENABLED: The R-bit is set to zero and the U-bit is set to zero
during initial call setup.The R-bit is set to one and the U-bit
is set to zero during call restoration. The R-bit is set to zero and
the U-bit is set to one during ARR. The A-bit is set to zero at all
times.

DISABLED: The A-bit, R-bit and U-bit are all set to zero at all
times and these bits is silently ignored.

G709Mode V2 This attribute specifies the label format and controlling the
V3 switching capability type for ODU signals of the link.

Example
The following example modifies the GMPLS mode, supported with <linkpf_aid> set to
LINKPF-9, to OIF-ENNI-V1, and modifies ARUSupport to DISABLED.

ED-LINKPF::LINKPF-9:AM0011:::GMPLSMODE=OIF-ENNI-V1,ARUSUPPORT=DISABLED;

Possible System Response

CORIANT1 11-05-15 02:08:15
M AM0011 COMPLD
;

Default Link Profiles

The following tables provide the default Link profiles 91 to 99:

Page 30-368 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.43 Link Profile (LINKPF-91)

Keyword Default Value(s)
PFNAME NULL

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

SLPOLICY NONE

GMPLSMODE NONE

ARUSUPPORT ENABLED

G709MODE V3

Table 13.44 Link Profile (LINKPF-92)

Keyword Default Value(s)
PFNAME INNI V1

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

SLPOLICY NONE

GMPLSMODE INNI-V1

ARUSUPPORT ENABLED

G709MODE V3

Table 13.45 Link Profile (LINKPF-93)

Keyword Default Value(s)
PFNAME OIF ENNI V2

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

76.MTFP50/30, Rev B January 2018 Page 30-369

13. Edit Commands TL1 Command Reference Manual

Table 13.45 Link Profile (LINKPF-93) (Continued)

Keyword Default Value(s)
SLPOLICY NONE

GMPLSMODE OIF-ENNI-V2

ARUSUPPORT ENABLED

G709MODE V3

Table 13.46 Link Profile (LINKPF-94)

Keyword Default Value(s)
PFNAME NULL

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

SLPOLICY NONE

GMPLSMODE NONE

ARUSUPPORT ENABLED

G709MODE V2

Table 13.47 Link Profile (LINKPF-95)

Keyword Default Value(s)
PFNAME INNI V1

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

SLPOLICY NONE

GMPLSMODE INNI-V1

ARUSUPPORT ENABLED

G709MODE V2

Page 30-370 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.48 Link Profile (LINKPF-96)

Keyword Default Value(s)
PFNAME OIF ENNI V2

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

SLPOLICY NONE

GMPLSMODE OIF-ENNI-V2

ARUSUPPORT ENABLED

G709MODE V2

Table 13.49 Link Profile (LINKPF-97)

Keyword Default Value(s)
PFNAME IPv4 Internal

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

SLPOLICY NONE

GMPLSMODE NONE

ARUSUPPORT ENABLED

G709MODE V2

Table 13.50 Link Profile (LINKPF-98)

Keyword Default Value(s)
PFNAME IPv4 External

NAT ENABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

76.MTFP50/30, Rev B January 2018 Page 30-371

13. Edit Commands TL1 Command Reference Manual

Table 13.50 Link Profile (LINKPF-98) (Continued)

Keyword Default Value(s)
SLPOLICY NONE

GMPLSMODE NONE

ARUSUPPORT ENABLED

G709MODE V2

Table 13.51 Link Profile (LINKPF-99)

Keyword Default Value(s)
PFNAME OIF ENNI VI

NAT DISABLED

HELLOINTV 10

RTRDEADINTV 40

RETRANSINTV 5

DEFSLPROF SLPF-99

SLPOLICY NONE

GMPLSMODE OIF-ENNI-V1

ARUSUPPORT ENABLED

G709MODE V2

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

RTRV-LINKPF

Page 30-372 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-MGTETH

Command Changes Since Previous Feature Package

• None.

Description
The ED-MGTETH command instructs the network element (NE) to edit the attributes of a selected management
Ethernet facility entity.

Restrictions and Exceptions

• The command is denied if the RATE, FLOWCTRL, or DUPLEX parameters are set and AUTONEG is
ON.

• Primary state of the entity can only be modified with CMDMDE=FRCD when entity is associated with a
TL.

• Deletion of the MGTETH facility on mTera8 shelf is denied.

Command Format
ED-
MGTETH:[tid]:<fac_aid>:ctag:::[ALMPF=<almProfile>][,AUTONEG=<autoNeg>][,RATE=<et
hRate>][,DUPLEX=<duplexMode>][,FLOWCTRL=<flowCtrl>][MTU=<mtu>][,CMDMDE=<commandM
ode>][,ZTCASSIST=<assist_state>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.52 ED-MGTETH Parameters

Parameter Value(s) Definition
fac_aid MGTETH-20-[13,14,21,24,25,28]-[1-8] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

autoNeg ON Specifies if 802.3 auto-negotiation signaling is enabled (on) or

OFF disabled (off) on the management ETH facility.

ethRate 10 When auto-negotiation is off, specifies the manually configured

100 rate. When auto-negotiation is enabled, this parameter has no
1000 meaning.
10G
AUTO

76.MTFP50/30, Rev B January 2018 Page 30-373

13. Edit Commands TL1 Command Reference Manual

Table 13.52 ED-MGTETH Parameters (Continued)

Parameter Value(s) Definition
duplexMode FDPLX When auto-negotiation is off, specifies the manually configured
HDPLX duplex mode (full or half).When auto-negotiation is enabled, this
AUTO parameter has no meaning.

flowCtrl OFF When auto-negotiation is off, pecifies the type of flow control
TXRX support to be supported:
TX - OFF indicates no pause frames are supported
RX - TXRX indicates symmetric (transmit and receive)
- TX indicates transmit direction only
- RX indicates receive direction only
When auto-negotiation is enabled, this parameter has no
meaning.

mtu 576-1500 octets Specifies the maximum number of octets in the Information and
Padding fields.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

assist_state ENABLED Specifies the ZTC Assist state of the interface.

DISABLED When the ZTC Assist state is ENABLED, the NE can be the ZTC
Assist of the ZTC DUC attached to the port.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
Change the maximum advertised rate to 100 Mbps on a port that supports 10/100/1000BASE-T operation:

ED-MGTETH:CORIANT1:MGTETH-20-21-1:myctag:::RATE=100;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-MGTETH
ENT-MGTETH
RTRV-MGTETH

Page 30-374 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-MGTINBANDETH

Command Changes Since Previous Feature Package

• None.

Description
The ED-MGTINBANDETH command instructs the network element (NE) to provision an inband management
P2PVLAN facility on Packet module.

Restrictions and Exceptions

• The P2P management VLAN can only be created over the interface of CEP,PNP and PPNP port with
type of switch

Command Format
ED-MGTINBANDETH:[tid]:<mgtinbandeth_aid>:[CTAG]:::[LKTYPE=<lktype>],
[MTU=<mtu>],[ZTCASSIST=<assist_state>]:[<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>COMPLD<cr>lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.53 ED-MGTINBANDETH Parameters

Parameter Value(s) Definition
mgtinbandeth_ MGTINBANDETH-20-[10-16,1-7]-[1- EntityID-ShelfID-SlotID-PortID
aid 20]

lktype BROADCAST specifies the interface link type is point to point or boardcast
POINTTOPOINT

mtu 64-1500 octets Specifies the maximum number of octets in the Information and
Padding fields for transmission

assist_state ENABLED Specifies the ZTC Assist state of the interface.

DISABLED When the ZTC Assist state is ENABLED, the NE can be the ZTC
Assist of the ZTC DUC attached to the port.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
ED-MGTINBANDETH:CORIANT1:mgtinbandeth-20-7-13:MYCTAG::::oos;

76.MTFP50/30, Rev B January 2018 Page 30-375

13. Edit Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-MGTINBANDETH
ENT-MGTINBANDETH
RTRV-MGTINBANDETH

Page 30-376 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-NE

Command Changes Since Previous Feature Package

• Added PMALARMS parameter.

• Added support for OSM-4S and OSM-5C.

Description
The ED-NE command instructs the network element (NE) to edit some of its configuration parameters.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• String parameters must be used in quotes.

• The command mode parameter (CMDMDE) should always have the value FRCD for the following
parameters, otherwise the command should be denied: TYPE, STYPE, HWR, SPANA and SPANB. The
remaining parameters (NENAME, LOCATION, TIMEZONE and DSP) do not necessitate the FRCD
value to be modified.

• Any configuration parameter change using the FRCD mode results in a Controller Module (for example,
STPM) warm restart.

• The NE's PST must be OOS-MA, either in the same ED-NE command or as a precondition, in order to
change the configuration parameters with the FRCD mode.

• STSVCMODE parameter needs to be provisioned to indicate if the NE operates in SONET or SDH

mode.

• STSVCARCINTV parameter is used together with STSVCMODE to set ARC count down interval default
for STSn on an NE basis.

• For STS Path ARC, changing <stsvcarcintv> does not impact timer of entities that are in count down
state.

• If a copy switch or a restart of the shelf active controller (ex. STPM) occurs during the countdown
interval, the NE restarts the countdown timer for the STSn entities that were in countdown before the
reset.

• If STSVCARCINTV is changed and then a switch or restart of the shelf controllers occur, after the
switch/restart STSn entities that are countdown uses the new value.

• SYSALMPF parameter provides the default alarm profile table that applies to all entities in the NE,
unless the alarm profile table is modified for each entity via ENT- or ED- command. However entities
created prior to this parameter being set do not have their alarm profile table modified.

• Changing the CPINIT parameter from ALW to INH requires a warm/cold reset of the shelf controllers to
take effect.

• STSVCMODE can be changed as long as no port facilities are provisioned within an mTera network
element. Modification of the STSVCMDE does not result in a system reset for mTera network elements.

76.MTFP50/30, Rev B January 2018 Page 30-377

13. Edit Commands TL1 Command Reference Manual

Supported Configurations

Table 13.54 Supported Configurations

Cfg
Number Allowed
(in sw) type stype hwr SpanA Span B Reconfig
0a NA NA NA NA NA All
(UNKNOWN_SU
BNODE)

4 DC MTERA MTERA NA NA 0

Note:
a. 0 indicates that the database can be deleted and returned to UNKNOWN_SUBNODE configuration.

Command Format
ED-NE:[tid]::ctag:::[NENAME=<nename>][,TYPE=<type>][,STYPE=<stype>]
[,HWR=<hwr>][,SPANA=<spana>][,SPANB=<spanb>][,LOCATION=<location>][,SITE=<site>]
[,TIMEZONE=<timezone>][,DSP=<dsp>][,STSVCMDE=<stsvcmde>][,STSVCARCINTV=<stsvcarc
intv>][,SYSALMPF=<SysAlmProfile>][,CPINIT=<cpinit>][,CABLMISMCHK=<Cable_Mismatch
_Check>][,PMALARMS=<pmAlarms>][,CMDMDE=<commandMode>]:[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.55 ED-NE Parameters

Parameter Value(s) Definition
nename 0 to 64 alphanumeric characters. Specifies the name assigned to this particular NE.
Refer to section 2 for the applicable characters.

type DC Specifies the type of configuration of this NE.

NA Each NE type represents the Network configuration that the NE
is placed in.
DC: Direct Connect
NA: for Unknown configuration.

stype MTERA Specifies the subtype of the configuration of this NE. Refer to
"Supported Configurations" table for the values for each NE
configuration supported. For unknown configuration, this
parameter is set to NA.

hwr MTERA Specifies the Hardware Release used in the NE. Refer to
NA "Supported Configurations" table for the values for each NE
configuration supported. For unknown configuration, this
parameter is set to NA.

Page 30-378 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.55 ED-NE Parameters (Continued)

Parameter Value(s) Definition
spana NA Specifies the kind of input amplification used in the A direction.

NA: Not Applicable

spanb NA Specifies the kind of input amplification used in the B direction.

NA: Not Applicable

location 0 to 31 alphanumeric characters. Specifies the name of the location of this particular NE.

site 0 to 31 alphanumeric characters. Can be used to specify the name or CLLI of the site where this
NE is located.

timezone [1-75] Specifies the Time of Day Clock Daylight Time Zone Parameter
of this NE.
1: Eniwetok-Kwajalein [GMT-12:00]
2: Midway Island-Samoa [GMT-11:00]
3: Hawaii [GMT-10:00]
4: Alaska [GMT-09:00]
5: Pacific Time[US and Canada] [GMT-08:00]
6: Arizona [GMT-07:00]
7: Mountain Time [US and Canada] [GMT-07:00]
8: CentralAmerica [GMT-06:00]
9: Central Time [US and Canada] [GMT-06:00]
10: Mexico City-Tegucigalpa [GMT-06:00]
11: Saskatchewan [GMT-06:00]
12: Bagota-Lima-Quito [GMT-05:00]
13: Eastern Time [US and Canada] [GMT-05:00]
14: Indiana[East] [GMT-05:00]
15: Atlantic Time [Canada] [GMT-04:00]
16: Caracas-La Paz [GMT-04:00]
17: Santiago [GMT-04:00]
18: Newfoundland [GMT-03:30]
19: Brasilia [GMT-03:00]
20: Buenos Aires, Georgetown [GMT-03:00]
21: Greenland [GMT-03:00]
22: Mid-Atlantic [GMT-02:00]
23: Azores [GMT-01:00]
24: Cape Verde Is. [GMT-01:00]
25: Casablanca-Monrovia [GMT]
26: Greenwich Mean Time: Dublin-Edinburgh-Lisbon-London
[GMT]
27: Amsterdam-Copenhagen-Madrid-ParisVilnius [GMT+01:00]
28: Belgrade-Sarajevo-Skopje-Sofija-Zargreb [GMT+01:00]
29: Bratislava-Budapest-Ljublijana-Prague-Wasaw
[GMT+01:00]
30: Brussels-Berlin-Bern-Rome-Stockholm-Vienna
[GMT+01:00]
31: West Central Africa [GMT+01:00]
32: Athens-Istanbul-Minsk [GMT+02:00]
33: Bucharest [GMT+02:00]
34: Cairo [GMT+02:00]
35: Harare-Pretoria [GMT+02:00]

76.MTFP50/30, Rev B January 2018 Page 30-379

13. Edit Commands TL1 Command Reference Manual

Table 13.55 ED-NE Parameters (Continued)

Parameter Value(s) Definition
timezone [1-75] 36: Helsinki-Riga-Tallinn [GMT+02:00]
(continue) 37: Jerusalem [GMT+02:00]
38: Israel [GMT+02:00]
39: Baghdad [GMT+03:00]
40: Kuwait-Riyadh [GMT+03:00]
41: Moscow-St.Petersburg-Volgograd [GMT+03:00]
42: Nairobi [GMT+03:00]
43: Tehran [GMT+03:30]
44: Abu Dhabi-Muscat [GMT+04:00]
45: Baku- [GMT+04:00]46: Tbilisi [GMT+04:00]
47: Kabul [GMT+04:30]
48: Ekaterinburg [GMT+05:00]
49: Islamabad-Karachi-Tashkent [GMT+05:00]
50: Mumbai-Calcutta-Chennai-New Delhi [GMT+05:30]
51: Kathmandu [GMT+05:45]
52: Dhaka [GMT+06:00]
53: Almaty [GMT+06:00]
54: Colombo [GMT+06:00]
55: Rangoon [GMT+06:30]
56: Bangkok-Hanoi-Jakarta [GMT+07:00]
57: Beijing-Chongqing-Hong Kong-Urumqi [GMT+08:00]
58: Perth [GMT+08:00]
59: Singapore-Kuala Lumpur [GMT+08:00]
60: Taipei [GMT+08:00]
61: Osaka-Sapporo-Tokyo [GMT+09:00]
62: Seoul [GMT+09:00]
63: Yakutsk [GMT+09:00]
64: Adelaide [GMT+09:30]
65: Darwin [GMT+09:30]
66: Brisbane [GMT+10:00]
67: Canberra-Melbourne-Sydney [GMT+10:00]
68: Guam-Port Moresby [GMT+10:00]
69: Hobart [GMT+10:00]
70: Vladivostok [GMT+10:00]
71: Magadan-Solomon Is.-New Caledonia [GMT+11:00]
72: Auckland-Wellington [GMT+12:00]
73: Fiji-Kamchatka-Marshall Is. [GMT+12:00]
74: Nuku'alofa [GMT+13:00]
75: Kiritimati [GMT+14:00]

dsp ON Dayligth Saving Policy: Specifies the Time of Day

OFF Clock Daylight Saving Policy of this NE.

stsvcmde STS Specifies the operating mode of the NE. NE can operate in
VC SONET mode (value = STS) or in SDH mode (value=VC).

SysAlmProfile [0-20] or 99 Specifies the default alarm profile table for the NE.
This alarm profile is used by the system when entities are
automatically created and when no alarm profile table is
provided for explicitly created entities.

cpinit ALW Specifies the Transport Control Plane Initialization for the NE.
INH Enter ALW to allow the Transport Control Plane to initialize.
Default: ALW Enter INH to inhibit the Transport Control Plane from initializing.
Note, MCN and SCN is initialized even when CPINIT is INH.

Page 30-380 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.55 ED-NE Parameters (Continued)

Parameter Value(s) Definition
Cable_Mismat DISABLED Specifies the support of cable mismatch check on cable physical
ch_Check Default: DISABLED connection between transponder line port (OCH-P) and CDC
add/drop port on mTera UTP NE.

DISABLED: In the NE, transponder line port adds/drops through

MCS based CDC module without cable mismatch check.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the NE. Possible primary states
yState OOS include:
IS: In-Service
OOS: Out-of-Service

Example
ED-NE:CORIANT1::AM0074:::NENAME="WhateverName",LOCATION="Manhattan
1",TIMEZONE=13,DSP=OFF;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Example
ED-NE:CORIANT1::AM0075:::TYPE=DC,STYPE=MTERA,SYSALMPF=1,CMDMDE=FRCD:OOS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0075 COMPLD

Possible System Response

^^^CORIANT1 03-14-15 09:26:54
M CTAG COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-381

13. Edit Commands TL1 Command Reference Manual

Related Commands
RTRV-NE

Channel Plans Supported by mTera UTP network elements:

Table 13.56 88-Channel Plan, Wavelength/ChannelId Association

Channels 1-44 Channels 45-88

Frequency Wavelength Frequency Wavelength

Channel ID (THz) (nm) Channel ID (THz) (nm)
1 191.7 1563.863 45 191.75 1563.455

2 191.8 1563.047 46 191.85 1562.64

3 191.9 1562.233 47 191.95 1561.826

4 192 1561.419 48 192.05 1561.013

5 192.1 1560.606 49 192.15 1560.2

6 192.2 1559.794 50 192.25 1559.389

7 192.3 1558.983 51 192.35 1558.578

8 192.4 1558.173 52 192.45 1557.768

9 192.5 1557.364 53 192.55 1556.959

10 192.6 1556.555 54 192.65 1556.151

11 192.7 1555.747 55 192.75 1555.344

12 192.8 1554.94 56 192.85 1554.537

13 192.9 1554.134 57 192.95 1553.732

14 193 1553.329 58 193.05 1552.927

15 193.1 1552.525 59 193.15 1552.123

16 193.2 1551.721 60 193.25 1551.32

17 193.3 1550.918 61 193.35 1550.517

18 193.4 1550.116 62 193.45 1549.716

19 193.5 1549.315 63 193.55 1548.915

20 193.6 1548.515 64 193.65 1548.115

21 193.7 1547.716 65 193.75 1547.316

22 193.8 1546.917 66 193.85 1546.518

23 193.9 1546.119 67 193.95 1545.721

24 194 1545.322 68 194.05 1544.924

25 194.1 1544.526 69 194.15 1544.128

26 194.2 1543.731 70 194.25 1543.333

27 194.3 1542.936 71 194.35 1542.539

Page 30-382 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.56 88-Channel Plan, Wavelength/ChannelId Association (Continued)

Channels 1-44 Channels 45-88

Frequency Wavelength Frequency Wavelength

Channel ID (THz) (nm) Channel ID (THz) (nm)
28 194.4 1542.142 72 194.45 1541.746

29 194.5 1541.35 73 194.55 1540.953

30 194.6 1540.558 74 194.65 1540.162

31 194.7 1539.766 75 194.75 1539.371

32 194.8 1538.976 76 194.85 1538.581

33 194.9 1538.186 77 194.95 1537.792

34 195 1537.397 78 195.05 1537.003

35 195.1 1536.609 79 195.15 1536.216

36 195.2 1535.822 80 195.25 1535.429

37 195.3 1535.036 81 195.35 1534.643

38 195.4 1534.25 82 195.45 1533.858

39 195.5 1533.465 83 195.55 1533.073

40 195.6 1532.681 84 195.65 1532.29

41 195.7 1531.898 85 195.75 1531.507

42 195.8 1531.116 86 195.85 1530.725

43 195.9 1530.334 87 195.95 1529.944

44 196 1529.554 88 196.05 1529.163

A frequency between 191.35 THz and 196.1 THz in increments of 50 GHz can be specified, in the Direct Connect
provisioning of a 100G DWDM OCh interface on a module.

A channel ID from the 88 channel plan can be specified, in the Direct Connect provisioning of a 100G DWDM OCh
interface on a module.

Table 13.57 96-Channel Plan, Wavelength/ChannelId Association

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
90 191.4 1566.314 89 191.35 1566.723

92 191.5 1565.496 91 191.45 1565.905

94 191.6 1564.679 93 191.55 1565.087

1 191.7 1563.863 95 191.65 1564.271

2 191.8 1563.047 45 191.75 1563.455

3 191.9 1562.233 46 191.85 1562.64

4 192 1561.419 47 191.95 1561.826

5 192.1 1560.606 48 192.05 1561.013

76.MTFP50/30, Rev B January 2018 Page 30-383

13. Edit Commands TL1 Command Reference Manual

Table 13.57 96-Channel Plan, Wavelength/ChannelId Association (Continued)

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
6 192.2 1559.794 49 192.15 1560.2

7 192.3 1558.983 50 192.25 1559.389

8 192.4 1558.173 51 192.35 1558.578

9 192.5 1557.364 52 192.45 1557.768

10 192.6 1556.555 53 192.55 1556.959

11 192.7 1555.747 54 192.65 1556.151

12 192.8 1554.94 55 192.75 1555.344

13 192.9 1554.134 56 192.85 1554.537

14 193 1553.329 57 192.95 1553.732

15 193.1 1552.525 58 193.05 1552.927

16 193.2 1551.721 59 193.15 1552.123

17 193.3 1550.918 60 193.25 1551.32

18 193.4 1550.116 61 193.35 1550.517

19 193.5 1549.315 62 193.45 1549.716

20 193.6 1548.515 63 193.55 1548.915

21 193.7 1547.716 64 193.65 1548.115

22 193.8 1546.917 65 193.75 1547.316

23 193.9 1546.119 66 193.85 1546.518

24 194 1545.322 67 193.95 1545.721

25 194.1 1544.526 68 194.05 1544.924

26 194.2 1543.731 69 194.15 1544.128

27 194.3 1542.936 70 194.25 1543.333

28 194.4 1542.142 71 194.35 1542.539

29 194.5 1541.35 72 194.45 1541.746

30 194.6 1540.558 73 194.55 1540.953

31 194.7 1539.766 74 194.65 1540.162

32 194.8 1538.976 75 194.75 1539.371

33 194.9 1538.186 76 194.85 1538.581

34 195 1537.397 77 194.95 1537.792

35 195.1 1536.609 78 195.05 1537.003

36 195.2 1535.822 79 195.15 1536.216

37 195.3 1535.036 80 195.25 1535.429

38 195.4 1534.25 81 195.35 1534.643

Page 30-384 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.57 96-Channel Plan, Wavelength/ChannelId Association (Continued)

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
39 195.5 1533.465 82 195.45 1533.858

40 195.6 1532.681 83 195.55 1533.073

41 195.7 1531.898 84 195.65 1532.29

42 195.8 1531.116 85 195.75 1531.507

43 195.9 1530.334 86 195.85 1530.725

44 196 1529.554 87 195.95 1529.944

96 196.1 1528.773 88 196.05 1529.163

Configurations Supported by mTera UTP network elements:

Table 13.58 mTera Universal Transport Platform (UTP) Configuration #4

Configuration # 4
mTera Shelf
Slot # Module Slot # Module
1 1 17 MFAB, MFAB2, mMFM
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM
2 1 18 MFAB, MFAB2, mMFM
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM
3 1 19 MFAB, MFAB2, mMFM
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM
4 1 20 MFAB, MFAB2, mMFM
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM
5 1 21 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM SEIM, mSFM
6 1 22 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM SAIM, mSFM
7 1 23 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM mSFM , STIM
8 MFAB, MFAB2, mMFM 24 STPM
9 MFAB, MFAB2, mMFM 25 STPM
10 1 26 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM mSFM , STIM
11 1 27 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM mSFM
12 1 28 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM SEIM, mSFM
13 1 29 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM mFAN
14 1 30 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM mFAN
15 1 31 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM mFAN
16 1 32 1
mTRN, OADMRS-20, OADMRS-9, OCC, mBFM mFAN

76.MTFP50/30, Rev B January 2018 Page 30-385

13. Edit Commands TL1 Command Reference Manual

Configuration # 4
mTera Shelf
Slot # Module Slot # Module
33 SDM
34 FSM
35 FSM
1
Note :
mTRN = OSM-2C, OSM-2S, OSM-1S, SSM-2S, OSM-4C, OSM-4CE, OSM-4F, OSM-4FE, OSM-4S, OSM-4SE, OSM-
5C, OSM-5CE
mBFM = BFM (81.71B-MBFM-R6)
mSFM = SFM
mFAN = 81.71F-MFAN-R6
mMFM = MMFM (81.71B-MMFM-R6)

Table 13.59 mTera Universal Transport Platform (UTP) Configuration #4 (8-slot mTera)

Configuration # 4

8-slot mTera Shelf

Slot # Module Slot # Module

1 1 11 MFAB, MFAB2, mMFM
mTRN, OADMRS-9, mBFM
2 1 12 MFAB, MFAB2, mMFM
mTRN, OADMRS-9, mBFM
3 1 13 STPM-8
mTRN, OADMRS-9, mBFM
4 1 14 STPM-8
mTRN, OADMRS-9, mBFM
5 MFAB, MFAB2, mMFM 15 SIOM
6 MFAB, MFAB2, mMFM 16 1
mFAN
7 1 17 1
mTRN, OADMRS-9, mBFM mFAN
8 1
mTRN, OADMRS-9, mBFM
9 1
mTRN, OADMRS-9, mBFM
10 1
mTRN, OADMRS-9, mBFM
Note1 :
mTRN = OSM-2C, OSM-2S, OSM-1S, SSM-2S, OSM-4C, OSM-4CE, OSM-4F, OSM-4FE, OSM-4S,
OSM-4SE, OSM-5C, OSM-5CE
mBFM = BFM (81.71B-MBFM-R6)
mSFM = SFM
mFAN = 81.71F-M8FAN-R6
mMFM = MMFM (81.71B-MMFM-R6)

Page 30-386 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-NODE

Command Changes Since Previous Feature Package

• None.

Description
The ED-NODE command instructs the network element (NE) to edit the Node entity.
Note: the Node Id is not editable

Restricions and Exceptions

• String parameters must be used in quotes.

• The NE denies an attempt to modify the RoutingAreaAID if there are TLs provisioned on the target
NODE.

Command Format
ED-
NODE:[tid]:<node_aid>:ctag:::[NODENAME=<NodeName>][,RAAID=<RoutingAreaAID][:<edi
tablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.60 ED-NODE Parameters

Parameter Value(s) Definition
node_aid NODE-[1,3]-[1-512] EntityID-NPID-NodeID

NodeName A double quoted string consisting of 0 Specifies the Node name.

to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

editablePrimar IS Specifies the primary state of the entity.

yState OOS Two states are possible: In-Service (IS)
and Out-of-Service (OOS).

RouterAreaAI OSPFAREA-[1,3]-1-[1-32] Identifies the router area entity which represents the lowest
D routing area this node is participating in.
for example, OSPFAREA-3-1-1

Example
ED-NODE::NODE-3-1:AM0011:::RAAID=OSPFAREA-3-1-1;

76.MTFP50/30, Rev B January 2018 Page 30-387

13. Edit Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NODE
ENT-NODE
RTRV-NODE

Page 30-388 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-NP

Command Changes Since Previous Feature Package

• None.

Description
Use the ED-NP to modify the attributes of the Network Partition Entity.

Only calls that with inherited timeout value from the NP gets the timeout value updated when the NP's timeout value
is changed. Note that if the call was originally setup without providing a timeout value, and never been modified with
a new timeout value, then the timeout value of the call inherits that from the NP.

Restrictions and Exception

• String parameters must be used in quotes.

Command Format
ED-NP:[tid]:<np_aid>:ctag:::[NPNAME=<NpName>][,TIMEOUT=<Timeout>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.61 ED-NP Parameters

Parameter Value(s) Definition
np_aid NP-[1,3] EntityID-NPID

NpName A double quoted string consisting of 0 Specifies the Network Partition name.
to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

Timeout [120-900] Specifies the default timeout for a call setup request.

Example
ED-NP:CORIANT001:NP-3:AM0074:::NPNAME="TPCP Partition";

Possible System Response

Example1:
CORIANT001 06-05-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-389

13. Edit Commands TL1 Command Reference Manual

Related Commands
DLT-NP
ENT-NP
RTRV-NP
RTRV-NP-STATS

Page 30-390 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-NTPPEER

Command Changes Since Previous Feature Package

• None.

Description
The ED-NTPPEER command instructs the network element (NE) to edit the primary state of a NTP Peer entity and
modify its name if required.

Changing the primary State to OOS to one NTP Peer prevent this NTP Peer to be a source of clock synchronization.
Changing the primary State to OOS to both NTP Peers (when 2 NTP Peers are configured) makes the NE's TOD
clock to operate in "Free Run" instead of "External". This means that the NE is no longer synchronized to an external
NTP clock source.

Restrictions and Exceptions

• None

Command Format
ED-NTPPEER:[tid]:<ntppeer_aid>:ctag:::[PEERNAME=<NTPName>]:
[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.62 ED-NTPPEER Parameters

Parameter Value(s) Definition
ntppeer_aid NTPPEER-[2,1] EntityID-PeerID

NTPName 0 to 31 alphanumeric characters. Specifies the customer entered additional field to label the NTP
Peer.
Refer to section 2 for the applicable characters.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS - In-Service: IS
- Out-of-Service: OOS

Example
ED-NTPPEER:CORIANT1:NTPPEER-1:AM0074::::OOS;

76.MTFP50/30, Rev B January 2018 Page 30-391

13. Edit Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NTPPEER
ENT-NTPPEER
RTRV-NTPPEER

Page 30-392 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OCH

Command Changes Since Previous Feature Package

• Added OSM-4F 300G support using 2 x OCH-OS.

• Added support for OSM-4S.

Description
The ED-OCH command instructs the network element (NE) to edit some attributes of an Optical Channel Interface
(OCH) facility entity. There are different OCH facilities in a mTera UTP as shown in the figure "OCH supported on
mTera UTP ". This figure does not represent an actual system. It is to conceptualize the various OCH facilities in
the NEs.

Note that all OCH that are implicitly created are created In-Service except for the OCH-L facility. OCH-L facility is
implicitly created administratively OOS but iscome automatically In-service when involved in OCH cross-connection.
When the OCH cross-connection is deleted, it goes back to administratively OOS.

Figure 13.6 OCH supported on mTera UTP

The OCH-L is always located on the The OCH is on the OMD, CDCP.
first Module where the Line Side .. is used for cross-connection of alien transponder for
-It
(DWDM or OTS) Signal enters the OMD and CDCP
NE.
-It is also used for EVOA adjustment
on OADMRS/OADMRS9.

OCH-L OCH-L
OCH
OADMRS/OADMRS9

OMD, CDCP

OADMRS/OADMRS9
TRM

TRM

OCH-P/OCH-OS
The OCH-P/OCH-OS is always
located on transponders.
It identifies the DWDM
TRM=Transponder Module line side of transponder

THIS DRAWING DOES NOT REPRESENT AN ACTUAL SYSTEM. It is meant to conceptualize the several OCH types on the NE.

76.MTFP50/30, Rev B January 2018 Page 30-393

13. Edit Commands TL1 Command Reference Manual

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• String parameters must be used in quotes.

• If the optional parameters are not specified, the default value is no change to the current value

• The Trace attributes (EXPOTUTRC,OTUTRC and MONOTUTRC) are supported on OSM-2S and
OSM-2C transponders.

• The Trace attributes (EXPOPER,TXOPER and MONOTUTRC) are supported on OSM-2S/OSM-2C/

OSM-4S transponders.

• FECTYPE is configurable when the supporting module is OSM-2S, OSM-2C, and OSM-4S.

• The OSM-2S/OSM-4S supports 4 FEC types: 1) Regular G.709 FEC; 2) Super FEC (I.4 EFEC); 3)
SuperI7 FEC (I.7 EFEC); or 4) NOFEC.
The Super FEC is an enhanced Forward Error Correction Scheme (I.4 EFEC) that provides superior
Error correction capabilities than the Generic FEC (GFEC) (which is called Regular FEC). The Regular
FEC is G.709 compliant with a 6.2 dB coding gain (at 10e-15 BER). The Super FEC is G.709 I.4
complaint and provides >8 dB coding gain @ 10e-15 BER. The NOFEC option disable FEC
processing.The SuperI7 FEC is an additional enhanced FEC alternative for providing greater coding
gain than Regular FEC.

• On OSM-2S, the Super FEC provisioning for a group of ports must be the same (for example, SUPER
- I.4 EFEC or SUPERI7 - I.7 EFEC). The system denies an attempt to provision the FECTYPE as
SUPER or SUPERI7 if one of the ports in the group is already provisioned for a different SUPER/
SUPERI7 value. The port groups are: 1-4, 5-8, 9-10, 11-14, 15-18 and 19-20.

• For OSM-4C OCH-OS, it supports 15% Soft-Decision FEC (SOFT) and is not configurable. The
FECTYPE parameter cannot be included in the command. If FECTYPE is included in the command
input, the command is denied.

• For OSM-4F OCH-OS, it supports 25% Soft Decision FEC (SOFT25EFEC) for all modulation formats
(100GQPSK, 200G16QAM and 2x150G8QAM) and is not configurable. The FECTYPE parameter
cannot be included in the command. If FECTYPE is included in the command input, the command is
denied.

• For OSM-4C, it supports modulation format 100GQPSK and is not configurable. The MODUFMT
parameter cannot be included in the command. If MODUFMT is included in the command input, the
command is denied.

• For OSM-4F, the modulation format governs the possible subtended OTU and ODU layer entities of the
OCH-OS facility. For modulation format 100GQPSK, the OCH-OS contains OTU4 and the subtending
ODUk entities; for modulation format 2X150G8QAM, the OCH-OS contains OTUC3, ODUC3 and the
subtending ODUk entities; for modulation format 200G16QAM, the OCH-OS contains OTUC2, ODUC2
and the subtending ODUk entities. To change the modulation format, the OCH-OS should not have any
subtending OTUC2, OTU4 and ODUk entities. If the subtending OTUCn (n=2,3), OTU4 and ODUk
entities exist, they must also be deleted first.

• For OSM-4F, the two OCH-OS facilities must have the same modulation format setting. If both OCH-
OS facilities exist, editing the modulation format for one OCH-OS facility is not allowed and the
command is denied. In such scenario, one must delete one OCH-OS to allow editing of the modulation
format of the remaining OCH-OS.

• For OSM-4F, the modulation format cannot be changed when the OCH-OS is involved in a cross-
connection, unless CMDMDE=FRCD is used.

Page 30-394 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

• For OSM-4F, when the modulation format is changed, the transmit power does not change. A new
transmit power value must manually configured if desired. (The default transmit power is only applicable
when ENT-OCH command is used to create the OCH-OS)

• For OSM-4F, for modulation format 2x150G8QAM, it uses two OCH-OS facilities and are deemed
'coupled'. Each of the OCH-OS facility can be edited but some of the parameters are considered
'coupled-parameters'. These include: ALMPF, FECTYPE, MODUFMT, ROLLOFF.
- For these 'coupled-parameters', they are mastered on OCH-OS on port#1
- Value of the 'coupled-parameter' edited for OCH-OS on port#1 is automatically propagate to the same
parameter for OCH-OS on port#2 if the command is successful
- Inclusion of any of these 'coupled-parameters' in the editing of OCH-OS on port#2 is optional. If
included, the value entered must be the same as the corresponding parameter for OCH-OS on port#1,
otherwise, the command is denied.

• FECTYPE parameter value on both near-end and far-end transponders must be set to the same value.

• When EXTCHAN={1-88} or {191350000-196100000} or {191338750-196111250} or {191150000-

196100000}, line side laser is activated in the same manner that the OCH-L to OCH-P/OCH-OS cross-
connection provides when EXTCHAN=NA.

• Editing of EXTCHAN is denied if a FIBR connection exists to the OCH-P facility of a transponder.

• The CMDMDE=FRCD must be used to edit any parameter for the OCH entity if the entity is owned by
the control plane.

• CLOCKTYPE may not be altered if the ODU has already been mapped to the OCHP. This restriction
does not apply to the OSM-2C.

• The FECTYPE cannot be modified if the OCH-P is involved in a cross-connection, unless

CMDMDE=FRCD is used.

• An attempt to modify EXTCHAN is denied after OCH-P TSL has been created

• Edit the NPOWNER of an OCH/OCH-L facility is denied when the OCH/OCH-L CTPs associated with
cross-connection, this is independent of the cross-connect initiated from MP or CP.

• The CMDMDE=FRCD must be used to edit the ownership for the OCH/OCH-L facilities.

• If GRIDMODE=FIXED88_7100 on OADMRS/OADMRS9, the attempt to provision FREQ of the OCH-L

to a different value defined by channel plan is denied. Frequency of an OCH-L is decided by last
modifier number of the OCH-L AID per 7100 88 channel plan.

• If GRIDMODE=FIXED44_7100 on OADMRS/OADMRS9, the attempt to provision FREQ of the OCH-L

to a different value defined by channel plan is denied. Frequency of an OCH-L is decided by last
modifier number of the OCH-L AID per 7100 44 channel plan.

• If GRIDMODE=FIXED96_MTERA on OADMRS/OADMRS9, the attempt to provision FREQ of the

OCH-L to a different value defined by channel plan is denied. Frequency of an OCH-L is decided by last
modifier number of the OCH-L AID per mTera 96 channel plan.

• If GRIDMODE=FIXED96_NOCHANPLAN, the attempt to change FREQ is denied when the OCH-L is

involved in cross connection.

• The attempt to change FREQ of an OCH-L on OADMRS/OADMRS9 is denied when the OCH-L is
involved in a cross connection.

• The attempt to provision FREQ of an OCH-L with same frequency as any other OCH-L on the same
OADMRS/OADMRS9 is denied.

• On mTera UTP NE, the attempt to change CLOCKTYPE of an OCH-P is denied if the OCH-P has
associated with OCH cross connection.

76.MTFP50/30, Rev B January 2018 Page 30-395

13. Edit Commands TL1 Command Reference Manual

• For Operator Specific TTI trace, by default the OTUTRC and EXPOTUTRC is taking effective if there is
no explicitly provisioned TXOPER or EXPOPER value.

• On the same OCH-P entity for modules supported on mTera, an attempt to provision TXOPER or
EXPOPER is denied when OTUTRC or EXPOTUTRC provisioned already with an Operator Specific
value and the value is not empty.

• On the same OCH-P entity for modules supported on mTera, an attempt to provision TXOPER or
EXPOPER is denied when OTUTRC or EXPOTUTRC provisioned already with an Operator Specific
value and the value is not empty.

• On OADMRS/OADMRS9, when OTSMODE=MTERA or HIT7300, an attempt to set AAMINGR or

AAMEGR is denied due to the fact that these parameters are controlled by the OCHAAMINGR and
OCHAAMEGR parameters at the OMS level for these OTSMODEs.
- When OCHAAMING is set to AUTO at the OMS, all OCH-Ls within the OMS shows AAMINGR in
RTRV-OCH as AUTO. When OCHAAMINGR is set to MAN at the OMS, all OCH-Ls within the OMS
shows AAMINGR in RTRV-OCH as MAN.

• When OTSMODE=7100 an attempt to set AAMINGR be denied.

• An attempt to enter a value for OMSPWRCORR or INGRPWRCORR on an OCH-L that is associated

with an OTS with OTSMODE=7100 is denied since these parameters are not applicable in
OTSMODE=7100.

• Changing the CLOCKTYPE to OTU4FEC15 automatically changes the FECTYPE to SOFT. Changing
the CLOCKTYPE to OTU4FEC21 automatically changes the FECTYPE to SOFT21GFEC.

• Parameter ROLLOFF is only applicable for OCH-OS on OSM-4F. The applicable values are 0.2 or 0.8.
If the parameter is present for other OCH entities (OCH, OCH-L, OCH-P, or OCH-OS on OSM-4C), the
command is denied.

Table 13.63 FECTYPE By Module

FECTYPE
Module Type NOFEC REGULAR SUPER SUPERI7 SOFT SOFT21GFEC SOFT25EFEC

OSM-2S X X X X

OSM-2C CLOCKTYPE= CLOCKTYPE=

OTU4FEC15 OTU4FEC21

OSM-4C X

OSM-4F MODUFMT=100
GQPSK
or
MODUFMT=2x1
50G8QAM
or
MODUFMT=200
G16QAM

OSM-4S X X X X

Command Format
ED-
OCH:[tid]:<och_aid>:ctag:::[,ALMPF=<almProfile>][,EXTCHAN=<ExtChan>][,CONNECTED=
<ConnectedTo>][,FECTYPE=<fecType>][,EXPOTUTRC=<OTUExpTrc>][,OTUTRC=<OTUTrc>][,MO
NOTUTRC=<OTUMonTrc>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSA
PI>][,TXOPER=<TxOperator>][,TXDAPI=<txDAPI>][,TXSAPI=<txSAPI>][,TIMDEF=<TIMdefin

Page 30-396 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ition>][,CLOCKTYPE=<ClkType>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_thresho
ld>][,CMDMDE=<commandMode>][,NPOWNER=<NpOwner>][,AAMEGR=<AttAdjModeEgress>][,AAM
INGR=<AttAdjModeIngress>][,FREQ=<frequency>][,MODUFMT=<ModulationFormat>][,TXPWR
=<TransmitPower>][,ROLLOFF=<rolloff>][,INGRPWRCORR=<in_pwr_correct>][,OMSPWRCORR
=<oms_pwr_correct>]:[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters Applicability when Entering the Command

Table 13.64 Parameters Applicability when Entering the Command

PARAMETER DEFa OCH OCH-L OCH-P OCH-OS
AAMEGR ND X

AAMINGR ND X

ALMPF ND X X X X

CLOCKTYPE ND Xb

CONNECTED ND Xc X X

EXPOPER ND X

EXPDAPI ND X

EXPSAPI ND X

EXPOTUTRC ND X

EXTCHAN ND X X

FECTYPE ND X

FREQ ND X

MONOTUTRC ND X

OTUTRC ND X

TIMDEF ND X

TXDAPI ND X

TXSAPI ND X

TXOPER ND X

DEGM ND X

DEGTHR ND X

CMDMDE ND X X X X

NPOWNER ND X X

MODUFMT ND X Xd

TXPWR ND X

76.MTFP50/30, Rev B January 2018 Page 30-397

13. Edit Commands TL1 Command Reference Manual

Table 13.64 Parameters Applicability when Entering the Command (Continued)

PARAMETER DEFa OCH OCH-L OCH-P OCH-OS
ROLLOFF ND Xd

INGRPWRCORR ND X

OMSPWRCORR ND X

PST PD X X X X

a. ND: Name Defined or PD: Position Defined.

b. Applies to OCH-P supported by OSM-2S only when no ODU2 is mapped to the
corresponding OCH-P. Also applies to OCH-P on OSM-2C, OSM-4S.
c. Applies to CDCP, OMD only.
d. Applies to OSM-4F only. Not applicable to OCH-OS on OSM-4C.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.65 ED-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Page 30-398 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.65 ED-OCH Parameters (Continued)

Parameter Value(s) Definition
ExtChan (1)NA (2)1 to 88 (3)191350000 to Specifies the DWDM Channel number or frequency at which the
196100000 in increments of 50000 (4) interface operates and enables the transmit laser when set to a
191338750 to 196111250 in increment non-NA value.
of 125 (5) 191150000 to 196100000 in
increments of 500 Values of 1-88 represent the channel ID in the 88 channel plan
where each channel ID has an associated frequency. Values of
191350000 to 196100000 in increments of 50000 represents the
frequency in MHz in increments of 50 GHz and covers 96
channels. Values of 191338750 to 196111250 in increments of
125 represents the frequency in MHz in increments of 125 MHz
and covers 96+ channels. Values of 191150000 to 196100000
in increments of 500 represents the frequency in MHz in
increments of 500 MHz and covers 96+ channels.

The OSM-2C Tunable CFP supports values of 1 to 88 and

191350000 to 196100000.
The OSM-4C Tunable optics supports values of 1 to 88 and
values of 191338750 MHz to 196111250 MHz in steps of 125
MHz.
The OSM-4F Tunable optics supports values of 1 to 88 and
191150000 to 196100000 MHz in steps of 500 MHz.
All other modules support values of 1 to 88.

This parameter is used when directly connecting the module to a

separate network element, rather than connecting to an optical
multiplexer/demultiplex module within the same network
element where the channel is provisioned with an OCH-L to
OCH-P OEO Regeneration crossconnection. When the ExtChan
value is NA, the transmit laser is either disabled and no channel
has yet been selected, or the optical channel is involved in an
OCH-L to OCH-P/OCH-L cross-connection where the frequency
is set based on the OCH-L.

ConnectedTo 0 to 36 characters, inclusive. This attribute can be used to indicate remote NE TID & Module/
Facility AID to which the current facility is connected.

This parameter applies to:

1) OCH facility on the Add/Drop port of a CDCP, OMD, when it
was explicitly created for connection to Non-Coriant
transponder.
2) OCH-P/OCH-OS facility on a transponder which is connected
to external equipment.

Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-399

13. Edit Commands TL1 Command Reference Manual

Table 13.65 ED-OCH Parameters (Continued)

Parameter Value(s) Definition
fecType REGULAR Specifies the type of Forward Error Correction on the OCH-P/
NOFEC OCH-OS facility.
SUPER
SUPERI7 OTU2 and OTU2e based OCH-P interfaces
SOFT (CLOCKTYPE=G709,OVRCLK_FS) support the following
SOFT21GFEC values:
SOFT25EFEC NOFEC = FEC processing disabled.
REGULAR = G.709 compliant GFEC with a 6.2dB coding gain
(at 10e-15 BER).
SUPER = G.975.1 I.4 complaint EFEC with >8 dB coding gain@
10e-15 BER.
SUPERI7 = G.975.1 I.7 complaint EFEC with >8 dB coding
gain@ 10e-15 BER.

OTU4v with 15% FEC Overhead based OCH-P interfaces

(120.579 Gbps, CLOCKTYPE=OTU4FEC15) support only the
SOFT option which is a proprietary Soft-Decision FEC using
15% overhead that provides 11.1 dB of coding gain at 10e-15
BER.

OTU4v with 21% FEC Overhead based OCH-P interfaces

(127.156 Gbps, CLOCKTYPE=OTU4FEC21) support only the
SOFT21GFEC option which is a proprietary Soft-Decision +
GFEC combination using 21% FEC overhead that provides 10.5
dB of coding gain at 10e-15 BER.

For OSM-4F OCH-OS, only the 25% FEC Overhead

(SOFT25EFEC) is applicable. This is for all OSM-4F supported
modulation formats (MODUFMT=100GQPSK, 200G16QAM and
2x150G8QAM).

For OSM-4C OCH-OS, only the 15% FEC Overhead (SOFT) is

applicable.

OTUExpTrc One to 28 alphanumeric characters Specifies the expected trace value in the Operator Specific area
of the OTU trail trace identifier.
All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id expected.
Refer to section 2 for the applicable characters.

OTUTrc One to 28 alphanumeric characters Specifies the transmitted trace value in the Operator Specific
area of the OTU trail trace identifier.
All printable characters are allowed except for the semi-colon
and double quote. A value of "," means that there is no Trail
Trace Id sent. When this field is empty, the Default OTU Trace
value is sent.

Refer to section 2 for the applicable characters.

OTUMonTrc ENABLED-AIS Specifies the monitored OTU trace identification mode.

ENABLED-NOAIS - Enter ENABLED-AIS to enable monitoring and insert AIS on
DISABLED the port side (TDTC direction) when there is a OTU Trace
mismatch.
- Enter ENABLED-NOAIS to enable monitoring but not insert
AIS.
- Enter DISABLED to disable monitoring.
Default is DISABLED.

Page 30-400 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.65 ED-OCH Parameters (Continued)

Parameter Value(s) Definition
ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.Refer to section 2 for the
applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
All the characters listed are allowed except for the semi-colon
and double quote.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
All the characters listed are allowed except for the semi-colon
and double quote.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
All the characters listed are allowed except for the semi-colon
and double quote.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
All the characters listed are allowed except for the semi-colon
and double quote.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

ClkType G709 Specifies the rate of the OCH-P (OTU4) on OSM-2C:

OVRCLK_FS OTU4FEC15: 120.579 Gbps (OTU4v with 15% FEC Overhead
OTU4FEC15 supported by the 71T-CDWDMS series of Tunable CFPs)
OTU4FEC21 OTU4FEC21: 127.156 Gbps (OTU4v with 21% FEC Overhead
supported by the 71T-CDWDMS2 series of Tunable CFPs)

Specifies the rate of the signal on OSM-2S/OSM4S:

G709: 10.709 Gbps (ODU2 based)
OVRCLK_FS: 11.096 Gbps (ODU2e based)

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-856388] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 82026, default of 12304 (ODU2 based)
1 to 84986, default of 12748 (ODU2e based)
1 to 856388, default of 128459 (ODU4 based)

76.MTFP50/30, Rev B January 2018 Page 30-401

13. Edit Commands TL1 Command Reference Manual

Table 13.65 ED-OCH Parameters (Continued)

Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

NpOwner NONE Specifies which network partition owns this entity.

By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

AttAdjModeEg AUTO Indicates the attenuation adjustment mode at egress side of

ress MAN module.

For select side per channel attenuation control of OADMRS/

OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

MAN indicates the facility is on manual adjustment.

AttAdjModeIng AUTO Indicates the attenuation adjustment mode at ingress side of

ress MAN module.

For select side per channel attenuation control of OADMRS/

OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

MAN indicates the facility is on manual adjustment.

frequency From 191350000 to 196100000 with Indicates the center frequency (Mbps) of the OCH-L channel.
increment 50000
Applicable to all OCH-L entities of mTera UTP NE.

Under specific GRIDMODEs, only corresponding frequency

values are valid on an OCH-L:
If GRIDMODE = FIXED88_7100, default value defined per 88
channel plan related to the ID of the OCH-L.
If GRIDMODE = FIXED44_7100, default value defined per 44
channel plan related to the ID of the OCH-L.
If GRIDMODE = FIXED96_MTERA, default value defined per 96
channel plan related to the ID of the OCH-L.

Page 30-402 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.65 ED-OCH Parameters (Continued)

Parameter Value(s) Definition
ModulationFor UNKNOWN Specifies the modulation format of the optical channel on the
mat 10GOOK Och-OS and OCH facilities.
40GQPSK
50GBPSK Och-OS on OSM-4F:
100GQPSK - Supports 100GQPSK, 2X150G8QAM or 200G16QAM
2X150G8QAM - When 100GQPSK is selected, the OCh-OS facility supports a
200G16QAM single OTU4 entity;
- When 2X150G8QAM is selected, two OCh-OS facilities are
required and support a single OTUC3, a single ODUC3 and 3 x
ODU4 entities;
- When 200G16QAM is selected, the OCh-OS facility supports a
single OTUC2, a single ODUC2 and 2 x ODU4 entities.
Note: different modulation formats can have different desired
transmit power values. When the modulation format of the OCh-
OS facility is changed, the system does not automatically
change the transmit power value. Ensure the proper transmit
power value is also configured. In the case the default transmit
power value of the corresponding modulation format is used,
please consult the ENT-OCH command.

Och-OS on OSM-4C:
- Not configurable.

OCH:
Any of the following modulation formats can be provisioned for
alien wavelengths.
UNKNOWN
40GQPSK
10GOOK
2X150G8QAM
200G16QAM
100GQPSK
50GBPSK

TransmitPowe [-2000 to 4500] Unit is in thousandths Specifies the Transmit output power of the Och-OS facility.
r of dBm. Incremental step of 100. Applicable for OSM-4F and OSM-4C only.
For OSM-4F:
- Tx Power range: -2 dBm ... + 4.5 dBm, step 0.1 dBm

For OSM-4C:
- Tx Power range: -2 dBm ... +1 dBm, step 0.1 dBm

rolloff 0.2 Specifies the roll-off factor of the signal which affects the pulse
0.8 shape.
For OCH-OS on OSM-4F only, default=0.2. applicable = 0.2 or
0.8

in_pwr_correct -999 to 200 (dB/10) Specifies a power correction value for an optical channel.
Applies to the complete optical path and is set at the ingress
point to the APC domain.

oms_pwr_corr -999 to 200 (dB/10) Specifies a power correction value for an optical channel for
ect each preemphasis section.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

76.MTFP50/30, Rev B January 2018 Page 30-403

13. Edit Commands TL1 Command Reference Manual

Table 13.65 ED-OCH Parameters (Continued)

Parameter Value(s) Definition
txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.Refer to section 2 for the
applicable characters.

Example: Change FEC type on OCH-P to G.975 I.7 EFEC

ED-OCH:CORIANT1:OCH-P-20-1-1:AM0074:::FECTYPE=SUPERI7:IS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-OCH
DLT-OCH
RTRV-OCH

Page 30-404 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OCn/STMn

Command Changes Since Previous Feature Package

• None.

Description
The ED-{X} command instructs the network element (NE) to edit the attributes of a selected facility entity. Refer to
the table below for the facilities can be edited on transponders.

Table 13.66 Facilities Supported By Transponders

Facilities--> OC3/ OC12/ OC48/ OC192/
Transponders STM1 STM4 STM16 STM64/
OSM-1S X X X

OSM-2S X

SSM-2S X X X X

{X} specifies the facility type among the following:

• Facilities (fac_type): OC3, OC12, OC48, OC192, STM1, STM4, STM16, STM64.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• String parameters must be used in quotes.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• Trace functionality (J0) should be available when the supporting module is a SSM-2S (EXPTRC,
MONTRC, TRC on OCn facilities).

• OSM-2S provides transparent transport of SONET signals and may only monitor the J0 trace message
non-intrusively. OCn port facilities support INCTR, CEXPTRC and MONTRC parameters. The J0
message cannot be altered, only read and optionally compared to an expected value.

• The parameter PROT is not supported on OSM-1S.

• The parameter PROT is supported on SSM-2S.

• An OC192/STM64 is mapped to ODU2 directly if the ODUk is created on the same physical port on
OSM-2S.

• An OC192/STM64 is mapped to ODU2 directly if the ODUk is created on the same port on SSM-2S.

• OC3/STM1, OC12/STM4 is mapped to ODU0 directly if the ODUk is created on the same physical port
on OSM-1S.

• OC48/STM16 is mapped to ODU1 directly if the ODUk is created on the same physical port on OSM-1S.

• OC48/STM16 is mapped to ODU1 directly if the ODUk is created on the same port on SSM-2S.

• For an OCn/STMn on an OSM-2S/OSM-1S, the TRANSPARENT parameter is always set to YES

because there is no SONET/SDH path layer management supported on this transponder.

76.MTFP50/30, Rev B January 2018 Page 30-405

13. Edit Commands TL1 Command Reference Manual

• For an OCn/STMn on an SSM-2S, the TRANSPARENT parameter is always set to NO because there
is always SONET/SDH path layer management supported on this module.

• The CMDMDE=FRCD must be used to edit any parameters for the OCn facilities if the facility is owned
by the control plane.

• Command is denied when changing CBRMAP unless the facility (which supports CBRMAP parameter)
is OOS.

• On mTera SSM-2S working module that is in EPG group, edit OCn/STMn facility associated with virtual
port 99 on backplane would implicitly edit STMn facility associated with virtual port 99 on backplane on
protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to edit OCn/STMn facility
associated with virtual port 99 on backplane would be denied.

Command Format
ED-
{fac_type}:[tid]:{fac_aid}:ctag:::[,TRC=<trc>][,EXPTRC=<exptrc>][,MONTRC=<montrc
>][,PROT=<protection>][,SFTHRESH=<SFThreshold>][,SDTHRESH=<SDThreshold>][,AISTYP
E=<AISType>][,CBRMAP=<cbrMap>][,ALMPF=<almProfile>][,CMDMDE=<commandMode>][,SSMS
UPP=<ssmSupported>][,QL=<qualityLevelOverride>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Table 13.67 Parameters Applicability When Entering the Command

PARAMETER DEFa OSM-1S OSM-2S SSM-2S
EXPTRC ND O O O

MONTRC ND O O O

TRC ND O

SFTHRES ND O

SDTHRES ND O

SSMSUPP ND O

QLOVERRIDE ND O

PROT ND O Oc

AISTYPE ND O O

CBRMAP ND Ob Ob Ob

ALMPF ND O O O

CMDMDE ND O O O

PST PD O O O

Page 30-406 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.67 Parameters Applicability When Entering the Command (Continued)

PARAMETER DEFa OSM-1S OSM-2S SSM-2S
a. ND: Name Defined or PD: Position Defined.
b. Applicable only to OC48/STM16 on OSM-1S, OC192/STM64 on OSM-2S,
and OC48/STM16/OC192/STM64 demapped from ODUk on SSM-2S.
c. Not applicable to OC48/STM16/OC192/STM64 demapped from ODUk on
SSM-2S.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.68 ED-OCn/STMn/TGBEP Parameters

Parameter Value(s) Definition
fac_aid OC12-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]

trc One to 15 alphanumeric characters Specifies the sent trail trace identification (J0) for STMn. A value
of "" means that there is no Trail Trace Id sent.

Refer to section 2 for the applicable characters.

exptrc One to 15 alphanumeric characters Specifies the expected trail trace identification (J0).
A value of "" means that there is no Trail Trace Id expected.

Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored J0 trace identification mode.

DISABLED - Enter ENABLED-NOAIS to enable J0 monitoring coming from
the port side but not insert AIS when there is a trace mismatch
(signal is passed through intact).
- Enter DISABLED to disable J0 monitoring.

protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.

Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending an maintenance
signal (for example, AIS) when there is a signal failure detected
on the line side of a transponder.

Setting the value to NO does not shut down the laser. When this
value is set standard maintenance signaling is used.

This parameter applies only to OCn/STMn facilities supported

by OSM-2S.

76.MTFP50/30, Rev B January 2018 Page 30-407

13. Edit Commands TL1 Command Reference Manual

Table 13.68 ED-OCn/STMn/TGBEP Parameters (Continued)

Parameter Value(s) Definition
cbrMap SYNC Specifies the mapping type of the constant bit rate signal into an
ASYNC OPU, either bit-synchronously (SYNC) or asynchronously
(ASYNC).

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

ssmSupported YES It is used to indicate whether this facility supports SSM

NO generation or not.
Default: YES Yes: the transmitted QL is based on synchronization selection
process. (default)
NO: the transmitted QL of the facility is forced to DNU/DUS.

qualityLevelOv DISABLED It is used to overwrite the incoming QL by operator, When set to

erride PRS 'disable', the system uses the SSM value received in the
ST2 synchronization status message.
TNC DISABLED (default)
ST3E QL value:
ST3 Option II: QL-PRS, QL-ST2, QL-TNC, QL-ST3E, QL-ST3, QL-
SMC SMC, QL-ST4, QL-PROV, QL-DUS
ST4 Option I: QL-PRC, QL-SSU-A, QL-SSU-B, QL-SEC, QL-DNU
PROV
DUS
PRC
SSU-A
SSU-B
SEC
DNU
Default: DISABLED

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

AIStype AISL When a network failure occurs, AIS is transmitted out of the
GENAIS OCn port to suppress subsequent LOS or LOF alarms on
SONET connected equipment.
There are two types of signals which may be inserted. A setting
of AISL inserts client based AISL out of the port per GR.253. A
setting of GENAIS inserts a generic AIS signal based on a PN-
11 sequence per ITU-T G.709.

Example 1:Editing an in service OC3 out of service.

ED-OC3:CORIANT1:OC3-20-11-1:AM0074:::CMDMDE=FRCD:OOS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Page 30-408 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example 5: Configure OC48 Facility as System timing source, without QL overrided in

ingress side and without force QL in egress side
Configure the OC-48 port's output SSM information to be from system
synchronization process, and incoming QL is not overrided.

ED-OC48:CORIANT1:OC48-20-1-4:ctag:::SSMSUPP=YES, QLOVERRIDE=DISABLED;

Example6: Configure STM16 Facility as System timing source, with QL overrided in

ingress side and with force QL in egress side
Configure the STM16 port's output SSM information to be forced as DNU, and incoming
QL is overrided with QL-SEC:

ED-STM16:CORIANT1:STM16-20-1-4:ctag:::SSMSUPP=NO, QLOVERRIDE=QL-SEC;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ENT-{X}
RTRV-{X}

76.MTFP50/30, Rev B January 2018 Page 30-409

13. Edit Commands TL1 Command Reference Manual

ED-ODUF

Command Changes Since Previous Feature Package

• Updated for ODUF Size Change in Hybrid Mode.

• Added support of ODUF mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S and OSM-5C.

Description
The ED-ODUF command instructs the Network Element (NE) to edit the attributes of an ODUF.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• This command is supported for OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S and OSM-5C.

• There must be a non-OTU client mapped to an ODUF that is cross-connected in order to set the
TXSAPI, TXDAPI, or TXOPER.

• TRIBSLOT must be specified when ODUF is muxed to an ODU2.

• CMDMDE=FRCD must be used to modify the EXPRATE or GFPTS parameters.

• If a client exists with the same port number as the ODUF, then an attempt to set the EXPRATE is denied
if the value does not match the EXPRATE of the GOPT or the known rate of the specified GOPT
SIGTYPE.

• Edit the NPOWNER of an ODUF facility as NONE is denied when the ODUF associated with CP owned
cross-connection.

• The CMDMDE=FRCD must be used to edit the ownership for the ODUF facilities.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• An attempt to set OPUCONFIG=MUX is denied for an ODUF.

Page 30-410 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

• When editing OPUCONFIG, it affects the value of ODU SWITCHTYPE parameter:

- If OPUCONFIG=AUTO, and if packet subsystem claims ownership, SWITCHTYPE=PKT;
- If ODU cross-connection is created or an ODUj is multiplexed into the ODU, SWITCHTYPE=OTN;
- If a non-packet switched client is mapped into the ODU, SWITCHTYPE=OTN;
- If OPUCONFIG=INTACT|MUX|CLIENT, then SWITCHTYPE=OTN;
- Otherwise, SWITCHTYPE=UNUSED.

• If SWITCHTYPE=PKT, the system denies an attempt to set OPUCONFIG to INTACT, MUX, or CLIENT.

Command Format
ED-
ODUF:[tid]:<fac_aid>:ctag:::[EXPRATE=<ExpClientRate>][,GFPTS=<nmbrOfTS_GFPclient
>][,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<pmProfile>][,DEGM=<degrade_
interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_source>][,EXPOPER=<ExpOper
ator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI=<Tx
DAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MONTRC=<montrc>][,PT=pt][,CMD
MDE=<commandMode>][,NPOWNER=<NpOwner>][,OPUCONFIG=<opu_config>][:<editablePrimar
yState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.69 ED-ODUF Parameters

Parameter Value(s) Definition
fac_aid ODUF-20-[1-16]-[1-40]-[1-80], ODUF- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-20]-[B,C][1-80]-[1-32], ODU4TribPort][-SupportODU ODUTribPort]-TribID
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

ExpClientRate A fixed integer value between Specifies the expected signal rate of the constant bit rate
2488022 and 103688578. mapped client within the payload of the ODUflex. This value is
used by the system to determine the ODUflex(CBR) rate. The
number is specified in Kbps.

A fixed integer value between 2488022 and 9952261 when the

ODUF is supported by an OSM-2S.
A fixed integer value between 2488022 to 103688578 when the
ODUF is supported by an OSM-2C.

nmbrOfTS_GF [1-80] Specify the ODUflex(GFP) rate by entering the number of 1.25G
Pclient Tributary Slots when the ODUflex supports a GFP client. The
supported ODUflex(GFP) rate is GFPTS x 1,249,177.230 kbit/s
when GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s when
GFPTS = 9 to 32, or GFPTS x 1,301,467.133 kbit/s when
GFPTS = 33 to 80.

Range is [1-8] for an ODUF mapped to an ODU2.

Range is [1-32] for an ODUF mapped to an ODU3.
Range is [1-80] for an ODUF mapped to an ODU4.

76.MTFP50/30, Rev B January 2018 Page 30-411

13. Edit Commands TL1 Command Reference Manual

Table 13.69 ED-ODUF Parameters (Continued)

Parameter Value(s) Definition
tribslot [1-80] Specifies a single value, or a group of values, or a range of
values identifying which tributary slots is used within the
supporting ODUk/ODUj to carry the ODUF.

A range of {1 to 8} is used for mapping to an ODU2 with 1.25G

tributary slots. Decide which tributary slots within the ODU2 to
use for a particular ODUF.
A range of {1 to 32} is used for mapping to an ODU3 with 1.25G
tributary slots. Decide which tributary slots within the ODU3 to
use for a particular ODUF.
A range of {1 to 80} is used for mapping to an ODU4. Decide
which 1.25G tributary slots within the ODU4 to use for a
particular ODUF.

Use & for grouping.

Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODUF
entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-850910] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.
Range is 1-81672 for OSM-2S.
Range is 1-850910 for OSM-2C.
The default threshold level is 15% of the total blocks present in a
given ODUflex, based on the ODUflex rate. The system
automatically calculates and sets the default integer value
based on the 15% threshold.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Page 30-412 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.69 ED-ODUF Parameters (Continued)

Parameter Value(s) Definition
montrc ENABLED-NOAIS Specifies the monitored trace identification mode.
DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

NpOwner NONE Specifies which network partition owns this entity.

By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

76.MTFP50/30, Rev B January 2018 Page 30-413

13. Edit Commands TL1 Command Reference Manual

Table 13.69 ED-ODUF Parameters (Continued)

Parameter Value(s) Definition
pt AUTO Specifies the transmitted Payload Type hexadecimal value.
Default: AUTO Typical Values:
- AUTO (implies the pt is set based on the connected facility
type). If a PT value is not assigned or AUTO is used to the PT
value upon mapping to a port, the ODUF PT value is set to the
appropriate value by the system. When the ODUF is unmapped
from a port, the ODUF PT value returns to AUTO.

Example
ED-ODUF::ODUF-20-3-3-1:CMDCTG::::IS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15
M CMDCTG COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODUF
ENT-ODUF
RTRV-ODUF

Page 30-414 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ODU0

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S and OSM-5C.

Description
The ED-ODU0 command instructs the Network Element (NE) to edit the attributes of an ODU0.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• This command is supported for OSM-2S, OSM-1S, OSM-2C, OSM-4C, OSM-4F, OSM-4S and OSM-
5C.

• There must be a client mapped to an ODU0 that is cross-connected in order to set the TXSAPI, TXDAPI,
or TXOPER.

• TRIBSLOT must be specified when ODU0 is muxed to an ODUk.

• TRIBSLOT value must be equal to the TribID value within the AID when the ODU0 is multiplexed into
an ODU1.

• The DMSOURCE parameter is only applicable to OSM-2S, OSM-1S, OSM-2C, OSM-4C, OSM-4F,
OSM-4S and OSM-5C.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• Edit the NPOWNER of an ODU0 facility as NONE is denied when the ODU0 associated with CP owned
cross-connection.

• The CMDMDE=FRCD must be used to edit the ownership for the ODU0 facilities.

• An attempt to edit the OPUCONFIG of an ODU0 is denied, when there is a TL provisioned on the ODU0.

• An attempt to edit OPUCONFIG is denied when ODUj is owned by CP.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

76.MTFP50/30, Rev B January 2018 Page 30-415

13. Edit Commands TL1 Command Reference Manual

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• An attempt to set OPUCONFIG=MUX is denied for an ODU0.

• OPUCONFIG applies only to the OSM-1S, OSM-2S, and OSM-2C.

• When editing OPUCONFIG, it affects the value of ODU SWITCHTYPE parameter:

- If OPUCONFIG=AUTO, and if packet subsystem claims ownership, SWITCHTYPE=PKT;
- If ODU cross-connection is created or an ODUj is multiplexed into the ODU, SWITCHTYPE=OTN;
- If a non-packet switched client is mapped into the ODU, SWITCHTYPE=OTN;
- If OPUCONFIG=INTACT|MUX|CLIENT, then SWITCHTYPE=OTN;
- Otherwise, SWITCHTYPE=UNUSED.

• If SWITCHTYPE=PKT, the system denies an attempt to set OPUCONFIG to INTACT, MUX, or CLIENT.

• For OSM-1S, if an ODU0 entity exists on port 1 through 16 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU0 terminations †associated with ports 1-16 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, if an ETH entity exists on any port 1 through 16, then the system denies an attempt to
create or modify any ODU0 terminations †associated with ports 1-16 to have OPUCONFIG of INTACT,
MUX, or CLIENT.

• For OSM-1S, if an ODU0 entity exists on port 17 through 32 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU0 terminations †associated with ports 17-32 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, if an ETH entity exists on any port 17 through 32, then the system denies an attempt to
create or modify any ODU0 terminations †associated with ports 17-32 to have OPUCONFIG of
INTACT, MUX, or CLIENT.

Command Format
ED-ODU0:[tid]:<fac_aid>:ctag:::
[TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<pmProfile>][,DEGM=<degrade_int
erval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_source>][,EXPOPER=<ExpOperato
r>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI=<TxDAP
I>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MONTRC=<montrc>][,CMDMDE=command
Mode][,NPOWNER=<NpOwner>][,OPUCONFIG=<opu_config>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-416 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.70 ED-ODU0 Parameters

Parameter Value(s) Definition
fac_aid ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]

tribslot [1-8] Specifies the tribslot that is used to carry the ODU0 within its
supporting ODUk/ODUj. Decide which tributary slot within the
ODUk/ODUj to use for a particular ODU0.
Range is [1-2] for mapping an ODU0 into an ODU1.
Range is [1-8] for mapping an ODU0 into an ODU2.
Range is [1-32] for mapping an ODU0 into an ODU3.
Range is [1-80] for mapping an ODU0 into an ODU4.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU0
entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-10168] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

76.MTFP50/30, Rev B January 2018 Page 30-417

13. Edit Commands TL1 Command Reference Manual

Table 13.70 ED-ODU0 Parameters (Continued)

Parameter Value(s) Definition
NpOwner NONE Specifies which network partition owns this entity.
By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
ED-ODU0::ODU0-20-3-3-1:CMDCTG::::IS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15
M CMDCTG COMPLD
;

Page 30-418 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU0
ENT-ODU0
RTRV-ODU0

76.MTFP50/30, Rev B January 2018 Page 30-419

13. Edit Commands TL1 Command Reference Manual

ED-ODU1

Command Changes Since Previous Feature Package

• Added support of ODU1 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ED-ODU1 command instructs the Network Element (NE) to edit the attributes of an ODU1.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• When ODU1 is not muxed to an ODUk, TRIBSLOT is not editable. TRIBSLOT is not used when
connected to a port facility.

• There must be a non-OTU client mapped to an ODU1 that is cross-connected in order to set the
TXSAPI, TXDAPI, or TXOPER.

• An attempt to set PT is denied if the ODUk is unterminated.

• An attempt to set PT is denied if the ODUk is cross-connected and the client being mapped is the OTUk.

• TRIBSLOT must be specified when ODU1 is going to be muxed to an ODUk.

• The DMSOURCE parameter is only applicable to the OSM-2S, OSM-1S, OSM-2C, OSM-4C, OSM4F,
OSM-4S, OSM-5C and SSM-2S.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• Edit the NPOWNER of an ODU1 facility as NONE is denied when the ODU1 associated with CP owned
cross-connection.

• The CMDMDE=FRCD must be used to edit the ownership for the ODU1 facilities.

• An attempt to edit the OPUCONFIG of an ODU1 is denied, when there is a TL provisioned on the ODU1
or the associated facilities (OTUk).

• An attempt to edit OPUCONFIG is denied when ODUj is owned by CP.

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

Page 30-420 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• OPUCONFIG applies only to the OSM-1S, OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C
and SSM-2S.

• The system denies an attempt to set OPUCONFIG=MUX on an ODU1 that is mapped to an ODU2 on
the OSM-1S.

• The system denies an attempt to set OPUCONFIG=MUX on an ODU1 on the OSM-2C.

• For OSM-1S, if an ODU0 entity exists on port 1 through 16 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU1 terminations †associated with ports 1-16 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, if an ETH exists on any port 1 through 16, then the system denies an attempt to create or
modify any ODU1 terminations †associated with ports 1-16 to have OPUCONFIG of INTACT, MUX, or
CLIENT.

• For OSM-1S, if an ODU0 entity exists on port 17 through 32 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU1 terminations †associated with ports 17-32 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, If an ETH entity exists on any port 17 through 32, then the system denies an attempt to
create or modify any ODU1 terminations †associated with ports 17-32 to have OPUCONFIG of
INTACT, MUX, or CLIENT.

• On mTera SSM-2S working module that is in EPG group, edit ODU1 facility would implicitly edit ODU1
facility on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to edit ODU1 facility would be
denied.

Command Format
ED-
ODU1:[tid]:<fac_aid>:ctag:::[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<p
mProfile>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_
source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER
=<txOperator>][,TXDAPI=<txDAPI>][,TXSAPI=<txSAPI>][,TIMDEF=<TIMDefinition>][,MON
TRC=<montrc>][,CMDMDE=<commandMode>][,NPOWNER=<NpOwner>][,OPUCONFIG=<opu_config>
][:<editablePrimaryState>];

76.MTFP50/30, Rev B January 2018 Page 30-421

13. Edit Commands TL1 Command Reference Manual

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.71 ED-ODU1 Parameters

Parameter Value(s) Definition
fac_aid ODU1-20-[1-16]-[1-32], ODU1-20-[1- EntityID-ShelfID-SlotID--{PortID[-SupportingODU4
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]

tribslot [1-80] Specifies a single value, or a group of values, or a range of

values identifying which tributary slots is used within the
supporting ODUk/ODUj to carry the ODU1.

TRIBSLOT is set to a group of two values in the range of 1 to 8

for mapping to an ODU2 with 1.25G Tributary Slots on the OSM-
2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C.
TRIBSLOT is set to a group of two values in the range of 1 to 32
for mapping to an ODU3 with 1.25G Tributary Slots on the OSM-
2C, OSM-4C, OSM-4F, OSM-5C.
TRIBSLOT is set to a group of two values in the range of 1 to 80
for mapping to an ODU4 on the OSM-2C, OSM-4C, OSM-4F,
OSM-5C.
Example: TRIBSLOT=1&5

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU1
entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-20421] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

Page 30-422 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.71 ED-ODU1 Parameters (Continued)

Parameter Value(s) Definition
txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

NpOwner NONE Specifies which network partition owns this entity.

By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service(OOS).

76.MTFP50/30, Rev B January 2018 Page 30-423

13. Edit Commands TL1 Command Reference Manual

Table 13.71 ED-ODU1 Parameters (Continued)

Parameter Value(s) Definition
TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

Example
ED-ODU1::ODU1-20-13-2-
2:CMDCTG:::TRIBSLOT=1&2,TIMDEF=SAPI_DAPI_OPER,MONTRC=ENABLED-AIS:IS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15

M CMDCTG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU1
ENT-ODU1
RTRV-ODU1

Page 30-424 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ODU2

Command Changes Since Previous Feature Package

• Added support of ODU2 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ED-ODU2 command instructs the Network Element (NE) to edit the attributes of an ODU2.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• CMDMDE=FRCD must be used to edit control plane owned ODU2.

• An attempt to set the PT is denied if the ODUk is unterminated.

• An attempt to set the TXDAPI, TXSAPI, or TXOPER on unterminated ODU2 is denied.

• An attempt to provision an ODU2 is denied in mTera shelf if the provisioned TGLAN of the same port
with TRANSMAP not equal to FRAME_STD/PREAMBLE.

• If the non-OTU/OCH-P client is provisioned on the port, changing the PT of the ODU2 on the port to a
value which the client does not support is denied.

• On the OSM-2S/SSM-2S, if a PT value is assigned to the ODU2

1. On mapping to a port, PT is validated against the facility type (for example, when the mapped client
is STM64, PT value of 0x80 cannot be assigned).
2. On unmapping from a port, the PT value remains as configured and not revert to AUTO as in the
default case.
Note that there is a special case for assignment of PT=0x2 (async) and PT=0x3 (sync) when a PT of
0x2 or 0x3 is assigned and mapped to a SONET/SDH signal type.
1. If the CBRMAP is changed between ASYNC and SYNC using the ED-OC192/ED-STM64, the ODUk
PT value changes with the CBRMAP parameter.
2. On unmapping from a port, the PT value remains as the last PT value assigned.
3. On unmapping from a client facility, initial AUTO type of PT returns back to AUTO.

• The DMSOURCE parameter is only applicable to the OSM-2C, OSM-2S, OSM-4C, OSM-4F, OSM-4S,
OSM-5C and SSM-2S.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P facility.

• The attempt to change the tributary slots is denied if the number of tributary slots assigned to the ODU2
with specific CLOCKTYPE is not equal to the required tributary slot number.

• TRIBSLOT is only applicable when the ODU2 is multiplexed in a higher order ODU.

• If any of the assigned tributary slots has been occupied by other ODU, the attempt to edit the ODU2 is
denied.

• Edit the NPOWNER of an ODU2 facility as NONE is denied when the ODU2 associated with CP owned
cross-connection.

• The CMDMDE=FRCD must be used to edit the ownership for the ODU2.

76.MTFP50/30, Rev B January 2018 Page 30-425

13. Edit Commands TL1 Command Reference Manual

• For the high order direct mapped ODU2 on a muxable module, the ownership of ODU2 is assigned to
CP if and only if CP provisioned the cross connect over the ODU2.

• An attempt to edit the OPUCONFIG of an ODU2 is denied, when there is a TL provisioned on the ODU2
or the associated facilities (OTUk/OCH-P).

• An attempt to edit OPUCONFIG is denied when ODUj is owned by CP.

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk/OCH-P/OCH-OS.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• OPUCONFIG applies only to the OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C and SSM-
2S.

• When editing OPUCONFIG, it affects the value of ODU SWITCHTYPE parameter:

- If OPUCONFIG=AUTO, and if packet subsystem claims ownership, SWITCHTYPE=PKT;
- If ODU cross-connection is created or an ODUj is multiplexed into the ODU, SWITCHTYPE=OTN;
- If a non-packet switched client is mapped into the ODU, SWITCHTYPE=OTN;
- If OPUCONFIG=INTACT|MUX|CLIENT, then SWITCHTYPE=OTN;
- Otherwise, SWITCHTYPE=UNUSED.

• If SWITCHTYPE=PKT, the system denies an attempt to set OPUCONFIG to INTACT, MUX, or CLIENT.

• On mTera SSM-2S working module that is in EPG group, edit ODU2 facility would implicitly edit ODU2
facility on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to edit ODU2 facility would be
denied.

Command Format
ED-
ODU2:[tid]:<fac_aid>:ctag:::[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<p
mProfile>][,SDTHRESH=<SDThreshold>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_t
hreshold>][,DMSOURCE=<DM_source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,E

Page 30-426 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

XPSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIM
DEF=<TIMDefinition>][,MONTRC=<montrc>][,PT=<pt>][,CMDMDE=<commandMode>][,NPOWNER
=<NpOwner>][,OPUCONFIG=<opu_config>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Applicable Parameters

Table 13.72 Module - Parameter Applicability

OSM-2C/
OSM-2S/ OSM-4C/
SSM-2S/ OSM-4F/
a
PARAMETER DEFb OSM-4S OSM-5C
ALMPF ND O O

PMPF ND O O

EXPOPER ND O O

EXPDAPI ND O O

EXPSAPI ND O O

TXOPER ND O O

TXDAPI ND O O

TXSAPI ND O O

TIMDEF ND O O

MONTRC ND O O

TRIBSLOT ND O

PT ND O

DEGM ND O O

DEGTHR ND O O

DMSOURCE ND O O

CMDMDE ND O O

NPOWNER ND O O

OPUCONFIG ND O O

editablePrimarySt PD O O
ate

a. M indicates a MANDATORY parameter and O indicates an

OPTIONAL parameter for the specified module.
b. ND: Name Defined or PD: Position defined.
c. Mandatory when execution of the command impacts
existing traffic.

76.MTFP50/30, Rev B January 2018 Page 30-427

13. Edit Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.73 ED-ODU2 Parameters

Parameter Value(s) Definition
fac_aid ODU2-20-[1-16]-[1-40], ODU2-20-[1- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]

tribslot [1-80] Specifies a group of values, or a range of values identifying

which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU2. Decide which tributary slots within the ODUk to
use for a particular ODU2.
Range is [1-32] for mapping an ODU2 into an ODU3.
Range is [1-80] for mapping an ODU2 into an ODU4.
Use & for grouping.
Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU2
entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-82026] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 82026, default of 12304 (ODU2)

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

TxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

Page 30-428 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.73 ED-ODU2 Parameters (Continued)

Parameter Value(s) Definition
TxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

TIMDefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

pt AUTO Specifies the transmitted Payload Type hexadecimal value on

0x02 the OSM-2S/OSM-4S.
0x03
0x05 Typical Values:
0x09 - AUTO (implies the pt is set based on the connected facility
0x10 type). If a PT value is not assigned or AUTO is configured to the
0x11 PT value upon mapping to a port, the ODU2 PT value is set to
0x80 the appropriate value by the system. When the ODU2 is
0x81 unmapped from a port, the ODU2 PT value returns to AUTO.
0x82 - 0x09, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x83 TRANSMAP=PREAMBLE payload
0x84 - 0x03, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x85 - 0x05 for a TGLAN with TRANSMAP=FRAME_STD payload
0x86 - 0x03 for an OC192/STM64 with CBRMAP=SYNC payload
0x87 - 0x02 for an OC192/STM64 with CBRMAP=ASYNC payload
0x88
0x89 Note that the Payload Type value cannot be changed from the
0x8A typical value if a TGLAN with TRANSMAP=FRAME_STD or for
0x8B an OC192/STM64 is connected to the ODU2.
0x8C
0x8D
0x8E
0x8F
Default: AUTO

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

76.MTFP50/30, Rev B January 2018 Page 30-429

13. Edit Commands TL1 Command Reference Manual

Table 13.73 ED-ODU2 Parameters (Continued)

Parameter Value(s) Definition
NpOwner NONE Specifies which network partition owns this entity.
By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service
(OOS).

Example
This following command puts the 4th ODU2 on the line side of an FGTM-M out of service.
ED-ODU2::ODU2-20-1-5-4:CMDCTG::::OOS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15

M CMDCTG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU2
ENT-ODU2
RTRV-ODU2

Page 30-430 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ODU2E

Command Changes Since Previous Feature Package

• Added support of ODU2E mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ED-ODU2E commands instruct the network element (NE) to edit the attributes of an ODU2E.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• An attempt to set the TXSAPI, TXDAPI, or TXOPER can only be set on a terminated ODU2E, which is
an ODU2E associated with a TGLAN interface.

• If the ODU is associated with ODU cross-connection, the ODU cannot be edited OOS unless
CMDMDE=FRCD is used.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• Edit the NPOWNER of an ODU2E facility as NONE is denied when the ODU2E associated with CP
owned cross-connection.

• The CMDMDE=FRCD must be used to edit the ownership for the ODU2E facilities.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk/OCH-P.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

Command Format
ED-
ODU2E:[tid]:<fac_aid>:ctag:::[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<
pmProfile>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM
_source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPE

76.MTFP50/30, Rev B January 2018 Page 30-431

13. Edit Commands TL1 Command Reference Manual

R=<txOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MO
NTRC=<montrc>][,PT=pt][,NPOWNER=<NpOwner>][,OPUCONFIG=<opu_config>][:<editablePr
imaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.
Table 13.74
Table 13.75 ED-ODU2E Parameters
Parameter Value(s) Definition
fac_aid ODU2E-20-[1-16]-[1-4], ODU2E-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]

tribslot [1-80] Specifies a group of values, or a range of values, identifying

which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU2E. Decide which tributary slots within the ODUk
to use for a particular ODU2E.
Range is [1-32] for mapping an ODU2E into an ODU3. Nine
tribslot values must be entered for an ODU2E mapped into an
ODU3.
Range is [1-80] for mapping an ODU2E into an ODU4.
Eight tribslot values must be entered for an ODU2E mapped into
an ODU3.
Use & for grouping.
Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU2E
entity.
Note: Default value is 99.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-84986] Indicates the threshold number of block errors at which a one
hold Default: 12748 second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Page 30-432 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.75 ED-ODU2E Parameters (Continued)

Parameter Value(s) Definition
ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.
Note that AIS insertion is only performed on a terminated entity.

NpOwner NONE Specifies which network partition owns this entity.

By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service
(OOS).The system default is IS.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-433

13. Edit Commands TL1 Command Reference Manual

Table 13.75 ED-ODU2E Parameters (Continued)

Parameter Value(s) Definition
TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

pt AUTO Specifies the transmitted Payload Type hexadecimal value.

0x03 Typical Values:
0x10 - AUTO (implies the pt is set based on the connected facility
0x11 type). If the a PT value is not assigned or AUTO is configured to
0x80 the PT value upon mapping to a port, the ODU2E PT value is
0x81 set to the appropriate value by the system. When the ODU2E is
0x82 unmapped from a port, the ODU2E PT value returns to AUTO.
0x83 - 0x03, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x84 TRANSMAP=LINE_FS
0x85
0x86
0x87
0x88
0x89
0x8A
0x8B
0x8C
0x8D
0x8E
0x8F
Default: AUTO

Example
This following command puts an ODU2E on an OSM-2C out of service.
ED-ODU2E:CORIANT1:ODU2E-20-2-2-1:AM0074::::OOS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU2E
ENT-ODU2E
RTRV-ODU2E

Page 30-434 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ODU3

Command Changes Since Previous Feature Package

• Added support of ODU3 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-5C.

Description
The ED-ODU3 command instructs the Network Element (NE) to edit the attributes of an ODU3.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• An attempt to set the TXSAPI, TXDAPI, or TXOPER can only be set on a terminated ODU3, which is
an ODU3 supporting ODUj.

• If the ODU is associated with ODU cross-connection, the ODU cannot be edited OOS unless
CMDMDE=FRCD is used.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• Edit the NPOWNER of an ODU3 facility as NONE is denied when the ODU3 associated with CP owned
cross-connection.

• The CMDMDE=FRCD must be used to edit the ownership for the ODU3 facilities.

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

76.MTFP50/30, Rev B January 2018 Page 30-435

13. Edit Commands TL1 Command Reference Manual

Command Format
ED-
ODU3:[tid]:<fac_aid>:ctag:::[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<p
mProfile>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_
source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER
=<txOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MON
TRC=<montrc>][,NPOWNER=<NpOwner>][,OPUCONFIG=<opu_config>][:<editablePrimaryStat
e>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.
Table 13.76
Table 13.77 ED-ODU3 Parameters
Parameter Value(s) Definition
fac_aid ODU3-20-[1-16]-[1-5]-[1-80], ODU3- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]- ODU4TribPort]-TribID
[D][1-3]-[1-80]

tribslot [1-80] Specifies a group of values, or a range of values, identifying

which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU3. Decide which tributary slots within the ODUk to
use for a particular ODU3.
Range is [1-80] for mapping an ODU3 into an ODU4.
31 tribslot values must be entered for an ODU3 mapped into an
ODU4.
Use & for grouping.
Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU3
entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-329492] Indicates the threshold number of block errors at which a one
hold Default: 49424 second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Page 30-436 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.77 ED-ODU3 Parameters (Continued)

Parameter Value(s) Definition
ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and insert AIS
maintenance signal when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
insert AIS when there is a trace mismatch (signal is passed
through intact).
- Enter DISABLED to disable trace monitoring.

NpOwner NONE Specifies which network partition owns this entity.

By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service (OOS).

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

76.MTFP50/30, Rev B January 2018 Page 30-437

13. Edit Commands TL1 Command Reference Manual

Example
This following command puts an ODU3 out of service.

ED-ODU3:CORIANT1:ODU3-20-2-2-1:AM0074::::OOS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15

M CMDCTG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU3
ENT-ODU3
RTRV-ODU3

Page 30-438 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ODU4

Command Changes Since Previous Feature Package

• Added support of ODU4 mux into the ODUC3 on OSM-4F.

• Added support for OSM-5C.

Description
The ED-ODU4 command instructs the Network Element (NE) to edit the attributes of an ODU4.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• An attempt to set the TXSAPI, TXDAPI, or TXOPER can only be set on a terminated ODU4, which is
an ODU4 associated with an HGE interface or an ODU4 supporting ODUj on the OSM-2C/OSM-5C.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• On OSM-2C, if the ODU is associated with ODU cross-connection, the ODU cannot be edited OOS
unless CMDMDE=FRCD is used.

• Edit the NPOWNER of an ODU4 facility as NONE is denied when the ODU4 associated with CP owned
cross-connection.

• The CMDMDE=FRCD must be used to edit the ownership for the ODU4 facilities.

• An attempt to edit the OPUCONFIG of an ODU4 is denied, when there is a TL provisioned on the ODU4
or the associated facilities (OTUk/OCH-P).

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk/OCH-P.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

76.MTFP50/30, Rev B January 2018 Page 30-439

13. Edit Commands TL1 Command Reference Manual

• When editing OPUCONFIG, it affects the value of ODU SWITCHTYPE parameter:

- If OPUCONFIG=AUTO, and if packet subsystem claims ownership, SWITCHTYPE=PKT;
- If ODU cross-connection is created or an ODUj is multiplexed into the ODU, SWITCHTYPE=OTN;
- If a non-packet switched client is mapped into the ODU, SWITCHTYPE=OTN;
- If OPUCONFIG=INTACT|MUX|CLIENT, then SWITCHTYPE=OTN;
- Otherwise, SWITCHTYPE=UNUSED.

• If SWITCHTYPE=PKT, the system denies an attempt to set OPUCONFIG to INTACT, MUX, or CLIENT.

• The ODU4TribPort field in the AID is applicable only for the ODU4 within an ODUC2 or ODUC3 of the
OSM-4F.

• PKTMAP can only be set when SWITCHTYPE=UNUSED.

• MSIM can only be set when the ODU4 being de-multiplexed on OSM-2C.

Command Format
ED-
ODU4:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PMPF=<pmProfile>][,DEGM=<degr
ade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_source>][,EXPOPER=<Exp
Operator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI
=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MONTRC=<montrc>][,CMDMDE=
<commandMode>][,NPOWNER=<NpOwner>][,OPUCONFIG=<opu_config>][,MSIM=<msim_config>]
[,PKTMAP=<pktmap>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.78 ED-ODU4 Parameters

Parameter Value(s) Definition
fac_aid ODU4-20-[1-16]-[1-5], ODU4-20-[1- EntityID-ShelfID-SlotID-PortID[-ODU4TribPort]
16]-[1-2]-[1-3]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU4
Default: 99 entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-856388] Indicates the threshold number of block errors at which a one
hold Default: 128459 second interval is considered degraded for the purposes of
SDBER detection.

Page 30-440 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.78 ED-ODU4 Parameters (Continued)

Parameter Value(s) Definition
DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED
For an end-to-end ODUk path, there are two terminations and
only one of the two should have DMSOURCE set to ENABLED
in order to get proper delay measurement values.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
Default: DISABLED consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

NpOwner NONE Specifies which network partition owns this entity.

By specifying NONE meant to reset/release the CP retained
entity. After release, it could be used for MP purposes.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service (OOS).

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-441

13. Edit Commands TL1 Command Reference Manual

Table 13.78 ED-ODU4 Parameters (Continued)

Parameter Value(s) Definition
txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

CommandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

pktmap GFP Specifies the type of mapping/demapping used for packet traffic
GMP within an ODU owned by the packet subsystem.
- GFP indicates that GFP-F is used to map/demap the packets
into/out of the ODU
- GMP indicates that a constant bit rate mapping using GMP is
used to map/demap the packets into/out of the ODU.

Example
ED-ODU4::ODU4-20-2-1-1:CMDCTG::::OOS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15

M CMDCTG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ODU4

Page 30-442 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ODUC2

Command Changes Since Previous Feature Package

• None.

Description
The ED-ODUC2 command instructs the Network Element (NE) to edit the attributes of an ODUC2.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• This command is supported for OSM-4F.

• ODUC2 is not cross-connectable.

Command Format
ED-ODUC2:[tid]:<fac_aid>:ctag:::[,CMDMDE=commandMode][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.79 ED-ODUC2 Parameters

Parameter Value(s) Definition
fac_aid ODUC2-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service (OOS).

CommandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
ED-ODUC2::ODUC2-20-2-1:CMDCTG::::OOS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15

M CMDCTG COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-443

13. Edit Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ODUC2

Page 30-444 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-ODUC3

Command Changes Since Previous Feature Package

• New command for OSM-4F 300G support.

Description
The ED-ODUC3 command instructs the Network Element (NE) to edit the attributes of an ODUC3.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• This command is supported for OSM-4F.

• ODUC3 is not cross-connectable.

Command Format
ED-ODUC3:[tid]:<fac_aid>:ctag:::[,CMDMDE=commandMode][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.80 ED-ODUC3 Parameters

Parameter Value(s) Definition
fac_aid ODUC3-20-[1-16]-1 EntityID-ShelfID-SlotID-PortID

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service (OOS).

CommandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
ED-ODUC3::ODUC3-20-2-1:CMDCTG::::OOS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15

M CMDCTG COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-445

13. Edit Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ODUC3

Page 30-446 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OMS

Command Changes Since Previous Feature Package

• None

Description
The ED-OMS command instructs the network element (NE) to edit the primary state of a optical multiplex section
(OMS) facility entity. For certain OMS entities, the command also allows for the modification of OMS attributes.
On the OADMRS20 and OADMRS9, the command allows the setting of attributes related to the OMS facility on the
DWDM Line port.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• CHANTYPES, CHANALLOW and GRIDMODE are only applicable to OMS entity on DWDM Line port
of OADMRS/OADMRS9.

• CHANALLOW is only supported when GRIDMODE=FIXED96_mTera, or FIXED44_7100, or

FIXED88_7100.

• When OTSMODE=7100, chantypes of COHERENTONLY and MIXED are supported under both
gridmodes of FIXED88_7100 and FIXED44_7100, COHERENTONLYHIPWR is only supported under
gridmode of FIXED44_7100.

• The attempt to provision CHANALLOW outside the range defined by GRIDMODE is denied.

• The attempt to provision CHANTYPES as COHERENTONLYHIPWR is denied if any of the existing

OCH-L entities is outside of the range 1&&44.

• CMDMDE=FRCD must be used in order to change the CHANTYPES value due to the fact that a
change on only one end of the OMS port could affect traffic at the other end of the OMS port.

• An attempt to change the CHANTYPES value from MIXED to COHERENTONLY or

COHERENTONLYHIPWR is denied if an OTS TL has been provisioned for the OTS of the OMS port
and any of the following OTS TL1 parameters have a value of NA: RCD, SPMN, XPMN, and/or PDL.

• When OTSMODE of the OTS at the OMS port is 7100, GRIDMODE of the OMS can only be
FIXED88_7100 or FIXED44_7100.

• When OTSMODE of the OTS at the OMS port is MTERA, GRIDMODE of the OMS can only be
FIXED96_MTERA or FIXED96_NOCHANPLAN.

• When OTSMODE of the OTS at the OMS port is HIT7300, GRIDMODE of the OMS can only be
FIXED96_MTERA or FIXED96_NOCHANPLAN.

• CHANTYPES can be MIXED on OADMRS/OADMRS9 only if OTSMODE of the OTS at the OMS port
is 7100.

• When OTSMODE of the OTS at the OMS port is MTERA, CHANTYPES of the OMS can only be
COHERENTONLY.

• When OTSMODE of the OTS at the OMS port is HIT7300, CHANTYPES of the OMS can only be
COHERENTONLY.

• GRIDMODE can only be edited if the OMS is administratively OOS and command mode is FRCD.

76.MTFP50/30, Rev B January 2018 Page 30-447

13. Edit Commands TL1 Command Reference Manual

• The attempt to edit GRIDMODE is denied if any of the existing OCH-L entities is not allowed by the new
mode including that relation between OCH-L ID and frequency is not allowed by new mode, or
frequency of the OCH-L is not within the allowed channel range of new mode.

• An attempt to remove a channel from CHANALLOW is denied if an OCH-L exists for that channel. The
OCH-L must be deleted before the channel can be removed from CHANALLOW.

• The following parameters only have an impact on the OMS when OTSMODE=MTERA or
OTSMODE=HIT7300 and attempts to change their values is denied when OTSMODE=7100:
- COEFFK
- OSNRPC100G
- OSNRPC40G
- OSNRPC10G
- EOLCHNLCNT
- OCHAAMINGR
- OCHAAMEGR

• When OCHAAMING is set to AUTO, all OCH-Ls within the OMS shows AAMINGR in RTRV-OCH as
AUTO. When OCHAAMINGR is set to MAN, all OCH-Ls within the OMS shows AAMINGR in RTRV-
OCH as MAN.

• When OCHAAMEGR is set to AUTO, all OCH-Ls within the OMS shows AAMEGR in RTRV-OCH as
AUTO. When OCHAAMEGR is set to MAN, all OCH-Ls within the OMS shows AAMEGR in RTRV-OCH
as MAN.

Command Format
ED-
OMS:[tid]:<oms_aid>:ctag:::[,ALMPF=<almProfile>][,CMDMDE=<commandMode>][,CHANALL
OW=<channels_allowed>][,CHANTYPES=<channelTypes>][,GRIDMODE=<gridmode>][,COEFFK=
<coefficient_k>][,OSNRPC100G=<osnr_pwr_correct_100g>][,OSNRPC40G=<osnr_pwr_corre
ct_40g>][,OSNRPC10G=<osnr_pwr_correct_10g>][,EOLCHNLCNT=<eol_channel_count>][,OC
HAAMINGR=<ochAttAdjModeIngress>][,OCHAAMEGR=<ochAttAdjModeEgress>]:[<editablePri
maryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.81 ED-OMS Parameters

Parameter Value(s) Definition
oms_aid OMS-20-[10-16,1-7]-[1-21],OMS-20- EntityID-ShelfID-SlotID[-SubslotID]-PortID
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Page 30-448 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.81 ED-OMS Parameters (Continued)

Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

channels_allo [1-96] Indicates the set of channels that are allowed to use.
wed The parameter is only supported when GRIDMODE of the
OADMRS/OADMRS9 is = FIXED96_mTera, or FIXED44_7100,
or FIXED88_7100.

On OADMRS/OADMRS9, the set of channels allowed is limited

by the GRIDMODE.
On OADMRS/OADMRS9, if its GRIDMODE is FIXED96_mTera,
then the max channel number is 96.
On OADMRS/OADMRS9, if its GRIDMODE is FIXED44_7100,
then the max channel number is 44.
On OADMRS/OADMRS9, if its GRIDMODE is FIXED88_7100,
then the max channel number is 88.
If the GRIDMODE value or CHANTYPES value changes, then
the default value for CHANALLOW also implicitly change to
match the channel range.

Default values are:

- Default CHANALLOW = 1&&88 if GRIDMODE =
FIXED88_7100
- Default CHANALLOW= 1&&44 if GRIDMODE =
FIXED44_7100
- Default CHANALLOW = 1&&96 if GRIDMODE =
FIXED96_mTera

Note: This parameter allows use of the grouping operator "&" or

the ranging operator "&&" (eg. CHANALLOW=1&3&5&7&9 or
CHANALLOW=1&&9).

76.MTFP50/30, Rev B January 2018 Page 30-449

13. Edit Commands TL1 Command Reference Manual

Table 13.81 ED-OMS Parameters (Continued)

Parameter Value(s) Definition
channelTypes MIXED Indicates the channel type that the specified OMS carries
COHERENTONLY wavelengths.
COHERENTONLYHIPWR
COHERENTONLYHIPWR is only applicable when
GRIDMODE = FIXED44_7100.

MIXED = Any mixture of 2.5G, 10G, 40G, 100G coherent or

non-coherent wavelengths on the OMS.

COHERENTONLYHIPWR = The OMS can contain only

coherent wavelength up to the number allowed by GRIDMODE.
The target ouput power per channel is increased to 3 dB more
than the normal target per channel in order to gain improved
optical performance, for example, when 44 channels or less are
required for the module capable to support more than 88
channels. This OMS is not intended to
be used to carry any direct detect 2.5G, 10G, or 40G
wavelengths.

COHERENTONLY = The OMS can contain wavelengths up to

the maximum allowed on the interface of only coherent
wavelengths. This OMS is not intended to be used to carry any
direct detect 2.5G, 10G, or 40G wavelengths.

If OTSMODE = 7100 at the OTS entity of the OMS port:

Default: MIXED
If OTSMODE = MTERA at the OTS entity of the OMS port:
Default: COHERENTONLY
If OTSMODE = HIT7300 at the OTS entity of the OMS port:
Default: COHERENTONLY

Page 30-450 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.81 ED-OMS Parameters (Continued)

Parameter Value(s) Definition
gridmode FIXED96_NOCHANPLAN Indicates the grid mode that the specified OMS. Grid mode
FIXED44_7100 includes the grid type and channel plan information. 'FIXED'
FIXED88_7100 indicates the grid is fixed frequency grid.
FIXED96_MTERA
FIXED96_NOCHANPLAN: 96 channels of fixed frequency grid.
Channel Center Frequency (FREQ) is configurable but not
decided per OCH-L ID - No channel plan. Channel Number is
limited to 96.

FIXED44_7100: 44 channels of fixed frequency grid. Channel

Center Frequency (FREQ) is implicitly decided per OCH-L ID
according to channel plan of 7100 OTS/Nano 44 channel plan.
Channel Number is limited to 44.

FIXED88_7100: 88 channels of fixed frequency grid. Channel

Center Frequency (FREQ) is implicitly decided per OCH-L ID
according to channel plan of 7100 OTS/Nano 88 channel plan.
Channel Number is limited to 88.

FIXED96_MTERA: 96 channels of fixed frequency grid. Channel

Center Frequency (FREQ) is implicitly decided per OCH-L ID
according to channel plan of 96 channel plan of mTera UTP
system. Channel Number is limited to 96.

If OTSMODE = 7100 at the OTS of the OMS located module:

Default: FIXED88_7100
If OTSMODE = MTERA at the OTS of the OMS located module:
Default: FIXED96_NOCHANPLAN
If OTSMODE = HIT7300 at the OTS of the OMS located
module:
Default: FIXED96_NOCHANPLAN

coefficient_k [0-100] Specifies the K Coefficient which is the correction factor for
power preemphasis calculation.

osnr_pwr_corr -50 to 50 (dB/10) Specifies the power correction factor to consider for 100G
ect_100g wavelengths within the OMS.

osnr_pwr_corr -50 to 50 (dB/10) Specifies the power correction factor to consider for 40G
ect_40g wavelengths within the OMS.

osnr_pwr_corr -50 to 50 (dB/10) Specifies the power correction factor to consider for 10G
ect_10g wavelengths within the OMS.

eol_channel_c [1-96] Specifies the planned end-of-life channel count for the link.
ount

ochAttAdjMod AUTO Specifies is all OCH-L within an OMS are in Automatic or

eIngress MAN Manual attenuation adjustment mode within the Ingress WSS
when OTSMODE=MTERA or HIT7300.
AUTO = Automatic Attenuation Adjustment for OCH-Ls within
OMS
MAN = Manual Attenuation Adjustment for OCH-Ls within OMS.

76.MTFP50/30, Rev B January 2018 Page 30-451

13. Edit Commands TL1 Command Reference Manual

Table 13.81 ED-OMS Parameters (Continued)

Parameter Value(s) Definition
ochAttAdjMod AUTO Specifies is all OCH-L within an OMS are in Automatic or
eEgress MAN Manual attenuation adjustment mode within the Egress WSS
when OTSMODE=MTERA or HIT7300.
AUTO = Automatic Attenuation Adjustment for OCH-Ls within
OMS
MAN = Manual Attenuation Adjustment for OCH-Ls within OMS.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Outof-Service (OOS).

Example
ED-OMS:CORIANT1:OMS-20-1-1:AM0074::::IS;

Possible System Response

^^^CORIANT1 14-12-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-OMS

Page 30-452 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OTU1/OTU2/OTU4/OTUC2/OTUC3/TGLAN

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

Description
The ED-{X} command instructs the network element (NE) to edit the attributes of a selected facility entity.

The facilities in the table below can be edited on transponders:

Table 13.82 Facilities Supported by Transponders
Table 13.83
Facilities -->
Transponders TGLAN OTU1 OTU2 OTU4 OTUC2 OTUC3

OSM-1S X

OSM-2S X X

OSM-2C X

OSM-4C X

OSM-4F X X X

OSM-4S X X

OSM-5C X

{X} specifies the facility type among the following:

• Facilities (fac_type): OTU1, OTU2, OTU4, OTUC2, OTUC3, TGLAN.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• NENDALS can only be set to YES if PROT=YES for the facility.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• The system denies an attempt to modify FECTYPE parameter after the OTUk TL has been successfully
created.

• On OSM-2S, the Super FEC provisioning for a group of ports must be the same (for example, SUPER
- I.4 EFEC or SUPERI7 - I.7 EFEC). The system denies an attempt to provision the FECTYPE as
SUPER or SUPERI7 if one of the ports in the group is already provisioned for a different SUPER/
SUPERI7 value. The port groups are: 1-4, 5-8, 9-10, 11-14, 15-18 and 19-20.

• PT value is not editable on the OTUk for OSM-2S, OSM-1S and OSM-2C. Use ODUk based commands
for PT for OSM-2S, OSM-1S and OSM-2C.

• For TGLAN facility, only TRANSMAP=PREAMBLE/ LINE/ LINE_FS includes support to transport RF/
LF ordered sets to far-end client connected device.

• CMDMDE=FRCD must be used to edit control plane owned OTU1/OTU2/OTU2e(OTU2e implied

clocktype setting on the OTU2 facility)/OTU4.

76.MTFP50/30, Rev B January 2018 Page 30-453

13. Edit Commands TL1 Command Reference Manual

• The commands is denied if any of the sub-rate ODUk are connected.

• CLOCKTYPE may not be altered if the ODU has already been mapped to the OTU2.

• An attempt to set the UPI value for a TGLAN with TRANSMAP set to any value other than PREAMBLE
is denied.

• Auto laser shutdown using PROT is not supported on the OTU2 facilities supported by the OSM-2S
module. Auto laser shutdown using PROT is not supported on the OTU4 facilities supported by the
OSM-2C module.

• Auto laser shutdown using NENDALS is not supported on the OTUk supported by mTera modules.

• MAINTPROP parameter is not supported on mTera modules.

• PROT and NENDALS parameters are supported on OSM-2S for facilities of TGLAN.

• Provisioning PT value for OSM-2S is denied. PT value of OSM-2S is set on ODUk entity.

• On OSM-2S, provisioning UPI=TLABLEGACY on TGLAN(Preamble) is denied.

• The NE denies an attempt to provision an TGLAN on OSM-2S with CHAN=NA when the supporting
SFP+ is a Tunable DWDM SFP+.

Command Format
ED-
<fac_type>:[tid]:<fac_aid>:ctag:::[ALMPF=<almProfile>][,FECTYPE=<fecType>][,PROT
=<protection>][,NENDALS=<NendALS>][,UPI=<UPIvalue>][,PT=<pt>][,EXPDAPI=<ExpDAPI>
][,EXPSAPI=<ExpSAPI>][,EXPOPER=<ExpOperator>][,TXDAPI=<txDAPI>][,TXSAPI=<txSAPI>
][,TXOPER=<txOperator>][,CLOCKTYPE=<ClkType>][,TIMDEF=<TIMdefinition>][,MONTRC=<
montrc>][,CHAN=<channel>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_threshold>]
[,EXTCHAN=<ExtChan>][,CMDMDE=<commandMode>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Table 13.84 Parameters Applicability When Entering the Command

PARAMETER DEFa TGLAN OTU1 OTU2 OTU4 OTUC2 OTUC3
ALMPF ND X X X X X X

PROT ND X

NENDALS ND X

FECTYPE ND X X

UPI ND X

EXPDAPI ND X X X X X

EXPSAPI ND X X X X X

EXPOPER ND X X X X X

TXDAPI ND X X X X X

Page 30-454 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.84 Parameters Applicability When Entering the Command (Continued)

PARAMETER DEFa TGLAN OTU1 OTU2 OTU4 OTUC2 OTUC3
TXSAPI ND X X X X X

TXOPER ND X X X X X

CLOCKTYPE ND X

MONTRC ND X X X X X

TIMDEF ND X X X X X

CHAN ND Xd Xb

DEGM ND Xc Xc X X X

DEGTHR ND Xc Xc X X X

CMDMDE ND X X X X X X

PST PD X X X X X X

a. ND: Name Defined or PD: Position Defined.

b. Supported by the OSM-2S.
c. DEGM and DEGTHR are applicable on OSM-1S and OSM-2S.
d. Applies to OSM-2S.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.85 ED-OPTD/TGLAN/OTU1/OTU2/OTU3/TGFC Parameters

Parameter Value(s) Definition
fac_aid OTU1-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
TGLAN-20-[1-16]-[1-40]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

fecType REGULAR Specifies the type of FEC supported on the OTU1/OTU2/OTU4

NOFEC client side facility.
SUPER REGULAR FEC is the G.709 FEC.
SUPERI7 The SUPER FEC provides more than 8 dB of coding
gain.(Applicable for OTU2 facility supported on OSM-2S/OSM-
4S)
Only OSM-2S/OSM-4S supports SuperI7 which is an alternative
enhanced FECTYPE.
NOFEC: FEC is disabled.

Applies to OTU1 facility supported by OSM-1S, OTU2 facility

supported by OSM-2S/OSM-4S.

The OSM-2C/OSM-5C supports the following FEC values for

the OTU4 facility:
REGULAR

76.MTFP50/30, Rev B January 2018 Page 30-455

13. Edit Commands TL1 Command Reference Manual

Table 13.85 ED-OPTD/TGLAN/OTU1/OTU2/OTU3/TGFC Parameters (Continued)

Parameter Value(s) Definition
protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.

Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending a maintenance
signal (for example, AIS or LF depending on the type of facility
provisioned) when there is a signal failure detected on the line
side of a transponder.
This value is typically used with external client side protection.

Setting the value to NO does not shut down the laser on the port
side of the transponder. When this value is set standard
maintenance signaling is used.

Setting this value to NA disables the protection functionality.

The value of NA does not apply to OTU4.

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOF/LOSYNC).

Applies only to TGLAN supported by OSM-2S.

Note: This parameter does not be used (for example, default to

NO) for 1-WAY Line-to-Port Connection.
NENDALS can only be set to YES if PROT=YES for the facility.

UPIvalue GSUPP43 Specifies the GFP UPI values transmitted for a TGLAN with
G709AMD3 TRANSMPA=PREAMBLE.
- GSUPP43 - 0xFD for data frames and 0xFE for ordered sets.
Provides compatibility with ITU-T Supplemental43
recommendation.
- G709AMD3 - 0x13 for data frames and 0x14 for ordered sets.
Provides compatibility with ITU-T G.709 recommendation values
first introduced in Amendment 3.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ClkType G709 Specifies the rate of the OTU2 port side facility.
OVRCLK_FS G.709: 10.7 Gb/s
OVRCLK_FS: 11.095 Gb/s

Page 30-456 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.85 ED-OPTD/TGLAN/OTU1/OTU2/OTU3/TGFC Parameters (Continued)

Parameter Value(s) Definition
TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

channel (1) NA (2) 1-88 (3) 191700000 to Specifies either the DWDM channel number or the DWDM
196050000 in increments of 50000 frequency at which the interface operates when the supporting
SFP+ for the facility is a tunable DWDM SFP+.

The channel number can be set to an integer value from 1-88,

corresponding to the DWDM wavelength/frequency in the 7100
88-Channel Plan.
Or the frequency can be set to a value between 191700000 to
196050000 MHz in increments of 50000 MHz which covers a
total of 88 DWDM frequencies (191.7 THz to 196.05 THz in 50
GHz increments.)
A setting of NA (Not Applicable) allows the supporting SFP+ to
operate at its default wavelength.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-2590844] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 20421, default of 3064 (OTU1)
1 to 82026, default of 12304 (OTU2)
1 to 84986, default of 12748 (OTU2e)
1 to 856388, default of 128459 (OTU4)
1 to 863615, default of 129543 (OTU4 with 25% SD-FEC)
1 to 1727230, default of 259085 (OTUC2)
1 to 2590844, default of 388627 (OTUC3)

76.MTFP50/30, Rev B January 2018 Page 30-457

13. Edit Commands TL1 Command Reference Manual

Table 13.85 ED-OPTD/TGLAN/OTU1/OTU2/OTU3/TGFC Parameters (Continued)

Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example: Provisioning TGLAN Facility on OSM-2S in ED- Command

ENT-TGLAN:CORIANT1:TGLAN-20-2-3:AM0074;

ED-TGLAN:CORIANT1:TGLAN-20-2-
3:AM0075:::,PROT=YES,NENDALS=NO,UPIvalue=G709AMD3:IS;

Possible System Response

^^^CORIANT1 06-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ENT-{X}
RTRV-{X}

Page 30-458 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OSC

Command Changes Since Previous Feature Package

• None.

Description
The ED-OSC command instructs the network element (NE) to edit the primary state or alarm profile of a optical
supervisory channel (OSC) facility entity.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• Editing the eon_msg parameter to DISABLED affects the control plane signaling or routing traffic if a
OSCX-ShelfID-SlotID-PortID-2 entity is configured on the OSC and is being used by control plane to
carry signaling or routing traffic.

Command Format
ED-OSC:[tid]:<osc_aid>:<ctag>:::[EONMSG=<eon_msg>]
[,ALMPF=<almProfile>]:[<EditablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.86 ED-OSC Parameters

Parameter Value(s) Definition
osc_aid OSC-20-[10-16,1-7]-21,OSC-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

eon_msg ENABLED Specifies if EON traffic is going through the OSC facility
DISABLED (ENABLED) or is blocked (DISABLED). When set to DISABLED,
it disables the port associated to the OSC facility on the
ROUTER on the NE.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Outof-Service (OOS).

Example
ED-OSC:CORIANTNE:OSC-20-1-21:AM0074::::OOS;

76.MTFP50/30, Rev B January 2018 Page 30-459

13. Edit Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANTNE 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-OSC

Page 30-460 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OSCX

Command Changes Since Previous Feature Package

• None.

Description
The ED-OSCX command instructs the network element (NE) to edit an OSCX entity.

Restrictions and Exceptions

• The CMDMDE=FRCD must be used to edit any parameters if the OSCX facility is owned by the control
plane.

Command Format
ED-OSCX:[tid]:<oscx_aid>:<ctag>:::[TRAFFIC=<Traffic>][,CMDMDE=<commandMode>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.87 ED-OSCX Parameters

Parameter Value(s) Definition
oscx_aid OSCX-20-[10-16,1-7]-21-[2,1],OSCX- EntityID-ShelfID-SlotID-PortID-N
20-[1-16]-1-[2,1]

Traffic ENABLED Controls traffic flow on OSCX/OSCXPOL entity.

DISABLED

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
ED-OSCX::OSCX-1-1-21-2:AM0011:::TRAFFIC=DISABLED,CMDMDE=FRCD;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-461

13. Edit Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSCX
ENT-OSCX
RTRV-OSCX

Page 30-462 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OSPF

Command Changes Since Previous Feature Package

• None.

Description
The ED-OSPF command instructs the network element (NE) to modify the router ID of an OSPF routing instance.

Restrictions and Exceptions

• If the OSPF entity is IS, the router_id parameter cannot be modified unless command_mode is used
with the value FRCD.

• This command is denied if router_id is set to a value of 000.000.000.000.

• If at least one ospf area has been configured for this routing instance, the editablePrimaryState
parameter cannot be set to OOS unless command_mode is used with the value FRCD.

Command Format
ED-OSPF:[tid]:<ospf_aid>:<ctag>:::RTRID=<router_id>[,CMDMDE=<command_mode>]
:[<EditablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.88 ED-OSPF Parameters

Parameter Value(s) Definition
ospf_aid OSPF-[1,3]-1 EntityID-NPID-OSPFID

router_id [0-255].[0-255].[0-255].[0-255] The router ID attribute of the OSPF routing controller forms its
identity in the context of its network.
The router ID needs to be unique within a network. Each
network partition represents a network. A network spans
multiple NEs.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity.

yState OOS Two values are In-Service(IS) and Outof-Service (OOS).

Example
The following example changes the router_id of an ospf routing controller to 192.168.2.1.

76.MTFP50/30, Rev B January 2018 Page 30-463

13. Edit Commands TL1 Command Reference Manual

ED-OSPF:NE01:OSPF-1-1:AM0011:::RTRID=192.168.2.1,CMDMDE=FRCD;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-OSPF
DLT-OSPF
RTRV-OSPF

Page 30-464 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OSPFADJ

Command Changes Since Previous Feature Package

• None.

Description
The ED-OSPFADJ command instructs the network element (NE) to modify the OSPF Area associated with a manual
OSPF routing adjacency.

Restrictions and Exceptions

• This command is denied if the routing area specified in the command is not configured for the routing
controller.

• This command is denied if another adjacency already exists with the same interface_aid and a different
ospfarea_aid value.

• This command is denied if the routing area specified is not on the same OSPF entity as the OSPFADJ
entity.

Command Format
ED-
OSPFADJ:[tid]:<ospfadj_aid>:<ctag>:::[OSPFAREA=<ospfarea_aid>]:[<EditablePrimary
State>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.89 ED-OSPFADJ Parameters

Parameter Value(s) Definition
ospfadj_aid OSPFADJ-[1,3]-1-[1-40] EntityID-NPID-OSPFID-OSPFADJID

ospfarea_aid OSPFAREA-[1,3]-1-[1-32] Specifies the access identifier of the OSPF Area.

editablePrimar IS Specifies the primary state of the entity.

yState OOS Two values are In-Service(IS) and Outof-Service (OOS).

Example
ED-OSPFADJ:NE01:OSPFADJ-1-1-2:AM0011::: OSPFAREA=OSPFAREA-1-1-1;

76.MTFP50/30, Rev B January 2018 Page 30-465

13. Edit Commands TL1 Command Reference Manual

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-OSPFADJ
DLT-OSPFADJ
RTRV-OSPFADJ

Page 30-466 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OSPFAREA

Command Changes Since Previous Feature Package

• Added STUBTYPE attribute.

Description
The ED-OSPFAREA command instructs the network element (NE) to modify the primary state of an OSPF routing
area. Modifying this attribute does not interrupt existing connections for the TPCP network partition. However,
existing connections within the SCN and MCN network partitions experiences service interruption as a result of
these changes.

Restrictions and Exceptions

• If the ospf area has topological links assigned, the editablePrimaryState parameter cannot be set to
OOS unless command_mode is used with the value FRCD.

• The RROVISIBILITY parameter only applies to Recorded Route Object only.

• The RROVISIBILITY/HUB parameter modification can be implemented whenever the primary state of
the entity is IS or OOS.

• STUBTYPE must be DISABLED for backbone areas (RAID=0.0.0.0).

• STUBTYPE must be configured consistent across all IP routers in the OSPFArea for adjacencies to
form.

Command Format
ED-OSPFAREA:[tid]:<ospfarea_aid>:ctag:::
[CMDMDE=<command_mode>][,HUB=<hub>][,PRTPF=<prtpf_aid>][,RROVISIBILITY=<RRoFlag>
][,STUBTYPE=<stubtype>]:[<EditablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.90 ED-OSPFAREA Parameters

Parameter Value(s) Definition
ospfarea_aid OSPFAREA-[1,3]-1-[1-32] EntityID-NPID-OSPFID-OSPFAREAID

command_mo NORM Specifies the way in which the command is executed:

de FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

hub YES Identified the routing area is a hub node.

NO

prtpf_aid CPPF-[94-99,1-20] Specifies the access identifier of the Protocol Profile.

76.MTFP50/30, Rev B January 2018 Page 30-467

13. Edit Commands TL1 Command Reference Manual

Table 13.90 ED-OSPFAREA Parameters (Continued)

Parameter Value(s) Definition
RRoFlag Masked This attribute identifies the visibility of a given OSPF area.
Passed
This state value applies to RRO only.
"Masked" means the RRO for this area is to be propagated
within the area but not to be propagated outside of the area,
whereas "Passed" would mean that the RRO for this area is to
be propagated outside of the area as well as within the area.

stubtype DISABLED This attribute identifies the IPv4 stub area behavior for a given
STUB OSPF area.
NSSA The StubTypes have the following behavior:
Default: DISABLED - DISABLED - no Stub Area behavior. This is the default
behavior.
- STUB - No Type 5 AS-external LSAs propagated from the
Backbone area to this area. Default route inserted by ABR.
- NSSA - No Type 5 AS-external LSAs propagated from the
Backbone area to this area. Default route inserted by the ABR.
Type 7 LSAs generated within this area are converted at the
ABR to Type 5 LSAs and propagated into the Backbone Area.

editablePrimar IS Specifies the primary state of the entity.

yState OOS Two values are In-Service(IS) and Outof-Service (OOS).

Example
ED-OSPFAREA:NE01:OSPFAREA-1-1-1:AM0011:::HUB=YES,RROVISIBILITY=Passed:OOS;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-OSPFAREA
DLT-OSPFAREA
RTRV-OSPFAREA

Page 30-468 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-OSPFRP

Command Changes Since Previous Feature Package

• None.

Description
The ED-OSPFRP command instructs the network element (NE) to modify a redistribution point.

Restrictions and Exceptions

• This command is denied if the CRTAREAID has the same value as the PRTAREAID.

• The command is denied if the first octet specicied in the PLIFINDEX is in the range of 127 to 137 (127
and 137 included by the range).

• The value of the precedence attribute (PRCDNC) must be unique for a child router area ID
(CRTAREAID) when specifying a hierachy redistribution point.

• For an inter domain TL/BL, the GMPLS Mode attribute must set to OIF-ENNI-V1 or OIF-ENNI-V2.

• The CRTAREAID of OSPFRP entity (ABSTRACTNODE type) must match the RAID of the node which
the TL or BL resides on.

• The PRTAREAID of OSPFRP entity (ABSTRACTNODE type) must match the RAID of the TL or BL.

• The CLADDR of OSPFRP entity (ABSTRACTNODE type) must match the NODEID of the node which
TL or BL resides on.

• The CLIFINDEX of OSPFRP entity (ABSTRACTNODE type) must match the IfIndex of a TL or BL.

Command Format
ED-OSPFRP:[tid]:<ospfrp_aid>:<ctag>:::[CRTAREAID=<child_routing_area_id>][,
PRTAREAID=<parent_routing_area_id>][,PNDID=<parent_node_id>][,PTADDR=<parent_tar
get_address>][,PTADDRMSK=<parent_target_address_mask>][,CTADDR=<child_target_add
ress>][,CTADDRMSK=<child_target_address_mask>][,PLADDR=<parent_link_address>][,P
LIFINDEX=<parent_link_ifindex>][,CLADDR=<child_link_address>][,CLIFINDEX=<child_
link_ifindex>][,PRCDNC=<precedence>];

Proper System Response

The completed response indicates that the redistribution point map entry has been modified.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.91 ED-OSPFRP Parameters

Parameter Value(s) Definition
ospfrp_aid OSPFRP-[1,3]-1-[1-3]-[1-100] EntityID-NPID-OSPFID-OSPFRPMAPID-OSPFRPID

76.MTFP50/30, Rev B January 2018 Page 30-469

13. Edit Commands TL1 Command Reference Manual

Table 13.91 ED-OSPFRP Parameters (Continued)

Parameter Value(s) Definition
child_routing_ Enter 32-bit value in dotted decimal The ID attribute of the Child OSPF area.
area_id format. Possible values are: 0.0.0.1 to This parameter is used for all types of redistribution point.
255.255.255.255

parent_routing Enter 32-bit value in dotted decimal The ID attribute of the Parent OSPF area.
_area_id format. Possible values are: 0.0.0.0 to This parameter is used for all types of redistribution point.
255.255.255.255

parent_node_i Enter 32-bit value in dotted decimal Specifies the ID of the parent node for the redistribution point.
d format. Possible values are: 0.0.0.1 to This parameter is used for the hierarchy and reachability
255.255.255.255 redistribution point.

parent_target_ Enter 32-bit value in dotted decimal Specifies the target address of the parent node for the
address format. Possible values are: 0.0.0.1 to reachability redistribution point. The target address specifies the
255.255.255.255 dotted decimal portion of a TNA address.

parent_target_ Enter 32-bit value in dotted decimal Specifies the target address mask of the parent node for the
address_mask format. Possible values are: 0.0.0.0 to reachability redistribution point.
255.255.255.255

child_target_a Enter 32-bit value in dotted decimal Specifies the target address of the child node for the reachability
ddress format. Possible values are: 0.0.0.1 to redistribution point. The target address specifies the dotted
255.255.255.255 decimal portion of a TNA address.

child_target_a Enter 32-bit value in dotted decimal Specifies the target address mask of the child node for the
ddress_mask format. Possible values are: 0.0.0.0 to reachability redistribution point.
255.255.255.255

parent_link_ad Enter 32-bit value in dotted decimal Specifies the parent link address for the abstract node
dress format. Possible values are: 0.0.0.1 to redistribution point. The link address specifies the node ID
255.255.255.255 associated with the link.

parent_link_ifi Enter 32-bit value in dotted decimal Specifies the parent if index for the abstract node redistribution
ndex format. Possible values are: 0.0.0.1 to point.
255.255.255.255

child_link_addr Enter 32-bit value in dotted decimal Specifies the child link address for the abstract node
ess format. Possible values are: 0.0.0.1 to redistribution point. The link address specifies the node ID
255.255.255.255 associated with the link.

child_link_ifind Enter 32-bit value in dotted decimal Specifies the child if index for the abstract node redistribution
ex format. Possible values are: 0.0.0.1 to point.
255.255.255.255

precedence [0-255] Specifies the priority of the map entry for the hierarchy
redistribution point.

Example
ED-OSPFRP:NE01:OSPFRP-3-1-3-
1:ctag:::CRTAREAID=0.0.3.210,PRTAREAID=0.0.3.211,ENTTYP=ABSTRACTNODE,PLADDR=22.3
.30.2,PLIFINDEX=0.142.160.0,CLADDR=120.200.3.250,CLIFINDEX=0.142.160.0;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Page 30-470 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-OSPFRP
DLT-OSPFRP
RTRV-OSPFRP

76.MTFP50/30, Rev B January 2018 Page 30-471

13. Edit Commands TL1 Command Reference Manual

ED-OTS

Command Changes Since Previous Feature Package

• None.

Description
The ED-OTS command instructs the network element (NE) to edit some of the attributes of a Line Side Interface
(OTS) facility entity.

Restrictions and Exceptions

• When no parameter is specified, the behavior is to not change its current setting.

• Name-defined parameters can be entered in any order.

• String parameters must be used in quotes.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• ATPS is applicable for OADMRS/OADMRS9 only if its OTSMODE=7100.

• FiberType is only applicable to OTS of OADMRS/OADMRS9.

• The parameter OTSMODE is only applicable to OTS entity of OADMRS/OADMRS9.

• The attempt to edit OTSMODE is denied if the equipment entity is not administratively OOS.

• OTSMODE can only be edited with CMDMDE = FRCD.

• The attempt to change OTSMODE is denied if one or more OCH-L entities exist on the module.

• CHANTYPES and CHANALLOW are not applicable to OADMRS. OADMRS/OADMRS9 uses

CHANTYPES and CHANALLOW on OMS entity.

• When new OTSmode (first column in the table) is provisioned, the related parameters (columns other
than the first) in following table is explicitly provisioned with default values overriding existing values.

Table 13.92 Parameter Values for OTS Interoperability

OSCMODE GRIDMODE CHANTYPES ATPSENABLED GAINRANGE

RTRV- ED/RTRV-
OTSMODE OSC ED/RTRV-OMS ED/RTRV-OMS ED/RTRV-OTS OTS
7100 155M52 FIXED88_7100 MIXED (default) ENABLED LOW (default)
(default) COHERENTONL (default) HIGH
Y DISABLED

FIXED44_7100 MIXED (default)

COHERENTONL
YHIPWR
COHERENTONL
Y

HIT7300 150M FIXED96_MTERA COHERENTONL - AUTO

FIXED96_NOCHA Y
NPLAN (default)

Page 30-472 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.92 Parameter Values for OTS Interoperability (Continued)

OSCMODE GRIDMODE CHANTYPES ATPSENABLED GAINRANGE

RTRV- ED/RTRV-
OTSMODE OSC ED/RTRV-OMS ED/RTRV-OMS ED/RTRV-OTS OTS
MTERA 150M FIXED96_MTERA COHERENTONL - AUTO
FIXED96_NOCHA Y
NPLAN(default)

• When OTSMODE=MTERA or HIT7300, APAO/APAI can only be AUTO and is not editable.

• Changing APAO to be MAN is denied if OPLADJ is ENABLED.

• On OADMRS/OADMRS9, when OTSMODE=7100, EXPOTSTRC/MONOTSTRC are appliable.

Configuring ExpOPER, ExpDAPI, ExpSAPI, txOPER, txDAPI, txSAPI is denied.

• On OADMRS/OADMRS9, when OTSMODE=MTERA or HIT7300, ExpOPER/ExpDAPI/ExpSAPI/

txOPER/txDAPI/txSAPI are appliable. Configuring EXPOTSTRC or MONOTSTRC is denied.

• OPLADJ is always DISABLED when OTSMODE=7100.

• On OADMRS/OADMRS9, the attempt to provision GAINRANGE to be a value other than AUTO is

denied if its OTSMODE is HIT7300 or MTERA.

• On OADMRS/OADMRS9, GAINRANGE must be configured as a value other than AUTO if its

OTSMODE is 7100.

• The attempt to change GAINRANGE of OADMRS/OADMRS9 is denied if the module is not

administratively OOS or CMDMDE is not FRCD.

• An attempt to change OTSMODE to MTERA or HIT7300 is denied if any OCH-Ls within the OTS have
AAMEGR=MAN.

• The following parameters only have an impact on the OMS when OTSMODE=MTERA or
OTSMODE=HIT7300 and attempts to change their values is denied when OTSMODE=7100:
- RMNTILTCOE
- FSATILT.

Command Format
ED-OTS:[tid]:<ots_aid>:ctag:::[,ALMPF=<almProfile>][,EXPOTSTRC=<OTSExpTrc>]
[,MONOTSTRC=<OTSMonTrc>][,APAO=<APAOutMode>][,APAI=<APAInMode>][,ATPS=<ATPSEnabl
ed>][,FIBRTYPE=<fiberType>][,OTSMODE=<OTSMode>][,GAINRANGE=<gainrange>][,OPLADJ=
<oplAdj>][,EXPSAPI=<ExpSAPI>][,TXSAPI=<txSAPI>][,EXPDAPI=<ExpDAPI>][,TXDAPI=<txD
API>][,EXPOPER=<ExpOperator>][,TXOPER=<txOperator>][,FSATILT=<fsa_tilt>][,RMNTIL
TCOE=<raman_tilt_coeff>][,CMDMDE=<commandMode>]:[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-473

13. Edit Commands TL1 Command Reference Manual

Table 13.93 ED-OTS Parameters

Parameter Value(s) Definition
ots_aid OTS-20-[10-16,1-7]-21,OTS-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

OTSExpTrc One to 28 alphanumeric characters Indicates the expected OTS trace identification.
All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id expected.
Refer to section 2 for the applicable characters.

OTSMonTrc ENABLED-NOAIS Specifies the monitored OTS trace identification mode.

DISABLED - Enter ENABLED-NOAIS to enable monitoring.
Default: DISABLED - Enter DISABLED to disable monitoring.

APAOutMode AUTO Specifies the output power adjustment mode.

MAN - Enter AUTO to indicate the facility is on automatic power
Default: AUTO adjustment.
- Enter MAN to indicate the facility is on manual power
adjustment.

APAInMode AUTO Specifies the input power adjustment mode.

MAN - Enter AUTO to indicate the facility is on automatic power
Default: AUTO; MAN (default for NE adjustment.
Configuration #23 only) - Enter MAN to indicate the facility is on manual power
adjustment.

ATPSEnabled ENABLED Indicates the state of the automatic laser shutdown functionality
DISABLED at the line side interface. When there is a detection of LOS on
Default: ENABLED the line side interface the laser automatically shuts down if the
ATPS is set to ENABLED. If ATPS is set to DISABLED, then the
laser remains on.

fiberType SMF28 Indicates the span fiber type that the specified OTS port is
TERALIGHT connected.
TRUEWAVEREACH
TRUEWAVERS
TRUEWAVEXL
LEAF
G.654
DSF
LS
TWCLASSIC
TWPLUS
Default: SMF28

OTSMode MTERA Indicates the interoperating optical system at the other end of
7100 the span that the OTS port connects:
HIT7300 - MTERA, Interoperation optical system is mTera UTP system
Default: MTERA - 7100, Interoperation optical system is 7100 Nano or 7100 OTS
system
- HIT7300, Interoperation optical system is hiT 7300 optical
system

Page 30-474 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.93 ED-OTS Parameters (Continued)

Parameter Value(s) Definition
gainrange AUTO Specifies the gain range of the OADMRS/OADMRS9 module:
HIGH LOW = gain range 4.5~20.5dB (OADMRS/OADMRS9)
LOW HIGH = gain range 18.5~30.5dB (OADMRS), 10.0~30.5 dB
(OADMRS9)
AUTO, indicating the gain range is not decided by power
management, which is only supported when the module is
controlled under APC/ALC power management in OTSMODE of
MTERA or HIT7300.

Default value of gainrange when its OTSMODE is configured to

corresponding value:
AUTO, if OTSMODE of the module is HIT7300 or MTERA.
LOW, if OTSMODE of the module is 7100.

oplAdj ENABLED Indicates the support of manual provisioning the output power
DISABLED level (opl) on the OTS facility.

When OPLADJ = ENABLED, the opl does not be decided per

measured span loss but the manually input opl value. The
retrieved opl value is the manually input opl value.

When OPLADJ = DISABLED, the opl is decided per measured

span loss. The retrieved opl value is the automatically calculated
target opl value.

Default: DISABLED, when OTSMODE=MTERA

Always ENABLED, when OTSMODE=HIT7300
Always DISABLED, when OTSMODE=7100.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no SAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

For mTera UTP system, the default OTS trace consists of NE

TID and the shelfID and slotID the OTS locates,
"TID,ShelfID,SlotID" when OTSMODE=MTERA or HIT7300.

fsa_tilt -200 to 200 (dB/THz/100) Specifies the Fiber Spectral Attenuation Tilt.

76.MTFP50/30, Rev B January 2018 Page 30-475

13. Edit Commands TL1 Command Reference Manual

Table 13.93 ED-OTS Parameters (Continued)

Parameter Value(s) Definition
raman_tilt_coe 0 to 2000 ((dB/(THz*W))/100) Specifies the Raman Tilt Coefficient.
ff

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example
ED-OTS:CORIANTNE:OTS-20-1-21:AM0074:::APAI=MAN:IS;

Possible System Response

^^^CORIANTNE 14-12-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-OTS

Page 30-476 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-PID

Command Changes Since Previous Feature Package

• Remove support for pid_encrypt =Y

Description
The ED-PID command instructs the network element (NE) to allow the editing a password (pid) in an active session.

When the logon password is entered in the command, only one asterisk (*) appears on the screen, regardless of
how many characters comprise the password. The pid_encrypt parameter is also displayed as an asterisk(*).

The value of the new password (newpid) must be different from the last "XX" passwords (where "XX" = PCNT
attribute set by Admin in ED-SECU-SYS command) in order for the pid to be modified. All users can change only
their own active password.

If the uid is not entered, it is defaulted to the user currently active on the session.

Note that this command is available even the password of the user has aged. However the command is denied if
the user is trying to change his password within the password update waiting period.

Command Format
ED-PID:[tid]:[<uid>]:ctag::<oldpw>,<newpw>[,<pid_encrypt>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.94 ED-PID Parameters

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. UID

76.MTFP50/30, Rev B January 2018 Page 30-477

13. Edit Commands TL1 Command Reference Manual

Table 13.94 ED-PID Parameters (Continued)

Parameter Value(s) Definition
oldpw one string accord with the conditions The oldpw indicates the current password to be changed. It
listed in the definition column must meet the complexity rules mentioned in the "Value(s)"
column.

If the password complexity parameter is set to YES (refer to the

ED-SECU-SYS and RTRV-SECU-SYS commands), the
following rules apply for the password:
-Password length must be 8 characters minimum, 12 characters
maximum.
-At least 3 of the 4 following character types must be present:
numeric character, lowercase alphabetical character, uppercase
alphabetical character, special character.
-Special character consists of any of the following: ! # $ % & @ ^
*
-The Password must not include more than 2 consecutive
repetitions of the same character.
-UID (UserId) must not be contained in password (case
insensitive).

newpw one string accord with the conditions The newpw indicates what the new password is. It must meet
listed in the definition column the complexity rules mentioned in the "Value(s)" column.

If the password complexity parameter is set to YES (refer to the

ED-SECU-SYS and RTRV-SECU-SYS commands), the
following rules apply for the password:
-Password length must be 8 characters minimum, 12 characters
maximum.
-At least 3 of the 4 following character types must be present:
numeric character, lowercase alphabetical character, uppercase
alphabetical character, special character.
-Special character consists of any of the following: ! # $ % & @ ^
*
-The Password must not include more than 2 consecutive
repetitions of the same character.
-UID (UserId) must not be contained in password (case
insensitive).

If the password complexity parameter is set to NO, then the

<pid> can be between 6 and 12 characters long using any of the
characters mentioned above, with no restriction on upper case
or character repetition.
When the <pid_encrypt>=N, pid has to be 6 to 12 alphanumeric
characters.
When the <pid_encrypt>=A, pid has to be 32 alphanumeric
characters and follow AES encryption algorithm.

pid_encrypt N Optional parameter which indicates if the pid, snmpauthpid and

A snmpprivpid is transmitted with AES encryption (A) or no
Default: N encryption (N) in a TL1 command.
When parameter is omitted, PID is sent without encryption.

Example
Example 1
ED-PID:CORIANT1:ADMIN:CP0100::MYPSWD$1,MYPSWD$2;

In any session, this command appears on screen as:

ED-PID:CORIANT1:ADMIN:CP0100::*,*;

Page 30-478 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example 2
ED-PID:CORIANT1:ADMINJR:CP0100::09bee95a865616ca4bfab4335baabd95
,9c1978a598d5ddce801e1d0ea74a00b1,A;

In any session, this command appears on screen as:

ED-PID:CORIANT1:ADMINJR:CP0100::*,*,*;

Example 3
The following sequence of commands are used to change a password from 784XYZcde to !qaz2wsx using MD5
encryption:
Login as Admin1 User to create TestUser:
ENT-USER-
SECU::TestUser:CTAG::784XYZcde,N:UAP=A4,TMOUT=30,PAGE=60,PUWP=50,PELN=4,DBCHGMSG
=INH;

Login as TestUser to change the password:

ACT-USER::TestUser:c::784XYZcde,N;
ED-
PID::TestUser:CTAG::310bbecabb44402c9d8210f47225a842,b12a3a6d70c7bf2d5b049fcd658
c36f7,Y;

Login as TestUser with new password:

ACT-USER::TestUser:c::!qaz2wsx;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M CP0100 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-USER-SECU
ENT-USER-SECU
RTRV-USER-SECU
ED-SECU-SYS
RTRV-SECU-SYS

76.MTFP50/30, Rev B January 2018 Page 30-479

13. Edit Commands TL1 Command Reference Manual

ED-PMPF-{X}

Command Changes Since Previous Feature Package

• Added support of ODUk mux into ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ED-PMPF command instructs the network element (NE) to modify the attributes of a Performance Monitoring
profile. PM profiles are used to specify the threshold levels for monitored SDH, SONET, ODUk path facilities that,
when exceeded, triggers an automatic message (TCA).

• Facilities (fac_type): ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, STS1, STS3C, STS12C,
STS48C, STS192C.

• The threshold settings of this PM profile may be retrieved using the RTRV-PMPF command.

Restrictions and Exceptions

• PM Profiles 1-20 are editable.

• This command is denied if the editing targets at the PM parameter of a given direction in this profile is
referenced from a facility entity. For example, if a facility supports a PM parameter in RCV direction,
then editing the Profile PM parameter associated with RCV is denied.

• When the threshold level <thlev> parameter is set to 0 for a counter montype, then no automatic
message (TCA) is generated for this montype. Also, any TCAs announced during the time period, prior
to setting the parameter to 0 is still visible via RTRV-TCA.

Command Format
ED-PMPF-<fac_type>:[tid]:<pmpf_aid>:ctag::<montype>,<thlev>,<dirn>[,<tmper>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.95 ED-PMPF-{X} Parameters

Parameter Value(s) Definition
pmpf_aid PMPF-[99,1-20,0] EntityID-PMPFID

montype x Specifies the type of performance monitoring for the specified

entity.
- x: To be used to specify current threshold value for <montype>
x.
Where possible values of <montypes> can be found in RTRV-
PM command.

Page 30-480 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.95 ED-PMPF-{X} Parameters (Continued)

Parameter Value(s) Definition
thlev (1)0-9223372036854775807 (2)0, Specifies the desired threshold value of the selected
0.00001 to 15 (3)DFLT performance monitoring parameter.
0, 0.00001 to 15 is the possible value range for the EB-ODU
parameter for an ODUF
Enter DFLT to set threshold level back to the default value.
The value depends on the montype.

dirn TDTC Specifies the direction of an event/occurrence in the system:

TDTN - TDTC specifies Transmit direction toward customer.
RCV - TDTN specifies Transmit direction toward DWDM network.
TRMT - RCV specifies Receive direction.
NA - TRMT specifies Transmit direction.
- NA specifies the direction is not applicable.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
Default: 15-MIN - Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

Example
ED-PMPF-ODU1::PMPF-1:AM0011::BBEHP,100,TDTC,1-DAY;

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-PMPF
RTRV-PMPFUSE

76.MTFP50/30, Rev B January 2018 Page 30-481

13. Edit Commands TL1 Command Reference Manual

ED-PPG-ODUk

Command Changes Since Previous Feature Package

• Added support of ODUk mux into ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ED-PPG-ODUk (Edit ODUk Path Protection Group) command provides for editing the attributes of a path
protection group.

Restrictions and Exceptions

• Neither the protected or protecting facilities of the protection group can be modified.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• When the current status is WTR or DNR, the system rejects the enable/disable action for
BIDIR_SIWTCH.

• Any parameter modifications of the PPG is denied when the PPG is owned by CP.

• This command not apply for the ODUk associated with SSM-2S that has 1+1 EPG provisioned.

Command Format
ED-PPG-
<fac_type>:[tid]:<protectedId>,<protectingId>:ctag:::[RVRTV=<rvrtv>][,WTR=<wtr>]
[,HOLDOFFPROT=<HoldOffProt>][,BIDIR_SWITCH=<BIDIR_SWITCH>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-482 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.96 ED-PPG-ODUk Parameters

Parameter Value(s) Definition
protectedId ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-Num]|[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-483

13. Edit Commands TL1 Command Reference Manual

Table 13.96 ED-PPG-ODUk Parameters (Continued)

Parameter Value(s) Definition
protectingId ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-Num]|[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive.
Default value is no change to current value.

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
Default: 300 seconds switch’s back immediately.
Note this parameter applies only when FFP is revertive.

HoldOffProt 0,60-1000 in increments of 5 msec If no additional hold-off time for a protection switch is desired,
then the value is set to zero. Hold off timer is typically employed
when supporting nested protection domains and a hold off time
is required to allow another protection domain to execute a
switch before doing so on the subject PPG.

bidir_switch ENABLED Specifies if the SNC protection is unidirectional or bidirectional

DISABLED switching.
Default: DISABLED - DISABLED: unidirectional SNC
- ENABLED: bidrectional SNC
By default the value is DISABLED for unidirectional switching

Example
ED-PPG-ODU1:CORIANT1:ODU1-20-6-1-1,ODU1-20-7-2-
5:AM0075:::RVRTV=YES,WTR=600,HOLDOFFPROT=60,BIDIR_SWITCH=ENABLED;

Page 30-484 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0075 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-PPG-ODUk

76.MTFP50/30, Rev B January 2018 Page 30-485

13. Edit Commands TL1 Command Reference Manual

ED-PPG-STSn

Command Changes Since Previous Feature Package

• None.

Description
The ED-PPG-STSn (Edit STSn Path Protection Group) command provides for editing the attributes of a path
protection group.

Restrictions and Exceptions

• Neither the protected or protecting facilities of the protection group can be modified.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• Any parameter modifications of the PPG is denied when the PPG is owned by CP.

Command Format
ED-PPG-
<fac_type>:[tid]:<protectedId>,<protectingId>:ctag:::[RVRTV=<rvrtv>][,WTR=<wtr>]
[,HOLDOFFPROT=<HoldOffProt>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.97 ED-PPG-STSn (for STS1/STS3C/STS12C/STS48C) Parameters

Parameter Value(s) Definition
protectedId STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

Page 30-486 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.97 ED-PPG-STSn (for STS1/STS3C/STS12C/STS48C) Parameters (Continued)

Parameter Value(s) Definition
protectingId STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive.
Default value is no change to current value.

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
Default: 300 seconds switch’s back immediately.
Note this parameter applies only when FFP is revertive.

HoldOffProt 0,60-1000 in increments of 5 msec If no additional hold-off time for a protection switch is desired,
then the value is set to zero. Hold off timer is typically employed
when supporting nested protection domains and a hold off time
is required to allow another protection domain to execute a
switch before doing so on the subject PPG.

Example

ED-PPG-STS1:CORIANT1:STS1-20-6-1-25,STS1-20-7-2-
5:AM0075:::RVRTV=YES,WTR=600;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0075 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-PPG-STSn

76.MTFP50/30, Rev B January 2018 Page 30-487

13. Edit Commands TL1 Command Reference Manual

ED-PPP

Command Changes Since Previous Feature Package

• None.

Description
The ED-PPP command instructs the network element (NE) to modify the attributes of a PPP session over DCC of
an OCn facility.

Restrictions and Exceptions

• CMDMDE=FRCD parameter should be used to change the editablePrimaryState from IS to OOS or if
the ppppf_aid value is modified.

• The CMDMDE=FRCD must be used to edit any parameters if the PPP entity is owned by the control
plane.

• The CMDMDE=FRCD must be used to edit any parameters if the PPP is enabled in MCN.

Command Format
ED-
PPP:[tid]:<ppp_aid>:ctag:::[PPPPF=<ppppf_aid>][,ALMPF=<almProfile>][,CMDMDE=<com
mandMode>]:[<EditablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.98 ED-PPP Parameters

Parameter Value(s) Definition
ppp_aid PPPL-[20]-[1-16]-[1-30], PPPL-[20]-[1- EntityID-ShelfID-SlotID-PortID[-Index]
16]-99-[1-30]
PPPMS-[20]-[1-16]-[1-30], PPPMS-
[20]-[1-16]-99-[1-30]
PPPRS-[20]-[1-16]-[1-30], PPPRS-
[20]-[1-16]-99-[1-30]
PPPS-[20]-[1-16]-[1-30], PPPS-[20]-
[1-16]-99-[1-30]

ppppf_aid PPPPF-[99,1-10] Specifies the access identifier of the PPP protocol profile.

almProfile 0-20, 99 Specifies the alarm profile to use for this entity.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Page 30-488 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.98 ED-PPP Parameters (Continued)

Parameter Value(s) Definition
editablePrimar IS Specifies the primary state of the entity.
yState OOS Possible values are:
- IS: In-Service
- OOS: Out-of-Service

Example
ED-PPP:NE01:PPPL-20-3-6:AM0011:::CMDMDE=FRCD:OOS;

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-PPP
DLT-PPP
RTRV-PPP

76.MTFP50/30, Rev B January 2018 Page 30-489

13. Edit Commands TL1 Command Reference Manual

ED-PPPPF

Command Changes Since Previous Feature Package

• None.

Description
The ED-PPPPF command instructs the network element (NE) to modify the attributes of a PPP profile. PPP profiles
are used to specify the data link layer attributes of a PPP session over GCC of an OTN facility.

Restrictions and Exceptions

• Protocol Profiles 1-10 are editable.

• The command is denied if the GCC or PPP entities associated with the PPPPF are not in OOS-MA
state.

• String parameters must be used in quotes.

Command Format
ED-
PPPPF:[tid]:<ppppf_aid>:ctag:::[PFNAME=<pfname>][,MRU=<maximum_receive_units>][,
FCS=<fcs>][,RESTARTMR=<restart_timer>][,MAXFAILCNT=<max_failure_count>] ;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.99 ED-PPPPF Parameters

Parameter Value(s) Definition
ppppf_aid PPPPF-[99,1-10] EntityID-PPPPFID

pfname 0 to 31 alphanumeric characters. Specifies the customer entered additional field to lable the PPP
profile.
Refer to section 2 for the applicable characters.

maximum_rec 576-1500 octets Specifies the maximum number of octets in the Information and
eive_units Padding fields.

fcs 16 Specifies whether the frame check sequence is a 16-bit or 32-bit

32 value.
Default: 16

restart_timer [1-10] Specifies the restart timer of the PPP protocol profile.
Default: 3 Unit: seconds

max_failure_c [2-10] Specifies the maximum failure value of the PPP protocol profile.
ount Default: 5

Page 30-490 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example
ED-PPPPF:NE01:PPPPF-1:AM0011:::PFNAME="Default Profile",MRU=1500;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-PPPPF

76.MTFP50/30, Rev B January 2018 Page 30-491

13. Edit Commands TL1 Command Reference Manual

ED-PROXY

Command Changes Since Previous Feature Package

• None.

Description
The ED-PROXY command instructs the mTera Univeral Transport Platform NE to edit the proxy mode of the NE.
The proxy mode of the mTera NE specifies the mode of applications running on it.

When the mTera NE is directly connected to the customer's DCN using the public IP address space, the proxy mode
is set to "DISABLED". This requires all mTera applications to run without the client/server application gateway.
When the mTera NE participates in the legacy Private EON with a networking function as PRNE, the proxy mode is
set to "CLIENT". This requires all mTera applications to use the gateway capability running on the PGNE to
communicate with its server.

Command Format
ED-PROXY:[tid]::ctag:::PROXYMODE=<ProxyMode>;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.100 ED-PROXY Parameters

Parameter Value(s) Definition
ProxyMode DISABLED Specifies the Applications proxy mode on the NE.
CLIENT The default value is DISABLED.
Default: DISABLED

Example
The following example changes the Proxy Mode to "DISABLED":
ED-PROXY:CORIANT1::KTRP01:::PROXYMODE=DISABLED;

Possible System Response

CORIANT1 06-05-15 02:08:15
M KTRP01 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-PROXY

Page 30-492 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-RSVPADJ

Command Changes Since Previous Feature Package

• None.

Description
The ED-RSVPADJ command instructs the network element (NE) to edit a RSVP signaling adjacency.

RSVP Signaling Adjacency entities (that is, RSVPADJ) are automatically created and deleted by the control plane
software. The control plane attempts to create a signaling adjacency to a neighbor if the signaling controller (RSVP
entity) is IS and at least one TL with signaling enabled is IS to the neighbor. Only one signaling adjacency is created
per neighbor. The control plane deletes a signaling adjacency if the signaling controller is OOS or if the TL with
signaling enabled is put OOS and there are no IS TLs with signaling enabled to the neighbor.

Restrictions and Exceptions

• Since the RSVPADJ entity is not persisted by the system , changes to the primary state parameter does
not be persisted over a system reset.

Command Format
ED-RSVPADJ:[tid]:<rsvpadj_aid>:<ctag>::::[<EditablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.101 ED-RSVPADJ Parameters

Parameter Value(s) Definition
rsvpadj_aid RSVPADJ-[1,3]-1-[1-40] EntityID-NPID-RSVPID-RSVPADJID

editablePrimar IS Indicates the primary state and primary state qualifier

yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

Example
ED-RSVPADJ::RSVPADJ-2-1-1:AM0011::::OOS;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-493

13. Edit Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

REPT^ALM ADJ
RTRV-RSVPADJ

Page 30-494 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-SECU-SYS

Command Changes Since Previous Feature Package

• Updated to add FIPS mode restrictions

Description
The ED-SECU-SYS command instructs the network element (NE) to allow a system administrator to edit the
following system security attributes of all users: the number of allowed invalid login attempts, the suspension period
after unsuccessful login attempts, the number of most recently used passwords, the password complexity checking,
the interval for disabling inactive users and the interval for generating an event for inactive user.

When a parameter is not edited, the command default is no change in current parameter status. All parameters are
name-defined.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• The UOUT and IRT parameters do not apply to A8 (Admin) TL1 user account

• The IRT parameter value must always be less than or equal to UOUT value

• Setting SECURE=FIPS is permitted when the ED-SECU-SYS parameters are set as described
below. In addition, these constraints is enforced if the user tries to edit one of these parameters
when SECURE=FIPS.

- Maximum invalid login attempts (MXINV), the value of zero is not allowed
- Suspension time following invalid login attempts (DURAL), the value of zero is not allowed.
- Password count (PCNT), the value of zero is not allowed
- Password complexity (PWDCOMPL) must be set to Yes
- User account inactivity (UOUT), the value of zero is not allowed

• Setting SECURE=FIPS is permitted when the ED-TCPIP parameters are set as follows:

-TELNET can only be set to SECURE

-FTP can only be set to SECURE
-SSHKEYSTRENGTH can only be set to 2048

• Setting SECURE=FIPS or SECURE=NONFIPS is only permitted when the standby STPM is OOS. If
the standby STPM is not OOS this command is denied.

• Setting SECURE=FIPS is permitted when at least one user account meets the following constraints:

ENT-USER-SECU command parameters need to meet the following constraints

- UAP=A8
- Password age (PAGE), the value 0 is not allowed
- Password update waiting period (PUWP), the value 0 is not allowed
- Session timeout (TMOUT), the value 0 is not allowed
- Password expired login number (PELN), the value 0 is not allowed

This account must not be a RADIUS user account. The Password Aging Interval has not been exceeded

76.MTFP50/30, Rev B January 2018 Page 30-495

13. Edit Commands TL1 Command Reference Manual

(ED-USER-SECU parameter PAGE not exceeded) for this account. This account is not disabled due to
consecutive invalid login attempts. (ED-SECU-SYS DURAL parameter). The TL1 password (pid) for this
account must be saved using a FIPS compliant algorithm (see RTRV-USER-SECU).

• Setting SECURE=FIPS is permitted when RADIUS authentication is disabled. RADIUS authentication

is disabled when no AAA servers are configured.

• When the command is denied, the violation is identified in the response with a TL1 error code of SNVS
that is,, the TL1 Additional Text has different error messages depending upon the first violation
encountered. v

• The parameter secureMode can only be specified if the NE is still in an unknown configuration (that is,
TYPE=NA and STYPE=NA) that is,, during Basic Commissioning.

Command Format
ED-SECU-SYS:[tid]::ctag::[,MXINV=<loginTriesNum>][,DURAL=<suspensionDuration>]
[,PCNT=<passwordCount>][,PWDCOMPL=<pwdcompl>][,UOUT=<uout>][,IRT=<irt>][,SECURE=
<secureMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.102 ED-SECU-SYS Parameters

Parameter Value(s) Definition
loginTriesNum [0-9] This attribute is the maximum number of consecutive and invalid
Default: 3 login attempts before an account is suspended (lockedout).The
user is locked-out for the period defined in the
<suspensionDuration> attribute and can not be unlocked by
Admin during that period.
Setting the value to 0 disables this attribute.

suspensionDur [0-300] This attribute is the duration of UID suspension following

ation Default: 60 seconds consecutive invalid login attempts.
Setting the value to 0 disables this attribute.

passwordCoun [0-10] This attribute specifies the number of previously used

t Default: 5 passwords remembered by the system for one UID, which
cannot be repeated when changing to a new password.
When PCNT=0 new password can be the same as the current
password.
When PCNT=1 new password can not be the same as the
current password.
When PCNT=2 new password can not be the same as the
current password and the previously used password.
When PCNT=3 new password cant not be the same as the
current password and as the last 2 previous passwords, and so
on.
Setting the value to 0 disables this attribute.

Page 30-496 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.102 ED-SECU-SYS Parameters (Continued)

Parameter Value(s) Definition
pwdcompl YES This attribute specifies if password complexity checking is
NO enabled (YES) or disabled (NO) on the TL1 interface. When the
Default: YES value is YES, the password <pid> must conform to the following
rules:
-Password length must be 8 characters minimum, 12 characters
maximum.
-At least 3 of the 4 following character types must be present:
numeric character, lowercase alphabetical character, uppercase
alphabetical character, special character.
-Special character consists of any of the following: ! # $ % & @ ^
*
-The Password must not include more than 2 consecutive
repetitions of the same character.
-UID (UserId) must not be contained in password (case
insensitive).

If the password complexity parameter is set to NO, then the

<pid> can be between 6 and 12 characters long using any of the
characters mentioned above, with no restriction on upper case
or character repetition.

uout [0-365] Inactivity Disable threshold. Specifies the time interval (in days)
Default: 60 days for disabling a user account that has not been used during that
interval. Inactive users has their STATUS=DISABLED once this
interval is reached.
Note: this parameter does not apply to TL1 user with UAP=A8.
Setting the value to 0 disables this attribute.

irt [0-365] Inactivity Report threshold. Specifies the time interval (in days)
Default: 60 days for generating an INACTIVE Event Condition type for a user
account that has not been used during that interval.
Note: this parameter does not apply to TL1 user with UAP=A8.
The value for this parameter must always be inferior or equal to
the UOUT (uout) parameter.
Setting the value to 0 disables this attribute.

secureMode FIPS This attribute specifies whether the system security is operating
NONFIPS in FIPS compliance mode.
Default: NONFIPS

Example: only MXINV parameters is edited.

ED-SECU-SYS:CORIANT1::CP0100::MXINV=5;

Possible System Response

CORIANT1 02-04-16 02:08:15
M CP0100 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SECU-SYS

76.MTFP50/30, Rev B January 2018 Page 30-497

13. Edit Commands TL1 Command Reference Manual

ED-SLOT

Command Changes Since Previous Feature Package

• None.

Description
The ED-SLOT command instructs the network element (NE) to edit the alarm profile or state parameters of the
specified SLOT entity.

Restrictions and Exceptions

• This command does not support sub-slots (such as SFP modules).

• COMMCONN is only applicable to SLOT 34 and 35 on shelf of mTera UTP NE.

• The attempt to provision COMMCONN as a subslot entity is denied if the subslot entity does not exist.

• The attempt to provision COMMCONN as a subslot entity is denied if the subslot entity is not supporting
by an OADMRS module on the same shelf.

• The attempt to provision COMMCONN as a subslot entity is denied if there is equipment entity created
on the subslot entity, for example, OMD or DCM.

• The attempt to provision COMMCONN as a subslot entity is denied if the subslot entity is used as
COMMCONN of other SLOT entity.

Command Format
ED-
SLOT:[tid]:<slot_aid>:ctag:::[ALMPF=<almProfile>][,CMDMDE=<commandMode>][,COMMCO
NN=<comm_connection>]:[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.103 ED-SLOT Parameters

Parameter Value(s) Definition
slot_aid SLOT-20-[1-35]-[1-32], SLOT-[50-58]- EntityID-ShelfID-SlotID[-SubslotID]
[1-8]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Page 30-498 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.103 ED-SLOT Parameters (Continued)

Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

comm_connec NA, SLOT-20-[1-16]-[1-3] Specifies the OADMRS subslot of the same shelf used as the
tion communication connection (COMM port) for the module in the
SLOT.

- NA indicates there is no specified COMM connection to a

subslot.
- SLOT AID indicates the connecting COMM port.

editablePrimar IS Specifies the primary state of the entity.

yState OOS Possible primary states include:
- IS: In-Service
- OOS: Out-of-Service

Example
ED-SLOT:CORIANT1:SLOT-20-1:AM0074:::ALMPF=1;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Example
Establish a connection between an FSM and OADM in slot 3 COMM port 1 (Note, the
FSM and OADM must have the same Shelf Number):

ED-SLOT:CORIANT1:SLOT-20-34:CTAG:::COMMCONN=SLOT-20-3-1;

Possible System Response

^^^CORIANT1 06-03-15 07:23:17

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SLOT

76.MTFP50/30, Rev B January 2018 Page 30-499

13. Edit Commands TL1 Command Reference Manual

ED-SLPF

Command Changes Since Previous Feature Package

• None.

Description
The ED-SLPF command instructs the network element's (NE) Control Plane to modify a pre-defined service level
profile. Service level profiles is referenced by service level policies.

The service level profile and service level policy parameters provide the ability to perform code point translation for
control plane messages traversing the link that references this profile. This is necessary because code points are
not standardized and translation may need to be done between service providers.

Restrictions and Exceptions

• When the PROTLVL parameter value is set to REROUTE, 2PORTREROUTE or FULLTIME, at least
one of the two parameter values (RRTBDRYREROUTE, RRTETOEREROUTE) must be set to YES.

• When the RRTCALLSETUP parameter value is set to YES, at least one of the two parameter values
(RRTBDRYREROUTE, RRTETOEREROUTE) must be set to YES.

• DIVERSITY only applies when a diverse calculation is needed for a given call/service.

• RESCONNB only applies during the connection setup of the nominal protect path for
1P1TWOSTRIKES,2PORT,2PORTREROUTE and FULLTIME calls. RESCONNB is ignored during the
connection setup of UNPROTECT and REROUTE calls.

• When the PROTLVL parameter value is set to 2PORTREROUTE, RESVSTYLE is restricted to SE.

• TRANSLINEMSDCC, TRANSSECTIONRSDCC do not apply to mTera platform, the setting is ignored

by mTera.

Command Format
ED-
SLPF:[tid]:<aid>:ctag:::[PROFNAME=<profile_name>][,PROTLVL=<protection_level>][,
DIVERSITY=<diversity>][,REVERSION=<reversion>][,WTR=<reversiontime>][,RRTCALLSET
UP=<rrt_call_setup>][,RRTMAXREROUTE=<rrt_max_reroute_attempts>][,RRTBOFFIVAL=<rr
t_back_off_interval>][,RRTBDRYREROUTE=<rrt_boundary_reroute>][,RRTETOEREROUTE=<r
rt_end_to_end_reroute>][,COROUTING=<corouting>][,TRANSLINEMSDCC=<transparent_lin
e_MS_DCC>][,TRANSSECTIONRSDCC=<transparent_section_RS_DCC>][,TRANSOTUGCC0=<trans
parent_OTU_GCC0>][,TRANSODUGCC12=<transparent_ODU_GCC1_2>][,LATENCY=<latency>][,
RESVSTYLE=<ReservationStyle>][,RESCLASS=<ResourceClass>][,PRIO=<priority>][,RESC
ONNA=<ResourceConnA>][,RESCONNB=<ResourceConnB>][,CPREVERSION=<cp_reversion>][,C
PWTR=<cp_wtr>][,DIVERSITYCHECK=<diversity_check>]<cr><lf>;

Note: following parameters are not applied to mTera system:

TRANSLINEMSDCC, TRANSSECTIONRSDCC

Proper System Response

The completed response indicates that the service level profile under the service level profile <aid> has been
successfully modified.

Page 30-500 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.104 ED-SLPF Parameters

Parameter Value(s) Definition
aid SLPF-[99,1-20] EntityID-SLPFID

profile_name One to 31 alphanumeric characters. Name of the service level profile.

This parameter identifies one of twenty(20) pre-defined service
level profiles.
It is highly recommended to enter a name that maps uniquely to
an 'aid'.

protection_lev 1P1TWOSTRIKES Protection levels:

el UNPROTECT 1P1TWOSTRIKES - service is protected but is interrupted when
REROUTE both the working and protect paths have failed
FULLTIME UNPROTECT - no protection is requested
2PORT REROUTE - service is unprotected but attempts to be rerouted
2PORTREROUTE when the path fails
DONOTOVERRIDE FULLTIME - service is 1+1 protected and attempts to reroute
the broken leg while service is ongoing
2PORT - two unprotected paths is created but the paths does
not be rerouted when failure occurs.
2PORTREROUTE - two unprotected paths is created and the
paths is rerouted when failure occurs.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

diversity LINK Used to avoid/exclude nodes and/or links in the routing of a call.
SRLG LINK - The call avoids common links.
DONOTOVERRIDE SRLG - is used in diversity path computation. The SRLG values
list is extracted from the path which a subsequent path is
diversed from.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

NOTE: While this parameter share the same semantics as the

parameter for CALL and shares a superset of parameter values,
only the subset of parameter values listed above applies in the
service level profile application context.

reversion NO Specifies whether to perform reversion back to the path prior to

YES protection action after restoration.
DONOTOVERRIDE DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

rrt_call_setup NO Reroute at call setup

YES
DONOTOVERRIDE

rrt_max_rerout [0-3] Maximum number of reroute attempts.

e_attempts NOTE: This is the number of attempts on top of the initial
reroute.

76.MTFP50/30, Rev B January 2018 Page 30-501

13. Edit Commands TL1 Command Reference Manual

Table 13.104 ED-SLPF Parameters (Continued)

Parameter Value(s) Definition
rrt_back_off_in [0-60] Back-off time between reroute attempts.
terval

rrt_boundary_r NO Reroute is performed at domain boundary points.

eroute YES
DONOTOVERRIDE

rrt_end_to_en NO Reroute is performed at call end points.

d_reroute YES
DONOTOVERRIDE

transparent_O NO Provides transparency for the OTU GCC0 channel.

TU_GCC0 DONOTOVERRIDE DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

transparent_O NO Provides transparency for the ODU GCC-1 and GCC-2

DU_GCC1_2 DONOTOVERRIDE channels.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

latency [0-65535] The maximum aggregated data transmission delay allowed for
the end-to-end circuit.
Unit: micro-seconds
0: No latency constraint

ReservationSt SE This parameter specifies the reservation style of service level

yle FF profile (to use for new calls).
SE: Shared Explicit
FF: Fixed Filter

ResourceClas A double quoted 4 byte hex strings. 32-bit long bit-mapped field with each bit representing a specific
s resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example:
"3E04990A"
Example bit-mapped resource class definitions:
"00000000" - None
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

priority Possible values are: (1)0 to 7 This parameter specifies the restoration priority.
(2)DONOTOVERRIDE 0 is the highest priority.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

Page 30-502 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.104 ED-SLPF Parameters (Continued)

Parameter Value(s) Definition
ResourceConn AVAIL During connection setup of the nominal working path for
A AVAIL&FAILED 1P1TWOSTRIKES, UNPROTECT, REROUTE, FULLTIME,
2PORT and 2PORTREROUTE calls, this parameter specifies
the following:

AVAIL - During connection setup, the end-to-end connection is

established over unused capacity on links that are
administratively in-service and operationally in-service.
AVAIL&FAILED - During connection setup, the end-to-end
connection is established over unused capacity on links that are
administratively in-service. The link state can be operationally
in-service or operationally out-of-service.

ResourceConn AVAIL During connection setup of the nominal working path for
B AVAIL&FAILED 1P1TWOSTRIKES, UNPROTECT, REROUTE, FULLTIME,
2PORT and 2PORTREROUTE calls, this parameter specifies
the following:

AVAIL - During connection setup, the end-to-end connection is

established over unused capacity on links that are
administratively in-service and operationally in-service.
AVAIL&FAILED - During connection setup, the end-to-end
connection is established over unused capacity on links that are
administratively in-service. The link state can be operationally
in-service or operationally out-of-service.

cp_reversion NO Specifies whether to revert traffic back to nominal working/

AUTO protect path after the fault is cleared.
MAN NO: do not revert when fault on nominal connection path has
cleared.
AUTO: automatically revert traffic back to nominal path.
MAN: revert traffic back to nominal path upon request.

cp_wtr [0-3600] Specifies Control Plane Wait To Revert timer.

Unit: second
A value of zero causes the connection path to be reverted
immediately.
Note this parameter may always be configured but applies only
when cp_reversion in the SLPF is AUTO.

diversity_chec HARD HARD: Perform diversity check when the preferred restoration
k SOFT path is specified for a connection.
SOFT: No diversity check of the preferred restoration path is
done in the provisioning phase.

wtr [0-3600] Specifies Wait To Restore time to provisioned on a PPG. Valid

values: 0-3600 seconds. A value of zero causes the PPG switch
back immediately.
Note this parameter may always be configured but applies only
when reversion in the SLPF is YES or reversion in the SLPF is
DONOTOVERRIDE and the signaling message indicates
reversion is YES.

co_routing NO Specifies signaling of component connections along the same

route or through different routes.
A co-signaled VCAT group implies corouting.

76.MTFP50/30, Rev B January 2018 Page 30-503

13. Edit Commands TL1 Command Reference Manual

Example
The following example modifies the name of the service level profile with <aid> "SLPF-2" to "FiveNinesAvailability",
modifies the nominal working path to route over AVAIL capacity, and modifies the nominal protect path to route over
AVAIL&FAILED capacity.
ED-SLPF::SLPF-
2:AM0011:::PROFNAME="FiveNinesAvailability",RESCONNA=AVAIL,RESCONNB=AVAIL&FAILED
;

Possible System Response

CORIANT1 11-05-15 02:08:15
M AM0011 COMPLD
;

Parameter values for Default Service Level Profile SLPF-99

Table 13.105

Keyword Default Value(s)

aid SLPF-99

PROFNAME
““
PROTLVL
DONOTOVERRIDE
DIVERSITY LINK
REVERSION NO
WTR 300
RRTCALLSETUP NO
RRTMAXREROUTE 1
RRTBOFFIVAL 5
RRTBDRYREROUTE YES
RRTETOEREROUTE YES
COROUTING NO
TRANSLINEMSDCC NO
TRANSSECTIONRSDCC NO
TRANSOTUGCC0 NO
TRANSODUGCC12 NO
LATENCY 0
RESVSTYLE SE
RESCLASS ““
PRIO DONOTOVERRIDE
RESCONNA AVAIL

Page 30-504 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.105 (Continued)

RESCONNB AVAIL
CPREVERSION NO
CPWTR 300
DIVERSITYCHECK SOFT

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-SLPOLICY
RTRV-SLPF
ENT-CALL

76.MTFP50/30, Rev B January 2018 Page 30-505

13. Edit Commands TL1 Command Reference Manual

ED-SLPOLICY

Command Changes Since Previous Feature Package

• None.

Description
The ED-SLPOLICY command instructs the network element's (NE) Control Plane to modify a pre-defined service
level policy.
NOTE: A service level policy can support multiple service level code-points.

Restrictions and Exceptions

• SLCODE must be unique under a service level policy profile aid, that is, no duplicate SLCODE.

• Specifying SLPFAIDx is not allowed when SLCODEx (x=1/2/3/4/5/6/7/8/9/10) is set to DFLT.

Command Format
ED-
SLPOLICY:[tid]:<aid>:ctag:::[POLICYNAME=<policy_name>][,SLCODE1=<service_level_c
ode_point>][,SLPFAID1=<service_level_profile_aid>][,SLCODE2=<service_level_code_
point>][,SLPFAID2=<service_level_profile_aid>][,SLCODE3=<service_level_code_poin
t>][,SLPFAID3=<service_level_profile_aid>][,SLCODE4=<service_level_code_point>][
,SLPFAID4=<service_level_profile_aid>][,SLCODE5=<service_level_code_point>][,SLP
FAID5=<service_level_profile_aid>][,SLCODE6=<service_level_code_point>][,SLPFAID
6=<service_level_profile_aid>][,SLCODE7=<service_level_code_point>][,SLPFAID7=<s
ervice_level_profile_aid>][,SLCODE8=<service_level_code_point>][,SLPFAID8=<servi
ce_level_profile_aid>][,SLCODE9=<service_level_code_point>][,SLPFAID9=<service_l
evel_profile_aid>][,SLCODE10=<service_level_code_point>][,SLPFAID10=<service_lev
el_profile_aid>];

NOTE: Parameter pairs are NOT required to be specified in numerical sequence. The change of SLCODE from one
SL codepoint to another does not stipulate a change of the associated SL profile (SLPFAID). Conversely, the
change of SLPFAID from one SL profile to another does not stipulate a change to the associated SL codepoint
(SLCODE).

Proper System Response

The completed response indicates that the service level policy under the service level policy <aid> has been
successfully modified.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.106 ED-SLPOLICY Parameters

Parameter Value(s) Definition
aid SLPOLICY-[1-20] EntityID-SLPOLICYID

Page 30-506 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.106 ED-SLPOLICY Parameters (Continued)

Parameter Value(s) Definition
policy_name Alpha-numeric text string up to 30 The name of the service level policy to be modified.
characters.

service_level_ (1)0-255 (2)NONE (3)DFLT The service level code-point corresponding to a specific service
code_point level profile associated with an internetworked carrier.
DFLT - resets to the default value:
NONE, and the corresponding SLPFAID to SLPF-99.

service_level_ SLPF-[99,1-20] 'aid' of the service level profile to be associated with the service
profile_aid level codepoint.
A service level profile can service multiple code-points.

param_name SLCODE1 Identifies one of the parameters in the service level policy.
SLCODE2
SLCODE3
SLCODE4
SLCODE5
SLCODE6
SLCODE7
SLCODE8
SLCODE9
SLCODE10

Example
The following example adds the service level code points 200 and 210, and their associated service level profile
"FiveNinesByReroute" under the service level policy "PlatinumAccess" referenced by <aid> "SLPOLICY-01":
ED-SLPOLICY::SLPOLICY-1:AM0011:::POLICYNAME="PlatinumAccess",SLCODE2=210,
SLPFAID2=SLPF-2,SLCODE1=200,SLPFAID1=SLPF-1;

To reset a policy parameter to its default value:

ED-SLPOLICY:[tid]:<aid>:ctag:::<param_name>=DFLT;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-SLPF
ENT-CALL
RTRV-SLPOLICY

76.MTFP50/30, Rev B January 2018 Page 30-507

13. Edit Commands TL1 Command Reference Manual

ED-SNMP

Command Changes Since Previous Feature Package

• None.

Description
The ED-SNMP command provides the ability to configure attributes for the SNMP entity. The SNMP entity controls
access to the system from an SNMP manager. The SNMP manager can only read and write to the MIB entities
necessary to enable monitoring of ethernet facilities and read the ethernet statistics specified by the SNMP RMON
RFCs.

The read-only community name (ROCNAME), and read-write community name (RCWNAME) are used to specify
access control from an SNMPV2 manager to the NE. A SNMPV2 manager cannot be to communicate to a NE until
one of the community names are specified.
The SNMP entity also allows access from a SNMPV3 manager. SNMPV3 user names and passwords are
configured by an administrator using a SNMPV3 manager. Initial access to the SNMP entity from a SNMPV3
manager is provided through the default username admin1.

Restrictions and Exceptions

• String parameters must be used in quotes.

• When the SNMP entity is enabled, it defaults to SNMP V3 support. For environments that support
SNMP V2 only, enter a value into ROCNAME and/or RWCNAME to enable SNMP V2 support.

Command Format
ED-
SNMP:[tid]:<snmp_aid>:ctag:::[,ROCNAME=<rocname>][,RWCNAME=<rwcname>][:<editable
PrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.107 ED-SNMP Parameters

Parameter Value(s) Definition
snmp_aid SNMP EntityID

rocname Is a string of length 1 to 30 characters. Specifies the read-only community string.

Refer to section 2 for the applicable characters.

rwcname Is a string of length 1 to 30 characters. Specifies the read-write community string.

Refer to section 2 for the applicable characters.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS - In-Service: IS
Default: OOS - Out-of-Service: OOS

Page 30-508 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example
ED-SNMP:CORIANT:SNMP:AM0074:::ROCNAME="NE-87-RO",RWCNAME="NE-87-RW":IS;

Possible System Response

^^^CORIANT1 05-11-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SNMP

76.MTFP50/30, Rev B January 2018 Page 30-509

13. Edit Commands TL1 Command Reference Manual

ED-SNMP-COMMPREFIX

Command Changes Since Previous Feature Package

• None.

Description
The ED-SNMP-COMMPREFIX command instructs the network element to change the old community strings in the
NE to the new community strings, based on the old and new authentication portion of the community strings
provided and the context engine ids of each of the main-shelf control module and port-shelf control modules in the
EON.

The community string follows the following format :

[authcstr]+[tid]+[shelf_id]

where

authcstr is the user-specified community string

tid is the target identifier of the targetted NE
shelf_id is the shelf identifer of each of the main-shelf control modules and port-shelf control modules.

Restrictions and Exceptions

• The command should be denied if the SNMPv2C is not turned on by ALW-PKT-SNMPV2 command.

Command Format
ED-SNMP-
COMMPREFIX:[tid]::ctag:::[OLDAUTHCSTR=<oldauthcstr>],[NEWAUTHCSTR=<newauthcstr>]
;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.108 ED-SNMP-COMMPREFIX Parameters

Parameter Value(s) Definition
oldauthcstr Is a string of length 1 to 8 characters, Specifies the authentication portion of the old community string.
inclusive. Refer to section 2 for the applicable characters.
Default: "DEFAULT"

newauthcstr Is a string of length 1 to 8 characters, Specifies the authentication portion of the new community
inclusive. string.
Default: "DEFAULT" Refer to section 2 for the applicable characters.

Page 30-510 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example
ED-SNMP-
COMMPREFIX:CORIANT::AM0074:::OLDAUTHCSTR="PREFIX1",NEWAUTHCSTR="PREFIX2";

Possible System Response

^^^CORIANT 05-11-15 02:08:15

M AM0074 COMPLD ;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SNMP-COMMPREFIX
RTRV-SNMP-COMM
INH-PKT-SNMPV2
ALW-PKT-SNMPV2

76.MTFP50/30, Rev B January 2018 Page 30-511

13. Edit Commands TL1 Command Reference Manual

ED-STAT-RTE

Command Changes Since Previous Feature Package

• None.

Description
The ED-STAT-RTE command instructs the network element's (NE) to modify the ADVERTISE attibute of an existing
static route.

Restrictions and Exceptions

• The command is denied if the static route specified by the parameters DEST, NETMASK, INTERFACE/
IFNAME and NEXTHOP does not exist.

• The parameters value set [DEST, NETMASK, INTERFACE] must be used to uniquely identify a static
route entry for a TL associated with a resource of type GCC, PPP and OSCX.

• The parameters value set [DEST, NETMASK, INTERFACE, NEXTHOP] must uniquely identify a static
route entry for a TL associated with a resource of MGTETH, IPPG.

• This command is denied if the TL_aid provided is not a MCN (Partition 1) TL.

• This command is denied if TL_aid is not specified.

• This command is denied if IFNAME is specified.

• This command is denied if the TL specified by the TL_aid parameter does not exist.

• This command is denied if the TL_aid parameter specifies a TL associated with a SINTF-1, OCn or
STMn entity.

• For default gateway configuration, if the DEST is set to 0.0.0.0, the NETMASK must be set to 0.0.0.0.

• This command is denied if the NEXTHOP provided is not from the same subnet as the TL/IFNAME
provided.

• If ADVERTISE=YES for MCN static route, MCN OSPF is automatically changed to ASBR. MCN OSPF
status can be retrieved by using RTRV-OSPF for OSPF-1-1.

Command Format
ED-STAT-
RTE:[tid]::ctag:::DEST=<destination>[,NETMASK=<netmask>][,INTERFACE=<TL_aid>][,I
FNAME=<IfName>][,NEXTHOP=<next_hop>][,ADVERTISE=<advertise>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-512 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.109 ED-STAT-RTE Parameters

Parameter Value(s) Definition
destination Format for the IP address is: A double Specifies the host or the network destination where the IP
quoted string representing the IPv4 packet is attempting to reach.
address. IPv4 address = "[0-255].[0- The following IPv4 addresses is not allowed:
255].[0-255].[0-255]". Invalid addresses --------------- Prefix/Prefix length
224-255.xxx.xxx.xxx ------------ 224/3
169.254.xxx.xxx ----------------- 169.254/16
127.xxx.xxx.xxx ------------------ 127/8
0-1.xxx.xxx.xxx ------------------- 0/7
NOTE: The special destination value of 0.0.0.0 is allowed. It
serves as the default route in the IP packet forwarding table.

netmask [0-255].[0-255].[0-255].[0-255] The netmask is bitwise 'AND'ed with the destination IP address
of the packet and compared with the 'destination' field of this IP
forwarding table entry.

TL_aid TL-1-[1-512]-[1-1500] Specifies the local host interface (TL) through which the IP
packet egresses.

next_hop [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the next_hop to be taken by the IP

packet en route to the destination.
This parameter is required when ARP is needed to find out the
Ethernet MAC address to send the IP packet.
This parameter is not required if the interface is a point to point
Ethernet link.

advertise YES For SCN TL interface, when set to YES, the static route is
NO advertised in the routing protocol for the partition of the TL. For
OSPF, the static route is advertised as an AS external route,
and OSPF must be configured as an ASBR.
For MCN IFName or MCN TL, when set to YES, the static route
is advertised in the routing protocol for the partition of the MCN.
OSPF automatically enables/disables ASBR according to
whether advertised MCN static route exists.

Example
ED-STAT-RTE:::AM0011:::DEST="0.0.0.0",NETMASK=0.0.0.0,INTERFACE=TL-1-1-
2,NEXTHOP="135.252.200.1",ADVERTISE=YES;

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-STAT-RTE
ENT-STAT-RTE
RTRV-STAT-RTE
RTRV-RTE-ALL

76.MTFP50/30, Rev B January 2018 Page 30-513

13. Edit Commands TL1 Command Reference Manual

ED-STSn (for STS1/STS3C/STS12c/STS48C/STS192C)

Command Changes Since Previous Feature Package

• None.

Description
The ED-{X} command instructs the network element (NE) to edit the attributes of a selected STSn facility entity.
• Facilities (fac_type): STS1, STS3C, STS12C, STS48C, STS192C.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• The forced command mode must be used to edit any parameters for the STS1 STS3c STS12c, STS48c,
or STS192c facilities if the facility is not owned by the MCN partition (network partition 1).

• On mTera SSM-2S working module that is in EPG group, edit STSn entity associated with virtual port
99 on backplane would implicitly edit STSn entity associated with virtual port 99 on backplane on
protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to edit STSn entity associated
with virtual port 99 on backplan would be denied.

Command Format
ED-<fac_type>:[tid]:<fac_aid>:ctag:::[,SFTHRESH=<SFThreshold>]
[,SDTHRESH=<SDThreshold>][,ALMPF=<almProfile>][,PMPF=<pmProfile>][,CMDMDE=<comma
ndMode>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters Applicability When Entering the Command

Table 13.110
STS1
STS3C
STS12C
STS48C
a
PARAMETER DEF STS192C
SFTHRES ND X
SDTHRES ND X
ALMPF ND X
PMPF ND X
CMDMDE ND X

Page 30-514 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.110 (Continued)

STS1
STS3C
STS12C
STS48C
a
PARAMETER DEF STS192C
PST PD X
a. ND: Name Defined or PD: Position
Defined.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.111 ED-STSn (for STS1/STS3C/STS12c/STS48C/STS192C)/STS1CNV/STS3CNV/STSnT (for STS3T/

STS12T/STS48T) Parameters
Parameter Value(s) Definition
fac_aid STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

SFThreshold 10E-3 Specifies the threshold for Signal Failure on the incoming signal.
10E-4 -Default is 10E-3 on STS1/STS1CNV.
10E-5 -Default is 10E-4 on STS3CNV/STS3C/STS12C/STS48C/
STS192C.
Does not apply to STS1CNV or STS3CNV facilities implicitly
created under GBEP/OPTD.
Does not apply to STSnT facilities.

SDThreshold 10E-5 Specifies the threshold for Signal Degrade.

10E-6 Does not apply to STS1CNV or STS3CNV facilities implicitly
10E-7 created under GBEP/OPTD.
10E-8 Does not apply to STSnT facilities.
10E-9
Default: 10E-6

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Does not apply to STS1CNV or STS3CNV facilities implicitly

created under GBEP/OPTD port side facility.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the STS.
Default: 99
Does not apply to STS1CNV or STS3CNV facilities implicitly
created under GBEP/OPTD port side facility.

76.MTFP50/30, Rev B January 2018 Page 30-515

13. Edit Commands TL1 Command Reference Manual

Table 13.111 ED-STSn (for STS1/STS3C/STS12c/STS48C/STS192C)/STS1CNV/STS3CNV/STSnT (for STS3T/

STS12T/STS48T) Parameters (Continued)
Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

Example 1:
ED-STS12C:CORIANT1:STS12C-20-6-1-25:AM0074:::CMDMDE=FRCD:OOS;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}, ENT-{X}, RTRV-{X}

Page 30-516 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-SYNC

Command Changes Since Previous Feature Package

• None.

• Add for Pico

• Not applicable for USS/Nano

Description
The ED-SYNC command instructs the network element (NE) to add or delete synchronization references sources;

Restrictions and Exceptions

• When add one new reference clock, it needs to delete one or two previous selected reference clocks
first.

• To change the selected timing reference(s) to new time reference(s), it is necessary to delete the
selected timing reference(s) and then add new timing reference(s).

• For delete operation, the reference clock should be from one of previous selected reference clocks.

• To delete the timing reference(s) (REFCLK1 or REFCLK2 or both), the corresponding parameter(s)
(refclk1 or refclk2 or both) should be set to N/A.

• For add/delete operation, it should be no more than 2 reference clocks.

• When both reference clocks are deleted, the NE goes for holdover status.

• STM1, STM4, STM16 and STM64 references are only supported from SSM-2S module
OC3, OC12, OC48 and OC192 references are only supported from SSM-2S modules.

Command Format
ED-SYNC:[tid]:<sync_aid>:ctag::: [REFCLK1=<refclk1>] [,REFCLK2=<refclk2>]
[,CMDMDE=<commandMode>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.112 ED-SYNC Parameters

Parameter Value(s) Definition
sync_aid SYNC-20-1 EntityID-ShelfID-SYNCID

76.MTFP50/30, Rev B January 2018 Page 30-517

13. Edit Commands TL1 Command Reference Manual

Table 13.112 ED-SYNC Parameters (Continued)

Parameter Value(s) Definition
refclk1 T1-20-[15,23,26]-[1,2], Specifies the valid reference clock source ID which is same as
E1-20-[15,23,26]-[1,2], facility ID.
2MH-20-[15,23,26]-[1,2], EntityID-ShelfID-SlotID-PortID
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

refclk2 T1-20-[15,23,26]-[1,2], Specifies the valid reference clock source ID which is same as
E1-20-[15,23,26]-[1,2], facility ID.
2MH-20-[15,23,26]-[1,2], EntityID-ShelfID-SlotID-PortID
NA,
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

commandMod NORM Specifies the way in which the command is executed:

e FRCD 1. Enter NORM to specify a normal mode of execution (any
state inconsistencies prevents the command from executing).
2. Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).
2.1 As long as the reference clock which is in active (NR-ACT) is
to be removed (changed to NA) or changed to another new
timing source;

Example: Change one timing source

ED-SYNC:CORIANT1:SYNC-20-1:ctag:::REFCLK1=STM16-20-1-1, NORM;

ED-SYNC:CORIANT1:SYNC-1-1:ctag:::REFCLK1=OCH-P-1-1-2, NORM;

Example: Change two timing sources

ED-SYNC:CORIANT1:SYNC-20-1:ctag:::REFCLK1=STM16-20-1-1, REFCLK1=STM16-20-4-2,
NORM;

ED-SYNC:CORIANT1:SYNC-1-1:ctag:::REFCLK1=OCH-P-1-1-3, REFCLK2=SYNCETH-1-2-4,
NORM;

Page 30-518 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example: Remove both timing source

ED-SYNC:CORIANT1:SYNC-20-1:ctag:::REFCLK1=NA, REFCLK1=NA, FRCD;

ED-SYNC:CORIANT1:SYNC-1-1:ctag:::REFCLK1=NA, REFCLK2=NA, FRCD;

Possible System Response

^^^CORIANT1 07-09-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SYNC
DLT-SYNC
ENT-SYNC
OPR-SYNCSW
RLS-SYNCSW

76.MTFP50/30, Rev B January 2018 Page 30-519

13. Edit Commands TL1 Command Reference Manual

ED-TCPIP

Command Changes Since Previous Feature Package

• Updated to add FIPS mode restrictions

Description
The ED-TCPIP command instructs the network element (NE) to edit the attributes of TCPIP entity.

Secure communication service protocols such as SSH, sFTP and Tunneling of non-secure ports are modified via
this command. The NE generates the private / public key pair required for the SSH secure communication service
when the sshKeyStrength parameter is specified.

The system defaults the authentication method to key-based and password-based.

Restrictions and Exceptions

• The first name-defined parameter entered after the ctag must not have its leading comma

• The private / public keys used by the SSH secure communication service should not be regenerated
unless a security breach of the private key has occurred.

• The command is denied if DADCNT or DADTMR is specified.

• The TL specified for the ASINTRFC parameter must exist.

• This command is denied if SSHAUTH is set to KEY and a host key is not created using the
sshKeyStrength parameter.

• If the NE is in FIPS mode (ED-SECU-SYS parameter SECURE=FIPS) the following parameters

constraints is enforced

- FTP=SECURE
- TELNET=SECURE
- sshKeyStrength is set to 2048

Command Format
ED-TCPIP:[TID]:<tcpip_aid>:ctag:::[,DADCNT=<dupAddrDand so
onnt>][,DADTMR=<dupAddrDetTmr>][,FTP=<ftp>][,HTTP=<http>][,TELNET=<telnet>][,SSH
AUTH=<sshAuthentication>][,sshKeyStrength=<sshKeyStrength>][,ASINTRFC=<AppSrcInt
erface>][,CMDMDE=<commandMode>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-520 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.113 ED-TCPIP Parameters

Parameter Value(s) Definition
tcpip_aid TCPIP-1 EntityID-TCPIPID

dupAddrDand [0-600] Specifies the number of neighbor solicitation messages sent

so onnt Default: 1 when performing duplicate address detection on the interface.
Setting the value to 0 disables this attribute.

dupAddrDetT [1000-3600000] Specifies the time interval between neighbor solicitation

mr Default: 1000 messages sent when performing duplicate address detection.

ftp ALW Specifies whether the file transfer application is allowed for both
SECURE nonsecure or secure mode, only secure mode or inhibited.
INH ALW, to allow both non-secure and secure mode.
Default: ALW SECURE, to allow secure mode only.
INH, to inhibit the terminal application.

http ALW Specifies whether the http server is allowed for both non-secure
INH or secure mode, or inhibited.
Default: ALW ALW, to allow both non-secure and secure mode.
INH, to inhibit the terminal application.

telnet ALW Specifies whether telnet is allowed for both non-secure or

SECURE secure mode, only secure mode or inhibited.
INH ALW, to allow both non-secure and secure mode.
Default: ALW SECURE, to allow secure mode only, that is,, only SSH.
INH, to inhibit the application.

sshAuthenticat KEY Specifies the authentication method allowed for secure

ion ALL operations in SSH or sFTP.
Default: ALL KEY, to allow the use keybased authentication only.
ALL, to use key-based and passwordbased authentication.

sshKeyStrengt 512,1024,2048 Specifies the strength of the key for regenerating the private/
h Default: 512 public key pair in the SSH or sFTP.
Specifying this parameter causes the existing keys in the
system to be replaced with newly generated private/public key
pair of the specified key strength. There is no change to the
existing keys if this parameter is not specified.

AppSrcInterfac NA, The Application Source Interface is used by an application to

e TL-1-[1-512]-[1-1500] determine source IP address that is used when initiating a
Default: NA session.

The TL AID is used to determine the NE address that is used for

an application.

A setting of NA (Not Applicable) indicates that no Application

Source Address is specified.

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
Disable FTP:
ED-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::FTP=INH;

76.MTFP50/30, Rev B January 2018 Page 30-521

13. Edit Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 10-02-10 07:48:00

M MYCTAG COMPLD

Example
Enable SFTP and FTP:
ED-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::FTP=ALW;

Possible System Response

^^^CORIANT1 10-03-10 07:48:00

M MYCTAG COMPLD

Example
Disable Duplicate Address detection:
ED-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::DADCNT=0;

Possible System Response

^^^CORIANT1 10-02-10 07:50:00

M MYCTAG COMPLD

Possible System Response

^^^CORIANT1 10-02-10 07:53:00

M MYCTAG COMPLD

Example
Prevent the use of non-secure File Transfer application (FTP) and regenerate the private / public key pair with a
strength of 1024 for use with sFTP.
ED-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::FTP=SECURE,sshKeyStrength=1024;

Possible System Response

^^^CORIANT1 10-02-10 07:55:00

M MYCTAG COMPLD

Page 30-522 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example
Regenerate the private / public key pair with a strength of 2048 for use with SFTP (Nano/mTera).
ED-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::sshKeyStrength=2048;

Possible System Response

^^^CORIANT1 10-09-10 07:58:00

M MYCTAG COMPLD

Example
Regenerate the private / public key pair with a strength of 1024 for use with SSH.
ED-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::sshKeyStrength=1024;

Possible System Response

^^^CORIANT1 10-09-10 07:58:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.
Command to regenerate the private / public key pair with the specified key strength was denied because the system
is operating in FIPS secure mode.

CORIANT1 10-09-29 12:18:25

M MYCTAG DENY
SNVS
/* Operation denied. Key strength too weak for current system secure mode settings. */
;

Related Commands
RTRV-TCPIP

76.MTFP50/30, Rev B January 2018 Page 30-523

13. Edit Commands TL1 Command Reference Manual

ED-TL

Command Changes Since Previous Feature Package

• None.

Description
The ED-TL command instructs the network element (NE) to edit a topological link.

Restrictions and Exceptions

• NIFINDEX cannot be set to 0.0.0.0.

• The NE denies an attempt to modify the NIFINDEX, NNID, NSIGADDR or NSIGID parameter, if there
is a call on the TL.

• The NE denies an attempt to modify the NIFINDEX, NNID, NSIGADDR or NSIGID parameter of a
Transport TL if the TL is InService or NDISCOVERY is enabled.

• Setting NIFINDEX as NULL (empty value) does not erase the already configured NIFINDEX value.

• The ROUTING parameter cannot be set to ACTIVE or PASSIVE if the RAID of the TL to be edited is
empty.

• If the RESOURCE parameter is set to one of the OSCX, GCC interfaces or if the IFNAME parameter is
set to SINTF-1/SINTF-2, this command is denied if a value for the SRLG, LATENCY, or RESCLASS
parameters is specified.

• If the RESOURCE parameter is set to one of the OSCX, GCC interfaces or if the IFNAME parameter is
set to SINTF-1/SINTF-2, this command is denied if the value of LATENCYMODE as MANUAL is
specified.

• ROUTING parameter cannot be set to ACTIVE if RESOURCE is of OTUk/ODUk or OCn/STMn type.

• For an inter domain TL, NIFINDEX and OSPFRP(abstract node type) must be set before TL can be put
into IS.

• For an inter domain TL, GMPLSMode of the LINKPF on the TL must be set to OIF-ENNI-V1 or
OIFENNI-V2.

• The ROUTING is ACTIVE and the NDISCOVERY is DISABLED is mutual exclusive for an IP TL. that
is, provide ROUTING is ACTIVE and NDISCOVERY is ENABLED when editing the IP TL.

• The ROUTING is PASSIVE and the NDISCOVERY is ENABLED is mutual exclusive for an IP TL. that
is, change NDISCOVERY to DISABLED when editing the ROUTING parameter of an IP TL to
PASSIVE.

• The ROUTING is DISABLED and the NDISCOVERY is ENABLED is mutual exclusive for IP TL. that is,
change NDISCOVERY to DISABLED when editing the ROUTING parameter of an IP TL to DISABLED.

• When Neighbor Discovery is edited to DISABLED and ROUTING is edited to DISABLED, the RAID
value is automatically set to <unspecified>.

• When Neighbor Discovery is edited to ENABLED and ROUTING is edited from DISABLED to ACTIVE,
the RAID has to be specified.

• The RAID is ignored by system when the ROUTING parameter of an IP TL was edited from ACTIVE or
PASSIVE to DISABLED (That is, when the TL was edited successfully, the NDISCOVERY displays as
DISABLED, and the RAID does not show up in the response of RTRV-TL).

Page 30-524 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

• While the cost for interfaces that are in loopback (for example, STBL interfaces) may be configured with
a non-zero cost; consistent with IP control planes, IP interfaces that are in loopback is advertised as a
stub host with a cost of zero.

Command Format
ED-
TL:[tid]:<tl_aid>:ctag:::[TLNAME=<TLname>][,COST=<Cost>][,NIFINDEX=<NeighborIfIn
dex>][,ROUTING=<routing>][,SRLG=<Srlg>][,LATENCYMODE=<LatencyMode>][,LATENCY=<La
tency>][,PMD=<Pmd>][,OSNR=<Osnr>][,FWMP=<Fwmp>][,PDL=<Pdl>][,RCD=<ResidualCD>][,
SPMN=<SpmNoise>][,XPMN=<XpmNoise>][,RESCLASS=<ResourceClass>][,NNID=<NeighborNod
eId>][,NSIGADDR=<NeighborSignalingAddr>][,NSIGID=<NeighborSignalingId>][,NDISCOV
ERY=<NeighborDiscovery>]:[<EditablePrimaryState>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.114 ED-TL Parameters

Parameter Value(s) Definition
tl_aid TL-[1,3]-[1-512]-[1-1500] EntityID-NPID-NodeID-TLID

TLname A double quoted string consisting of 0 Specifies the Topological Link name.
to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

Cost [1-4294967295] Specifies the cost for the link.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

Srlg A double quoted input string of up to Specifies the Shared Risk Link Groups
32 comma separated 4 byte hex associated with this TL.
strings.
Example:
"3E04990A,044D1A0C"

LatencyMode MANUAL MANUAL - the latency value is manually provisioned

DISABLED DISABLED - the latency parameter is not populated

Latency [0-65535] Specifies the latency across this TL in Micro-Second.

Pmd [0-6500] Unit is in hundredths of Specifies the value for polarization mode dispersion.
picoseconds.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

76.MTFP50/30, Rev B January 2018 Page 30-525

13. Edit Commands TL1 Command Reference Manual

Table 13.114 ED-TL Parameters (Continued)

Parameter Value(s) Definition
Osnr [0-8000] Unit is in hundredths of dB. Specifies the value for Optical Signal to Noise Ratio.

This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Fwmp -8000 to -1500 Unit is in hundredth of Specifies the value for Four Wave Mixing crosstalk Power.
dB.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Pdl NA or [0-100000] Unit is in one- Specifies the value for Polarization Dependent Loss.
hundred-thousandths
of dB. This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

ResidualCD NA or [-200000-2500000] Unit is in Specifies the value for Residual Chromatic Dispersion.
hundredth of ps/nm
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

SpmNoise NA or [0-56000] Unit is in one- Specifies the value for Self Phase Modulation - Noise.
hundred-thousandths of a Radian.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

XpmNoise NA or [0-112000] Unit is in one- Specifies the value for Cross-Phase Modulation - Noise.
hundred-thousandths of a Radian.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

ResourceClas A double quoted 4 byte hex strings. Specifies the resource class for the TL.
s 32-bit long bit-mapped field with each bit representing a specific
resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.

Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example bit-mapped resource class definitions:

"00000000" - None, used to reset to the default value ""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

Page 30-526 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.114 ED-TL Parameters (Continued)

Parameter Value(s) Definition
NeighborNode [0-255].[0-255].[0-255].[0-255] Specifies the neighbors node ID.
Id

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling address.

lingAddr

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors node ID.

lingId

NeighborDisco ENABLED Specifies whether or not neighbor discovery is used to learn the
very DISABLED neighbor parameters.

Routing ACTIVE Specifies if Routing is enabled and if so, if Routing is passive or

PASSIVE active.
DISABLED ACTIVE - This link is advertised and routing messages are
transported over this link.
PASSIVE - This link is advertised, routing messages are not
transported over this link.
DISABLED - This link is not advertised, routing messages are
not transported over this link.

editablePrimar IS IS: In-Service

yState OOS OOS: Out-of-Service

NearEndAddr [0-255].[0-255].[0-255].[0-255] Identifies the near end address used for this link.
The address prefix needs to be unique in both MCN and SCN.
Each network partition represents a network. A network spans
multiple NEs.

The following addresses are not allowed:

224-255.xxx.xxx.xxx
169.254.xxx.xxx
127.xxx.xxx.xxx
1.xxx.xxx.xxx
0.xxx.xxx.xxx

When NearEndAddrType=NUM, this is a mandatory parameter.

When NearEndAddrType=UNNUM, this parameter reflects the
value stored in the NearEndAddr parameter of the TL identified
by NearEndParentTL.

NearEndMask [0-255].[0-255].[0-255].[0-255] Specifies the near end mask for a numbered link.
Default: 255.255.255.255

Example
Example for an OTU4 TL:
ED-TL::TL-3-1-1:AM0011:::COST=200,OSNR=7500;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-527

13. Edit Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TL
DLT-TL
RTRV-TL

Page 30-528 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-TSL

Command Changes Since Previous Feature Package

• None.

Description
The ED-TSL command instructs the network element (NE) to edit a transitional link.

Restrictions and Exceptions

• NIFINDEX cannot be set to 0.0.0.0.

• TSL cannot be set to IS if NIFINDEX value is not set.

• The NE denies an attempt to modify TSL if a call exists on the given TSL.

• When PDL of an OCH-P TSL of 100G interface is edited, the PDL must be specified with a non-NA
value, otherwise the command is denied.

• If the TSL is entered in an area using a CPPF with OPTPATHALG configured as OPE, the TSL
secondary state is INCOMP if the optical impairment information for this TSL has not been included in
the OPE data file installed in the network element. While in this state, no capacity is advertised for this
TSL.

Command Format
ED-
TSL:[tid]:<tsl_aid>:ctag:::[TSLNAME=<TSLname>][,COST=<Cost>][,NIFINDEX=<Neighbor
IfIndex>][,PMD=<Pmd>][,OSNR=<Osnr>][,PDL=<Pdl>][,RESCLASS=<ResourceClass>]:[<Edi
tablePrimaryState>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.115 ED-TSL Parameters

Parameter Value(s) Definition
tsl_aid TSL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-TSLID

TSLname Alpha-numeric text string up to 30 Specifies the transition link name.

characters. Refer to section 2 for the applicable characters.

Cost [1-4294967295] Specifies the cost for the link.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

76.MTFP50/30, Rev B January 2018 Page 30-529

13. Edit Commands TL1 Command Reference Manual

Table 13.115 ED-TSL Parameters (Continued)

Parameter Value(s) Definition
Pmd [0-6500] Unit is in hundredths of Specifies the value for polarization mode dispersion.
picoseconds.
This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

Osnr [0-8000] Unit is in hundredths of dB. Specifies the value for Optical Signal to Noise Ratio.

This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

Pdl NA or [0-100000] Unit is in one- Specifies the value for Polarization Dependent Loss.
hundred-thousandths
of dB. This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

ResourceClas A double quoted 4 byte hex strings. Specifies the resource class for the TSL.
s 32-bit long bit-mapped field with each bit representing a specific
resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example bit-mapped resource class definitions:

"00000000" - None, used to reset to the default
value ""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

editablePrimar IS IS: In-Service

yState OOS OOS: Out-of-Service

Example
Example for an OTN CP OCH TSL:
ED-TSL::TSL-3-1-
1:AM0011:::COST=200,NIFINDEX=0.198.160.0,NNID=22.3.30.1,PMD=0,OSNR=6000;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-530 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Related Commands
ENT-TSL
DLT-TSL
RTRV-TSL

76.MTFP50/30, Rev B January 2018 Page 30-531

13. Edit Commands TL1 Command Reference Manual

ED-TTP-{x}

Command Changes Since Previous Feature Package

• None.

Description
The ED-TTP command instructs the network element (NE) to edit the attributes of a selected trail termination point
entity.
• {x} can be STS1 or STS3C.

Restrictions and Exceptions

• None.

• On mTera SSM-2S working module that is in EPG group, edit TTPSTSn entity associated with virtual
port 99 on backplane would implicitly edit TTPSTSn entity on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to edit TTPSTSn entity
associated with virtual port 99 on backplane would be denied.

Command Format
ED-TTP-{x}:[tid]:ttp_aid:ctag:::[,CMDMDE=<commandMode>]:<editablePrimaryState>;

Proper System Responses

<header>

M^^<ctag>COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.116 ED-TTP-{x} Parameters

Parameter Value(s) Definition
ttp_aid TTPSTS1-20-[1-16]-99-[1-3]-[1-192] EntityID-ShelfID-SlotID-Vport-GroupId-n
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
The system default is IS.

Page 30-532 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Example
Edit a STS3C TTP OOS:

ED-TTP-STS3C:CORIANT1:TTPSTS3C-20-12-99-1-7:myctag::::OOS

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M^^MYCTAG^COMPLD<cr><lf>

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-TTP
ENT-TTP
ED-VCG
RTRV-TTP

76.MTFP50/30, Rev B January 2018 Page 30-533

13. Edit Commands TL1 Command Reference Manual

ED-T1

Command Changes Since Previous Feature Package

• None

Description
The command instructs the network element (NE) to edit attributes of a DS1 (T1) facility providing an External
Synchronization signal.

Restrictions and Exceptions

• When no parameter is specified, the behavior is to not change its current setting.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• T1 Line Code & Format can only be edited if the T1/T1OUT facility is in OOS-MA or if the command is
forced (CMDMDE = FRCD).

• When both Input Synchronization AID(T1) and Output Synchronization reference AID (T1OUT) are
existed in one port, T1 Format can only be edited if the both T1 and T1OUT facility are in OOS-MA or
if the command is forced (CMDMDE = FRCD).

• almProfile and qualityLevelOverride is only applicable to an Input Synchronization reference AID(T1).

• tx_ref and loopPrevention is only applicable to an Output Synchronization reference AID (T1OUT).

• QLOVERRIDE cannot be Disable when the Input Synchronization reference AID(T1) Frame Format is
SF.

Command Format
ED-
T1:[tid]:<T1_aid>:ctag:::[,LINECDE=<LineCode>][,FMT=<FrameFormat>][,TXREF=<tx_re
f>][,ALMPF=<almProfile>][,QLOVERRIDE=<qualityLevelOverride>][,CMDMDE=<commandMod
e>][,LOOPPRVT=<loopPrevention>]:[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.117 ED-T1 Parameters

Parameter Value(s) Definition
T1_aid T1-20-[15,23,26]-[1,2] EntityID-ShelfID-SlotID-PortID
T1OUT-20-[15,23,26]-[1,2]

Page 30-534 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.117 ED-T1 Parameters (Continued)

Parameter Value(s) Definition
LineCode AMI Indicates the line code for a T1 facility.
B8ZS Possible values are Alternate Mark Inverted (AMI) or Bipolar
with 8 zero substitution (B8ZS).

FrameFormat SF Indicates the digital signal frame format of a T1 facility. Possible

ESF values are Extended Superframe (ESF), Superframe (SF), or no
framing (NONE).

tx_ref NA, Indicates the derived source signal timing the output
SYNC-20-1, synchronization reference. Applicable only to output
OC3-20-[1-16]-[1-32], synchronization references.
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

qualityLevelOv DISABLED Specifies the synchronization signal quality level that is

erride PRS associated with the specified T1 facility instead of the value
ST2 received in the synchronization status message within the
TNC signal. This allows the override of the quality level that was
ST3E received.
ST3 When set to DISABLED, the system uses the quality level
SMC received in the synchronization status message.
ST4
PROV
DUS
Default: DISABLED

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM Inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

loopPrevention DISABLED Specifies the loop prevention function of the entity.

ENABLED Enable: The SSM of output synchronization is forced to DNU
Default: DISABLED when the tx_ref is SYNC-20-1 and the SYNC-20-1 source is the
same input synchronization port
Disable: The SSM of output synchronization follows the tx_ref
and squelch result. It does not consider the status of the tx_ref
entity.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Outof-Service (OOS).

76.MTFP50/30, Rev B January 2018 Page 30-535

13. Edit Commands TL1 Command Reference Manual

Table 13.117 ED-T1 Parameters (Continued)

Parameter Value(s) Definition
tx_sqlch AIS Indicates output synchronization reference when squelch is
DNU applied. Applicable only to output synchronization references.
SQLCH ²AIS : Force AIS in the output synchronization signal
SSM ²DNU: The SSM of the output synchronization set to DNU, this
parameter is only available when the Frame Format is NOCRC4
or CRC4
²SQLCH: Shutdown the output synchronization signal
²SSM: The SSM function shuts down the output synchronization
signal transmission if the tx-ref signal with a quality that is lower
than the configurable threshold.

ql_min PRS Indicates the QL threshold of the derived source signal timing
ST2 the output synchronization reference when it is SSM squelch
TNC mode. Applicable only to output synchronization references.
ST3E
ST3
SMC
ST4
PROV
DUS

Example
ED-T1:CORIANT1:T1-20-14-1:CTAG:::LINECDE=AMI:IS;

Possible System Response

^^^CORIANT1 15-03-14 02:08:15

M CTAGCOMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-T1
ENT-T1
DLT-{x}

Page 30-536 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-USER-SECU

Command Changes Since Previous Feature Package

• Add FIPS mode restrictions for SNMP parameters

• Remove support for pid_encrypt=Y

• Change the value of snmp_priv_protocol from DES3 to DES

Description
The ED-USER-SECU command instructs the network element (NE) to edit the user access privilege codes (uap,
uap_cli, and uap_snmp) for both TL1, CLI and SNMP access, password (pid), session time out, password aging,
password update waiting period, and the remaining number of login attempts after expiration of a password for a
specified user identifier (uid).

When the logon password is entered in the command, only one asterisk (*) appears on the screen, regardless of
how many characters comprise the password.

It allows also to modify the status of a user, by activating it (enabled), by activating it but force change of password
on next login (password aged) or by disabling a user (disabled). In addition, for each user, it provides the ability to
allow/inhibit autonomous message report generation. This command can only be utilized by the TL1 System
Administrator.

When the NE user being edited has SNMP privilege, this command also instructs the network element (NE) to
update the SNMPv3 user with the corresponding access privilege and pass phrases.

Users who intend to login to the NE with secure shell (SSH) or transfer patches to the system via SFTP may identify
the location of the user's public key. If the public key location is identified in the command text, the system
automatically attempts to connect to the server holding the public key file and store the key in the lowest available
KEY variable (that is, KEY1, KEY2... KEY6). Up to 6 public keys can be stored as user attributes and duplicate public
keys are never stored. However, the user can clear one or more of the key values with the CLRKEY parameter.

Restrictions and Exceptions

• Modifications of these parameters is applied following the next login session of the same user.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• When parameter is omitted in the command, this means that there is no change to the current
parameter value.

• PUWP value must always be less than or equal to PAGE value.

• Command is denied if all UAP, UAPCLI and UAPSNMP are set to A0.

• For NE users with only SNMPv3 privileges, the attribute, user_status, takes only ENABLED or
DISABLED values , unless the NE user also has TL1/CLI privileges.

• snmp_user_sec_level, snmp_auth_protocol, snmp_auth_passphrase, snmp_priv_protocol and

snmp_priv_passphrase are not applicable when uap_snmp=A0.

• For a Craft Station user, pid, snmp_auth_passphrase and snmp_priv_passphrase need to be the same.

• If all keys have been used and an attempt to assign an additional key is performed, the command is
denied.

76.MTFP50/30, Rev B January 2018 Page 30-537

13. Edit Commands TL1 Command Reference Manual

• If a file is not specified in the KEYLCN parameter, this command is denied.

• If the NE is in FIPS mode (ED-SECU-SYS parameter SECURE=FIPS) and uap_snmp is not set to A0
the following parameter constraints is enforced:
- SNMP USER Security Level must be set to authPriv or authNoPriv (USERSECLEVEL=authPriv or
authNoPriv)
- SNMP Authentication Protocol must be set to SHA (SNMPAUTPROT=SHA)

• If the NE is in FIPS mode (ED-SECU-SYS parameter SECURE=FIPS) the following parameter

constraints is enforced:

- Password age (PAGE), the value 0 is not allowed

- Password update waiting period (PUWP), the value 0 is not allowed
- Session timeout (TMOUT), the value 0 is not allowed
- Password expired login number (PELN), the value 0 is not allowed

Command Format
ED-USER-
SECU:[tid]:<uid>:ctag::[<pid>][,<pid_encrypt]:[,UAP=<uap>][,UAPCLI=<uap_cli>][,U
APSNMP=<uap_snmp>][,TMOUT=<session_timeout>][,PAGE=<password_aging][,PUWP=<pwd_u
pdate_waiting_period>][,PELN=<pwdexpire_login_num>][,MAXSES=<max_sessions>][,ALM
MSG=<almmsg>][,EVTMSG=<evtmsg>][,DBCHGMSG=<dbchgmsg>][,PMMSG=<pmmsg>][,STATUS=<u
ser_status>][,USERSECLEVEL=<snmp_user_sec_level][,SNMPAUTHPROT=<snmp_auth_protoc
ol>][,SNMPAUTHPID=<snmp_auth_passphrase>][,SNMPPRIVPROT=<snmp_priv_protocol>][,S
NMPPRIVPID=<snmp_priv_passphrase>][,KEYLCN=<public_key_location>][,CLRKEY=<key_i
d>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.118 ED-USER-SECU Parameters

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. UID

Page 30-538 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.118 ED-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
pid one string accord with the conditions Specifies the new login password associated to this UID.
listed in the Definition colum
If the password complexity parameter is set to YES (refer to the
ED-SECU-SYS and RTRVSECU-
SYS commands), the following rules apply for the password:
-Password length must be 8 characters minimum, 12 characters
maximum.
-At least 3 of the 4 following character types must be present:
numeric character, lowercase alphabetical character, uppercase
alphabetical character, special character.
-Special character consists of any of the following: ! # $ % & @ ^
*
-The Password must not include more than 2 consecutive
repetitions of the same character.
-UID (UserId) must not be contained in password (case
insensitive).

If the password complexity parameter is set to NO, then the

<pid> can be between 6 and 12 characters long using any of the
characters mentioned above, with no restriction on upper case
or character repetition.
When the <pid_encrypt>=N, pid has to be 6 to 12 alphanumeric
characters.
When the <pid_encrypt>=A, pid has to be 32 alphanumeric
characters and follow AES encryption algorithm.

uap A0 This mandatory attribute specifies the TL1 user access privilege
A2 code (UAP) assigned to the login (uid). It indicates the
A4 commands the user is allowed to execute as described in Table
A6 6.2, page 30-135.
A7 - Enter A0 to block access to TL1 commands (except ACT-
A8 USER, CANCEL-USER and ED-PID).
- Enter A2 to specify Public privilege.
- Enter A4 to specify Test privilege.
- Enter A6 to specify Provisioning privilege.
- Enter A7 to specify Operator privilege.
- Enter A8 to specify Admin privilege.
Refer to Security and Administration, page 2007-134, for
detailed information on the TL1 UAP.

uap_cli A0 This attribute specifies the CLI (Command Line Interface) user
A2 access privilege code (UAP) assigned to the login (uid).
A4 - Enter A0 to block access to CLI interface.
A6 - Enter A2 to specify Public privilege.
A7 - Enter A4 to specify Test privilege.
A8 - Enter A6 to specify Provisioning privilege.
Default: A0 - Enter A7 to specify Operator privilege.
- Enter A8 to specify Admin privilege.

uap_snmp A0 This attribute specifies the SNMP (Simple Network

A2 Management Protocol) user access privilege code (UAP)
A8 assigned to the login (uid).
Default: A0 - Enter A0 to block access to SNMP interface.
- Enter A2 to specify Public privilege. (A2 indicates full read-only
and notify access to the MIBs, write access to change its own
SNMP Passphrases)
- Enter A8 to specify Admin privilege.(A8 indicates full read-write
access to all the MIBs )

76.MTFP50/30, Rev B January 2018 Page 30-539

13. Edit Commands TL1 Command Reference Manual

Table 13.118 ED-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
session_timeo [0-99] This attribute is the Session Time Out Interval.
ut If there are no messages between the user and the NE over the
Time Out interval, the session is logged off.
Setting the value to 0 disables this attribute (meaning the
session does not time out).

Default is 15 min for A8, 30 min for A7 and A6, 45 min for A4,
and 60 min for A2.

pwdexpire_logi [0-5] This attribute specifies the number of times that an existing
n_num Default: 3 password can still be used once it has expired. Once the user
has exceeded this number, the only TL1 commands allowed are
ACT-USER/ED-PID/CANC-USER/RTRV-SW.
Setting the value to 0 disables this attribute.

max_sessions [1-128] This attribute specifies the maximum number of sessions

Default: 6 allowed for a user.

almmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
Default: ALW REPT^ALM and REPT^ALM-ENV.

evtmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
Default: ALW REPT^BKUP, REPT^EVT, REPT^EVT^FXFR, REPT^EVT-
SESSION.

dbchgmsg ALW This attribute specifies if this user receives (value=ALW), not
INH receive (value=INH), or receive all, except those that are a result
INH-OWN of administrative actions that they perform (value=INH-OWN),
Default: ALW autonomous messages reported through REPT^DBCHG.

pmmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
Default: ALW REPT^PM.

user_status ENABLED This attribute allows the Admin to enable or disable a user
PASSWORD AGED depending on current user status. These modifications take
DISABLED effect on the next login.

User with STATUS=ENABLED can be modified to PASSWORD

AGED or DISABLED.
User with STATUS=DISABLED can be modified to PASSWORD
AGED or ENABLED.
User with STATUS=PASSWORD AGED can be modified to
ENABLED or DISABLED.
User with STATUS=LOCK-OUT can be modified to ENABLED,
DISABLED, or PASSWORD AGED.

Note:
-Modifying the status to PASSWORD AGED forces the user to
change his password on next login.
-LOCK-OUT is a user_status obtained after unsuccessful login
attempts.

snmp_auth_pa a string value Specifies the SNMPv3 authentication pass phrase. This
ssphrase attribute is mandatory only if the authentication security level is
added (via changing USERSECLEVEL from noAuthNoPriv to
authNoPriv or authPriv)

Page 30-540 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.118 ED-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
snmp_priv_pro DES Specifies the privacy protocol that the SNMPv3 user being
tocol created uses.

snmp_priv_pa a string value Specifies the SNMPv3 privacy pass phrase.

ssphrase This attribute is mandatory only if the priv security level is
added. (via changing USERSECLEVEL from noAuthNoPriv or
authNoPriv to authPriv)

public_key_loc ftp://userid:pwd@ftphost:[portid]/url- Specifies the location of the public key.

ation path Port number 21 can be used for non-secure FTP file transfer.
Port number 22 is the default value and can be used for secure
FTP (SFTP) file transfer.
<url-path> specifies the device/drive/directory/
publickeyfilename.
NE automatically attempts to connect to the server holding the
public key file and store the key in the lowest available KEY
variable (that is, KEY1, KEY2...KEY6).

key_id ALLKEYS to clear all six keys. KEYx to Specifies the identifier for the key corresponding to the remote
clear an individual key, where x = 1 server's public key string that is to be cleared from the NE.
through 6.

password_agi [0-255] This attribute is the Password Aging Interval.

ng Default: 30 days Setting the value to 0 disables this attribute.

pwd_update_ [0-60] This attribute specifies the number of days that a user must wait
waiting_period Default: 25 days before he can update his password.
Setting the value to 0 disables this attribute.
Notes:
- When both PAGE and PUWP are enabled, PUWP must
always be inferior or equal to PAGE value.
-The system administrator can update PID (password) at
anytime. It is not impacted by the PUWP value.

snmp_user_se authPriv Specifies the SNMPv3 user security level.

c_level authNoPriv
noAuthnoPriv
Default: authPriv

snmp_auth_pr MD5 Specifies the authentication protocol that the SNMPv3 user
otocol SHA being created uses.

pid_encrypt N Optional parameter which indicates if the pid, snmpauthpid and

A snmpprivpid is transmitted with AES encryption (A) or no
Default: N encryption (N) in a TL1 command.
When parameter is omitted, PID is sent without encryption.

Example
ED-USER-SECU:CORIANT1:Smith22:AM0105::*:UAP=A4,TMOUT=30,PAGE=60,
PUWP=50,PELN=2,DBCHGMSG=INH,EVTMSG=INH,PMMSG=INH,STATUS=ENABLED;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-541

13. Edit Commands TL1 Command Reference Manual

Example
To edit an existing user who has unencrypted password such that it has AES encrypted password:

ED-USER-SECU:CORIANT1:Jackson71:AM0105::b614db5f47c75531e9748f4cb8a93179,A;
The above is shown as,
ED-USER-SECU:CORIANT1:Jackson71:AM0105::*,A;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Example
To provide SNMPv3 access to an existing user who had an AES encrypted pid:

ED-USER-
SECU:CORIANT1:Jackson71:AM0105:::UAPSNMP=A8,SNMPAUTHPID=b614db5f47c75531e9748f4c
b8a93179,SNMPPRIVPID=b614db5f47c75531e9748f4cb8a93179;
The above is shown as,
ED-USER-SECU:CORIANT1:Jackson71:AM0105:::UAPSNMP=A8,SNMPAUTHPID=*,SNMPPRIVPID=*;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Example
To provide SNMPv3 access to an existing user:

ED-USER-
SECU:CORIANT1:Peterson71:AM0105::*:UAPSNMP=A2,USERSECLEVEL=authNoPriv,SNMPAUTHPI
D=someAuthPID1;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Example
To change the SNMPv3 authentication passphrase only:

ED-USER-SECU:CORIANT1:Peterson71:AM0105::*:SNMPAUTHPID=newAuthPID1;

Page 30-542 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Example
To change the SNMPv3 authentication protocol only keeping the same SNMPv3 authentication passphrase:

ED-USER-
SECU:CORIANT1:Peterson71:AM0105::*:SNMPAUTHPROT=SHA,SNMPAUTHPID=latestAuPID;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Example
To add SNMPv3 encryption privilege to an existing SNMPv3 user:

ED-USER-
SECU:CORIANT1:Peterson71:AM0105::*:USERSECLEVEL=authPriv,SNMPPRIVPID=somePrivPID
1;
Note that this will set the SNMPV3 privacy protocol to DES, by default.

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Example
To remove SNMPv3 authentication and encryption privilege to an existing SNMPv3 user, but continue to provide
SNMPv3 access:

ED-USER-SECU:CORIANT1:Peterson71:AM0105::*:USERSECLEVEL=noAuthnoPriv ;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-543

13. Edit Commands TL1 Command Reference Manual

Example
The following example clears the value stored in the 3rd public key parameter for user Townsend82:

ED-USER-SECU:CORIANT1: Townsend82 :AM0105::,,,,,,,,,,,,,,,,,,,,,CLRKEY=KEY3;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Example
The following example adds a new public key for user Townsend82:

ED-USER-SECU:TELLABS7100:Townsend82:AM0105::,,,,,,,,,,,,,,,,,,,KEYLCN="sftp://
172.23.24.82/ssh/id_rsa.pub";

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0105 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-USER-SECU
DLT-USER-SECU
RTRV-USER-SECU
ED-SECU-SYS
RTRV-SECU-SYS

Page 30-544 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

ED-VCG

Command Changes Since Previous Feature Package

• None.

Description
The ED-VCG command instructs the network element (NE) to edit the attributes of a selected virtual concatenation
group entity.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• The ADDTTP, RMVTTP, ADDTTPMAP, RMVTTPMAP parameters can only be used if the VCGTYPE
is MAN.

• The NVALUE is only applicable to a AUTO VCG, and can only be changed prior to a VCG
crossconnection.

• The SSM-2S only support to assign TTPs which belong to same GroupId into same VCG under
parameters of ADDTTP and ADDTTPMAP, different group TTP assigned to same VCG is denied.

• The operation of changing TTPs resource from one group to another group is denied if the VCG is still
reserved by packet function. In such case, remove the packet service and release MAC over the
responding VCG and Delete the VCG, then create them again.

• On mTera SSM-2S working module that is in EPG group, edit VCG entity would implicitly edit VCG
entity on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to edit VCG entity would be
denied.

Command Format
ED-
VCG:[tid]:<vcg_aid>:ctag:::[ALMPF=<alarmProfile>][,ADDTTP=<ttp_aid>][,RMVTTP=<tt
p_aid>][,GroupId=<GroupId>][,ADDTTPMAP=<TtpMap>][,RMVTTPMAP=<TtpMap>][,CMDMDE=<c
ommandMode>][,NVALUE=<NValue>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-545

13. Edit Commands TL1 Command Reference Manual

Table 13.119 ED-VCG Parameters

Parameter Value(s) Definition
vcg_aid VCG-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-n

ttp_aid TTPSTS1-20-[1-16]-99-[1-3]-[1-192], Indicates the AID of a TTP to be added or removed from the
TTPSTS3C-20-[1-16]-99-[1-3]- VCG. This parameter is used when the vcgType is MAN.
[190,187,-,10,7,4,1]

GroupId [1-3] Indicates the Group whch the TTP belongs to . This parameter
is used only when the ttpmap is used.

commandMod NORM Specifies the command execution mode.

e FRCD In NORM mode, any state inconsistencies prevents the
Default: NORM command from executing.
In FRCD mode, the command executes whether or not there are
state inconsistencies.

NValue [1-192] Defines the current number of TTPs associated with a VCG. The
parameter only applies to vcgType AUTO.
- 1-192 (STS1 members)
- 1-64 (STS3C members)

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Ttpmap [1-192] Specifies the list of TTPSTS1 or TTPSTS3C

This parameter allows use of the grouping operator "&" or the

ranging operator "&&"
Note, ranging operation "&&" is not allowed to STS3C, since the
numbering scheme is not contiguous.

To be more specific, the list specifying depends on the

VCATTYPE of the given VCG:
a)If VCATTYPE=STS1:
Possible value in the list could be 1 to 192.
b)If VCATTYPE=STS3C:
Possible value in the list could be 1, 4, 7, 10, ..., 187, 190.

For example:
if VCATTYPE=STS1, add 7 TTPSTS1 together could be either
1&2&3&4&5&6&7 or 1&&7.
if VCATTYPE=STS3C, add 3 TTPSTS3C together could be
1&4&7.

Example
Add 7 members to STS3C group with VCGTYPE= MAN

ED-VCG:CORIANT:VCG-20-6-7:CTAG1:::GRPIDPOLICY= 1,ADDTTPMAP= 1&&7,NVALUE=7;

Possible System Response

^^^CORIANT1 08-02-08 07:45:00

Page 30-546 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-VCG
ENT-TTP
ENT-VCG
ED-VCG
RTRV-VCG

76.MTFP50/30, Rev B January 2018 Page 30-547

13. Edit Commands TL1 Command Reference Manual

ED-WARNING

Command Changes Since Previous Feature Package

• None.

Description
The ED-WARNING command instructs the network element (NE) to allow a system administrator to edit the warning
message displayed at user login. The message can consist of up to 18 lines with maximum of 80 characters per line.
Line with more than 80 characters is automatically split into multiple lines.

For lines that have less than 80 characters, enter '\n' to skip to a new line if desired.

Note that the current NOTICES described in the response to ACT-USER command, about unauthorized access and
Password expiration can not be modified. This command allows accommodation of additional information in the
response to ACT-USER.

Command Format
ED-WARNING:[tid]::ctag::<warningMesg>;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.120 ED-WARNING Parameters

Parameter Value(s) Definition
warningMesg Up to 18 lines with maximum of 80 Specifies the warning message to be displayed in the response
characters per line. to ACT-USER command when a user logs into the NE.
Note that entering ' \n' is interpreted as a carriage return by the
TL1 parser.

Refer to section 2 for the applicable characters.

Example
ED-WARNING:CORIANT1::CP0100::"This system is property of PTT TELCO. \n Use of this
system by unauthorized personnel may lead to jail.";

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M CP0100 COMPLD

Page 30-548 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ACT-USER
RTRV-WARNING

76.MTFP50/30, Rev B January 2018 Page 30-549

13. Edit Commands TL1 Command Reference Manual

ED-WCG

Command Changes Since Previous Feature Package

• New Command

Description
The ED-WCG command instructs the network element (NE) to reserve or release frequencies from a Wavelength
Contention Group (WCG) which is applicable in Colorless, Directionless add/drop architectures.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• When ACTION=MODIFY, NPOWNER must be specified. The reserved frequency specified in FREQ is
have its ownership modified based on the value entered in NPOWNER.

• If the FREQ value specified is not already reserved in the WCG list, the command with
ACTION=MODIFY is denied.

• CMDMDE=FRCD must be used to modify the NPOWNER unless the current NPOWNER is NONE or
MIGRATING.

• Attempts to reserve a frequency (using FREQ + ACTION=RESERVE) is denied if the frequency is

already reserved or in use (appears in the response to RTRV-WCG.)

• Attempts to release a frequency (using FREQ + ACTION=RELEASE) is denied if the frequency appears
in the response of RTRV-WCG with CC=YES (frequency is used by a cross-connection.)

Command Format
ED-
WCG:[tid]:<wcg_aid>:ctag:::FREQ=<centerFrequency>,ACTION=<wcgAction>[,NPOWNER=<N
pOwner>][,CMDMDE=<commandMode>;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 13.121 ED-WCG Parameters

Parameter Value(s) Definition
wcg_aid WCG-20-[1-16],WCG-[50-58]-[2-4,6-8] EntityID-ShelfID-SlotID

centerFrequen From 191350000 to 196100000 with Specifies a center frequency in MHz on which the specified
cy increment 50000 action is performed.

Page 30-550 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 13. Edit Commands

Table 13.121 ED-WCG Parameters (Continued)

Parameter Value(s) Definition
wcgAction RESERVE Specifies the action to be taken for the specified center
RELEASE frequency.
MODIFY RESERVE = Reserve the specified center frequency in the
WCG for the specified NpOwner.
RELEASE = Release a reserve center frequency from the WCG.
MODIFY = Modify the NpOwner.

NpOwner NONE Specifies the network partition owner of the specified center
3 frequency.

NONE = No owner
3 = Control Plane

CommandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution.
Enter FRCD to specify a forced mode of execution.

Example
ED-WCG:CORIANT1:WCG-50-2:AM0074:::FREQ=191350000,ACTION=RESERVE;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-WCG

76.MTFP50/30, Rev B January 2018 Page 30-551

14. Enter Commands TL1 Command Reference Manual

14. Enter Commands

ENT-AAA

Command Changes Since Previous Feature Package

• Added a FIPS mode constraint

Description
The ENT-AAA command instructs the NE to provision a AAA (Authentication, Authorization and Accounting) server.

Restrictions and Exceptions

• If the ED-TCPIP parameter ASINTRFC is set to NA, this command is denied

• If the ED-SECU-SYS parameter SECURE is set to FIPS, this command is denied

Command Format
ENT-
AAA:[tid]::ctag:::SERVER=<ipaddress>,SECRET=<sharedsecret>[,PROTO=<aaaproto>][,R
OLE=<aaarole>][,TIMEOUT=<radtimeout>][,RETRY=<radretry>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.1 ENT-AAA Parameters

Parameter Value(s) Definition
ipaddress [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the AAA server.

sharedsecret A string consisting of 6 to 32 Specifies the shared secret for the AAA server identified by the
characters. <ipaddress>.

The characters can be: numeric, lowercase alphabetical,

uppercase alphabetical or special characters: ! # $ % & @ ^ *
Note that the following characters are not allowed for
<sharedsecret>: ? / \ { [ ( ) ] }
The sharedsecret is displayed as "*".

aaaproto RADIUS Specifies the AAA protocol between NE and the AAA server.
Default: RADIUS

aaarole AUTH Specifies the AAA role supported by this AAA entry.
Default: AUTH

Page 30-552 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.1 ENT-AAA Parameters (Continued)

Parameter Value(s) Definition
radtimeout [1-60] Specifies the response timeout of Access-Request messages
Default: 5 sent to a AAA server in seconds.

radretry [1-10] Specifies the number of attempted Access-Request messages

Default: 3 to a single AAA server before failing authentication.

Example
The following example provisions a AAA server:
ENT-AAA:CORIANT1::AM0011:::SERVER="135.252.1.101",SECRET=*;

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-AAA
DLT-AAA
RTRV-AAA

76.MTFP50/30, Rev B January 2018 Page 30-553

14. Enter Commands TL1 Command Reference Manual

ENT-BL

Command Changes Since Previous Feature Package

• None.

Description
The ENT-BL command instructs the network element (NE) to create a bundled link.

Bundled Link Definitions

The purpose of a BL is to improve routing scalability by reducing the amount of routing information that needs to be
processed and advertised. This reduction is accomplished by grouping together topological links with the same
routing characteristics.

Figure 14.1 PROT and SYMPROT BL Example

A BL (Bundled Link) entity represents a logical group of topological links (TLs). 7100 control plane uses BLs to
represent a pair of links (TLs) that form a protection and working relationship for supporting protected services. A
BL is used as an inter-domain link supporting an E-NNI interface (PROT) or used as a null link supporting call
termination (SYMPROT). It contains up to two TLs.

The Coriant control plane uses the BL type PROT to represent a protected inter-domain link. To support routing with
two levels routing areas, BL needs to be redistributed into the parent area. This is accomplished by provisioning an
OSPFRP entity with redistribution type ABSTRACTNODE. The figure below illustrates that both BL and its
members (TLs) is redistributed into the same parent area. Thus, a BL and its members (TLs) must have the same
values for CRTAREAID, PRTAREAID and PLADDR on the OSPFRP abstract node entity.

• child routing area (CRTAREAID).

• parent routing area (PRTAREAID).

• parent node (PLADDR).

Page 30-554 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

A BL is created empty and then up to 2 E-NNI ODUk/OTUk TLs or 2 NULL ODUk/OTUk TLs are added via the ED-
BL-MEMBER command.

Latency mode and latency on the BL overrides the setting of the TL members. Changing these two parameters on
the TL or adding/removing TL members has no effect on the BL.

Restriction and Exceptions

• The BL can only be supported by TPCP partition.

• Creation of a BL entity is denied if the associated Node entity does not exist.

• The BL state is operationally IS if and only if both conditions are met: a) all TL members have been
added; b) all TL members are operationally IS.

• When a BL has no member, the BL state is operationally OOS, with the secondary state as INCOMP.

• When LATENCYMODE is DISABLED, LATENCY is not required as an input to ENT-BL.

• LATENCY parameter is valid for provisioning only if LATENCYMODE is set to MANUAL.

• If LATENCY parameter value is not supplied when LATENCYMODE is set to MANUAL, it is populated
with the default value.

• Specified IfIndexes must be an unallocated IfIndex from the range 65537-262144.

• Creation of a BL is denied on the mTera system if the specified IfIndex is already used.

Command Format
ENT-
BL:[tid]:<bl_aid>:ctag:::[BLNAME=<BLName>],BLTYPE=<BLType>,COST=<Cost>[,IFINDEX=
<IfIndex>][,NIFINDEX=<NeighborIfIndex>],ROUTING=<Routing>[,SRLG=<Srlg>][,LATENCY
MODE=<LatencyMode>][,LATENCY=<Latency>][,RESCLASS=<ResourceClass>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.2 ENT-BL Parameters

Parameter Value(s) Definition
bl_aid BL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-BLID

BLName A double quoted string consisting of 0 Specifies the Bundled Link name.
to 30 printable characters, not
including the quotes.
Default: "" (empty string)

76.MTFP50/30, Rev B January 2018 Page 30-555

14. Enter Commands TL1 Command Reference Manual

Table 14.2 ENT-BL Parameters (Continued)

Parameter Value(s) Definition
BLType PROT Specifies the Bundled Link type.
SYMPROT - PROT is for an E-NNI interface.
- SYMPROT is for a NULL link on ODUk/OTUk facility.
There is no default value.

Cost [1-4294967295] Specifies the cost for the link.

IfIndex [0-255].[0-255].[0-255].[0-255] Specifies the IfIndex.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

Routing PASSIVE Specifies the state of Routing.

DISABLED PASSIVE - This link is advertised, routing messages are not
transported over this link.
DISABLED - This link is not advertised, routing messages are
not transported over this link.

Srlg A double quoted input string of up to Specifies the Shared Risk Link Groups associated with this BL.
32 comma separated 4 byte hex
strings. Example:
Default: "" (empty string) "3E04990A,044D1A0C"

LatencyMode MANUAL Specifies the latency mode for this BL.

DISABLED MANUAL - the latency value is manually provisioned.
Default: MANUAL DISABLED - the latency parameter is not populated.

Latency [1-65535] Specifies the latency across this BL in Micro-Second.

Default: 200 Default is based on average fiber latency of 5 microseconds (us)
per kilometer and a distance of 40 km per segment between two
NEs.

ResourceClas A double quoted 4 byte hex strings. 32-bit long bit-mapped field with each bit representing a specific
s Default: "" (empty string) resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example bit-mapped resource class definitions:

"00000000" - None, used to reset to the default
value ""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

Example
ENT-BL::BL-3-4-
1:AM0011:::BLTYPE=PROT,COST=15,NIFINDEX=144.0.128.163,ROUTING=PASSIVE;

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Page 30-556 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-BL
DLT-BL
RTRV-BL

76.MTFP50/30, Rev B January 2018 Page 30-557

14. Enter Commands TL1 Command Reference Manual

ENT-CALL

Command Changes Since Previous Feature Package

• Support Callname up to 100 characters

Description
The ENT-CALL command instructs the NE Control Plane to establish an end-to-end path between network
elements. This command is only relevant for the NE serving as a call end-point.

The command supports to establish single port call and 2-port call. The single port call means the path(s) of the call
originate(s) from the single source endpoint and terminate(s) at the single destination endpoint.The 2-port call
means there are two pairs of source and destination endpoints respectively for the two paths of the call. The 2-port
call needs extra parameters to specify its second pair of endpoints, see the parameters section for the detail. The
single port call and 2-port call are differentiated by the protection levels. When the protection level of the call is
2PORT or 2PORTREROUTE, the call is a 2-port call, otherwise it is a single port call.

The 2 port diverse feature is not supported by SONET/SDH MT>1 call.

Figure 14.2 Call end-points

NE NE NE

Call Call
end-point end-point

The INGRSS/EGRSS parameter is in the form of IfIndex[-Label]. The IfIndex can be specified but no Label for
INGRSS and/or EGRSS, CP picks the label(s) for either MT=1 or MT>1 call. Note the CP picked label(s) can be
retrieved at CP_INGRSS and/or CP_EGRSS in response of MT=1 call, or label set object for MT>1 call if ingress
and/or egress labels were not specified at call creation stage.

CP_INGRSS, CP_EGRSS are retrieve only parameters for MT=1 call.

INGRSS2, EGRSS2, CP_INGRSS2 and CP_EGRSS2 only apply to 2-port call.

The INGRSS2 and EGRSS2 parameters have the similar usage of INGRSS and EGRSS but only apply to 2-port
call. The CP picked labels CP_INGRSS2 and CP_EGRSS2 can only be retrieved for the 2-port MT=1 call.

Page 30-558 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.3 Label related Parameters Applicability for CP Call

SONET/SDH CP Call OTN CP Call
PARAMETER
MT=1 MT>1 MT=1 MT>11

INGRSS X X2 X

EGRSS X X2 X
3
CP_INGRSS X X
n/a
3
CP_EGRSS X X

LABELSET X X

1. OTN CP MT>1 Call: Not supported.

2. Combinations on "INGRSS & ingress part of LABELSET" and "EGRSS & egress part of LABELSET" when a
SONET/SDH CP call created:
The following combinations of Interface and LABELSET are invalid:
a) INGRSS interface is specified, and a LABELSET with INGRSS is specified.
b) EGRSS interface is specified, and a LABELSET with EGRSS is specified.

The following values are valid with respect to the ingress side of the call:
a) INGRSS not specified. In this case, the LABELSET may be omitted, partial, or complete.
b) INGRSS specifies ifIndex only. In this case, the LABELSET may be omitted, or specify EGRSS only.
c) INGRSS specifies ifIndex and Label(s). In this case, the LABELSET may be omitted, or specify EGRSS only.

The following values are valid with respect to the egress side of the call:
a) EGRSS not specified. In this case, the LABELSET may be omitted, partial, or complete.
b) EGRSS specifies ifIndex only. In this case, the LABELSET may be omitted, or specify INGRSS only.
c) EGRSS specifies ifIndex and Label(s). In this case, the LABELSET may be omitted, or specify INGRSS only.

Note:
1) when no labels are user-specified for a given interface, the control plane determines the labels to be used.
2) if a LABELSET is specified, the count of the labels within that LABELSET must match the MT value specified in
the ENT-CALL.

3. CP_INGRSS, CP_EGRSS are retrieve only parameters for MT=1 call.

The range of MULTIPLER is from 1 to 32, this depends on the facility of the given call. For example, an OC12 facility
one can support up to 12 STS1 and 4 STS3C end to end circuits.
Provision of one or more MT>1 call(s) per one SONET/SDH facility for a SONET/SDH service is allowed.

Provision of one or more TTP supported MT>1 call(s) for VCAT (VCG supported) service is allowed.

Settings of CPREVERSION and CPWTR are ignored when the PROTLVL of a call referencing SLPF is set to
1P1TWOSTRIKES, 2PORT or UNPROTECT.

Restrictions and Exceptions

• The system denies an attempt to enter a call with an A_EndPoint that is not specified on the system or
if no route to the Z_EndPoint can be found.

• If an ENT-CALL is requested on a partition that does not have a RSVP entity defined, the call is denied.
The partition is identified in the first digit of the NODE AID specified in the NODE parameter.

76.MTFP50/30, Rev B January 2018 Page 30-559

14. Enter Commands TL1 Command Reference Manual

• If SRLG parameter has been entered with a non-empty string and the call being created is
UNPROTECT or REROUTE (that is, set in either the PROTTYPE or in the SLPF protection level field),
the SRLG constraints is the overriding parameter used in the creation of the call path.

• The WKGPATH/PROTPATH parameter applies to Unprotected, 1+1 Working/Protection, 2 port

unprotect, 2 port reroute and Full Time Protection services and needs to be consistent with the SLPF
definition.

• Only WKGPATH is used to define explicit path for unprotected services.

• Only WKGXPATH is allowed for specifying excluded path for unprotected services.

• An attempt to enter an MT>1 call is denied if any label(s) are specified in WKGPATH or PROTPATH.

• ENT-CALL is denied if SIGTYPE is not supported.

• The NE denies an attempt to provision an MT>1, if the signal type specified is not consistent with the
label.

• INGRSS/EGRSS and LABELSET permutation restrictions for SONET/SDH CP Call, please refer to
Table of "Label related Parameters Applicability for CP Call" above.

• Multiplier value must be 1 for OTN CP Call.

• LABELSET is not supported by OTN CP Call.

• Only MAN label set AID allowed (CP does not allow specifying AUTO label set AID) to LABELSET
parameter when calls are provisioned.

• In case of the explicit protect path contains E-NNI interface, CP ignores the E-NNI interface and use the
E-NNI interface which specified in the explicit working path.

• In case of the explicit protect path contains E-NNI interface, CP ignores the E-NNI interface and use the
E-NNI interface which specified in the explicit working path. The explicit protect path is not used in
signaling ( to the down stream domain), it is only used in the routing in the source domain.

• WKGPRP1 or PROTPRP1 is only allowed to be provided for dynamic reroute, 2-port reroute and full
time calls that have CP REVERSION set to Auto or Man.

• COMPWKGPRP1 or COMPPROTPRP1 is only allowed to be set as YES for dynamic reroute, 2-port
reroute and full time calls that have CP REVERSION set to Auto or Man.

• To assign a user defined explicit path to the working connection as the preferred restoration path,
COMPWKGPRP1 must be set to NO and the expp_aid referenced by WKGPRP1 must exist.

• To assign a user defined explicit path to the protect connection as the preferred restoration path,
COMPPROTPRP1 must be set to NO and the expp_aid referenced by PROTPRP1 must exist.

• To compute a preferred restoration path for the working connection, COMPWKGPRP1 must be set to
YES and the expp_aid referenced by WKGPRP1 must not exist.

• To compute a preferred restoration path for the protect connection, COMPPROTPRP1 must be set to
YES and the expp_aid referenced by PROTPRP1 must not exist.

• ENT-CALL is denied if a computed restoration path is requested but the system fails to compute a path
which meets the diversity constraint.

• The NE denies an attempt to provision an MT>1 call if the assigned preferred restoration path contains
label info.

• The ODUk/j/flex label is always a multiple of 8 hexadecimal digits.

Page 30-560 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• If BL is specified with label, the command is denied by CP and TL1 response SNVS "Operation Denied.
Labels are not applicable to BL".

• The EXPRATE, GFPTS parameters only apply to ODUF_CBR,ODUF_GFP call.

• EXPRATE must be used to specify the rate of the client when set up an ODUflex(CBR) call. CP
calculates and fulfills the "bit rate" in the signaling object and calculate TSs. The required number of TS
values is equal to: Ceiling(ODUflex(CBR) nominal bit rate/ 1,249,409.620 kbit/s) x (1.0001/0.99998)),
where ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an
ODU2. Ceiling(ODUflex(CBR) nominal bit rate/ 1,254,703.729 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU3.
Ceiling(ODUflex(CBR) nominal bit rate/ 1,301,709.251 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU4.

• GFPTS must be used to set up an ODUflex(GFP) call by providing the number of 1.25G Tributary Slots.
The supported ODUflex(GFP) bit rate in the signaling object is GFPTS x1,249,177.230 kbit/s when
GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s when GFPTS = 9 to 32, or GFPTS x 1,301,467.133 kbit/
s when GFPTS = 33 to 80.

• The system denies an attempt to specify a value for EXPRATE and GFPTS at the same time.

• The system denies an attempt to specify value for AEND2, ZEND2, NODEID2, INGRSS2 or EGRSS2
when the protection level value of the SLPF is not 2PORT or 2PORTREROUTE.

• AEND2, ZEND2 and NODEID2 are mandatory parameters when the protection level value of the SLPF
parameter is 2PORT or 2PORTREROUTE.

• Multiplier value must be 1 for 2-port Call.

• LABELSET is not supported by 2-port Call.

Command Format
ENT-
CALL:[tid]::ctag:::[CALLNAME=<Callname>],AEND=<A_EndPoint>,ZEND=<Z_EndPoint>,NOD
E=<node_aid>[,AEND2=<A_EndPoint>,ZEND2=<Z_EndPoint>,NODEID2=<node_id>],SIGTYPE=<
SignalType>,MULTIPLIER=<MultiplierValue>[,INGRSS=<Interface>][,EGRSS=<Interface>
][,INGRSS2=<Interface>][,EGRSS2=<Interface>][,DIRECT=<Directionality>][,WKGPATH=
<expp_aid>][,PROTPATH=<expp_aid>][,LABELSET=<Labelset_aid>][,SRLG=<Srlg>][,TIMEO
UT=<Timeout>][,SLPF=<Slpf>][,WKGPRP1=<expp_aid>,COMPWKGPRP1=<compute_restoration
_path>][,PROTPRP1=<expp_aid>,COMPPROTPRP1=<compute_restoration_path>][,WKGXPATH=
<exdp_aid>][,PROTXPATH=<exdp_aid>][,EXPRATE=<ExpClientRate>][,GFPTS=<nmbrOfTS_GF
Pclient>];

Proper System Response

The completed response indicates that the call has been established through all the NE elements between the call
end-points.
^^^<header>
M^^<ctag>^COMPLD<cr><lf>
^^^/* <CallId> */<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-561

14. Enter Commands TL1 Command Reference Manual

Table 14.4 ENT-CALL Parameters

Parameter Value(s) Definition
Callname A double quoted string consisting of 0 Specifies the call name.
to 100 printable characters, not
including the quotes. Refer to section 2 for the applicable characters.
Default: ""

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier.

node_id [0-255].[0-255].[0-255].[0-255] Specifies the node id.

The parameter NODEID2 is used to specify the second source
node of a 2-port call.

SignalType ODU0 The connection type of the call.

ODU1
ODU2
ODU2e
ODU3
ODU4
ODUF_CBR
ODUF_GFP
OTU2
OTU2e
OTU4
STS1
STS3C
STS12C
STS48C
STS192C

MultiplierValue [1-32] This value is used to indicate the number of channels of

SignalType used in the call.

Note: only MultiplierValue=1 supported for OTN services.

Interface A double quoted item sequence for the Dependency on a SONET/SDH switch_type value.
interfaces. Each item of interfaces is in This parameter identifies an egress interface to use on the
form of IfIndex[-Label] format: ZEND end point or an ingress interface to use on AEND end
(1)IfIndex is 8 hexadecimal digits. point TNA.
(2)Label is 8 hexadecimal digits for
non ODUk labels or G.709 V2 ODUk Example:
labels; Label is a multiple of 8 "110ABB11-00040000"
hexadecimal digits for G.709 V3
ODUk/j/flex labels.

Directionality BI This parameter specifies the direction of traffic flow. Bidirectional

Default: BI (BI) is the only supported value in the initial release.
Unidirectional does not be supported until a later release.

expp_aid EXPPATH-[1,3]-[1-512] Specifies the access identifier of the explicit path being refered
for a call.

Labelset_aid LABELSET-3-[d] This parameter specifies the access identifier of the label set
being referenced by a call.

Page 30-562 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.4 ENT-CALL Parameters (Continued)

Parameter Value(s) Definition
Srlg A double quoted input string of up to This parameter is ignored if Diversity is NONE.
32 comma separated 4 byte hex Specifies that Shared Risk Link Groups is avoided.
strings. The Hex string is a group of 4 hex byte strings representing the
Default: "" (empty string) SRLGs to avoid.

Example:
"3E04990A,044D1A0C"

Timeout [120-900] The maximum number of seconds that the end-to-end call is to
be established within.
The Network Partition default time out is used if this parameter
is not specified.

compute_resto YES Specifies whether to compute a preferred restoration path for

ration_path NO the working/protect connection.

exdp_aid EXDPATH-[1,3]-[1-512] Specifies the access identifier of the excluded path being
refered for a call.

ExpClientRate A fixed integer value between Specifies the expected signal rate of the constant bit rate
2488022 and 103688578. mapped client within the payload of the ODUflex.

This value is used by the system to determine the

ODUflex(CBR) "Bit Rate" in the RSVP signaling object. For a
terminated ODUF, the expected client rate is the same as the
Expected Rate of the GOPT facility that is mapped into the
ODUF. The number is specified in Kbps.
A fixed integer value between 2488022 and 9952261 when the
ODUF is supported by an OSM-2S.
A fixed integer value between 2488022 to 103688578 when the
ODUF is supported by an OSM-2C.

nmbrOfTS_GF [1-80] Specify the ODUflex(GFP) rate by entering the number of 1.25G
Pclient Tributary Slots when the ODUflex supports a GFP client.

This value is used by CP to determine the ODUflex(GFP) "Bit

Rate" in the RSVP signaling object.

The supported ODUflex(GFP) rate is GFPTS x 1,249,177.230

kbit/s when GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s
when GFPTS = 9 to 32, or GFPTS x 1,301,467.133 kbit/s when
GFPTS = 33 to 80.

Slpf_AID SLPF-[99,1-20], Service level profile to be configured by the customer. If none

NONE was specified, the call has the default SLPF-99.
Default: SLPF-99

EndPoint Enter type-xxx.xxx.xxx.xxx format: (1) The EndPoint is a TNA and is composed of the address type
type is one of the following: IPV4 and address.
(2)xxx = 0-255 In the model above this would be AEND/ZEND/AEND2/ZEND2.
AEND2 and ZEND2 are used to specify the second pair of
Endpoints of a 2-port call.

Example
The following example establishes an ODUflex GFP call with GFPTS=3:
ENT-CALL:CORIANT1::AM0011:::CALLNAME="PARIS",AEND=IPV4-
111.111.111.111,ZEND=IPV4-222.222.222.222,NODE=NODE-3-
1,SIGTYPE=ODUF_GFP,MULTIPLIER=1,INGRSS="00A01000",EGRSS="00CEE000",GFPTS=3;

76.MTFP50/30, Rev B January 2018 Page 30-563

14. Enter Commands TL1 Command Reference Manual

The following example establishes an unprotected 2-port call(assume SLPF-11 has been edited as 2-port unprotect
service level profile):
ENT-CALL:CORIANT1::AM0011:::AEND=IPV4-111.111.111.111,ZEND=IPV4-
222.222.222.222,NODE=NODE-3-1,AEND2=IPV4-111.111.111.112,ZEND2=IPV4-
222.222.222.223,NODEID2=122.222.222.222,SIGTYPE=ODU2,MULTIPLIER=1,INGRSS="110ABB
11-00040000",INGRSS2="110ABB12-00040000",SLPF=SLPF-11;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
/* IPV4-1.1.1.1-A1B2C3D4 */
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CALL
RTRV-CALL

SONET Label Description

The format of the label for a SONET TDM link is defined in IETF RFC4606 as follows (Note, the TTP label format
follows SONET/SDH SUKLM numbering rule):

Table 14.5 Label Format

0 1 2 3

0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

S U K L M

CP supports only SONET labels, and does not support low order signals. So the L, and M fields should be set to
zero. And for SONET, the K field should always be set to zero.

Table 14.6 SONET Labels Summary

Facility Signal Type S Range U Range
OC3 STS1 1 1 to 3

OC3 STS3C 1 0

OC12 STS1 N, 1<=N<=4 1 to 3

OC12 STS3C N, 1<=N<=4 0

OC12 STS12C 1 0

OC48 STS1 N, 1<=N<=16 1 to 3

OC48 STS3C N, 1<=N<=16 0

OC48 STS12C 4*(N-1)+1, 1<=N<=4 0

Page 30-564 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.6 SONET Labels Summary (Continued)

Facility Signal Type S Range U Range
OC48 STS48C 1 0

OC192 STS1 N, 1<=N<=64 1 to 3

OC192 STS3C N, 1<=N<=64 0

OC192 STS12C 4*(N-1)+1, 1<=N<=16 0

OC192 STS48C 16*(N-1)+1, 1<=N<=4 0

OC192 STS192C 1 0

SONET Example

Note: The S, U, and label values are in hex

For an OC3 facility, signal type = STS1, the second STS1:

S = 0001, U = 2, label = 00012000
For an OC12 facility, signal type = STS3C, the third STS3C:
S = 0003, U = 0, label = 00030000
For an OC48 facility, signal type = STS1, the third STS1 in the 16th STS3C:
S = 0010, U = 3, label = 00103000
For an OC48 facility, signal type = STS12C, the fourth STS12C:
S = 000D, U = 0, label = 000D0000
For an OC48 facility, signal type = STS48C:
S = 0001, U = 0, label = 00010000
For an OC192 facility, signal type = STS48C, the second STS48C:
S = 0011, U = 0, label = 00110000

OTN Legacy Label Description

Generalized Label [RFC3471] with Class-Num = 16, C-Type = 2 is used in OTN CP.

Details of the ODUk label format are documented in [RFC4328]. The following is an abstract description.

The G.709 Digital Path Layer label or ODUk label has the following format:

Table 14.7 RFC4328 Label Format

0 1 2 3

0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

Reserved t3 t2 t1

76.MTFP50/30, Rev B January 2018 Page 30-565

14. Enter Commands TL1 Command Reference Manual

t1 (1-bit):
- t1=1 indicates an ODU1 signal.
- t1 is not significant for the other ODUk signal types.
t2 (3-bit):
- t2=1 indicates an ODU2 signal that is not further sub-divided.
- t2=[2..5] indicates the tributary slot (t2th-1) used by the ODU1 in an ODTUG2 mapped into an ODU2 (via OPU2).

OTN New Label Description

In order to be compatible with new types of ODU signal and new types of tributary slot, the following new ODUk label
format is defined in Draft-ietf-ccamp-gmpls-signaling-g709v3-00:

Table 14.8 New V3 Label Format

0 1 2 3

0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1

TPN Reserved Length

Bit Map

The ODU Generalized Label is used to indicate how the LO ODUj signal is multiplexed into the HO ODUk link. Note
that the LO ODUj signal type is indicated by traffic parameters, while the type of HO ODUk link can be figured out
locally according to the identifier of the selected interface carried in the IF_ID RSVP_HOP Object.

TPN (12 bits): indicates the Tributary Port Number (TPN) for the assigned Tributary Slot(s). The value range of TPN
is depend on the LO ODUj signal type and the HO ODUk tributary size. In case of ODUj mapped into OTUk (j=k),
the TPN is not needed and this field MUST be set to 0.

Length : (12 bits): indicates the number of bit of the Bit Map field, that is,, the total number of TS in the HO ODUk link.

Bit Map (variable): indicates which tributary slots in HO ODU that the LO ODU is multiplexed into. The sequence of
the Bit Map is consistent with the sequence of the tributary slots in HO ODU. Each bit in the bit map represents the
corresponding tributary slot in HO ODU with a value of 1 or 0 indicating whether the tributary slot is used by LO ODU
or not. Padded bits are added behind the Bit Map to make the whole label a multiple of four bytes if necessary.
Padded bit MUST be set to 0 and MUST be ignored.

Page 30-566 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-CRS-OCH

Command Changes Since Previous Feature Package

• Added new restrictions based on WCG (wavelength contention group).

Description
OCH Cross-connections (CRS) enable the provisioning of the routing of OCH signals (such as wavelengths) going
through a Network Element (NE). It is used to indicate if a specific wavelength is added/dropped or passed through
within an NE, and how this wavelength is routed by setting a path for all CRS types. This path describes the modules
through which the OCH goes (e.g TRM-TRM), and also gives the cross-connect specific usage (ADD/DROP).
The ENT-CRS-OCH command can be used to provision cross-connections between OCH-L entities and either
another OCH-L, or an OCH-P, OCH-OS, or an OCH.

OCH Facility Definitions

An OCH-L represents an Optical Channel (wavelength) at the DWDM interface of a NE. The OCH-L is always
located on the first module where the Line Side (such as DWDM/OTS) Signal enters the NE.

The OCH-P represents the Optical Channel (wavelength) as it is terminated at the Optical-to-Electrical conversion
point on an OSM module.
The creation of a cross-connection between an OCH-L and the OCH-P enables the transmit laser on the OSM
interface and tunes the interface to the frequency selected based on the OCH-L provisioning.
The OCH-OS represents the Optical Channel or Optical Signal as it is terminated at the Optical-to-Electrical
conversion point on an OSM-4F/OSM-4C.
The creation of a cross-connection between an OCH-L and the OCH-OS enables the transmit laser on the OSM
interface and tunes the interface to the frequency selected based on the OCH-L provisioning.
The OCH is used within this command to identify a foreign wavelength going through ADD/DROP ports on an OMD
or CDCP.
• OCH-L facilities are explicitly provisioned on mTera UTP.

• OCH-P facilities are explicitly provisioned on mTera UTP.

• OCH-OS facilities are explicitly provisioned on mTera UTP.

• OCH facilities are implicitly provisioned on add/drop ports of the OMD and CDCP when OCH cross
connections (between OCH-L and OCH-P) are provisioned through the OMD/CDCP to the OCH-P
ports.

• OCH facilities can also be explicitly provisioned on OMD, CDCP for support of foreign wavelengths.

OCH Cross-Connection Types

There are 2 main types of OCH Cross-connections: ADD/DROP (OCH-L to OCH-P/OCH-OS) and PASS-
THROUGH (OCH-L to OCH-L). The Cross-Connect path field is mandatory for all OCH CRS.

An OCH-L to OCH-P/OCH-OS cross-connection allows add/drop of a signal from a DWDM interface to a

transponder. Note that before an OCH-L to OCH-P/OCH-OS CRS can be provisioned, all applicable FIBR entities,
using the ENT-FIBR-EQPT command have to be provisioned.

An OCH-L to OCH cross connection allows add/drop of a wavelength from a DWDM interface to an alien
transponder. For this type of connection explicitly provision an OCH facility using ENT-OCH command. All
applicable FIBR entities must be provisioned using the ENT-FIBR-EQPT command before the OCH-L to OCH cross
connection can be provisioned.

76.MTFP50/30, Rev B January 2018 Page 30-567

14. Enter Commands TL1 Command Reference Manual

An OCH-L to OCH-L cross connection allows pass through of a specific wavelength from one DWDM interface to
the other DWDM interface within the NE.

Note that before an OCH-L to OCH-L CRS can be provisioned, provision the FIBR entity between two OADMRS/
OADMRS9s, using the ENT-FIBR-EQPT command.

Restrictions and Exceptions

• An attempt to create OCH-L to OCH-P/OCH-OS add/drop cross-connect from management plane is
denied, if there is an OCH-L to OCH-L cross-connect is owned by control plane on the given OCH-L
facility.

• An attempt to create OCH-L to OCH-L cross-connect from management plane is denied, if there is an
OCH-L to OCH-P/OCH-OS cross-connect is owned by control plane on the given OCH-L facility.

• An attempt to create an OCH cross-connection involving an OCH-L is denied, if it represents a channel

that is not in the CHANALLOW list provided in ED-OMS command.

• An attempt to create a cross connection (that is, ENT-CRS) is denied if one or both end-points are
owned by Control Plane.

• An OCH cross-connection creation is denied if there is any supported FIBR entity not created on the
interfaces that the OCH cross-connection needs to go through. The supported FIBR entities are defined
in ENT-FIBR-EQPT command.

• The attempt to create a cross connection with an OCH-L as the source entity is denied if that entity is
already the source entity for another cross connection.

• The attempt to create a cross connection with an OCH-L as the destination entity is denied if that entity
is already the destination entity for another cross connection.

• The attempt to create an OCh cross connection is denied if an optical path does not exist based on ENT-
FIBR-EQPT provisioning between the ports of OCH-P/OCH/OCH-L entities to be cross connected.

• The attempt to create cross connection between two OCH-L entities is denied, if the two OCH-Ls are
on the same DWDM Line interface.

• The attempt to create cross connection between OCH-L and OCH-L entities is denied if the FREQs of
the two entities are not same.

• The attempt to create cross connection between OCH-P/OCH-OS and OCH-L entities is denied if the
OCH-P port or pluggable on the port cannot support the frequency specified by the OCH-L.

• The attempt to create cross connection between OCH-P and OCH-L entities through CDC module is
denied if the OCH-P port is not a coherent signal.

• The attempt to create a cross connection between OCH-P and OCH-L entities through a CDC module
is denied if the pluggable on the OCH-P port does not support a coherent signal.

• The attempt to create a cross connection between OCH-P and OCH-L of an OADMRS with coherent
only OMS CHANTYPES is denied if the OCH-P port is not a coherent signal.

• The attempt to create a cross connection between OCH-P and OCH-L of an OADMRS with coherent
only OMS CHANTYPES is denied if the pluggable on the OCH-P port does not support a coherent
signal.

• The attempt to create a cross connection through an add/drop port of an OMD module is denied if the
center frequency of the OMD add/drop port is not same as the FREQ of the OCH-L entity.

• The attempt to create a cross connection on an OADMRS module through an OMD module is denied if
the OMD is not created on the subslot of the OADMRS/OADMRS9 module.

Page 30-568 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• The attempt to create a colored add/drop OCh cross connection on an OCH-L of an OADMRS is denied
if OTS interoperation mode of the OADMRS is MTERA or HIT7300.

• The attempt to create a colored add/drop OCh cross connection on an OCH-L of an OADMRS is denied
if OTS interoperation mode of the OADMRS is MTERA or HIT7300.

• The attempt to create a cross-connection is denied if the frequency is listed in RTRV-WCG response of
the associated WCG in a CD-AD structure and CC=YES.

• The attempt to create a cross-connection is denied if the frequency is listed in the RTRV-WCG response
of the associated WCG on a CD-AD structure, CC=NO, and the NPOWNER of the frequency does not
match the NPOWNER of the AIDs in the ENT-CRS-OCH command.

• The GRP ID must be unique per cross-connection.

Command Format
ENT-CRS-
OCH:[tid]:<from_och>,<to_och>:ctag::[<CCT>]:GRP=<grp>[,CKTID=<circuitIdentificat
ion>],CCPATH=<ccPath>;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.9 ENT-CRS-OCH Parameters

Parameter Value(s) Definition
from_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]

to_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num

OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]

CCT 2WAY Specifies the cross-connection type.

1WAY 2WAY = two-way/bidirectional cross-connection
Default: 2WAY 1WAY = one-way/unidirectional cross-connection

grp One to 45 alphanumeric characters. Specifies the group ID of the cross-connection being
provisioned.

76.MTFP50/30, Rev B January 2018 Page 30-569

14. Enter Commands TL1 Command Reference Manual

Table 14.9 ENT-CRS-OCH Parameters (Continued)

Parameter Value(s) Definition
circuitIdentifica One to 46 alphanumeric characters. Specifies the circuit ID of the cross-connection being
tion Default: "" (empty string) provisioned.
<space> character is not allowed.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

ccPath CMM-CMM Specifies on which module the crossconnection is going

ADD/DROP through.
ADD - CMM-CMM: represents a DWDM signal going through two
DROP OADMs for an OCH-L to OCH-L pass through connection.
- ADD/DROP: represents a 2-way signal being added/dropped.
- ADD: represents a 1-way signal being added
- DROP: represents a 1-way signal being dropped

Example
ENT-CRS-OCH:MTERA1:OCH-L-20-1-21-7,OCH-P-20-4-
1:AM0074:::GRP="12345",CKTID="CORIANT1",CCPATH=ADD/DROP;

Possible System Response

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-OCH
ED-CRS-OCH
RTRV-CRS-OCH
ENT-FIBR-EQPT

Page 30-570 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-CRS-ODUk

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ENT-CRS-ODUk command where k={0,1,2,2E,3,4,F}, instructs the network element (NE) to provision an ODUk
cross-connection across a switch fabric in support of ODU switching.

This command is also used to create the connections necessary for SNC protection for the ODUk. When the cross
connect type (CCT) is set to one of the protected options, an ODUk path protection group (PPG) is implicitly created.

This command is also used for SSM-2S to create the connections necessary for SONET/SDH adaption to OTN
application together with other OSM-x module (that is, OSM-1S/OSM-2S/OSM-2C/OSM-4F/OSM-4C/OSM-4S/
OSM-5C) where the OTN facility is allocated. The connection for the SSM-2S end could be unprotected when no
EPG provisioned, or portected when EPG provisioned.
Allowable switch fabric cross connections in mTera:

Table 14.10 Supported Cross-Connect Rates

ODU2e
ODUF

ODU2
ODU0

ODU1
Cross connect matrix

ODU3

ODU4
(with clocktype)

ODUF X
ODU0 X
ODU1 X
ODU2 X
ODU2e X
ODU3 X
ODU4 X

Restrictions and Exceptions

• The system denies cross-connection of an ODUk if the TXSAPI, TXDAPI, or TXOPER is not empty and
the client being mapped is not equal to a non-OTU AID.

• An attempt to create a cross connection is denied if one or both end-points are owned by Control Plane.

• An attempt to create an ODUk cross-connection is denied if the PT is set and the ODUk is unterminated.

• An attempt to create an ODUk cross-connection is denied if the ODUk has the PT set and the client
being mapped is the OTUk AID.

• An attempt to create an ODUk cross-connection is denied if the ODUk has an AID which includes the
TribID and DMSOURCE=ENABLED.

• An attempt to create an ODUk cross-connection is denied if the ODUk has an AID which includes the
TribID and the PRBS or NULL test signal is being inserted in the ODUk's payload.

• If an ODUk of OCH-P/OCH-OS/OTU port is enabling DMSOURCE, an attempt to create cross-

connection with the ODUk is denied.

76.MTFP50/30, Rev B January 2018 Page 30-571

14. Enter Commands TL1 Command Reference Manual

• If an ODUk of OCH-P/OCH-OS/OTU port is enabled with NULL or payload PRBS testing, an attempt to
create cross-connection for it is denied.

• The system denies an attempt to create a protected connection (2WAYPR, 1WAYPR) involving a
source that is already involved as a source in another protected connection.

• An attempt to specify a value for DEST_PROT is denied when the CCT=1WAYPR. A 1WAYPR
connection has a working and protect source ODUk.

• The system denies an attempt to create a protected ODU cross-connection when the associated client
is configured for Y-Cable protection.

• An attempt to provision a 1WAY ODU cross-connection from a client ODU to an ODU multiplexed into
an OTU is denied when a Y-cable FFP is provisioned on the port facility associated with the client ODU
and another 1WAY ODU cross-connection in the opposite direction does not exist (from the ODU
multiplexed into an OTU to the client ODU.)

• For OSM1S, if an ETH entity exists on any port 1 through 16, then the system denies an attempt to
create an ODU cross-connection on any ODUs that exist on ports 1 through 16.

• For OSM1S, if an ETH entity exists on any port 17 through 32, then the system denies an attempt to
create ODU cross-connections on any ODUs that exist on ports 17 through 32.

• For OSM-1S, If an ODU0 or ODU1 entity exists on port 1 through 16 with SWITCHTYPE=PKT, then the
system denies an attempt to create ODU cross-connections on ports 1 through 16.

• For OSM-1S, If an ODU0 or ODU1 entity exists on port 17 through 32 with SWITCHTYPE=PKT, then
the system denies an attempt to create ODU cross-connections on ports 17 through 32.

• For SSM-2S, when 1+1 EPG provisioned for OTN adaption single point failure equipment protection,
only need specify the ODUk entity associated with working SSM-2S module in the cross connection,
the protection entity is not involved and the system creates a protected ODUk cross connection
automatically once the EPG configured already.

Command Format
ENT-CRS-
ODUk:[tid]:<src_odu>,<dest_odu>:ctag::[<CCT>]:[SRC_PROT=<src_prot_odu>][,DEST_PR
OT=<dest_prot_odu>][,CKTID=<circuitIdentification>][,RDLD=<red_lined>][,SRC_PROT
TYPE=<src_ProtectionType>][,DEST_PROTTYPE=<dest_ProtectionType>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-572 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.11 ENT-CRS-ODUk Parameters

Parameter Value(s) Definition
src_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-573

14. Enter Commands TL1 Command Reference Manual

Table 14.11 ENT-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

CCT 2WAY Specifies the cross connection type:

2WAYPR - 2WAY: Bidirectional connection (default).
2WAYDRI - 2WAYPR: Bidirectional connection with SNC Protection
1WAY - 2WAYDRI: Bidirectional Dual Ring Interconnected connection
1WAYPR - 1WAY: Unidirectional connection
Default: 2WAY - 1WAYPR: Unidirectional connection with SNC Protection

Page 30-574 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.11 ENT-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
src_prot_odu ODUF-20-[1-16]-[1-40]-[1-80], Specifies the ODU that is the crossconnection source. It it used
ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1- only when working and protected ODU have different ODU_IDs
32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

76.MTFP50/30, Rev B January 2018 Page 30-575

14. Enter Commands TL1 Command Reference Manual

Table 14.11 ENT-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_prot_odu ODUF-20-[1-16]-[1-40]-[1-80], Specifies the ODU that is the crossconnection destination. It it
ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1- used only when working and protected ODU have different
32], ODU_IDs
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

circuitIdentifica One to 46 alphanumeric characters. Specifies the circuit ID of the channel being provisioned.
tion Default: "" (empty string) <space> character is not allowed in this parameter.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

red_lined YES Specifies if the circuit is to be red-lined or not.

NO If the circuit is red-lined (YES), then it cannot be modified or
Default: NO deleted unless the INCL=YES parameter is specified in the ED/
DLT command.

src_Protection SNCI Specifies the Protection Type that is applied to the SRC (source)
Type SNCN side of the connection.
Default: SNCN - SNCI: SubNetwork Connection protection with Inherent
monitoring. Only the server layer is monitored for protection
switching purposes.
- SNCN: SubNetwork Connection protection with Non-intrusive
monitoring. The end-to-end layer and the server layer are
monitored for protection switching purposes.

Page 30-576 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.11 ENT-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_Protectio SNCI Specifies the Protection Type that is applied to the DEST
nType SNCN (destination) side of the connection.
Default: SNCN - SNCI: SubNetwork Connection protection with Inherent
monitoring. Only the server layer is monitored for protection
switching purposes.
- SNCN: SubNetwork Connection protection with Non-intrusive
monitoring. The end-to-end layer and the server layer are
monitored for protection switching purposes.

Example 1
ENT-CRS-ODU2:CORIANT1:ODU2-20-1-3-1,ODU2-20-1-5-3:MV0076::2WAY:CKTID="ILEC3";

Possible System Response

^^^CORIANT1 09-03-15 02:08:15

M MV0076 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-ODUk
ED-CRS-ODUk
RTRV-CRS-ODUk

76.MTFP50/30, Rev B January 2018 Page 30-577

14. Enter Commands TL1 Command Reference Manual

ENT-CRS-STSn (STS1/3C/12C/48C/192C)

Command Changes Since Previous Feature Package

• None.

Description
The ENT-CRS-STSn command instructs the network element (NE) to provision an STSn cross-connection.

When there is an existing 1+1 FFP, ALL STS must be involved in a protected CRS (CRS with CCT=2WAY,
2WAYPR, 1WAY or 1WAYPR).

When there is an existing 1+1 EPG for the OTN/EOS adaption point equipment protection, ALL STSn/TTPSTSn
associated with virtual port 99 on backplane must be involved in a protected CRS (CRS with CCT=1WAY, 2WAY,
2WAYPR, or 1WAYPR).

Restrictions and Exceptions

• The SOURCE and DESTINATION STS terminations must be of type specified in command.

• In 1WAY CRS, direction is determined by the <src_sts> going to the <dest_sts>.

• This command is denied if the specified STSn is owned by the control plane.

• When CP creates the cross-connect, the CKTID value is assigned as the connection ID.

• The system denies an attempt to create a protected connection (2WAYPR, 1WAYPR) involving a
source that is already involved as a source in another protected connection.

Command Format
ENT-CRS-STSn:[tid]:<src_sts>,<dest_sts>:ctag::[<CCT>]:
[,SRC_PROT=<src_prot_fac>][,DEST_PROT=<dest_prot_fac>]
[,CKTID=<circuitIdentification>][,RDLD=<red_lined>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-578 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.12 ENT-CRS-STSn (STS1/3C/12C/48C/192C) Parameters

Parameter Value(s) Definition
src_sts STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

dest_sts STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID

20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

CCT 2WAY Specifies the cross connection type:

1WAY - 2WAY: Bidirectional connection (default).
1WAYPR - 1WAY: Unidirectional connection.
2WAYPR - 2WAYPR: Bidirectional protected connection.
Default: 2WAY - 1WAYPR: Unidirectional protected connection.

src_prot_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STS that is the protection STS associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <src_sts>. It it used only when working and protected STS have
STS3C-20-[1-16]-[1-30]-[190,- different StsID in SNCP 1WAYPR/2WAYPR.
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

76.MTFP50/30, Rev B January 2018 Page 30-579

14. Enter Commands TL1 Command Reference Manual

Table 14.12 ENT-CRS-STSn (STS1/3C/12C/48C/192C) Parameters (Continued)

Parameter Value(s) Definition
dest_prot_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STS that is the protection STS associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <dest_sts>. It it used only when working and protected STS
STS3C-20-[1-16]-[1-30]-[190,- have different StsID in SNCP 1WAYPR/2WAYPR.
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

circuitIdentifica One to 46 alphanumeric characters. Specifies the circuit ID of the channel being provisioned.
tion Default: "" (empty string) <space> character is not allowed in this parameter.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

red_lined YES Specifies if the circuit is to be red-lined or not.

NO If the circuit is red-lined (YES), then it cannot be modified or
Default: NO deleted unless the INCL=YES parameter is specified in the ED/
DLT command.

Example 1: 2WAY Non-protected STS1 CRS

ENT-CRS-STS1:CORIANT1:STS1-20-11-1-6,STS1-20-11-9-150:AM0075::2WAY:
CKTID="ILEC32";

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0075 COMPLD

Example 2: STS3C of Port OC3-20-2-10 is 2 Way Protected by OC192 In Port 20-4-1 and 20-
13-1. Assumption: OC192 1+1 APS FFP Between OC192-20-4-1 and OC192-20-13-1
Already Provisioned
ENT-FFP-OC192::OC192-20-4-1,OC192-20-13-1:ctag:::SCHEME=1P1;
1- Create SONET Port Side Facility OC3 and SONET STS3C Terminations:

1- Create Sonet Port Side Facility OC3 and Sonet STS3C Port Side And Line Side Terminations:

ENT-OC3::OC3-20-2-10:ctag1::::IS;

ENT-STS3C::STS3C-20-2-10-1:ctag2::::IS;

ENT-STS3C::STS3C-20-4-1-4:ctag3::::IS;

Page 30-580 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-STS3C::STS3C-20-13-1-4:ctag3::::IS;

2- Create STS3C Cross-connection:

ENT-CRS-STS3C::STS3C-20-2-10-1,STS3C-20-4-1-4:ctag4::2WAY;

The 2WAY value in the CCT field causes the mTera to automatically setup a protected connection if a 1+1 FFP or
EPG is configured on the port side of the module. If a protected cross-connect is required, for 1+1 APS the mTera
need explicitly create the port side STS3C on the protection port (for example, STS3C-20-13-1-4) that has FFP
configured; for 1+1 EPG the mTera implicitly creates the port side STS3C on the protection SSM-2S (for example,
STS3C-20-13-1-4).

3- Example of TL1 retrieval commands:

RTRV-CRS-STS3C:CORIANT1:STS3C-20-2-10-1,STS3C-20-4-1-4:AM0077;

^^^CORIANT1 02-03-15 02:08:15

M AM0077 COMPLD

"STS3C-20-2-10-1,STS3C-20-4-1-4:2WAYPR:DEST_PROT=STS3C-20-13-1-
4:AUTOCFG=YES,CKTID="RBOC23":IS-NR"

RTRV-STS3C:CORIANT1:STS3C-20-2-10-1:AM0181;

CORIANT1 02-02-02 03:20:21

M AM0181 COMPLD

"STS3C-20-2-10-1::CPTYPE=\" SSM2S: Sonet/SDH Switching Module 2 (SFP/SFP+)

\",ALMPF=99,SFTHRESH=10E-4,SDTHRESH=10E-7:IS-NR,"

76.MTFP50/30, Rev B January 2018 Page 30-581

14. Enter Commands TL1 Command Reference Manual

Example 3: 1+1 EPG

Figure 14.3 1+1 EPG Provision Example, with 1+1 APS FFP on facility and ODUk SNC on OSM-2S

SSM-2S (slot 4) SSM-2S (slot 5)

1+1 APS
w/ or w/o 1+1 APS
OC192-20-4-1 OC192-20-5-1
STSn path entity on protection
STS3C-20-4-1-1 STS3C-20-5-1-1
facility visible and created
(4/7/10/...) (4/7/10/...) explicitly

W P
Equipment Protection
SSM-2S (slot 1) SSM-2S (slot 3)
All entities include ODUk/OCn/
STS3C-20-1-99-1-1 1+1 EPG STS3C-20-3-99-1-1 STSn/TTPSTSn/VCG/MAC
(4/7/10/...) (4/7/10/...)
associated with backplane on
OC192-20-1-99-1 OC192-20-3-99-1 protection SSM-2S visible but
provisioned (include enter, edit,
ODU2-20-1-99-1 ODU2-20-3-99-1 delete) implicitly with entity
provision (include enter, edit,
delete) on working module.

SNC

ODU2-20-2-2 ODU2-20-2-1

w/ or w/o ODU SNC

OCH-P-20-2-2 OCH-P-20-2-1

OSM-2S (slot 2)

1- Provision SSM-2S module to reserve the OTN (and/or EOS) mapping resource by selecting which port groups
need be used for the OTN (and/or EOS) adaption. More details refer to ENT-EQPT/ED-EQPT:

ENT-EQPT:CORIANT1:SSM2S-20-1:AM0074:OTN_MAP_GROUP=1&2&3::;

ENT-EQPT:CORIANT1:SSM2S-20-3:AM0074:OTN_MAP_GROUP=1&2&3::;

2- Provision facility and entity for OSM-2S:

ENT-OCH::OCH-P-20-2-1;

ENT-OCH::OCH-P-20-2-2;

ENT-ODU2::ODU2-20-2-1;

ENT-ODU2::ODU2-20-2-2;

3- Provision facility and entity for SSM-2S on slot 4 and 5 that provide FFP protection:

Page 30-582 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OC192::OC192-20-4-1;

ENT-OC192::OC192-20-5-2;

ENT-STS3C::STS3C-20-4-1-1(and STS3C-20-4-1-4/7/10/---/190);

ENT-STS3C::STS3C-20-5-2-1(and STS3C-20-5-2-4/7/10/---/190);

4- Provision 1+1 APS FFP for OC192 ports OC192-20-4-1 and OC192-20-5-2:

ENT-FFP-OC192::OC192-20-4-1,OC192-20-5-2::::SCHEME=1P1

5- Provision 1+1 EPG protection group for adaption traffic with SSM-2S module on slot 1 and slot 3:

ENT-EPG:: SSM2S-20-1, SSM2S-20-3;

6- Provision facility and entity for working SSM-2S in slot 1 only, the corresponding facility and entity associated with
backplane for adaption traffic on protection SSM-2S in slot 3 is implicity created:

ENT-OC192:: OC192-20-1-99-1; (OC192 on protection module implicit created)

ENT-ODU2 :: ODU2-20-1-99-1; (ODU2 on protection module implicit created)

ENT-STS3C::STS3C-20-1-99-1-1(and 4/7/10Ö); (STSn on protection module implicit

created)

7- Provision a STS circuit by cross-connect STSn under working facility of 1+1 APS FFP and STSn under working
module of 1+1 EPG. Only working path entity need be specified in the cross connection but a protected cross
connection for both ends is created with 1+1 FFP and 1+1 EPG pre-provision:

ENT-CRS-STS3C:: STS3C-20-4-1-1, STS3C-20-1-99-1-1:CTAG: :2WAY

8- Provision a ODUk SNC protection with OSM-2S module to protect the ODUk on SSM-2S. Only the ODUk path
entity of working module for a EPG protection group need be specified in the cross connection but a protected cross
connection for OTN adaption end is created with 1+1 EPG pre-provision:

ENT-CRS-ODU2::ODU2-20-2-1,ODU2-20-1-99-1:CTAG: :2WAYPR:src_prot =ODU2-20-2-2;

Example 4: Using CCT set to 2WAYPR with both source protection and destination
protection for back-to-back SNCP
ENT-CRS-STS3C:7100 NanoE:STS3c-20-2-2-1,STS3C-20-2-10-
1:CTAG01::2WAYPR:SRC_PROT=STS3C-20-12-2-1,DEST_PROT=STS3C-20-12-10-
1,CKTID=MBHCCT22;

76.MTFP50/30, Rev B January 2018 Page 30-583

14. Enter Commands TL1 Command Reference Manual

Figure 14.4 CCT=2WAYPR with src_prot_stsn and dest_prot_stsn included.

CRS
Fabric

Port Line
terminations terminations

w STS 3 c - 20 - 2- 1 - 1
STS 3 c - 20 - 2 - 2- 1

STS 3 c - 20 - 12 - 2 - 1 p STS 3 c - 20 - 12 - 1 - 1

Example 5: Using CCT set to 2WAYPR with destination protection for SNCP
ENT-CRS-STS3C:CORIANT1:STS3c-20-2-2-1,STS3C-20-2-1-
1:CTAG01::2WAYPR:DEST_PROT=STS3C-20-12-1-1,CKTID=MBHCCT22;

Figure 14.5 CCT=2WAYPR with src_prot_stsn only.

CRS
Fabric

Port Line
terminations terminations

w STS 3 c - 20 - 2 - 1 - 1
STS 3 c - 20 - 2 - 2 - 1

STS 3 c - 20 - 12 - 2 - 1 p

Example 6: Using CCT set to 2WAYPR with source protection for SNCP
ENT-CRS-STS3C:CORIANT1:STS3c-2-2-2-1,STS3C-2-2-1-
1:CTAG01::2WAYPR:SRC_PROT=STS3C-2-12-2-1,CKTID=MBHCCT22;

Page 30-584 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Figure 14.6 CCT=2WAYPR with dst_prot_stsn only.

CRS
Fabric

Port Line
terminations terminations

w
STS 3 c - 20 - 2 - 2 - 1

STS 3 c - 20 - 12 - 2 - 1 p STS 3 c - 20 - 12 - 1 - 1

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-STSn
ED-CRS-STSn
RTRV-CRS-STSn

Protection Combinations and STS Cross-connections

For this release, the table below shows the types of cross-connections that can be made based on the protection
being used for the facilities that support the source and destination STS. This section provides information on how
to provision Protection group, port side facilities and cross-connection for the different scenarios shown in the table.
All cross connection need go through MFAB.

Table 14.13 STS CRS Supported In This Release

1waypr

2waypr
1way

2way

First
Release SRC STS DEST STS
FP3.0 Unprotected1 Unprotecte1,3 x x

FP3.0 Unprotected3 Unprotecte1 x x

FP4.0 Unprotected1 Unprotecte2 x x

FP4.0 Unprotected2 Unprotecte1 x x

FP4.0 Unprotected1,2,3 1+1 APS1 x x

FP4.0 Unprotected1,2,3 SNCP1 x

FP4.0 1+1 APS1 Unprotected1,2,3 x x

FP4.0 1+1 APS1 1+1 APS1 x x

FP4.0 1+1 APS1 SNCP1 x

FP4.0 SNCP1 Unprotected1,2,3 x x

FP4.0 SNCP1 1+1 APS1 x x

76.MTFP50/30, Rev B January 2018 Page 30-585

14. Enter Commands TL1 Command Reference Manual

Table 14.13 STS CRS Supported In This Release (Continued)

1waypr

2waypr
1way

2way
First
Release SRC STS DEST STS
FP4.0 SNCP1 SNCP1 x

FP4.0 Unprotected1 EPG2,3 x x

FP4.0 1+1 APS1 EPG2,3 x x

FP4.0 SNCP1 EPG2,3 x x

FP4.0 EPG2,3 Unprotected1 x x

FP4.0 EPG2,3 1+1 APS1 x x

FP4.0 EPG2,3 SNCP1 x

Notes:
1.The STSn associated with front panel physical port OC/STMn;
2.The STSn associated with virtual port 99 on backplane OC/STMn, which is demapped from ODU1/ODU2. Can
cross connect only with STS/VCn under physical port OC/STMn;
3.The TTPSTSn associated with virtual port 99 on backplane, which is terminated to EOS. Can cross connect
only with STSn under physical port OC/STMn.

Allowed STS CRS

Once appropriate facilities and STS termination points have been provisioned, the cross-connections of type 1WAY,
1WAYPR, 2WAY and 2WAYPR can be provisioned.
The SSM-2S supports connections at the STS1, STS3C, STS12C, STS48C, STS192C rates.
The following figure displays some examples of STS CRS that can be provisioned.

1WAY/2WAY Connections
These connections are allowed between 2 STSx for which there is no protection group configured on their side. They
are also allowed if one or both STSx have a supporting OCn facility involved in 1+1 APS FFP or 1+1 EPG. These
connections are not allowed if there are SNCP on the sides associated with one or both STSx.

2 x 1WAY connections can be provisioned using same STSx source.

A single 2WAY connection using same STSx can also be combined with these 1 WAY connections.

Page 30-586 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Figure 14.7 1WAY/2WAY Unprotected STS3C CRS, on SSM-2S

OC192-A, STS3C-A Provisioning Sequence

1 Provision Port Facility OC3-B on port 8:
SSM2S-20-6 ENT-OC3::OC3-20-4-8:ctag1::::IS;
ENT-OC192::OC192-20-6-1:ctag1::::IS;

Provision Port termination STS3C-B on port 8:

Note: MFAB allows this ENT-STS3c::STS3C-20-4-8-1:ctag2::::IS;
connection to be done on
MFABs
the same or on 2 different
SSM-2S modules. Provision Port side termination STS3C-A on port 1:

ENT-STS3C::STS3C-20-6-1-7:ctag3::::IS;

SSM2S-20-4
Provision STS CRS if 2WAY CRS:
8
ENT-CRS-STS3C::STS3C-20-4-8-1,STS3C-20-6-1-
OC3-B, STS3C-B 7:ctag4::2WAY:RDLD=YES

Or if 1WAY CRS from B to A:

ENT-CRS-STS3C::STS3C-20-4-8-1,STS3C-20-6-1-
7:ctag4::1WAY;

Or if 1WAY CRS from A to B:

ENT-CRS-STS3C::STS3C-20-6-1-7,STS3C-20-4-8-
1:ctag4::1WAY;

Retrieve STS3C-B CRS:

RTRV-CRS-STS3C::STS3C-20-4-8-1,ALL:ctag5;

^^^CORIANT1 07-03-15 02:08:15

M ctag5 COMPLD
"STS3C-20-4-8-1,STS3C-20-6-1-7::2WAY:
AUTOCFG=NO,CKTID="":IS-NR,RDLD"

76.MTFP50/30, Rev B January 2018 Page 30-587

14. Enter Commands TL1 Command Reference Manual

Figure 14.8 1WAY Unprotected With Broadcast Connections

Broadcast connection is done by provisioning multiple 1WAY
Connections using the same source (STS3C-A). This allow in-service
addition/removal of legs as requested.
OC192-A, STS3C-A OC192-E, STS3C-E

1. Provision 1WAY Drop from A to B:

ENT-CRS-STS3C::STS3C-20-6-1-7,STS3C-20-4-
SSM2S-20-6 SSM2S-20-11 20-1:ctag1::1WAY;
2. Provision 1WAY Drop from A to C:

ENT-CRS-STS3C::STS3C-20-6-1-7,STS3C-20-4-
8-1:ctag2::1WAY;
MFABs
3. Provision 1WAY Drop from A to D:

ENT-CRS-STS3C::STS3C-20-6-1-7,STS3C-20-13-
11-7:ctag3::1WAY;
SSM2S-20-4 SSM2S-20-13 4. Provision 1WAY Drop from A to E:

ENT-CRS-STS3C::STS3C-20-6-1-7,STS3C-20-11-
1-145:ctag4::1WAY;
OC3-B, STS3C-B OC3-D, STS3C-D
5. Retrieve STS3C-A CRS:
OC3-C, STS3C-C
RTRV-CRS-STS3C::STS3C-20-6-1-7,ALL:ctag5:
^^^CORIANT7100 07-03-15 02:08:15
M ctag5 COMPLD
"STS3C-20-6-1-7,STS3C-20-4-20-1::1WAY:
AUTOCFG=NO,CKTID="":IS-NR"
"STS3C-20-6-1-7,STS3C-20-4-8-1::1WAY:
AUTOCFG=NO,CKTID="":IS-NR"
"STS3C-20-6-1-7,STS3C-20-13-11-7::1WAY:
AUTOCFG=NO,CKTID="":IS-NR"
"STS3C-20-6-1-7,STS3C-20-11-1-145::1WAY:
AUTOCFG=NO,CKTID="":IS-NR"

Figure 14.9 Unprotected 1WAY/2WAY connections are also supported when there is a 1+1 APS FFP provisioned
on the side associated with either the <src_sts> and <dest_sts>, as shown in the following example.

Page 30-588 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Figure 14.10 2WAY Unprotected CRS with 1+1 FFP on Another Side.

1. Provision OC3-B port side facility and supported STS3C-A and STS3C-B.
OC192-A, STS3C-A OC192-D, STS3C-D

2. Provision OC192 1+1 APS FFP between OC192-A and OC192.D.

SSM2S-20-6 SSM2S-20-11 3. Provision 2WAY Drop from B to A:

ENT-CRS-STS3C::STS3C-20-4-8-1,STS3C-20-6-
1-7:ctag::2WAY;

MFABs 4. Retrieve STS3C-B CRS:

RTRV-CRS-STS3C::STS3C-20-4-8-1,ALL:ctag5:
^^^CORIANT1 07-03-15 02:08:15
M ctag5 COMPLD
SSM2S-20-4 "STS3C-20-4-8-1,STS3C-20-6-1-7::2WAY:
SSM2S-20-13
AUTOCFG=NO,CKTID="":IS-NR"

OC3-C, STS3C-C
OC3-B, STS3C-B
Note 1: Additional 1WAY or 2WAYPR
could be provisioned using STS3C-B as a
source.

1WAYPR Connections
This type of connection is allowed if there is a SNCP on the side associated with the <src_sts> or <dest_sts>.

76.MTFP50/30, Rev B January 2018 Page 30-589

14. Enter Commands TL1 Command Reference Manual

Figure 14.11 1WAYPR Connections With No Protection Or Protection On Destination STS

OC192-A, STS3C-A OC192-A, STS3C-A OC192-D, STS3C-D

1 1 STS3C SNCP 4
SSM2S-20-6 SSM2S-20-6 SSM2S-20-11

MFABs
MFABs

STS3C SNCP STS3C SNCP

SSM2S-20-4 SSM2S-20-13 SSM2S-20-4 SSM2S-20-13
8 20 8 20
OC3-B, STS3C-B OC3-C, STS3C-C OC3-B, STS3C-B OC3-C, STS3C-C

The RTRV-CRS-STS command shows SRC_PROT and/or DEST_PROT parameters depending if there is an FFP
associated with the <src_sts> or <dest_sts> or not.

Figure 14.12 1WAYPR CRS, with SNCP Associated with Source STS
S
OC192-A, STS3C-A OC192-D, STS3C-D 1. Provision port facility and supported STS3C-A, STS3C-B,
and STS3C-D.
STS3C SNCP
1 1
SSM2S-20-6 SSM2S-20-11

2. Provision 1WAYPR from A to B to setup SNCP connection:

MFABs
ENT-CRS-STS3C::STS3C-20-6-1-7,STS3C-20-4-
8-1:ctag1::1WAYPR:SRC_PROT=STS3C-20-11-1-7;
3. Retrieve STSC-A CRS:

RTRV-CRS-STS3C::STS3C-20-6-1-7,ALL:ctag5:
SSM2S-20-4 ^^^CORIANT1 07-03-15 02:08:15
M ctag5 COMPLD
8 "STS3C-20-6-1-7,STS3C-20-4-8-1:1WAYPR:
OC3-B, STS3C-B :SRC_PROT=STS3C-20-11-1-7,SRC_PROT_STATUS
=NOREQ,AUTOCFG=NO,CKTID="":IS-NR"

Note 1: Multiple additional 1WAY, 1WAYPR,

and one 2WAYPR or 2WAY could be provisioned using
STS3C-A as a source.

Page 30-590 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Figure 14.13 1WAYPR CRS, with SNCP on Source STS and 1+1 FFP on Destination STS

1. Provision OC3-B/OC3-C/OC192-A/OC192-D port side facilities and supported

OC192-A, STS3C-A OC192-D, STS3C-D A, STS3C-B, STS3C-C, and STS3C-D.

STS3C SNCP 2. Provision OC3 1+1 FFP.

1 1
SSM2S-20-6 SSM2S-20-11 3. Provision 1WAYPR from A to B:

ENT-CRS-STS3C::STS3C-20-6-1-7,STS3C-20-4-
8-1:ctag::1WAYPR:SRC_PROT=STS3C-20-11-1-7
;
MFABs
4. Retrieve STSC-A CRS:

RTRV-CRS-STS3C::STS3C-20-6-1-7,ALL:ctag5:
OC3 1+1 FFP ^^^CORIANT7100 07-03-15 02:08:15
M ctag5 COMPLD
SSM2S-20-4 SSM2S-20-13 "STS3C-20-6-1-7,STS3C-20-4-8-
8 22 1::1WAYPR:SRC_PROT=STS3C-20-11-1-
7,DEST_PROT=STS3C-20-13-22-
OC3-B, STS3C-B OC3-C, STS3C-C 1,AUTOCFG=NO,SRC_PROT_STATUS=NOREQ,CKTID=
"":IS-NR"

Note 1: Multiple additional 1WAYPR and

one 2WAYPR could be provisioned using STS3C-A as a
source.

2WAYPR Connections
This type of connection is allowed if there is either <src_sts> or <dest_sts> (or both) have a supporting OCn facility
involved in SNCP.

76.MTFP50/30, Rev B January 2018 Page 30-591

14. Enter Commands TL1 Command Reference Manual

Figure 14.14 2WAYPR connection with unprotected SOURCE STS and Protected (SNCP) DESTINATION STS

1. Provision OC3-B, OC192-A, and OC192-D port facility and supported

OC192-A, STS3C-A OC192-D, STS3C-D STS3C-A, STS3C-B, STS3C-D path entity.

STS3C SNCP
1 1
SSM2S-20-6 SSM2S-20-11

MFABs 2. Provision 2WAYPR from B to A:

ENT-CRS-STS3C::STS3C-20-4-8-1,STS3C-20-6-
1-7:ctag1::2WAYPR:DEST_PROT=STS3C-20-11-1-7

3. Retrieve STSC-B CRS:

SSM2S-20-4
RTRV-CRS-STS3C::STS3C-20-4-8-1,ALL:ctag5:
8 ^^^CORIANT1 07-03-15 02:08:15
M ctag5 COMPLD
OC3-B, STS3C-B
"STS3C-20-4-8-1,STS3C-20-6-1-7:2WAYPR:
DEST_PROT=STS3C-20-11-1-7,AUTOCFG=NO,
CKTID="":IS-NR"

Page 30-592 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Figure 14.15 2WAYPR connection with Protected SOURCE STS (1+1) and Protected (SNCP) DESTINATION STS

1. Provision OC192-A, OC192-D, OC3-B and OC3-C port side facilities

and supported STS3C-A, STS3C-B, STS3C-C, and STS3C-D.
OC192-A, STS3C-A OC192-D, STS3C-D

SNCP 2. Provision OC3 1+1 FFP.

1 1
SSM2S-20-6 SSM2S-20-11 3. Provision 2WAYPR from B to A:

ENT-CRS-STS3C::STS3C-20-4-8-1,STS3C-20-6-1-
7:ctag1::2WAYPR:
DEST_PROT=STS3C-20-11-1-7;
MFABs 4. Retrieve STSC-B CRS:

RTRV-CRS-STS3C::STS3C-20-4-8-1,ALL:ctag5:
^^^CORIANT1 07-03-15 02:08:15
OC3 1+1 FFP M ctag5 COMPLD
"STS3C-20-4-8-1,STS3C-20-6-1-7:2WAYPR:
SSM2S-20-4 SSM2S-20-13 SRC_PROT=STS3C-20-13-22-1,DEST_PROT=
8 22 STS3C-20-11-1-7,AUTOCFG=NO,
DEST_PROT_STATUS=NOREQ,CKTID="":IS-NR"
OC3-B, STS3C-B OC3-C, STS3C-C

Note 1: Multiple additional 1WAYPR

could be provisioned using STS3C-B as a source.

76.MTFP50/30, Rev B January 2018 Page 30-593

14. Enter Commands TL1 Command Reference Manual

ENT-DA

Command Changes Since Previous Feature Package

• None.

Description
The ENT-DA command instructs the network element (NE) to create the Discovery Agent (DA).

The Discovery Agent is used to perform Neighbor Discovery on any non-IP Topological Links (TL) with the Neighbor
Discovery (NDISCOVERY) attribute enabled. Creating the Discovery Agent is a prerequisite to creating a non-IP
Topological Link with Neighbor Discovery enabled.

Restrictions and Exceptions

• Only DA-1 is supported.

• Only IP or SINTF-1 TLs from NP-1 can be provisioned as DADCNIF.

Command Format
ENT-
DA:[tid]:<DA_aid>:ctag:::DADCNIF=<DcnTL>[,MGMTDOM=<mgtDomain>]:[<editablePrimary
State>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.14 ENT-DA Parameters

Parameter Value(s) Definition
DA_aid DA-1 EntityID-DAID

DcnTL TL-1-[1-512]-[1-1500] Identifies the IP or SINTF-1 TL to be used for sending and

receiving Discovery PDUs.

mgtDomain A double quoted string consisting of 0 Specifies the Management Domain Name.
to 30 printable characters, not Refer to section 2 for the applicable characters. If not provided
including the quotes. the empty string is used.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Outof-Service (OOS).
Default: IS

Example
ENT-DA:CORIANT1:DA-1:AM0011:::DADCNIF=TL-1-1-1,MGMTDOM="USEast":IS;

Page 30-594 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Possible System Response

^^^CORIANT1 06-05-15 02:09:11

M AM0011 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TL
DLT-DA
ED-DA
RTRV-DA

76.MTFP50/30, Rev B January 2018 Page 30-595

14. Enter Commands TL1 Command Reference Manual

ENT-EPG

Command Changes Since Previous Feature Package

• None.

Description
The ENT-EPG command instructs the network element (NE) to provision an EPG (equipment protection group) for
adaption traffic in the case of single point failure on equipment level. The adaption include SONET/SDH clients to
OTN adaption and EOS (Ethernet Over SONET/SDH) adaption.

SSM-2S could be used to bridge the SONET/SDH domain to OTN domain by grooming the STS/VCn path entities
from SONET/SDH domain and then adapt to OC/STMn facility which is mapped to ODUk and that ODUk is swithed
in OTN domain with other OSM modules in mTera shelf. Similarly, SSM-2S could be used also to bridge the SONET/
SDH domain to packet domain by grooming the Ethernet packect traffic from OSM-x modules and then adapt it to
TTPSTS/VCn path entities with EOS function and switch the TTP entity under a VCG group with the STS/VCn
associated with physical SONET/SDH facility of front panel. To protect the adaption point failure caused by
equipment for example module failure or missing, this command is used to setup the protection group between two
modules.

Refer to ENT-CRS-ODU command for examples on how to setup a circuit in OTN domain that involves the ODUk
entity associated with working SSM-2S module.

Refer to ENT-CRS-STS/ENT-CRS-VC command for examples on how to setup a circuit in SONET/SDH domain
that involves the STS/VCn path entity associated with working SSM-2S module.

Restrictions and Exceptions

• The first name-defined parameters entered after the ctag must not have its leading comma.

• The system denies this command if any of working module or protection module involves in another
EPG group.

• The system denies this command if there is existing entity (ODUk, OCn/STMn, STSn/VCn, TTPSTSn/
VCn, VCG) associated with virtual port 99 on backplane for adaption traffic on either protection module
or working module.

• Followed by this command, all entities include ODUk/OC192/STSn/VCn/TTPSTSn/TTPVCn/VCG/MAC

on protection SSM-2S module are provisioned (include enter, edit, delete) implicitly with entity
provisioned (include enter, edit, delete) on working SSM-2S module.

Command Format
ENT-EPG:[tid]:<protectedModule>,<protectingModule>:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Page 30-596 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.15 ENT-EPG Parameters

Parameter Value(s) Definition
protectedModu SSM2S-20-[1-16] EntityID-ShelfID-SlotID
le

protectingMod SSM2S-20-[1-16] EntityID-ShelfID-SlotID

ule

Example 1
ENT-EPG:CORIANT1: SSM2S-20-1, SSM2S-20-3:CTAG-1;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Example 2: Provision a circuit that has 1+1 FFP configued on client port, SNC configured
on ODUk
See ENT-CRS-STSn example 3.

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EPG
RTRV-EPG

76.MTFP50/30, Rev B January 2018 Page 30-597

14. Enter Commands TL1 Command Reference Manual

ENT-EQPT

Command Changes Since Previous Feature Package

• Added PWS, CD4D8

• Added support for OSM-4S, OSM-5C.

Description
The ENT-EQPT::{X} command instructs the network element (NE) to provision an equipment entity.

Restrictions and Exceptions

• The CPName parameter string must be entered between quotes.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered must not have its leading comma.

• Entering the SH, FAN, FAN8, SDM, SIOM, STPM, or STPM8 equipment is denied because the modules
are implicitly created when the supporting shelf is created.

• A HW mismatch alarm is raised if wrong SFP/SFPP/CFP/CFP2 type inserted after pre-provisioning

implemented by ENT-EQPT::SFP/SFPP/CFP/CFP2 command.

• The attempt to create an OMD or DCM entity on the subslot of an OADMRS is denied if the subslot is
used as COMMCONN of an extension SLOT (EXTENSIONSLOT of the subslot is not NA).

• If supporting module does not exist, the attempt to provision pluggable module of it is denied.

• On SSM-2S, there are three port groups corresponding to three independent physical Framers. Each
port group support max. 40G SONET/SDH Framer include the OCn/STMn facility on front panel
physical port and the OCn/STMn facility demapped from ODUk (k=1/2) on backplane; support max. 20G
OTN mapping capacity in the combination of any ODU2 or ODU1 when the parameter
OTN_MAP_GROUP for that port group checked per the provision of the module; support max. 10G
EOS mapping capacity on backplane when EOS_MAP_GROUP for that port group checked per the
provision of the module. But the bandwidth include front panel OCn/STMn facility and backplane OCn/
STMn facility demapped from ODUk and TTPSTSn/TTPVCn for EOS on backplane, does not exceed
40G. The OCn/STMn interface (based on pluggable 6xSFPP+ and 24xSFP optics) on front panel
physical port and the entity (ODU1/ODU2/OCn/STMn/STSn/VCn/TTPSTSn/TTPVCn) provisioned on
backplane is grouped in the way below:
- The first port group (connecting with 1st Framer):
Port 1-2: 2xSFP+ for 10G OC192/STM64 clients
Port 7-14: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 7-14 (for example,
ODU1-<shelf>-<slot>-<99>-<7-14>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 1-2 (for example,
ODU2-<shelf>-<slot>-<99>-<1-2>)
TTPSTSn/VCn with the port group number 1 (for example, TTPSTSn-<shelf>-<slot>-<99>-<1>-<1-
192>)
- The second port group (connecting with 2nd Framer):
Port 3-4: 2xSFP+ for 10G OC192/STM64 clients
Port 15-22: 8xSFP for <=2.5G OCn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 15-22 (for example,
ODU1-<shelf>-<slot>-<99>-<15-22>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 3-4 (for example,

Page 30-598 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ODU2-<shelf>-<slot>-<99>-<3-4>)
TTPSTSn/VCn with the port group number 2 (for example, TTPSTSn-<shelf>-<slot>-<99>-<2>-<1-
192>)
- The third port group (connecting with 3rd Framer):
Port 5-6: 2xSFP+ for 10G OC192/STM64 clients
Port 23-30: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 23-30 (for example,
ODU1-<shelf>-<slot>-<99>-<23-30>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 5-6 (for example,
ODU2-<shelf>-<slot>-<99>-<5-6>)
TTPSTSn/VCn with the port group number 3 (for example, TTPSTSn-<shelf>-<slot>-<99>-<3>-<1-
192>)

• On SSM-2S, the parameter OTN_MAP_GROUP is used to specify a single value, or a group of values,
or a range of values identifying which port groups is used within the supporting module to do OTN
adaption. The granularity is 20G, which means when a port group is selected it reserves 20G ODU
mapping capacity. By default no port group is selected for OTN adaption.

• On SSM-2S, the parameter EOS_MAP_GROUP is used to specify a single value, or a group of values,
or a range of values identifying which port groups is used within the supporting module to do EOS
adaption. The granularity is 10G, which means when a port group is selected it reserves 10G ODU
mapping capacity. By default all three port groups are selected for EOS adaption.

• The value of DISPCOMPRL must be less than the value of DISPCOMPRH.

• The difference between the values of DISPCOMPRL and DISPCOMPRH must be at least 1000.

• The DISPCOMPRL and DISPCOMPRH parameters are only supported for CFPs with the part numbers
81.71T-CDWDMS-R6 or 82.71T-CDWDMS-R6.

Passive WDM Shelves (PWS) can be deployed in 3-shelf daisy chains from an OADMRS-9. A single mTera
supports up to 3 daisy chains of PWS shelves. When creating (ENT-EQPT) PWS shelves, they must be created in
the order supported by the daisy chain (for example, PWS-56 before PWS-57). The table below shows the shelf
numbers for each supported daisy chain.

Table 14.16 PWS Daisy Chains

Daisy Chain

1 2 3
50 53 56

PWS Shelf Number 51 54 57

52 55 58

When managing a PWS daisy chain, the first shelf in the daisy chain (for example, 50, 53 or 56) is connected to a
COMM port on an OADMRS-9. When creating the first PWS shelf, specify the AID of the OADMRS-9 COMM subslot
in the COMMCONN parameter. When creating the second or third shelf of the daisy chain; specify the AID of the
immediately preceding PWS shelf in the daisy chain (for example, when entering PWS-58 specify PWS-57) in the
COMMCONN field.

If the PWS COMM ports does not be connected, then provision COMMCONN as NA.

• An attempt to create a PWS is denied if the shelf preceeding it in the daisy chain has not been created.

• PWS shelves 50, 53, and 56 must have COMMCONN set to NA or an OADMRS-9 COMM subslot AID.

76.MTFP50/30, Rev B January 2018 Page 30-599

14. Enter Commands TL1 Command Reference Manual

• An attempt to configure COMMCONN to a value other than NA for PWS shelves 51, 52, 54, 55, 57 or
58 is denied if COMMCONN is not specified to as the PWS shelf that is one less (for example, PWS-51
must specify COMMCONN as PWS-50).

Command Format
ENT-
EQPT:[tid]:<eqpt_aid>:ctag[:::[,CPNAME=<CPName>][,CHANRANGE=<ChannelRange>][,ALM
PF=<almProfile>][,EXTATTN=<ExternalAttenuator>][,OTN_MAP_GROUP=<OTN_Map_Group>][
,EOS_MAP_GROUP=<EOS_Map_Group>][,DISPCOMPRL=<dispcomprl>][,DISPCOMPRH=<dispcompr
h>][:<editablePrimaryState>]];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters Applicability when Entering the Command

• OTN_MAP_GROUP and EOS_MAP_GROUP apply only to SSM-2S module. For an SSM-2S, it is
optional to specify the OTN_MAP_GROUP and EOS_MAP_GROUP parameters, by default no port
group is selected for OTN mapping but all of three port groups are selected for EOS mapping.

Table 14.17 Parameters Applicability When Entering the Command

BFM
SFP
SFPP
CFP
DCM
OSM2C
OSM1S
OSM2S
OSM4C
OSM4F
OSM4S
OSM5C
SAIM
SEIM
SFM
OCC
CDCP
MPOBO
FSM
a
PARAMETER DEFb CD4D8 OMD OADMRS PWS
ALMPF ND O O O O

CPNAME ND O O O

CHANRANGE ND M

EXTATTN ND O

SHELFNAME ND O

COMMCONN ND M

Page 30-600 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.17 Parameters Applicability When Entering the Command (Continued)

BFM
SFP
SFPP
CFP
DCM
OSM2C
OSM1S
OSM2S
OSM4C
OSM4F
OSM4S
OSM5C
SAIM
SEIM
SFM
OCC
CDCP
MPOBO
FSM
a
PARAMETER DEFb CD4D8 OMD OADMRS PWS
PST PD O O O O

a. M indicates a MANDATORY and O indicates an OPTIONAL parameter for the specified module.
b. ND: Name Defined or PD: Position Defined, in the input command.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-601

14. Enter Commands TL1 Command Reference Manual

Table 14.18 ENT-EQPT Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CD4D8-[50-58]-[2-4,6-8]
CDCP-20-[10-16,1-7]-[1-3]
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
DCM-20-[1-16]-[1-3]
FSM-20-[35,34]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OMD-20-[1-16]-[1-2]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SSM2S-20-[1-16]
STIM-20-[26,23]

CPName Is a string of length 0 to 47 characters. Specifies an additional field to identify the entity.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ChannelRange 48S Specifies the type of OMD based on the channel range.
48O - 48S = OMD48S supporting Standard frequencies 191.40 THz
1_44 to 196.10 THz
45_88 - 48O = OMD48O supporting Offset frequencies 191.35 THz to
196.05 THz
- 1_44 = OMD44 supporting channels 1 through 44
- 45_88 = OMD44 supporting channels 45 through 88.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

ExternalAttenu [0-20] 1 to 20 dB indicates the value of any external attenuator that is

ator Default: 0 connected to the input of an input amplifier.

0 indicates that no external attenuator is present.

Page 30-602 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.18 ENT-EQPT Parameters (Continued)

Parameter Value(s) Definition
OTN_Map_Gr [0-3] Specifies a single value, or a group of values, or a range of
oup values identifying which port groups is used within the
supporting SSM-2S module to do OTN adaption. The granularity
is 20G, which means when a port group is selected it reserves
20G ODU mapping capacity. 1 means 1st port group selected, 2
means 2nd port group selected, 3 means 3rd port group
selected, 1&2&3 means all the three port groups selected and
on a SSM-2S module it could support 60G OTN mapping. 0
means non port group is selected so no resource reserved for
OTN mapping.

Use & for grouping.

Use && for ranging.

EOS_Map_Gr [0-3] Specifies a single value, or a group of values, or a range of

oup values identifying which port groups is used within the
supporting module to do EoS adaption. The granularity is 10G,
which means when a port group is selected it reserves 10G
Ethernet over SONET/SDH mapping capacity. 1 means 1st port
group selected, 2 means 2nd port group selected, 3 means 3rd
port group selected, 1&2&3 means all the three port groups
selected and on a SSM-2S module it could support 30G EOS
mapping.0 means non port group is selected so no resource
reserved for EOS mapping.

Use & for grouping.

Use && for ranging.

dispcomprl AUTO, -40000 to +39000 Specifies the low end of the range for the chromatic dispersion
picoseconds/nanometer (ps/nm) in 1 search.
ps/nm increments.
Default: AUTO When set to AUTO for the CFP parts 81.71T-CDWDMS-R6 and
82.71T-CDWDMS-R6, the low end of the range for the
chromatic dispersion search is set to -40000 picoseconds/
nanometer (ps/nm)

dispcomprh AUTO, -39000 to +40000 Specifies the high end of the range for the chromatic dispersion
picoseconds/nanometer (ps/nm) in 1 search.
ps/nm increments.
Default: AUTO When set to AUTO for the CFP parts 81.71T-CDWDMS-R6 and
82.71T-CDWDMS-R6, the high end of the range for the
chromatic dispersion search is set to +40000 picoseconds/
nanometer (ps/nm)

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

Wavelength/ChannelId Association
Refer to the table below for the wavelength/frequency associated with each channel and half-band in mTera UTP

Table 14.19 96-Channel Plan, Wavelength/ChannelId Association

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
90 191.4 1566.314 89 191.35 1566.723

76.MTFP50/30, Rev B January 2018 Page 30-603

14. Enter Commands TL1 Command Reference Manual

Table 14.19 96-Channel Plan, Wavelength/ChannelId Association (Continued)

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
92 191.5 1565.496 91 191.45 1565.905

94 191.6 1564.679 93 191.55 1565.087

1 191.7 1563.863 95 191.65 1564.271

2 191.8 1563.047 45 191.75 1563.455

3 191.9 1562.233 46 191.85 1562.64

4 192 1561.419 47 191.95 1561.826

5 192.1 1560.606 48 192.05 1561.013

6 192.2 1559.794 49 192.15 1560.2

7 192.3 1558.983 50 192.25 1559.389

8 192.4 1558.173 51 192.35 1558.578

9 192.5 1557.364 52 192.45 1557.768

10 192.6 1556.555 53 192.55 1556.959

11 192.7 1555.747 54 192.65 1556.151

12 192.8 1554.94 55 192.75 1555.344

13 192.9 1554.134 56 192.85 1554.537

14 193 1553.329 57 192.95 1553.732

15 193.1 1552.525 58 193.05 1552.927

16 193.2 1551.721 59 193.15 1552.123

17 193.3 1550.918 60 193.25 1551.32

18 193.4 1550.116 61 193.35 1550.517

19 193.5 1549.315 62 193.45 1549.716

20 193.6 1548.515 63 193.55 1548.915

21 193.7 1547.716 64 193.65 1548.115

22 193.8 1546.917 65 193.75 1547.316

23 193.9 1546.119 66 193.85 1546.518

24 194 1545.322 67 193.95 1545.721

25 194.1 1544.526 68 194.05 1544.924

26 194.2 1543.731 69 194.15 1544.128

27 194.3 1542.936 70 194.25 1543.333

28 194.4 1542.142 71 194.35 1542.539

29 194.5 1541.35 72 194.45 1541.746

30 194.6 1540.558 73 194.55 1540.953

31 194.7 1539.766 74 194.65 1540.162

Page 30-604 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.19 96-Channel Plan, Wavelength/ChannelId Association (Continued)

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
32 194.8 1538.976 75 194.75 1539.371

33 194.9 1538.186 76 194.85 1538.581

34 195 1537.397 77 194.95 1537.792

35 195.1 1536.609 78 195.05 1537.003

36 195.2 1535.822 79 195.15 1536.216

37 195.3 1535.036 80 195.25 1535.429

38 195.4 1534.25 81 195.35 1534.643

39 195.5 1533.465 82 195.45 1533.858

40 195.6 1532.681 83 195.55 1533.073

41 195.7 1531.898 84 195.65 1532.29

42 195.8 1531.116 85 195.75 1531.507

43 195.9 1530.334 86 195.85 1530.725

44 196 1529.554 87 195.95 1529.944

96 196.1 1528.773 88 196.05 1529.163

Example
ENT-EQPT:CORIANT1:OSM2S-20-1:AM0074:::;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M AM0074 COMPLD
;

Example 2
Provision SSM-2S module to reserve port group #1, #2, #3 for OTN mapping; and port group #3 for EOS mapping.
ENT-EQPT:CORIANT1:SSM2S-20-1:AM0074:::OTN_MAP_GROUP=1&&3,EOS_MAP_GROUP=3;

^^^CORIANT1 02-03-16 02:08:15

M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EQPT::{X}
ED-EQPT::{X}
RTRV-EQPT::{X}

76.MTFP50/30, Rev B January 2018 Page 30-605

14. Enter Commands TL1 Command Reference Manual

ENT-EXDPATH

Command Changes Since Previous Feature Package

• None.

Description
The ENT-EXDPATH command specifies the path by means of a set of excluded path route elements (route
information could be nodes or TLs) that CP should NOT traverse on call establishment or through restorations.

Loose hop has to be L-areaID-nodeID[-IfIndex], strict hop has to be S-areaID-nodeID[-IfIndex] when a routing
element is provided.

Strict setting implies that the route elements specified MUST be excluded; Loose setting implies that the route
elements specified SHOULD be avoided. L and S must be explicitly input.

Figure 14.16 An example of excluded path over multiple domains

E_NNI E_NNI

Domain UA Domain UM Domain UZ

Child Area ID: 0.0.0.20 Child Area ID: 0.0.0.30 Child Area ID: 0.0.0.40
Abs NodeID: 20.10.20.20 Abs NodeID: 20.10.20.30 Abs NodeID: 20.10.20.40

u a
w A E S T U m
u a
k
v
F G D L M Z
x
j
B C N y P V n
y b b

Parent Area ID: 0.0.0.200
Domain UN
Child Area ID: 0.0.0.50
Abs NodeID: 20.10.20.50
In an E2E network as shown in Figure above, the intent is to setup a DR call from Node A to Node Z. The call can
traverse several domains.
There is an option to provide an excluded path when setup a call. By introducing "route exclusion" feature, one more
option is possible, to specify the routes to be excluded for a CP connection setup.

The excluded path route element is in the form of "(S|L)-area-node[-ifindex]". When only "node" specified in the
excluded path, it means to exclude all interfaces of this given node when setup a CP connection. The "area" field
provides the routing context of the node or interface to be excluded. For the routes to be excluded in a specific
domain, the child Area ID should be provided, while to exclude an abstract node, the parent Area ID should be
provided. So the following excluded routes can be specified to align with the use cases above:
1.The excluded routes specified as {S-0.0.0.20-A-u, S-0.0.0.20-G-v, S-0.0.0.30-S-u, S-0.0.0.40-U-m} to exclude
"Au, G-v" in domain UA, "S-u" in domain UM, "U-m" in domain UZ.

Page 30-606 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

2. The excluded routes specified as {S-0.0.0.200-20.10.20.30} to exclude domain UM.

3. The excluded routes specified as {S-0.0.0.30-S-u, S-0.0.0.30-T} to exclude "S-u, T" in domain UM.

Restrictions and Exceptions

• The excluded path can only be supported by TPCP partition.

• The maximum number of excluded paths allowed per NE is 512.

• EXDPATHNAME is a name string that can be inputed optionally, the suggestion is each path should
have clearly denoted name.

• Maximum 36 excluded path route elements are supported per excluded path object, the total characters
added by the excluded path route elements cannot exceed 1692 chars, these limitations apply to
ROUTE parameter.

• S or L is mandatory in every excluded path route element.

• ROUTE is mandatory. The system denies an attempt to enter an excluded path object with empty
excluded path routeElements in ROUTE parameter.

Command Format
ENT-
EXDPATH:[tid]:<EXDP_aid>:ctag:::[EXDPATHNAME=<EXDPathName>],ROUTE=<xrouteElement
s>;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.20 ENT-EXDPATH Parameters

Parameter Value(s) Definition
EXDP_aid EXDPATH-[1,3]-[1-512] EntityID-NPID-PathID

EXDPathNam 0 to 31 alphanumeric characters. Specifies the string name of excluded path.

e Default: "" (empty string)
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-607

14. Enter Commands TL1 Command Reference Manual

Table 14.20 ENT-EXDPATH Parameters (Continued)

Parameter Value(s) Definition
xrouteElement Contains a list of excluded path route Specifies the excluded path route elements that form the
s element that are separated by comma. excluded path in a specific format.
A excluded path route element is
inform of (S|L)-areaID-nodeID[- Maximum 36 excluded path route elements are supported per
IfIndex]. IfIndex is 8 hexadecimal excluded path object.
digits. Maximum 1692 chars are allowed for the total characters added
by the excluded path route elements.

S means the excluded path route element(s) is(are) strict. It

says that the route elements specified MUST be excluded;
L means the excluded path route element(s) is(are) loose. It
says that the route elements specified SHOULD be avoided.
L and S must be explicitly input.

Two forms of excluded path route element:

(S|L)-areaID-nodeID: L-1.1.1.10-123.224.187.198
(S|L)-areaID-nodeID-Ifindex: S-1.1.1.10-123.224.187.198-
040FAA0C

Example
The following example establishes excluded path between two nodes:

ENT-EXDPATH:CORIANT1:EXDPATH-3-1:AM0011:::EXDPATHNAME="WKGXPATH-1",ROUTE="S-
1.1.1.10-111.0.10.0-020FAA01,S-1.1.1.10-111.0.0.110";

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EXDPATH
ED-EXDPATH
RTRV-EXDPATH

Page 30-608 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-EXPPATH

Command Changes Since Previous Feature Package

• None.

Description
The ENT-EXPPATH command specifies the path by means of a set of route elements (route information could be
nodes or TLs) that the Call must traverse.

Loose hop has to be L-node-IfIndex[-Label], strict hop has to be S-nodeId-IfIndex[-Label] when a routing element is
provided. L and S must be explicitly input.

Figure 14.17 Explicit Path Examples

Z Destination Node
Source Node
A

Fully explicit route Partial explicit route

An S hop may be an initial hop in an explicit path if it is the first hop out of the origination node at that hop's OSPF
hierarchical level. The S hop of S-D-1 in explicit path 1 is an example of this case in the following figure.

Figure 14.18 Explicit path with S hop as initial hop

B C

Source
A
node Destination
2 3 2 3 Z node
1 1 4
D 4 E

explicit path 1: S-D-1,S-E-1

76.MTFP50/30, Rev B January 2018 Page 30-609

14. Enter Commands TL1 Command Reference Manual

An S hop may be the first hop specified within a given level's domain if it is the first hop within that level's domain -
that is, it is the hop out of the origination node (or originating abstract node) at that hop's OSPF hierarchical level,
or it is the hop out of the ingress node of that hop's domain (at that hop's hierarchical level). Note: if specifying
ingress hops instead of egress hops, the first hop may in fact be an ingress hop at the far end of the link out of the
origination/ingress node.

In following example, explicit path 2 and explicit path 3 are actually indicating the same path route. The S hop of S-
E-4 in explicit path 2 is the first hop within the intermediate domain while the S hop of S-F-1 in explicit path 3 is the
far end of the same hop.

Figure 14.19 An example of explicit path over multiple domains

explicit path 2: L-D-3,S-E-4,S-F-4 explicit path 3: L-D-3,S-F-1,S-F-4

B 1
1 4
E F 4
A 2 3
3
2 Destination
2 3
Source D node
1 4
node Z
C G H

E_NNI E_NNI

If any hops are provided within a non-originating child area, they must be preceded by an L or S hop in the the parent
area to enter that domain. In the example above, the L hop of L-D-3 is necessary to allow hops to be specified within
the intermediate domain.

Except as noted above, S hops at a given OSPF hierarchical level (within a given domain) must be preceded by an
S or L hop at that same level (that is,, an immediately preceding link at that same level - not just immediately
preceding in the routeElements field). Note, however, that other hops in child areas may appear between these hops
at their given level.

Except as noted above, there is no restriction on what must precede an L hop.

The order of the hops in the EXPPATH is required to be met in any route generated by a call using the EXPPATH.

Restrictions and Exceptions

• The explicit path can only be supported by TPCP partition.

• The maximum number of explicit paths allowed per NE is 512.

• EXPPATHNAME is a name string that can be inputed optionally, the suggestion is each path should
have clearly denoted name.

• Maximum 36 route elements are supported per explicit path object, the total characters added by the
explicit path's route elements cannot exceed 1692 chars, these limitations apply to ROUTE parameter.

• S or L is mandatory in every route element.

Page 30-610 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• For strict hop, both ingress and egress interface could be used.
For loose hop, the ingress interface is used.

• ROUTE is mandatory. The system denies an attempt to enter an explicit path object with empty
routeElements in ROUTE parameter.

• The ODUk/j/flex label is always a multiple of 8 hexadecimal digits.

Command Format
ENT-
EXPPATH:[tid]:<expp_aid>:ctag:::[EXPPATHNAME=<expPathName>],ROUTE=<routeElements
>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.21 ENT-EXPPATH Parameters

Parameter Value(s) Definition
expp_aid EXPPATH-[1,3]-[1-512] EntityID-NPID-PathID

routeElements Contains a list of route element that The route elements form the explicit path in a specific format.
are separated by comma. A route Maximum 36 route elements are supported per explicit path
element is inform of (S|L)-nodeID- object.
IfIndex[-Label] (1)IfIndex is 8 Maximum 1692 chars are allowed for the total characters added
hexadecimal digits. (2)Label is 8 by the explicit path's route elements.
hexadecimal digits for non ODUk
labels or G.709 V2 ODUk labels; Label S means the route element(s) is(are) strict.The path between a
is a multiple of 8 hexadecimal digits for strict route element and its preceding route element MUST
G.709 V3 ODUk/j/flex labels. include only network route elements from the strict route
element and its preceding abstract route element.
L means the route element(s) is(are) loose.The path between a
loose route element and its preceding route element MAY
include other network route elements that are not part of the
strict route element or its preceding abstract route element.
Two forms of route element:
(S|L)-Node-Ifindex: L-123.224.187.198-040FAA0C
S-Node-Ifindex-label: S-123.224.187.198-040FAA0C-000A0000

exppathName 0 to 31 alphanumeric characters. Specifies the string name of explicit path.

Default: "" (empty string) Refer to section 2 for the applicable characters.

Example
The following example establishes explicit path between two nodes.
ENT-EXPPATH:CORIANT1:EXPPATH-3-1:AM0011:::EXPPATHNAME="WorkingPath1",ROUTE="S-
111.0.10.0-020FAA01,S-111.0.0.110-030FBB02";

76.MTFP50/30, Rev B January 2018 Page 30-611

14. Enter Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 08-03-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EXPPATH
ED-EXPPATH
RTRV-EXPPATH

Page 30-612 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-E1

Command Changes Since Previous Feature Package

Description

Command instructs the network element (NE) to enter a E1 (2.048 Mb/s) or 2.048MHz
facility entity providing an External Synchronization reference.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• The facility AID must always correspond to the facility type.

• E1 Line Code, Format, SaBit are only applicable on the 2.048Mbps aid ( E1/E1OUT ).

• tx_ref and loopPrevention are only applicable on the Output Synchronization aid (E1OUT).

• almProfile and qualityLevelOverride are only applicable on the Input Synchronization aid (E1/2MH).

• The qualityLevelOverride is a mandatory parameter when aid is 2MH or the unframed E1. This
parameter does not be Disable for 2MH and unframed E1.

• The tx_ref is a mandatory parameter on the Output Synchronization aid (E1OUT)

• The ENT-E1 on E1/2MH(E1OUT) creates the E1OUT(E1) in the same port simultaneously.

Command Format
ED-
E1:[tid]:E1_aid:ctag:::[,LINECDE=<LineCode>][,FMT=<FrameFormat>][,TXREF=<tx_ref>
][,ALMPF=<almProfile>][,SABIT=<SaBit>][,QLOVERRIDE=<qualityLevelOverride>][,TERM
=<terminationE1>][,CMDMDE=<commandMode>][,LOOPPRVT=<loopPrevention>]:[<editableP
rimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters

Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.22 ENT-E1 Parameters

Parameter Value(s) Definition
E1_aid 2MH-20-[15,23,26]-[1,2] EntityID-ShelfID-SlotID-PortID
E1-20-[15,23,26]-[1,2]
E1OUT-20-[15,23,26]-[1,2]

76.MTFP50/30, Rev B January 2018 Page 30-613

14. Enter Commands TL1 Command Reference Manual

Table 14.22 ENT-E1 Parameters (Continued)

Parameter Value(s) Definition
LineCode AMI Indicates the line code for a E1 facility.
HDB3 Possible values are High Density Bipolar 3 coding (HDB3) or
Default: HDB3 Alternate Mark Inverted(AMI).

FrameFormat NOCRC4 Indicates the digital signal frame format of a E1 facility.

CRC4
UNFRAMED
Default: CRC4

tx_ref NA, Indicates the derived source signal timing the output
SYNC-20-1, synchronization reference. Applicable only to output
OC3-20-[1-16]-[1-32], synchronization references.
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]
Default: SYNC-20-1

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

SaBit 4 Specifies which one of the Sa4 to Sa8 bits, is allocated for
5 Synchronization Status Messages.
6
7
8
Default: 4

qualityLevelOv DISABLED Specifies the synchronization signal quality level that is

erride PRC associated with the specified E1 facility instead of the value
SSU-A received in the synchronization status message within the E1
SSU-B signal. This allows an override of the quality level that was
SEC received within the E1.
DNU When set to DISABLED, the system uses the quality level
Default: DISABLED received in the synchronization status message of the E1.

terminationE1 75 Sets the termination for the E1 facility.

120
Default: 120

loopPrevention DISABLED Specifies the loop prevention function of the entity.

ENABLED Enable: The SSM of output synchronization is forced to DNU
Default: DISABLED when the tx_ref is SYNC-20-1 and the SYNC-20-1 source is the
same input synchronization port
Disable: The SSM of output synchronization follows the tx_ref
and squelch result. It does not consider the status of the tx_ref
entity.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Outof-Service (OOS).
Default: IS

Page 30-614 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.22 ENT-E1 Parameters (Continued)

Parameter Value(s) Definition
tx_sqlch AIS Indicates output synchronization reference when squelch is
DNU applied. Applicable only to output synchronization references.
SQLCH ²AIS : Force AIS in the output synchronization signal
SSM ²DNU: The SSM of the output synchronization set to DNU, this
Default: SSM parameter is only available when the Frame Format is NOCRC4
or CRC4
²SQLCH: Shutdown the output synchronization signal
²SSM: The SSM function shuts down the output synchronization
signal transmission if the tx-ref signal with a quality that is lower
than the configurable threshold.

ql_min PRC Indicates the QL threshold of the derived source signal timing
SSU-A the output synchronization reference when it is SSM squelch
SSU-B mode. Applicable only to output synchronization references.
SEC
DNU
Default: DNU

Example
ENT-E1:CORIANT1:E1-20-23-2:CT0074:::LINECDE=AMI,FMT=NOCRC4,TERM=120:IS;

Possible System Response

^^^CORIANT1 15-03-15 02:08:15

M CT0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-E1
ED-E1
DLT-{x}

76.MTFP50/30, Rev B January 2018 Page 30-615

14. Enter Commands TL1 Command Reference Manual

ENT-FFP-HGE

Command Changes Since Previous Feature Package

• Updated for OSM-5C.

Description
The ENT-FFP-HGE command instructs the network element (NE) to provision a facility protection group for a pair
of HGE (100GE) facilities.

The following HGE FFP is allowed in an mTera UTP:

• Y-Cable, using any OSM-2C modules in an mTera shelf.

This command is not applicable to OSM-5C which does not support Y-cable.

Restrictions and Exceptions

• The FFP is denied if
- Two port facilities are not the same type.
- Either of the specified port facilities has PROT = YES
- Either of the specified port facilities has NENDALS = YES
- Firmware status is not in current status.

• Y-cable provisioning is denied if either of the HGE facilities is supported by an LR10-2km CFP.

• Y-cable provisioning is denied if either of the HGE facilities is supported by an SR10 CFP.

• Creation of FFP protection group (Y-Cable) on client facility is denied if there is ODUk TL provisioned
on the mapped ODUk facilities.

• Y-cable provisionig applicable only for OSM-2C, the valid PortID of the AID is between [1-2]. If PortID
of [3-5] is entered, the command is denied.

Command Format
ENT-FFP-
HGE:[tid]:<protectedId>,<protectingId>:ctag:::[,SCHEME=<scheme>][,HOLDOFFPROT=<H
oldOffProt>][,RVRTV=<rvrtv>][,WTR=<wtr>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.23 ENT-FFP-HGE Parameters

Parameter Value(s) Definition
protectedId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

protectingId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

Page 30-616 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.23 ENT-FFP-HGE Parameters (Continued)

Parameter Value(s) Definition
scheme YCABLE Specifies the protection scheme.
Default: YCABLE - YCABLE

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive
Default: NO - NO: not revertive.

wtr [300-3600] Wait To Restore. Valid values: 300-3600 seconds. After

Default: 300 seconds expiration of the timer, the working line is restored and a no
request state is transmitted.

Example
ENT-FFP-HGE:CORIANT1:HGE-20-6-1,HGE-20-11-1:CTAG-1:::SCHEME=YCABLE;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG-1 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-FFP-HGE
RTRV-FFP-HGE

76.MTFP50/30, Rev B January 2018 Page 30-617

14. Enter Commands TL1 Command Reference Manual

ENT-FFP-OCn{3,12,48,192}

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The ENT-FFP-OCn command instructs the network element (NE) to provision a facility protection group for a pair
of OCn facilities.

Y-Cable is supported for OC192 client using any OSM-2S or OSM-4S modules in an mTera shelf.

OC3/12/48/192 1+1 APS(LAPS) FFP between two physical port interfaces over the whole mTera shelf including on
any two SSM-2S modules or on the single SSM-2S module.

Refer to ENT-CRS-STS command for examples on how to provision OCn FFP and do appropriate cross-
connections for unprotected/protected circuits.

Restrictions and Exceptions

• This command is supported when the supporting module is a OSM-2S for Y-Cable protection, or when
the supporting module is a SSM-2S for OC3/12/48/192 1+1 APS FFP protection.

• On an SSM-2S supporting 1+1 APS FFP, the STS sub-facilities under the OCn must not be involved in
cross-connection, otherwise creation of the FFP is denied.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• The FFP is denied if one or both facilities are owned by control plane.

• HoldOffProt is applicable when scheme=Y-Cable or 1+1 APS FFP.

• An attempt to provision a Y-cable FFP for the client port facilities associated only with a 1WAY ODU
cross-connection from the client ODU to the ODU multiplexed into an OTU is denied.

• The Y-Cable FFP is denied if

- One of the two facilities is already part of a protection group.
- Two port facilities are not the same type.
- Either of the specified port facilities has PROT = YES
- Firmware status is not in current status.

• Creation of FFP protection group (Y-Cable) on client facility is denied if there is ODUk TL provisioned
on the mapped ODUk facilities.

• This command not apply for the OCn facility associated with virtual port 99 on SSM-2S, instead use
ENT/ED-EPG commands on SSM-2S for the Equipment Protection Group provision or edit when the
adaption point protection is needed in the application of SONET to OTN bridge.

Command Format
ENT-FFP-
OCn:[tid]:<protectedId>,<protectingId>:ctag:::[,SCHEME=<scheme>][,HOLDOFFPROT=<H
oldOffProt>][,RVRTV=<rvrtv>][,WTR=<wtr>];

Proper System Response

<header>

Page 30-618 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.24 ENT-FFP-OCn{3,12,48,192,768} Parameters

Parameter Value(s) Definition
protectedId OC12-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID
OC192-20-[1-16]-[1-40]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]

protectingId OC12-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID

OC192-20-[1-16]-[1-40]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]

scheme 1P1 Specifies the protection scheme. YCABLE is supported for

YCABLE OSM-2S, 1+1 APS is supported for SSM-2S.
- 1P1 (default for SSM-2S)
- YCABLE (default for OSM-2S)

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive.
Default: NO - NO: not revertive

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
Default: 300 switch’s back immediately. After expiration of the timer, the
working line is restored and a no request state is transmitted.

300-3600 seconds for Y-CABLE scheme.

Example
ENT-FFP-OC192:CORIANT1:OC192-20-3-1,OC192-20-14-1:CTAG-
1:::SCHEME=YCABLE,RVRTV=NO;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-FFP-OCn
ED-FFP-OCn
RTRV-FFP-OCn

76.MTFP50/30, Rev B January 2018 Page 30-619

14. Enter Commands TL1 Command Reference Manual

ENT-FFP-STMn (STM1/STM4/STM16/STM64)

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The ENT-FFP-STMn command instructs the network element (NE) to provision a facility protection group for a pair
of STMn facilities.

Y-Cable is supported for STM64 clients using a single OSM-2S/OSM-4S, or any two OSM-2S or two OSM-4S over
the whole mTera shelf.

STM1/4/16/64 1+1 MSP FFP using a single SSM-2S, or any two SSM-2S over the whole mTera shelf.

Restrictions and Exceptions

• This command is only supported when the supporting module is an SSM-2S/OSM-2S/OSM-4S.

• Neither of the facilities associated with the protection group nor the protection scheme can be modified.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• For Sonet NE module in case of 1+1 MSP FFP, the STSn sub-facilities under the STMn must not be
involved in cross-connection, otherwise creation of the FFP is denied.

• The FFP is denied if one or both facilities are owned by control plane (that is, NPOWNER = 2 or 3)

• Only one TL can be associated with a 1+1 (1P1) FFP. The attempt to create a 1P1 FFP where both
STMn are associated with a TL is denied.

• HoldOffProt is applicable when scheme=Y-Cable only.

• Parameter HoldOffProt apply when scheme=Y-Cable for OSM modules.

• Parameter HoldOffProt apply also for SSM-2S 1+1 MSP FFP protection.

• An attempt to provision a Y-cable FFP for the client port facilities associated only with a 1WAY ODU
cross-connection from the client ODU to the ODU multiplexed into an OTU is denied.

• The Y-Cable FFP is denied if

- One of the two facilities is already part of a protection group.
- Two port facilities are not the same type.
- Either of the specified port facilities has PROT = YES
- Firmware status is not in current status.

• Any FFP provisioning on the facilities that mapped on ODUk/j TLs is denied, if the TLs to be configured
with protection (for example, ODUk/j TL as the members of SYMPROT BL).

• This command not apply for the STMn facility associated with virtual port 99 on SSM-2S, instead use
ENT/ED-EPG commands on SSM-2S for the Equipment Protection Group provision or edit when the
adaption point protection is needed in the application of SDH to OTN bridge.

Command Format
ENT-FFP-
STMn:[tid]:<protectedId>,<protectingId>:ctag:::[,SCHEME=<scheme>][,HOLDOFFPROT=<
HoldOffProt>][,RVRTV=<rvrtv>][,WTR=<wtr>];

Page 30-620 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.25 ENT-FFP-STMn (STM1/STM4/STM16/STM64/STM256) Parameters

Parameter Value(s) Definition
protectedId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID
STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

protectingId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID

STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

scheme 1P1 Specifies the protection scheme. YCABLE is supported for

YCABLE OSM-2S, 1+1 APS is supported for SSM-2S.
- 1P1 (default for SSM-2S)
- YCABLE (default for OSM-2S)

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive.
Default: NO - NO: not revertive

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
Default: 300 switch’s back immediately. After expiration of the timer, the
working line is restored and a no request state is transmitted.

300-3600 seconds for Y-CABLE scheme.

Example
ENT-FFP-STM64:CORIANT1:STM64-20-3-1,STM64-20-14-1:CTAG-
1:::SCHEME=YCABLE,RVRTV=NO;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-621

14. Enter Commands TL1 Command Reference Manual

Related Commands
DLT-FFP-STMn
ED-FFP-STMn
RTRV-FFP-STMn

Page 30-622 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-FFP-TGLAN

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The ENT-FFP-TGLAN command instructs the network element (NE) to provision a facility protection group for a pair
of TGLAN facilities.

The following TGLAN FFP is allowed in an 7100 mTera UTP:

• Y-Cable is supported for TGLAN client using any OSM-2S modules in an mTera shelf.

• Y-Cable is supported for TGLAN client using any OSM-4S modules in an mTera shelf.

Restrictions and Exceptions

• The FFP is denied if
- One of the port side facilities is already in a Y-Cable protection switch
- Two port facilities are not same type.
- Either of the specified port facilities has PROT = YES
- Either of the specified port facilities has NENDALS = YES
- Firmware status is not in current status.

• An attempt to provision a Y-cable FFP for the client port facilities associated only with a 1WAY ODU
cross-connection from the client ODU to the ODU multiplexed into an OTU is denied.

• Creation of FFP protection group (Y-Cable) on client facility is denied if there is ODUk TL provisioned
on the mapped ODUk facilities.

Command Format
ENT-FFP-
TGLAN:[tid]:<protectedId>,<protectingId>:ctag:::[,SCHEME=<scheme>][,HOLDOFFPROT=
<HoldOffProt>][,RVRTV=<rvrtv>][,WTR=<wtr>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.26 ENT-FFP-TGLAN Parameters

Parameter Value(s) Definition
protectedId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

protectingId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

scheme YCABLE Specifies the protection scheme. YCABLE is the default value.
Default: YCABLE

76.MTFP50/30, Rev B January 2018 Page 30-623

14. Enter Commands TL1 Command Reference Manual

Table 14.26 ENT-FFP-TGLAN Parameters (Continued)

Parameter Value(s) Definition
HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive.
Default: NO - NO: not revertive.

wtr [300-3600] Wait To Restore. Valid values: 300-3600 seconds. After

Default: 300 expiration of the timer, the working line is restored and a no
request state is transmitted.

Example
ENT-FFP-TGLAN:CORIANT1:TGLAN-20-6-1,TGLAN-20-11-1:CTAG-1:::SCHEME=YCABLE,
RVRTV=NO;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-FFP-TGLAN
RTRV-FFP-TGLAN
ED-FFP-TGLAN

Page 30-624 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-FGE

Command Changes Since Previous Feature Package

• None.

Description
The ENT-FGE command instruct the network element (NE) to provision a FGE (40 Gbps Ethernet) facility entity.

Before the facility can be provisioned, the module that supports this facility should be already provisioned.

The FGE facility can be provisioned on the following modules:

• OSM-2C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• NENDALS can only be set to YES if PROT=YES for the facility.

Command Format
ENT-
FGE:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PROT=<protection>][,NENDALS=<N
endALS>][:<editablePrimaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.27 ENT-FGE Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

76.MTFP50/30, Rev B January 2018 Page 30-625

14. Enter Commands TL1 Command Reference Manual

Table 14.27 ENT-FGE Parameters (Continued)

Parameter Value(s) Definition
protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.
Default: NO
Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending an maintenance
signal when there is a signal failure detected on the line side of a
transponder.

Setting the value to NO does not shut down the laser. When this
value is set standard maintenance signaling is used.

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOSYNC).
Default: NO Note: This parameter does not be used (for example, default to
NO) for 1-WAY Line-to-Port Connection.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

Example
ENT-FGE:CORIANT1:FGE-20-2-1:MYCTAGE::::IS;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-FGE
DLT-{X}
RTRV-{X}

Page 30-626 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-FIBR-EQPT

Command Changes Since Previous Feature Package

• Updated for CD4D8.

• Added support for OSM-4S.

Description
The ENT-FIBR-EQPT command instructs the network element (NE) to provision the non-ribbon fiber connection(s)
for:
• Equipment connection from OMD/CDCP/CD4D8 add/drop ports to line interfaces of port modules.

• Equipment connection from OADMRS9 Aux ports to OMD/CD4D8 DWDM ports.

• Equipment connections between OADMRS9 Express ports.

• Each port on the module is only associated with one fiber connection entity.

The ENT-FIBR-EQPT command instructs the network element (NE) to provision the ribbon fiber connection(s) for:
• Equipment Ribbon fiber connection from OADMRS MPO ports to fiber shuffle MPO ports.

• Equipment Ribbon fiber connection from fiber shuffle MPO ports to CDCP MPO ports.

Provisioning the following fiber connection does not need to specify 'toport':

This command allows to define physical connection between a transponder and the Patch panel port number of a
channel multiplexer module. This information can be used by customer in their work orders, when they pre-provision
the transponders in the NE: information would be used by field technician to correctly wire the transponder to the
appropriate port of a channel multiplexer. In addition, it can be used at the Network Operation Center (NOC) to keep
information on how the transponders that are not in-service are connected to the channel multiplexers.

Note 1: This command is not required to describe facility connection from an

Add/Drop port of an OMD or CDCP module to an Alien (not managed by
the NE) transponder. User must provision an OCH facility on OMD/
CDCP Add/drop port (using ENT-OCH cmmand) and must use the ENT-
CRS-OCH command by specifying the OCH AID instead.

76.MTFP50/30, Rev B January 2018 Page 30-627

14. Enter Commands TL1 Command Reference Manual

Figure 14.20 Provisioning Ribbon FIBR Connection in mTera UTP NE.

OADMRS-20

on OCC
CDC8D-6
mTera Shelf

Ribbon FIBR Connection

Ribbon FIBR Connection

Column 21
Fiber Shuffle Column 1

Provision Ribbon FIBR connections between OADMRS-20 and Fiber Shuffle,

and between CDCP and Fiber Shuffle:

ENT-FIBR-EQPT:TID:OADMRS-2-1,FSM-2-34:
ctag:::FROMRBPORT=V,TORBPORT=1V;

ENT-FIBR-EQPT:TID:FSM-2-34,CDCP-2-16-1:
ctag:::FROMRBPORT=21V,TORBPORT=V;

Restrictions and Exceptions

• This command is required to define physical connection before provisioning a OCH-L to OCH-P/OCH-
OS, OCH-L to OCH or OCH-L to OCH-L cross-connection over this physical connection.

• This command is denied for a transponder when the supported OCH-P/OCH-OS has EXTCHAN is not
NA.

• The command is denied, if the give wavelength is owned by control plane.

• An OCH-P/OCH-OS entity must exist before a fiber connection can be created to a transponder.

• FROMRBPORT/TORBPORT are used for Ribbon fiber provisioning only.

• FROMPORT/TOPORT are used for non-ribbon fiber provisioning only.

• The NE only allows the ribbon fiber connection between OADMRS MPO and fiber shuffle MPO with
same MPO name, V to V, W to W, X to X, Y to Y or Z to Z.

• The NE only allows the ribbon fiber connection between CDCP MPO and fiber shuffle MPO with same
MPO name, V to V, W to W.

• The attempt to provision OADMRS MPO fiber connection with main fiber shuffle MPO is denied if any
other MPO of the OADMRS is connecting with different column MPO of the fiber shuffle.

• The attempt to provision OADMRS MPO fiber connection with a column MPO of main fiber shuffle is
denied if any other module is connecting with any MPO of same column.

Page 30-628 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• The attempt to provision CDC8D-6 MPO fiber connection with a column MPO of main fiber shuffle is
denied if any OADMRS is connecting with a column MPO of the fiber shuffle with larger column number.

• If there already is a ribbon fiber connection associated with an MPO, provisioning fiber connection on
the MPO is denied.

• The attempt to provision fiber connection between two different MPO ports of one module is denied.

• If an OCH entity exists on an add/drop port of CDC8D-6, an attempt to provision a fiber connection on
the port is denied.

• If an OCH entity exists on an add/drop port of OMD, an attempt to provision a fiber connection on the
port is denied.

• If a fiber connection i salready associated with an interface, an attempt to provision another fiber
connection on the interface is denied.

• An attempt to provision a fiber connection on the add/drop port of the OMD is denied if a fiber entity on
the DWDM port of an OMD does not exist.

• The attempt to provision fiber entity from CDC8D-6 to line port of port module is denied if the line port
is not able to support coherent signal.

• The attempt to provision fiber entity from CDC8D-6 to line port of port module is denied if the line port
is equipped with pluggable not supporting coherent signal.

• The system denies an attempt to create a FIBR association between an add/drop port on the CDC8D-
6 and an OCH-P supported by an 81.71T-CDWDMS-R6 T-CFP.

Refer to the tables below for corresponding patch panel add/drop port number and wavelength number, depending
on Channel plan.

Table 14.28 Patch Panel Port Numbers For 88 Channel Plan

Channels 1-44 Channels 45-88

Frequency Wavelength Frequency Wavelength

Channel ID (THz) (nm) Channel ID (THz) (nm)
1 191.7 1563.863 45 191.75 1563.455

2 191.8 1563.047 46 191.85 1562.64

3 191.9 1562.233 47 191.95 1561.826

4 192 1561.419 48 192.05 1561.013

5 192.1 1560.606 49 192.15 1560.2

6 192.2 1559.794 50 192.25 1559.389

7 192.3 1558.983 51 192.35 1558.578

8 192.4 1558.173 52 192.45 1557.768

9 192.5 1557.364 53 192.55 1556.959

10 192.6 1556.555 54 192.65 1556.151

11 192.7 1555.747 55 192.75 1555.344

12 192.8 1554.94 56 192.85 1554.537

13 192.9 1554.134 57 192.95 1553.732

76.MTFP50/30, Rev B January 2018 Page 30-629

14. Enter Commands TL1 Command Reference Manual

Table 14.28 Patch Panel Port Numbers For 88 Channel Plan (Continued)
Channels 1-44 Channels 45-88

Frequency Wavelength Frequency Wavelength

Channel ID (THz) (nm) Channel ID (THz) (nm)
14 193 1553.329 58 193.05 1552.927

15 193.1 1552.525 59 193.15 1552.123

16 193.2 1551.721 60 193.25 1551.32

17 193.3 1550.918 61 193.35 1550.517

18 193.4 1550.116 62 193.45 1549.716

19 193.5 1549.315 63 193.55 1548.915

20 193.6 1548.515 64 193.65 1548.115

21 193.7 1547.716 65 193.75 1547.316

22 193.8 1546.917 66 193.85 1546.518

23 193.9 1546.119 67 193.95 1545.721

24 194 1545.322 68 194.05 1544.924

25 194.1 1544.526 69 194.15 1544.128

26 194.2 1543.731 70 194.25 1543.333

27 194.3 1542.936 71 194.35 1542.539

28 194.4 1542.142 72 194.45 1541.746

29 194.5 1541.35 73 194.55 1540.953

30 194.6 1540.558 74 194.65 1540.162

31 194.7 1539.766 75 194.75 1539.371

32 194.8 1538.976 76 194.85 1538.581

33 194.9 1538.186 77 194.95 1537.792

34 195 1537.397 78 195.05 1537.003

35 195.1 1536.609 79 195.15 1536.216

36 195.2 1535.822 80 195.25 1535.429

37 195.3 1535.036 81 195.35 1534.643

38 195.4 1534.25 82 195.45 1533.858

39 195.5 1533.465 83 195.55 1533.073

40 195.6 1532.681 84 195.65 1532.29

41 195.7 1531.898 85 195.75 1531.507

42 195.8 1531.116 86 195.85 1530.725

43 195.9 1530.334 87 195.95 1529.944

44 196 1529.554 88 196.05 1529.163

Page 30-630 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Command Format
ENT-FIBR-EQPT:[tid]:<from_aid>,<to_aid>:ctag:::[FROMPORT=<fromPort>]
[,TOPORT=<toPort>][,FROMRBPORT=<fromRibbonPort>][,TORBPORT=<toRibbonPort>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.29 ENT-FIBR-EQPT Parameters

Parameter Value(s) Definition
from_aid CD4D8-[50-58]-[2-4,6-8] EntityID-ShelfID-SlotID-SubslotID
CDCP-20-[10-16,1-7]-[1-3]
FSM-20-[35,34]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OMD-20-[1-16]-[1-2]

to_aid CD4D8-[50-58]-[2-4,6-8] EntityID-ShelfID-SlotID-SubslotID

CDCP-20-[10-16,1-7]-[1-3]
FSM-20-[35,34]
OADMRS9-20-[1-16]
OMD-20-[1-16]-[1-2]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]

fromPort Possible values are: (1) 9 to 14 when Specifies the "FROM" Aux port on an OADMRS9.
"from_aid" is CDCP (2) 3 to 11 when or
"from_aid" is OADMRS9 (3) 19135 to Specifiies the "FROM" Express port on an OADMRS9.
19610 in increments of 5 when or
"from_aid" is an OMD48. (4) 3 to 6, 9 Specifies the "FROM" add/drop port number on an OMD/CDCP/
to 12 when "from_aid" is a CD4D8. CD4D8.

toPort Possible values are: (1) 1 to 2 when Specifies the "TO" port module.
the "to_aid" is OSM2C. (2) 1 to 20
when the "to_aid" is OSM2S. (3) 1 to 4
when the "to_aid" is OSM4C (4) 1 to 2
when the "to_aid" is OSM4F (5) 3 to
11 when the "to_aid" is OADMRS9 (6)
1,2,7,8 when the "to_aid" is CD4D8 (7)
1 to 40 when the "to_aid" is OSM4S.

fromRibbonPo Possible values are: Specifies the "FROM" Ribbon Fiber MPO port name/number on
rt (1)"columnNumber""MPOName", an FSM.
columnNumber=1 to 21, or
MPOName=V, W, X, Y, Z, when Specifies the "FROM" Ribbon Fiber MPO port name on an
"from_aid" is FSM and "to_aid" is OADMRS.
CDCP. (2) V to Z when "from_aid" is
OADMRS and "to_aid" is FSM.

76.MTFP50/30, Rev B January 2018 Page 30-631

14. Enter Commands TL1 Command Reference Manual

Table 14.29 ENT-FIBR-EQPT Parameters (Continued)

Parameter Value(s) Definition
toRibbonPort Possible values are: (1) Specifies the "TO" Ribbon Fiber MPO port name/number on an
"columnNumber""MPOName", FSM.
columnNumber=1 to 21, or
MPOName=V, W, X, Y, Z, if to_aid is Specifies the "TO" Ribbon Fiber MPO port name on an CDCP.
FSM. (2) V, W if to_aid is CDCP.

Example
ENT-FIBR-EQPT:MTERA:OADMRS-20-1,FSM-20-34:CTAG-1:::FROMRBPORT=V,TORBPORT=1V;

Possible System Response

^^^MTERA 14-11-15 02:08:15

M CTAG-1 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-FIBR-EQPT
DLT-FIBR-EQPT

Page 30-632 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-FTPSERVER

Command Changes Since Previous Feature Package

• None.

Description
The ENT-FTPSERVER command instructs the network element (NE) to set up FTP server for PM file transfer
purpose in binary format. This command is required in order to allow automatic transfer of historical STSn or ODUk
PM data from NE to an external FTPSERVER.

Restrictions and Exceptions

• Only Historical PM file transfer in binary format for STS or ODU montypes (for example, Path PM) is
supported

• urlPath must be enclosed in double quotes.

• The parameter pwd is optional for configuring SFTP server that is,, when portid = 22. However, it is
mandatory when configuring FTP server.

Command Format
ENT-
FTPSERVER:[tid]:[<ftpserver_aid>]:ctag::<userid>,[<pwd>],<ipaddress>,<portid>,<u
rlPath>;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.30 ENT-FTPSERVER Parameters

Parameter Value(s) Definition
ftpserver_aid FTPSERVER-1 EntityID-FTPSERVERID

userid A string consisting of 6 to 32 Specifies a valid user identification on the FTP server.
characters.
Note that the following characters are not allowed for <userid>:
@?/\{[()]}

pwd A string consisting of 6 to 32 Specifies the corresponding password for the valid <userid> on
characters. the FTP server.

Note that the following characters are not allowed for <pwd>: @
?/\{[()]}
The password is displayed as "*".

76.MTFP50/30, Rev B January 2018 Page 30-633

14. Enter Commands TL1 Command Reference Manual

Table 14.30 ENT-FTPSERVER Parameters (Continued)

Parameter Value(s) Definition
ipaddress Format for the IP address is: A double Specifies the IP address of the FTP server.
quoted string representing the IPv4
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

portid 21,22 Specifies the logical port number associated with the FTP server
Default: 22 IP address.

- 21 for non-secure FTP file transfer.

- 22 for secure FTP (SFTP) file transfer.

urlPath Possible values are: xxx/yyy/zzz Specifies the device/drive/directory to put the file on FTP server.
Note: The value must be entered between quotes ("").

Example
ENT-FTPSERVER:CORIANT1:FTPSERVER-1:CTAG::user1,*,"172.111.21.4",21,"/dir2/";

Possible System Response

^^^CORIANT1 06-06-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-FTPSERVER
ED-FTPSERVER
DLT-FTPSERVER

Page 30-634 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-GBEP

Command Changes Since Previous Feature Package

• None.

Description
The ENT-GBEP command instruct the network element (NE) to provision a Gigabit Ethernet facility entity.

Before the facility can be provisioned, the transponder module that supports this facility should be already
provisioned.

The GBEP facility can be provisioned on the following transponders:

• OSM-1S

On the OSM-1S GBEP represents a Gigabit Ethernet facility (1.25 Gb/s) that is mapped to an ODU0 using
TTT+GMP.

If a GBEP and an ODUk are on the same physical port on one OSM-1S, the mapping relationship is created directly
between GBEP and the ODUk.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• NENDALS can only be set to YES if PROT=YES for the facility.

• GBEP on OSM-1S is mapped to the ODU0 rather than SONET VCAT. There are no supporting STSn
timeslots.

• An attempt to enter a GBEP on the OSM-1S is denied if an ODUF or ODU entity is provisioned on the
same port.

• On an OSM-1S, an attempt to enter a GBEP is denied if an ODUk with TribID specified is entered for
the same physical port.

• On an OSM-1S, after the command provisioning with setting NENDALS=YES, then electrical SFP
inserted, the module reports MEA on the pluggable module.

• On an OSM-1S, when electrical SFP inserted, the module denies the command provisioning with
NENDALS=YES on the associated facility.

• For OSM-1S, if an ETH entity exists on any port 1 through 16, then the system denies an attempt to
create any facilities other than OTU1 on ports 1 through 16. If an ETH entity exists on any port 17
through 32, then the system denies an attempt to create any facilities other than OTU1 on ports 17
through 32.

• For OSM-1S, if an ODU1 or ODU0 entity exists on port 1 through 16 with SWITCHTYPE=PKT, then the
system denies an attempt to create any facilities other than OTU1 on ports 1 through 16. If an ODU1 or
ODU0 entity exists on any port 17 through 32 with SWITCHTYPE=PKT, then the system denies an
attempt to create any facilities other than OTU1 on ports 17 through 32.

76.MTFP50/30, Rev B January 2018 Page 30-635

14. Enter Commands TL1 Command Reference Manual

Command Format
ENT-
GBEP:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PROT=<protection>][,NENDALS=<
NendALS>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Applicable Parameters When Entering the Command

Table 14.31 Parameters Applicability When Entering the Command

Supporting
a b
PARAMETER DEF Req Transponder
ALMPF ND O All

PROT ND O OSM1Sc

NENDALS ND O OSM1Sc

editablePrimaryState PD O All

a. ND: Name Defined or PD: Position Defined.

b. O indicates an OPTIONAL parameter for the specified module.
c. Not appliable when electrical SFP inserted.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.32 ENT-GBEP Parameters

Parameter Value(s) Definition
fac_aid GBEP-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.
Default: NO
Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending a maintenance
signal (for example, AIS or LF depending on the type of facility
provisioned) when there is a signal failure detected on the line
side of a transponder.

Setting the value to NO does not shut down the laser on the port
side of the transponder. When this value is set standard
maintenance signaling is used.

Page 30-636 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.32 ENT-GBEP Parameters (Continued)

Parameter Value(s) Definition
NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOF/LOSYNC).
Default: NO
Note: This parameter does not be used (for example, default to
NO) for 1-WAY Line-to-Port Connection.

NENDALS can only be set to YES if PROT=YES for the facility.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

ENT-GBEP:CORIANT1:GBEP-2-13-1:AM0074:::ALMPF=99,VCAT=STS3C
,PROT=NO,NENDALS=NO,ADDCRSMAP=1&4&7&10&13&16&19:IS;

Example: Provisioning GBEP Transparent Facility on OSM-1S

ENT-GBEP:CORIANT1:GBEP-20-4-10:AM0074:::ALMPF=99,PROT=YES:IS;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ED-{X}
RTRV-{X}

76.MTFP50/30, Rev B January 2018 Page 30-637

14. Enter Commands TL1 Command Reference Manual

ENT-GCC

Command Changes Since Previous Feature Package

• Added support for GCC of ODUk of an ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

• Update for ZTC proxy over GCC links.

Description
The ENT-GCC command instructs the network element (NE) to establish a GCC communication channel entity.

A GCC entity can be created on the OTN entities in the following table:

Table 14.33 GCC Supported by Entities of Port Modules

Facilities
OTUC2a

ODU2eb

OCH-Pa
ODUFb
b

ODU2b

ODU3b

ODU4b
OTU1a

OTU4a

--> OTUC2

ODU0

ODU1
OTU2

Modules

OSM-1S X X X

OSM-2S X X X X X X X

OSM-2C X X X X X X X X

OSM-4C X X X X X X X

OSM-4F X X X X X X X X

OSM-4S X X X X X X X

OSM-5C X X X X X X X X
a. Support GCC0
b. Support GCC1, GCC2 and GCC12

Restrictions and Exceptions

• The command is rejected if the port module does not exist.

• The command is rejected if the NE or shelf or port module on which the GCC is located has reached its
limitations of its GCC number.

• Deny GCC provisioning if the associated OTN facility has not yet been provisioned.

• The command is rejected if the associated OTN facility does not support GCC.

• The command is denied if the related OTN entity does not support the type of GCC.

• If GCC1 or GCC2 exists on the OTN entity, creating a GCC12 on the same OTN entity is denied.

• If GCC12 exists on the OTN facility, creating a GCC1 or GCC2 entity on the same OTN entity is denied.

Page 30-638 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Command Format
ENT-
GCC:[tid]:<GCC_aid>:ctag:::[PPPPF=<ppppf_aid>][,ALMPF=<almProfile>][,ZTCPROXY=<p
roxy_state>]:[<EditablePrimaryState>];

Proper System Response

The completed response indicates that a GCC entity has been established.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.34 ENT-GCC Parameters

Parameter Value(s) Definition
ppppf_aid PPPPF-[99,1-10] Specifies the access identifier of the PPP protocol profile.

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

proxy_state ENABLED Specifies the ZTC proxy state of the interface.

DISABLED When the ZTC proxy state is ENABLED, the NE can be the ZTC
Default: DISABLED proxy of the ZTC DUC attached to the port.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

76.MTFP50/30, Rev B January 2018 Page 30-639

14. Enter Commands TL1 Command Reference Manual

Table 14.34 ENT-GCC Parameters (Continued)

Parameter Value(s) Definition
gcc_aid GCC0-20-[1-16]-[1-32], GCC0-ShelfID-SlotID-PortID
GCC1-20-[1-16]-[1-20], GCC1-ShelfID-SlotID-PortID-{Supporting ODUtype}{Supporting
GCC1-20-[1-16]-[1-4]-[B,C][1-80]- ODU Tributary Port}-{ODUtype}{ODUTribPort}
[A,B,E,Z,F][1-32], GCC1-ShelfID-SlotID-PortID-{Supporting ODU4}{Supporting
GCC1-20-[1-16]-[1-20]- ODU4 TributaryPort}-{Supporting ODUtype}{Supporting ODU
[A,B,C,D,E,Z,F][1-80], Tributary Port}-{ODUtype}{ODUTribPort}
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32], Note:
GCC1-20-[1-16]-[1-2]-[D][1-3]- 1. for GCC created on an ODU associated with a client port, the
[A,B,C,E,Z,F][1-80], ODUTribPort is not used
GCC2-20-[1-16]-[1-20], 2. Supporting ODUtype and Supporting ODU Tributary Port are
GCC2-20-[1-16]-[1-4]-[B,C][1-80]- only used for 2-stage ODU multiplexing.
[A,B,E,Z,F][1-32], 3. GCC2 and GCC12 have same format values as GCC1.
GCC2-20-[1-16]-[1-20]- 4. Supporting ODU4 and Supporting ODU4 Tributary Port are
[A,B,C,D,E,Z,F][1-80], only applicable when LO ODU is multiplexed into ODU4 within
GCC2-20-[1-16]-[1-2]-[D][1-3]-[B,C][1- the ODUC2 (when the modulation format of the port on OSM-4F
80]-[A,B,E,Z,F][1-32], is configured to 200G16QAM).
GCC2-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC12-20-[1-16]-[1-20],
GCC12-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]

Example
ENT-GCC:NE01:GCC0-20-2-1:AM0011:::PPPPF=PPPPF-1;

Possible System Response

^^^NEO1 11-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-GCC
DLT-GCC
RTRV-GCC

Page 30-640 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-HGE

Command Changes Since Previous Feature Package

• None.

• Added support for OSM-5C.

Description
The ENT-HGE command instruct the network element (NE) to provision a HGE (100 Gbps Ethernet) facility entity.

Before the facility can be provisioned, the transponder module that supports this facility should be already
provisioned.

The HGE facility can be provisioned on the following transponders:

• OSM-2C, OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• NENDALS can only be set to YES if PROT=YES for the facility.

• If an ODU exists for the port with OPUCONFIG=INTACT or MUX, then the sytem denies an attempt to
enter a facility on the same port.

Command Format
ENT-
HGE:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PROT=<protection>][,MAP=<MAP>]
[,NENDALS=<NendALS>][:<editablePrimaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.35 ENT-HGE Parameters

Parameter Value(s) Definition
fac_aid HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

76.MTFP50/30, Rev B January 2018 Page 30-641

14. Enter Commands TL1 Command Reference Manual

Table 14.35 ENT-HGE Parameters (Continued)

Parameter Value(s) Definition
protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.
Default: NO
Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending an maintenance
signal when there is a signal failure detected on the line side of a
transponder.

Setting the value to NO does not shut down the laser on the line
or port side of the transponder. When this value is set standard
maintenance signaling is used..

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOSYNC).
Default: NO Note: This parameter does not be used (for example, default to
NO) for 1-WAY Line-to-Port Connection.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

map GMP Specifies the Transparent mapping variance of the HGE facility
GFP-F on OSM-2C, OSM-5C.
Default: GMP GMP: Per section 17.7.5 of ITU-T G.709, HGE is GMP mapped
to ODU4 with PSI=0x07. Preamble and IPG transported.
GFP-F: Per section 17.4 of ITU-T G.709, HGE is GFP-mapped
frames to ODU4 with PSI=0x05. Neither Preamble nor IPG
transported.

Example
ENT-HGE:CORIANT1:HGE-20-2-1:MYCTAGE::::IS;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-HGE
DLT-{X}
RTRV-{X}

Page 30-642 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-IPPG

Command Changes Since Previous Feature Package

• None.

Description
The ENT-IPPG command instructs the mTera Universal Transport Platform NE to provision a IP protection group
on NP-1.

The single IP address can be assigned to the IP protection group by provisioning TL with the IPPG entity as the
resource of the TL and the IP address is protected between the members of the IPPG.

The SEIM port can be the member of the IPPG, which is provisioned by the ENT-MGTETH command.

Restrictions and Exceptions

• Only DCN MGTETH entities (that is,, MGTETH-20-21-8 and MGTETH-20-28-8) can be added as the
members of an IPPG.

• The command is denied if there is TL created on the specified IPPG members.

• The command is denied if any of the MGTETH entities in the IPPGMEM does not exist.

Command Format
ENT-
IPPG:[tid]:<ippg_aid>:ctag:::IPPGMEM=<Member>[,IPPGNAME=<IppgName>][:<editablePr
imaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.36 ENT-IPPG Parameters

Parameter Value(s) Definition
ippg_aid IPPG-1 EntityID-IPPGID

Member A list of two MGTETH entities. The Specifies the two members of IPPG.
members is separated by a symbol This parameter uses the grouping operator "&" for multiple
"&". A member is specified by the AID members.
of MGTETH entity. For example,
IPPGMEM=MGTETH-20-21-8&MGTETH-20-28-8

IppgName A double quoted string consisting of 0 Specifies the IPPG name.

to 30 printable characters, not
including the quotes. Refer to section 2 for the applicable characters.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

76.MTFP50/30, Rev B January 2018 Page 30-643

14. Enter Commands TL1 Command Reference Manual

Example
The following example creates IPPG with the name DCN PROTECTION GROUP:

ENT-IPPG:CORIANT1:IPPG-1:KTRP01:::IPPGMEM=MGTETH-20-21-8&MGTETH-20-28-
8,IPPGNAME="DCN PROTECTION GROUP";

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M KTRP01 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-IPPG
ED-IPPG
RTRV-IPPG

Page 30-644 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-LABELSET

Command Changes Since Previous Feature Package

• None.

Description
The ENT-LABELSET command instructs the NE Control Plane to create a label set object which contains ingress
and egress label information. A label set object can be used in ENT-CALL command.

SET_EGRSS and SET_INGRSS are retrievable only attributes. They indicate how the INGRSS or EGRSS
information were input by the user. For example, when user only provided INGRSS in ENT-LABELSET command,
the resulted label set object has SET_INGRSS = "Y" and SET_EGRSS = "N".

Parameter SEED is to support creation of a new label set by using an existing/original label set as a seed.

The SET_INGRSS and SET_EGRSS of the new label set inherits the value of original label set after the new label
set has been created by using an existing label set as a seed in the ENT-LABELSET command (e.g original
LABELSET-3-1 has ingress only labels, new LABELSET-3-2 created by seeding with LABELSET-3-1,
SET_INGRSS and SET_EGRSS of LABELSET-3-2 are "Y" and "N" as the values for LABELSET-3-1).

Parameter IDXRANGE is to specify the index(s) of the labels in the original label set (use RTRV-LABELSET to get
label information in the original label set), the label(s) specified by this parameter is retained in the new label set that
created by this command. The IDXRANGE is used for the purpose of degrowing a call. For IDXRANGE input, there
is no perceived ordering request. Example 1: 2&&5&1&7 is equivalent to 1&&5&7, example 2: 2&&5&3 is equivalent
to 2&&5.

It is possible to create a label set object in the following forms:

a: With INGRSS only.
b: With EGRSS only.
c: With INGRSS and EGRSS.
d: With SEED and INGRSS.
e: With SEED and EGRSS.
f: With SEED and INGRSS and EGRSS.
g: With SEED and IDXRANGE.

When SEED with INGRSS and/or EGRSS are inputted, labels of ingress and/or egress in original label set is copied
first then the labels specified in the INGRSS and/or EGRSS parameter(s) is appended after, all labels grouped in
order into the new label set.

Restrictions and Exceptions

• The label set can only be supported by TPCP partition.

• Provide the label set AID, otherwise the command is denied by the NE.

• A label set object can contain up to 32 ingress and egress interface pairs.

• The "IfIndex" must be consistent/same for multiple entries of Interfaces parameter.

• The "IfIndex-Label" must be of uniqueness for multiple entries of Interfaces parameter.

• The "IfIndex" only and "IfIndex-Label" mixing entries are not allowed for Interfaces parameter.

• Interfaces sequence is double quoted when input for INGRSS/EGRSS.

76.MTFP50/30, Rev B January 2018 Page 30-645

14. Enter Commands TL1 Command Reference Manual

• The INGRSS and EGRSS parameter can not be an empty quoted string. Otherwise, the command is
denied.

• SEED must be provided when the IDXRANGE is specified, otherwise the command is denied.

• The SEED with INGRSS and/or EGRSS operation permutations must be consistent with SET_INGRSS
and SET_EGRSS of the original label set, otherwise the command is denied (e.g SET_INGRSS=Y,
SET_EGRSS=N of original label set, the creation of new label set can only be SEED with INGRSS
permutation).

• If INGRSS and EGRSS parameters are specified simultaneously, they should have the same number
of the interface entry(ies).

Command Format
ENT-
LABELSET:[tid]:<Labelset_aid>:ctag:::[SEED=<Labelset_aid>][,IDXRANGE=<Index_rang
e>][,INGRSS=<Interfaces>][,EGRSS=<Interfaces>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.37 ENT-LABELSET Parameters

Parameter Value(s) Definition
Labelset_aid LABELSET-3-[d] EntityID-NPID-LSID

Index_range 1-32 or number combinations with Specifies the index range of the labels to be retained at new
marks: & indicates a group, && label set.
indicates a range
Examples:
(a) 1&&10 (select the 1st to 10th labels in original label set)
(b) 1&2&3&8 (select the 1st, 2nd, 3rd, 8th labels in original label
set)
(c) 1&2&7&&11 (select the 1st, 2nd, 7th, 8th, 9th, 10th, 11th
labels in original label set)

Interfaces A double quoted item sequence for the This parameter specifies the interfaces being added to a label
interfaces. Each item of interfaces is in set.
form of IfIndex-Label format: (1).
interface is 8 hex numbers. (2). label is Example:
8 hex numbers. "110ABB11-00040000,110ABB11-00050000"

Example1
Create a label set by specifying INGRSS only:
ENT-LABELSET:CORIANT1:LABELSET-3-1:ctag:::INGRSS="110ABB11-00040000,110ABB11-
00050000,110ABB11-00060000";

Example2
On the basis of example 1, create a new label set by seeding with LABELSET-3-1:

Page 30-646 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-LABELSET:CORIANT1:LABELSET-3-2:ctag:::SEED=LABELSET-3-1,INGRSS="110ABB11-
00070000,110ABB11-00080000";

Example3
On the basis of example 2, create a new label set by seeding with LABELSET-3-2 and specifying IDXRANGE:
ENT-LABELSET:CORIANT1:LABELSET-3-3:ctag:::SEED=LABELSET-3-2,IDXRANGE=1&2&3;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-LABELSET
ED-LABELSET
RTRV-LABELSET
ENT-CALL

76.MTFP50/30, Rev B January 2018 Page 30-647

14. Enter Commands TL1 Command Reference Manual

ENT-MGTETH

Command Changes Since Previous Feature Package

• None.

Description
The ENT-MGTETH command instructs the network element (NE) to provision an management Ethernet facility (at
a specified rate).

The mTera NE implicitly creates LCI and DCN MGTETH entities (MGTETH-20-[24,25]-1 and MGTETH-20-[21,28]-
8).

The management ethernet facility can be provisioned on the SEIM module, before that the SEIM module that
supports this facility should be already provisioned.

All the MGTETH entities on the mTera 8-slot shelf NE are implicitly created and this command doesn't apply.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The command is denied if the RATE, FLOWCTRL, or DUPLEX parameters are set and AUTONEG is
ON.

Command Format
ENT-
MGTETH:[tid]:<fac_aid>:ctag:::[ALMPF=<almProfile>][,AUTONEG=<autoNeg>][,RATE=<et
hRate>][,DUPLEX=<duplexMode>][,FLOWCTRL=<flowCtrl>][,MTU=<mtu>][,ZTCASSIST=<assi
st_state>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.38 ENT-MGTETH Parameters

Parameter Value(s) Definition
fac_aid MGTETH-20-[13,14,21,28]-[1-7] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

autoNeg ON Specifies if 802.3 auto-negotiation signaling is enabled(on) or

OFF disabled (off) on the management ETH facility.
Default: ON

Page 30-648 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.38 ENT-MGTETH Parameters (Continued)

Parameter Value(s) Definition
ethRate 10 When auto-negotiation is off, specifies the manually configured
100 rate. When auto-negotiation is enabled, this parameter has no
1000 meaning.
10G
AUTO
Default: 1000 if AutoNeg is OFF,
AUTO if AutoNeg is ON

duplexMode FDPLX When auto-negotiation is off, specifies the manually configured

HDPLX duplex mode (full or half).When auto-negotiation is enabled, this
AUTO parameter has no meaning.
Default: FDPLX if AutoNeg is OFF,
AUTO if AutoNeg is ON

flowCtrl OFF When auto-negotiation is off, specifies the type of flow control
TXRX support to be supported:
TX - OFF indicates no pause frames are supported
RX - TXRX indicates symmetric (transmit and receive)
Default: OFF - TX indicates transmit direction only
- RX indicates receive direction only
When auto-negotiation is enabled, this parameter has no
meaning.

mtu 576-1500 octets Specifies the maximum number of octets in the Information and
Default: 1500 Padding fields.

assist_state ENABLED Specifies the ZTC Assist state of the interface.

DISABLED When the ZTC Assist state is ENABLED, the NE can be the ZTC
Default: DISABLED Assist of the ZTC DUC attached to the port.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS The system default is IS.

Example
Provisioning a management ETH port:

ENT-MGTETH:CORIANT1:MGTETH-20-21-1:myctag:::ALMPF=99,AUTONEG=OFF,RATE=1000;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-MGTETH
ED-MGTETH
RTRV-MGTETH

76.MTFP50/30, Rev B January 2018 Page 30-649

14. Enter Commands TL1 Command Reference Manual

ENT-MGTINBANDETH

Command Changes Since Previous Feature Package

• None.

Description
The ENT-MGTINBANDETH command instructs the network element (NE) to provision an in-band management
P2PVLAN facility on Packet module.

Restrictions and Exceptions

• The P2P management VLAN can only be created over the interface of CEP, PNP and PPNP port with
type of switch

Command Format
ENT-
MGTINBANDETH:[tid]:<mgtinbandeth_aid>:[CTAG]:::[LKTYPE=<lktype>],[P2PVLAN=<p2pvl
an>], [MTU=<mtu>][,ZTCASSIST=<assist_state>]:[<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>COMPLD<cr>lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.39 ENT-MGTINBANDETH Parameters

Parameter Value(s) Definition
mgtinbandeth_ MGTINBANDETH-20-[10-16,1-7]-[1- EntityID-ShelfID-SlotID-PortID
aid 20]

lktype BROADCAST Specified the Ethernet interface link type, Point to Point or
POINTTOPOINT Boardcast

p2pvlan [1-4094] Specifies the VLAN id of the Ethernet point to point port

mtu 64-1500 octets Specifies the maximum number of octets in the Information and
Default: 1500 Padding fields for Transmission

assist_state ENABLED Specifies the ZTC Assist state of the interface.

DISABLED When the ZTC Assist state is ENABLED, the NE can be the ZTC
Default: DISABLED Assist of the ZTC DUC attached to the port.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS The system default is IS.

Page 30-650 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Example
ENT-MGTINBANDETH:CORIANT1:mgtinbandeth-20-16-
18:MYCTAG:::lktype=broadcast,p2pvlan=4094:is

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-MGTINBANDETH
ED-MGTINBANDETH
RTRV-MGTINBANDETH

76.MTFP50/30, Rev B January 2018 Page 30-651

14. Enter Commands TL1 Command Reference Manual

ENT-NODE

Command Changes Since Previous Feature Package

• Add support for the IP parameter

• Remove support for the NODEID parameter

Description
The ENT-NODE command instructs the network element (NE) to create a Node entity.
Since IPv4 link connectivity is not limited by the MFAB, only one node is necessary for the SCN partition.

Restrictions and Exceptions

• String parameters must be used in quotes.

• Creation of the Node entity is denied if the associated Network Partition entity does not exist.

• Only one node in a partition can have the IP parameter set to YES

Command Format
ENT-
NODE:[tid]:<node_aid>:<ctag>:::[NODENAME=<NodeName>],RAAID=<RouterAreaAID>[,IP=<
SupportIP>]:[<editablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.40 ENT-NODE Parameters

Parameter Value(s) Definition
node_aid NODE-[1,3]-[1-512] EntityID-NPID-NodeID

NodeName A double quoted string consisting of 0 Specifies the Node name.

to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

RouterAreaAI OSPFAREA-[1,3]-1-[1-32] Identifies the router area entity which represents the lowest
D routing area this node is participating in.

SupportIP NO Specifies if this Node Supports IP or not.

YES
Default: NO NO - This Node does not support IP
YES - This Node supports IP

editablePrimar IS Specifies the primary state of the entity.

yState OOS Two states are possible: In-Service (IS) and Out-of-Service
Default: IS (OOS).

Page 30-652 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Example
The following example shows the creation of a node

ENT-NODE::NODE-2-1:AM0011:::RAAID=OSPFAREA-3-1-1;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NODE
ED-NODE
RTRV-NODE

76.MTFP50/30, Rev B January 2018 Page 30-653

14. Enter Commands TL1 Command Reference Manual

ENT-NP

Command Changes Since Previous Feature Package

• None.

Description
The ENT-NP command instructs the network element (NE) to provision a Network Partition.

A Network Partition entity provides the ability to separately configure the Management and Signaling Control
Network (NP-1) and the Transport Plane Control Plane (NP-3) Network.

The system assumes that NP-1 is used for both MCN and SCN, and NP-3 is used for the TPCP partition.

Restrictions and Exceptions

• String parameters must be used in quotes.

• Creation of NP-2 is be rejected.

• TPCP NP provisioning on NEs more than 8 port shelves is denied.

Command Format
ENT-NP:[tid]:<np_aid>:ctag:::[NPNAME=<NpName>][,TIMEOUT=<Timeout>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.41 ENT-NP Parameters

Parameter Value(s) Definition
np_aid NP-[1,3] EntityID-NPID

NpName A double quoted string consisting of 0 Specifies the Network Partition name.
to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.
Default: "" (empty string)

timeout [120-900] Specifies the default timeout for a call setup request.
Default: 900 seconds

Example
The following example creates Network Partition 3 with the name TPCP Partition:
ENT-NP:CORIANT1:NP-3:AM0074:::NPNAME="TPCP Partition";

Page 30-654 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-NP
DLT-NP
RTRV-NP
RTRV-NP-STATS

76.MTFP50/30, Rev B January 2018 Page 30-655

14. Enter Commands TL1 Command Reference Manual

ENT-NTPPEER

Command Changes Since Previous Feature Package

• None.

Description
The ENT-NTPPEER command instructs the network element (NE) to provision the attributes of a specified NTP
Peer entity. Up to two NTP Peers can be configured per NE.

The NTPPEER-1 and NTPPEER-2 is manually provisioned on the NE, regardless of its proxy mode. When the NE
is participating in the Private EON, provision the PGNEs as the NTPPEERs.

Restrictions and Exceptions

• String parameters must be used in quotes.

Command Format
ENT-
NTPPEER:[tid]:<ntppeer_aid>:ctag:::[IPPEER=<IPPeer>][,PEERNAME=<NTPName>][:<edit
ablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.42 ENT-NTPPEER Parameters

Parameter Value(s) Definition
ntppeer_aid NTPPEER-[2,1] EntityID-PeerID

IPPeer [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the NTP Peer being entered.

NTPName 0 to 31 alphanumeric characters. Specifies the customer entered additional field to label the NTP
Default: "" (empty string) Peer.
Refer to section 2 for the applicable characters.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Outof-Service (OOS).
Default: IS

Example
ENT-NTPPEER:CORIANT1:NTPPEER-1:AM0074:::IPPEER=138.111.1.101,PEERNAME="NMS 7194
Peer1":IS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

Page 30-656 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NTPPEER
ED-NTPPEER
RTRV-NTPPEER

76.MTFP50/30, Rev B January 2018 Page 30-657

14. Enter Commands TL1 Command Reference Manual

ENT-OCH

Command Changes Since Previous Feature Package

• Added OSM-4F 300G support using 2 x OCH-OS.

• Added support for OSM-4S.

Description
The ENT-OCH command instructs the mTera UTP network element to provision an OCH-P entity on an OSM-2C/
OSM-2S/OSM-4S.
The ENT-OCH command instructs the mTera UTP network element to provision an OCH-OS entity on an OSM-4C/
OSM-4F.
The ENT-OCH command instructs the mTera UTP network element to provision OCH-L entity on OADM module.
This explicitly provisioned OCH-L entity is able to be configured with frequency which does not have fixed channel
plan relation to the ID defined in the OCH-L.

When provisioning a OCH-P on mTera UTP network element, the OCH-P provisioned is associated with the ODUk
on the same port automatically if the ODUk exists.
When provisioning a OCH-OS on mTera UTP network element, the OCH-OS provisioned is associated with the
ODUk on the same port automatically if the ODUk exists.
The ENT-OCH command instructs the mTera UTP network element to provision OCH entity on add/drop ports of
OMD/CDCP module to allow add/drop of a wavelength from OADM degree to an Alien transponder using the OCH-
L to OCH cross connection.

Page 30-658 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Figure 14.21 Example: OCH on Add/Drop Port of OADMRS in mTera Configuration.

1. 1WAY CRS ADD: Unidirectional traffic from alien transponder to DWDM interface.
2. 1WAY CRS DROP: Unidirectional traffic from DWDM interface to alien transponder.
3. 2WAY CRS: ADD/DROP from/to DWDM to alien transponder.
Note: You must provision the OCH facility on ROADM add/drop port before provisioning this OCH CRS.
Note 2: FIBR connection is not required.
Note 3: The direction is determined by FROM and TO in 1WAY CRS.

DWDM interface
ROADMRS

1) ENT-OCH:[tid]:OCH-20-1-5-25:ctag::::IS;
1) ENT-CRS-OCH:[tid]:<OCH-L-1-1-1-25>,<OCH-20-1-5-
25>:ctag::2WAY:GRP=<group_id>,CCPATH=ADD/DROP;
Port
5
alien transponder

ADD/DROP

Provisioning of OCH on port modules with tunable pluggable optics support allows the system to recognize that a
port that connects to the DWDM optics using OCH-P/OCH-L cross connect and FIBER commands supported by the
NE. By creating an OCH-P entity for these flexible ports the lineside characteristics of legacy modules becomes
associated with the pluggable port and a tunable laser is required.

Table 14.43 Flexible OCH-P Assignment

Maximum Number Allowable Port
Mux/Transponder of OCH-P Number
OSM-2S 20 1,2,3...20

OSM-2C 2 1,2

OSM-4S 40 1,2,3...40

Table 14.44 Flexible OCH-OS Assignment

Maximum Number Allowable Port
Mux/Transponder of OCH-OS Number
OSM-4C 4 1..4

OSM-4F 2 1..2

76.MTFP50/30, Rev B January 2018 Page 30-659

14. Enter Commands TL1 Command Reference Manual

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• String parameters must be used in quotes.

• OCH can be explicitly provisioned on OMD, CDCP for alien wavelengths.

• When entering an OCH entity, the channel specified must be part of the allowed channel set for the
corresponding OTS. (CHANALLOW on OTS must include the channel specified for the OCH.)

• For Operator Specific TTI trace, by default the OTUTRC and EXPOTUTRC is taking effective if there is
no explicitly provisioned TXOPER or EXPOPER value.

• On the same OCH-P entity for modules supported on mTera, an attempt to provision TXOPER or
EXPOPER is denied when OTUTRC or EXPOTUTRC provisioned already with an Operator Specific
value and the value is not empty.

• On the same OCH-P entity for modules supported on mTera, an attempt to provision OTUTRC or
EXPOTUTRC is denied when TXOPER or EXPOPER provisioned already with an Operator Specific
value and the value is not empty.

• On the same OCH-P entity for modules supported on mTera, an attempt to provision both the
proprietary Operator Specific trace mode (up to 28 characters, by specifying the mode with parameter
OTUTRC/EXPOTUTRC) and the standard Operator Specific trace mode (up to 32 characters, by
specifying the mode with parameter TXOPER/EXPOPER) at the same time is denied.

• If an ODU exists for the port with OPUCONFIG=CLIENT, then the system denies an attempt to enter
an OCH-P on the same port.

• If GRIDMODE=FIXED88_7100 on OADMRS/OADMRS9, the attempt to provision FREQ of the OCH-L

to a different value defined by channel plan is denied. Frequency of an OCH-L is decided by last
modifier number of the OCH-L AID per 7100 88 channel plan.

• If GRIDMODE=FIXED44_7100 on OADMRS/OADMRS9, the attempt to provision FREQ of the OCH-L

to a different value defined by channel plan is denied. Frequency of an OCH-L is decided by last
modifier number of the OCH-L AID per 7100 44 channel plan.

• If GRIDMODE=FIXED96_MTERA on OADMRS/OADMRS9, the attempt to provision FREQ of the

OCH-L to a different value defined by channel plan is denied. Frequency of an OCH-L is decided by last
modifier number of the OCH-L AID per mTera 96 channel plan.

• If GRIDMODE=FIXED96_NOCHANPLAN on OADMRS/OADMRS9, the attempt to provision an OCH-

L without specifying FREQ is denied. The last modifier of the OCH-L is logical ID which does not decide
frequency of the channel.

• When the GRIDMODE is set to a value that uses a channel plan, provisioning OCH-L with an ID outside
the list of CHANALLOW is denied.

• On OMD module, OCH can be created on it only if the module is in mTera UTP NE.

• In mTera UTP NE, the attempt to explicitly create an OCH entity on an add/drop interface of OMD is
denied if the DWDM port of the OMD does not have fiber entity created.

• When OTSMODE=7100 an attempt to set AAMINGR is denied.

Page 30-660 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• On OADMRS/OADMRS9, when OTSMODE=MTERA or HIT7300, an attempt to set AAMINGR or

AAMEGR is denied due to the fact that these parameters are controlled by the OCHAAMINGR and
OCHAAMEGR parameters at the OMS level for these OTSMODEs.
- When OCHAAMING is set to AUTO at the OMS, all OCH-Ls within the OMS shows AAMINGR in
RTRV-OCH as AUTO. When OCHAAMINGR is set to MAN at the OMS, all OCH-Ls within the OMS
shows AAMINGR in RTRV-OCH as MAN.

• FECTYPE is configurable when the supporting module is OSM-2S/OSM-2C/OSM-4S

- OSM-2S/OSM-4S OCH-P supports 4 FEC types: 1) Regular G.709 FEC; 2) Super FEC (G.975.1 I.4
EFEC); 3) SuperI7 FEC (G.975.1 I.7 EFEC); or 4) NOFEC.
- The OSM-2C supports Soft-Decision FEC (SOFT) for an OCH-P with CLOCKTYPE=OTU4FEC15 and
Soft Decision FEC 21% + GFEC (SOFT21GFEC) for an OCH-P with CLOCKTYPE=OTU4FEC21.

• On OSM-2S, the Super FEC provisioning for a group of ports must be the same (for example, SUPER
- I.4 EFEC or SUPERI7 - I.7 EFEC). The system denies an attempt to provision the FECTYPE as
SUPER or SUPERI7 if one of the ports in the group is already provisioned for a different SUPER/
SUPERI7 value. The port groups are: 1-4, 5-8, 9-10, 11-14, 15-18 and 19-20.

Table 14.45 FECTYPE Parameter Value Table

FECTYPE
Module Type NOFEC REGULAR SUPER SUPERI7 SOFT SOFT21GFEC SOFT25EFEC

OSM-2S X X X X

OSM-2C CLOCKTYPE= CLOCKTYPE=

OTU4FEC15 OTU4FEC21

OSM-4C X

OSM-4F MODUFMT=100
GQPSK
or
MODUFMT=2x1
50G8QAM
or
MODUFMT=200
G16QAM

OSM-4S X X X X

• For OSM-4C OCH-OS, it supports 15% Soft-Decision FEC (SOFT) and is not configurable. The
FECTYPE parameter cannot be included in the command. If FECTYPE is included in the command
input, the command is denied.

• For OSM-4F OCH-OS, it supports 25% Soft Decision FEC (SOFT25EFEC) for all modulation formats
(100GQPSK, 200G16QAM and 2x150G8QAM) and is not configurable. The FECTYPE parameter
cannot be included in the command. If FECTYPE is included in the command input, the command is
denied.

• For OSM-4C, it supports modulation format 100GQPSK and is not configurable. The MODUFMT
parameter cannot be included in the command. If MODUFMT is included in the command input, the
command is denied.

• For OSM-4F, the two OCH-OS facilities must have the same modulation format. This means both OCH-
OS can be100GQPSK, or both can be 2X150G8QAM, or both can be 200G16QAM. When the first
OCH-OS facility on the module is created, it is possible to select either modulation format. Once the first
OCH-OS is created, it automatically constraints the modulation format for the second OCH-OS facility.

76.MTFP50/30, Rev B January 2018 Page 30-661

14. Enter Commands TL1 Command Reference Manual

• For OSM-4F with modulation format 2X150G8QAM, the following provisioning order is used:
- create OCH-OS with modulation format 2X150G8QAM on port#1 first
- create OCH-OS with modulation format 2X150G8QAM on port#2 second

• For OSM-4F, when creating the second OCH-OS facility on the module, if <MODUFMT> parameter is
not present in the ENT-OCH command, the modulation format is automatically set by the system to be
the same value as the existing OCH-OS of the same OSM-4F module.

• For OSM-4F, when creating the second OCH-OS facility on the module, if the <MODUFMT> parameter
is present in the ENT-OCH command and has a different modulation format values (from the existing
OCH-OS) the command is denied. The only acceptable value for <MODUFMT> is the modulation
format of the existing OCH-OS (on the same OSM-4F module).

• For OSM-4F, when modulation format is 2X150G8QAM, the following parameters applicable to OCH-
OS are primarily governed by the settings of the OCH-OS on port#1:
ALMPF, FECTYPE, MODUFMT, ROLLOFF
The configuration of these parameters follows the restrictions in the following table.

Table 14.46 Parameter Coupling for OCH-OS with 2X150G8QAM

PARAMETER OCH-OS on Port#1 OCH-OS on Port#2

ALMPF Configuration is done primarily on Configuration is allowed and

port#1. accepted when creating OCH-
OS on port#2 if and only if the
value is the same as the
corresponding parameter of
OCH-OS on port#1.
If the value is different, the
command is denied.

CONNECTED Configure independently from Configure independently from

port#2. port#1.

EXTCHAN Configure independently from Configure independently from

port#2. port#1.

FECTYPE Configuration is done primarily on Configuration is allowed and

port#1. accepted when creating OCH-
OS on port#2 if and only if the
value is the same as the
corresponding parameter of
OCH-OS on port#1.
If the value is different, the
command is denied.

MODUFMT Configuration is done primarily on Configuration is allowed and

port#1. accepted when creating OCH-
OS on port#2 if and only if the
value is the same as the
corresponding parameter of
OCH-OS on port#1.
If the value is different, the
command is denied.

TXPWR Configure independently from Configure independently from

port#2. port#1.

Page 30-662 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.46 Parameter Coupling for OCH-OS with 2X150G8QAM (Continued)

PARAMETER OCH-OS on Port#1 OCH-OS on Port#2

ROLLOFF Configuration is done primarily on Configuration is allowed and

port#1. accepted when creating OCH-
OS on port#2 if and only if the
value is the same as the
corresponding parameter of
OCH-OS on port#1.
If the value is different, the
command is denied.

PST Configure independently from Configure independently from

port#2. port#1.

• An attempt to enter a value for OMSPWRCORR or INGRPWRCORR on an OCH-L that is associated

with an OTS with OTSMODE=7100 is denied since these parameters are not applicable in
OTSMODE=7100.

Command Format
ENT-
OCH:[tid]:<och_aid>:ctag:::[,ALMPF=<almProfile>][,EXTCHAN=<ExtChan>][,CONNECTED=
<ConnectedTo>][,FECTYPE=<fecType>][,EXPOTUTRC=<OTUExpTrc>][,OTUTRC=<OTUTrc>][,MO
NOTUTRC=<OTUMonTrc>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSA
PI>][,TXOPER=<TxOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMdefin
ition>][,CLOCKTYPE=<ClkType>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_thresho
ld>][,AAMEGR=<AttAdjModeEgress>][,AAMINGR=<AttAdjModeIngress>][,FREQ=<frequency>
][,MODUFMT=<ModulationFormat>][,TXPWR=<TransmitPower>][,ROLLOFF=<rolloff>][,INGR
PWRCORR=<in_pwr_correct>][,OMSPWRCORR=<oms_pwr_correct>]:[<editablePrimaryState>
];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters Applicability When Entering the Command

Table 14.47 Parameters Applicability When Entering the Command

a b
PARAMETER DEF OCH OCH-P OCH-L OCH-OS
ALMPF ND X X X X

AAMEGR ND X

AAMINGR ND X

CLOCKTYPE ND X

CONNECTED ND X X X

EXPOPER ND X

EXPDAPI ND X

76.MTFP50/30, Rev B January 2018 Page 30-663

14. Enter Commands TL1 Command Reference Manual

Table 14.47 Parameters Applicability When Entering the Command (Continued)

PARAMETER DEFa OCH OCH-P OCH-L OCH-OS
b

EXPSAPI ND X

EXPOTUTRC ND X

EXTCHAN ND X X

FECTYPE ND X

FREQ ND X

MONOTUTRC ND X

OTUTRC ND X

TIMDEF ND X

TXOPER ND X

TXDAPI ND X

TXSAPI ND X

DEGM ND X

DEGTHR ND X

MODUFMT ND X Xc

TXPWR ND X
c
ROLLOFF ND X

INGRPWRCORR ND X

OMSPWRCORR ND X

PST PD X X X X

a. ND: Name Defined or PD: Position Defined

b. Only OSM-4C and OSM-4F support OCH-OS entity
c. Only applicable for OSM-4F, not applicable for OSM-4C.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.48 ENT-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-ShelfID-SlotID[-SubslotID]-PortID
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

Page 30-664 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.48 ENT-OCH Parameters (Continued)

Parameter Value(s) Definition
almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

ExtChan (1)NA (2)1 to 88 (3)191350000 to Specifies the DWDM Channel number or frequency at which the
196100000 in increments of 50000 (4) interface operates and enables the transmit laser when set to a
191338750 to 196111250 in increment value 1 to 88, 191350000 to 196100000 MHz, 191338750 to
of 125 (5) 191150000 to 196100000 in 196111250 MHz, or 191150000 to 196100000 MHz.
increments of 500
Default: NA Values of 1-88 represent the channel ID in the 88 channel plan
where each channel ID has an associated frequency. Values of
191350000 to 196100000 in increments of 50000 represents the
frequency in MHz in increments of 50 GHz and covers 96
channels. Values of 191338750 to 196111250 in increments of
125 represents the frequency in MHz in increments of 125 MHz
and covers 96+ channels. Values of 191150000 to 196100000
in increments of 500 represents the frequency in MHz in
increments of 500 MHz and covers 96+ channels.

The OSM-2C Tunable CFP supports values of 1 to 88 and

191350000 to 196100000 MHz in increments of 50000 MHz
(covering 96 channels with 50 GHz spacing).
The OSM-4C Tunable optics supports values of 1 to 88 and
values of 191338750 MHz to 196111250 MHz in steps of 125
MHz.
The OSM-4F Tunable optics supports values of 1 to 88 and
191150000 MHz to 196100000 MHz in steps of 500 MHz.
All other modules support values of 1 to 88.

This parameter is used when directly connecting the module to a

separate network element, rather than connecting to an optical
multiplexer/demultiplex module within the same network
element where the channel is provisioned with an OCH-L to
OCH-P OEO Regeneration crossconnection.
When the ExtChan value is NA, the transmit laser is either
disabled and no channel has yet been selected, or the optical
channel is involved in an OCH-L to OCH-P/OCH-L cross-
connection where the frequency is set based on the OCH-L.

ConnectedTo 0 to 36 characters, inclusive. This attribute can be used to indicate remote NE TID & Module/
Facility AID to which the current facility is connected.

This parameter applies to:

1) OCH facility on the Add/Drop port of a CDCP, OMD, when it
was explicitly created for connection to Non-Coriant
transponder.
2) OCH-P/OCH-OS facility on a transponder which is connected
to external equipment

Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-665

14. Enter Commands TL1 Command Reference Manual

Table 14.48 ENT-OCH Parameters (Continued)

Parameter Value(s) Definition
fecType REGULAR Specifies the type of Forward Error Correction on the OCH-P/
NOFEC OCH-OS facility.
SUPER
SUPERI7 OTU2 and OTU2e based OCH-P interfaces
SOFT (CLOCKTYPE=G709,OVRCLK_FS) support the following
SOFT21GFEC values:
SOFT25EFEC NOFEC = FEC processing disabled.
Default: SUPER for REGULAR = G.709 compliant GFEC with a 6.2dB coding gain
CLOCKTYPE=G709 and (at 10e-15 BER).
OVRCLK_FS, SOFT for SUPER = G.975.1 I.4 complaint EFEC with >8 dB coding gain@
CLOCKTYPE=OTU4FEC15, 10e-15 BER.
SOFT21GFEC for SUPERI7 = G.975.1 I.7 complaint EFEC with >8 dB coding
CLOCKTYPE=OTU4FEC21, SOFT for gain@ 10e-15 BER.
OSM-4C, SOFT25EFEC for OSM-4F
OTU4v with 15% FEC Overhead based OCH-P interfaces
(120.579 Gbps, CLOCKTYPE=OTU4FEC15) support only the
SOFT option which is a proprietary Soft-Decision FEC using
15% overhead that provides 11.1 dB of coding gain at 10e-15
BER.

OTU4v with 21% FEC Overhead based OCH-P interfaces

(127.156 Gbps, CLOCKTYPE=OTU4FEC21) support only the
SOFT21GFEC option which is a proprietary Soft-Decision +
GFEC combination using 21% FEC overhead that provides 10.5
dB of coding gain at 10e-15 BER.

For OSM-4F OCH-OS, only the 25% SDFEC Overhead

(SOFT25EFEC) is applicable. This is for all OSM-4F supported
modulation formats (MODUFMT=100GQPSK, 200G16QAM and
2x150G8QAM).

For OSM-4C OCH-OS, only the 15% SDFEC Overhead (SOFT)

is applicable.

OTUExpTrc One to 28 alphanumeric characters Specifies the expected trace value in the Operator Specific area
Default: "" (empty string) of the OTU trail trace identifier.

All printable characters are allowed except for the semi-colon

and double quote. A value of "" means that there is no Trail
Trace Id expected.

Refer to section 2 for the applicable characters.

OTUTrc One to 28 alphanumeric characters Specifies the transmitted trace value in the Operator Specific
area of the OTU trail trace identifier.
All printable characters are allowed except for the semi-colon
and double quote. A value of "," means that there is no Trail
Trace Id sent.
When this field is empty, the Default OTU Trace value is sent.
Refer to section 2 for the applicable characters.

OTUMonTrc ENABLED-AIS Specifies the monitored OTU trace identification mode.

ENABLED-NOAIS - Enter ENABLED-AIS to enable monitoring and insert AIS on
DISABLED the port side (TDTC direction) when there is a OTU Trace
Default: DISABLED mismatch.
- Enter ENABLED-NOAIS to enable monitoring but not insert
AIS.
- Enter DISABLED to disable monitoring.

Page 30-666 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.48 ENT-OCH Parameters (Continued)

Parameter Value(s) Definition
ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace
SAPI_DAPI identifier mismatch purposes.
SAPI_DAPI_OPER - OPER (Operator Specific mismatch only),
SAPI_OPER - SAPI (SAPI mismatch only),
DAPI_OPER - DAPI (DAPI mismatch only),
Default: OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

ClkType G709 Specifies the rate of the OCH-P.

OVRCLK_FS
OTU4FEC15 For an OCH-P on an OSM-2S/OSM-4S the possible values are:
OTU4FEC21 G709: 10.709 Gbps (OTU2 based)
Default: G709 for OCH-P on OSM-2S, OVRCLK_FS: 11.096 Gbps (OTU2e based)
OTU4FEC15 for an OCH-P on an
OSM-2C For an OCH-P on an OSM-2C the possible values are:
OTU4FEC15: 120.579 Gbps (OTU4v with 15% FEC Overhead
supported by the 71T-CDWDMS series of Tunable CFPs)
OTU4FEC21: 127.156 Gbps (OTU4v with 21% FEC Overhead
supported by the 71T-CDWDMS2 series of Tunable CFPs)

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-856388] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 82026, default of 12304 (ODU2 based)
1 to 84986, default of 12748 (ODU2e based)
1 to 856388, default of 128459 (ODU4 based)

AttAdjModeEg AUTO Specifies the attenuation adjustment mode at egress side of

ress MAN module.
Default: AUTO
For select side per channel attenuation control of OADMRS/
OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

MAN indicates the facility is on manual adjustment.

76.MTFP50/30, Rev B January 2018 Page 30-667

14. Enter Commands TL1 Command Reference Manual

Table 14.48 ENT-OCH Parameters (Continued)

Parameter Value(s) Definition
AttAdjModeIng AUTO Specifies the attenuation adjustment mode at ingress side of
ress MAN module.
Default: AUTO
For route side per channel attenuation control of OADMRS/
OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

MAN indicates the facility is on manual adjustment.

frequency From 191350000 to 196100000 with Indicates the center frequency (MHz) of the OCH-L channel.
increment 50000
Applicable to all OCH-L entities of mTera UTP NE.

Under specific GRIDMODEs, only corresponding frequency

values are valid on an OCH-L, which is default values if not
provisioned:
If GRIDMODE = FIXED88_7100, default value defined per 88
channel plan related to the ID of the OCH-L.
If GRIDMODE = FIXED44_7100, default value defined per 44
channel plan related to the ID of the OCH-L.
If GRIDMODE = FIXED96_MTERA, default value defined per 96
channel plan related to the ID of the OCH-L.

ModulationFor UNKNOWN Specifies the modulation format of the optical channel on the
mat 10GOOK Och-OS and OCH facilities.
40GQPSK
50GBPSK Och-OS on OSM-4F:
100GQPSK - Supports 100GQPSK, 2X150G8QAM or 200G16QAM
2X150G8QAM - When 100GQPSK is selected, the OCh-OS facility supports a
200G16QAM single OTU4 entity;
Default: 100GQPSK for OCH-OS, - When 2X150G8QAM is selected, two OCh-OS facilities are
UNKNOWN for OCH required and support a single OTUC3, a single ODUC3 and 3 x
ODU4 entities;
- When 200G16QAM is selected, the OCh-OS facility supports a
single OTUC2, a single ODUC2 and 2 x ODU4 entities.

Och-OS on OSM-4C:
- Not configurable.

OCH:
Any of the following modulation formats can be provisioned for
alien wavelengths.
UNKNOWN
40GQPSK
10GOOK
2X150G8QAM
200G16QAM
100GQPSK
50GBPSK

Page 30-668 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.48 ENT-OCH Parameters (Continued)

Parameter Value(s) Definition
TransmitPowe [-2000 to 4500] Unit is in thousandths Specifies the Transmit output power of the Och-OS facility.
r of dBm. Incremental step of 100. Applicable for OSM-4F and OSM-4C only.
Default: 2 dBm when For OSM-4F:
modufmt=100GQPSK, 4dBm when - Tx Power range: -2 dBm ... + 4.5 dBm, step 0.1 dBm
modufmt=200G16QAM - If MODUFMT=100GQPSK, default Tx power = 2dBm
- If MODUFMT=2X150G8QAM, default Tx power = 2dBm
- If MODUFMT=200G16QAM, default Tx power = 4dBm
For OSM-4C:
- Tx Power range: -2 dBm ... +1 dBm, step 0.1 dBm
- Default Tx power = 1 dBm

rolloff 0.2 Specifies the roll-off factor of the signal which affects the pulse
0.8 shape.
Configurable for OCH-OS on OSM-4F only, default=0.2,
applicable values are 0.2 and 0.8.
Not configurable for OCH-OS on OSM-4C. Default is 0.8.
Not applicable to OCH, OCH-L and OCH-P.

in_pwr_correct -999 to 200 (dB/10) Specifies a power correction value for an optical channel.
Default: 0 Applies to the complete optical path and is set at the ingress
point to the APC domain.

oms_pwr_corr -999 to 200 (dB/10) Specifies a power correction value for an optical channel for
ect Default: 0 each preemphasis section.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example: OCH-P
ENT-OCH:CORIANT1:OCH-P-20-1-5:AM0074::::IS;

Possible System Response

^^^CORIANT1 07-03-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-OCH
ED-OCH
DLT-OCH

76.MTFP50/30, Rev B January 2018 Page 30-669

14. Enter Commands TL1 Command Reference Manual

ENT-OCn/STMn/STSn

Command Changes Since Previous Feature Package

• None.

Description
The ENT-OCn/STMn/STSn command instructs the network element (NE) to provision a selected facility entity.
Before the facility can be provisioned, the transponder module that supports this facility should be already
provisioned. Refer to the table below for facilities that can be provisioned on the listed transponders.

Table 14.49 Facilities Supported By Transponders

STS1/
STS3C/
Facilities --> STS12C/
OC3/ OC12/ OC48/ OC192/ STS48C/
Transponders STM1 STM4 STM16 STM64 STS192C
OSM-2S X

OSM-1S X X X

SSM-2S X X X X X

• Facilities (fac_type): OC3, OC12, OC48, OC192, STM1, STM4, STM16, STM64, STS1, STS3C,
STS12C, STS48C, STS192C

Restrictions and Exceptions

• Intrusive J0 Trace Monitoring and J0 Generation options should be only available when the supporting
module is a SSM-2S (EXPTRC, MONTRC, TRC on OCn port side facilities).

• OSM-1S, OSM-2S provide transparent transport of SONET signals and may only monitor the J0 trace
message non-intrusively. OCn port facilities support INCTRC, EXPTRC and MONTRC parameters. The
J0 message cannot be altered, only read and optionally compared to an expected value.

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• An OC192/STM64 is mapped to ODU2 directly if the ODUk is created on the same physical port on
OSM-2S.

• An OC192/STM64 is mapped to ODU2 directly if the ODU2 is created on the same virtual port on SSM-
2S for Sonet/SDH facility to OTN bridge.

• OC3/STM1, OC12/STM4 is mapped to ODU0 directly if the ODUk is created on the same physical port
on OSM-1S.

• OC48/STM16 is mapped to ODU1 directly if the ODU1 is created on the same virtual port on SSM-2S
for Sonet/SDH facility to OTN bridge.

• OC48/STM16 is mapped to ODU1 directly if the ODUk is created on the same physical port on OSM-1S.

• For an OCn/STMn on an OSM-2S, OSM-1S, the TRANSPARENT parameter is always set to YES
because there is no SONET/SDH path layer management supported on this transponder.

Page 30-670 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• For an OCn/STMn on an SSM-2S, the TRANSPARENT parameter is always set to NO because there
is always SONET/SDH path layer management supported on this module.

• The CBRMAP parameter is supported for OC48/STM16 on OSM-1S, and OC192/STM64 facilities on
OSM-2S.

• The CBRMAP parameter is supported for OC48/STM16 associated with virtual port on SSM-2S back
plane side that is demapped from ODU1, and OC192/STM64 facilities associated with virtual port on
SSM-2S back plane side that is demapped from ODU2.

• An attempt to enter an OCn/STMn is denied if the supporting ODUk entity has an incompatible PT value.

• For a SSM-2S, the ENT-STS1/STS3C/STS12C/STS48C/STS192C should be denied if the OCn is

owned by the control plane.

• STMn are provisionable when the NE is in SONET mode, however these entities are managed as OCn
entities.

• On an OSM-2S/OSM-1S, an attempt to enter an OCn/STMn is denied if an ODUk with TribID specified

is entered for the same physical port.

• On an OSM-2S/OSM-1S, an attempt to enter an OCn/STMn is denied if an ODUk which does not

support the specified OCn/STMn signal is specified for the same physical port.

• QL (quality level) parameter may only be set on the STMn facilities while in SONET mode. The operator
should reference ITU-T recommentation G.781 "Synchronization layer functions" when manually
setting a QL value to correlate to the SONET stratum level.

• QL may only be set if SSMSUPP=YES.

• PROT is not supported on OCn/STMn facilities provisioned on the OSM-1S. PROT may not be changed
from the default (that is, PROT=NO).

• PROT is supported on SSM-2S OCn/STMn facilities associated with frontpanel physical port.

• Provisioning the OC192/STM64 entity is denied if the provisioned ODUk of the same port is not ODU2
in mTera shelf.

• For OSM-1S port range 1-16, when N facilities (<1.25G, such as OC3/OC12/STM1/STM4/GBEP) and
M facilities (including OC48/STM16/OTU1) existing, the total number should follow the following
formula: N+2M <16 or N+2M=16.
For OSM-1S port range 17-32, when N facilities (<1.25G, such as OC3/OC12/STM1/STM4/GBEP) and
M facilities (including OC48/STM16/OTU1) existing, the total number should follow the following
formula: N+2M <16 or N+2M=16.

• For OSM-1S, if an ETH entity exists on any port 1 through 16, then the system denies an attempt to
create any facilities other than OTU1 on ports 1 through 16. If an ETH entity exists on any port 17
through 32, then the system denies an attempt to create any facilities other than OTU1 on ports 17
through 32.

• For OSM-1S, if an ODU1 or ODU0 entity exists on port 1 through 16 with SWITCHTYPE=PKT, then the
system denies an attempt to create any facilities other than OTU1 on ports 1 through 16. If an ODU1 or
ODU0 entity exists on any port 17 through 32 with SWITCHTYPE=PKT, then the system denies an
attempt to create any facilities other than OTU1 on ports 17 through 32.

• On SSM-2S, there are three port groups corresponding to three independent Framers, the OCn/STMn
interface (based on pluggable 6xSFPP+ and 24xSFP optics) on front panel physical port and the entity
(ODU1/ODU2/OCn/STMn/STSn/VCn/TTPSTSn) provisioned on backplane is grouped in the way
below:
- The first port group (connecting with 1st Framer):
Port 1-2: 2xSFP+ for 10G OC192/STM64 clients

76.MTFP50/30, Rev B January 2018 Page 30-671

14. Enter Commands TL1 Command Reference Manual

Port 7-14: 8xSFP for <=2.5G OCn/STMn clients

ODU1 and demapped OC48/STM16/STSn with the index range in between 7-14 (for example, ODU1-
<shelf>-<slot>-<99>-<7-14>)
ODU2 and demapped OC192/STM64/STSn with the index range in between 1-2 (for example, ODU2-
<shelf>-<slot>-<99>-<1-2>)
TTPSTSn/VCn with the port group number 1 (for example, TTPSTSn-<shelf>-<slot>-<99>-<1>-<1-
192>)
- The second port group (connecting with 2nd Framer):
Port 3-4: 2xSFP+ for 10G OC192/STM64 clients
Port 15-22: 8xSFP for <=2.5G OCn/STMn clients
ODU1 and demapped OC48/STM16/STSn with the index range in between 15-22 (for example, ODU1-
<shelf>-<slot>-<99>-<15-22>)
ODU2 and demapped OC192/STM64/STSn with the index range in between 3-4 (for example, ODU2-
<shelf>-<slot>-<99>-<3-4>)
TTPSTSn with the port group number 2 (for example, TTPSTSn-<shelf>-<slot>-<99>-<2>-<1-192>)
- The third port group (connecting with 3rd Framer):
Port 5-6: 2xSFP+ for 10G OC192/STM64 clients
Port 23-30: 8xSFP for <=2.5G OCn/STMn clients
ODU1 and demapped OC48/STM16/STSn with the index range in between 23-30 (for example, ODU1-
<shelf>-<slot>-<99>-<23-30>)
ODU2 and demapped OC192/STM64/STSn with the index range in between 5-6 (for example, ODU2-
<shelf>-<slot>-<99>-<5-6>)
TTPSTSn/VCn with the port group number 3 (for example, TTPSTSn-<shelf>-<slot>-<99>-<3>-<1-
192>)
The SSM-2S module support totally 40G SONET/SDH Framer capacity for each port group, with
16x2.5G Framer slice resource shared by front panel physical port or OCn/STMn facility demapped
from ODUk (k=1/2) on backplane. For different OCn/STMn facility the Framer slice resource needed is
defined as below:
- OC192/STM64 need 4x 2.5G Framer slices;
- OC48/STM16/OC12/STM4/OC3/STM1 need 1x 2.5G Framer slice.

• The system denies the provision of OC/STMn physical facility on front panel for a port group if the total
bandwidth include front panel physical port and the bandwidth on backplane that is reserved by
OTN_MAP_GROUP and EOS_MAP_GROUP for a port group would over 40G (in equivalent to 4x 192
STS1), with the exception that:
- For OC3/OC12/OC48/STM1/STM4/STM16, total facility number does not exceed 4 for this case
because with OTN_MAP_GROUP and EOS_MAP_GROUP configured that consumes 30G bandwidth
so only 10G available for front panel but the system only released 4x 2.5G SDH/SONET Framer slice
so only max. 4 facilities (OC3/OC12/OC48/STM1/STM4/STM16) on front panel could be provisioned.

• The system denies the provision of OCn/STMn physical facility that would consume more than 12x 2.5G
Framer slices when only EOS_MAP_MAP configured (EOS_MAP_GROUP configured consumes 10G
bandwidth but 30G available for front panel however system only released 12x 2.5G SDH/SONET
Framer slice for use).

• On mTera SSM-2S module that is configured as working module involving an EPG protection group or
when no EPG configured for that module, follow the order of first explicitly create OC48/STM16/OC192/
STM64 facility associated with virtual port 99 on backplane and then the ODU1/ODU2 entity could be
provisioned.

• On mTera SSM-2S working module that is in EPG group, provision OCn/STMn/STSn facility/entity
associated with virtual port 99 on backplane would implicitly provision OCn/STMn/STSn facility/entity
associated with virtual port 99 on backplane on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to provision OCn/STMn/STSn
facility/entity associated with virtual port 99 on backplan would be denied.

Page 30-672 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• If an ODU exists for the port with OPUCONFIG=INTACT or MUX, then the sytem denies an attempt to
enter a facility on the same port.

Command Format
ENT-
{fac_type}:[tid]:{fac_aid}:ctag:::[,ALMPF=<almProfile>][,EXPTRC=<exptrc>][,MONTR
C=<montrc>][,PROT=<protection>][,AISTYPE=<AIStype>][,SSMSUPP=<ssmSupported>][,QL
=<qualityLevelOverride>][,CBRMAP=<cbrMap>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters Applicability When Entering the Command

Table 14.50
STS1/
STS3C/
STS12C/
STS48C
PARAMETERa DEFb OCn STS192C STMn

ALMPF ND O O O

PMPF ND O

TRC ND Od Od

EXPTRC ND O O

MONTRC ND O O

PROT ND Oe Oe
d d
SFTHRES ND O O O

SDTHRES ND Od O Od

AISTYPE ND Of Of
d d
SSMSUPP ND O O

QL ND Od Od

CBRMAP ND Oc Oc

TRANSPARENT ND O O

PST PD O O O

76.MTFP50/30, Rev B January 2018 Page 30-673

14. Enter Commands TL1 Command Reference Manual

Table 14.50 (Continued)

STS1/
STS3C/
STS12C/
STS48C
PARAMETERa DEF
b
OCn STS192C STMn
a. M indicates a MANDATORY parameter and O indicates an OPTIONAL
parameter.
b. ND: Name Defined or PD: Position Defined.
c. Applicable to OC48/STM16/OC192/STM64 on OSM-1S/OSM-2S,
and to OC48/STM16/OC192/STM64 associated with virtual port on
backplane of SSM-2S.
d. Not apply to OSM-1S/OSM-2S, apply to SSM-2S only.
e. Not apply to OSM-1S and OCn/STMn associated with virtual port on
backplane of SSM-2S.
f. Not apply to SSM-2S.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.51 ENT-OCn/STMn/STSn/STSnCNV/STSnT/TGBEP Parameters

Parameter Value(s) Definition
fac_aid OC12-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

exptrc One to 15 alphanumeric characters Specifies the expected trail trace identification (J0).
A value of "" means that there is no Trail Trace Id expected.

Refer to section 2 for the applicable characters.

Page 30-674 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.51 ENT-OCn/STMn/STSn/STSnCNV/STSnT/TGBEP Parameters (Continued)

Parameter Value(s) Definition
montrc ENABLED-NOAIS Specifies the monitored J0 trace identification mode.
DISABLED - Enter ENABLED-NOAIS to enable J0 monitoring coming from
Default: DISABLED the port side but not insert AIS when there is a trace mismatch
(signal is passed through intact).
- Enter DISABLED to disable J0 monitoring.

protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.
Default: NO
Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending an maintenance
signal (for example, AIS) when there is a signal failure detected
on the line side of a transponder.

Setting the value to NO does not shut down the laser on the line
or port side of the transponder. When this value is set standard
maintenance signaling is used.

This parameter applies only to OCn/STMn facilities supported

by OSM-2S.

AIStype AISL When a network failure occurs, AIS is transmitted out of the
GENAIS OCn port to suppress subsequent LOS or LOF alarms on
Default: AISL SONET connected equipment.
There are two types of signals which may be inserted. A setting
of AISL inserts client based AIS-L out of the port per GR.253. A
setting of GENAIS inserts a generic AIS signal based on a PN-
11 sequence per ITU-T G.709.

ssmSupported YES It is used to indicate whether this facility supports SSM

NO generation or not.
Default: YES Yes: the transmitted QL is based on synchronization selection
process. (default)
NO: the transmitted QL of the facility is forced to DNU/DUS.

qualityLevelOv DISABLED It is used to overwrite the incoming QL by operator, When set to

erride PRS 'disable', the system uses the SSM value received in the
ST2 synchronization status message.
TNC DISABLED (default)
ST3E QL value:
ST3 Option II: QL-PRS, QL-ST2, QL-TNC, QL-ST3E, QL-ST3, QL-
SMC SMC, QL-ST4, QL-PROV, QL-DUS
ST4 Option I: QL-PRC, QL-SSU-A, QL-SSU-B, QL-SEC, QL-DNU
PROV
DUS
PRC
SSU-A
SSU-B
SEC
DNU
Default: DISABLED

cbrMap SYNC Specifies the mapping type of the constant bit rate signal into an
ASYNC OPU, either bit-synchronously (SYNC) or asynchronously
Default: SYNC (ASYNC).

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

76.MTFP50/30, Rev B January 2018 Page 30-675

14. Enter Commands TL1 Command Reference Manual

Table 14.51 ENT-OCn/STMn/STSn/STSnCNV/STSnT/TGBEP Parameters (Continued)

Parameter Value(s) Definition
trc One to 15 alphanumeric characters Specifies the sent trail trace identification (J0).
A value of "" means that there is no Trail Trace Id sent.
Refer to section 2 for the applicable characters.

Example 1:Provision OC12 Facility on Transponder

ENT-OC12:CORIANT1:OC12-20-5-1:AM0074:::PROT=YES:IS;

Example 2: Provision STS1 Termination on SSM-2S

ENT-STS1:CORIANT1:STS1-20-4-9-2:ctag:::ALMPF=03,PMPF=10,SFTHRESH=10E-
5,SDTHRESH=10E-8:OOS-MA;

Example 3: Provision STM1 Facility on SSM-2S

ENT-STM4:CORIANT1:STM4-20-13-
4:AM0074:::[ALMPF=99][,TRC=<trc>][,EXPTRC=<exptrc>][,MONTRC=<montrc>][,PROT=<pro
tection>]:IS;

Example 10: Provision OC48 Facility as System timing source, without QL overrided in
ingress side and without force QL in egress side
Configure the OC-48 port's output SSM information to be from system
synchronization process, and incoming QL is not overrided.

ENT-OC48:CORIANT1:OC48-20-1-4:ctag:::SSMSUPP=YES, QLOVERRIDE=DISABLED;

Example 11: Provision STM16 Facility as System timing source, with QL overrided in
ingress side and with force QL in egress side
Configure the STM16 port's output SSM information to be forced as DNU, and incoming
QL is overrided with QL-SEC:

ENT-STM16:CORIANT1:STM16-20-1-4:ctag:::SSMSUPP=NO, QLOVERRIDE=QL-SEC;

Example 4: Provisioning SONET Facility demapped from ODUk on SSM-2S

When provisioning SONET facilities that are demapped to an ODUk either
asynchronously or synchronously using the CBRMAP parameter. In this example
asynchronously mapping is used so ODU2's PT=0x02, CBRMAP=ASYNC for OC192.

ENT-ODU2:CORIANT7100:ODU2-20-1-99-1:ctag:::OPUCONFIG=CLIENT, PT=0x02:IS;

ENT-OC192:CORIANT7100:OC192-20-1-99-1:ctag:::CBRMAP=ASYNC;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ED-{X}
RTRV-{X}

Page 30-676 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-ODUF

Command Changes Since Previous Feature Package

• Added support of ODUF mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ENT-ODUF commands instruct the network element (NE) to provision an ODUflex (ODUF) entity.

The command creates the ODUflex association to a mapped client port or defines the multiplexing association to an
ODUk based on the specified ODUF AID.

The ODUF facility can be provisioned on the following transponders:

• OSM-2C

• OSM-2S

• OSM-4C

• OSM-4F

• OSM-4S

• OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• TRIBSLOT must be specified when ODUF is muxed to an ODUk.

• An attempt to enter an ODUF with TribID specified in AID is denied if the supporting ODUk is
crossconnected.

• When provisioning an ODUflex, if a client exists with the same port number, then the ODUflex
provisioning is denied if the EXPRATE of the ODUF does not match the EXPRATE of the GOPT or the
rate of the specified GOPT SIGTYPE.

• When provisioning an ODUflex, if the AID entered does not include the TribID, then the system denies
an attempt to set the GFPTS.

• When supported within an OTUk/OCH-P facility, the supporting ODUk must be provisioned before the
supported ODUF can be entered.

• The specified Tributary Port ID within the ODUF AID is not required to match any of the values entered
for TRIBSLOT.

• The specified Tributary Port ID within the ODUF AID cannot be the same as the Tributary Port ID used
by another ODUF or ODU0 within the same ODU2. This is due to the fact that the ODUF and ODU0
use the same multiplexing structure within the ODUk and therefore share the same namespace for
tributary port values.

76.MTFP50/30, Rev B January 2018 Page 30-677

14. Enter Commands TL1 Command Reference Manual

• The specified Tributary Port ID within the ODUF AID cannot be the same as the Tributary Port ID used
by another ODUF, ODU0. or ODU2E within the same ODU3. This is due to the fact that the ODUF,
ODU0, and ODU2E use the same multiplexing structure within the ODU3 and therefore share the same
namespace for tributary port values.

• The specified Tributary Port ID within the ODUF AID cannot be the same as the Tributary Port ID used
by another ODUj within the same ODU4. This is due to the fact that all ODUj use the same multiplexing
structure within the ODU4 and therefore share the same namespace for tributary port values.

• EXPRATE must be used to specify the rate of the supported client when the ODUflex supports a CBR
client.

• GFPTS must be used to specify the ODUflex(GFP) rate by entering the number of 1.25G Tributary
Slots when the ODUflex supports a GFP client. The supported ODUflex(GFP) rate is GFPTS x
1,249,177.230 kbit/s when GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s when GFPTS = 9 to 32, or
GFPTS x 1,301,467.133 kbit/s when GFPTS = 33 to 80.

• The system denies an attempt to specify a value for EXPRATE and GFPTS at the same time.

• When EXPRATE is entered, the number of values entered for TRIBSLOT must equal to the number of
tributary slots required for the specified ODUflex rate, or the command is denied. The required number
of TRIBSLOT values is equal to:
Ceiling(ODUflex(CBR) nominal bit rate/ 1,249,409.620 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU2.
Ceiling(ODUflex(CBR) nominal bit rate/ 1,254,703.729 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU3.
Ceiling(ODUflex(CBR) nominal bit rate/ 1,301,709.251 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU4.

• When GFPTS is entered, the number of values entered for TRIBSLOT must equal the value of GFPTS,
or the command is denied.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• An attempt to set OPUCONFIG=MUX is denied for an ODUF.

Command Format
ENT-ODUF:[tid]:<fac_aid>:ctag:::
{EXPRATE=<ExpClientRate>|GFPTS=<nmbrOfTS_GFPclient>}[,TRIBSLOT=<tribslot>][,ALMP
F=<almProfile>][,PMPF=<pmProfile>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_th
reshold>][,DMSOURCE=<DM_source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EX

Page 30-678 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

PSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMD
EF=<TIMDefinition>][,MONTRC=<montrc>][,PT=pt][,OPUCONFIG=<opu_config>][:<editabl
ePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.52 ENT-ODUF Parameters

Parameter Value(s) Definition
fac_aid ODUF-20-[1-16]-[1-40]-[1-80], ODUF- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-20]-[B,C][1-80]-[1-32], ODU4TribPort][-SupportODU ODUTribPort]-TribID
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

ExpClientRate A fixed integer value between Specifies the expected signal rate of the constant bit rate
2488022 and 103688578. mapped client within the payload of the ODUflex. This value is
used by the system to determine the ODUflex(CBR) rate. The
number is specified in Kbps.

A fixed integer value between 2488022 and 9952261 when the

ODUF is supported by an OSM-2S.
A fixed integer value between 2488022 to 103688578 when the
ODUF is supported by an OSM-2C.

nmbrOfTS_GF [1-80] Specify the ODUflex(GFP) rate by entering the number of 1.25G
Pclient Tributary Slots when the ODUflex supports a GFP client. The
supported ODUflex(GFP) rate is GFPTS x 1,249,177.230 kbit/s
when GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s when
GFPTS = 9 to 32, or GFPTS x 1,301,467.133 kbit/s when
GFPTS = 33 to 80.

Range is [1-8] for an ODUF mapped to an ODU2.

Range is [1-32] for an ODUF mapped to an ODU3.
Range is [1-80] for an ODUF mapped to an ODU4.

76.MTFP50/30, Rev B January 2018 Page 30-679

14. Enter Commands TL1 Command Reference Manual

Table 14.52 ENT-ODUF Parameters (Continued)

Parameter Value(s) Definition
tribslot [1-80] Specifies a single value, or a group of values, or a range of
values identifying which tributary slots is used within the
supporting ODUk/ODUj to carry the ODUF.

A range of {1 to 8} is used for mapping to an ODU2 with 1.25G

tributary slots. Decide which tributary slots within the ODU2 to
use for a particular ODUF.
A range of {1 to 32} is used for mapping to an ODU3 with 1.25G
tributary slots. Decide which tributary slots within the ODU3 to
use for a particular ODUF.
A range of {1 to 80} is used for mapping to an ODU4. Decide
which 1.25G tributary slots within the ODU4 to use for a
particular ODUF.

Use & for grouping.

Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODUF
entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-850910] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Range is 1-81672 for OSM-2S.

Range is 1-850910 for OSM-2C.

The default threshold level is 15% of the total blocks present in a

given ODUflex, based on the ODUflex rate. The system
automatically calculates and sets the default integer value
based on the 15% threshold.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Page 30-680 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.52 ENT-ODUF Parameters (Continued)

Parameter Value(s) Definition
montrc ENABLED-NOAIS Specifies the monitored trace identification mode.
DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
Default: AUTO ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

pt AUTO Specifies the transmitted Payload Type hexadecimal value.

Default: AUTO Typical Values:
- AUTO (implies the pt is set based on the connected facility
type). If a PT value is not assigned or AUTO is configured to the
PT value upon mapping to a port, the ODUF PT value is set to
the appropriate value by the system. When the ODUF is
unmapped from a port, the ODUF PT value returns to AUTO.

76.MTFP50/30, Rev B January 2018 Page 30-681

14. Enter Commands TL1 Command Reference Manual

Example
ENT-ODUF:CORIANT1:ODUF-20-2-3-1:AM0074:::EXPRATE=4250000,TRIBSLOT=4,ALMPF=20:IS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODUF
ED-ODUF
RTRV-ODUF

Page 30-682 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-ODU0

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ENT-ODU0 commands instruct the network element (NE) to provision an ODU0 entity.

The ODU0 facility can be provisioned on the following transponders:

• OSM-2S

• OSM-2C

• OSM-1S

• OSM-4C

• OSM-4F

• OSM-4S

• OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• TRIBSLOT must be specified when ODU0 is muxed to an ODUk.

• TRIBSLOT value must be equal to the TribID value within the AID when the ODU0 is multiplexed into
an ODU1.

• An attempt to enter an ODU0 with TribID specified in AID is denied if the supporting ODUk is cross-
connected and has a TXSAPI, TXDAPI, or TXOPER that is not empty.

• Supporting ODUk must be provisioned before the supported ODU0 can be entered.

• The DMSOURCE parameter is only applicable to the OSM-2C, OSM-2S, OSM-4C, OSM-4F, OSM-4S
and OSM-5C.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• An attempt to provision ODU0 is denied when the provisioned ODU0 entity number exceeds 16 on port
1-16 of OSM-1S (port 1-16 as one group). If both ODU0 and ODU1 existing (M: ODU0 number, N:ODU1
number), M+2N is not greater than 16.

• An attempt to provision ODU0 is denied when the provisioned ODU0 entity number exceeds 16 on port
17-32 of OSM-1S (port 17-32 as the other group). If both ODU0 and ODU1 existing (M: ODU0 number,
N:ODU1 number), M+2N is not greater than 16.

76.MTFP50/30, Rev B January 2018 Page 30-683

14. Enter Commands TL1 Command Reference Manual

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• An attempt to set OPUCONFIG=MUX is denied for an ODU0.

• On mTera, an attempt to provision ODU0 is denied when the port facility is not provisioned yet.

• An attempt to provision ODU0 under ODU1 is denied on OSM-2S since it supports only one stage ODU
Mux/Demux.

• For OSM-1S, if an ODU0 entity exists on port 1 through 16 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU0 terminations †associated with ports 1-16 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, if an ETH entity exists on any port 1 through 16, then the system denies an attempt to
create or modify any ODU0 terminations †associated with ports 1-16 to have OPUCONFIG of INTACT,
MUX, or CLIENT.

• For OSM-1S, if an ODU0 entity exists on port 17 through 32 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU0 terminations †associated with ports 17-32 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, if an ETH entity exists on any port 17 through 32, then the system denies an attempt to
create or modify any ODU0 terminations †associated with ports 17-32 to have OPUCONFIG of
INTACT, MUX, or CLIENT.

Command Format
ENT-ODU0:[tid]:<fac_aid>:ctag:::
[TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<pmProfile>][,DEGM=<degrade_int
erval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_source>][,EXPOPER=<ExpOperato
r>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI=<TxDAP
I>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MONTRC=<montrc>][,OPUCONFIG=<opu
_config>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Page 30-684 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.53 ENT-ODU0 Parameters

Parameter Value(s) Definition
fac_aid ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]

tribslot [1-8] Specifies the tribslot that is used to carry the ODU0 within its
supporting ODUk/ODUj. Decide which tributary slot within the
ODUk/ODUj to use for a particular ODU0.
Range is [1-2] for mapping an ODU0 into an ODU1.
Range is [1-8] for mapping an ODU0 into an ODU2.
Range is [1-32] for mapping an ODU0 into an ODU3.
Range is [1-80] for mapping an ODU0 into an ODU4.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU0
Default: 99 entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-10168] Indicates the threshold number of block errors at which a one
hold Default: 1526 second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-685

14. Enter Commands TL1 Command Reference Manual

Table 14.53 ENT-ODU0 Parameters (Continued)

Parameter Value(s) Definition
montrc ENABLED-NOAIS Specifies the monitored trace identification mode.
DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
Default: DISABLED consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
Default: AUTO ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS The system default is IS.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

Example
Create a ODU0 contained in ODU2-20-1-1-2 on a OSM2C

ENT-ODU0:CORIANT1:ODU0-20-1-1-B2-1:AM0074::::IS;

Create a ODU0 contained in ODU3-20-1-1-2 on a OSM2C

ENT-ODU0:CORIANT1:ODU0-20-1-1-C1-1:AM0074::::IS;

Page 30-686 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU0
ED-ODU0
RTRV-ODU0

76.MTFP50/30, Rev B January 2018 Page 30-687

14. Enter Commands TL1 Command Reference Manual

ENT-ODU1

Command Changes Since Previous Feature Package

• Added support of ODU1 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ENT-ODU1 commands instruct the network element (NE) to provision an ODU1 entity.

The ODU1 facility can be provisioned on the following transponders:

• OSM-2C

• OSM-2S

• OSM-1S

• SSM-2S

• OSM-4C

• OSM-4F

• OSM-4S

• OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• Supporting ODUk must be provisioned before the supported ODU1 can be entered.

• ODU1 is always aligned to virtual port 99 in the AID when created on a SSM-2S.

• An attempt to set the PT is denied if the ODUk is cross-connected and the client being mapped is not
equal to a non-OTU AID.

• TRIBSLOT must be specified when ODU1 is muxed to an ODUk.

• An attempt to set the PT is denied if the ODUk is unterminated.

• An attempt to set PT is denied if the ODUk is cross-connected and the client being mapped is the OTUk.

• An attempt to provision ODU1 is denied when the provisioned ODU1 entity number exceeds 8 on port
1-16 of OSM-1S (port 1-16 as one group). If both ODU0 and ODU1 existing (M: ODU0 number, N:ODU1
number), M+2N is not greater than 16.

• An attempt to provision ODU1 is denied when the provisioned ODU1 entity number exceeds 8 on port
17-32 of OSM-1S (port 17-32 as the other group). If both ODU0 and ODU1 existing (M: ODU0 number,
N:ODU1 number), M+2N is not greater than 16.

Page 30-688 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• On SSM-2S, there are three port groups corresponding to three independent physical Framers. Each
port group support max. 20G OTN mapping capacity in the combination of any ODU2 or ODU1 when
the parameter OTN_MAP_GROUP for that port group checked per the provision of the module. The
system denies the provision of ODU2 entity if the total ODUk (k=1/2) bandwidth would exceed 20G. The
pluggable interfaces (6xSFP+ and 24xSFP) and the entity provisioned (ODU1/ODU2, VCG) on
backplane is grouped in the way below:
- The first port group (connecting with 1st Framer):
Port 1-2: 2xSFP+ for 10G OC192/STM64 clients
Port 7-14: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 7-14 (for example,
ODU1-<shelf>-<slot>-<99>-<7-14>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 1-2 (for example,
ODU2-<shelf>-<slot>-<99>-<1-2>)
TTPSTSn/VCn with the port group number 1 (for example, TTPSTSn-<shelf>-<slot>-<99>-<1>-<1-
192>)
- The second port group (connecting with 2nd Framer):
Port 3-4: 2xSFP+ for 10G OC192/STM64 clients
Port 15-22: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 15-22 (for example,
ODU1-<shelf>-<slot>-<99>-<15-22>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 3-4 (for example,
ODU2-<shelf>-<slot>-<99>-<3-4>)
TTPSTSn/VCn with the port group number 2 (for example, TTPSTSn-<shelf>-<slot>-<99>-<2>-<1-
192>)
- The third port group (connecting with 3rd Framer):
Port 5-6: 2xSFP+ for 10G OC192/STM64 clients
Port 23-30: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 23-30 (for example,
ODU1-<shelf>-<slot>-<99>-<23-30>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 5-6 (for example,
ODU2-<shelf>-<slot>-<99>-<5-6>)
TTPSTSn/VCn with the port group number 3 (for example, TTPSTSn-<shelf>-<slot>-<99>-<3>-<1-
192>)

• The DMSOURCE parameter is only applicable to the OSM-2C, OSM-2S, OSM-4C, OSM-4F, OSM-4S,
OSM-5C and SSM-2S.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

76.MTFP50/30, Rev B January 2018 Page 30-689

14. Enter Commands TL1 Command Reference Manual

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• OPUCONFIG applies only to the OSM-1S, OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S and OSM-
5C.

• The system denies an attempt to set OPUCONFIG=MUX on an ODU1 that is mapped to an ODU2 on
OSM-1S.

• The system denies an attempt to set OPUCONFIG=MUX on an ODU1 on the OSM-2C.

• On mTera OSM modules, an attempt to provision ODU1 is denied when the port facility is not
provisioned yet.

• On mTera SSM-2S module that is configured as working module involving an EPG protection group or
when no EPG configured for that module, follow the order of first explicitly create OC48/STM16 facility
and then the ODU1 entity could be provisioned.

• On mTera SSM-2S working module that is in EPG group, provision ODU1 facility would implicitly
provision ODU1 facility on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to provision ODU1 facility would
be denied.

• For OSM-1S, if an ODU0 entity exists on port 1 through 16 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU1 terminations †associated with ports 1-16 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, if an ETH exists on any port 1 through 16, then the system denies an attempt to create or
modify any ODU1 terminations †associated with ports 1-16 to have OPUCONFIG of INTACT, MUX, or
CLIENT.

• For OSM-1S, if an ODU0 entity exists on port 17 through 32 with SWITCHTYPE=PKT, then the system
denies an attempt to create or modify any ODU1 terminations †associated with ports 17-32 to have
OPUCONFIG of INTACT, MUX, or CLIENT.

• For OSM-1S, If an ETH entity exists on any port 17 through 32, then the system denies an attempt to
create or modify any ODU1 terminations †associated with ports 17-32 to have OPUCONFIG of
INTACT, MUX, or CLIENT.

Command Format
ENT-ODU1:[tid]:<fac_aid>:ctag:::
[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<pmProfile>][,DEGM=<degrade_in
terval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_source>][,EXPOPER=<ExpOperat
or>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI=<TxDA
PI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MONTRC=<montrc>][,OPUCONFIG=<op
u_config>][:<editablePrimaryState>];

Page 30-690 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.54 ENT-ODU1 Parameters

Parameter Value(s) Definition
fac_aid ODU1-20-[1-16]-[1-32], ODU1-20-[1- EntityID-ShelfID-SlotID--{PortID[-SupportingODU4
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]

tribslot [1-80] Specifies a single value, or a group of values, or a range of

values identifying which tributary slots is used within the
supporting ODUk/ODUj to carry the ODU1.
Example: TRIBSLOT=1
TRIBSLOT is set to a group of two values in the range of 1 to 8
for mapping to an ODU2 with 1.25G Tributary Slots on the OSM-
2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C.
TRIBSLOT is set to a group of two values in the range of 1 to 32
for mapping to an ODU3 with 1.25G Tributary Slots on the OSM-
2C, OSM-4C, OSM-4F, OSM-5C.
TRIBSLOT is set to a group of two values in the range of 1 to 80
for mapping to an ODU4 on the OSM-2C, OSM-4C, OSM-4F,
OSM-5C.
Example: TRIBSLOT=1&5

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU1
Default: 99 entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-20421] Indicates the threshold number of block errors at which a one
hold Default: 3064 second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-691

14. Enter Commands TL1 Command Reference Manual

Table 14.54 ENT-ODU1 Parameters (Continued)

Parameter Value(s) Definition
ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
Default: DISABLED consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
Default: AUTO ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS The system default is IS.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

Page 30-692 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Example: Provisioning ODU1 Facility on an OSM module

ENT-ODU1:CORIANT1:ODU1-20-2-5-
1:AM0074:::EXPOPER=Coriant1NorthEast,EXPDAPI=NorthEast09,EXPSAPI=NorthEast09,TIM
EDEF=SAPI_DAPI_OPER,MONTRC=ENABLED-NOAIS,TRIBSLOT=1&5:IS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU1
ED-ODU1
RTRV-ODU1

76.MTFP50/30, Rev B January 2018 Page 30-693

14. Enter Commands TL1 Command Reference Manual

ENT-ODU2

Command Changes Since Previous Feature Package

• Added support of ODU2 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ENT-ODU2 commands instruct the network element (NE) to provision an ODU2 entity.

The ODU2 facility can be provisioned on the following transponders:

• OSM-2C

• OSM-2S

• SSM-2S

• OSM-4C

• OSM-4F

• OSM-4S

• OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The system denies a connection of a facility to an ODUk with a pre-set PT value that is incompatible.

• An attempt to provision an ODU2 is denied in mTera shelf if the provisioned TGLAN of the same port
with TRANSMAP not equal to FRAME_STD/PREAMBLE.

• The attempt to create the ODU2 is denied if the specified CLOCKTYPE of the ODU2 does not match
the TRANSMAP of TGLAN on the port or port facility type.

• An attempt to set the PT is denied if the ODUk is unterminated.

• An attempt to set PT is denied if the ODUk is cross-connected and the client being mapped is the OTUk.

• On the OSM-2S/SSM-2S, if a PT value is assigned to the ODU2

1. On mapping to a port, PT is validated against the facility type (for example, it is not possible assign
PT value of 0x80 when the mapped client is STM64).
2. On unmapping from a port, the PT value remains as assigned and not revert to AUTO as in the default
case.
Note that there is a special case for assignment of PT=0x2 (async) and PT=0x3 (sync) when the user
assigns a PT of 0x2 or 0x3 and maps to a SONET/SDH signal type.
1. If the CBRMAP is changed between ASYNC and SYNC using the ED-OC192/ED-STM64, the ODUk
PT value changes with the CBRMAP parameter.
2. On unmapping from a port, the PT value remains as the last assigned PT value.
3.On unmapping from a client facility, initial AUTO type of PT returns back to AUTO.

• The DMSOURCE parameter is only applicable to the OSM-2C, OSM-2S, OSM-4C, OSM-4F, OSM-4S,
OSM-5C and SSM-2S.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

Page 30-694 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• The payload type parameter (PT) is not supported on the OSM-2C/OSM-4C/OSM-4F/OSM-5C module
for ODU2 provisioning.

• DEGM and DEGTHR are applicable to the modules supported by mTera.

• The attempt to create the ODU2 is denied if the number of tributary slots assigned to the ODU2 is not
equal to the required tributary slot number for an ODU2 with the provisioned CLOCKTYPE.

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk/OCH-P/OCH-OS.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• On SSM-2S, there are three port groups corresponding to three independent physical Framers. Each
port group support max. 20G OTN mapping capacity in the combination of any ODU2 or ODU1 when
the parameter OTN_MAP_GROUP for that port group checked per the provision of the module. The
system denies the provision of ODU1 entity if the total ODUk (k=1/2) bandwidth would exceed 20G. The
pluggable interfaces (6xSFP+ and 24xSFP) and the entity provisioned (ODU1/ODU2, VCG) on
backplane is grouped in the way below:
- The first port group (connecting with 1st Framer):
Port 1-2: 2xSFP+ for 10G OC192/STM64 clients
Port 7-14: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 7-14 (for example,
ODU1-<shelf>-<slot>-<99>-<7-14>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 1-2 (for example,
ODU2-<shelf>-<slot>-<99>-<1-2>)
TTPSTSn/VCn with the port group number 1 (for example, TTPSTSn-<shelf>-<slot>-<99>-<1>-<1-
192>)
- The second port group (connecting with 2nd Framer):
Port 3-4: 2xSFP+ for 10G OC192/STM64 clients
Port 15-22: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 15-22 (for example,
ODU1-<shelf>-<slot>-<99>-<15-22>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 3-4 (for example,

76.MTFP50/30, Rev B January 2018 Page 30-695

14. Enter Commands TL1 Command Reference Manual

ODU2-<shelf>-<slot>-<99>-<3-4>)
TTPSTSn/VCn with the port group number 2 (for example, TTPSTSn-<shelf>-<slot>-<99>-<2>-<1-
192>)
- The third port group (connecting with 3rd Framer):
Port 5-6: 2xSFP+ for 10G OC192/STM64 clients
Port 23-30: 8xSFP for <=2.5G Ocn/STMn clients
ODU1 and demapped OC48/STM16/STS/VCn with the index range in between 23-30 (for example,
ODU1-<shelf>-<slot>-<99>-<23-30>)
ODU2 and demapped OC192/STM64/STS/VCn with the index range in between 5-6 (for example,
ODU2-<shelf>-<slot>-<99>-<5-6>)
TTPSTSn/VCn with the port group number 3 (for example, TTPSTSn-<shelf>-<slot>-<99>-<3>-<1-
192>)

• OPUCONFIG applies only to the OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-5C and SSM-2S.

• On mTera OSM modules, an attempt to provision ODU2 is denied when the port facility is not
provisioned yet.

• On mTera SSM-2S module that is configured as working module involving an EPG protection group or
when no EPG configured for that module, follow the order of first explicitly create OC192/STM64 facility
and then the ODU2 entity could be provisioned.

• On mTera SSM-2S working module that is in EPG group, provision ODU2 facility would implicitly
provision ODU2 facility on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to provision ODU2 facility would
be denied.

Command Format
ENT-
ODU2:[tid]:<fac_aid>:ctag:::[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<p
mProfile>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_
source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER
=<txOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MON
TRC=<montrc>][,PT=<pt>][,OPUCONFIG=<opu_config>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.55 ENT-ODU2 Parameters

Parameter Value(s) Definition
fac_aid ODU2-20-[1-16]-[1-40], ODU2-20-[1- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]

Page 30-696 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.55 ENT-ODU2 Parameters (Continued)

Parameter Value(s) Definition
tribslot [1-80] Specifies a group of values, or a range of values identifying
which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU2. Decide which tributary slots within the ODUk to
use for a particular ODU2.
Range is [1-32] for mapping an ODU2 into an ODU3.
Range is [1-80] for mapping an ODU2 into an ODU4.
Use & for grouping.
Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU2
Default: 99 entity.
Note: Default value is 99.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-82026] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 82026, default of 12304 (ODU2)
1 to 84986, default of 12748 (ODU2e)

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

TxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

TxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-697

14. Enter Commands TL1 Command Reference Manual

Table 14.55 ENT-ODU2 Parameters (Continued)

Parameter Value(s) Definition
TIMDefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER
mismatches).

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
Default: DISABLED consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

pt AUTO Specifies the transmitted Payload Type hexadecimal value.

0x02 Typical Values:
0x03 - AUTO (implies the pt is set based on the connected facility
0x05 type). If a PT value is not assigned or AUTO is configured to the
0x09 PT value upon mapping to a port, the ODU2 PT value is set to
0x10 the appropriate value by the system. When the ODU2 is
0x11 unmapped from a port, the ODU2 PT value returns to AUTO.
0x80 - 0x09, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x81 TRANSMAP=PREAMBLE payload
0x82 - 0x03, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x83 TRANSMAP=LINE_FS payload
0x84 - 0x05 for a TGLAN with TRANSMAP=FRAME_STD payload
0x85 - 0x03 for an OC192/STM64 with CBRMAP=SYNC payload
0x86 - 0x02 for an OC192/STM64 with CBRMAP=ASYNC payload
0x87
0x88 Note that the Payload Type value cannot be changed from the
0x89 typical value if a TGLAN with TRANSMAP=FRAME_STD or for
0x8A an OC192/STM64 is connected to the ODU2.
0x8B
0x8C
0x8D
0x8E
0x8F
Default: AUTO

Page 30-698 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.55 ENT-ODU2 Parameters (Continued)

Parameter Value(s) Definition
opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
Default: AUTO ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS The system default is IS.

Example
This following command creates an ODU2 on a OSM-2S.
ENT-ODU2:CORIANT1:ODU20-2-2-1:AM0074::::IS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU2
ED-ODU2
RTRV-ODU2

76.MTFP50/30, Rev B January 2018 Page 30-699

14. Enter Commands TL1 Command Reference Manual

ENT-ODU2E

Command Changes Since Previous Feature Package

• Added support of ODU2E mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The ENT-ODU2E commands instruct the network element (NE) to provision an ODU2E entity.

The ODU2E facility can be provisioned on the following transponders:

• OSM-2S

• OSM-2C

• OSM-4C

• OSM-4F

• OSM-4S

• OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type

• The attempt to create an ODU2E is denied if the CLOCKTYPE of the associated OTU2/OCH-P port is
not set to OVRCLK_FS.

• The attempt to create an ODU2E is denied if the TRANSMAP of a TGLAN on the associated physical
port is not set to LINE_FS.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk/OCH-P.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

Page 30-700 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

• On mTera, an attempt to provision ODU2E is denied when the port facility is not provisioned yet.

Command Format
ENT-
ODU2E:[tid]:<fac_aid>:ctag:::[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<
pmProfile>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM
_source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPE
R=<txOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MO
NTRC=<montrc>][,PT=pt][,OPUCONFIG=<opu_config>][:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.56 ENT-ODU2E Parameters

Parameter Value(s) Definition
fac_aid ODU2E-20-[1-16]-[1-4], ODU2E-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]

tribslot [1-80] Specifies a group of values, or a range of values, identifying

which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU2E. Decide which tributary slots within the ODUk
to use for a particular ODU2E.
Range is [1-32] for mapping an ODU2E into an ODU3. Nine
tribslot values must be entered for an ODU2E mapped into an
ODU3.
Range is [1-80] for mapping an ODU2E into an ODU4.
Eight tribslot values must be entered for an ODU2E mapped into
an ODU3.
Use & for grouping.
Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU2
Default: 99 entity.
Note: Default value is 99.

76.MTFP50/30, Rev B January 2018 Page 30-701

14. Enter Commands TL1 Command Reference Manual

Table 14.56 ENT-ODU2E Parameters (Continued)

Parameter Value(s) Definition
degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-84986] Indicates the threshold number of block errors at which a one
hold Default: 12748 second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
Default: DISABLED consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
Default: AUTO ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS The system default is IS.

Page 30-702 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.56 ENT-ODU2E Parameters (Continued)

Parameter Value(s) Definition
txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER
mismatches).

pt AUTO Specifies the transmitted Payload Type hexadecimal value.

0x03 Typical Values:
0x10 - AUTO (implies the pt is set based on the connected facility
0x11 type). If a PT value is not assigned or AUTO is configured to the
0x80 PT value upon mapping to a port, the ODU2E PT value is set to
0x81 the appropriate value by the system. When the ODU2E is
0x82 unmapped from a port, the ODU2E PT value returns to AUTO.
0x83 - 0x03, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x84 TRANSMAP=LINE_FS
0x85
0x86
0x87
0x88
0x89
0x8A
0x8B
0x8C
0x8D
0x8E
0x8F
Default: AUTO

Example
This following command creates an ODU2E on an OSM-2C.
ENT-ODU2E::ODU2E-20-1-5-4:CMDCTG::::OOS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-703

14. Enter Commands TL1 Command Reference Manual

Related Commands
DLT-ODU2E
ED-ODU2E
RTRV-ODU2E

Page 30-704 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-ODU3

Command Changes Since Previous Feature Package

• Added support of ODU3 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-5C.

Description
The ENT-ODU3 commands instruct the network element (NE) to provision an ODU3 entity.

The ODU3 facility can be provisioned on the following transponders:

• OSM-2C

• OSM-4C

• OSM-4F

• OSM-5C

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• The system denies an attempt to set OPUCONFIG to CLIENT on an ODU AID with a TribID (an ODUj
being multiplexed into an ODUk). OPUCONFIG can only be set to CLIENT on an ODU AID with shelf-
slot-port modifiers.

76.MTFP50/30, Rev B January 2018 Page 30-705

14. Enter Commands TL1 Command Reference Manual

Command Format
ENT-
ODU3:[tid]:<fac_aid>:ctag:::[,TRIBSLOT=<tribslot>][,ALMPF=<almProfile>][,PMPF=<p
mProfile>][,DEGM=<degrade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_
source>][,EXPOPER=<ExpOperator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER
=<txOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<TxSAPI>][,TIMDEF=<TIMDefinition>][,MON
TRC=<montrc>][,OPUCONFIG=<opu_config>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.
Table 14.57 ENT-ODU3 Parameters
Parameter Value(s) Definition
fac_aid ODU3-20-[1-16]-[1-5]-[1-80], ODU3- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]- ODU4TribPort]-TribID
[D][1-3]-[1-80]

tribslot [1-80] Specifies a group of values, or a range of values, identifying

which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU3. Decide which tributary slots within the ODUk to
use for a particular ODU3.
Range is [1-80] for mapping an ODU3 into an ODU4.
31 tribslot values must be entered for an ODU3 mapped into an
ODU4.
Use & for grouping.
Use && for ranging.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99
Note: Default value is 99 or the value specifiENT by SYSALMPF
parameter in ENT-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU3
Default: 99 entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

Page 30-706 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.57 ENT-ODU3 Parameters (Continued)

Parameter Value(s) Definition
ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and insert AIS
Default: DISABLED maintenance signal when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
insert AIS when there is a trace mismatch (signal is passed
through intact).
- Enter DISABLED to disable trace monitoring.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
Default: AUTO ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service
Default: IS (OOS).

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

degrade- [1-329492] Indicates the threshold number of block errors at which a one
threshold Default: 49424 second interval is considered degraded for the purposes of
SDBER detection.

76.MTFP50/30, Rev B January 2018 Page 30-707

14. Enter Commands TL1 Command Reference Manual

Example
This following command creates an ODU3 on an OSM-2C.

ENT-ODU3:CORIANT1:ODU3-20-2-2-1:AM0074::::IS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU3
ED-ODU3
RTRV-ODU3

Page 30-708 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-ODU4

Command Changes Since Previous Feature Package

• Added support of ODU4 mux into the ODUC3 on OSM-4F.

• Added support for OSM-5C.

• Update for OSM-2C MSI.

Description
The ENT-ODU4 commands instruct the network element (NE) to provision an ODU4 entity.

The ODU4 facility can be provisioned on the following transponders:

• OSM-2C, OSM-4C, OSM-4F, OSM-5C.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID includes the TribID and is cross-
connected.

• An attempt to set DMSOURCE to ENABLED is denied if the ODUk AID is cross-connected and mapped
to an OTUk/OCH-P/OCH-OS facility.

• When OPUCONFIG=INTACT, the system denies an attempt to provision an ODUj within the ODUk.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
INTACT once a cross-connection is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
MUX once an ODUj is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to any value other than AUTO or
CLIENT once a client is provisioned for the ODU.

• The system denies an attempt to change the value of OPUCONFIG to CLIENT if the ODU is associated
with an OTUk/OCH-P.

• When OPUCONFIG=CLIENT, the NE denies provisioning of an ODUj.

• When OPUCONFIG=INTACT, the NE denies an attempt to set the TXSAPI, TXDAPI, or TXOPER.

• The system denies an attempt to change the OPUCONFIG to INTACT if a non-null value exists for
TXSAPI, TXDAPI, or TXOPER.

• When OPUCONFIG=INTACT, the NE denies an attempt to set DMSOURCE to ENABLED.

• The system denies an attempt to change the OPUCONFIG to INTACT if a DMSOURCE=ENABLED.

• An attempt to provision ODU4 is denied when the port facility is not provisioned yet.

• The ODu4TribPort field in the AID is only applicable to the ODU4 within an ODUC2 or ODUC3 on OSM-
4F.

• PKTMAP can only be set when SWITCHTYPE=UNUSED.

• MSIM can only be set when the ODU4 being de-multiplexed on OSM-2C.

76.MTFP50/30, Rev B January 2018 Page 30-709

14. Enter Commands TL1 Command Reference Manual

Command Format
ENT-
ODU4:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PMPF=<pmProfile>][,DEGM=<degr
ade_interval>][,DEGTHR=<degrade_threshold>][,DMSOURCE=<DM_source>][,EXPOPER=<Exp
Operator>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER=<txOperator>][,TXDAPI
=<txDAPI>][,TXSAPI=<txSAPI>][,TIMDEF=<TIMdefinition>][,MONTRC=<montrc>][,OPUCONF
IG=<opu_config>][,MSIM=<msim_config>][,PKTMAP=<pktmap>][:<editablePrimaryState>]
;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.58 ENT-ODU4 Parameters

Parameter Value(s) Definition
fac_aid ODU4-20-[1-16]-[1-5], ODU4-20-[1- EntityID-ShelfID-SlotID-PortID[-Num]|[-ODU4TribPort]
16]-[1-2]-[1-3]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99
Note: Default value is 99 or the value specifiENT by SYSALMPF
parameter in ENT-/RTRV-NE command.

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU4
Default: 99 entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-856388] Indicates the threshold number of block errors at which a one
hold Default: 128459 second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.
Default: DISABLED

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

Page 30-710 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.58 ENT-ODU4 Parameters (Continued)

Parameter Value(s) Definition
txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and insert AIS
Default: DISABLED maintenance signal when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
insert AIS when there is a trace mismatch (signal is passed
through intact).
- Enter DISABLED to disable trace monitoring.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
Default: AUTO ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

msim_config ENABLED Specifies msim alarm reporting or not when msi value received
DISABLED does not follow G.709 definition.
Default: DISABLED

pktmap GFP Specifies the type of mapping/demapping used for packet traffic
GMP within an ODU owned by the packet subsystem.
Default: GFP - GFP indicates that GFP-F is used to map/demap the packets
into/out of the ODU
- GMP indicates that a constant bit rate mapping using GMP is
used to map/demap the packets into/out of the ODU.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service
Default: IS (OOS).

76.MTFP50/30, Rev B January 2018 Page 30-711

14. Enter Commands TL1 Command Reference Manual

Example
This following command creates an ODU4 on an OSM-2C.

ENT-ODU4:CORIANT1:ODU4-20-2-2:AM0074::::IS;

Possible System Response

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU4
ED-ODU4
RTRV-ODU4

Page 30-712 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-ODUC2

Command Changes Since Previous Feature Package

• None.

Description
The ENT-ODUC2 commands instruct the network element (NE) to provision an ODUC2 entity.

The ODUC2 facility can be provisioned on the following transponders:

• OSM-4F

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The command is only applicable for OSM-4F and only if OCH-OS parameter MODUFMT=200G16QAM

• ALMPF and PMPF are not supported for ODUC2 since no alarm and PM is defined for this layer.

• An attempt to provision ODUC2 is denied when the port facility, the corresponding OCH-OS and
OTUC2 facility are not provisioned yet.

Command Format
ENT-ODUC2:[tid]:<fac_aid>:ctag::::[<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.59 ENT-ODUC2 Parameters

Parameter Value(s) Definition
fac_aid ODUC2-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service
Default: IS (OOS).

Example
This following command creates an ODUC2on an OSM-4F.

ENT-ODUC2:CORIANT1:ODUC2-20-2-2:AM0074::::OOS;

76.MTFP50/30, Rev B January 2018 Page 30-713

14. Enter Commands TL1 Command Reference Manual

Possible System Response

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODUC2
ED-ODUC2
RTRV-ODUC2

Page 30-714 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-ODUC3

Command Changes Since Previous Feature Package

• New command for OSM-4F 300G support.

Description
The ENT-ODUC3 commands instruct the network element (NE) to provision an ODUC3 entity.

The ODUC3 facility can be provisioned on the following transponders:

• OSM-4F

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The command is only applicable for OSM-4F and only if OCH-OS parameter
MODUFMT=2X150G8QAM

• ALMPF and PMPF are not supported for ODUC3 since no alarm and PM is defined for this layer.

• An attempt to provision ODUC3 is denied when the port facility, the corresponding OCH-OS and
OTUC3 facility are not provisioned yet.

Command Format
ENT-ODUC3:[tid]:<fac_aid>:ctag:::[:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.60 ENT-ODUC3 Parameters

Parameter Value(s) Definition
fac_aid ODUC3-20-[1-16]-1 EntityID-ShelfID-SlotID-PortID

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of- Service
Default: IS (OOS).

Example
This following command creates an ODUC3on an OSM-4F.

ENT-ODUC3:CORIANT1:ODUC3-20-2-2:AM0074::::OOS;

76.MTFP50/30, Rev B January 2018 Page 30-715

14. Enter Commands TL1 Command Reference Manual

Possible System Response

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODUC3
ED-ODUC3
RTRV-ODUC3

Page 30-716 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OTU1/OTU2/OTU4/OTUC2/OTUC3/TGLAN

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The ENT-{X} commands instruct the network element (NE) to provision a selected facility entity.

Before the facility can be provisioned, the transponder module that supports this facility should be already
provisioned.

These facilities can be provisioned on transponders according to the following table:

Table 14.61 Facilities Supported by Transponders

Facilities -->
Transponders TGLAN OTU1 OTU2 OTU4 OTUC2 OTUC3

OSM-1S X

OSM-2S X X

OSM-2C X

OSM-4F X X X

OSM-4C X

OSM-4S X X

OSM-5C X

TGLAN represents a 10 GbE-LAN (10.3125 Gb/s) facility that can be provisioned on the port interface of a OSM-
2S/OSM-4S.
The following table provides a list of the applicable rates within this command set for 10G client signals. Additional
parameters are noted if required.

Table 14.62 List of 10G Port Side Facilities

Client Bit Rate Line Bit Rate
Port Side Facility Type AID Other TL1 Parameters (bps) (bps)
10G Base-R (LAN) TGLAN TRANSMAP=FRAME_STD 10,312,500,000 10,709,225,317
(Frame transparent mapping via PT=0x05, not editable
OTU2 with standard GFP.)
10G Base-R (LAN) TGLAN TRANSMAP=PREAMBLE 10,312,500,000 10,709,225,317
(G.709amd3,ODU2 - Extended (default for TGLAN on OSM-2S/
OPU2 - Preamble Transparent OSM-4S)
mapping) PT=0x09 (default value,
editable)
PT=0x80 (Tellabs Legacy)
10G Base-R (LAN) TGLAN TRANSMAP=LINE_FS 10,312,500,000 11,095,727,848
(G.709amd3 ODU2e - line PT=0x03 (default value,
transparent with fixed stuff editable)
mapping) PT=0x10 (Tellabs Legacy)

76.MTFP50/30, Rev B January 2018 Page 30-717

14. Enter Commands TL1 Command Reference Manual

Table 14.62 List of 10G Port Side Facilities (Continued)

Client Bit Rate Line Bit Rate
Port Side Facility Type AID Other TL1 Parameters (bps) (bps)
OTU2 (G.709) OTU2 CLOCKTYPE=G709 (default 10,709,225,317 10,709,225,317
value)
Over clocked OTU2 (G.sup43 OTU2 CLOCKTYPE=OVRCLK_FS 11,095,727,848 11,095,727,848
OTU2e - OTU2 Over-clocked
with fixed stuff.)

OTU1 represent ITU G.709 facilities that can be provisioned on port side of OSM-1S.

OTU2 represent ITU G.709 facility that can be provisioned on port side of OSM-2S/OSM-4S.
OTU4 represent ITU G.709 facilities that can be provisioned on the OSM-2C, OSM-4C, OSM-4F and OSM-5C.
OTUC2 (with OCH-OS @ 274.71 Gbps) and OTUC3 (with 2 x OCH-OS @ 206.035 Gbps) can only be provisioned
on the line interface of an OSM-4F.

When provisioning a OTUk (k=1,2,4), if an ODUk (k=1,2,4) exists with the same port number, the OTUk client is
associated with the ODUk automatically.

{X} specifies the facility type among the following:

• Facilities (fac_type): TGLAN, OTU1, OTU2, OTU4, OTUC2, OTUC3

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• NENDALS can only be set to YES if PROT=YES for the facility.

• PT value is not editable on the OTUk for mTera. Use ODUk based commands for PT for mTera.

• For TGLAN facility, only TRANSMAP=PREAMBLE/ LINE_FS includes support to transport RF/LF
ordered sets to far-end client connected device.

• The NE denies an attempt to provision an OTU2 with CHAN=NA when the supporting XFP/SFP+ is a
Tunable DWDM XFP/SFP+.

• The NE denies an attempt to provision an TGLAN on OSM-2S with CHAN=NA when the supporting
SFP+ is a Tunable DWDM SFP+.

• An attempt to set the UPI value for a TGLAN with TRANSMAP set to any value other than PREAMBLE
is denied.

• Auto laser shutdown using PROT is not supported on the OTU1 or OTU2 or OTU4 facilities supported
by the mTera modules.

• Auto laser shutdown using NENDALS is not supported by the OSM-1S module for OTU1 facility.

• An attempt to create a non-OTU facility is denied if the existing ODUk of the same port does not support
mapping the provisioned non-OTU entity on the module. This includes the evaluation to the ODUk with
correct clock type against the client facility.

• An attempt to provision an TGLAN is denied in mTera shelf if the provisioned TRANSMAP value does
not match the type of ODUk entitiy that is assosicated with the same port for TGLAN. The cases are:
1) TRANSMAP=LINE_FS but the associated ODUk entity is not ODU2E;
2) TRANSMAP=FRAME_STD/PREAMBLE but the associated ODUk entity is not ODU2;

Page 30-718 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• An attempt to provision an TGLAN is denied if the provisioned TRANSMAP value does not match the
CLOCKTYPE of existing ODU2 associated with the TGLAN.

• If a cross-connected ODU enabled DMSOURCE, the attempt to provision OTU on the port of the ODU
is denied.

• If a cross-connected ODU enabled payload PRBS or NULL testing, the attempt to provision OTU on the
port of the ODU is denied.

• If a cross-connected ODU is provisioned PT value, the attempt to provision OTU on the port of the ODU
is denied.

• On OSM-2S, provisioning UPI=TLABLEGACY on TGLAN(Preamble) is denied.

• For OSM-1S port range 1-16, when N facilities (<1.25G, such as OC3/OC12/STM1/STM4/GBEP) and
M facilities (including OC48/STM16/OTU1) existing, the total number should follow the following
formula: N+2M <16 or N+2M=16.
For OSM-1S port range 17-32, when N facilities (<1.25G, such as OC3/OC12/STM1/STM4/GBEP) and
M facilities (including OC48/STM16/OTU1) existing, the total number should follow the following
formula: N+2M <16 or N+2M=16.

• If an ODU exists for the port with OPUCONFIG=INTACT or MUX, then the sytem denies an attempt to
enter a facility on the same port.

• If an ODU2 exists for the port with OPUCONFIG=CLIENT, then the system denies an attempt to enter
an OTU2 on the same port.

• On OSM-2S, the Super FEC provisioning for a group of ports must be the same (for example, SUPER
- I.4 EFEC or SUPERI7 - I.7 EFEC). The system denies an attempt to provision the FECTYPE as
SUPER or SUPERI7 if one of the ports in the group is already provisioned for a different SUPER/
SUPERI7 value. The port groups are: 1-4, 5-8, 9-10, 11-14, 15-18 and 19-20.

• For OTUC2 and OTUC3 facilities, only the following parameters are applicable: ALMPF, DEGM,
DEGTHR, <editablePrimaryState>. Inclusion of other parameters in the ENT-OTUC2 command is
denied with error code IPNV

• For OSM-4F, the input parameter FECTYPE is not applicable for the OTU4/OTUC2/OTUC3. The
FECTYPE is supported by the supporting OCh-OS entity, please see ENT-OCH command. If
FECTYPE is included, the command is denied with error code IPNV.

• For OSM-4F, when creating OTUC3 facility, both supporting OCH-OS facilities must be created first,
otherwise, the OTUC3 facility creation fails.

Command Format
ENT-<fac_type>:[tid]:<fac_aid>:ctag:::[,ALMPF=<almProfile>][,PROT=<protection>]
[,TRANSMAP=<Transmap>][,UPI=<UPIvalue>][,NENDALS=<NendALS>][,FECTYPE=<fecType>][
,CLOCKTYPE=<ClkType>][,PT=<pt>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAPI>][,EXPOPER
=<ExpOperator>][,TXDAPI=<txDAPI>][,TXSAPI=<txSAPI>][,TXOPER=<txOperator>][,TIMDE
F=<TIMdefinition>][,MONTRC=<montrc>][,CHAN=<channel>][,DEGM=<degrade_interval>][
,DEGTHR=<degrade_threshold>]:<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

76.MTFP50/30, Rev B January 2018 Page 30-719

14. Enter Commands TL1 Command Reference Manual

Applicable Parameters

Table 14.63 Applicable Parameters When Entering Commands

PARAMETERa DEF
b
TGLAN OTU1 OTU2 OTU4 OTUC2 OTUC3
ALMPF ND O O O O O O

PROT ND O

NENDALS ND O

TRANSMAP ND O

UPI ND O

FECTYPE ND O O

CLOCKTYPE ND Od

EXPDAPI ND Oe Oc O O O
e c
EXPSAPI ND O O O O O

EXPOPER ND Oe Oc O O O

TXDAPI ND Oe Oc O O O

TXSAPI ND Oe Oc O O O
e c
TXOPER ND O O O O O

MONTRC ND Oe Oc O O O

TIMDEF ND Oe Oc O O O

CHAN ND Oh Oc

DEGM ND Of Of O O O

DEGTHR ND Of Of O O O

PST PD O O O O O O

a. M indicates a MANDATORY parameter and O indicates an OPTIONAL parameter for the specified
module.
b. ND: Name Defined or PD: Position defined.
c. Applies to OSM-2S/OSM-4S.
d. Applies to OTUk facilities supported by OSM-2S/OSM-4S only.
e. Applies to OTU1 on OSM-1S.
f. DEGM and DEGTHR are applicable to OTU1 or OTU2 on OSM-1S and OSM-2S/OSM-4S.
h. Applies to TGLAN facility supported by OSM-2S for tunable SFP+.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-720 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.64 ENT-OPTD/OTU1/OTU2/OTU3/TGLAN/TGFC Parameters

Parameter Value(s) Definition
fac_aid OTU1-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
TGLAN-20-[1-16]-[1-40]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.
Default: NO
Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending a maintenance
signal (for example, AIS or LF depending on the type of facility
provisioned) when there is a signal failure detected on the line
side of a transponder.

Setting the value to NO does not shut down the laser. When this
value is set standard maintenance signaling is used.

Transmap FRAME_STD Specifies the Transparent mapping variance of the TGLAN

PREAMBLE facility on a OSM-2S/OSM-4S transponder.
LINE_FS
Default: PREAMBLE FRAME_STD: GFP-mapped frames for frame Transparent 10G
LAN using mapping via OTU2 in standard mode with PSI=0x05.
Neither Preamble nor IPG transported (Standard G.709 GFP
mapped payload).
G.709 17.4/G.7041 7.1: GFP-F to OPU2

PREAMBLE: GFP-mapped frames. Preamble transported

(GFP-mapped payload with OPU overhead used for extra
needed bandwidth).
G.709 17.4.1/G.7041 7.9: GFP-F to Extended OPU2

LINE_FS: Frame, Preamble and IPG all transported with over

clocked G.709 (OTU2) with fixed stuff (64/66B)
G.709 17.2.4: CBR 10.3G to OPU2e

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOF/LOSYNC).
Default: NO
Applies only to TGLAN supported by OSM-2S.

NENDALS can only be set to YES if PROT=YES.

Note: This parameter does not be used (for example, default to

NO) for 1-WAY Line-to-Port Connection.

76.MTFP50/30, Rev B January 2018 Page 30-721

14. Enter Commands TL1 Command Reference Manual

Table 14.64 ENT-OPTD/OTU1/OTU2/OTU3/TGLAN/TGFC Parameters (Continued)

Parameter Value(s) Definition
fecType REGULAR Specifies the type of FEC supported on the OTU1/OTU2/OTU4
NOFEC client side facility.
SUPER REGULAR FEC is the G.709 FEC.
SUPERI7 The SUPER FEC provides more than 8 dB of coding gain.
Default: REGULAR (Applies to OTU2 facility supported by OSM-2S/OSM-4S)
Only OSM-2S/OSM-4S supports SuperI7 which is an alternative
enhanced FECTYPE.
NOFEC: FEC is disabled.

Applies to OTU1 supported by OSM-1S, OTU2 supported by

OSM-2S/OSM-4S.

The OSM-2C/OSM-5C supports the following FEC values for

the OTU4 facility:
REGULAR

ClkType G709 Specifies the rate of the OTU2 port side facility on OSM-2S/
OVRCLK_FS OSM-4S.
Default: G709 G.709: 10.7 Gb/s
OVRCLK_FS: 11.095 Gb/s

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Default: "" (empty string) Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Default: "" (empty string) Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Default: "" (empty string)
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Default: "" (empty string)
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value for
Default: "" (empty string) the Operator Specific area of the TTI.

Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
Default: SAPI - SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

Page 30-722 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.64 ENT-OPTD/OTU1/OTU2/OTU3/TGLAN/TGFC Parameters (Continued)

Parameter Value(s) Definition
montrc ENABLED-NOAIS Specifies the monitored trace identification mode.
DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
Default: DISABLED consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

channel (1) NA (2) 1-88 (3) 191700000 to Specifies either the DWDM channel number or the DWDM
196050000 in increments of 50000 frequency at which the interface operates when the supporting
Default: NA SFP+ for the facility is a tunable DWDM SFP+.

The channel number can be set to an integer value from 1-88,

corresponding to the DWDM wavelength/frequency in the 7100
88-Channel Plan.
Or the frequency can be set to a value between 191700000 to
196050000 MHz in increments of 50000 MHz which covers a
total of 88 DWDM frequencies (191.7 THz to 196.05 THz in 50
GHz increments.)
A setting of NA (Not Applicable) allows the supporting SFP+ to
operate at its default wavelength.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al Default: 7 the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-2590844] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.
Possible values are:
1 to 20421, default of 3064 (OTU1)
1 to 82026, default of 12304 (OTU2)
1 to 84986, default of 12748 (OTU2e)
1 to 856388, default of 128459 (OTU4)
1 to 863615, default of 129543 (OTU4 with 25% SD-FEC)
1 to 1727230, default of 259085 (OTUC2)
1 to 2590844, default of 388627 (OTUC3)

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

UPI GSUPP43 Specifies the GFP UPI values transmitted for a TGLAN with
G709AMD3 TRANSMPA=PREAMBLE.
Default: G709AMD3
- GSUPP43 - 0xFD for data frames and 0xFE for ordered sets.
Provides compatibility with ITU-T Supplemental43
recommendation.
- G709AMD3 - 0x13 for data frames and 0x14 for ordered sets.
Provides compatibility with ITU-T G.709 recommendation values
first introduced in Amendment 3.

76.MTFP50/30, Rev B January 2018 Page 30-723

14. Enter Commands TL1 Command Reference Manual

Example: Provisioning OTU2 and TGLAN Facility on OSM-2S

ENT-OTU2:CORIANT1:OTU2-20-2-3:AM0074:::CLOCKTYPE=OVRCLK_FS:IS;

ENT-ODU2E:CORIANT1:ODU2E-20-2-3:AM0074:::OPUCONFG=INTACT:IS;

ENT-TGLAN:CORIANT1:TGLAN-20-2-4:AM0074:::TRANSMAP=LINE_FS:IS;

ENT-ODU2E:CORIANT1:ODU2E-20-2-4:AM0074:::PT=0X80,OPUCONFG=CLIENT:IS;

ENT-CRS-ODU2E:CORIANT1:ODU2E-20-2-3, ODU2E-20-2-4:MV0076::2WAY:CKTID="ILEC3"

Example: Provisioning OTUC2 Facility on OSM-4F

ENT-OTUC2:CORIANT1:OTUC2-20-2-1:AM0074::::IS;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ED-{X}
RTRV-{X}

Page 30-724 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OSCX

Command Changes Since Previous Feature Package

• None.

Description
The ENT-OSCX command instructs the network element (NE) to create a Optical Supervisory Channel Extended
(OSCX) entity.

The last digit of the OSCX AID identifies a channel number on the OSC. Channel 1 carries management traffic and
Channel 2 carries SCN traffic.

Restriction and Exceptions

• The AID OSCX-<degree>-1 is denied because this entity is automatically created.

Command Format
ENT-OSCX:[tid]:<oscx_aid>:ctag:::[TRAFFIC=<Traffic>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.65 ENT-OSCX Parameters

Parameter Value(s) Definition
oscx_aid OSCX-20-[10-16,1-7]-21-[2,1],OSCX- EntityID-ShelfID-SlotID-PortID-N
20-[1-16]-1-[2,1]

Traffic ENABLED Controls traffic flow on OSCX entity.

DISABLED
Default: ENABLED

Example
ENT-OSCX::OSCX-20-1-21-2:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-725

14. Enter Commands TL1 Command Reference Manual

Related Commands
DLT-OSCX
ED-OSCX
RTRV-OSCX

Page 30-726 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OSPF

Command Changes Since Previous Feature Package

• None.

Description
The ENT-OSPF command instructs the network element (NE) to establish an OSPF routing instance for a network
partition.
For the mTera participating in the legacy Private EON, the OSPF controller's RTRID of OSPF-1-1 must match one
of the provisioned stable interface(SINTF-1)'s IP addresses in the OSPF area 0.0.0.0

Restrictions and Exceptions

• This command is denied if the network partition for the routing controller does not exist.

• This command is denied if no value is specified for the router_id.

• This command is denied if router_id is set to a value of 000.000.000.000.

Command Format
ENT-OSPF:[tid]:<ospf_aid>:ctag:::RTRID=<router_id>
[,ASBR=<autonomous_system_border_router>]:[<EditablePrimaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.66 ENT-OSPF Parameters

Parameter Value(s) Definition
ospf_aid OSPF-[1,3]-1 EntityID-NPID-OSPFID

router_id [0-255].[0-255].[0-255].[0-255] The router ID attribute of the OSPF routing controller forms its
identity in the context of its network. Though formatted to look
like an IP address, this value doesn't need to be an actual IP
address.
The router ID needs to be unique within a network. Each
network partition represents a network. A network spans
multiple NEs.

autonomous_s ENABLED Specifies if the OSPF instance is being configured as a border

ystem_border_ DISABLED router.
router Default: DISABLED

editablePrimar IS Specifies the primary state of the entity.

yState OOS Possible values are:
Default: IS - IS: In-Service
- OOS: Out-of-Service

76.MTFP50/30, Rev B January 2018 Page 30-727

14. Enter Commands TL1 Command Reference Manual

Example
The following example establishes an ospf routing controller with router ID 192.168.1.1.
ENT-OSPF:NE01:OSPF-1-1:AM0011:::RTRID=192.168.1.1;

Prossible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Realated Commands
ED-OSPF
DLT-OSPF
RTRV-OSPF

Page 30-728 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OSPFADJ

Command Changes Since Previous Feature Package

• None.

Description
The ENT-OSPFADJ command instructs the network element (NE) to configure a manual OSPF routing adjacency
for a routing controller.

Restrictions and Exceptions

• This command is denied if the routing controller for the routing adjacency does not exist.

• This command is denied if the routing area specified in the command is not configured for the routing
controller.

• This command is denied if another adjacency already exists with the same interface_aid and a different
ospfarea_aid value.

• This command is denied if another adjacency exists in the NP with the same interface_aid and
neighbor_address.

• The OSPFADJ entity and the area identified by the OSPFAREA parameter must both belong to the
same OSPF entity.

• The TL specified in the INTRFC parameter and the area identified by the OSPFAREA parameter must
exist.

• This command is denied if the routing area specified is not on the same OSPF entity as the OSPFADJ
entity.

• This command is denied if a TSL interface is specified to INTRFC.

Command Format
ENT-OSPFADJ:[tid]:<ospfadj_aid>:ctag:::INTRFC=<interface_aid>[,INTRFCTYP=
<interface_type>],OSPFAREA=<ospfarea_aid>,NGHBRADDR=<neighbor_address>:[<Editabl
ePrimaryState>];

Proper System Response

The completed response indicates that the adjacency has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.67 ENT-OSPFADJ Parameters

Parameter Value(s) Definition
ospfadj_aid OSPFADJ-[1,3]-1-[1-40] EntityID-NPID-OSPFID-OSPFADJID

76.MTFP50/30, Rev B January 2018 Page 30-729

14. Enter Commands TL1 Command Reference Manual

Table 14.67 ENT-OSPFADJ Parameters (Continued)

Parameter Value(s) Definition
interface_aid TL-[1,3]-[1-512]-[1-1500] Specifies the access identifier of the topological link being used
for this adjacency.

interface_type POINTTOMP Specifies the type of propagation that is performed on this

adjacency.

- POINTTOMP - point to multipoint

ospfarea_aid OSPFAREA-[1,3]-1-[1-32] Specifies the access identifier of the OSPF Area.

neighbor_addr [0-255].[0-255].[0-255].[0-255] MCN/SCN address of the peer entity on the adjacency.

ess

editablePrimar IS Specifies the primary state of the entity.

yState OOS Possible values are:
Default: IS - IS: In-Service
- OOS: Out-of-Service

Example
The following example configures a point-to-multipoint routing adjacency on the interface represented by TL-1-1-1.
ENT-OSPFADJ:NE01:OSPFADJ-3-1-2:AM0011:::INTRFC=TL-1-1-
1,INTRFCTYP=POINTTOMP,OSPFAREA=OSPFAREA-3-1-1,NGHBRADDR=100.100.1.1;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OSPFADJ
DLT-OSPFADJ
RTRV-OSPFADJ

Page 30-730 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OSPFAREA

Command Changes Since Previous Feature Package

• Added STUBTYPE attribute.

Description
The ENT-OSPFAREA command instructs the network element (NE) to configure an OSPF routing area for an OSPF
routing instance.

Restrictions and Exceptions

• This command is denied if the routing controller for the routing area does not exist.

• This command is denied if another OSPF area with same area_id value already exists on the network
partition specified in the command.

• The RROVISIBILITY parameter only applies to Recorded Route Object only.

• The RROVISIBILITY/HUB parameter modification can be implemented whenever the primary state of
the entity is IS or OOS.

• Creation of OSFPAREA with NPID 2 must be rejected.

• STUBTYPE must be DISABLED for backbone areas (RAID=0.0.0.0).

• STUBTYPE must be configured consistent across all IP routers in the OSPFArea for adjacencies to
form.

Command Format
ENT-
OSPFAREA:[tid]:<ospfarea_aid>:ctag:::RAID=<RouterAreaId>,PRTPF=<prtpf_aid>[,HUB=
<hub>][,RROVISIBILITY=<RRoFlag>][,STUBTYPE=<stubtype>]:[<EditablePrimaryState>];

Proper System Response

The completed response indicates that the ospf area has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.68 ENT-OSPFAREA Parameters

Parameter Value(s) Definition
ospfarea_aid OSPFAREA-[1,3]-1-[1-32] EntityID-NPID-OSPFID-OSPFAREAID

RouterAreaId [0-255].[0-255].[0-255].[0-255] Specifies the OSPF Area ID. Though formatted to look like an IP
address, this value doesn't need to be an actual IP address.

prtpf_aid CPPF-[94-99,1-20] Specifies the access identifier of the Protocol Profile.

76.MTFP50/30, Rev B January 2018 Page 30-731

14. Enter Commands TL1 Command Reference Manual

Table 14.68 ENT-OSPFAREA Parameters (Continued)

Parameter Value(s) Definition
hub YES This attribute identifies the routing area is a hub.
NO
Default: NO

RRoFlag Masked This attribute identifies the visibility of a given OSPF area.
Passed
Default: Masked This state value applies to RRO only.
"Masked" means the RRO for this area is to be propagated
within the area but not to be propagated outside of the area,
whereas "Passed" would mean that the RRO for this area is to
be propagated outside of the area as well as within the area.

stubtype DISABLED This attribute configures IPv4 stub area behavior for a given
STUB OSPF area.
NSSA The StubTypes have the following behavior:
Default: DISABLED - DISABLED - no Stub Area behavior. This is the default
behavior.
- STUB - No Type 5 AS-external LSAs propagated from the
Backbone area to this area. Default route inserted by ABR.
- NSSA - No Type 5 AS-external LSAs propagated from the
Backbone area to this area. Default route inserted by the ABR.
Type 7 LSAs generated within this area are converted at the
ABR to Type 5 LSAs and propagated into the Backbone Area.

editablePrimar IS Specifies the primary state of the entity.

yState OOS Possible values are:
Default: IS - IS: In-Service
- OOS: Out-of-Service

Example
The following example configures an ospf area with area ID 1.1.1.10 and protocol profile CPPF-2.
ENT-OSPFAREA:NE01:OSPFAREA-1-1-1:AM0011:::RAID=1.1.1.10,PRTPF=CPPF-
2,HUB=NO,RROVISIBILITY=Passed;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OSPFAREA
DLT-OSPFAREA
RTRV-OSPFAREA

Page 30-732 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OSPFRP

Command Changes Since Previous Feature Package

• None.

Description
The ENT-OSPFRP command instructs the network element (NE) to add an entry to a redistribution point map.

The NE supports three OSPF Redistribution Point Maps per OSPF Routing Controller. Each map supports a specific
OSPF Redistribtuion Point type. Map one supports the Hierarchy type, map two supports the Reachability type and
map three supports the Abstract Node type. The map number is specfied in the third digit of the OSPF Redistribution
Point AID. For example, a valid AID for a Hierarchy OSPF Redistribution Point in partition three has the AID
OSPFRP-3-1-1-2.

The precedence value is used to perform area reconfiguration so choosing a value in the middle of the range (for
example, 128) is recommended. For example, to change the parent of a child routing area, create a hierarchy
redistribution point for the child routing area ID with the new parent that has a lower precedence value than the
hierarchy entry of the existing child area ID entry. If there are multiple hierarchy entries for the same child area ID
the system uses the hierarchy entry with the lower precedence value.

The OSPFRP creation for a BL is similar to that of a TL with the needs to specify the parent and child area IfIndexes
by the PLIFINDEX and CLIFINDEX parameters.

Restrictions and Exceptions

• This command is denied if the associated OSPFRPMAP entity does not exist.

• This command is denied if the CRTAREAID has the same value as the PRTAREAID.

• The command is denied if the first octet specicied in the PLIFINDEX is in the range of 127 to 137 (127
and 137 included by the range).

• This command is denied if the value for the ENTTYPE parameter is not consistent with the AID for this
entity.

• The value of the precedence attribute (PRCDNC) must be unique for a child router area ID
(CRTAREAID) when specifying a hierachy redistribution point.

• The ENT-OSPFRPMAP entity is only supported in the TPCP partition (for example, ENT-
OSPFRPMAP-3-1-1). This command is denied if the ENT-OSPFRPMAP is not created in the TPCP
partition.

• The required parameters depend on the redistribution point type as shown in the table below.

• Only ABSTRACTNODE type OSPFRP is allowed to be added for PROT BL.

• TL or BL must be an inter domain link when the OSPFRP entity is created (ABSTRACTNODE type).

• For an inter domain BL/TL, the GMPLS Mode attribute must set to OIF-ENNI-V1 or OIF-ENNI-V2.

• The CRTAREAID of OSPFRP entity (ABSTRACTNODE type) must match the RAID of the node which
the TL or BL resides on.

• The PRTAREAID of OSPFRP entity (ABSTRACTNODE type) must match the RAID of the TL or BL.

• The CLADDR of OSPFRP entity (ABSTRACTNODE type) must match the NODEID of the node which
TL or BL resides on.

76.MTFP50/30, Rev B January 2018 Page 30-733

14. Enter Commands TL1 Command Reference Manual

• The CLIFINDEX of OSPFRP entity (ABSTRACTNODE type) must match the IfIndex of a TL or BL.

• The creation of ABSTRACTNODE type OSPFRP is denied if the specified parent node, child node,
parent ifindex, child ifindex are simultaneously duplicated with one existing OSPFRP entity in the
system.

Command Format
ENT-OSPFRP:[tid]:<ospfrp_aid>:<ctag>:::CRTAREAID=<child_routing_area_id>,
PRTAREAID=<parent_routing_area_id>,ENTTYPE=<entry_type>[,PNDID=<parent_node_id>]
[,PTADDR=<parent_target_address>][,PTADDRMSK=<parent_target_address_mask>][,CTAD
DR=<child_target_address>][,CTADDRMSK=<child_target_address_mask>][,PLADDR=<pare
nt_link_address>][,PLIFINDEX=<parent_link_ifindex>][,CLADDR=<child_link_address>
][,CLIFINDEX=<child_link_ifindex>][,PRCDNC=<precedence>];

Table 14.69 Parameters Required for Redistribution Point Type

Type -->

Parameters REACHABILITY ABSTRACTNODE HIERARCHY

ospfrp_aid X X X

CRTAREAID X X X

PRTAREAID X X X

ENTTYPE X X X

PNDID X X

PTADDR X

PTADDRMSK X

CTADDR X

CTADDRMSK X

PLADDR X

PLIFINDEX X

CLADDR X

CLIFINDEX X

PRCDNC X

Proper System Response

The completed response indicates that the ospf area has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-734 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.70 ENT-OSPFRP Parameters

Parameter Value(s) Definition
ospfrp_aid OSPFRP-[1,3]-1-[1-3]-[1-100] EntityID-NPID-OSPFID-OSPFRPMAPID-OSPFRPID

child_routing_ Enter 32-bit value in dotted decimal The ID attribute of the Child OSPF area.
area_id format. Possible values are: 0.0.0.1 to This parameter is used for all types of redistribution point.
255.255.255.255

parent_routing Enter 32-bit value in dotted decimal The ID attribute of the Parent OSPF area.
_area_id format. Possible values are: 0.0.0.0 to This parameter is used for all types of redistribution point.
255.255.255.255

entry_type REACHABILITY Specifies the type of map entry.

ABSTRACTNODE
HIERARCHY

parent_node_i Enter 32-bit value in dotted decimal Specifies the ID of the parent node for the redistribution point.
d format. Possible values are: 0.0.0.1 to This parameter is used for the hierarchy and reachability
255.255.255.255 redistribution point.

parent_target_ Enter 32-bit value in dotted decimal Specifies the target address of the parent node for the
address format. Possible values are: 0.0.0.1 to reachability redistribution point. The target address specifies the
255.255.255.255 dotted decimal portion of a TNA address.

parent_target_ Enter 32-bit value in dotted decimal Specifies the target address mask of the parent node for the
address_mask format. Possible values are: 0.0.0.0 to reachability redistribution point.
255.255.255.255

child_target_a Enter 32-bit value in dotted decimal Specifies the target address of the child node for the reachability
ddress format. Possible values are: 0.0.0.1 to redistribution point. The target address specifies the dotted
255.255.255.255 decimal portion of a TNA address.

child_target_a Enter 32-bit value in dotted decimal Specifies the target address mask of the child node for the
ddress_mask format. Possible values are: 0.0.0.0 to reachability redistribution point.
255.255.255.255

parent_link_ad Enter 32-bit value in dotted decimal Specifies the parent link address for the abstract node
dress format. Possible values are: 0.0.0.1 to redistribution point. The link address specifies the node ID
255.255.255.255 associated with the link.

parent_link_ifi Enter 32-bit value in dotted decimal Specifies the parent if index for the abstract node redistribution
ndex format. Possible values are: 0.0.0.1 to point.
255.255.255.255

child_link_addr Enter 32-bit value in dotted decimal Specifies the child link address for the abstract node
ess format. Possible values are: 0.0.0.1 to redistribution point. The link address specifies the node ID
255.255.255.255 associated with the link.

child_link_ifind Enter 32-bit value in dotted decimal Specifies the child if index for the abstract node redistribution
ex format. Possible values are: 0.0.0.1 to point.
255.255.255.255

precedence [0-255] Specifies the priority of the map entry for the hierarchy
redistribution point.

Example
The following example adds an Abstract Node redistribution point with parent area 0.0.1.1.
ENT-OSPFRP:NE01:OSPFRP-3-1-3-1:AM0074:::CRTAREAID=1.0.1.1,PRTAREAID=0.0.1.1,
ENTTYPE=ABSTRACTNODE,PLADDR=192.28.255.255,PLIFINDEX=0.0.0.1,
CLADDR=190.28.20.20,CLIFINDEX=0.0.0.11;

76.MTFP50/30, Rev B January 2018 Page 30-735

14. Enter Commands TL1 Command Reference Manual

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSPFRP
ED-OSPFRP
RTRV-OSPFRP

Page 30-736 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-OSPFRPMAP

Command Changes Since Previous Feature Package

• None.

Description
The ENT-OSPFRPMAP command instructs the network element (NE) to create a redistribution point map.

The NE supports three OSPF Redistribution Point Maps per OSPF Routing Controller. Each map supports a specific
OSPF Redistribtuion Point type. Map one supports the Hierarchy type, map two supports the Reachability type and
map three supports the Abstract Node type. The map number is specfied in the last digit of the OSPF Redistribution
Point Map AID. For example, the OSPF Redistribution Point Map for the Hierarchy Redistribution Points has the AID
OSPFRPMAP-3-1-1.

Restrictions and Exceptions

• The ENT-OSPFRPMAP entity is only supported in the TPCP partition (for example, ENT-
OSPFRPMAP-3-1-1). This command is denied if the ENT-OSPFRPMAP is not created in the TPCP
partition.

Command Format
ENT-OSPFRPMAP:[tid]:<ospfrpmap_aid>:ctag;

Proper System Response

The completed response indicates that the ospf area has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.71 ENT-OSPFRPMAP Parameters

Parameter Value(s) Definition
ospfrpmap_aid OSPFRPMAP-[1,3]-1-[1-3] EntityID-NPID-OSPFID-OSPFRPMAPID

Example
The following example creates an OSPF Redistribution Point Map for Hierarchy Redistribution Points.
ENT-OSPFRPMAP:NE01:OSPFRPMAP-3-1-1:AM0074;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-737

14. Enter Commands TL1 Command Reference Manual

Related Commands
DLT-OSPFRPMAP
RTRV-OSPFRPMAP

Page 30-738 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-PPP

Command Changes Since Previous Feature Package

• None.

Description
The ENT-PPP command instructs the network element (NE) to establish a PPP session over the Data
Communication Channel(DCC) of an OCn facility.

Restrictions and Exceptions

• None.

Command Format
ENT-
PPP:[tid]:<ppp_aid>:ctag:::[PPPPF=<ppppf_aid>][,ALMPF=<almProfile>]:[<EditablePr
imaryState>];

Proper System Response

The completed response indicates that a PPP session has been established for the line or section DCC.
<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.72 ENT-PPP Parameters

Parameter Value(s) Definition
ppp_aid PPPL-[20]-[1-16]-[1-30], PPPL-[20]-[1- EntityID-ShelfID-SlotID-PortID[-Index]
16]-99-[1-30]
PPPMS-[20]-[1-16]-[1-30], PPPMS-
[20]-[1-16]-99-[1-30]
PPPRS-[20]-[1-16]-[1-30], PPPRS-
[20]-[1-16]-99-[1-30]
PPPS-[20]-[1-16]-[1-30], PPPS-[20]-
[1-16]-99-[1-30]

ppppf_aid PPPPF-[99,1-10] Specifies the access identifier of the PPP protocol profile.

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

editablePrimar IS Specifies the primary state of the entity.

yState OOS Two states are possible: In-Service (IS) and Out-of-Service
Default: IS (OOS).

Example
ENT-PPP:NE01:PPPL-20-3-6:AM0011:::PPPPF=PPPPF-1;

76.MTFP50/30, Rev B January 2018 Page 30-739

14. Enter Commands TL1 Command Reference Manual

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0074 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-PPP
DLT-PPP
RTRV-PPP

Page 30-740 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-RSVP

Command Changes Since Previous Feature Package

• None.

Description
The ENT-RSVP command instructs the network element (NE) to create a RSVP Signaling Controller (RSVP SC)
entity.

Restrictions and Exceptions

• Creation of the RSVP SC entity is denied if the associated Network Partition entity does not exist.

• The RSVP SC entity is only supported in the TPCP partition (for example, RSVP-3-1). This command
is denied if the RSVP SC is not created in the TPCP partition.

Command Format
ENT-RSVP:[tid]:<rsvp_aid>:ctag:::SIGID=<SignalingControllerId>
,INTRFC=<SignalingLinkAid>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.73 ENT-RSVP Parameters

Parameter Value(s) Definition
rsvp_aid RSVP-[1,3]-1 EntityID-NPID-RSVPID

SignalingLinkA TL-1-[1-512]-[1-1500] Identifies the TL used to transport signaling messages. The TL

id specified is usually a Stable Interface (loopback interface).

signalingContr [0-255].[0-255].[0-255].[0-255] Specifies the signaling controller ID.

ollerId The Signaling Controller ID needs to be unique within a network.
Each network partition represents a network. A network spans
multiple NEs.

Example
ENT-RSVP::RSVP-3-1:AM0011:::SIGID=127.254.233.255,INTRFC=TL-1-3-1;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-741

14. Enter Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-RSVP
RTRV-RSVP

Page 30-742 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-STAT-RTE

Command Changes Since Previous Feature Package

• None.

Description
The ENT-STAT-RTE command instructs the network element's (NE) Control Plane to create a static route for IP
packet forwarding.

Restrictions and Exceptions

• The parameters value set [DEST, NETMASK, INTERFACE] must uniquely identify a static route entry
for a TL associated with a resource of type GCC, PPP or OSCX. This command is denied if a static
route entry already exists.

• The parameters value set [DEST, NETMASK, INTERFACE, NEXTHOP] must uniquely identify a static
route entry for a TL associated with a resource of MGTETH, IPPG. This command is denied if a static
route entry already exists.

• A value for TL_aid must be specified.

• This command is denied if a value is specified for IFNAME.

• The TL specified by the TL_aid parameter must exist.

• This command is denied if the TL_aid parameter specifies a TL associated with a SINTF-1, OCn or
STMn entity.

• The NEXTHOP parameter is mandatory if TL_aid specifies a TL associated with MGTETH or IPPG.

• This command is denied if the NEXTHOP parameter is specified for PPP, GCC or OSCX interfaces.
These are point-to-point links and a next hop does not need to be specified.

• For default gateway configuration, if the DEST is set to 0.0.0.0, the NETMASK must be set to 0.0.0.0.

• This command is denied if ADVERTISE=YES and the OSPF entity for the partition containing the TL
identified by TL_aid has ASBR disabled.

• This command is denied if the NEXTHOP provided is not from the same subnet as the TL/IFNAME
provided.

Command Format
ENT-STAT-
RTE:[tid]::ctag:::DEST=<destination>[,NETMASK=<netmask>][,INTERFACE=<TL_aid>][,I
FNAME=<IfName>][,NEXTHOP=<next_hop>][,ADVERTISE=<advertise>];

Proper System Response

The completed response indicates that a new static route has been successfully created in the IP forwarding table.
<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-743

14. Enter Commands TL1 Command Reference Manual

Table 14.74 ENT-STAT-RTE Parameters

Parameter Value(s) Definition
destination Format for the IP address is: A double Specifies the host or the network destination where the IP
quoted string representing the IPv4 packet is attempting to reach.
address. IPv4 address = "[0-255].[0- The following IPv4 addresses does not be allowed:
255].[0-255].[0-255]". Invalid addresses --------------- Prefix/Prefix length
224-255.xxx.xxx.xxx ------------ 224/3
169.254.xxx.xxx ----------------- 169.254/16
127.xxx.xxx.xxx ------------------ 127/8
10.0.0-3.xxx ---------------------- 10.0.0/22
0-1.xxx.xxx.xxx ------------------- 0/7

NOTE: The special destination value of 0.0.0.0 is allowed. It

serves as the default route in the IP packet forwarding table.

netmask [0-255].[0-255].[0-255].[0-255] The netmask is bitwise 'AND'ed with the destination IP address
of the packet and compared with the 'destination' field of this IP
forwarding table entry.

TL_aid TL-1-[1-512]-[1-1500] Specifies the local host interface (TL) through which the IP
packet egresses.

next_hop [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the next_hop to be taken by the IP

packet en route to the destination.
This parameter is required when ARP is needed to find out the
Ethernet MAC address to send the IP packet.
This parameter is not required if the interface is a point to point
Ethernet link.

advertise YES When set to YES, the static route is advertised in the routing
NO protocol for the partition of the TL. For OSPF, the static route is
Default: NO advertised as an AS external route, and OSPF must be
configured as an ASBR.

Example
The following example creates a new static route to destination network 192.168.2.0, TL-1-5-7 is associated with a
GCC entity.
ENT-STAT-RTE:::AM0011:::DEST="192.168.2.0",NETMASK=255.255.255.0,INTERFACE=TL-1-
5-7,ADVERTISE=YES;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-STAT-RTE
RTRV-STAT-RTE
RTRV-RTE-ALL
ED-STAT-RTE

Page 30-744 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-SYNC

Command Changes Since Previous Feature Package

• None.

Description
The ENT-SYNC command instructs the network element (NE) to provision the external or line synchronization
references to be used as system timing source within the NE that require synchronization to a reference clock.

Restrictions and Exceptions

• The timing reference clocks could be mixed from port modules and/or from STIM modules.

• STM1, STM4, STM16 and STM64 references are only supported from SSM-2S module
OC3, OC12, OC48 and OC192 references are only supported from SSM-2S modules.

Command Format
ENT-SYNC:[tid]:<sync_aid>:ctag::: REFCLK1=<refclk1> [,REFCLK2=<refclk2>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.75 ENT-SYNC Parameters

Parameter Value(s) Definition
sync_aid SYNC-20-1 EntityID-ShelfID-SYNCID

refclk1 T1-20-[15,23,26]-[1,2], Specifies the valid referene clock sources ID which is same as
E1-20-[15,23,26]-[1,2], facility ID.
2MH-20-[15,23,26]-[1,2], EntityID-ShelfID-SlotID-PortID
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

76.MTFP50/30, Rev B January 2018 Page 30-745

14. Enter Commands TL1 Command Reference Manual

Table 14.75 ENT-SYNC Parameters (Continued)

Parameter Value(s) Definition
refclk2 T1-20-[15,23,26]-[1,2], Specifies the valid referene clock sources ID which is same as
E1-20-[15,23,26]-[1,2], facility ID.
2MH-20-[15,23,26]-[1,2], EntityID-ShelfID-SlotID-PortID
NA,
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

Example: Configuration of External Timing Using Facilities

ENT-SYNC:CORIANT1:SYNC-20-1:CTAG:::REFCLK1=E1-20-23-1, REFCLK2=T1-20-26-1;

Example: Configuration of Line Timing on SSM-2 Facilities

ENT-SYNC:CORIANT1:SYNC-20-1:CTAG:::REFCLK1=STM16-20-1-1, REFCLK2=STM16-20-2-4;

Possible System Response

^^^CORIANT1 07-09-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SYNC
DLT-SYNC
ED-SYNC
OPR-SYNCSW
RLS-SYNCSW

Page 30-746 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-TL

Command Changes Since Previous Feature Package

• Added a TL restriction based on the value of the node entities IP parameter

• Updated existing Addressing Restrictions and added new Addressing Restrictions

• Added a TL restriction to indicate that creation of a TL is denied if SIGNALING=ENABLED and the

RSVP entity is not created for the partition.

• Added OSM-4S, OSM-4F (including 200G and 300G), OSM-5C.

• Updated for GRE tunnels

• Added ODU3 TL support.

• Added OTUC2, OTUC3 as Resource.

Description
The ENT-TL command instructs the network element (NE) to create a topological link.

For NEs operating in a Telecordia environment, the first TL created on a node in partition 3 (for example, TL-3-<node
number>-1 must be a stable interface.

Resource Restrictions
TL restrictions are based on the resource type. Resource types are determined based on the RESOURCE/IFNAME
AID:

Table 14.76 TL interface Type

IPv4 Interface Stable Interface Transport
OSCX SINTF-1 OTUk (k=1,2,3,4)

GCC SINTF-2 OCH-P

GRE SINTF-3 ODUk (k=0,1,2,2E)

MGTETH OCn (n=3,12,48,192)

IPPG TPOOL

PPPL

PPPS

PPPMS

PPPRS

MGTINBANDETH

• Enter a value for either the RESOURCE or the IFNAME parameter.

• The entity specified in the RESOURCE field must exist beforehand.

• The NE denies setting the RESOURCE to an OSCX AID if the link profile has NAT enabled.

• The GMPLS mode of the link profile that is referenced by a PPP TL has to be NONE.

76.MTFP50/30, Rev B January 2018 Page 30-747

14. Enter Commands TL1 Command Reference Manual

• TPOOL is a local termination interface that behaves like Transport interface. SINTF-2 is a stable
interface used for OTN CP purpose. SINTF-3 is a stable interface used for 2-port call. Specific handling
for TPOOL, SINTF-2 and SINTF-3 are specified in each section below.

• IPv4 Interfaces and Transport Interfaces may only be referenced by one TL in the system at a time. This
means configuration of multiple TLs within a partition using the same resource is not allowed. It also
means configuration of TLs in different partitions using the same resource is not allowed.

• The value of RESOURCE must be unique to a TL, only one TL can be assigned to a specific resource.

• Multiple TLs can be assigned to the SINTF-1 value in the IFNAME parameter.

• The NE allows TLs to be assigned to a node based on the value of the Node's IP parameter as
described in the table below. An attempt to assign a TL to a node that is not supported as described in
the table below is denied.

Table 14.77 TL Node Assignment

TL Interface Type TLs Supported when the TLs Supported when the
Node IP parameter is set to Node IP parameter is set to
YES NO
SINTF-1 X X

TL IFNAME Parameter SINTF-2 X

Value
SINTF-3 X

OCn (n=3,12,48,192) X

OTUk (k=1,2,3,4) X

TPOOL X

OCH-P X

ODUk (k=0,1,2,2E) X
AID Specified in the TL
RESOURCE parameter OSCX X

PPPX (X=L,S,RS,MS) X

IPPG X

GCCx (x=1,2,12) X

MGTETH X

MGTINBANDETH X

GRE X

Partition Restrictions
The partition which a TL can be placed (.) or not (shaded) is as follows:

Table 14.78 TL partition

Partition IPv4 Interface Stable Interface Transport SINTF-2, SINTF-3
MCN • •

TPCP • • •

Page 30-748 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• For TLs created in the NP-1 partition, the valid values of the RESOURCE parameters are GCC, GRE,
PPPL, PPPS, PPPMS, PPPRS, MGTETH, IPPG, OSCX, ODUk/OTUk and OCn/STMn facility AIDS.
The valid values for the IFNAME parameter are SINTF-1 and SINTF-2.

• For TLs created in the TPCP partition (for example, TL-3-1-1), the valid values of the RESOURCE
parameter are ODUk/OTUk and OCn/STMn facility AIDs and the valid values for the IFNAME
parameter are SINTF-1, SINTF-2 and SINTF-3.

• On the mTera NE, all the TLs on NP-1 are explicitly created.

Addressing Restrictions
The addressing attributes restrictions for a TL are dependent on Address Type, not Interface Type. They are as
follows (M: Mandatory params; O: Optional params; X: Cannot be specified):

Table 14.79 TL Addressing Restrictions

Address Type NEADDRT NEADDR NEMASK NEPTL
Numbered NUM M O X
Unnumbered UNNUM X X M1
Note 1: The NEPTL provided must exist, be in the same partition as this TL and must be a Numbered TL..
For the TPCP partition, the NEPTL must be in the same node as this TL.

• SINTF-1 TL must be a Numbered interface.

• The NEMASK for SINTF-1 must be set to 255.255.255.255. This is the default value of NEMASK.

• SINTF-2 TL must be an Unnumbered interface

• TPOOL TL must be an Unnumbered interface.

• OSCX must be an Unnumbered interface.

• The last numbered TL for a node cannot be deleted if the node is advertising a node-based TNA. The
node-based TNA needs to be deleted first.

• The NEADDR parameter on a NUMbered TL needs to be unique within a partition. In addition, if the TL
is assigned to an IP node, the NEADDR needs to be unique across all IP nodes in all partitions.

• This command is denied if another numbered interface in this nodes partition contains the same
NEADDR.

• Only one numbered interface is supported in a TDM node.

• The only numbered interface supported in a TDM node is a SINTF-1.

Control Plane Attribute Restrictions

The valid combinations of TL attributes are as follows, based on Interface Type. These must be satisfied to place a
TL InService:
NDISCOVERY: E(Enabled), D(Disabled)
ROUTING: A(Active), P(Passive), D(Disabled), E(Enabled, either A or P)
SIGNALING: E(Enabled), D(Disabled)
Others: M(Mandatory params), O(Optional params), X(Cannot be specified)

76.MTFP50/30, Rev B January 2018 Page 30-749

14. Enter Commands TL1 Command Reference Manual

Table 14.80 Control Plane Attribute Restrictions for IPv4 Interface

LATENCYMODE
NDISCOVERY

SIGNALING

NSIGADDR
NIFINDEX
ROUTING

NSIGID
RAID1

COST
NNID
2
E A D M X X X X O O
2
D D D X X X X X O O
2
D P D M X X X X O O
Note 1: LATENCYMODE is not allowed to be set to MANUAL.

Table 14.81 Control Plane Attribute Restrictions for Transport Interface

LATENCYMODE
NDISCOVERY

SIGNALING

NSIGADDR
NIFINDEX
ROUTING

NSIGID
1

COST
NNID
RAID

E D E X O3 O3 O3 O3 M O
3 3 3 3
E P E M O O O O M O

D D E X M O1,2 M M M O

D P E M M O1,2 M M M O

D D D X X X X X M O
Note 1: The NIFINDEX is needed to place the TL InService. Creation of the TL is allowed without it.
Note 2: NIFINDEX cannot be set to the value of 0.0.0.0 when SIGNALING is set to ENABLED.
Note 3: The provided value is updated with Neighbor Discovery information when Neighbor Discovery is
completed.

Table 14.82 Control Plane Attribute Restrictions for SINTF-1 Interface

LATENCYMODE
NDISCOVERY

SIGNALING

NSIGADDR
NIFINDEX
ROUTING

NSIGID
1

COST
NNID
RAID

D D D X X X X X O O1

D P D M X X X X O O1
Note 1: LATENCYMODE is not allowed to be set to MANUAL.

Page 30-750 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.83 Control Plane Attribute Restrictions for SINTF-2 Interface

LATENCYMODE
NDISCOVERY

SIGNALING

NSIGADDR
NIFINDEX
ROUTING

NSIGID
1

COST
NNID
RAID
1
D D D X X X X X O O
Note 1: LATENCYMODE is not allowed to be set to MANUAL.

Table 14.84 Control Plane Attribute Restrictions for SINTF-3 Interface

LATENCYMODE
NDISCOVERY

SIGNALING

NSIGADDR
NIFINDEX
ROUTING

NSIGID

COST
RAID

NNID

1
D P E M X X X X O O
Note 1: LATENCYMODE is not allowed to be set to MANUAL.

• The RAID must exist in the same partition as the TL.

• If the TL is entered in an area using a CPPF with OPTPATHALG configured as OPE, the TL secondary
state is INCOMP if the optical impairment information for this TL has not been included in the OPE data
file installed in the network element. While in this state, no capacity is advertised for this TL.

• If LATENCYMODE is set to DISABLED, the TL does not participate in path computation where latency
is one of the constraint attributes.

• LATENCY parameter is valid for provisioning only if LATENCYMODE is set to MANUAL.

• If LATENCY parameter value is not supplied when LATENCYMODE is set to MANUAL, it is populated
with the default value.

• If latency information has been included in the OPE data file for the TL, any value configured for
LATENCY using TL1 is ignored and the value from the OPE data file is used.

• If the RESOURCE parameter is set to one of the OSCX, GCC, GRE, PPPL, PPPS, PPPMS or PPPRS
interfaces or if the IFNAME parameter is set to SINTF-1/SINTF-2, this command is denied if a value for
the NSIGADDR, NSIGID, SRLG, LATENCY, CARRID or RESCLASS parameters is specified.

• The provisioning of NULL TL (Transport interface TL with SIGNALING=D) with NDISCOVERY=E is

denied.

• NIFINDEX cannot be set to the value of 0.0.0.0 when SIGNALING is set to ENABLED.

• If the ROUTING is set to ACTIVE or PASSIVE, the parameter RAID is mandatory.

• This command is denied if ROUTING is ACTIVE and NDISCOVERY is DISABLED. It is valid to have
NDISCOVERY ENABLED and ROUTING set to DISABLED or PASSIVE.

76.MTFP50/30, Rev B January 2018 Page 30-751

14. Enter Commands TL1 Command Reference Manual

• If the RESOURCE parameter is set to one of the OSCX, GCC, GRE, PPPL, PPPS, PPPMS or PPPRS
interfaces or if the IFNAME parameter is set to SINTF-1/SINTF-2, this command is denied if the value
of LATENCYMODE as MANUAL is specified.

• If the RESOURCE parameter is set to one of the ODUk/OTUk or OCn interfaces this command is
denied if ROUTING is set to ACTIVE.

• For transport TLs, the command is denied if NDISCOVERY is ENABLED and the MONTRC of the
resource is not DISABLED.

• The provisioning of E-NNI TL with NDISCOVERY enabled is denied.

• An attempt to create TL on SINTF-1 is denied, if COST is specified.

• Creation of a TL is denied if SIGNALING=ENABLED and the RSVP entity is not created for the partition.

Multidomain Attribute Restrictions

An inter-domain link is a topological link between two routing domains. It can be identified as a TL that the RAID
(router area id) is different than the RAID of the node which the TL resides on. The AID of the TL identifies the Node
AID. An intra-domain link is a topological link that its link ends belong to one routing domain. It can be identified as
a TL that the RAID (router area id) is same as the RAID of the node which the TL resides on.

• For an inter domain TL, NIFINDEX and OSPFRP(abstract node type) must be set before TL can be put
into IS.

• For an inter domain TL, GMPLS Mode of the LINKPF on the TL must be set to OIF-ENNI-V1 or OIF-
ENNI-V2.

Technology Specific Attribute Restrictions

• Transport TLs on a NODE must all be of the same type. When a shelf support SONET and OTN
switching, two separate Nodes is required - one for SONET TLs and one for OTN TLs.

OCH Switching Nodes

• The SINTF-2 is not supported on node with OCH switching functions.

ODU Switching Nodes

• The OTN CP only supports one SINTF-2 per node.

• The ODUj TLs that belongs to same node has to belong to same fabric.

SONET Switching Nodes

• A TL may not be entered on an OCn/STMn that is configured for line layer protection.

• The OCn can be assigned to a partition only if no entities (for example, STSn) exist on the OCn.

OTN Transponder Interfaces

• Y-Cable FFP for the OTUk facility has to be created before OTUk TL creation, if this TL intends to have
protection capability.

• For OTU2 TL creation, variations of OTU2 rates (for example, OTU2e) does not be explicitly
represented since they are differentiated by using the CLOCKTYPE parameter on the ENT/ED-OTU2
command. Only OTU2 resource is allowed for OTU2 TL.

Page 30-752 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• For variations of OTU2 rates, the system denies an attempt to modify CLOCKTYPE (by using ED-
OTU2) parameter after the TL has been successfully created.

• The creation of OTUk TL entity is denied if the OCH-P TSL exists on the same node without flexibile
ODUk switching fabric.

• The provisioning of OTUk TL is denied if the OTUk is not associated with ODUk facility on a muxable
module.

• The provisioning of OCH-P TL is denied if the OCH-P is not associated with ODUk facility on a muxable
module.

• GMPLSMode of the LINKPF on an ODU0 TL must be set to NONE, otherwise the command is denied.

• The RESOURCE_LAYER only applies to OCH-P TL.

• An attempt to create ODUk TL is denied if the OPUCONFIG of the ODUk set as AUTO/INTACT.

• When the OPUCONFIG of the ODUk set as MUX, the ODUk TL MUST reference a link profile which
has G709 mode set as V3.

• Creation of ODUk/OTUk/OCH-P TL or OCH-P TSL with an ODUk rate greater than or equal to 100G is
denied if the G709 mode is set to V2 in the link profile.

• When the OPUCONFIG of the ODUk set as MUX, the associated OTUk/OCH-P TL MUST reference a
link profile which has G709 mode set as V3.

• Creation of ODUflex TL is denied when GMPLS mode of the referenced link profile is not set as NONE.

• Creation of ODUflex TL is denied when G709 mode of the referenced link profile is not set as V3.

• Creation of ODUCn and OTUCn (n=2,3) TL is denied when G709 mode of the referenced link profile is
not set as V3.

TPOOL Interfaces
For MT>1 feature, a TPOOL alias is used to identify the server layer VCG. Control plane only allows creating one
TPOOL TL per one VCG entity by using TPOOL as the resource to represent the TTP resources for the purpose of
supporting VCAT service.

When the TPOOL TL is referenced by a TTP supported MT>1 call, the system creates associated TTPs and add
the TTPs into associated VCG after the call has been established.

• TPOOL TL is only supported on SSM-2S module.

• TPOOL TL is only supported by TPCP partition.

• Only one TPOOL TL is allowed per a given VCG entity by using TPOOL as RESOURCE.

• An attempt to create a TPOOL TL per a given VCG entity with TTP members is denied.

• The VCG entity must be provisioned before the provisioning of its associated TPOOL TL.

• Creating a TPOOL TL on a VCG that is the VCG entity on the protection module of an EPG group is
denied.

• GMPLS Mode of the LINKPF on the TPOOL TL must be set to NULL.

SINTF-3 Interfaces
SINTF-3 TL is created on the node to support the 2-port diverse connections. The system supports one SINTF-3 TL
per one single TPCP node which supports 2-port call.

76.MTFP50/30, Rev B January 2018 Page 30-753

14. Enter Commands TL1 Command Reference Manual

• The attempt to create SINTF-3 TL on a TPCP node is denied if there is SINTF-3 TL on the node.

• SINTF-3 TL must be an unnumbered interface, and NEPTL must be set.

• The attempt to create SINTF-3 TL is denied, if the GMPLSMODE parameter of the CPPF provisioned
on the OSPFAREA where the SINTF-3 TL is created is not INNI-V2 or INNI-V1PV2.

• The attempt to create SINTF-3 TL is denied, if the GMPLSMODE of the LINKPF parameter is not INNI-
V1.

• The attempt to create SINTF-3 TL is denied, if the ARUSUPPORT of the LINKPF parameter is not
ENABLED.

• The attempt to create SINTF-3 TL is denied, if the SIGNALING parameter is not set to ENABLED.

Explicitly created NP-1 interfaces

• Creation of TL using a GCC as RESOURCE must be rejected if the ODUk associated with the GCC is
not associated with physical port.

• For an unnumbered TL, its parent TL must be numbered.

• Creation of multiple stable interface TLs with SINTF-1 as IFNAME on mTera NE is allowed.

• Default cost for TL on GCC interface is 10.

• Creation of TL with a MGTETH resource is denied if the MGTETH is a member of an IPPG.

• Creation of TL with an IPPG resource is denied if IPPG does not have two MGTETH members.

• For MGTETH ports 2, 5 and 6 in the mTera 8-slot shelf system, TLs may not be configured for a given
port number in both slots 13 and 14 (associated with the STPM-8). The system denies creating a TL on
one of these ports if a TL is already configured on the same port in a different slot.

Common Restrictions and Exceptions

• Creation of a TL entity is denied if the associated Node entity does not exist.

• Creation of a TL entity is denied if the associated facility/entity does not exist.

• TLNAME string parameters must be used in quotes.

• Default PST of TL (for both SCN and TPCP) with NULL link profile (GMPLS mode set to NONE) is
always IS.

• The PST defaults to OOS for non-NULL TLs in cases where no NIFINDEX is specified.

• Specified IfIndexes must be an unallocated IfIndex from the range 65537-262144.

• Creation of a TL is denied on mTera if the specified IfIndex is already used.

• While the cost for interfaces that are in loopback (for example, STBL interfaces) may be configured with
a non-zero cost; consistent with IP control planes, IP interfaces that are in loopback is advertised as a
stub host with a cost of zero.

Command Format
ENT-
TL:[tid]:<tl_aid>:ctag:::[TLNAME=<TLname>],NEADDRT=<NearEndAddrType>[,NEADDR=<Ne
arEndAddr>][,NDISCOVERY=<NeighborDiscovery>][,NEMASK=<NearEndMask>][,NEPTL=<Near
EndParentTL>][,COST=<Cost>][,IFINDEX=<IfIndex>][,NIFINDEX=<NeighborIfIndex>][,NN
ID=<NeighborNodeId>],LINKPF=<LinkpfAID>[,NSIGADDR=<NeighborSignalingAddr>][,NSIG

Page 30-754 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ID=<NeighborSignalingId>][,ROUTING=<Routing>][,SIGNALING=<Signaling>][,RAID=<Rou
terAreaId>][,SRLG=<Srlg>][,LATENCYMODE=<LatencyMode>][,LATENCY=<Latency>][,CARRI
D=<CarrierId>][,PMD=<Pmd>][,OSNR=<Osnr>][,FWMP=<Fwmp>][,PDL=<Pdl>][,RCD=<Residua
lCD>][,SPMN=<SpmNoise>][,XPMN=<XpmNoise>][,RESCLASS=<ResourceClass>][,RESOURCE=<
Resource>][,IFNAME=<IfName>][,RESOURCE_LAYER=<ResourceLayer>]:[<editablePrimaryS
tate>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.85 ENT-TL Parameters

Parameter Value(s) Definition
tl_aid TL-[1,3]-[1-512]-[1-1500] EntityID-NPID-NodeID-TLID

TLname A double quoted string consisting of 0 Specifies the Topological Link name.
to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

NearEndAddrT NUM Specifies this link is numbered or unnumbered.

ype UNNUM
Default: UNNUM

NearEndAddr [0-255].[0-255].[0-255].[0-255] Identifies the near end address used for this link.
Each network partition represents a network. A network spans
multiple NEs.

The following addresses does not be allowed:

224-255.xxx.xxx.xxx
169.254.xxx.xxx
127.xxx.xxx.xxx
1.xxx.xxx.xxx
0.xxx.xxx.xxx

When NearEndAddrType=NUM, this is a mandatory parameter.

When NearEndAddrType=UNNUM, this parameter reflects the
value stored in the NearEndAddr parameter of the TL identified
by NearEndParentTL.

NeighborDisco ENABLED Specifies whether or not neighbor discovery is used to learn the
very DISABLED neighbor parameters.

If the resource parameter is set to an OTU1/2 AID or IfName

parameter is set to SINTF-1/SINTF-2, the default is DISABLED
else the default is ENABLED.

NearEndMask [0-255].[0-255].[0-255].[0-255] Specifies the near end mask for a numbered link.
Default: 255.255.255.255 The default is only valid when NearEndAddrType=NUM

NearEndParen TL-[1,3]-[1-512]-[1-1500] Identifies the TL to be used to specify an address for this TL

tTL entity. This attribute is used for an unnumbered TL.

76.MTFP50/30, Rev B January 2018 Page 30-755

14. Enter Commands TL1 Command Reference Manual

Table 14.85 ENT-TL Parameters (Continued)

Parameter Value(s) Definition
Cost [1-4294967295] Specifies the cost for the link.

Default cost of 10 if the IfName parameter is SW, SINTF-1/

SINTF-2 or if the resource attribute is a PPP or GCC AID.
Default cost of 1 if the resource parameter specifies an OSCX
AID.

IfIndex [0-255].[0-255].[0-255].[0-255] Specifies the IfIndex.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

NeighborNode [0-255].[0-255].[0-255].[0-255] Specifies the neighbors node ID.

Id

LinkpfAID LINKPF-[91-99,1-20] Specifies the access identifier of the Link Profile.

Default: "" (empty string)

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling address.

lingAddr

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling ID.

lingId

Routing ACTIVE Specifies if Routing is enabled and if so, if Routing is passive or

PASSIVE active.
DISABLED ACTIVE - This link is advertised and routing messages are
Default: DISABLED transported over this link.
PASSIVE - This link is advertised, routing messages are not
transported over this link.
DISABLED - This link is not advertised, routing messages are
not transported over this link.

Signaling ENABLED Specifies if Signaling is enabled.

DISABLED ENABLED - Signaling is used to reserve resources on this link.
Default: DISABLED DISABLED - Signaling is not used to reserve resources on this
link.

RouterAreaId [0-255].[0-255].[0-255].[0-255] Identifies the router area ID for this TL.

The router area ID specifies an area that common to both link
ends.

Srlg A double quoted input string of up to Specifies the Shared Risk Link Groups associated with this TL.
32 comma separated 4 byte hex
strings. Example:
Default: "" (empty string) "3E04990A,044D1A0C"

LatencyMode MANUAL MANUAL - the latency value is manually provisioned

DISABLED DISABLED - the latency parameter is not populated
Default: MANUAL

Latency [0-65535] Specifies the latency across this TL in Micro-Second.

Default: 200 Default is based on average fiber latency of 5 micro-seconds
(us) per kilometer and a distance of 40 km per segment between
two NEs.

CarrierId Is a string of length 1 to 30 characters. Specifies the carrier ID.

Default: "" (empty string) Refer to section 2 for the applicable characters.

Page 30-756 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.85 ENT-TL Parameters (Continued)

Parameter Value(s) Definition
Pmd [0-6500] Unit is in hundredths of Specifies the value for polarization mode dispersion.
picoseconds.
Default: 0 This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Osnr [0-8000] Unit is in hundredths of dB. Specifies the value for Optical Signal to Noise Ratio.
Default: 8000
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Fwmp -8000 to -1500 Unit is in hundredth of Specifies the value for Four Wave Mixing crosstalk Power.
dB.
Default: -8000 This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Pdl NA or [0-100000] Unit is in one- Specifies the value for Polarization Dependent Loss.
hundred-thousandths
of dB. This parameter is advertised and used only when the CPPF for
Default: NA this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

ResidualCD NA or [-200000-2500000] Unit is in Specifies the value for Residual Chromatic Dispersion.
hundredth of ps/nm
Default: NA This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

SpmNoise NA or [0-56000] Unit is in one- Specifies the value for Self Phase Modulation - Noise.
hundred-thousandths of a Radian.
Default: NA This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

XpmNoise NA or [0-112000] Unit is in one- Specifies the value for Cross-Phase Modulation - Noise.
hundred-thousandths of a Radian.
Default: NA This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

76.MTFP50/30, Rev B January 2018 Page 30-757

14. Enter Commands TL1 Command Reference Manual

Table 14.85 ENT-TL Parameters (Continued)

Parameter Value(s) Definition
ResourceClas A double quoted 4 byte hex strings. Specifies the resource class for the TL.
s Default: "" (empty string) 32-bit long bit-mapped field with each bit representing a specific
resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example bit-mapped resource class definitions:

"00000000" - None, used to reset to the default value ""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

Resource IPPG-1, If the TL is assigned to a entity with a AID this parameter

MGTETH-20-[13,14,21,28]-[1-8], specifies the AID of the resource.
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
ODUF-20-[1-16]-[1-20]-[1-80],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-32]-[1-80],
OTU1-20-[1-16]-[1-32],
MGTINBANDETH-20-[10-16,1-7]-[1-
20],
OSCX-20-[10-16,1-7]-21-[2,1],OSCX-
20-[1-16]-1-[2,1],
PPPS-[20]-[1-16]-[1-30],
PPPS-[20]-[1-16]-99-[1-30],
PPPL-[20]-[1-16]-[1-30],
PPPL-[20]-[1-16]-99-[1-30],
PPPRS-[20]-[1-16]-[1-30],
PPPRS-[20]-[1-16]-99-[1-30],
PPPMS-[20]-[1-16]-[1-30],
PPPMS-[20]-[1-16]-99-[1-30],
OC48-20-[1-16]-[1-32],
OC192-20-[1-16]-[1-20],
TPOOL-20-[1-16]-[1-32],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-40],
ODU2E-20-[1-16]-[1-5]-[1-80],
OTU2-20-[1-16]-[1-40],
OCH-P-20-[1-16]-[1-40],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3],
OTU4-20-[1-16]-[1-5],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
OTUC2-20-[1-16]-[1-2],
OTUC3-20-[1-16]-1,
ODU3-20-[1-16]-[1-5]-[1-80]

Page 30-758 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.85 ENT-TL Parameters (Continued)

Parameter Value(s) Definition
Resource GCC0-20-[1-16]-[1-32], If the TL is assigned to a entity with a AID this parameter
(contd)' GCC1-20-[1-16]-[1-20], specifies the AID of the resource.
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC2-20-[1-16]-[1-20],
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC12-20-[1-16]-[1-20],
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]

IfName SINTF-1 If the TL is assigned to a entity without an AID this parameter

SINTF-2 specifies the interface name.
SINTF-3
The purpose of the stable interface is to provide a link whose
state is independent of port failures. Since the stable interface is
a logical interface and not associated with a physical port its
state is not affected by port failures. SINTF-1/2/3 has this
"stable" characteristic.
Stable Interface-1, the purpose is to ensure the TPCP RSVP
signaling controller and OSPF routing adjacencies specified in
the TPCP partition reference a TL associated with SINTF-1 so
that the transmission of signaling and routing messages are not
affected by port failures. Multiple entities can be assigned to
SINTF-1, but it prevents unnumbered TLs from being defined on
that interface.
Stable Interface-2, the purpose of associating a NULL TL with
an unnumbered SINTF-2 is to apply a TNA to a TL, then use
that TNA as a source or destination for a call to terminate at a
node (network interface) rather than on a client port.
Stable Interface-3, the purpose is to indicate the TPCP node
support the 2-port diverse connections call. One SNTF-3 TL is
created per one single node which supports 2-port call.

ResourceLaye OTU The OCH-P is a compound entity composed of three G.800

r TTPs: one each in the OCh, OTU and ODU layers. The
"ResourceLayer" parameter is used to identify the specific TTP
being referenced in this command.

76.MTFP50/30, Rev B January 2018 Page 30-759

14. Enter Commands TL1 Command Reference Manual

Table 14.85 ENT-TL Parameters (Continued)

Parameter Value(s) Definition
editablePrimar IS IS: In-Service
yState OOS OOS: Out-of-Service
Default: IS

Example
Example for OTN CP OTU2 TL
ENT-TL::TL-3-1-2:AM0011:::TLNAME="OTU2-2-1-1 to TEMS",NEADDRT=UNNUM,NEPTL=TL-3-
1-
1,COST=10,NDISCOVERY=DISABLED,SIGNALING=ENABLED,NNID=22.3.30.1,NIFINDEX=0.198.16
0.0,NSIGADDR=130.200.2.254,NSIGID=120.1.1.254,RAID=0.0.3.211,ROUTING=PASSIVE,LIN
KPF=LINKPF-96,RESOURCE=OTU2-1-1-4:IS;

Example for OTN CP SINTF-2:

ENT-TL::TL-3-1-1:AM0011:::TLNAME="Stable IF-2",NEADDRT=UNNUM,NEPTL=TL-3-1-
2,LINKPF=LINKPF-94,ROUTING=DISABLED,RAID=0.0.2.110,IFNAME=SINTF-2:IS;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TL
DLT-TL
RTRV-TL

Page 30-760 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-TNALNKMAP

Command Changes Since Previous Feature Package

• Added a node-based TNA restriction

Description
The ENT-TNALNKMAP command instructs the network element (NE) to add entries to a TNA Link Map. The TNA
Link Map provides the mapping between a TNA and a set of TLs/BLs. A TNA that maps to all TLs/BLs on a Node
may be specified using the Node's AID.

Restrictions and Exceptions

• This command accepted only for Topological Links (TL) that have connection oriented resources (that
is, OCn)

• A numbered TL must be created for a node before a node-based TNA is created.

Command Format
ENT-TNALNKMAP:[tid]::ctag:::TNA=<TNA>,LINKAID=<LinkAID> | NODEAID=<NodeAID>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.86 ENT-TNALNKMAP Parameters

Parameter Value(s) Definition
TNA Enter type-xxx.xxx.xxx.xxx format: (1) Specifies the TNA.
type is one of the following: IPV4
(2)xxx = 0-255

LinkAID TL-[1,3]-[1-512]-[1-1500], BL-[1,3]-[1- Specifies the AID of the link.

512]-[1-500]

NodeAID NODE-[1,3]-[1-512] Specifies the AID of the Node.

Example
ENT-TNALNKMAP:::AM0011:::TNA=IPV4-127.254.233.256,LINKAID=TL-3-2-4;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-761

14. Enter Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-TNALNKMAP
RTRV-TNALNKMAP

Page 30-762 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-TRAPIP

Command Changes Since Previous Feature Package

• None.

Description
The ENT-TRAPIP command instructs the network element (NE) to provision the trap target IP addresses with name
as optional information for SNMP manager.

When configuring trap IP address for targets/managers supporting SNMPv3, it provides the capability to configure
the SNMPv3 user name to be used for generating SNMPv3 notifications.

When the mTera is participating in the Private EON as a PRNE, the trap target IP of the mTera should be configured
to the MGMTIF IP of PGNE-1 and/or PGNE-2.
The Nano/USS PRNE uses the IP addresses of its PGNE-1 and PGNE-2 as its SNMP trap target IP addresses,if
the TRAPIP addresses are not explicitly provisioned.

Restrictions and Exceptions

• Up to 10 trap target IP addresses for SNMP managers can be provisioned.

• This command applies to the mTera NE regardless of its PROXY mode

• Command is denied if the same IP address + Port has already been provisioned for a SNMP manager.
Note that same IP address with different ports is allowed.

• Name-defined parameters can be entered in any order.

• The first name-defined parameter entered after the ctag must not have its leading comma.

• SNMPv3 notifications is generated and sent to the target IP, only if the UID is already provisioned in the
NE.

Command Format
ENT-
TRAPIP:[tid]::ctag:::TRPTGTADDR=<trptgtAddr>[,MGRNAME=<mgrName>][,PORT=<snmpPort
>][,SNMPVER=<snmpVersion>][,UID=<uid>];

UID field is mandatory, SNMPVER is SNMP version 3.

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-763

14. Enter Commands TL1 Command Reference Manual

Table 14.87 ENT-TRAPIP Parameters

Parameter Value(s) Definition
trptgtAddr Format for the IP address is: A double Specifies the IP address of the SNMP Manager (Trap Target IP
quoted string representing the IPv4 address).
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

mgrName 0 to 31 alphanumeric characters. Specifies the customer entered additional field to label the
SNMP Manager.
Refer to section 2 for the applicable characters.

snmpPort Possible values are : SNMP Port = Specifies the SNMP port at which the manager receives the
nnnnn,where n = 0-9. notifications.
Default: 162

snmpVersion 2 Specifies the SNMP version used by the NE to send SNMP

3 notifications to the manager.
Default: 3

uid 6 to 20 alphanumeric characters. Specifies the user's identity (login name).

This field is mandatory if snmpVersion is 3.

Example
ENT-
TRAPIP:CORIANT1::AM0074:::TRPTGTADDR="192.168.203.12",MGRNAME="NOC25",PORT=1042,
SNMPVER=2;

ENT-TRAPIP:CORIANT1::AM0074:::TRPTGTADDR="192.168.203.12",SNMPVER=2;

ENT-
TRAPIP:CORIANT1::AM0074:::TRPTGTADDR="192.168.203.12",SNMPVER=3,UID=Johnson93;

Possible System Response

^^^CORIANT1 07-09-15 02:08:15

M AM0074 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-TRAPIP
DLT-TRAPIP

Page 30-764 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-TSL

Command Changes Since Previous Feature Package

• Added a NEPTL restriction and updated the example to add the NEPTL parameter since this is a
mandatory parameter

• Update the ModuleAID parameter to support OSM-4S.

Description
The ENT-TSL command instructs the network element (NE) to create a transitional link.

From control plane routing prospective, the difference between a traditional TL and transitional link is: A transitional
link provide linkage between two different network layers.

In order to support TSL spans NANO and mTera platforms, the NEPTL is required for the TSL.

Restrictions and Exceptions

• The creation of a transitional link is denied if the associated node does not exist.

• The creation of a transitional link is denied if the associated fiber equipment has not been created.

• TSLNAME string parameters must be used in quotes.

• NIFINDEX cannot be set to 0.0.0.0.

• The TSL cannot be put in service without specifying NIFINDEX parameter.

• The PST is defaulted to OOS if the ENT-TSL command is missing Neighbor IfIndex attribute.

• The RAID must exist in the same partition as the TSL.

• GMPLS Mode is specified in the link profile for the TSL.

• Only one TSL can be associcated with a DPRING FFP. The attempt to create a TSL for an OCH-P
which is associated with DPRING is denied if the other OCH-P associated with the FFP is associated
with a TSL.

• If OTUk TL is needed, it is created before TSL on the same node.

• An attempt to create OCH-P TSL and OCH TSL cannot be on the same node.

• An attempt to create OCH-P TSL is denied if the associated OCH-P facility had OCH-DPRING FFP
provisioned.

• For OCH-P TSL on 10G OCH-P, OCH-P has to be FECTYPE=SUPER (EFEC) else the ENT-TSL is
denied.

• The system denies an attempt to modify FECTYPE (by using ED-OCH) parameter after the OCH-P TSL
has been successfully created.

• The LINKPF should always be an INNI profile for a TSL with GMPLS mode set to INNI-V1.

• OCH-P TSL creation is denied if the OCH-P is not associated with ODUk facility on a module with
flexible ODUk switching.

• GMPLS Mode of the LINKPF on the TSL must be INNI.

• RAID on TSL has to match that of the corresponding node when the LINKPF of TSL is INNI.

76.MTFP50/30, Rev B January 2018 Page 30-765

14. Enter Commands TL1 Command Reference Manual

• Transponder module not supported is denied when it is specified to MODULE (see ModuleAID list in
the parameter table for the supported modules).

• PDL on OCH-P TSL is mandatory if interface is 100G, optional (and allowed) on 10G/40G interface.

• If the TSL is entered in an area using a CPPF with OPTPATHALG configured as OPE, the TSL
secondary state is INCOMP if the optical impairment information for this TSL has not been included in
the OPE data file installed in the network element. While in this state, no capacity is advertised for this
TSL.

• Specified IfIndexes must be an unallocated IfIndex from the range 65537-262144.

• Creation of a TSL is denied if the specified IfIndex is already used.

• Creation of a TSL is denied if the EXTCHAN associated with an OCH-P is not NA.

• The NEPTL must exist, must be in the same node as this TSL and must be a Numbered TL.

Command Format
ENT-
TSL:[tid]:<tsl_aid>:ctag:::[TSLNAME=<TSLname>][,COST=<Cost>][,IFINDEX=<IfIndex>]
[,NIFINDEX=<NeighborIfIndex>],NNID=<NeighborNodeId>,NSIGADDR=<NeighborSignalingA
ddr>,NSIGID=<NeighborSignalingId>[,PMD=<Pmd>][,OSNR=<Osnr>][,PDL=<Pdl>],LINKPF=<
LinkpfAID>,RAID=<RouterAreaId>[,RESCLASS=<ResourceClass>],MODULE=<ModuleAID>,POR
TID=PortId,FACTYPE=<FacilityType>,ADAPT=<Adaptation>,NEPTL=<NearEndParentTL>:[<E
ditablePrimaryState>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.88 ENT-TSL Parameters

Parameter Value(s) Definition
tsl_aid TSL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-TSLID

TSLname Alpha-numeric text string up to 30 Specifies the transitional link name.

characters. Refer to section 2 for the applicable characters.
Default: "" (empty string)

Cost [1-4294967295] Specifies the cost for the link.

Default: 10

IfIndex [0-255].[0-255].[0-255].[0-255] Specifies the IfIndex.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

NeighborNode [0-255].[0-255].[0-255].[0-255] Specifies the neighbors node ID.

Id

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling address.

lingAddr

Page 30-766 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.88 ENT-TSL Parameters (Continued)

Parameter Value(s) Definition
NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling ID.
lingId

Pmd [0-6500] Unit is in hundredths of Specifies the value for polarization mode dispersion.
picoseconds.
Default: 0 This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

Osnr [0-8000] Unit is in hundredths of dB. Specifies the value for Optical Signal to Noise Ratio.
Default: 8000
This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

Pdl NA or [0-100000] Unit is in one- Specifies the value for Polarization Dependent Loss.
hundred-thousandths
of dB. This parameter is advertised and used only when the CPPF for
Default: NA this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

LinkpfAID LINKPF-[91-99,1-20] Specifies the access identifier of the Link Profile.

RouterAreaId [0-255].[0-255].[0-255].[0-255] Identifies the router area ID for this TSL.

The router area ID specifies an area that common to both link
ends.

ResourceClas A double quoted 4 byte hex strings. Specifies the resource class for the TSL.
s Default: "" (empty string) 32-bit long bit-mapped field with each bit representing a specific
resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example bit-mapped resource class definitions:

"00000000" - None, used to reset to the default value ""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

ModuleAID OSM2C-20-[1-16], Specifies the AID of Module that the link is terminated.
OSM2S-20-[1-16],
OMD-20-[1-16]-[1-2],
OSM4S-20-[1-16]

FacilityType OCH Specifies the sub-type of facility that is used to terminated the
OCH-P link end.

Adaptation OCH Specifies the topmost layer if the adaptation functions used at
ODU2 the given link end.
ODU2e
ODU3
ODU4

76.MTFP50/30, Rev B January 2018 Page 30-767

14. Enter Commands TL1 Command Reference Manual

Table 14.88 ENT-TSL Parameters (Continued)

Parameter Value(s) Definition
NearEndParen TL-[1,3]-[1-512]-[1-1500] Identifies the TL to be used to specify an address for this TSL
tTL entity.

EditablePrimar IS IS: In-Service

yState OOS OOS: Out-of-Service
Default: IS

PortID 1 to maximum PortId of each module. Specifies the port on the given equipment module which the link
Note: PortId ranges from 4 to 11 for is terminated.
OADMF8.

Example: An OCH-P TSL per OSM-2S

ENT-TSL::TSL-3-1-1:AM0011:::LINKPF=LINKPF-
1,NNID=22.3.30.1,NIFINDEX=0.198.160.0,NSIGADDR=130.200.2.254,NSIGID=120.1.1.254,
RAID=100.1.1.1,MODULE=OSM2S-2-1,PDL=250,PORTID=1,FACTYPE=OCH-
P,ADAPT=ODU,NEPTL=TL-3-1-2:IS;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TSL
DLT-TSL
RTRV-TSL

Page 30-768 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-TTP-{x}

Command Changes Since Previous Feature Package

• None.

Description
The ENT-TTP command instructs the network element (NE) to provision a trail termination point.

{x} can be STS1 or STS3C.

The TTP entity can be used to terminate a path that is associated with a virtual concatenation group.

Restrictions and Exceptions

• TTPSTS3C entities must be aligned to STS3 boundaries the same way that STS3C are.

• TTP entities that are provisioned with this command can only be used with virtual concatenation groups
(VCG) that have VCGTYPE=MAN.

• On mTera SSM-2S working module that is in EPG group, provision TTPSTSn entity associated with
virtual port 99 on backplane would implicitly provision TTPSTSn entity on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to provision TTPSTSn entity
associated with virtual port 99 on backplane would be denied.

Command Format
ENT-TTP-{x}:[tid]:<ttp_aid>:ctag[::::<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.89 ENT-TTP-{x} Parameters

Parameter Value(s) Definition
ttp_aid TTPSTS1-20-[1-16]-99-[1-3]-[1-192] EntityID-ShelfID-SlotID-Vport-GroupId-n
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

76.MTFP50/30, Rev B January 2018 Page 30-769

14. Enter Commands TL1 Command Reference Manual

Example
Enter a STS3C TTP:
ENT-TTP-STS3C:CORIANT1:TTPSTS3C-20-12-99-1-1:myctag;

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M^^MYCTAG^COMPLD<cr><lf>

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-TTP
ED-TTP
ED-VCG
RTRV-TTP

Page 30-770 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

ENT-T1

Command Changes Since Previous Feature Package

• None

Description
Command instructs the network element (NE) to provision a DS1 (T1) facility providing an External Synchronization
reference.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• almProfile and qualityLevelOverride is only applicable on the Input Synchronization aid (T1) facility.

• tx_ref and loopPrevention is only applicable on the Output Synchronization aid (T1OUT) facility.

• The ENT-T1 on T1(T1OUT) creates the T1OUT(T1) in the same port simultaneously.

• Setting QLOVERRIDE is mandatory when creating an Input Synchronization reference AID (T1) and its
Frame Format is SF. This parameter does not be Disable when the Input Synchronization reference
AID(T1) Frame Format is SF.

Command Format
ENT-
T1:[tid]:<T1_aid>:ctag:::[,LINECDE=<LineCode>][,FMT=<FrameFormat>][,TXREF=<tx_re
f>][,ALMPF=<almProfile>][,QLOVERRIDE=<qualityLevelOverride>][,LOOPPRVT=<loopPrev
ention>]:[<editablePrimaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.90 ENT-T1 Parameters

Parameter Value(s) Definition
T1_aid T1-20-[15,23,26]-[1,2] EntityID-ShelfID-SlotID-PortID
T1OUT-20-[15,23,26]-[1,2]

LineCode AMI Indicates the line code for a T1 facility.

B8ZS Possible values are Alternate Mark Inversion (AMI) or Bipolar
Default: B8ZS with 8 zero substitution (B8ZS).

76.MTFP50/30, Rev B January 2018 Page 30-771

14. Enter Commands TL1 Command Reference Manual

Table 14.90 ENT-T1 Parameters (Continued)

Parameter Value(s) Definition
FrameFormat SF Indicates the digital signal frame format of a T1 facility.
ESF
Default: ESF

tx_ref NA, Indicates the derived source signal timing the output
SYNC-20-1, synchronization reference. Applicable only to output
OC3-20-[1-16]-[1-32], synchronization references.
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.
Default: 99 Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

qualityLevelOv DISABLED Specifies the synchronization signal quality level that is

erride PRS associated with the specified facility instead of the value
ST2 received in the synchronization status message within the
TNC signal. This allows to override the received quality level.
ST3E When set to DISABLED, the system uses the quality level
ST3 received in the synchronization status message.
SMC
ST4
PROV
DUS
Default: DISABLED

loopPrevention DISABLED Specifies the loop prevention function of the entity.

ENABLED Enable: The SSM of output synchronization is forced to DNU
Default: DISABLED when the tx_ref is SYNC-20-1 and the SYNC-20-1 source is the
same input synchronization port
Disable: The SSM of output synchronization follows the tx_ref
and squelch result. It does not consider the status of the tx_ref
entity.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

tx_sqlch AIS Indicates output synchronization reference when squelch is

DNU applied. Applicable only to output synchronization references.
SQLCH ²AIS : Force AIS in the output synchronization signal
SSM ²DNU: The SSM of the output synchronization set to DNU, this
Default: SSM parameter is only available when the Frame Format is NOCRC4
or CRC4
²SQLCH: Shutdown the output synchronization signal
²SSM: The SSM function shuts down the output synchronization
signal transmission if the tx-ref signal with a quality that is lower
than the configurable threshold.

Page 30-772 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.90 ENT-T1 Parameters (Continued)

Parameter Value(s) Definition
ql_min PRS Indicates the QL threshold of the derived source signal timing
ST2 the output synchronization reference when it is SSM squelch
TNC mode. Applicable only to output synchronization references.
ST3E
ST3
SMC
ST4
PROV
DUS
Default: DUS

Example
ENT-T1:CORIANT1:T1-20-14-1:CTAG:::LINECDE=AMI,FMT=SF:IS;

Possible System Response

^^^CORIANT1 15-03-14 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-T1
ED-T1
DLT-{x}

76.MTFP50/30, Rev B January 2018 Page 30-773

14. Enter Commands TL1 Command Reference Manual

ENT-USER-SECU

Command Changes Since Previous Feature Package

• Add FIPS mode restrictions for SNMP parameters

• Remove support for pid_encrypt=Y

• Change the value of snmp_priv_protocol from DES3 to DES

Description
The ENT-USER-SECU command instructs the network element (NE) to enter (add) a new user login entry to the
system with his corresponding user access privilege codes (uap, uap_cli, uap_snmp), password (pid), session time
out (TMOUT), password aging (PAGE), password update waiting period (PUWP), remaining number of login
attempts after expiration of a password (PELN), autonomous report management (ALMMSG, EVTMSG,
DBCHGMSG and PMMSG) and user status (STATUS) of the specified user identifier (uid).

When the NE user being created has SNMPv3 privilege, this command also instructs the network element (NE) to
enter (add) a new SNMPv3 user with the corresponding access privilege (USERSECLEVEL) , SNMPV3 protocol
options (SNMPAUTHPROT, SNMPPRIVPROT) and SNMPv3 pass phrases (SNMPAUTHPID, SNMPPRIVPID)

Users who intend to login to the NE with secure shell (SSH) or transfer patches to the system via SFTP may identify
the location of the user's public key. If the public key location is identified in the command text, the system
automatically attempts to connect to the server holding the public key file and store the key in the lowest available
KEY variable (that is, KEY1, KEY2... KEY6). Up to 6 public keys can be stored as user attributes and duplicate public
keys are never stored.

This command can be run on DIR_OSC, PGNE-1, PGNE-2 and PRNE.

This command can only be utilized by a TL1 System Administrator.

When the logon password is entered in the command, only one asterisk (*) appears on the screen, regardless of
how many characters comprise the password.

Up to 500 TL1 users can be supported on a mTera UTP.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• The first name-defined parameters entered after the ctag must not have its leading comma.

• When parameter is omitted in the command, this means that the default parameter value is applied.

• PUWP value must always be less than or equal to PAGE value.

• Command is denied if all UAP, UAPCLI and UAPSNMP are set to A0.

• snmp_user_sec_level, snmp_auth_protocol, snmp_auth_passphrase, snmp_priv_protocol and

snmp_priv_passphrase are not applicable when uap_snmp=A0.

• When creating a SNMPv3 user, snmp_auth_passphrase and snmp_priv_passphrase are mandatory if

snmp_user_sec_level is not provided or provided with "authPriv".

• When creating a SNMPv3 user, snmp_auth_passphrase is mandatory if snmp_user_sec_level is

provided with "authnoPriv".

Page 30-774 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

• The attributes - session_time_out, password_aging, pwd_update_waiting_period,

pwdexpire_login_num, almmsg, dbchgmsg, pmmsg, evtmsg, are not applicable to NE users with only
SNMPv3 privileges, unless the NE user also has TL1/CLI privileges.

For NE users with only SNMPv3 privileges, the attribute, user_status, takes only ENABLED or
DISABLED values , unless the NE user also has TL1/CLI privileges.

• If the NE is in FIPS mode (ED-SECU-SYS parameter SECURE=FIPS) and uap_snmp is not set to A0
the following parameter constraints is enforced:
- SNMP USER Security Level must be set to authPriv or authNoPriv (USERSECLEVEL=authPriv or
authNoPriv)
- SNMP Authentication Protocol must be set to SHA (SNMPAUTPROT=SHA)

• If the NE is in FIPS mode (ED-SECU-SYS parameter SECURE=FIPS) the following parameter

constraints is enforced:

- Password age (PAGE), the value 0 is not allowed

- Password update waiting period (PUWP), the value 0 is not allowed
- Session timeout (TMOUT), the value 0 is not allowed
- Password expired login number (PELN), the value 0 is not allowed

Command Format
ENT-USER-
SECU:[tid]:<uid>:ctag::<pid>[,<pid_encrypt]:UAP=<uap>[,UAPCLI=<uap_cli>][,UAPSNM
P=<uap_snmp>][,TMOUT=<session_timeout>][,PAGE=<password_aging>][,PUWP=<pwd_updat
e_waiting_period>][,PELN=<pwdexpire_login_num>][,MAXSES=<max_sessions>][,ALMMSG=
<almmsg>][,EVTMSG=<evtmsg>][,DBCHGMSG=<dbchgmsg>][,PMMSG=<pmmsg>][,STATUS=<user_
status>][,USERSECLEVEL=<snmp_user_sec_level>][,SNMPAUTHPROT=<snmp_auth_protocol>
][,SNMPAUTHPID=<snmp_auth_passphrase>]
[,SNMPPRIVPROT=<snmp_priv_protocol>][,SNMPPRIVPID=<snmp_priv_passphrase>][,KEYLC
N=<public_key_location>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 14.91 ENT-USER-SECU Parameters

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. UID

76.MTFP50/30, Rev B January 2018 Page 30-775

14. Enter Commands TL1 Command Reference Manual

Table 14.91 ENT-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
pid one string accord with the conditions Specifies the new login password associated to this UID.
listed in the Definition colum
If the password complexity parameter is set to YES (refer to the
ED-SECU-SYS and RTRV-SECU-SYS commands), the
following rules apply for the password:
-Password length must be 8 characters minimum, 12 characters
maximum.
-At least 3 of the 4 following character types must be present:
numeric character, lowercase alphabetical character, uppercase
alphabetical character, special character.
-Special character consists of any of the following: ! # $ % & @ ^
*
-The Password must not include more than 2 consecutive
repetitions of the same character.
-UID (UserId) must not be contained in password (case
insensitive).

If the password complexity parameter is set to NO, then the

<pid> can be between 6 and 12 characters long using any of the
characters mentioned above, with no restriction on upper case
or character repetition.
When the <pid_encrypt>=N, pid has to be 6 to 12 alphanumeric
characters.
When the <pid_encrypt>=A, pid has to be 32 alphanumeric
characters and follow AES encryption algorithm.

uap A0 This mandatory attribute specifies the TL1 user access privilege
A2 code (UAP) assigned to the login (uid).
A4 - Enter A0 to block access to TL1 commands (except ACT-
A6 USER, CANCEL-USER and ED-PID).
A7 - Enter A2 to specify Public privilege.
A8 - Enter A4 to specify Test privilege.
- Enter A6 to specify Provisioning privilege.
- Enter A7 to specify Operator privilege.
- Enter A8 to specify Admin privilege.

uap_cli A0 This attribute specifies the CLI (Command Line Interface) user
A2 access privilege code (UAP) assigned to the login (uid).
A4 - Enter A0 to block access to CLI interface.
A6 - Enter A2 to specify Public privilege.
A7 - Enter A4 to specify Test privilege.
A8 - Enter A6 to specify Provisioning privilege.
Default: A0 - Enter A7 to specify Operator privilege.
- Enter A8 to specify Admin privilege.

uap_snmp A0 This attribute specifies the SNMP (Simple Network

A2 Management Protocol) user access privilege code (UAP)
A8 assigned to the login (uid).
Default: A0 - Enter A0 to block access to SNMP interface.
- Enter A2 to specify Public privilege. (A2 indicates full read-only
and notify access to the MIBs, write access to change its own
SNMP Passphrases)
- Enter A8 to specify Admin privilege.(A8 indicates full read-write
access to all the MIBs )

Page 30-776 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.91 ENT-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
session_timeo [0-99] This attribute is the Session Time Out Interval.
ut If there are no messages between the user and the NE over the
Time Out interval, the session is logged off.

Setting the value to 0 disables this attribute (meaning the

session does not time out).
Default is 15 minutes for A8, 30 minutes for A7 and A6, 45
minutes for A4, and 60 minutes for A2.

password_agi [0-255] This attribute is the Password Aging Interval.

ng Default: 30 Setting the value to 0 disables this attribute.

pwd_update_ [0-60] This attribute specifies the number of days that a user must wait
waiting_period Default: 25 before he can update his password.
Setting the value to 0 disables this attribute.
Notes:
- When both PAGE and PUWP are enabled, PUWP must
always be inferior or equal to PAGE value.

pwdexpire_logi [0-5] This attribute specifies the number of times that an existing
n_num Default: 3 password can still be used once it has expired. Once the user
has exceeded this number, the only TL1 commands allowed are
ACT-USER/ED-PID/CANC-USER/RTRV-SW.
Setting the value to 0 disables this attribute.

max_sessions [1-128] This attribute specifies the maximum number of sessions

Default: 6 allowed for a user.

almmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
Default: ALW REPT^ALM and REPT^ALM-ENV.

evtmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
Default: ALW REPT^BKUP, REPT^EVT, REPT^EVT^FXFR, REPT^EVT-
SESSION.

dbchgmsg ALW This attribute specifies if this user receives (value=ALW), not
INH receive (value=INH), or receive all, except those that are a result
INH-OWN of administrative actions that they perform (value=INH-OWN),
Default: ALW autonomous messages reported through REPT^DBCHG.

pmmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
Default: ALW REPT^PM.

user_status ENABLED This attribute allows the Admin to enable or disable a user upon
PASSWORD AGED creation.
DISABLED User with STATUS=ENABLED has access to the system.
User with STATUS=DISABLED does not have access to the
system.
User with status=PASSWORD AGED has access to the system
but is forced to change his password on first-time login.

Default is ENABLED for uid Admin1 User and all the NE users
with only SNMPv3 privileges, PASSWORD AGED for all other
users.

76.MTFP50/30, Rev B January 2018 Page 30-777

14. Enter Commands TL1 Command Reference Manual

Table 14.91 ENT-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
snmp_user_se authPriv Specifies the SNMPv3 user security level.
c_level authNoPriv
noAuthnoPriv
Default: authPriv

snmp_auth_pr MD5 Specifies the authentication protocol that the SNMPv3 user
otocol SHA being created uses.

snmp_auth_pa a string value Specifies the SNMPv3 authentication pass phrase. This
ssphrase attribute is mandatory only if the authentication security level is
added (via changing USERSECLEVEL from noAuthNoPriv to
authNoPriv or authPriv)

snmp_priv_pro DES Specifies the privacy protocol that the SNMPv3 user being
tocol created uses.

snmp_priv_pa a string value Specifies the SNMPv3 privacy pass phrase.

ssphrase This attribute is mandatory only if the priv security level is
added. (via changing USERSECLEVEL from noAuthNoPriv or
authNoPriv to authPriv)

public_key_loc ftp://userid:pwd@ftphost:[portid]/url- Specifies the location of the public key.

ation path Port number 21 can be used for non-secure FTP file transfer.
Port number 22 is the default value and can be used for secure
FTP (SFTP) file transfer.
<url-path> specifies the device/drive/directory/
publickeyfilename.
NE automatically attempts to connect to the server holding the
public key file and store the key in the lowest available KEY
variable (that is, KEY1, KEY2...KEY6).

pid_encrypt N Optional parameter which indicates if the pid, snmpauthpid and

A snmpprivpid is transmitted with AES encryption (A) or no
Default: N encryption (N) in a TL1 command.
When parameter is omitted, PID is sent without encryption.

Example
The following example creates a new user login, TEST, to the system. Since no STATUS value is provided, the
default PASSWORD AGED status applies.

ENT-USER-
SECU:CORIANT1:TEST12:AM0121::*:UAP=A4,TMOUT=30,PAGE=60,PUWP=50,PELN=4,DBCHGMSG=I
NH;

If the user wants to create an user with an AES encrypted password,

ENT-USER-SECU:CORIANT1:Robinson71:AM0105::b614db5f47c75531e9748f4cb8a93179,A;
The above is shown as,
ENT-USER-
SECU:CORIANT1:Robinson71:AM0105::*,A:UAP=A4,TMOUT=30,PAGE=60,PUWP=50,PELN=4,DBCH
GMSG=INH;

Page 30-778 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

The following example creates a new user login, SNMPTEST, to the system. It also creates SNMPTEST in the
SNMP MIB Tables in the NE, with the authentication and encryption passphrase of pid.
Since no STATUS value is provided, the default ENABLED status applies.This user has A4 privileges for TL1 and
A8 privileges for SNMPV3. TMOUT, PAGE, PUWP, PELN, DBCHGMSG are applicable to only the TL1 commands
and doesn't affect SNMP communication.

ENT-USER-
SECU:CORIANT1:SNMPTEST:AM0121::*:UAP=A4,UAPSNMP=A8,TMOUT=30,PAGE=60,PUWP=50,PELN
=4,DBCHGMSG=INH;

ENT-USER-
SECU:CORIANT1:SNMPUSER1:AM0121::*:UAP=A4,UAPSNMP=A8,TMOUT=30,PAGE=60,PUWP=50,PEL
N=4,DBCHGMSG=INH,SNMPAUTHPID=snmpv3TestAu, SNMPPRIVPID=snmpv3TestPr;
The above is shown as,
ENT-USER-
SECU:CORIANT1:SNMPUSER1:AM0121::*:UAP=A4,UAPSNMP=A8,TMOUT=30,PAGE=60,PUWP=50,PEL
N=4,DBCHGMSG=INH,SNMPAUTHPID=*, SNMPPRIVPID=*;

To create a NE user with SNMPv3 security privilege of authNoPriv, with SHA as

authentication protocol -
ENT-USER-
SECU:CORIANT1:SNMPOPER:AM0121::*:UAP=A4,UAPSNMP=A2,TMOUT=30,PAGE=60,PUWP=50,PELN
=4,DBCHGMSG=INH,USERSECLEVEL=authNoPriv,SNMPAUTHPROT=SHA,SNMPAUTHPID=snmpv3TestA
u;

To create a NE user with SNMPv3 security privilege of noAuthNoPriv -

ENT-USER-
SECU:CORIANT1:SNMPOPER2:AM0121::*:UAP=A4,UAPSNMP=A2,TMOUT=30,PAGE=60,PUWP=50,PEL
N=4,DBCHGMSG=INH,USERSECLEVEL=noAuthNoPriv;

The following example creates a new user login, Malhotra85. The additional text string indicates where a remote
server public key is stored which is immediately stored in the user's first available user public key parameter:

ENT-USER-
SECU:TELLABS7100:Malhotra85:AM0105::*,A:UAP=A4,TMOUT=30,PAGE=60,PUWP=50,PELN=4,D
BCHGMSG=INH,KEYLCN="sftp://173.39.13.3/ssh/id_rsa.pub";

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM0121 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-USER-SECU
RTRV-USER-SECU
ED-USER-SECU
ED-SECU-SYS
RTRV-SECU-SYS

76.MTFP50/30, Rev B January 2018 Page 30-779

14. Enter Commands TL1 Command Reference Manual

ENT-VCG

Command Changes Since Previous Feature Package

• None.

Description
The ENT-VCG command instructs the network element (NE) to provision a virtual concatenation group. The group
may be provisioned in AUTO mode, in which case the NE also automatically provisions the necessary TTP entities,
or in manual mode, in which a provision of TTP entities prior to adding them to a VCG is required.

Restrictions and Exceptions

• Name-defined parameters can be entered in any order.

• A maximum of 32 VCGs can exist on a SSM at any given time

• The NVALUE is only applicable to a AUTO VCG, and can only be changed prior to a VCG
crossconnection.

• vcgType of MAN is the only value currently supported.

• The GRPIDPOLICY is an optional parameters which is used to indcated the port group which the VCG
is linked to if the GRPIDPOLICY is given, then the TTP which is planned to assign into this VCG uses
the same group id, otherwise NE responses error for the mismatched group id of the TTP. The
GRPIDPOLICY also can be not inputed, and the NE implicitly indicates the port gourp of the VCG based
on the TTP's which is given in ED-VCG

• On mTera SSM-2S working module that is in EPG group, edit VCG entity would implicitly edit VCG
entity on protection module.

• On mTera SSM-2S protection module that is in EPG group, an attempt to edit VCG entity would be
denied.

Command Format
ENT-
VCG:[tid]:<vcg_aid>:ctag::[<vcgType>]:[VCAT=<VcatType>][,ALMPF=<alarmProfile>]
[,CCPATH=<ccPath>]
[,GRPIDPOLICY=<GroupId>][,NVALUE=<NValue>][:<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>COMPLD<cr>lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-780 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 14. Enter Commands

Table 14.92 ENT-VCG Parameters

Parameter Value(s) Definition
vcg_aid VCG-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-n

vcgType AUTO Specifies what type of entities may be added to the virtual
MAN concatenation group.
Default: MAN vcgType=MAN, TTP entities are added to the VCG.
The TTPs must be explicitly created and cross-connected to
STS1, STS3C or STS12C prior to being added to the VCG.

VcatType STS1 Specifies the type of facilities that can be added as members of
STS3C the virtual concatenation group.

ccPath ADD Specifies the directionality of the virtual concatenation group.

DROP When vcgType=MAN, this is used to validate that the cross-
ADD/DROP connections between STSn and TTP are made correctly. When
Default: ADD/DROP vcgType=AUTO, this is used to determine the type of
connection to provision between the STSn and the TTP.
- ADD indicates that the VCG is a source only (supports 1WAY
or 1WAYBR connections)
- DROP indicates that the VCG is sink only (supports 1WAY or
1WAYPR connections)
- ADD/DROP indicates that the VCG is bidirectional (supports
2WAY, 2WAYPR, 2WAYAUTO connections)

GroupId [1-3] The GroupId is used to indicate the VCG id belonged to which
Default: 0 port group. Due to HW restriction , the list of ttpmap must
belong to same port group with VCG ID which TTPs are
assigned to

NValue [0-192] Specified the number of VcatType TTPs to be created.

Default: 0 Created TTPs are always added to the VCG.

- 1-192 (STS1 members)

- 1-64 (STS3C members)

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).
Default: IS

almProfile 0-20, 99 Specifies the new alarm profile table for the virtualconcatenation
group.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Example
Provision a VCG with STS3C members and manual provisioning of TTPs

ENT-VCG:CORIANT1:VCG-20-12-6:myctag::MAN:VCAT=STS3C, GRPIDPOLICY= 1

Possible System Response

^^^CORIANT1 05-02-08 07:45:00

M MYCTAG COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-781

14. Enter Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-VCG
ED-VCG
ENT-TTP
RTRV-VCG

Page 30-782 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 15. Inhibit Commands

15. Inhibit Commands

INH-BKUPSCHED-MEM

Command Changes Since Previous Feature Package

• None.

Description
Use the INH-BKUPSCHED-MEM command to inhibit the scheduled database backup from the source to the
destination at the times specified in the SCHED-BKUP-MEM command.

The name of the remote server for the scheduled backup is selected in the SCHED-BKUP-MEM command.

Command Format
INH-BKUPSCHED-MEM:[tid]:[<backup_mem_aid>]:ctag::[<datatype>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 15.1 INH-BKUPSCHED-MEM Parameters

Parameter Value(s) Definition
backup_mem_ SERVER EntityID
aid

datatype DB Specifies the type of backup memory that is the source.

Default: DB - Enter DB to specify the NE database.

Example
INH-BKUPSCHED-MEM:MONTREAL:SERVER:AM0027::DB;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15
M AM0027 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-783

15. Inhibit Commands TL1 Command Reference Manual

Related Commands
ALW-BKUPSCHED-MEM
RTRV-BKUPSCHED-MEM
SCHED-BKUP-MEM

Page 30-784 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 15. Inhibit Commands

INH-MSG-ALL

Command Changes Since Previous Feature Package

• None.

Description
INH-MSG-ALL instructs an NE to enter a mode in which certain automatic messages are prevented from being
transmitted to the OS. This applies to all supported entities.

This command only applies to the OS/NE or user session on which this command is sent. This command should not
have any effect on indicators in the office where the NE resides or on the NE itself.

During the entire period of message inhibition, the NE should continue to respond fully to RTRV-ALM and RTRV-
COND requests. The condition may be restored to normal with the ALW-MSG command.

Command Format
INH-MSG-ALL:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Example
INH-MSG-ALL:MONTREAL::AM0027;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15

M AM0027 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-MSG-ALL
RTRV-USER-SECU

76.MTFP50/30, Rev B January 2018 Page 30-785

15. Inhibit Commands TL1 Command Reference Manual

INH-PKT-SNMPV2

Command Changes Since Previous Feature Package

• None.

Description
The INH-PKT-SNMPV2 command provides the ability to turn off SNMPV2 on the network element for managing
the Packet Subsystem.

SNMPV2c provides read-only SNMP management of Packet subystem by using community strings. When this
command it run, it automatically deletes the default read-only community strings.

Restrictions and Exceptions

• This command is denied if SNMPV2 has already been turned off.

• This command applies to mTera in the DISABLED proxy mode. The proxy mode can be retrieved by
ED-PROXY command.

Command Format
INH-PKT-SNMPV2:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Example
INH-PKT-SNMPV2:::AM0011;

Possible System Response

^^^CORIANT1 05-11-15 02:08:15

M AM0011 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-PKT-SNMPV2

Page 30-786 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 15. Inhibit Commands

INH-PMFILE-{X}

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The INH-PMFILE-{X} command instructs the network element (NE) to enter a mode in which scheduled transfer of
historical PM reporting in binary file format, as established by the SCHED-PMFILE-{X} command, is inhibited.

The path PM parameters continue to be stored in the NE's database and should be available on demand via the
RTRV-PM-{X} command. Refer to the RTRV-PM-{X} command for a list of all supported PM.

Periodic reporting can be resumed by using the ALW-PMFILE-{X} command.

{X} specifies the facility type among the following AIDs:

Facilities (fac_type): STS1, STS3C, STS12C, STS48C, STS192C, OCH(for OCH-L), ODUF, ODU0, ODU1, ODU2,
ODU2E, ODU3, ODU4, OMS, OSC.

Restrictions and Exceptions

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• The Facility AID {fac_aid} must always correspond to the Facility type {fac_type}.

Command Format
INH-PMFILE-<fac_type>:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-787

15. Inhibit Commands TL1 Command Reference Manual

Table 15.2 INH-PMFILE-{X} Parameters

Parameter Value(s) Definition
fac_aid OCH-L-20-[10-16,1-7]-21-[1-96],OCH- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
L-20-[1-16]-1-[1-96] ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-21,OMS-20-[1-
16]-1
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

Page 30-788 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 15. Inhibit Commands

Table 15.2 INH-PMFILE-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_type OCH-L Specifies the facility type.
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
OMS
OSC

Example
INH-PMFILE-OTU1:MONTREAL:OTU1-20-1-1:AM0027;

Possible System Response

^^^MONTREAL 06-06-15 02:08:15

M AM0027 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-PMFILE-{X}
SCHED-PMFILE-{X}
RTRV-PMFILESCHED-{X}

76.MTFP50/30, Rev B January 2018 Page 30-789

15. Inhibit Commands TL1 Command Reference Manual

INH-PMREPT-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The INH-PMREPT-{X} command instructs the network element (NE) to enter a mode in which all scheduled PM
reporting, as established by the SCHED-PMREPT-{X} command, is inhibited.

The PM parameters continue to be stored in the NE's database and should be available on demand via the RTRV-
PM-{X} command. Refer to the RTRV-PM-{X} command for a list of all PM parameters supported.

Periodic reporting can be resumed by using the ALW-PMREPT-{X} command.

{X} specifies the equipment type or facility type among the following AIDs
• ALL

• Facilities (fac_type): ETH, FGE, GBEP, HGE, OC3, OC12, OC48, OC192, OCH (for OCH-P and OCH-
OS), OTU1, OTU2, OTU4, OTUC2, OTUC3, TGLAN.

Restrictions and Exceptions

• When OCH is used, it represents OCH, OCH-L, OCH-P, OCH-OS.

• When "ALL" is used as second modifier, the AID is optional and defaults to ALL.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• The facility AID must always correspond to the facility type.

Command Format
INH-PMREPT-{<fac_type>|ALL}:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-790 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 15. Inhibit Commands

Table 15.3 INH-PMREPT-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
TGLAN-20-[1-16]-[1-40]

Example 1
INH-PMREPT-OTU1:MONTREAL:OTU1-20-1-1:AM0027;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15
M AM0027 COMPLD
;

Example 2
INH-PMREPT-ALL:MONTREAL::AM0027;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15
M AM0027 COMPLD
;

Example 3
INH-PMREPT-GBEP:MONTREAL:GBEP-20-7-5:AM0027;

Possible System Response

^^^MONTREAL 02-03-15 02:08:15
M AM0027 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-791

15. Inhibit Commands TL1 Command Reference Manual

Related Commands
ALW-PMREPT-{X}

Page 30-792 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 16. Initialize Commands

16. Initialize Commands

INIT-REG-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The init-reg command is used to reset the PM register for a specific montype during the CURRENT PM
accumulation period. If the montype is a counter like then this command resets the counter to zero for the current
PM accumulated for either the 15-min or 24-hour period, depending on what is specified in <tmper> parameter.

When the montype is a gauge, then there are 3 PM values accumulated for each 15-min or 1-Day periods: 1) The
current value at the end of a period, 2) the highest values reached during the period, and 3) the lowest value reached
during this period. This command can be used to reset the highest value (for example, montype = x-C) or the lowest
value (for example, montype = x-F) to the current value.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): ETH, FGE, GBEP, HGE, OC3, OC12, OC48, OC192, STM1, STM4, STM16,
STM64, OCH (for OCH-L, OCH-P and OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4,
OTU1, OTU2, OTU4, OTUC2, OTUC3, OMS, OSC, STS1, STS3C, STS12C, STS48C, STS192C,
TGLAN.

Restrictions and Exceptions

• When no MONTYPE is specified, the command applies to all MONTYPES supported by the facility or
equipment.

• The facility AID must always correspond to the facility type.

• The facility "montype" must correspond to the facility type.

• Counters are always reset to zero and gauges are reset to their current value.

Command Format
INIT-REG-{fac_type}:[tid]:{<fac_aid>}:ctag::[<montype>],,[locn],
[<dirn>],[tmper],;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-793

16. Initialize Commands TL1 Command Reference Manual

Table 16.1 INIT-REG-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STM1-20-[1-16]-[1-32]

Page 30-794 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 16. Initialize Commands

Table 16.1 INIT-REG-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STM16-20-[1-16]-[1-32], STM16-20- EntityID-ShelfID-SlotID-PortID
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

montype x,x-C,x-F Specifies the type of performance monitoring for the specified
entity.
- x: To be used to specify current value for <montype> x.
- x-C: To be used to specify highest value for gauge <montype>
x. C=Ceiling.
- x-F: To be used to specify lowest value for gauge <montype>
x. F=Floor.

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies both directions.
TDTN - TDTC specifies Transmit direction toward customer.
RCV - TDTN specifies Transmit direction toward network.
TRMT - RCV specifies Receive direction.
NA - TRMT specifies Transmit direction.
- NA specifies the direction is not applicable.

locn NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end location.
The default is NEND. Only NEND is supported.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
Default: 15-MIN - Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

Example
The following example resets the loss-of-signal-seconds of a GBEP for the current 15-minute register to 0.

INIT-REG-GBEP::GBEP-20-3-5:AM0012::LOSS,,,,15-MIN,;

Possible System Response

^^^CHICAGO 14-04-16 02:08:15

M AM0012 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-795

16. Initialize Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-PM-{X}

Page 30-796 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 16. Initialize Commands

INIT-SYS

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The INIT-SYS command instructs the network element (NE) to initialize a specific module.

Phase 1 initialization, warm reboot, causes the specified module software to reboot while preserving its hardware
configuration. For TDM traffic, there is no impact to any data traffic.

Phase 3 initialization, cold reboot, is used to cold reset a module and install a firmware patch if one is available. This
may cause an interruption in traffic.

Phase 5 initialization, software and firmware patch installation, is used to install a software and firmware patch if
oneexists on a patchable module. Phase 5 may cause an interruption in traffic.
Restrictions and Exceptions
• Usage of CMDMODE=FRCD is required when the initialization action may be traffic impacting.

• For a shelf controller (ex. STPM,) any initialization phase is allowed only under the following
circumstances:
- The module is Standby
- The command is forced (CMDMODE=FRCD)

• Phase 3 initialization for non-shelf controller modules, cold reboot, is only allowed under the following
conditions:
- The module is manually OOS (OOS-*MA)
- The module is in the SHTDWN state

• Phase 5 initialization, patch installation, is denied when no patches are to be applied, or the module is
current with the system sotware and firnmware patch levels, or a system software upgrade is in process.

• The following modules do not run system software and only support phase 3 (PH=3) initialization:
- mTera: FAN, SDM, SAIM, SEIM, STIM
- 8-slot mTera: FAN8, SIOM.

• Firmware patching is supported using a cold restart (PH=3) for the following modules when their FPGA
version is "NOT_CURRENT":
- mTera: FAN, SDM, SAIM, SEIM, STIM
- 8-slot mTera: FAN8, SIOM.

• Only an INIT-SYS PH3 is allowed when a module is in the SHTDWN state

• Warm reboot (PH=1) is supported for the following modules (EQPT) to install a software patch: MFAB,
MFAB2, OADMRS, OADMRS9, OCC, OSM-2C, OSM-1S, OSM-2S, OSM-4C, OSM-4F, SSM-2S,
OSM-4S, OSM-5C, STPM, STPM8.

• Software/firmware patching (PH=5) is supported on the following modules (EQPT): CDCP, CFP, MFAB,
MFAB2, OADMRS, OADMRS9, OCC, OSM-2C, OSM-1S, OSM-2S, OSM-4C, OSM-4F, SSM-2S,
OSM-4S, OSM-5C, STPM, STPM8.

• When both a software patch and firmware patch are available for a module, phase 5 must be specified
with CDMODE=FRCD to load both patches. A cold reboot of the module take place and may cause an
interruption in traffic.

• This command is denied if the Control Plane is in the midst of call setup and/or call reroute operation.

76.MTFP50/30, Rev B January 2018 Page 30-797

16. Initialize Commands TL1 Command Reference Manual

• Phase 1 and 5 initialization for a module with a Y-cable FFP in WTR state is denied.

Command Format
INIT-SYS:[tid]:<aid>:ctag::<ph>:[,CMDMDE=<commandMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

If the restarted equipment is the STPM module acting as the active Controller, the following system response is
expected:
<header>

M^^<ctag>^COMPLD<cr><lf>

^^^/*Restarting the Controller module requires that the active TL1 session(s) on
the NE to be re-established once the restart operation is completed*/

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 16.2 INIT-SYS Parameters

Parameter Value(s) Definition
aid CFP-20-[1-16]-[1,2] EntityID-ShelfID-SlotID
CFP2-20-[1-16]-[1-5]
FAN-20-[29-32]
FAN8-20-[16,17]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SIOM-20-15
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

Page 30-798 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 16. Initialize Commands

Table 16.2 INIT-SYS Parameters (Continued)

Parameter Value(s) Definition
ph 1 Indicates whether the initialization phase is a cold or warm
3 restart.
5 - For a warm reboot enter: 1
- For a cold reboot and to install a firmware patch enter: 3
- For a software, and firmware if available, patch installation
enter: 5

commandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution (any state
inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

If MODE=FRCD is used and if Control Plane is in the midst of a

call setup and/or a call reroute, the calls may be left in an
undesirable state.

Example 1
To initiate OSM-2C with a warm restart:
INIT-SYS:CORIANT1:OSM2C-20-1:AM0010::1;

Example 2
To initiate SEIM with a cold restart:
INIT-SYS:CORIANT1:SEIM-20-21:AM0011::3;

Possible System Response

^^^CORIANT111-04-16 02:08:15

M AM0012 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

76.MTFP50/30, Rev B January 2018 Page 30-799

17. Install Commands TL1 Command Reference Manual

17. Install Commands

INSTALL-CEF

Command Changes Since Previous Feature Package

• None.

Description
Use the INSTALL-CEF command to install a Capability Extension File (CEF) on the NE.

Restrictions and Exceptions

• The CEF must be copied to the NE using the COPY-RFILE command before the INSTALL-CEF
command is initiated.

• The INSTALL-CEF command is denied when the installation file version is equivalent to the currently
installed version.

Command Format
INSTALL-CEF:[tid]::ctag:::FILE=<filename>;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;
/* The target NE has initiated the installation process. Autonomous message(s)
will follow to provide progress updates and to indicate the completion status of
the process. */

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 17.1 INSTALL-CEF Parameters

Parameter Value(s) Definition
filename A string of alphanumeric and special Specifies the Capability Extension File name to be installed on
characters between double quotes. the NE.
Specifying the file extension is optional.

Example
INSTALL-CEF:CORIANT1::AM1122:::FILE="FP1_0_PLUGTF_V2_CEF";

Page 30-800 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 17. Install Commands

Possible System Response

^^^CORIANT1 07-05-15 02:08:15
M AM1122 COMPLD
;
/* The target NE has initiated the installation process. Autonomous message(s)
will follow to provide progress updates and to indicate the completion status of
the process. */

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE
RTRV-RFILE
RTRV-CEF

76.MTFP50/30, Rev B January 2018 Page 30-801

17. Install Commands TL1 Command Reference Manual

INSTALL-SW

Command Changes Since Previous Feature Package

• None.

Description
Use the INSTALL-SW command to install the newly delivered software when the NE is in "Basic Commissioning"
mode only.

Restrictions and Exceptions

• As the command INSTALL-SW is available only in "Basic Commissioning", it is not processed by the
NE Agent during normal operation of the network element after the commissioning of the NE is
completed. It is rejected if executed.

• When the Force Option is used, this allows the software installed on the controller module (STPM) to
overwrite the software currently installed on the network element.

Command Format
INSTALL-SW:[tid]::ctag:::[CMDMDE=<commandMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

/* The target NE has initiated the unzip process. Autonomous message(s) will follow
to provide unzip progress and to indicate the completion status of the unzip
session. */

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 17.2 INSTALL-SW Parameters

Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution. When this
mode is specified, if the Module Replacement Management
checking for the controller module (ACTIVE SPM/SPMN)
detects an inconsistency, the controller module is returned to
Basic Commissioning following the execution of the INIT-SYS
command from the Basic Commissioning level.
Enter FRCD to specify a forced mode of execution. When this
mode is specified, the Module Replacement Management
checking for the controller module (ACTIVE SPM/SPMN) is
overruled and the NE automatically gets upgraded with the new
software version.

Page 30-802 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 17. Install Commands

Example
INSTALL-SW:CORIANT1::AM1122;

Possible System Response

^^^CORIANT102-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE

76.MTFP50/30, Rev B January 2018 Page 30-803

18. Measure Commands TL1 Command Reference Manual

18. Measure Commands

MEAS-OPTPWR::{X}

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The MEAS-OPTPWR::{X} command instructs the network element to perform an optical power measurement on the
specified equipment. This is a user-initiated measurement that is used to monitor the power levels on an equipment
of a specific channel or on a specific port of a transponder. The following optical power measurements can be done
on the mTera UTP network elements:

mTera UTP Optical Modules:

- On OADMRS (OADMRS-20), optical power measurement is
possible for:
- Optical power of OCH and OMS facilities on the DWDM TX/RX
interfaces (LST/LSR).
- Optical power of OCH Power at the output of the input amplifier,
in line-to-port direction (TDTC) (PST).
- Optical power of OMS at the input of the output amplifier, in port-
to-line direction (TDTN),(PSR).
- Optical power of OMS at the output of the input amplifier, in port-
to-line direction (TDTC) (PST).
- Optical power of OCH at the output of the Route WSS Ports in
TX direction (RST).
- OSC optical power in both TX/RX directions is also supported
(LST/ LSR).
- On OADMRS9, optical power measurement is possible for:
- Optical power of OCH and OMS facilities on the DWDM TX/RX
interfaces (LST/LSR).
- Optical power of OCH Power at the output of the input amplifier,
in line-to-port direction (TDTC) (PST).
- Optical power of OMS at the input of the output amplifier, in port-
to-line direction (TDTN),(PSR).
- Optical power of OMS at the output of the input amplifier, in port-
to-line direction (TDTC) (PST).
- Optical power of OMS at the "To ISD" port connected to a DCM
(DST).
- Optical power of OMS at the "From ISD" port connected to a
DCM (DSR).
- Optical power of OCH at the output of the Route WSS Ports in
TX direction (RST).
- OSC optical power in both TX/RX directions is also supported
(LST/ LSR).
Transponders:
- On the transponders such as OSM-2C, OSM-1S, OSM-2S, OSM-
4S, per-channel optical power measurement is supported on the
low-speed (client) port interface in TX/RX directions (PST/PSR)
and on DWDM high speed line interface in TX/RX directions (LST/

Page 30-804 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 18. Measure Commands

LSR).
On the transponders such as OSM-5C, per-channel optical power
measurement is supported on the low-speed (client) port interface
in TX/RX directions (PST/PSR)
On the OSM-2C, OSM-1S, OSM-2S, OSM-4S, OSM-5C, if a
facility has not yet been provisioned, the per-channel optical
power measurement is supported on the interface in the TX/RX
directions as PSR/PST.
On the OSM-2C, optical power measurement is supported on
multi-lane CFPs in the TX/RX directions as PSR/PST.
- On OSM-2C, aggregation optical power measurement is
supported on 100G coherent interface in the RX direction as LSR,
which show the power when multiple channel operation on the
coherent receiver.(LSR_OMS_OPT_PWR)
- On the transponders such as SSM-2S, per-channel optical power
measurement is supported on the port interface in TX/RX
directions (PST/PSR),
on the SSM-2S, if a facility has not yet been provisioned, the per-
channel optical power measurement is supported on the interface
in the TX/RX directions as PSR/PST.
- On the OSM-4C/OSM-4F, per-channel optical power
measurement is supported on the line interface in TX/RX
directions (LST/LSR).

76.MTFP50/30, Rev B January 2018 Page 30-805

18. Measure Commands TL1 Command Reference Manual

Figure 18.1 Optical Power Measurement Locations with OADMRS on mTera UTP NE
Optical Power Monitoring
with OADMRS Legend:
PSR
n OSM-5C LSR = Line Side RX
PST n=5 for OSM-5C LST = Line Side TX
PST = Port Side TX
PSR = Port Side RX
PSR RST = Route Side Tx
OSM-1S
n SSM-2S

OADMRS
PST n=32 for OSM-1S
n=30 for SSM-2S

PSR LST
n x OMD PSR LST
OSM-2C
PST OSM-2S
LSR
OSM-4S
LSR
RST PST
n,x=20 for OSM-2S
n,x=2 for OSM-2C
n,x=40 for OSM-4S

PSR LST
n x CDC
OSM-2C
PST LSR
LSR_OMS

n,x=2 for OSM-2C

LST LSR
OSM-4C LST (OSC)
x (OSC)
OSM-4F
LSR
x = 4 for OSM-4C
x = 2 for OSM-4F

Page 30-806 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 18. Measure Commands

Figure 18.2 Optical Power Measurement Locations with OADMRS9 on mTera UTP NE
Optical Power Monitoring
Legend:
with OADMRS9
PSR LSR = Line Side RX
n LST = Line Side TX
OSM-5C PST = Port Side TX
PST PSR = Port Side RX
n=5 for OSM-5C
RST = Route Side Tx

OADMRS9
PSR DSR = DCM Side Receive
OSM-1S
n SSM-2S DST = DCM Side Transmit

PST n=32 for OSM-1S

n=30 for SSM-2S

LST PSR LST

PSR
n x OMD/CD
OSM-2C
PST OSM-2S
LSR PST LSR
OSM-4S RST

WSS
n,x=20 for OSM-2S
n,x=2 for OSM-2C
n,x=40 for OSM-4S

LST
OSM-4C
x
OSM-4F
LSR
x = 4 for OSM-4C DST (ISD)
x = 2 for OSM-4F

DSR (ISD)

LSR
LST (OSC)
(OSC)

This command is generally non-intrusive (non-traffic affecting) and is allowed regardless if the equipment is IS (in-
service) or OOS (out-of-service).

For multi-lane pluggable transceivers (including those supported on CFP, the response for the MEAS-OPTPWR
command includes the aggregate power in the PST_OPT_PWR and PSR_OPT_PWR parameters, along with the
per lane power levels for the lanes which have the highest power and the lowest power of all the supported lanes
(PST_LANE_LOW_OPT_PWR, PST_LANE_HIGH_OPT_PWR, PSR_LANE_LOW_OPT_PWR,
PSR_LANE_HIGH_OPT_PWR). Additionally, the transmit and receive power in each individual lane can optionally
be returned.

For multiple channel operation of coherent receiver, the response for the MEAS-OPTPWR command includes both
the aggregate power of all the input channels LSR_OMS_OPT_PWR and the selected channel power
LSR_OPT_PWR. For non-coherent receiver LSR_OMS_OPT_PWR does not return.

{X} specifies the equipment type among the following AIDs:

• OADMRS, OADMRS9, OSM2C, OSM1S, OSM2S, OSM4C, OSM4F, OSM4S, OSM5C.

76.MTFP50/30, Rev B January 2018 Page 30-807

18. Measure Commands TL1 Command Reference Manual

Restrictions and Exceptions

• A "0" reading is an uncommon reading when reading the power of a facility supported by an SFP. With
some pluggable transceivers there is typically a non-zero value present even when the facility is not
connected.

• The PORT parameter is mandatory for the OSM-2C, OSM-1S, OSM-2S, OSM-4C, OSM-4F, SSM-2S,
OSM-4S, OSM-5C.

• When a measurement needs CHAN parameter to identify the measured points but it is not provided, the
command is denied.

• SIGDIR defaults as ALL. The command is denied if the specified SIGDIR is not supported by the
provided module or measurement combination.

• When CHAN=OCHEQUIP is specified, if there are no OCH's equipped an empty list is returned.

• 'An empty list is returned when the LANE parameter is specified for a pluggable which does not support
LANE power measurement.

Command Format
MEAS-
OPTPWR:[tid]:<eqpt_aid>:ctag:::[SIGDIR=<sigdir>][,CHAN=<chan>][,PORT=<port>][,LA
NE=<lane>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^"<eqpt_aid>::[CHAN=<chan>][,PORT=<port>][,LSR_OPT_PWR=<optical_power>][,LSR_O
MS_OPT_PWR][,LST_OPT_PWR=<optical_power>][,PST_OPT_PWR=<optical_power>][,PSR_OPT
_PWR=<optical_power>][,RST_OPT_PWR=<optical_power>][,PSR_LANE_LOW_OPT_PWR=<optic
al_power>][,PST_LANE_LOW_OPT_PWR=<optical_power>][,PSR_LANE_HIGH_OPT_PWR=<optica
l_power>][,PST_LANE_HIGH_OPT_PWR=<optical_power>][,LANE=<lane>][,PSR_LANE_OPT_PW
R=<optical_power>][,PST_LANE_OPT_PWR=<optical_power>][,CHANNEL_EQUIPPED=<ch_equi
p>][,PORT_EQUIPPED=<port_equip>]"<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-808 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 18. Measure Commands

Table 18.1 MEAS-OPTPWR::{X} Parameters

Parameter Value(s) Definition
eqpt_aid OADMRS-20-[10-16,1-7] EntityID-ShelfID-SlotID
OADMRS9-20-[1-16]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
SSM2S-20-[1-16]

sigdir LSR Specifies the optical signal location (Port, Line or Express) and
LST the signal direction (transmit or receive) of the channel under
PST test.
PSR - Enter LSR to specify Line Side Receive.
RST - Enter LST to specify Line Side Transmit.
ALL - Enter PST to specify Port Side Transmit.
- Enter PSR to specify Port Side Receive.
- Enter RST to specify ROUTE Side Transmit.

Notes:
1) OSM-2C, OSM-2S, OSM-4S support LST, LSR, PST, PSR
and ALL.
2) OSM-1S, SSM-2S, OSM-5C support PST, PSR and ALL.
3) OSM-4C, OSM-4F support LST, LSR and ALL.
4) OADMRS supports PST, PSR, LST, LSR, RST and ALL.
5) OADMRS9 supports PST, PSR, LST, LSR, DSR, DST and
ALL.

In each case, ALL returns all directions supported by the

module.

76.MTFP50/30, Rev B January 2018 Page 30-809

18. Measure Commands TL1 Command Reference Manual

Table 18.1 MEAS-OPTPWR::{X} Parameters (Continued)

Parameter Value(s) Definition
chan 1-96 Specifies the optical channel under test.
OMS ALL addresses multiple channels depending on the specified
OSC equipment:
ALL - ALL = 96 channels, OMS and OSC power value in 96-channel
OCHEQUIP with GRIDMODE = FIXED96_MTERA or
FIXED96_NOCHANPLAN on OADMRS/OADMRS9.
- ALL = 88 channels, OMS and OSC power value in 88-channel
with GRIDMODE = FIXED88_7100 on OADMRS/OADMRS9.
- ALL = 44 channels, OMS and OSC power value in 44-channel
with GRIDMODE = FIXED44_7100 on OADMRS/OADMRS9.
Note that the number 1-96 is the Num of OCH-L AID in
OADMRS/OADMRS9 in the cases with or without channel plan
configured on the module.
- OCHEQUIP values provides power measurement for all OCH
involved in a CRS.
- OMS value provides aggregate power measurement (OMS) on
OADMRS/OADMRS9 module in directions of LST, LSR, PST,
PSR and DSR, DST on OADMRS9. OMS must be used with
directions of LSR, LST, PSR, PST, DSR, DST or ALL for
aggregate power.
- OSC values provide power measurement of OSC signal on
OADMRS/OADMRS9 modules in both LST and LSR directions
and in. So OSC must be used with directions LSR, LST or ALL.

CHAN is only applicable on an OADMRS/OADMRS9. CHAN is

not returned on an OSM/SSM.

port [1-40], ALL Indicates the port number associated with the signal being
measured.

(1)1-20 for OSM-2S.

(2)1-2 for OSM-2C.
(3)1-32 for OSM-1S.
(4)1-30 for SSM-2S
(5)1-2 for OSM-4F
(6)1-4 for OSM-4C
(7)1-40 for OSM-4S
(8)1-5 for OSM-5C
(9)ALL

lane Possible values are: (1)1 to 4 on SR4, Specifies the lane number of multiple-lane pluggables such as
LR4 (2)1 to 10 on SR10, LR10 (3)ALL CFP. Range of values for LANE is determined by the part
number of the CFP that is present.

If a value is entered for LANE, then the PSR/PST info

(PSR_LANE_OPT_PWR and PST_LANE_OPT_PWR) for that
particular lane is returned.
ALL is supported to return the power level info for each lane.

If LANE is not entered, then the response does not include the
LANE and associated PSR/PST parameters.

port_equip YES Iindicates if a port side facility is provisioned AND if there is a

NO Pluggable Transceiver equipped on the specified port. If a port
side facility is provisioned and there is a Pluggable Transceiver
equipped then the value should be YES. If there is no port side
facility provisioned or there is no Pluggable Transceiver
equipped on the specified port, then the value should be NO.

Page 30-810 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 18. Measure Commands

Example 1
MEAS-OPTPWR:CORIANT1:OSM2S-20-1:AM0074:::SIGDIR=ALL,PORT=2;

Possible System Response

^^^CORIANT1 14-12-15 02:08:15

M AM0074 COMPLD

^^^"OSM2S-20-1::PORT=2,LST_OPT_PWR=(+0.3),LSR_OPT_PWR=(-15.0),PORT_EQUIPPED=YES"
;

Example 2
MEAS-OPTPWR:CORIANT1:OADMRS-20-1:AM0074:::SIGDIR=ALL,CHAN=OSC;

Possible System Response

^^^CORIANT1 14-12-15 02:08:15

M AM0074 COMPLD

^^^"OADMRS-20-1::CHAN=OSC,LSR_OPT_PWR=(-20.2),LST_OPT_PWR=(+0.5)"
;

Example 3
MEAS-OPTPWR:CORIANT1:OSM2C-20-1:AM0074:::SIGDIR=ALL,PORT=1,LANE=ALL;

Possible System Response

^^^CORIANT1 14-12-15 02:08:15

M AM0074 COMPLD

^^^"OSM2C-20-
1::PORT=1,PSR_OPT_PWR=(+0.1),PST_OPT_PWR=(+10.2),PSR_LANE_LOW_OPT_PWR=(-
10.0),PST_LANE_LOW_OPT_PWR=(-0.2),PSR_LANE_HIGH_OPT_PWR=(-
9.9),PST_LANE_HIGH_OPT_PWR=(+0.1),LANE=1,PSR_LANE_OPT_PWR=(-
10.0),PST_LANE_OPT_PWR=(-0.2),PORT_EQUIPPED=YES"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

76.MTFP50/30, Rev B January 2018 Page 30-811

19. Operate Commands TL1 Command Reference Manual

19. Operate Commands

OPR-ACO-ALL

Command Changes Since Previous Feature Package

• None.

Description
Use the OPR-ACO-ALL command to cut off office audible alarms without altering local alarms. Only currently active
alarms are affected.

Command Format
OPR-ACO-ALL:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Example
OPR-ACO-ALL:CORIANT1::CT23;

Possible System Response

^^^CORIANT1 16-02-29 02:04:06

M CT23 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

Page 30-812 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

OPR-ADMREROUTE

Command Changes Since Previous Feature Package

• None.

Description
The OPR-ADMREROUTE command instructs the network element (NE) to perform a CP ARR (administratively
requested reroute) for a specific call or all calls on a specific/affected TL.

Figure 19.1 Affected link: L1

Protection Path

Z Egress Node

L3

Ingress Node
A L2
L1 Working Path

Affected Path

Figure 19.2 Use case: call request (reroute from L1)

Protection Path

Z Egress Node

L3

Ingress Node
A L2
L1 Working Path

Rerouted Path

76.MTFP50/30, Rev B January 2018 Page 30-813

19. Operate Commands TL1 Command Reference Manual

Figure 19.3 Use case: call request with a set of links (L2, L3) to avoid

Protection Path

Z Egress Node

L3

Ingress Node
A L2
L1 Working Path

CP supports ARR of a specific connection at the call origination node or domain ingress node with or without ERO
information, because CP supports one or multiple CP connections per call.

CP tries to route over the ERO in the form of an explicit path when ARR a connection with ERO.

The connection path could be nominal working, current working connections for unprotected, dynamic reroute, 1+1,
full time calls, or nominal protect, current protect connections for 1+1, full time calls.

Figure 19.4 Use case: the request of ARR nominal working connection with ERO (L4, L5, L6) to route over at

Nominal Protect
Connection

Z Egress Node
L6
L5
L3
L4

Ingress Node
A L2
L1 Nominal Working
Connection

ingress node

Page 30-814 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Figure 19.5 Use case: ARR nominal working connection with ERO (L4, L5, L6) to route over succeed

Nominal Protect
Connection

Z Egress Node
L6
L5
L3
L4

Ingress Node
A L2
L1 Nominal Working
Connection

CP also supports to ARR a specific connection at call origination node or domain ingress node with cost
optimization. When cost optimization attribute is disabled, CP does not perform any checks on the relative cost of
the existing connection versus the new connection. When cost optimization option is enabled, CP performs routing
and path selection but also ensures that the cost of new connection is less than the existing connection.

Note, ARR with cost optimization applies to ARR a connection with or without ERO.

Figure 19.6 Use case: the request of ARR nominal working connection with cost optimization at ingress node

Nominal Protect
Connection

Z Egress Node
L6
L5
L3
L4

Ingress Node
A L2
L1 Nominal Working
Connection

76.MTFP50/30, Rev B January 2018 Page 30-815

19. Operate Commands TL1 Command Reference Manual

Figure 19.7 Use case: ARR nominal working connection with cost optimization succeed

Nominal Protect
Connection

Z Egress Node
L6
L5
L3
L4

Ingress Node
A L2
L1 Nominal Working
Connection

The command can be executed for a variety of protection/restoration schemes including: unprotected, dynamic
reroute, diverse path, full time.
The command can be executed for either repair node or intermediate node for a given call, please see restriction
details when ARR a specific connection of a given call.

The avoided link(s) could be none, a single element or a list of elements. When ARR a connection without ERO, its
is recommend to put the whole links contained in the existing RRO of the specified connection as the avoided links.

The NE attempts to reroute all calls/connections but that does not mean that all calls/connections are successfully
rerouted. It is possible that some may reroute successfully while some may not.

CP supports ARR request in NORM or FRCD mode. The ARR a connection in NORM mode is denied if the node
received the request has no capability to perform data plane hitless operations (B&R or OTN unprotected to
protected operations); The ARR in NORM mode continues ARR operation on data plane if the node received the
request has the capability data plane hitless operations.

The response of ARR command indicates error code SNVS and additional text "Operation Denied. The operation
may interrupt traffic. Use FRCD mode to allow traffic interruption" when the NORM mode request was denied by the
system.

Restrictions and Exceptions

• In order to prevent the reroute path from including a TL, either 1) set the TL OOS before executing this
command with a LINKAID attribute or 2) provide an EXPPATH that does not include the TL.

• The call to be rerouted must reside in the same node as the TL specified by the LinkAID.

• When ALL is specified for an administratively requested reroute, the notifications sequence follows the
order of restoration priority.

• Attempt to administratively requested reroute both paths (working and protection) of a call is denied by
the system.

• Input of DIVERSEFRM must be entered between quotes.

• An attempt to perform administratively requested reroute on the link which is not specified by GMPLS
mode INNI-V1 link profile is denied.

Page 30-816 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

• Attempt to ARR a connection with enabling OPTCOST is denied if CP cannot find lower cost connection
than the specified connection.

• LINKAID must be provided when ARR a call or all calls on the affected link.

• CONNPATH, EXPPATH, OPTCOST parameters only apply to ARR a connection at call origination or
domain ingress node.

• CONNPATH and CALLID must be provided when ARR a connection.

• CONNPATH, EXPPATH, CALLID must be provided when ARR a connection with ERO.

• CONNPATH, DIVERSEFRM must be provided when ARR a connection without ERO. Provide
DIVERSEFRM with at least one link from the existing route for the purpose to avoid reroute onto the
existing route.

• LINKAID and EXPPATH are mutual exclusive.

• LINKAID and enabling OPTCOST are mutual exclusive.

• The request is denied only the CONNPATH but no CALLID are provided.

• CONNPATH and CALLID must be provided when ARR a connection with enabling OPTCOST.

• ARR in NORM mode is denied if the node received the request has no capability to perform data plane
hitless operations (B&R or OTN unprotected to protected operations).

• Attempt to ARR a connection is denied regardless of the command mode if the connection is being
reverted (moving the traffic back to nominal connection).

Table 19.1 Parameters Applicability for ARR

ORIG INT/ DINGRSS
Call Location DEST

A A A specific Call(s) Call(s) A A A specific Call(s)

specific specific conn w/ on on specific specific conn w/ on
conn w/ conn w/o enabling affected affected conn w/ conn w/o enabling affected
Params in ARR ERO ERO OPTCOST link link ERO ERO OPTCOST link

LINKAID X X X M M X X X M

CALLID M M M O O M M M O

CONNPATH M M M X X M M M X

DIVERSEFRM O M O O O O M O O

EXPPATH M X O X X M X O X

OPTCOST O O M X X O O M X

CMDMDE O O O O O O O O O

Notes:
M: Mandatory params.
X: Cannot be specified.
O: Optional params.

Command Format
OPR-
ADMREROUTE:[tid]::ctag:::[LINKAID=<LinkAID>][,CALLID=<CallId>][,CONNPATH=<ConnPa
th>][,DIVERSEFRM=<Links>][,EXPPATH=<Expp_aid>][,OPTCOST=<Flag>][,CMDMDE=<Command
Mode>];

76.MTFP50/30, Rev B January 2018 Page 30-817

19. Operate Commands TL1 Command Reference Manual

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.2 OPR-ADMREROUTE Parameters

Parameter Value(s) Definition
LinkAID TL-[1,3]-[1-512]-[1-1500] Specifies the AID of the topological link.

CallId Up to a 55 character string in the This parameter represents the call to be administratively
following format: [CNTRY-CAR-AP- rerouted.
]TYPE-ADDRESS-ID. (1)CNTRY -
country code (3 alphabetic characters) If no value is specified, all calls riding on the affected link is re-
(2)CAR - carrier code (1 to 6 rerouted/re-signaled.
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

ConnPath NOM_WKG Specifies the connection of a given call to be rerouted.

NOM_PROT
CURR_WKG NOM_WKG - nominal working
CURR_PROT NOM_PROT - nominal protect
CURR_WKG - current working
CURR_PROT - current protect

Links Contains a list of route element that Specifies the links (route elements) that the new route should
are separated by comma. A route not pass (avoided links).
element is in the form of: Node-Ifindex.

Expp_aid EXPPATH-[1,3]-[1-512] Specifies the access identifier of the explicit path for specific
connection to reroute on.

Flag ENABLED Specifies the cost optimization enable or not when performs
DISABLED reroute calculation.
Default: DISABLED

CommandMod NORM Specifies the way in which the command is executed:

e FRCD Enter NORM to specify a normal mode of execution.
Default: NORM Enter FRCD to specify a forced mode of execution.

Example
For an unprotected call request with specifying one route element to be avoided.
OPR-ADMREROUTE:CORIANT1::CTAG:::LINKAID=TL-3-1-3,DIVERSEFRM="111.0.0.111-
040FBB03";

For a full time call request with specifying nominal protect connection to route over ERO defined in EXPPATH-3-10.
OPR-ADMREROUTE:CORIANT1::CTAG:::CALLID="IPV4-1.1.1.1-
A1B2C3D4",CONNPATH=NOM_PROT,EXPPATH=EXPPATH-3-10;

Page 30-818 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Possible System Response

^^^CORIANT1 09-01-15 05:08:15
M CTAG COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
REPT^EVT^CALL

76.MTFP50/30, Rev B January 2018 Page 30-819

19. Operate Commands TL1 Command Reference Manual

OPR-ARC-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
Use the OPR-ARC command to enter a state where alarm and event reporting is inhibited on equipment or on a
facility. When ARC is in operation, reports of standing alarms and events with REPT^ALM and REPT^EVT are
inhibited, except for clears of previously reported alarms and events, which continue to be sent. Reports of threshold
crossing alerts (TCA's) are also inhibited when ARC is in operation, and are also inhibited if alarm reporting is turned
back on within the same period as the raise of the TCA.

However, other transient events such as protection switch events are still reported when ARC is in operation.

The NE accepts OPR-ARC commands while ARC is in operation.

If an OPR-ARC command is received with a different ARC mode requested, the facility or termination transitions to
the requested ARC mode, as long as the request is a valid transition. If an OPR-ARC command is received with the
same ARC mode requested, the timer is reset.

Below are the ARC mode transitions supported by the system:

• from RLS to QI

• from QI to RLS

{X} specifies the facility or equipment type among the following AIDs:
• Facilities (fac_type):STM1, STM4, STM16, STM64, OC3, OC12, OC48, OC192, FGE, GBEP, TGLAN,
HGE, ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4, OTUC2, OCH-P,
OCH-OS, STS1, STS3C, STS12C, STS48C, STS192C, VCG.

Restrictions and Exceptions

• For mTera, ARC can apply to each facility independently, while there is no one overall control for whole
module.

• For STSn path entities, parameter <arcinterval> cannot be specified.

• The AID must always correspond to the type.

Command Format
OPR-ARC-{EQPT|<fac_type>}:[tid]:{<eqpt_aid>|<fac_aid>}:ctag[::[<arcmode>],
[<arcinterval>]];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Page 30-820 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.3 OPR-ARC-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]

76.MTFP50/30, Rev B January 2018 Page 30-821

19. Operate Commands TL1 Command Reference Manual

Table 19.3 OPR-ARC-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS12C-20-[1-16]-[1-30]-[181,- EntityID-ShelfID-SlotID-PortID
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
T1-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]
VCG-20-[1-16]-[1-32]

arcmode QI Specifies the mode of Alarm Report Control:

- QI: Qualified Inhibition

arcinterval [0-99]-[0-59] Specifies the time interval to be used in the operation of the
Alarm Report Control feature:
- HOD identifies the hours.
- MOH identifies the minutes.
The default ARC interval is 8-00. (Eight hours)

Example
OPR-ARC-OTU2:CORIANT1:OTU2-20-1-4:AM1122::,80-00;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RLS-ARC-{X}
RTRV-ARC-{X}

Page 30-822 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

OPR-CPSW

Command Changes Since Previous Feature Package

• None.

Description
The OPR-CPSW (Operate Control Plane Switch) command instructs the network element (NE) to initiate control
plane switching a specific call or all the calls in an NE. Request initiated with this command remains active until it is
released with the RLS-CPSW command.
• FREEZE - This inhibits the ingress node from rerouting a call due to network failures. Any notifications
raised on the frozen call(s) will still be generated.

• REVERT - This requests CP reversion from the path of current working/protect connection to the path
of nominal working/protect connection.

• MKPERM - This makes the path of current working/protect connection to be the path of permanent
(nominal) connection.

NE completes the request to freeze or unfreeze all calls, even if there are no calls which have the source node or
domain ingress node in the NE.

Restrictions and Exceptions

• Calls set up with service levels 1P1TWOSTRIKES, UNPROTECT, REROUTE, FULLTIME can be
frozen.

• NE denies the request to freeze or unfreeze a call which doesn't have either the source node or domain
ingress node in the NE.

• CALLID of ALL only applies to FREEZE command.

• CONNPATH only applies to MKPERM and REVERT but not FREEZE command.

• CONNPATH applies to REROUTE and FULLTIME calls. For REROUTE calls, the CONNPATH is
defaulted to CURR_WKG. For full time calls, the REVERT or MKPERM command is denied if the
CONNPATH is not specified.

• NE denies the REVERT or MKPERM command if the repair node is not on the NE where the restoration
was conducted.

• NE denies the REVERT or MKPERM command if the call has CP reversion set to NO.

• NE denies the REVERT or MKPERM command if the connection path is not rerouted due to network
failure.

• NE denies the REVERT command if the connection path has been rerouted due to network failure but
the nominal connection path is with SST of NRDYRVT.

• NE denies the REVERT or MKPERM command if the call is having another operation (for example,
ARR) in-progress.

Command Format
OPR-CPSW:[tid]::ctag::<cmd>:CALLID={<CallId>|"ALL"}[,CONNPATH=<connpath>];

76.MTFP50/30, Rev B January 2018 Page 30-823

19. Operate Commands TL1 Command Reference Manual

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.4 OPR-CPSW Parameters

Parameter Value(s) Definition
cmd FREEZE FREEZE: When the command is issued with a specific call id, it
REVERT freezes the call on the line (working or protection) it is operating;
MKPERM When it is issued with "ALL", it will freeze all the calls in the NE
that have either source nodes or domain ingress nodes in the
NE.
REVERT: It requests CP reversion from the path of current
working/protect connection to the path of nominal working/
protect connection.
MKPERM: It makes the path of current working/protect
connection to be the path of permanent (nominal) connection.

CallId Up to a 55 character string in the This parameter represents the call to be frozen. Use "ALL" to
following format: [CNTRY-CAR-AP- freeze all the calls that have ingress nodes in the NE.
]TYPE-ADDRESS-ID. (1)CNTRY -
country code (3 alphabetic characters)
(2)CAR - carrier code (1 to 6
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

connpath CURR_WKG Specifies the connection path (current working or current

CURR_PROT protect) that the CP reversion or Making Permanent will happen.

Example
To freeze all the calls in an NE:
OPR-CPSW:CORIANT1::AM1122::FREEZE:CALLID="ALL";

To revert the working connection of a full time call:

OPR-CPSW:CORIANT1::AM1122::REVERT:CALLID="IPV4-1.1.1.1-
A1B2C3D4",CONNPATH=CURR_WKG;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Page 30-824 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RLS-CPSW
RTRV-CALL

76.MTFP50/30, Rev B January 2018 Page 30-825

19. Operate Commands TL1 Command Reference Manual

OPR-EXT-CONT

Command Changes Since Previous Feature Package

• None

Description
The OPR-EXT-CONT command instructs the network element to operate an external control by closing the defined
output contact. The contact can be only operated continuously (momentarily is not supported). It can be released
by using the RLS-EXT-CONT command.

Restrictions and Exceptions

• SAIM-20-21 supports CONT-[1-2].

Command Format
OPR-EXT-CONT:[tid]:<cont_aid>:ctag::,;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.5 OPR-EXT-CONT Parameters

Parameter Value(s) Definition
cont_aid CONT-[1-2] EntityID-ContID

Example
The following command operates external contact #2 until the release command is sent:
OPR-EXT-CONT:CORIANT1:CONT-2:AM1122::,;

Possible System Response

^^^CORIANT1 13-12-04 02:08:15
M AM1122 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RLS-EXT-CONT
RTRV-EXT-CONT
SET-ATTR-CONT

Page 30-826 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

OPR-FINDRTE

Command Changes Since Previous Feature Package

• Extend SIGTYPE to support 200G.

Description
The OPR-FINDRTE command instructs the network element (NE) to find route information from a source node to a
destination node.

The OPR-FINDRTE command is designed to investigate routing error conditions. It allows to specify AEND, ZEND,
and intermediate node to which the route should be reached.

For the 2 port call, the extra parameters AEND2, ZEND2 and NODEID2 are allowed to be specified.

The following figure shows that it is possible to utilize the command to find a route for an unprotected or dynamic
re-route call by using intermediate nodes.

Figure 19.8 Find Route for Unprotected or Dynamic Reroute Call

Intermediate node of working

A END 2
1
m p Z END
b j 3
a 4

q
z

c d f

1. Find the route from A end to j node

2. Find the route from A end to m node
3. Find the route from A end to q node
4. Find the route from A end to Z end

Table 19.6 Find Route for Unprotected or Dynamic Reroute Call

Use Case Parameters Note
1, 2, 3 AEND=<EndPoint>,ZEND=<EndPoint>,NODE=<node_ WRKTONODE (intermediate node for
aid>,MULTIPLIER=1[,WKGTONODE=<node_id>]SIGT working) identifies the intermediate TO
YPE=<SignalType>[,WKGPATH=<expp_aid>][,SRLG= node to find the route to.
<Srlg>][,SLPF=<Slpf>];

4 AEND=<EndPoint>,ZEND=<EndPoint>,NODE=<node_ End to end route is returned, if found.

aid>,MULTIPLIER=1,SIGTYPE=<SignalType>[,WKGPA
TH=<expp_aid>][,SRLG=<Srlg>][,SLPF=<Slpf>];

76.MTFP50/30, Rev B January 2018 Page 30-827

19. Operate Commands TL1 Command Reference Manual

The following figure shows that it is possible to use the command to find both working and protection path for 1+1,
2 port, 2 port reroute or full time call in two major steps.

Figure 19.9 Find Route for Protected Call

Intermediate node of working

A END
1
2
m p Z END
b j
a 3

q
z

c d f
6

4 5
Intermediate node of working

First step: Find the working path from A end to Z end

1. Find the route from A end to j node
2. Find the route from A end to q node
3. Find the route from A end to Z end
Second step: Find the protection path from A to Z end
4. Find the route from A to c node
5. Find the route from A to f node
6. Find the route from A and Z

Table 19.7 Find Route for Protected Call

Use Case Parameters Note
1, 2 AEND=<EndPoint>,ZEND=<EndPoint>,NODE=<node_ WRKTONODE (intermediate node for
aid>,MULTIPLIER=1[,WKGTONODE=<node_id>],SIGT working) indicates the intermediate
YPE=<SignalType>[,WKGPATH=<expp_aid>][,SRLG= working TO node and only working path
<Srlg>][,SLPF=<Slpf>]; is calculated.

3 AEND=<A_EndPoint>,ZEND=<Z_EndPoint>,NODE=<n With WKGPATH specified the working

ode_aid>,MULTIPLIER=1,SIGTYPE=<SignalType>[,W path is calculated using the explicit path
KGPATH=<expp_aid>][,SRLG=<Srlg>] [,SLPF=<Slpf>]; and, if successful, the protect route is
calculated.

4, 5 AEND=<EndPoint>,ZEND=<EndPoint>,NODE=<node_ With PROTTONODE (intermediate

aid>,MULTIPLIER=1[,PROTTONODE=<node_id>],SIG node for protection) working path is
TYPE=<SignalType>[,PROTPATH=<expp_aid>][,SRLG calculated up to ZEND and, if
=<Srlg>][,SLPF=<Slpf>]; successful, protection path will only be
calculated up to intermediate TO
NODE.

6 AEND=<A_EndPoint>,ZEND=<Z_EndPoint>,NODE=<n Try to find both working and protection

ode_aid>,MULTIPLIER=1,SIGTYPE=<SignalType>[,W path.
KGPATH=<expp_aid>][,PROTPATH=<expp_aid>][,SRL
G=<Srlg>][,SLPF=<Slpf>];

Page 30-828 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Please note that the above examples are cases for 1+1 and full time call. For the 2-port call, the steps are same but
the extra parameters AEND2, ZEND2 and NODEID2 should be specified.

Restrictions and Exceptions

• WKGTONODE and PROTTONODE are mutually exclusive.

• The route information does not be presented, in case the route status has the value of NOATTEMPTED
or FAIL

• In case of the explicit protect path contains E-NNI interface, CP ignores the E-NNI interface and use the
E-NNI interface which specified in the explicit working path. The explicit protect path is not used in
signaling ( to the down stream domain), it is only used in the routing in the source domain.

• Since OPR-FINDRTE is only performing routing operation at the source node, it will retrun a route even
if the destination TNA doesn't support the specific signaling type.

• For OPR-FINDRTE, when an explicit path is used to specify an I-NNI hop in a different domain, specify
the first E-NNI level hop that enters the domain. Since the find route function calculates the route at the
source node, the system cannot be to determine correctly the intermediate node and link information.
Incorrect route information may be returned if the E-NNI hop is not provided.

• EXPRATE and GFPTS are mutually exclusive.

• The EXPRATE, GFPTS parameters only apply to ODUF_CBR,ODUF_GFP call.

• EXPRATE must be used to specify the rate of the client when find route for an ODUflex(CBR) call. CP
will calculate and fulfill the "bit rate" and calculate TSs. The required number of TS values is equal to:
Ceiling(ODUflex(CBR) nominal bit rate/ 1,249,409.620 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU2.
Ceiling(ODUflex(CBR) nominal bit rate/ 1,254,703.729 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU3.
Ceiling(ODUflex(CBR) nominal bit rate/ 1,301,709.251 kbit/s) x (1.0001/0.99998)), where
ODUflex(CBR) nominal bit rate = 239/238 x EXPRATE when the ODUF is multiplexed into an ODU4.

• GFPTS must be used to find route for an ODUflex(GFP) call by providing the number of 1.25G Tributary
Slots. The supported ODUflex(GFP) bit rate in the signaling object is GFPTS x1,249,177.230 kbit/s
when GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s when GFPTS = 9 to 32, or GFPTS x
1,301,467.133 kbit/s when GFPTS = 33 to 80.

Command Format
OPR-
FINDRTE:[tid]::ctag:::AEND=<EndPoint>,ZEND=<EndPoint>,NODE=<node_aid>[,AEND2=<En
dPoint>,ZEND2=<EndPoint>,NODEID2=<node_id>],MULTIPLIER=<MultiplierValue>[,WKGTON
ODE=<node_id>][,PROTTONODE=<node_id>],SIGTYPE=<SignalType>[,WKGPATH=<expp_aid>][
,PROTPATH=<expp_aid>][,WKGXPATH=<exdp_aid>][,PROTXPATH=<exdp_aid>][,SRLG=<Srlg>]
[,SLPF=<Slpf>]aid>][,EXPRATE=<ExpClientRate>][,GFPTS=<nmbrOfTS_GFPclient>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^"CONNPATH=<ConnPath>,STATUS=<findrte_status>[,ROUTE=<routeElements>] <cr><lf>
+ ;<cr><lf>";

76.MTFP50/30, Rev B January 2018 Page 30-829

19. Operate Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.8 OPR-FINDRTE Parameters

Parameter Value(s) Definition
EndPoint Enter type-xxx.xxx.xxx.xxx format: (1) The EndPoint is a TNA.
type is one of the following: IPV4
(2)xxx = 0-255

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier.

node_id [0-255].[0-255].[0-255].[0-255] Specifies the node id.

The parameter NODEID2 is used to specify the second source
node of a 2-port call.

MultiplierValue [1-32] This value is used to indicate the number of channels of

SignalType used in the call.

Note only MultiplierValue=1 supported for OTN services.

SignalType ODU0 The connection type of the call.

ODU1
ODU2
ODU2e
ODU3
ODU4
ODUF_CBR
ODUF_GFP
OTU2
OTU2e
OTU4
STS1
STS3C
STS12C
STS48C
STS192C

expp_aid EXPPATH-[1,3]-[1-512] Specifies the access identifier of the explicit path being refered
for a call.

exdp_aid EXDPATH-[1,3]-[1-512] Specifies the access identifier of the excluded path being
refered for a call.

Srlg A double quoted input string of up to Specifies that Shared Risk Link Groups is avoided.
32 comma separated 4 byte hex The Hex string is a group of 4 hex byte strings representing the
strings. SRLGs to avoid.
Default: "" (empty string)
Example:
"3E04990A,044D1A0C"

Page 30-830 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Table 19.8 OPR-FINDRTE Parameters (Continued)

Parameter Value(s) Definition
ExpClientRate A fixed integer value between Specifies the expected signal rate of the constant bit rate
2488022 and 103688578. mapped client within the payload of the ODUflex.

This value is used by the system to determine the

ODUflex(CBR) "Bit Rate" in the RSVP signaling object. For a
terminated ODUF, the expected client rate is the same as the
Expected Rate of the GOPT facility that is mapped into the
ODUF. The number is specified in Kbps.
A fixed integer value between 2488022 and 9952261 when the
ODUF is supported by an OSM-2S.
A fixed integer value between 2488022 to 103688578 when the
ODUF is supported by an OSM-2C.

nmbrOfTS_GF [1-80] Specify the ODUflex(GFP) rate by entering the number of 1.25G
Pclient Tributary Slots when the ODUflex supports a GFP client.

This value is used by CP to determine the ODUflex(GFP) "Bit

Rate" in the RSVP signaling object.

The supported ODUflex(GFP) rate is GFPTS x 1,249,177.230

kbit/s when GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s
when GFPTS = 9 to 32, or GFPTS x 1,301,467.133 kbit/s when
GFPTS = 33 to 80.

ConnPath NOM_WKG It indicates the path of the route information that found or
NOM_PROT verified.
Since this command does not lead to a call establishment, the
reroute verified could be targeted as nominal connection for call
creation. There is never current connection displayed in
response.

findrte_status NOTATTEMPTED It indicates the status of returned route information:

FAIL NOTATTEMPTED: (Not Attempted) protection route not
STPATZEND attempted because working route not found, no route is
STPATTONODE returned.
PRTL FAIL: (Failed) failed to find a route, no route is returned.
SUCCESS STPATZEND: (Stopped at ZEND) reached ZEND before the
specified TONODE.
STPATTONODE: (Stopped at an intermediate node) found
route up to intermediate TONODE.
PRTL: (Partial) cannot reach ZEND (or TONODE), partial route
is returned.
SUCCESS: (Success) successfully found a route, complete
route is returned.

routeElements Contains a list of route element that In case of source and destination are the same, the route
are separated by comma. A route information is displayed as a quoted empty string.
element is inform of (S|L)-nodeID- For partial route, F-nodeId-FFFFFFFF indicates the hop cannot
IfIndex[-Label] (1)IfIndex is 8 be route off.
hexadecimal digits. (2)Label is 8 F-nodeID-Ifindex indicates that the given link has problem(s) on
hexadecimal digits for non ODUk the hop.
labels or G.709 V2 ODUk labels; Label
is a multiple of 8 hexadecimal digits for Example:
G.709 V3 ODUk/j/flex labels. "S-111.0.10.0-020FAA01,S-111.0.0.110-030FBB02"
If not route can be found, an empty quoted string is returned ""

Slpf_AID SLPF-[99,1-20], Service level profile to be configured by the customer. If not

NONE specified, the call has the default SLPF-99.
Default: SLPF-99

76.MTFP50/30, Rev B January 2018 Page 30-831

19. Operate Commands TL1 Command Reference Manual

Example1
OPR-FINDRTE:CORIANT1::AM0074::: AEND=IPV4-111.111.111.111,ZEND=IPV4-
222.222.222.222,NODE=NODE-3-1,MULTIPLIER=1,
SIGTYPE=STS1,WKGTONODE=123.023.022.21, WKGPATH=EXPPATH-3-1 ;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

"CONNPATH=NOM_WKG,STATUS=SUCCESS,ROUTE=\"S-111.0.10.0-020FAA01,S-111.0.0.110-
030FBB02,S-111.0.0.111-040FBB03\""

Example2
In this case, the goal is to find a route for a 1+1 service. Both working and protection route are found.
OPR-FINDRTE:CORIANT1::AM0074::: AEND=IPV4-111.111.111.123,ZEND=IPV4-
222.222.222.234, NODE=NODE-3-2,MULTIPLIER=1,SIGTYPE=ODU2,WKGPATH=EXPPATH-3-
1,PROTPATH=EXPPATH-3-2,SLPF=SLPF-3;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

"CONNPATH=NOM_WKG,STATUS=SUCCESS,ROUTE=\"S-111.0.10.0-020FAA01,S-111.0.0.110-
030FBB00,S-111.0.0.111-040FBB03\""
"CONNPATH=NOM_PROT,STATUS=SUCCESS,ROUTE=\"S-111.0.10.0-020FAAA1,S-111.0.0.220-
030FAA03,S-111.0.0.123-040FBBFF\""

Example3
In this case, the goal is to find a route for a 1+1 service. The working route is found, but failed to find protection route.
OPR-FINDRTE:CORIANT1::AM0074::: AEND=IPV4-111.111.111.123,ZEND=IPV4-
222.222.222.234, NODE=NODE-3-2,MULTIPLIER=1,SIGTYPE=ODU2,WKGPATH=EXPPATH-3-
1,SLPF=SLPF-3;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

"CONNPATH=NOM_WKG,STATUS=SUCCESS,ROUTE=\"S-111.0.10.0-020FAA01,S-111.0.0.110-
030FBB02,S-111.0.0.111-040FBB03\"
CONNPATH=NOM_PROT,STATUS=FAIL"

Page 30-832 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Example4
In this case, the goal is to find a route for a 1+1 service. A partial route is found for working, protection path is not
attempted.
OPR-FINDRTE:CORIANT1::AM0074::: AEND=IPV4-111.111.111.123,ZEND=IPV4-
222.222.222.234, NODE=NODE-3-2,MULTIPLIER=1,SIGTYPE=ODU2,WKGPATH=EXPPATH-3-
1,SLPF=SLPF-3;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

"CONNPATH=NOM_WKG,STATUS=PRTL,ROUTE=\"S-111.0.10.0-020FAA01,S-111.0.0.110-
030FBB02,F-111.0.0.111-FFFFFFFF\"
CONNPATH=NOM_PROT,STATUS=NOTATTEMPTED"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-CALL

76.MTFP50/30, Rev B January 2018 Page 30-833

19. Operate Commands TL1 Command Reference Manual

OPR-LPBK-{X}

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

• Added support for 300G on OSM-4F.

Description
The OPR-LPBK-{X} command instructs the network element (NE) to operate a loopback on the selected port side
or line side facility entity supported by a transponder. If the specified termination/facility is currently in the IS-NR (in-
service, normal) or IS-ANR (in-service, abnormal) state, it must be put OOS-MA before executing the command.

Refer to the Suported Loopbacks figure below.

Figure 19.10 Supported Loopbacks

Line Side

Line Facility Line Terminal

Port Facility Port Terminal

Port Side

{X} specifies the facility type among the following:

• STM1, STM4, STM16, STM64, OC3, OC12, OC48, OC192, FGE, GBEP, TGLAN, HGE, OCH (for
OCH-P and OCH-OS), OTU1, OTU2, OTU4.

Restrictions and Exceptions

• Port side Loopbacks are supported on Port side facilities, while Line Side Loopback are supported on
OCH-P/OCH-OS Line side facility.

• The facility AID must always correspond to the facility type.

• The facility must be placed OOS before a loopback may be enabled.

• For OSM-4F, when the modulation format is configured as 2X150G8QAM, it uses two OCh-OS facilities
(as coupled OCH-OS). In this configuration, to operate facility or terminal loopback, the following steps
is observed:
- both OCH-OS facilities must be taken OOS before issuing any loopback command;
- the loopback command is issued to the OCH-OS facility on port-1;
- if the loopback command is issued to OCH-OS facility on port-2, it is denied;
- if any of the two OCH-OS facility is not OOS, the command is denied.

Page 30-834 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Command Format
OPR-LPBK-<fac_type>:[tid]:{<fac_aid>|<och-p_aid>|<och-
os_aid>}:ctag::,,,[<lpbktype>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.9 OPR-LPBK-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
TGLAN-20-[1-16]-[1-40]

lpbktype FACILITY Specifies the type of loopback that is applied on this equipment:
TERMINAL FACILITY: Loops the signal back towards the customer for client
Default: FACILITY port side facility, or toward DWDM network for OCH-P/OCH-OS
line side facility.
TERMINAL: Loops the signal back towards the DWDM network
for client port side facility or toward the customer for OCH-P/
OCH-OS Line side facility.

Example
OPR-LPBK-STM1:CORIANT1:OC48-20-1-7:AM1122::,,,TERMINAL;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-835

19. Operate Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RLS-LPBK-{X}

Page 30-836 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

OPR-PING

Command Changes Since Previous Feature Package

• None.

Description
The OPR-PING command instructs the network element (NE) to send an echo request message to another TCP/IP
node to determine if the node is visible on the network.

Restrictions and Exceptions

• Command is denied if an OPR-PING or OPR-TRACE-ROUTE command is already in progress.

Command Format
OPR-
PING:[tid]::ctag::<ip_address>:[TMOUT=<ping_timeout>][,PKTSIZE=<ping_pktsize>][,
PKTCNT=<ping_pktcnt>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<ip_address> is alive"*<cr><lf>
;

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<ip_address>, no answer"*<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.10 OPR-PING Parameters

Parameter Value(s) Definition
ip_address [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the destination node.

The following IP addresses does not be allowed:

224-255.xxx.xxx.xxx
169.254.xxx.xxx
127.xxx.xxx.xxx
1.xxx.xxx.xxx
0.xxx.xxx.xxx

ping_timeout [1-5] Specifies the time (in seconds) before giving up waiting for a
Default: 1 response to the PING echo request.

ping_pktsize [0-1024] Specifies the size of the data portion of the PING PDU.
Default: 32

ping_pktcnt [1-32] Specifies the number of ping packets to send.

Default: 1

76.MTFP50/30, Rev B January 2018 Page 30-837

19. Operate Commands TL1 Command Reference Manual

Example
Possible Command and System Response for a ping sent three times.
OPR-PING:CORIANT1::AM0102::"234.234.3.4":PKTCNT=3;

Possible System Response

^^^CORIANT1 02-02-02 00:50:03

M AM0102 COMPLD

^^^"234.234.3.4 is alive"
^^^"234.234.3.4 is alive"
^^^"234.234.3.4 is alive"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-TRACE-ROUTE

Page 30-838 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

OPR-PROTNSW-{x}

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The OPR-PROTNSW-{x} (Operate Protection Switch facility) command instructs a network element (NE) to initiate
a protection switch request. Switch requests initiated with this command (that is, forced switch, lockout, and manual
switch) remain active until they are released via the RLS-PROTNSW-{x} command or overridden by a higher priority
protection switch request. This command may not require a switch to occur. It may be used to upgrade the priority
of a line already on protection; for example, to upgrade the priority of a channel automatically switched to protection
to a "forced" switch.

When the Switch command parameter is specified as LOCKOUT, protection switching for the specified AID is
inhibited.

This command causes a switch from the AID specified to its associated AID in the protection scheme. This
command can also be used to lockout the protection.

If AID is working, then service is switched from working to protect. after a manual or force switch is completed. If
AID is protect, then service is switched from protecting to working when a manual or force switch is completed. When
a lockout is completed, it prevents service from switching to the protection AID. If service is already on protection, it
is switched back to working.
{X} specifies the facility type among the following:

• Facilities (fac_type): EQPT, HGE, OC3, OC12, OC48, OC192, STM64, ODUF, ODU0, ODU1, ODU2,
ODU2E, ODU3, ODU4, STS1, STS3C, STS12C, STS48C, STS192C, TGLAN.

Restrictions and Exceptions

• The AID must always correspond to the type.

• OC3, OC12, OC48, OC192, STS1, STS3C, STS12C, STS48C, STS192C are applicable when
supported by the SSM-2S modules.

• ODUk are only applicable if they are supported on the OSM-1S, OSM-2S, OSM-2C, OSM-4C, OSM-
4F, OSM-4S, OSM-5C.

• The specified entity must be associated with an FFP or PPG.

• HGE, TGLAN, OC192 or STM64 must be associated with a YCABLE protection group.

• EQPT is only applicable if they are supported on the SSM-2S for EPG (Equipment Protection Group).

• The system denies the administrative switch request if the priority of the administrative switch request
is not higher than the current state or previous existing command.

• EXER is only valid in bidirectional SNC protection group

Command Format
OPR-PROTNSW-{fac_type}:[tid]:<fac_aid>:ctag::<swcmd>;

76.MTFP50/30, Rev B January 2018 Page 30-839

19. Operate Commands TL1 Command Reference Manual

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.11 OPR-PROTNSW-{x} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
HGE-20-[1-16]-[1-5]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
SSM2S-20-[1-16]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]

Page 30-840 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Table 19.11 OPR-PROTNSW-{x} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS3C-20-[1-16]-[1-30]-[190,- EntityID-ShelfID-SlotID-PortID
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

swcmd FRCD Specifies the protection command that is applied on this facility
LOCKOUT (such as, forced switch, lockout and manual switch as well as
MAN exercise).
EXER - FRCD: Forced switch of working to protection line, forced
switch of protection line to working line.
- LOCKOUT: Lockout of protection line.
- MAN: Manual switch of working line to protection line, manual
switch of protection line to working line.
-EXER: exercise is a command to test if APS channel is
operating correctly but it doesn't trigger the real switching.

Example 1
OPR-PROTNSW-ODU2:CORIANT1:ODU2-20-1-3-1:AM1122::MAN;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Example 2
OPR-PROTNSW-EQPT:CORIANT1:SSM2S-20-5:AM1122::FRCD;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RLS-PROTNSW-{x}

76.MTFP50/30, Rev B January 2018 Page 30-841

19. Operate Commands TL1 Command Reference Manual

OPR-SYNCSW

Command Changes Since Previous Feature Package

• None.

Description
The OPR-SYNCSW command instructs the network element (NE) to request a manual switch command (possibly
force switch, lockout in the future) to one of the nominated synchronization references. A switch occurs if the
"switched to" reference is IS-NR (in-service, normal). A manual switch can be preempted by another manual switch.

Restrictions and Exceptions

• The commanded reference must be one of the configured synchronization references (provisioned via
the ENT-SYNC command, and retrievable via the RTRV-SYNC command).

• A Manual Switch command is denied if it would cause a switch to a failed reference or a reference that
is not provisioned.

Command Format
OPR-SYNCSW:[tid]:<sync_aid>:ctag::<switchto>;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.12 OPR-SYNCSW Parameters

Parameter Value(s) Definition
switchto T1-20-[15,23,26]-[1,2], Specifies the target (destination, or "switched to") reference
E1-20-[15,23,26]-[1,2], access identifier. It is not the current active reference. It can be
2MH-20-[15,23,26]-[1,2], any of the reference clocks selected.
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

Example
OPR-SYNCSW:CORIANT1:SYNC-20-1:CTAG::STM16-20-2-4;

Page 30-842 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SYNC
RLS-SYNCSW

76.MTFP50/30, Rev B January 2018 Page 30-843

19. Operate Commands TL1 Command Reference Manual

OPR-TRACE-ROUTE

Command Changes Since Previous Feature Package

• None.

Description
The OPR-TRACE-ROUTE command instructs the network element (NE) to send probe packets that attempt to trace
a path to the destination node.

Restrictions and Exceptions

• Command is denied if an OPR-PING or OPR-TRACE-ROUTE command is already in progress.

Command Format
OPR-TRACE-
ROUTE:[tid]::ctag::<ip_address>:[TMOUT=<trace_timeout>][,PKTSIZE=<trace_pktsize>
][,HOPCNT=<trace_hopcnt>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"HOPCNT=<trace_hopcnt>,RSP=<trace_rsp>[,RSPADDR=<trace_rspaddr>,RSPTIME=<trac
e_rsptime>]"*<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.13 OPR-TRACE-ROUTE Parameters

Parameter Value(s) Definition
ip_address [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the destination node.

trace_timeout [1-5] Specifies the time (in seconds) before giving up waiting for a
Default: 1 response to the probe packet.

trace_pktsize [0-1024] Specifies the size of the data portion of the traceroute message.
Default: 32

trace_hopcnt [1-32] Specifies the number of hops that the traceroute message will
Default: 10 traverse.

trace_rsp RCV Specifies the response status.

NONE RCV indicates a successful response was received that will
include a response address and time.
NONE indicates that no response was received.

trace_rspaddr [0-255].[0-255].[0-255].[0-255] Identifies the IP address at that specific hop in the route.

trace_rsptime any integer Identifies the amount of time to receive response to a traceroute
message.

Page 30-844 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Example
OPR-TRACE-ROUTE:CORIANT1::AM0102::"172.23.115.16":HOPCNT=9;

Possible System Response

System response for a successful traceroute of 9 hops, with response time given in milliseconds (ms).
^^^CORIANT1 02-02-02 00:50:03

M AM0102 COMPLD

^^^"HOPCNT=1,RSP=RCV,RSPADDR=\"172.23.125.251\",RSPTIME=0"
^^^"HOPCNT=2,RSP=RCV,RSPADDR=\"172.23.115.16\",RSPTIME=2"
;

System response for an unsuccessful traceroute of 9 hops, with response time given in milliseconds (ms).
^^^CORIANT1 02-02-02 00:50:03

M AM0102 COMPLD

^^^"HOPCNT=1,RSP=RCV,RSPADDR=\"172.23.125.251\",RSPTIME=4"
^^^"HOPCNT=2,RSP=NONE"
^^^"HOPCNT=3,RSP=NONE"
^^^"HOPCNT=4,RSP=NONE"
^^^"HOPCNT=5,RSP=NONE"
^^^"HOPCNT=6,RSP=NONE"
^^^"HOPCNT=7,RSP=NONE"
^^^"HOPCNT=8,RSP=NONE"
^^^"HOPCNT=9,RSP=NONE"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-PING

76.MTFP50/30, Rev B January 2018 Page 30-845

19. Operate Commands TL1 Command Reference Manual

OPR-UPG-ABORT

Command Changes Since Previous Feature Package

• None

Description
Use the OPR-UPG-ABORT command to abort the software upgrade process. When this command is executed, the
NE will uninstall the new software release being installed and fall back to the previous software load.

This command is also used to abort the software patching process. When this command is executed after a Patch
Load File delivery to the NE but before applying the Patch Load File, the upgrade state of the NE returns to NONE
and software remains unchanged.

Restrictions and Exceptions

• This command is not valid for patching after a Patch Load Package has been applied/installed on the
NE.

• The command may be retried when the software upgrade process is in the "ABORTFAIL" state.

Command Format
OPR-UPG-ABORT:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
None

Example
OPR-UPG-ABORT:CORIANT1::AM1122;

Possible System Response

^^^CORIANT1 11-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-846 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Related Commands
COPY-RFILE
OPR-UPG-COMMIT
OPR-UPG-EXECUTE
OPR-UPG-INSTALL
OPR-UPG-PATCHAPPLY

76.MTFP50/30, Rev B January 2018 Page 30-847

19. Operate Commands TL1 Command Reference Manual

OPR-UPG-COMMIT

Command Changes Since Previous Feature Package

• None.

Description
Use the OPR-UPG-COMMIT command to commit the newly executed software.

Restrictions and Exceptions

• Control plane software will only be started after a successfully executed OPR-UPG-COMMIT
command.

• System denies NORM commit, if not all call instances can be upgraded into the new software load. Use
FRCD mode to force the commit.

• In case of a forced commit, the calls which failed the upgrade does not be recovered and is dropped in
a subsequent reset of the system controller. However, the associated resources (cross connects, term
points and so on) does not be dropped.

• When the upgrade state is "Execute - Partial", the command is denied unless using the FRCD mode.

Command Format
OPR-UPG-COMMIT:[tid]::ctag::[<commandMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 19.14 OPR-UPG-COMMIT Parameters

Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

Example
OPR-UPG-COMMIT:CORIANT1::AM1122;

Page 30-848 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE
OPR-UPG-ABORT
OPR-UPG-EXECUTE
OPR-UPG-INSTALL

76.MTFP50/30, Rev B January 2018 Page 30-849

19. Operate Commands TL1 Command Reference Manual

OPR-UPG-EXECUTE

Command Changes Since Previous Feature Package

• None.

Description
Use the OPR-UPG-EXECUTE command to execute the newly installed software.

The Upgrade Campaign list containing all modules in the NE is created when this command is issued from the Install
state. The Upgrade Campaign list defines the set of modules to receive and run upgraded software.

The Standby system controller software is upgraded and initializes such that it is running the new software and is
capable of becoming the Active system controller.

The NE will coordinate system and shelf controllers, and all modules in the Upgrade Campaign list to minimize any
control outages during the upgrade process.

The initially Standby system controller iscome Active enabling seamless transition between controllers.

The NE monitors all modules in the Campaign List and will report Execute Completed when all modules are running
the upgraded software.

It is possible that not all modules in the Campaign List complete their upgrade, in this case, the Upgrade State
indicates Execute Partial. This command may be iteratively issued until Execute completes, Execute is aborted, or
Upgrade Commit is forcibly issued.

Restrictions and Exceptions

• Active and Standby system controllers (example: STPM) in each shelf of the NE must be IS-NR,
otherwise the command is denied.

• The SW Upgrade State must be INSTCOMPLD or EXECPARTIAL.

• The Upgrade Campaign list is determined when command is issued and the SW Upgrade State is
INSTCOMPLD. Once the list is created, it remains fixed through the upgrade process.

Command Format
OPR-UPG-EXECUTE:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Page 30-850 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 19. Operate Commands

Parameters
None

Example
OPR-UPG-EXECUTE:CORIANT1::AM1122;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-UPG-ABORT
OPR-UPG-COMMIT
RTRV-UPG-STATE

76.MTFP50/30, Rev B January 2018 Page 30-851

19. Operate Commands TL1 Command Reference Manual

OPR-UPG-PATCHAPPLY

Command Changes Since Previous Feature Package

• None

Description
Use the OPR-UPG-PATCHAPPLY command to install software and firmware patch files from the Patch Load
Package to the active software directory on the NE.

Restrictions and Exceptions

• This command can only be executed if the upgrade state of the NE is PATCHDELVCOMPLD.

Command Format
OPR-UPG-PATCHAPPLY:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
None

Example
OPR-UPG-PATCHAPPLY:CORIANT1::MK1022;

Possible System Response

^^^CORIANT1 11-04-16 02:08:15

M MK1022 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE
OPR-UPG-ABORT
INIT-SYS

Page 30-852 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

20. Report - Autonomous Messages

REPT^ALM

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The report alarm message is generated when an alarm condition is met or cleared on an equipment entity, facility
or logical entity. The verb, modifiers, and parameters used in report alarm autonomous messages are provided
below. The parameters and their domains are defined in Equipment Alarm Table in section 6.

Parameters enclosed in brackets may or may not appear in the message.

The report alarm message includes one of the following as part of the message name:
• EQPT

• SLOT

• <fac_type>: ETH, GBEP, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L, OCH-P, OCH-OS),
ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4, OTU2C, OMS, OSC, OTS,
STM1, STM4, STM16, STM64, TGLAN, STS1, STS3C, STS12C, STS48C, STS192C, TTPSTS1,
TTPSTS3C, VCG.

• <log_type>: NTPPEER, SW, RSVPADJ, SWITCHDOMAIN, GCC, TL

• <log_type>: NTPPEER, SW, RSVPADJ, SWITCHDOMAIN, PPPL, PPPS, PPPRS, PPPMS, GCC, TL

When OCH is displayed, it represents OCH, OCH-L, OCH-P, OCH-DP, OCH-CP and OCH-OS.

Proper System Response

The following response is generated for alarms when they are raised:
<header>

<almcde>^<atag>^REPT^ALM^{EQPT|SLOT|<fac_type>|<log_type>}<cr><lf>
^^^"<aid>:<ntfcncde>,<condtype>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>:<conddes
cr>"<cr><lf>;

The following response is generated for alarms when they are cleared:
<header>

<almcde>^<atag>^REPT^ALM^{EQPT|SLOT|<fac_type>|<log_type>}<cr><lf>
^^^"<aid>:CL,<condtype>,<srveff>,<ocrdat>,<ocrtm>,<locn>,<dirn>:<conddescr>"<cr>
<lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-853

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.1 REPT^ALM Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CDCP-20-[10-16,1-7]-[1-3]
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
DCM-20-[1-16]-[1-3]
FAN-20-[29-32]
FAN8-20-[16,17]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SIOM-20-15
SLOT-20-[1-35]-[1-32], SLOT-[50-58]-
[1-8]
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

Page 30-854 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.1 REPT^ALM Parameters (Continued)

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88], OCH-
20-[1-16]-[1-2]-[19135-19610], OCH-
20-[10-16,1-7]-[1-20], OCH-20-[10-
16,1-7]-[1-3]-[2-13], OCH-[50-58]-[2-
4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-5]-
[B,C][1-80]-[1-32], ODU0-20-[1-16]-[1-
2]-[D][1-3]-[B,C][1-80]-[1-32], ODU0-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-5]-
[B,C][1-80]-[1-16], ODU1-[20]-[1-16]-
99-[7-30], ODU1-20-[1-16]-[1-2]-[D][1-
3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-5]-
C[1-80]-[1-4], ODU2-[20]-[1-16]-99-[1-
6], ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-4], ODU2-20-[1-16]-[1-2]-[D][1-
3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-[1-
2]-[D][1-3]-C[1-80]-[1-32], ODU2E-20-
[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-20-
[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-16]-
[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-[1-
16]-[1,3-11], OMS-20-[10-16,1-7]-[1-3]-
[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-16]-
1
OTS-20-[10-16,1-7]-21,OTS-20-[1-16]-
1
OTU1-20-[1-16]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-855

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.1 REPT^ALM Parameters (Continued)

Parameter Value(s) Definition
fac_aid OTU2-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID
(cont.) OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-[1-
16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-[1-
16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-30]-
99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1]
T1-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]
VCG-20-[1-16]-[1-32]

Page 30-856 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.1 REPT^ALM Parameters (Continued)

Parameter Value(s) Definition
log_aid GCC0-20-[1-16]-[1-32] EntityID-PeerID
GCC1-20-[1-16]-[1-20], GCC1-20-[1-
16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC1-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[A,B,E,Z,F][1-
32], GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]
GCC12-20-[1-16]-[1-20], GCC12-20-[1-
16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC12-20-[1-
16]-[1-2]-[D][1-3]-[B,C][1-80]-
[A,B,E,Z,F][1-32], GCC12-20-[1-16]-[1-
2]-[D][1-3]-[A,B,C,E,Z,F][1-80]
GCC2-20-[1-16]-[1-20], GCC2-20-[1-
16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC2-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC2-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[A,B,E,Z,F][1-
32], GCC2-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]
NTPPEER-[2,1]
PPPL-[20]-[1-16]-[1-30], PPPL-[20]-[1-
16]-99-[1-30]
PPPMS-[20]-[1-16]-[1-30], PPPMS-
[20]-[1-16]-99-[1-30]
PPPRS-[20]-[1-16]-[1-30], PPPRS-[20]-
[1-16]-99-[1-30]
PPPS-[20]-[1-16]-[1-30], PPPS-[20]-[1-
16]-99-[1-30]
RSVPADJ-[1,3]-1-[1-40]
SW-1
TL-[1,3]-[1-512]-[1-1500]

ntfcncde CR Indicates the notification code (severity level) associated with

MJ the condition type. The codes include:
MN - CR = critical
CL - MJ = major
- MN = minor
- CL = cleared

condtype Refer to Alarm and Condition Tables for Identifies the current state of the alarm conditions.
the possible values of Condition Types.

srveff NSA Indicates if an alarm is service affecting or nonservice affecting:

SA - NSA indicates non-service affecting.
- SA indicates service affecting.

ocrdat MOY-DOM format:(1)MOY = 1 - Indicates the occurrence date of the alarm by the month of the
12.(2)DOM = 1 - 31. year and the day of the month.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Indicates the occurrence time of the alarm by the hour of the
00 - 59 (3) SS = 00 - 59 day, the minute of the hour, and the second of the minute.

76.MTFP50/30, Rev B January 2018 Page 30-857

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.1 REPT^ALM Parameters (Continued)

Parameter Value(s) Definition
locn NEND Indicates if the alarm or event location is near end or far end:
FEND - NEND: Near End (Condition, alarm, or event occurred at the
near end of the system.)
- FEND: Far End (Condition, Alarm, or event occurred at the far
end of the system.)

dirn TDTC Specifies the direction of an event/occurrence in the system:

TDTN - TDTC indicates Transmit direction toward customer.
RCV - TDTN indicates Transmit direction toward DWDM network.
TRMT - RCV specifies Receive direction.
NA - TRMT specifies Transmit direction.
- NA indicates Not Applicable.

conddescr Refer to Alarm and Condition Tables for Describes the condition that caused the alarm. Text string with a
the possible values of Condition Types. maximum of 255 characters and enclosed in escape quotes.

almcde *C The alarm code which indicates the severity of the alarm:
** - Critical = *C
*^ - Major = **
A^ - Minor = *^
- Autonomous = A^

Message Format Examples

For Equipment alarms:
CORIANT1 02-02-02 00:02:39
*C 3 REPT ALM EQPT
"OSM2C-20-1:CR,RUP_FAIL,SA,02-02,00-02-39,NEND,NA:\"Replaceable Unit Problem -
Equipment Failed\""
;

When alarm clears:

CORIANT1 02-02-02 00:03:11
A^ 3 REPT ALM EQPT
"OSM2C-20-1:CL,RUP_FAIL,SA,02-02,00-03-11,NEND,NA:\"Replaceable Unit Problem -
Equipment Failed\""
;

For Facilities alarms:

CORIANT1 02-02-02 00:02:39
*C 3 REPT ALM OC3
"OC3-20-1-1:CR,LOS,SA,02-02,00-02-39,NEND,TDTN:\"Loss Of Signal\""
;

For Software alarms:

CORIANT1 02-02-02 00:02:39
*^ 3 REPT ALM SW
"SW-1:MN,PROGFLT,NSA,02-02,00-02-39,NEND,NA:\"Software fault or failure\""

For Router alarms:

CORIANT1 02-02-02 00:02:39
*^ 3 REPT ALM SW
"ROUTER-1:MN,CABL_LOS-NEXT,NSA,02-02,00-02-39,NEND,NA:\"Cable problem - Loss of
Signal - Ethernet cable - RT-17-2\""
;

Page 30-858 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

For DHCP alarms:

CORIANT1 02-02-02 00:02:39
** 3 REPT ALM DHCP
"DHCPCLIENT-1:MJ,DHCP-NOIPADDR,NSA,02-02,00-02-39,NEND,NA:\"No IP Address
Assigned\""
;

When alarm clears:

CORIANT1 02-02-02 00:03:11
A^ 3 REPT ALM DHCP
"DHCPCLIENT-1:CL,DHCP-NOIPADDR,NSA,02-02,00-03-11,NEND,NA:\"No IP Address
Assigned\""
;

For RSVPADJ alarms:

CORIANT1 02-02-02 00:02:39
*^ 3 REPT ALM RSVPADJ
"RSVPADJ-3-1-1:MN,ADJ_LOST,NSA,02-02,00-02-39,NEND,NA:\"RSVP Adjacency Lost\""
;

For TL alarms:
CORIANT1 02-02-02 00:02:39
*^ 3 REPT ALM TL
"TL-3-1-102:MJ,CONF_FAIL,NSA,11-29,00-06-06,NEND,NA:\"The Neighbor Discovery
process was unable to successfully negotiate\""
;

Related Commands
RTRV-ALM-ALL
RTRV-COND-ALL

76.MTFP50/30, Rev B January 2018 Page 30-859

20. Report - Autonomous Messages TL1 Command Reference Manual

REPT^ALM^ENV

Command Changes Since Previous Feature Package

• None.

Description
Report a customer defined condition on an environmental alarm input.

Table 20.2 Format for Environmental Alarms

Block Value(s)
Verb REPT

First Modifier ALM

Second Modifier ENV

Parameters env_aid: ntfcncde, almtype, ocrdat, ocrtm, almmsg

Restrictions and Exceptions

• None

Message Format (Proper System Response)

<header>

<almcde>^<atag>^REPT^ALM^ENV<cr><lf>
^^^"<env_aid>:<ntfcncde>,<almtype>,<ocrdat>,<ocrtm>,<almmsg>"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.3 REPT^ALM^ENV Parameters

Parameter Value(s) Definition
env_aid ENV-[1-5] EntityID-EnvID

ntfcncde CR Indicates the notification code (severity level) associated with

MJ the condition type. The codes include:
MN - CR = critical
CL - MJ = major
- MN = minor
- CL = cleared

Page 30-860 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.3 REPT^ALM^ENV Parameters (Continued)

Parameter Value(s) Definition
almtype AIRCOMPR Identifies the current state of the alarm conditions.
AIRCOND The text within "..." below describes the default alarm message
AIRDRYR associated with each alarm type.
BAMP_1_FAILURE - AIRCOMPR specifies "Air compressor failure".
BAMP_1_WARNING - AIRCOND specifies "Air conditioning failure".
BAMP_2_FAILURE - AIRDRYR specifies "Air dryer failure".
BAMP_2_WARNING - BAMP_x_FAILURE specifies "Booster Amp number x failure"
BAMP_3_FAILURE where x={1-4}.
BAMP_3_WARNING - BAMP_x_WARNING specifies "Booster Amp number x
BAMP_4_FAILURE warning" where x={1-4}.
BAMP_4_WARNING - BATDSCHRG specifies "Battery discharging".
BATDSCHRG - BATTERY specifies "Battery failure".
BATTERY - CLFAN specifies "Cooling fan failure".
CLFAN - CPMAJOR specifies "Centralized Power Major Environmental
CPMAJOR Alarm or Major Equipment Failure".
CPMINOR - CPMINOR specifies "Centralized Power Minor Environmental
CRA_1_FAILURE Alarm or Minor Equipment Failure".
CRA_1_WARNING - CRA_x_FAILURE specifies "Co-Propagating Raman number x
CRA_2_FAILURE failure" where x={1-4}.
CRA_2_WARNING - CRA_x_WARNING specifies "Co-Propagating Raman number
CRA_3_FAILURE x warning" where x={1-4}.
CRA_3_WARNING - ENGINE specifies "Engine failure".
CRA_4_FAILURE - ENGOPRG specifies "Engine operating".
CRA_4_WARNING - ENGTRANS specifies "Standby Engine Transfer".
ENGINE - EXPLGS specifies "Explosive gas".
ENGOPRG - FIRDETR specifies "Fire detector failure".
ENGTRANS - FIRE specifies "Fire".
EXPLGS - FLOOD specifies "Flood".
FIRDETR - FUELLEAK specifies "Fuel Leak".
FIRE - FUSE specifies "Fuse failure".
FLOOD - GASALARM specifies "Exp Gas/ Toxic Gas/Vent or Gas Mon
FUELLEAK Fail"
FUSE - GEN specifies "Generator failure".
GASALARM - HATCH specifies "CEV Hatch Fail".
GEN - HIAIR specifies "High airflow".
HATCH - HIHUM specifies "High humidity".
HIAIR - HITEMP specifies "High temperature".
HIHUM - HIWTR specifies "High water".
HITEMP - INTRUDER specifies "Intrusion".
HIWTR - LVDADSL specifies "Secondary ADSL Low Voltage
INTRUDER Disconnect".
LVDADSL

76.MTFP50/30, Rev B January 2018 Page 30-861

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.3 REPT^ALM^ENV Parameters (Continued)

Parameter Value(s) Definition
almtype LWBATVG - LWBATVG specifies "Low battery voltage".
(continue) LWFUEL - LWFUEL specifies "Low fuel".
LWHUM - LWHUM specifies "Low humidity".
LWPRES - LWPRES specifies "Low cable pressure".
LWTEMP - LWTEMP specifies "Low temperature".
LWWTR - LWWTR specifies "Low water".
MISC - MISC specifies "Miscellaneous" (default).
NIR_1_FAILURE -NIR_x_FAILURE specifies "Network Interfaced Raman number
NIR_1_WARNING x failure" where x={1-4}.
NIR_2_FAILURE - NIR_x_WARNING specifies "Network Interfaced Raman
NIR_2_WARNING number x warning" where x={1-4}.
NIR_3_FAILURE - OPENDR specifies "Open door".
NIR_3_WARNING - POWER specifies "Commercial power failure".
NIR_4_FAILURE - PWRMJ specifies "Power Supply Major incl Stdby Engine".
NIR_4_WARNING - PWRMN specifies "Power Supply Minor incl Stdby Engine".
OPENDR - PUMP specifies "Pump failure".
POWER - RECT specifies "Rectifier failure".
PUMP - RECTHI specifies "Rectifier high voltage".
PWRMJ - RECTLO specifies "Rectifier low voltage".
PWRMN - RTACADSL specifies "AC or Rectifier Power Fail ADSL Eqpt".
RECT - RTACCRIT specifies "AC or Rectifier Power Fail Trans Eqpt".
RECTHI - RTACPWR specifies "AC or Rectifier Power Fail DCL Eqpt".
RECTLO - RTACPWRENG specifies "Comm AC Fail - Site e/w Stdby
RTACADSL Eng".
RTACCRIT - RTBAYPWR specifies "AC power Loss Distributed Power RT
RTACPWR Bay".
RTACPWRENG - RTRVENG specifies "Retrieve Stdby Eng - Com AC restored".
RTBAYPWR - SMOKE specifies "Smoke".
RTRVENG - TEMP specifies "High-Low Temperature".
SMOKE - TOXICGAS specifies "Toxic gas".
TEMP - TREPEATER specifies "T Repeater Shelf Major".
TOXICGAS - VENTN specifies "Ventilation system failure".
TREPEATER
VENTN

ocrdat MOY-DOM format:(1)MOY = 1 - Indicates the occurrence date of the alarm by the month of the
12.(2)DOM = 1 - 31. year and the day of the month.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Indicates the occurrence time of the alarm by the hour of the
00 - 59 (3) SS = 00 - 59 day, the minute of the hour, and the second of the minute.

almmsg One to 40 alphanumeric characters. The text message to be associated with the environmental
alarm specified by the <env_aid> parameter.
Should be enclosed within a pair of escaped quotes.
If it was not previously modified, then the default alarm message
(shown above) associated with each alarm type is reported.
Refer to table "TL1 Quoted Allowable Characters" in section 2
for acceptable characters
Refer to section 2 for the applicable characters.

almcde *C The alarm code which indicates the severity of the alarm
** - Critical = *C
*^ - Major = **
A^ - Minor = *^
- Autonomous = A^

Page 30-862 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Message Format Examples

CORIANT1 14-02-28 00:02:39
*C 3 REPT ALM ENV
"ENV-1:CR,FIRE,02-28,00-02-39,\"FIRE\""
;

Related Commands
RTRV-ALM-ENV
SET-ATTR-ENV
RTRV-ATTR-ENV

76.MTFP50/30, Rev B January 2018 Page 30-863

20. Report - Autonomous Messages TL1 Command Reference Manual

REPT^BKUP

Command Changes Since Previous Feature Package

• None.

Description
This autonomous message is generated by the network element when a scheduled memory backup has been
completed. Reference the SCHED-BKUP-MEM command for details on scheduling memory backups.

Message Format (Proper System Response)

For a generic output report:
<header>

A^^<atag>^REPT^BKUP <cr><lf>
^^^"<backup_mem_aid>,<datatype>[,<status>][,<rslt>]" <cr><lf>
^^^/* Failure Description if <status> is FAIL */ <cr> <lf>+;

If the backup to remote server completes successfully:

<header>

A^^<atag>^REPT^BKUP <cr><lf>
^^^"<backup_mem_aid>,<datatype>[,<status>]" <cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.4 REPT^BKUP Parameters

Parameter Value(s) Definition
backup_mem_ SERVER EntityID
aid

datatype DB Specifies the type of backup memory that is the source.

status PASS - PASS - indicates the backup is successfully completed.

FAIL - FAIL - indicates a failed backup.

rslt FILENOTFOUND Specifies a scheduled backup that could not complete because
LOGINFAIL it failed or could not be executed:
NOCONNECT - FILENOTFOUND - indicates that the file was not found, that an
NOSPACE invalid directory was used or that the file read/write permission
SYSRESOFFLINE are incorrect.
- LOGINFAIL - indicates a login failure on the remote server
using the specified user id and password id.
- NOCONNECT - indicates a failed backup because the NE was
unable to connect to the remote server.
- NOSPACE - indicates a failed backup because of insufficient
storage capacity on the destination.
- SYSRESOFFLINE - indicates that the some resources on the
NE is not available to perform the backup operation.

Page 30-864 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Message Format Examples

The following example notifies maintenance personnel that a database backup was successfully completed.

CORIANT1 02-03-15 02:08:15

A 24^REPT^BKUP

"SERVER,DB,PASS"

Related Commands
SCHED-BKUP-MEM

76.MTFP50/30, Rev B January 2018 Page 30-865

20. Report - Autonomous Messages TL1 Command Reference Manual

REPT^DBCHG

Command Changes Since Previous Feature Package

• None.

Description
This autonomous message is generated to immediately report to the OS the Network Element (NE) database
changes that occurred as a result of system provisioning changes (State Changes) and changes due to external
events such as module insertion or removal.

Note 1: Database change events related to user ids and passwords are not
reported.

Note 2: For CRS, FFP database changes, both facility AIDs involved is reported,
seperated by a comma.

Note 3: Database change events related to facility state transitions to/from IS-
ANR,SGEO or OOS-AU,SGEO are not reported.

Note 4: Database change events related to cross-connect state transitions to/

from IS-ANR,SGEO or OOS-AU,SGEO are not reported.

Note 5: Database change events related to secondary state facility failure

transitions (FAF) are not reported.

Command Format
None

Message Format (Proper System Response)

<header>

A^^<atag>^REPT^DBCHG (<cr> <lf>

^^^"TIME=<dbchgtim>,DATE=<dbchgdat>,,,DBCHGSEQ=<dbchgseq>:<command_block>:<aid>
[:[<common_block>][:[<specific_block>][:<state_block>]]]")+<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.5 REPT^DBCHG Parameters

Parameter Value(s) Definition
dbchgtim HH-MM-SS: (1) HH = 00 - 23 (2) MM = Identifies the completion time of the command that was inputted
00 - 59 (3) SS = 00 - 59 to initiate the database change.

dbchgdat YY-MM-DD: (1). YY = 00 - 99 (2) MM = Identifies the completion date of the command that was inputted
01 - 12 (3) DD = 01 - 31 to initiate the database change.

Page 30-866 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.5 REPT^DBCHG Parameters (Continued)

Parameter Value(s) Definition
dbchgseq [0-9999] identifies the cyclical sequence number that is unique to REPT
DBCHG messages.

command_blo The following format is Indicates the command code information of the action which
ck supported:verb-modifier[-modifier]. created this external update.
Where verb can be: (1)DLT (2)ED - ED indicates that the specified entity has been either created
(3)SCHED (4)SET (5)SW or that its attributes have been modified using any of the
following command:
- ENT
- ED
- OPR
- RLS

common_bloc Text string Refer to Guidelines for TL1 Input Command Messages, page
k 30-130 for more information.

specific_block Text string Refer to Guidelines for TL1 Input Command Messages, page
30-130 for more information.

state_block The following format: The following format:

editablePrimaryState[,sst] <editablePrimaryState>[,<sst>]

editablePrimar IS-NR Indicates the primary state and primary state qualifier of an
yState IS-ANR entity.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service.
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

76.MTFP50/30, Rev B January 2018 Page 30-867

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.5 REPT^DBCHG Parameters (Continued)

Parameter Value(s) Definition
sst APIP Indicates the secondary state of an entity.
APR - APIP: automatic power management in progress
BERT-PRBS-TX - APR: automatic power reduction (amplifiers disabled)
BERT-PRBS-RX - BERT-PRBS-TX: Bit error test with PRBS signal in progress in
NULL-TX transmit direction
BUSY - BERT-PRBS-RX: Bit error test with PRBS signal in progress in
DGN receive direction
EXTERNAL - NULL-TX: NULL signal transmission in progress
FAF - BUSY: busy
FLT - DGN: diagnostic
FREERUN - EXTERNAL: external
IDLE - FAF: facility failure
LPBK - FLT: fault
MEA - FREERUN: free run
MT - IDLE: idle
NALM - LPBK: loopback
NALMQI - MEA: mismatch of equipment and attributes
NALMTI - MT: maintenance
PMI - NALM: not alarmed
PWR - NALMQI: Not alarmed qualified inhibit
SGEO - NALMTI: not alarmed timed inhibit
SHTDWN - PMI: performance monitoring inhibited
SWDL - PWR: power
TMGMASTER - SGEO: supporting entity outage
TMGSLAVE - SHTDWN: shutdown
UEQ - SWDL: software download
- TMGMASTER: Master Timing Source
- TMGSLAVE: Slave Timing Source
- UEQ: unequipped

Message Format Examples

Example 1: Modification of PST for a SMTM-U Module

CORIANT1 07-03-23 12:13:58

A 29 REPT DBCHG

"TIME=12-13-58,DATE=03-23,,,DBCHGSEQ=27:ED-EQPT:SMTMU-2-
14::ALMPF=99,CPTYPE=\"SUBRATE MULTIPLEXER TRANSPONDER MODULE - UNIVERSAL RATE
WITH ADM\",CPNAME=\"\",CHAN=NA,TMG=INTERNAL,RATE=10G,:OOS-AUMA,UEQ"

This message was sent after the following command was entered:

ED-EQPT:CORIANT1:SMTMU-2-14:100:::CMDMDE=FRCD:OOS;

Example 2: Modification of Security System Parameters

CORIANT1 03-03-12 17:07:26
A 2 REPT DBCHG
"TIME=17-07-26,DATE=03-03-12,,,DBCHGSEQ=3:ED-SECU-SYS:MXINV=4,DURAL=75"
;

This message was sent after the following command was entered:
ED-SECU-SYS:::CP0100::MXINV=4,DURAL=75;

Page 30-868 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Related Commands
ALW-MSG-ALL
INH-MSG-ALL

76.MTFP50/30, Rev B January 2018 Page 30-869

20. Report - Autonomous Messages TL1 Command Reference Manual

REPT^EVT

Command Changes Since Previous Feature Package

• Add OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The report event message is generated when an event occurs. The verb, modifiers, and parameters used in report
event autonomous messages are provided below. The parameters and their domains are defined in Alarm and
Condition Tables in section 6.

Parameters enclosed in brackets may or may not appear in the message.

The possible reported events could be a change in status condition or an irregularity which is not severe enough to
prompt alarmed notification. The report of threshold crossing message is generated when the value of a
performance monitoring parameter exceeds the threshold value.

Table 20.6 Format for Report Event Messages

Block Value(s)
Verb REPT

First Modifier EVT

Second Modifier EQPT

SLOT
FAC: ETH, GBEP, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L, OCH-P, OCH-
DP, OCH-CP, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1,
OTU2, OTU4, OTUC2, OTUC3, OMS, OSC, OTS, STM1, STM4, STM16, STM64, TGLAN.
LOGICAL: DB, DHCP, ROUTER, SECU, SW, STS1, STS3C, STS12C, STS48C, STS192C.

Parameter aid: condtype, condeff, ocrdat, ocrtm, locn, dirn, monval, thlev, tmper, conddescr

Message Format (Proper System Response)

The following response is generated for standing events when they are raised:
<header>

A^^<atag>^REPT^EVT^{EQPT|SLOT|FAC|DB|DHCP|ROUTER|SECU|SW}<cr><lf>
^^^"<aid>:<condtype>,<condeff>,<ocrdat>,<ocrtm>,<locn>,<dirn>,,,:<conddescr>"<cr
><lf>+;

The following response is generated for events when they are cleared:
<header>

A^^<atag>^REPT^EVT^{EQPT|SLOT|FAC|DB|DHCP|ROUTER|SECU|SW}<cr><lf>
^^^"<aid>:<condtype>,CL,<ocrdat>,<ocrtm>,<locn>,<dirn>,,,:<conddescr>"<cr><lf>+;

Page 30-870 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Message Format (Proper System Response)

The following response is generated for performance monitoring related TCAs (TCAs are not cleared) or condition
types starting with "T-"
<header>

A^^<atag>^REPT^EVT^{EQPT|FAC}<cr><lf>
^^^"<aid>:<condtype>,TC,<ocrdat>,<ocrtm>,<locn>,<dirn>,<monval>,<thlev>,<tmper>:
<conddescr>"<cr><lf>+;

Message Format (Proper System Response)

The following response is generated for facility protection switch notifications
<header>

A^^<atag>^REPT^EVT^{FAC}<cr><lf>
^^^"<aid>:<condtype>,TC,<ocrdat>,<ocrtm>,<locn>,,,,:<conddescr>"<cr><lf>+;

Message Format (Proper System Response)

The following notification is generated by the NE to notify the Management System to sync
<header>

A^^<atag>^REPT^EVT^EQPT<cr><lf>
^^^"<aid>:<condtype>,TC,<ocrdat>,<ocrtm>,<locn>,,,,:<conddescr>"<cr><lf>+;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-871

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.7 REPT^EVT Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CDCP-20-[10-16,1-7]-[1-3]
CFP2-20-[1-16]-[1-5]
FAN-20-[29-32]
FAN8-20-[16,17]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SIOM-20-15
SLOT-20-[1-35]-[1-32], SLOT-[50-58]-
[1-8]
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

Page 30-872 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.7 REPT^EVT Parameters (Continued)

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTS-20-[10-16,1-7]-21,OTS-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-873

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.7 REPT^EVT Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) OTU2-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
T1-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]
VCG-20-[1-16]-[1-32]

log_aid DB-1 EntityID-DBID

SECU
SW-1

condtype Refer to Alarm and Condition Tables Identifies the current state of the alarm conditions.
for the possible values of Condition
Types.

condeff TC Identifies the effect of the event on the condition.

SC
CL

ocrdat MOY-DOM format:(1)MOY = 1 - Identifies the occurrence date of the event. The month of year
12.(2)DOM = 1 - 31. and day of month are provided.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Identifies the occurrence time of the event. The hour of day,
00 - 59 (3) SS = 00 - 59 minute of hour, and second of minute are provided.

locn NEND Indicates if the alarm or event location is near end or far end:
FEND - NEND: Near End (Condition, alarm, or event occurred at the
near end of the system.)
- FEND: Far End (Condition, Alarm, or event occurred at the far
end of the system.)

dirn TDTC Indicates the direction of an event/occurrence in the system:

TDTN - TDTC indicates Transmit direction toward customer.
RCV - TDTN indicates Transmit direction toward DWDM network.
TRMT - RCV specifies Receive direction.
NA - TRMT specifies Transmit direction.
- NA indicates Not Applicable.

Page 30-874 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.7 REPT^EVT Parameters (Continued)

Parameter Value(s) Definition
conddescr Refer to Alarm and Condition Tables Describes the condition that caused the alarm.
for the possible values of Condition Text string with a maximum of 255 characters and enclosed in
Types. escape quotes.

monval (1)-60.0 to +60.0, LT+12.0, GT+20.0, Indicates the value of a performance monitoring parameter.
1.9E-2 to 2.3E-11, -40000 to +40000
for gauges. (2)0 to
18446744073709551615 for counters.
(3)NA

thlev (1)-45 to 18446744073709551615 Indicates the threshold value of the performance monitoring
(2)DFLT parameter.

tmper 15-MIN Indicates the time-period increments during which PM data is

1-DAY collected.
Enter 15-MIN to specify 15-minute increments.
Enter 1-DAY to specify daily increments.

Message Format Example (Event)

The following response is generated for events when they are raised:
CORIANT1 02-02-02 00:02:39
A^^123^REPT^EVT^OTS
"OTS-20-1-21:APIP,SC,02-02,00-02-39,NEND,TDTC,,,:\"Auto-Power Management In-
Progress\""

The following response is generated for events when they are cleared:
CORIANT1 02-02-02 00:02:39
A^^123^REPT^EVT^OTS
"OTS-20-1-21:APIP,CL,02-02,00-02-39,NEND,TDTC,,,:\"Auto-Power Management In-
Progress\""

Message Format Example (TCA)

CORIANT1 02-02-02 00:02:39
A^^3 REPT EVT EQPT
"OSM2S-20-2:T-LBC,TC,02-02,00-02-39,NEND,NA,103,100,15-MIN:\"Laser Bias Current
Level\""

Message Format Example (Security)

CORIANT1 02-02-02 00:02:39
A^^3 REPT EVT SECU
"SECU:INTRUSION,TC,02-02,12-02-02,NEND,NA,,,:\"Unknown account attempt\""

"<cr><lf>

76.MTFP50/30, Rev B January 2018 Page 30-875

20. Report - Autonomous Messages TL1 Command Reference Manual

Message Format Example (Security)

CORIANT1 02-02-02 00:02:39
A^^3 REPT EVT SECU
"SECU:USERLOCK,TC,02-02,12-02-02,NEND,NA,,,:\"User suspended\""

"<cr><lf>

Message Format Example (Facility Protection Switch)

This notification is for a manual protection switch FROM a working GOPT-W to a protection GOPT-P line of an
OPSM:
CORIANT1 02-02-02 00:02:39

A^^3 REPT EVT GOPT

"GOPT-W-2-18-5:MANTOPROT,TC,02-02,00-02-39,NEND,,,,:\"Manual Switch to
Protect\""

Message Format Example (DB)

CORIANT1 02-02-02 00:02:39

A^^3 REPT EVT EQPT

"STPM-20-24:MGMNTSYNC,TC,02-02,00-02-39,NEND,,,,:\"Management System Sync
Required\"";

Message Format Example (SW)

Notification generated during a software upgrade execute process:

CORIANT1 15-03-14 09:26:54

A^^301 REPT EVT SW

"SW-1:SWEXEC-IP,TC,03-14,09-26-54,NEND,,,,:\"Software Upgrade Execute In-
Progress\"";

CORIANT1 15-03-14 09:26:59

A^^302 REPT EVT SW

"SW-1:SWEXEC-COMPLD,TC,03-14,09-26-59,NEND,,,,:\"Software Upgrade Execute
Completed\"";

Message Format Example (EQPT)

Notification for equipment generated during a software upgrade:

CORIANT1 15-03-14 09:26:54

A^^302 REPT EVT SW

"OSM2C-20-2:SWEXEC-FAIL,TC,03-14,09-26-14,NEND,,,,:\"Download Failed\"";

Related Commands
RTRV-COND-ALL

Page 30-876 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

REPT^EVT^CALL

Command Changes Since Previous Feature Package

• None.

Description
The event message for calls is reported when an event occurs related to the calls. An event could be a change in
the status of a call or an irregularity which is not severe enough to report an alarm. For example, a reroute event is
reported when the call is rerouted because of a network failure or because of an administrative request.

For link fault triggered reroute, CP reversion event is raised for dynamic reroute/full time services that has CP
reversion set as AUTO or MAN. This event is sent after the reverting action is finished. A successful CP reversion
will revert traffic back to path of nominal connection while a failed CP reversion will keep traffic in path of restoration
connection.

AEND2,ZEND2,NODEID2,INGRSS2,EGRSS2 are parameters to describe the second path of the 2-port call
AUTO_DELETED event. On the primary source node of a 2-port call, AEND, ZEND,NODE, INGRSS, EGRSS is
displayed for the first path; AEND2, ZEND2, NODEID2, INGRSS2, EGRSS2 is displayed for the second path.

Message Format (Proper System Response)

The following response is generated for events when they are raised.
<header>

A^^<atag>^REPT^EVT^CALL<cr><lf>
^^^"<call_aid>:<node_aid>,<callid>,<condtype>,<ocrdat>,<ocrtm>:<conddescr>"<cr><
lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.8 REPT^EVT^CALL Parameters

Parameter Value(s) Definition
call_aid CALL-[1,3]-[1-4294967295] EntityID-NPID-CallNum

node_aid NODE-[1,3]-[1-512] Specifies the repair node AID in the NE for the call.

callid Up to a 55 character string in the Identifies the CP call id.

following format: [CNTRY-CAR-AP-
]TYPE-ADDRESS-ID. (1)CNTRY -
country code (3 alphabetic characters)
(2)CAR - carrier code (1 to 6
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

condtype Refer to the table below, for the Identifies the current state of the condition.
possible values of condition types.

76.MTFP50/30, Rev B January 2018 Page 30-877

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.8 REPT^EVT^CALL Parameters (Continued)

Parameter Value(s) Definition
ocrdat MOY-DOM format:(1)MOY = 1 - Identifies the occurrence date of the event. The month of year
12.(2)DOM = 1 - 31. and day of month are provided.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Identifies the occurrence time of the event. The hour of day,
00 - 59 (3) SS = 00 - 59 minute of hour, and second of minute are provided.

conddescr Refer to Alarm and Condition Tables Describes the condition that caused the event.
for the possible values of Condition
Types. For restore reroute (RESTORE_RRT_FAIL*) events, it includes
CONNPATH, AFFAREA, AFFNODE, and AFFLINK identifying
the path type, affected routing area, affected node and the
ifIndex of the affected TL.

For administratively requested reroute (ADMIN_RRT*) events, it

includes CONNPATH, AFFAREA, AFFNODE, AFFLINK,
OPTCOST and CMDMDE.
OPTCOST identifies whether cost optimization is enabled when
performing reroute calculation for ARR.
Other descriptions are the same as restore reroute event's.
CMDMDE identifies the way in which the command is executed
(FRCD or NORM mode).

For the "REVERT_*" event, it includes CONNPATH,

CPREVTMDE.

For the "AUTO_DELETED" event, it includes AEND, ZEND,

INGRSS, ERGSS, SLPF, LABELSET, MULTIPLIER, SIGTYPE,
NODEID2, AEND2, ZEND2, INGRSS2 and EGRSS2 values of
the CALL.
The parameters NODEID2, AEND2, ZEND2, INGRSS2 and
EGRSS2 only apply to 2-port call.

Please note that the maximum call conddescr string length is

255 bytes. If the call event exceeds 255 bytes, the event is
truncated and only the first 255 bytes is displayed.

Condition Types of REPT^EVT^CALL

Table 20.9 Condition Types for Report Event Call

CONDTYPE Description
ADMIN_RRT_SUCC Administratively requested reroute successful
ADMIN_RRT_FAIL Administratively requested reroute failed
RESTORE_RRT_SUCC Restoration Reroute successful
RESTORE_RRT_FAIL Restoration Reroute failed
RESTORE_RRT_NOTATT Restoration Reroute not attempted
REVERT_SUCC CP Reversion successful
REVERT_FAIL CP Reversion failed
AUTO_DELETED Call Deleted Autonomously

Page 30-878 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Parameters contained in Condition Description

Table 20.10 Parameters contained in Condition Description

Parameter Value Description
CONNPATH One of the following: Identifies the connection path (working or protection) of
• NOM_WKG the event.
• NOM_PROT NOM_WKG - nominal working
• CURR_WKG NOM_PROT - nominal protect
• CURR_PROT CURR_WKG – current working
CURR_PROT – current protect

AFFAREA A double quoted routing area item. Identifies the given routing area ID which the affected
Example: node (link fault affected node or the node
• “1.1.1.10” received an administratively requested reroute
instruction) belongs to.
AFFNODE A double quoted node item. Identifies the given node ID which could be link fault
Example: affected or the node received an administratively
• “123.224.187.198” requested reroute instruction.

AFFLINK A double quoted TL ifindex item. Identifies the ifindex format of a given link which could
Example: be a link fault link or an affected link that requested by
• “110ABB11” administrative reroute.

OPTCOST One of the following: Identifies the cost optimization enabled or disabled
• ENABLED when performs reroute calculation for ARR.
• DISABLED
CMDMDE One of the following: Identifies the way in which the related command is
• NORM executed.
• FRCD
CPREVTMDE One of the following: Identifies the CP reversion mode of the event.
• AUTO
• MAN
NODEID2 [0-255].[0-255].[0-255].[0-255] Specifies the node id.

The parameter NODEID2 is used to specify the second

source node of a 2-port call.

AEND Enter type-xxx.xxx.xxx.xxx format: (1) type is The EndPoint is a TNA and will follow TNA rules.
one of the following: IPV4 (2)xxx = 0-255
ZEND In the model this would be AEND/ZEND/AEND2/
ZEND2.
AEND2

ZEND2 AEND2 and ZEND2 are used to specify the second

pair of Endpoints of a 2-port call.

INGRSS A double quoted string in form of IfIndex[- This parameter specifies the interface of the call
EGRSS
Label]: deleted.
(1)IfIndex is 8 hexadecimal digits.
INGRSS2 (2)Label is 8 hexadecimal digits for non INGRSS2/EGRSS2 specify the ingress/egress
EGRSS2 ODUk labels or G.709 V2 ODUk labels; ifindex and label of the second path of a 2-port
Label is a multiple of 8 hexadecimal digits call.
for G.709 V3 ODUk/j/flex labels.
SLPF • SLPF-[99,1-20], Service level profile of the call deleted.
• NONE

76.MTFP50/30, Rev B January 2018 Page 30-879

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.10 Parameters contained in Condition Description (Continued)

LABELSET LABELSET-3-[d] The access identifier of the label set being referenced
by the call.
MULTIPLIER 1..32 The number of channels of SignalType used in the call.
SIGTYPE • ODU0 The connection type of the call.
• ODU1
• ODU2
• ODU2e
• ODU3
• ODU4
• ODUF_CBR
• ODUF_GFP
• OTU2
• OTU2e
• OTU4

Message Format Example

Example 1: Admin Reroute Failure

CORIANT1 12-01-27 16:19:25

A 57 REPT EVT CALL
"CALL-3-120:NODE-3-2,\"IPV4-21.3.245.2-01\",ADMIN_RRT_FAIL,01-27,16-19-
07:\"CURR_WKG,0.0.0.30,10.2.1.64,08080808,ENABLED\""
;

Example 2: Restore Reroute Failure

CORIANT1 12-01-27 16:15:27

A 55 REPT EVT CALL
"CALL-3-124:NODE-3-2,\"IPV4-21.3.245.2-01\",RESTORE_RRT_FAIL,01-27,16-14-
35:\"NOM_WKG,0.0.0.30,10.2.1.64,08080808\""
;

Example 3: Autonomous Call Deletion

CORIANT1 12-01-27 16:06:18

A 54 REPT EVT CALL
"CALL-3-10:NODE-3-2,\"IPV4-21.3.245.2-01\",AUTO_DELETED,01-27,16-06-
18:\"IPV4-1.64.2.1,IPV4-1.44.2.1,\\"08080808-00011000\\",\\"92000043-
00011000\\",SLPF-99,,1,ODU2\""
;

Example 4: Autonomous 2-port Call Deletion

CORIANT1 12-01-27 16:06:18

A 54 REPT EVT CALL
"CALL-3-10:NODE-3-2,\"IPV4-21.3.245.2-01\",AUTO_DELETED,01-27,16-06-18:\"IPV4-
1.64.2.1,IPV4-1.44.2.1,\\"08080808-00011000\\",\\"92000043-00011000\\",SLPF-
99,,1,ODU2,122.222.222.222,IPV4-1.64.3.1,IPV4-1.44.3.1,\\"08080909-
00011000\\",\\"92000044-00011000\\"\""
;

Example 5: Autonomous ODU0 Call Deletion

Page 30-880 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

CORIANT1 12-01-27 16:06:18

A 54 REPT EVT CALL
"CALL-3-12:NODE-3-2,\"IPV4-21.3.245.2-01\",AUTO_DELETED,01-27,16-06-18:\"IPV4-
1.64.2.1,IPV4-1.44.2.1,\\"08080808-0010000280000000\\",\\"92000043-
0010000280000000\\",SLPF-99,,1,ODU0\""
;

Example 6: Autonomous ODU0 Call (muxed to ODU4 link) Deletion

CORIANT1 12-01-27 16:06:18

A 54 REPT EVT CALL
"CALL-3-12:NODE-3-2,\"IPV4-21.3.245.2-01\",AUTO_DELETED,01-27,16-06-18:\"IPV4-
1.64.2.1,IPV4-
1.44.2.1,\\"08080808-00200050ff0000000000000000000000\\",\\"92000043-
00200050ff0000000000000000000000\\",SLPF-99,,1,ODU0\""
;

Example 7: Auto CP Reversion Failure

CORIANT1 12-01-27 16:06:18

A 54 REPT EVT CALL
"CALL-3-12:NODE-3-2,\"IPV4-21.3.245.2-01\",REVERT_FAIL,01-29,19-06-
18:\"CURR_WKG,AUTO\""
;

Related Commands
OPR-ADMREROUTE
OPR-CPSW

76.MTFP50/30, Rev B January 2018 Page 30-881

20. Report - Autonomous Messages TL1 Command Reference Manual

REPT^EVT^FXFR

Command Changes Since Previous Feature Package

• None.

Description
The report event file transfer is generated to notify of the file transfer completion status. A file transfer is initiated on
a target NE by using the COPY-RFILE and SCHED-PMFILE-{x} commands.

The report event file transfer is also used to notify of the file installation completion status for a new software patch
being installed via the OPR-UPG-PATCHAPPLY command.

This command is based on specifications defined in NSIF-033-1999.

Restrictions and Exceptions

• Two report event messages are generated for a software patch download (PDL) file transfer initiated by
the COPY-RFILE command. The first message is generated for the transfer of the ".dcr" file to the NE.
A second message is generated for the transfer of the ".zip" file to the NE.

• One report event message is generated when patch files from a Patch Load Package are applied/
copied to the active software directory on the NE as a result of the OPR-UPG-PATCHAPPLY command.

• During feature package installation phase, the system may report additional messages to provide extra
information about the installation process. The messages are summarized in the table below.

Table 20.11 Additional messages to provide extra information about the installation process

Message Description

"Procedure "Status Update ",START,IP,INSTALL,,0," Reports start of the "Initialize Admin Modules"
"Procedure "Status Update " partial complete = <percentage>,Execution Time = procedure – procedure to initialize / prepare
<seconds>,IP,INSTALL,,0," active & standby STPM for the FP installation
"Procedure "Initialize Admin Modules",START,IP,INSTALL,,0," phase.

"Procedure "Initialize Admin Modules" completed successfully, Execution Reports end of the “Initialize Admin Modules”
Time=<seconds>,IP,INSTALL,,0," procedure, result and procedure execution
time.

"Procedure "Install FP on Admins",START,IP,INSTALL,,0," Indicates start of the "Install FP on Admins"

procedure – this includes the following steps:
1) Transfer of the FP zip file from active to
standby STPM controller
2) FP installation (UZIP – unzipping of the zip
FP file on both active and standby STPM
controller)
3) Installation of the Upgrade Campaign file.

"FXFR : /mnt/sdcard/DOWNLOAD/SWLoad.zip, START,IP,INSTALL,,0," Indicates start of the step 1 (FXFR) - FP file (/

mnt/sdcard/DOWNLOAD/SWLoad.zip) transfer

"FXFR : /mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,<percentage>," Reports step 1 progress in 10% increments.

"FXFR : /mnt/sdcard/DOWNLOAD/SWLoad.zip,COMPLD,INSTALL,SUCCESS,,0" Indicates end of the step 1 and result.

"UZIP : /mnt/sdcard/DOWNLOAD/SWLoad.zip, START,IP,INSTALL,,0," Indicates start of the step 2 (UZIP) - FP file (/

mnt/sdcard/DOWNLOAD/SWLoad.zip)
installation step

Page 30-882 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

"UZIP : /mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,<percentage>," Reports step 2 progress in 10% increments.

"UZIP : /mnt/sdcard/DOWNLOAD/SWLoad.zip,COMPLD,INSTALL,SUCCESS,,0" Indicates end of the step 2 and result.

"FXFR : /mnt/sdcard/UPGRADE/UpgCampaign.tlf,COMPLD,INSTALL,SUCCESS,,0" Reports step 3 result.

"Procedure "Install FP on Admins" completed successfully, Execution Reports end of the “Install FP on Admins”
Time=<seconds>,IP,INSTALL,,0," procedure, result and procedure execution
time.

"Procedure "Verify FP Installation",START,IP,INSTALL,,0," Indicates start of the " Verify FP Installation "
procedure – this verifies if all FP files have
been properly installed on active and standby
STPM controller.

"Procedure "Verify FP Installation" completed successfully, Execution Reports end of the “Verify FP Installation”
Time=<seconds>,IP,INSTALL,,0," procedure, result and procedure execution
time.

Message Format (Proper System Response)

The following response is generated for events when they are raised.
<header>

A^^<atag>^REPT^EVT^FXFR<cr><lf>
[^^^"<filename>,<fxfr_status>,<xfertype>,<fxfr_rslt>[,<percentage>][,<bytes_xfrd
>]"
<cr><lf>]
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.12 REPT^EVT^FXFR Parameters

Parameter Value(s) Definition
filename An alphanumeric string containing Indicates the name of the file transferred.
allowed special characters defining a
path or a directory.

fxfr_status COMPLD Indicates the file transfer status:

START - COMPLD indicates the file transfer has completed.
IP - START indicates the file transfer has started.
RED_SYNC - IP indicates the file transfer is in-progress.
- RED_SYNC indicates file transfer to a redundant module.

76.MTFP50/30, Rev B January 2018 Page 30-883

20. Report - Autonomous Messages TL1 Command Reference Manual

Table 20.12 REPT^EVT^FXFR Parameters (Continued)

Parameter Value(s) Definition
xfertype SWDL Specifies the type and direction of the file transfer:
PDL - SWDL: indicates a software download (remote server to target
PATCHAPPLY NE).
LFR - PDL: indicates a software patch download (remote server to
RFR target NE).
RFBU - PATCHAPPLY: indicates a software patch load package is
PM being installed on the NE via the OPR-UPG-PATCHAPPLY
CEF command.
APPLOG - LFR: indicates an NE local file (database) restore.
INSTALL - RFR: indicates a remote file (database) restore (remote server
CPLOG to target NE).
PDLOG - RFBU: indicates a remote file (database) backup (target NE to
CALLLOG remote server).
PMFILE - PM: indicates a scheduled historical PM file transfer to a FTP
server.
- CEF: indicates the Capability Extension File is being
transferred from the provided source URL to the NE.
- APPLOG: indicates the application log file is being
transferred from the NE to the URL destination provided.
- INSTALL: indicates a software load being installed on the NE.
- CPLOG: indicates the control plane log file "ason.log" is being
transferred from the NE to the URL destination provided.
- PDLOG: indicates problem determination log file "pdtrc.lo0"
(DCL problem determination trace) being transferred from the
NE to the URL destination provided.
- CALLLOG: indicates call history log files being transferred from
NE to the URL destination provided.
- Enter PMFILE to upload the performance monitoring file from
the NE to the URL destination provided.

Page 30-884 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.12 REPT^EVT^FXFR Parameters (Continued)

Parameter Value(s) Definition
fxfr_rslt FAILURE-FILEINVALID Indicates success or failure of the file transfer.
FAILURE-FILENOTFOUND This parameter is only displayed when the file transfer has
FAILURE-INVALIDSWVERSION completed (such as fxfr_status=COMPLD):
FAILURE-LOGINFAIL - FAILURE - indicates the reason for failing the file transfer.
FAILURE-NOCONNECT - FILEINVALID - indicates that the compressed file checksum
FAILURE-NOSPACE and descriptor file do not match or that the descriptor format is
FAILURE-SYSRESOFFLINE incorrect.
FAILURE-TXFRABORTED - FILENOTFOUND - indicates that the file was not found, that an
FAILURE-NOVALIDCALLLOG invalid directory was used, or that the file read/write permission
FAILURE-FILENUMEXCEEDLIMIT is incorrect.
SUCCESS - INVALIDSWVERSION - indicates that the software release,
patch load release, or database backup to transfer is not
compatible with the software operating on the network element.
- LOGINFAIL - indicates a login failure on the remote server
using the specified user id and password id.
- NOCONNECT - indicates a file transfer failure because the NE
was unable to connect to the remote server.
- NOSPACE - indicates a file transfer failure because of
insufficient storage capacity on the destination.
- SYSRESOFFLINE - indicates that some resources on the NE
are not available to perform the file transfer operation.
- TXFRABORTED - indicates that the file transfer was aborted
by a manual command.
- NOVALIDCALLLOG - indicates that no valid call log starting at
the requested sequence number if the requested sequence
number is equal to the current recorded highest sequence
number at NE.
-FILENUMEXCEEDLIMIT - indicates that the PM file number to
be compressed exceeds the specified limitation.
- SUCCESS indicates successful file transfer.

percentage [1-100] Indicates the percentage of the file size transferred so far in 10%
steps.
This parameter is only displayed when the file transfer is in-
progress (such as fxfr_status=IP).

bytes_xfrd [0-99999999] Indicates the number of bytes transferred.

This parameter is only displayed when the file transfer has
completed (such as fxfr_status=COMPLD).

Message Format Example

Example 1
An event message identifying the in progress file transfer status and failed result of a software upgrade file transfer
to the NE:
CORIANT1 12-11-30 18:19:13

A 81 REPT EVT FXFR

"cdrom/dir1/FP7_1_WZ041_20121128_MTERA.dcr,COMPLD,SWDL,FAILURE-FILENOTFOUND,,0"

76.MTFP50/30, Rev B January 2018 Page 30-885

20. Report - Autonomous Messages TL1 Command Reference Manual

Example2
An event message identifying the in progress file transfer status for a remote database backup that is 10% percent
complete:
CORIANT1 12-11-30 18:20:13

A 123 REPT EVT FXFR

"cdrom/dir1/FP7_1_WZ041_20121128_MTERA.dcr,IP,RFBU,10"

Example 3
Event message identifying the completed file transfer status and result of a successful Patch Load Package file
transfer to the NE:
CORIANT1 11-08-30 18:40:23

A 232 REPT EVT FXFR

"server1/files/FP6.2PATCHLOAD_A.dcr,COMPLD,PDL,SUCCESS,,0"

CORIANT1 11-08-30 18:40:24

A 10 REPT EVT FXFR

"server1/files/FP6.2PATCHLOAD_A.ZIP,COMPLD,PDL,SUCCESS,,0"

Example 4
An event message identifying the successful completion of patch files copied from the Patch Load Package to the
active software directory on the NE:
CORIANT1 11-08-30 18:45:04

A 10 REPT EVT FXFR

"server1/files/FP6.2PATCH001.ZIP,COMPLD,PATCHAPPLY,SUCCESS,,0"

Example 5
When in the FP Installation phase, additional messages to indicate installation progress:
MTERA1-SID 16-09-09 12:14:19
A 3994 REPT EVT FXFR
"Procedure "Status Update ",START,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:14:29

A 3995 REPT EVT FXFR
"Procedure "Status Update " partial complete = 54%,Execution Time =
10s,IP,INSTALL,,0,"
;

Page 30-886 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

MTERA1-SID 16-09-09 12:14:30

A 4000 REPT EVT FXFR
"Procedure "Initialize Admin Modules ",START,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:14:31

A 4001 REPT EVT FXFR
"Procedure "Initialize Admin Modules " completed successfully,Execution Time =
1s,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:14:31

A 4002 REPT EVT FXFR
"Procedure "Install FP on Admins ",START,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:14:33

A 4004 REPT EVT FXFR
"FXFR:/mnt/sdcard/DOWNLOAD/SWLoad.zip,START,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:14:44

A 4005 REPT EVT FXFR
"FXFR:/mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,10,"
;

MTERA1-SID 16-09-09 12:14:58

A 4006 REPT EVT FXFR
"FXFR:/mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,20,"
;

....

MTERA1-SID 16-09-09 12:16:21

A 4014 REPT EVT FXFR
"FXFR:/mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,90,"
;

MTERA1-SID 16-09-09 12:16:32

A 4015 REPT EVT FXFR
"FXFR:/mnt/sdcard/DOWNLOAD/SWLoad.zip,COMPLD,INSTALL,SUCCESS,,0"
;

MTERA1-SID 16-09-09 12:16:37

A 4016 REPT EVT FXFR
"UZIP:/mnt/sdcard/DOWNLOAD/SWLoad.zip,START,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:16:47

A 4017 REPT EVT FXFR
"UZIP:/mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,10,"
;

MTERA1-SID 16-09-09 12:16:58

76.MTFP50/30, Rev B January 2018 Page 30-887

20. Report - Autonomous Messages TL1 Command Reference Manual

A 4018 REPT EVT FXFR

"UZIP:/mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,20,"
;

...

MTERA1-SID 16-09-09 12:18:15

A 4025 REPT EVT FXFR
"UZIP:/mnt/sdcard/DOWNLOAD/SWLoad.zip,IP,INSTALL,,90,"
;

MTERA1-SID 16-09-09 12:18:29

A 4026 REPT EVT FXFR
"UZIP:/mnt/sdcard/DOWNLOAD/SWLoad.zip,COMPLD,INSTALL,SUCCESS,,0"
;

MTERA1-SID 16-09-09 12:18:34

A 4029 REPT EVT FXFR
"FXFR:/mnt/sdcard/UPGRADE/UpgCampaign.tlf,COMPLD,INSTALL,SUCCESS,,0"
;

MTERA1-SID 16-09-09 12:18:35

A 4030 REPT EVT FXFR
"Procedure "Install FP on Admins " completed successfully,Execution Time =
243s,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:18:35

A 4031 REPT EVT FXFR
"Procedure "Verify FP Installation ",START,IP,INSTALL,,0,"
;

MTERA1-SID 16-09-09 12:18:36

A 4032 REPT EVT FXFR
"Procedure "Verify FP Installation " completed successfully,Execution Time =
0s,IP,INSTALL,,0,"
;

Related Commands
COPY-RFILE
SCHED-PMFILE-{x}

Page 30-888 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

REPT^EVT^OPEDATA

Command Changes Since Previous Feature Package

• New Command.

Description
The report event OPEDATA is generated to provide status of the validation and installation of OPE data files.
Installation of an OPE data file is initiated using the COPY-RFILE command.

Separate events are generated when the OPE data file is:
- VALIDATED - the OPE data file has been validated by the GMPLS Control Plane and is installed
- INSTALLED - the OPE data file has been installed by the GMPLS Control Plane and is now in use
- INVALID - the OPE data file has failed validation
- SYNCED - the OPE data file has been synched to the standby control processor

Restrictions and Exceptions

• None.

Message Format (Proper System Response)

The following response is generated for events when they are raised:

<header>

A^^<atag>^REPT^EVT^OPEDATA<cr><lf>
^^^"<opeDataset>,\"<opeName>\",\"<opeSerial>\",\"<opeTnVersion>\",<filesize>,<st
atus>"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.13 REPT^EVT^OPEDATA Parameters

Parameter Value(s) Definition
opeDataset OPENE Indicates the type of OPE data file.
OPEPROJ

opeName A string of 1 to 256 characters. Indicates the project or NE name from the OPE data file.

opeSerial A 32-bit integer in the form of a string. Indicates the serial number from the OPE data file.

opeTnVersion A string consisting of 1 to 18 Indicates the Transnet version of the OPE data file.
characters.

filesize A number in integer format in kbytes. Indicates the size of the OPE data file in kilobytes.

status INVALID Indicates the status of the OPE data file installation process.
INSTALLED
'&' may be used to report multiple status in one message.

76.MTFP50/30, Rev B January 2018 Page 30-889

20. Report - Autonomous Messages TL1 Command Reference Manual

Message Format Example

CORIANT1 12-01-27 16:06:18
A 55 REPT EVT OPEDATA
"OPENE,"Example NE 1","123456","TN 8.50 30 b123",834,INSTALLED"
;

Related Commands
COPY-RFILE

Page 30-890 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

REPT^EVT^SESSION

Command Changes Since Previous Feature Package

• Update system_id_code to support up to 35 characters.

Description
This autonomous message is generated to report a user logging in or logging out.

The output parameters <time>, <date> are output only when the user is logging in. <time> and <date> indicate the
last time this UID successfully logged into the system.

Command Format
None

Message Format (Proper System Response)

<header>

A^^<atag>^REPT^EVT^SESSION^crlf
^^^"<system_id_code>:<uid>,<user_action>,<session_ip_address>,[<date>,<time>]"<c
r><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.14 REPT^EVT^SESSION Parameters

Parameter Value(s) Definition
system_id_cod One to 35 characters The SID identifies the NE generating the message (this is the
e equivalent of the Target Identifier: TID).

uid 6 to 20 alphanumeric characters. Specifies the user identity (login name) that was assigned in the
ENT-USER-SECU command.

user_action LOGIN Identifies the action the user is taking.

LOGOUT

session_ip_ad [0-255].[0-255].[0-255].[0-255] Specifies the IP address associated with a session.

dress When the session is initiated from the RS232C serial port, the
value is NA.

date YY-MM-DD: (1). YY = 00 - 99 (2) MM = Identifies the completion date of the login.
01 - 12 (3) DD = 01 - 31

time HH-MM-SS: (1) HH = 00 - 23 (2) MM = Identifies the completion time of the login.
00 - 59 (3) SS = 00 - 59

76.MTFP50/30, Rev B January 2018 Page 30-891

20. Report - Autonomous Messages TL1 Command Reference Manual

Message Format Examples

When a user logs in:

<header>

A^^<atag>^REPT^EVT^SESSION
^^^"CORIANT:MJORDAN,LOGIN,172.112.121.12,14-01-01,02-36-10"
;

When a user logs out:

<header>

A^^<atag>^REPT^EVT^SESSION
^^^"CORIANT:MJORDAN,LOGOUT,172.112.121.12,"
;

Related Commands
ACT-USER
CANC-USER

Page 30-892 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

REPT^PM

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The REPT PM autonomous message reports performance monitoring information per the schedule and data
specified in the SCHED-PMREPT command.

NEs should not send the REPT PM message unless a schedule has been created via the SCHED-PMREPT
command. Existing PM reporting schedules can be queried using the RTRV-PMSCHED command. PM data may
also be retrieved on demand by a RTRV-PM command, however REPT PM is not used to respond to a RTRV-PM
command (see RETRIEVE-PM response format). Refer to the RTRV-PM-{X} command for a list of all PM supported
by the mTera UTP in this release.

Table 20.15 Format for Performance Monitoring Messages

Block Value(s)
Verb REPT

First Modifier PM

Second Modifier EQPT

FAC: ETH, GBEP, HGE, OCH-P, OCH-OS, OC3, OC12, OC48, OC192, OTU1, OTU2,
OTU4, OTUC2, OTUC3, STM1, STM4, STM16, STM64, TGLAN.

Parameter aid: montype, monval, vldty, locn, dirn, tmper, mondat, montm

Restrictions and Exceptions

• OCH(OCH, OCH-L), OMS, OSC, ODUk, STS1, STS3C, STS12C, STS48C, STS192C facilities are not
included in REPT^PM message. PM data for these facilities is retrievable through RTRV-PM and
RTRV-PMFILE commands. Use SCHED-PMFILE command to schedule the reporting of SONET
historical Path performance-monitoring data on a selected facility entity in binary file format.

• This command does not apply to SSM-2S since in this release it does not support performance monitor
on STMn facility.

Message Format (Proper System Response)

If there is no performance monitoring information to report:
<header>

A^<atag>^REPT^PM<cr><lf>;

If there is at least one condition to report:

<header>

A^<atag>^REPT^PM^{EQPT|fac_type}<cr><lf>
[^^^"<aid>:<montype>,<monval>,[<vldty>],[<locn>],[<dirn>],[<tmper>],[<mondat>][,
<montim>]"<cr><lf>]+;

76.MTFP50/30, Rev B January 2018 Page 30-893

20. Report - Autonomous Messages TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 20.16 REPT^PM Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
TGLAN-20-[1-16]-[1-40]

montype x,x-C,x-F Specifies the type of performance monitoring for the specified
entity.
- x: To be used to specify current value for <montype> x.
- x-C: To be used to specify highest value for gauge <montype>
x. C=Ceiling.
- x-F: To be used to specify lowest value for gauge <montype>
x. F=Floor.

Page 30-894 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 20. Report - Autonomous Messages

Table 20.16 REPT^PM Parameters (Continued)

Parameter Value(s) Definition
monval (1)-60.0 to +60.0, LT+12.0, GT+20.0, Specifies the value of a performance-monitoring parameter:
1.9E-2 to 2.3E-11, -40000 to +40000 - NA specifies that the parameter value is not available.
for gauges. (2)0 to
18446744073709551615 for counters.
(3)NA

vldty COMPL Indicates whether or not a performance monitoring value is

NA valid:
PRTL - COMPL indicates that performance monitoring data are
accumulated.
- NA indicates that performance monitoring data are not
available.
- PRTL indicates that performance monitoring data are
accumulated during a partial time period.

locn NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end location.
The default is NEND.

dirn TDTC Specifies the direction of an event/occurrence in the system:

TDTN - TDTC specifies Transmit direction toward customer.
RCV - TDTN specifies Transmit direction toward DWDM network.
TRMT - RCV specifies Receive direction.
NA - TRMT specifies Transmit direction.
- NA indicates Not Applicable (valid in the response only).

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.
The system defaults to 15-minute increments.

mondat MOY-DOM format:(1)MOY = 1 - Specifies the one day index during which PM data is collected.
12.(2)DOM = 1 - 31. The system defaults to the current date.

montim x-y format:(1). x is any number in the Specifies the beginning of the 15-minute performance
range 0-23. (2). y is one of the monitoring collection time period.
following 15-minute increments: 00, The system defaults to the current 15-minute collection time
15, 30, or 45. period.

Message Format Examples

CORIANT1 02-02-02 00:03:11
A^ 3 REPT PM EQPT
"OTU2-20-1-2:LOSS,0,COMPL,NEND,NA,15-MIN,02-18,23-15"
"OTU2-20-1-2:BE-FEC,1,COMPL,NEND,NA,15-MIN,02-18,23-15"
;

Related Commands
RTRV-PMSCHED
SCHED-PMREPT

76.MTFP50/30, Rev B January 2018 Page 30-895

21. Release Commands TL1 Command Reference Manual

21. Release Commands

RLS-ARC-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
RLS-ARC instructs the network element to leave any of the Alarm Reporting Control (ARC) modes and resume
normal reporting of alarms and events to all managers and the contribution of alarms and events to office and
centralized indications. Alarm reporting control (ARC) affects all OS/NE and user's sessions. When ARC is released,
alarms and events that were raised while ARC was in operation and not subsequently cleared are reported. Only
events that are standing conditions are reported. Transient conditions, such as threshold crossing alerts, are not
reported when ARC is released.

{X} is one of the following:

• Facilities (fac_type):STM1, STM4, STM16, STM64, OC3, OC12, OC48, OC192, FGE, GBEP, TGLAN,
HGE, ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4, OTUC2, OCH-P,
OCH-OS, STS1, STS3C, STS12C, STS48C, STS192C, TTPSTS1, TTPSTS3C.

Restrictions and Exceptions

• For mTera, ARC can apply to each facility independently, while there is no one overall control for whole
module.

• An attempt to RLS-ARC on an ODUk that does not have a client port mapping (CONNECTED1 =AVAIL)
is denied.

• The AID must always correspond to the type.

Command Format
RLS-ARC-{EQPT|<fac_type>}:[tid]:{<eqpt_aid>|<fac_aid>}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-896 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 21. Release Commands

Table 21.1 RLS-ARC-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-Type-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1

76.MTFP50/30, Rev B January 2018 Page 30-897

21. Release Commands TL1 Command Reference Manual

Table 21.1 RLS-ARC-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS3C-20-[1-16]-[1-30]-[190,- EntityID-Type-ShelfID-SlotID-PortID
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
T1-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]
VCG-20-[1-16]-[1-32]

Example 1
RLS-ARC-GOPT:CORIANT1:OTU2-20-1-7:AM1122;

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-ARC-{X}
RTRV-ARC-{X}

Page 30-898 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 21. Release Commands

RLS-CPSW

Command Changes Since Previous Feature Package

• None.

Description
The RLS-CPSW (Release Control Plane Switch) command instructs network element (NE) to release (clear) the
control plane switch request command issued using OPR-CPSW. This command assumes that only one user-
initiated switch request is active per entity (such as, per AID).

NE completes the request to freeze or unfreeze all calls, even if there are no calls which have the source node or
domain ingress node in the NE.

Restrictions and Exceptions

• NE denies the request to unfreeze a call which doesn't have either the source node or domain ingress
node in the NE.

Command Format
RLS-CPSW:[tid]::ctag:::CALLID={<CallId>|"ALL"};

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 21.2 RLS-CPSW Parameters

Parameter Value(s) Definition
CallId Up to a 55 character string in the This parameter represents the call to be frozen. Use "ALL" to
following format: [CNTRY-CAR-AP- freeze all the calls that have ingress nodes in the NE.
]TYPE-ADDRESS-ID. (1)CNTRY -
country code (3 alphabetic characters)
(2)CAR - carrier code (1 to 6
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

Example
RLS-CPSW:CORIANT1::AM1122::CALLID="ALL";

76.MTFP50/30, Rev B January 2018 Page 30-899

21. Release Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-CPSW
RTRV-CALL

Page 30-900 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 21. Release Commands

RLS-EXT-CONT

Command Changes Since Previous Feature Package

• None.

Description
RLS-EXT-CONT instructs an NE to release an external contact, such as a relay deactivation. The contact can be
only released continuously (momentarily is not supported), and can be operated by using the OPR-EXT-CONT
command.

Restrictions and Exceptions

• The mTera shelf, SAIM-20-21 supports CONT-[1-2].

Command Format
RLS-EXT-CONT:[tid]:<cont_aid>:ctag::,;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 21.3 RLS-EXT-CONT Parameters

Parameter Value(s) Definition
cont_aid CONT-[1-2] EntityID-ContID

Example
RLS-EXT-CONT:CORIANT1:CONT-1:AM1122::,;

Possible System Response

CORIANT1 14-12-27 02:08:15
M AM1122 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-EXT-CONT
RTRV-EXT-CONT

76.MTFP50/30, Rev B January 2018 Page 30-901

21. Release Commands TL1 Command Reference Manual

RLS-LPBK-{X}

Command Changes Since Previous Feature Package

• Added support for 300G on OSM-4F.

Description
The RLS-LPBK-{X} command instructs the network element (NE) to release a loopback on the selected port side
facility supported by a transponder. If the loopback is successfully released, the LPBKFACILITY or LPBKTERMINAL
is cleared.

To put back the facility IS again, use the appropriate ED-{facility} command.

The following figure depicts the supported loopback on transponders:

Figure 21.1 Supported Loopbacks

Line
Side

Line Facility Line Terminal

Port Facility Port Terminal

Port
Side

{X} specifies the facility type among the following:

• Facilities (fac_type): STM1, STM4, STM16, STM64, OC3, OC12, OC48, OC192, FGE, GBEP, TGLAN,
HGE, OCH (for OCH-P and OCH-OS), OTU1, OTU2, OTU4.

Restrictions and Exceptions

• Port side Loopbacks are supported on Port side facilities, while Line Side Loopback are supported on
OCH-P/OCH-OS Line side facility.

• The facility AID must always correspond to the facility type.

• For OSM-4F, when the modulation format is configured as 2X150G8QAM, it uses two OCh-OS facilities
(as coupled OCH-OS). In this configuration, the loopback command is valid for the OCH-OS facility on
port-1 only. See OPR-LPBK command for more information. To release the loopback:
- the loopback command is issued to the OCH-OS facility on port-1;
- if the loopback command is issued to OCH-OS facility on port-2, it is denied;

Page 30-902 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 21. Release Commands

Command Format
RLS-LPBK-<fac_type>:[tid]:{<fac_aid>|<och_p_aid>|<och-
os_aid>}:ctag::,,,[<lpbktype>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 21.4 RLS-LPBK-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
TGLAN-20-[1-16]-[1-40]

lpbktype FACILITY Specifies the type of loopback that is applied on this equipment:
TERMINAL FACILITY: Loops the signal back towards the customer for client
port side facility, or toward DWDM network for OCH-P/OCH-OS
line side facility.
TERMINAL: Loops the signal back towards the DWDM network
for client port side facility or toward the customer for OCH-P/
OCH-OS Line side facility.

Example
RLS-LPBK-OC48:CORIANT1:OC48-20-3-5:AM1122::,,,TERMINAL;

Possible System Response

CORIANT1 02-04-16 02:08:15
M AM1122 COMPLD
;

76.MTFP50/30, Rev B January 2018 Page 30-903

21. Release Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-LPBK-{X}

Page 30-904 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 21. Release Commands

RLS-PROTNSW-{x}

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RLS-PROTNSW-{x} (Release Protection Switch Facility) command instructs network element (NE) to release
(clear) a protection switch request between a working facility and a protection facility that was established with the
OPR-PROTNSW-{x} command. This command assumes that only one user-initiated switch request is active per
entity (such as, per AID).

{X} specifies the facility type among the following:

• Facilities (fac_type): EQPT, HGE, OC192, ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4,
TGLAN, STS1, STS3C, STS12C, STS48C, STS192C.

Restrictions and Exceptions

• Specifying either the working (W) or protect (P) AID clears the initiated protection switch request.

• If the Facility Protection Group (FFP) for the AID is configured for revertive, the service is switched to
the alternate facility. If the FFP is configured for non-revertive, the service stays on the current facility.

• The AID must always correspond to the type.

• OC3, OC12, OC48, OC192, STS1, STS3C, STS12C, STS48C, STS192C are applicable when
supported by the SSM-2S module.

• ODUk are only applicable if they are supported on the OSM-1S, OSM-2S, OSM-2C, OSM-4C, OSM-
4F, OSM-5C, OSM-4S.

• The specified entity must be associated with a protection group (1+1 for OCn, SNCP for STS1/STS3C/
STS12C/STS48C/STS192C).

• EQPT is only applicable if they are supported on the SSM-2S for EPG (Equipment Protection Group).

• HGE, TGLAN, OC192 or STM64 must be associated with a YCABLE protection group.

• The system denies the request to release if any of the following conditions are met:
- no local administrative switch request is in effect.
- not in WTR state.

Command Format
RLS-PROTNSW-<fac_type>:[tid]:<fac_aid>:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

76.MTFP50/30, Rev B January 2018 Page 30-905

21. Release Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 21.5 RLS-PROTNSW-{x} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
HGE-20-[1-16]-[1-5]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-16],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-C[1-80]-[1-4], ODU2-20-[1-
16]-[1-2]-[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
SSM2S-20-[1-16]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

Page 30-906 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 21. Release Commands

Example
This command releases a protection switch on a ODU2 protection facility on an OSM-2s.
RLS-PROTNSW-ODU2:CORIANT1:ODU2-20-1-3-1:AM1122;

Possible System Response

CORIANT1 02-04-16 02:08:15

M AM1122 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-PROTNSW-{x}

76.MTFP50/30, Rev B January 2018 Page 30-907

21. Release Commands TL1 Command Reference Manual

RLS-SYNCSW

Command Changes Since Previous Feature Package

• None.

Description
• The RLS-SYNCSW command instructs the network element (NE) to release a previous manual switch
command.

Command Format
RLS-SYNCSW:[tid]:<sync_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 21.6 RLS-SYNCSW Parameters

Parameter Value(s) Definition
sync_aid SYNC-20-1 EntityID-ShelfID-SYNCID

Example
RLS-SYNCSW:CORIANT1:SYNC-20-1:CTAG;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-SYNCSW
RTRV-SYNC
ENT-SYNC
DLT-SYNC
ED-SYNC

Page 30-908 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

22. Retrieve Commands

RTRV-AAA

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-AAA command instructs the NE to retrieve the parameters of AAA (Authentication, Authorization and
Accounting) servers.

Restrictions and Exceptions

• None

Command Format
RTRV-AAA:[tid]::ctag:::[SERVER=<ipaddress>][,PROTO=<aaaproto>][,ROLE=<aaarole>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"::SERVER=<ipaddress>,SECRET=<sharedsecret>,PROTO=<aaaproto>,ROLE=<aaarole>,T
IMEOUT=<radtimeout>,RETRY=<radretry>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.1 RTRV-AAA Parameters

Parameter Value(s) Definition
ipaddress [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the AAA server.

aaaproto RADIUS Specifies the AAA protocol between NE and the AAA server.

aaarole AUTH Specifies the AAA role supported by this AAA entry.

sharedsecret A string consisting of 6 to 32 Specifies the shared secret for the AAA server identified by the
characters. <ipaddress>.

The characters can be: numeric, lowercase alphabetical,

uppercase alphabetical or special characters: ! # $ % & @ ^ *
Note that the following characters are not allowed for
<sharedsecret>: ? / \ { [ ( ) ] }
The sharedsecret is displayed as "*".

radtimeout [1-60] Specifies the response timeout of Access-Request messages

sent to a AAA server in seconds.

76.MTFP50/30, Rev B January 2018 Page 30-909

22. Retrieve Commands TL1 Command Reference Manual

Table 22.1 RTRV-AAA Parameters (Continued)

Parameter Value(s) Definition
radretry [1-10] Specifies the number of attempted Access-Request messages
to a single AAA server before failing authentication.

Example
The following example retrieves all the AAA configurations:
RTRV-AAA:CORIANT1::ctag-1;

Possible System Response

CORIANT1 06-05-15 02:08:15
M ctag-1 COMPLD
^^^"::SERVER=135.252.2.1,SECRET=*,PROTO=RADIUS,ROLE=AUTH,TIMEOUT=10,RETRY=3"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-AAA
DLT-AAA
ENT-AAA

Page 30-910 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ALM-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-ALM-{X} command instructs the network element (NE) to retrieve the current state of alarm conditions
associated with the selected equipment or facility entity. The parameters and their domains are defined in Alarm and
Condition Tables in section 6.

Upon a RTRV-ALM-ALL TL1 input command, the NE does not report any alarms that are being locally suppressed
by the following conditions:
a) Suppression by ARC.
b) Suppression by a maintenance command (ED).

However, upon a RTRV-ALM-{ENTITY} TL1 input command, the NE will display failures that are being locally
suppressed for the following conditions but with NR (Not-Reported) as a notification code, instead of the actual
profile value:
a) Suppression by ARC.
b) Suppression by a maintenance command (ED).
c) Suppression when in any command are set to inhibit autonomous alarm (e.g INH-MSG-ALL).

{X} specifies the equipment type or facility type among the following:
• Equipment: EQPT: See the Parameter section for supported equipment AIDs.

• SLOT (eqpt_aid must be SLOT)

• Facilities (fac_type): ETH, FGE, GBEP, HGE, MGTETH, OC3, OC12, OC48, OC192, OCH (for OCH,
OCH-P, OCH-L, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4,
OTUC2, OPTD, OMS, OSC, OTS, TGLAN.

• Logical (logic_type):NTPPEER, SW, PPP, RSVPADJ, GCC, TL.

Restrictions and Exceptions

• When "ALL" is used as second modifier, no AID is allowed.

• When second modified is different than "ALL", then an AID (including ALL) must be specified.

• The Equipment/Facility/Logic AID must always correspond to the Equipment/Facility/Logic type.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-ALM-
{EQPT|SLOT|<fac_type>|<logic_type>|ALL}:[tid]:[<eqpt_aid>|<fac_aid>|<logic_aid>|
ALL]:ctag::[<ntfcncde>],[<condtype>],[<srveff>],[<locn>],[<dirn>];

76.MTFP50/30, Rev B January 2018 Page 30-911

22. Retrieve Commands TL1 Command Reference Manual

Proper System Response

There is no alarm to report:
<header>

M^^<ctag>^COMPLD<cr><lf>;

There is at least one alarm condition to report:

<header>

^^^"[<{eqpt_aid|fac_aid|logic_aid}>][,<aidtype>]:<ntfcncde>,<condtype>,<srveff>,
[<ocrdat>],[<ocrtm>],[<locn>],[<dirn>]:<conddescr>";

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.2 RTRV-ALM-{X} Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CDCP-20-[10-16,1-7]-[1-3]
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
FAN-20-[29-32]
FAN8-20-[16,17]
FSM-20-[35,34]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OMD-20-[1-16]-[1-2]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SIOM-20-15
SLOT-20-[1-35]-[1-32], SLOT-[50-58]-
[1-8]
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

Page 30-912 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.2 RTRV-ALM-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID[-ODU4TribPort]
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
MGTETH-20-[13,14,21,24,25,28]-[1-8]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTS-20-[10-16,1-7]-21,OTS-20-[1-
16]-1

76.MTFP50/30, Rev B January 2018 Page 30-913

22. Retrieve Commands TL1 Command Reference Manual

Table 22.2 RTRV-ALM-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) OTU1-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID[-ODU4TribPort]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
T1-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]
VCG-20-[1-16]-[1-32]

logic_aid GCC0-20-[1-16]-[1-32] EntityID-NPID-NodeID-TLID

GCC1-20-[1-16]-[1-20], GCC1-20-[1-
16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC1-20-[1-
16]-[1-2]-[D][1-3]-[B,C][1-80]-
[A,B,E,Z,F][1-32], GCC1-20-[1-16]-[1-
2]-[D][1-3]-[A,B,C,E,Z,F][1-80]
GCC12-20-[1-16]-[1-20], GCC12-20-
[1-16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-
32], GCC12-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC12-20-[1-
16]-[1-2]-[D][1-3]-[B,C][1-80]-
[A,B,E,Z,F][1-32], GCC12-20-[1-16]-
[1-2]-[D][1-3]-[A,B,C,E,Z,F][1-80]
GCC2-20-[1-16]-[1-20], GCC2-20-[1-
16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC2-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC2-20-[1-
16]-[1-2]-[D][1-3]-[B,C][1-80]-
[A,B,E,Z,F][1-32], GCC2-20-[1-16]-[1-
2]-[D][1-3]-[A,B,C,E,Z,F][1-80]
NTPPEER-[2,1]
PPPL-[20]-[1-16]-[1-30], PPPL-[20]-[1-
16]-99-[1-30]
PPPMS-[20]-[1-16]-[1-30], PPPMS-
[20]-[1-16]-99-[1-30]
PPPRS-[20]-[1-16]-[1-30], PPPRS-
[20]-[1-16]-99-[1-30]
PPPS-[20]-[1-16]-[1-30], PPPS-[20]-
[1-16]-99-[1-30]
RSVPADJ-[1,3]-1-[1-40]
SW-1
TL-[1,3]-[1-512]-[1-1500]

Page 30-914 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.2 RTRV-ALM-{X} Parameters (Continued)

Parameter Value(s) Definition
ntfcncde CR Indicates the notification code (severity level) associated with
MJ the condition type. The codes include: critical, major and minor.
MN
NR

condtype Refer to Alarm and Condition Tables Identifies the current standing conditions which cause alarms
for the possible values of Condition and/or events.
Types.

srveff NSA Indicates if an alarm is service affecting or nonservice affecting:

SA - NSA indicates non-service affecting.
- SA indicates service affecting.

locn NEND Indicates if the alarm or event location is near end or far end.
FEND - NEND: Near End (Condition, alarm, or event occurred at the
near end of the system.)
- FEND: Far End (Condition, Alarm, or event occurred at the far
end of the system.)

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies both applicable directions: one type of TDTC
TDTN and one type of TDTN.
RCV - TDTC specifies Transmit direction toward Customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.
- NA indicates Not Applicable (valid in the response only).

aidtype EQPT This is the type of the Access Identifier.

SLOTETH
GBEP
HGE
NTPPEER
OC3
OC12
OC48
OC192
OCH
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
OTU1
OTU2
OTU4
OTUC2
OMS
OSC
OTS
GCC
RSVPADJ
SW
TGLAN
TL

76.MTFP50/30, Rev B January 2018 Page 30-915

22. Retrieve Commands TL1 Command Reference Manual

Table 22.2 RTRV-ALM-{X} Parameters (Continued)

Parameter Value(s) Definition
ocrdat MOY-DOM format:(1)MOY = 1 - Indicates the occurrence date of the alarm by the month of the
12.(2)DOM = 1 - 31. year and the day of the month.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Indicates the occurrence time of the alarm by the hour of the
00 - 59 (3) SS = 00 - 59 day, the minute of the hour, and the second of the minute.

conddescr Refer to Alarm and Condition Tables Describes the condition that caused the alarm. Text string with a
for the possible values of Condition maximum of 255 characters and enclosed in escape quotes.
Types.

Example 1
RTRV-ALM-OC48:CORIANT:OC48-2-1-1:AM0662;

Possible System Response

CORIANT 14-02-12 16:07:47

M AM0662 COMPLD

"OC48-20-1-1,OC48:CR,LOS,SA,01-01,12-28-14,NEND,TDTN:\"Loss Of Signal\""

Example 2
RTRV-ALM-TL:HONGKONG::100;

Possible System Response

HONGKONG 14-11-29 00:06:06

M 100 COMPLD

"TL-20-1-102:MJ,CONF_FAIL,NSA,11-28,00-01-02,NEND,NA:\"The Neighbor Discovery

process was unable to successfully negotiate\""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

REPT^ALM
RTRV-COND-{X}

Page 30-916 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ALM-ENV

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-ALM-ENV command instructs the network element (NE) to retrieve the current state of environmental
alarm within the network element (NE).

Restrictions and Exceptions

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-ALM-ENV:[tid]:{<env_aid>|ALL}:ctag::[<ntfcncde>],[<almtype>];

Proper System Response

When there is no alarm to report:
<header>

M^^<ctag>^COMPLD

When there is at least one alarm to report:

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^"<env_aid>:<ntfcncde>,<almtype>,[<ocrdat>],[<ocrtm>][,<almmsg>]"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.3 RTRV-ALM-ENV Parameters

Parameter Value(s) Definition
env_aid ENV-[1-5] EntityID-EnvID

ntfcncde CR Indicates the notification code (severity level) associated with

MJ the condition type. The codes include: critical, major and minor.
MN

76.MTFP50/30, Rev B January 2018 Page 30-917

22. Retrieve Commands TL1 Command Reference Manual

Table 22.3 RTRV-ALM-ENV Parameters (Continued)

Parameter Value(s) Definition
almtype AIRCOMPR Identifies the current name of the alarm conditions. The text
AIRCOND within "..." below describes the default alarm message
AIRDRYR associated with each alarm type.
BAMP_1_FAILURE - AIRCOMPR specifies "Air compressor failure".
BAMP_1_WARNING - AIRCOND specifies "Air conditioning failure".
BAMP_2_FAILURE - AIRDRYR specifies "Air dryer failure".
BAMP_2_WARNING - BATDSCHRG specifies "Battery discharging".
BAMP_3_FAILURE - BATTERY specifies "Battery failure".
BAMP_3_WARNING - BAMP_x_FAILURE specifies "Booster Amp number x failure"
BAMP_4_FAILURE where x={1-4}.
BAMP_4_WARNING - BAMP_x_WARNING specifies "Booster Amp number x
BATDSCHRG warning" where x={1-4}.
BATTERY - CLFAN specifies "Cooling fan failure".
CLFAN - CPMAJOR specifies "Centralized Power Major Environmental
CPMAJOR Alarm or Major Equipment Failure".
CPMINOR - CPMINOR specifies "Centralized Power Minor Environmental
CRA_1_FAILURE Alarm or Minor Equipment Failure".
CRA_1_WARNING - CRA_x_FAILURE specifies "Co-Propagating Raman number x
CRA_2_FAILURE failure" where x={1-4}.
CRA_2_WARNING - CRA_x_WARNING specifies "Co-Propagating Raman number
CRA_3_FAILURE x warning" where x={1-4}.
CRA_3_WARNING - ENGINE specifies "Engine failure".
CRA_4_FAILURE - ENGOPRG specifies "Engine operating".
CRA_4_WARNING - ENGTRANS specifies "Standby Engine Transfer".
ENGINE - EXPLGS specifies "Explosive gas".
ENGOPRG - FIRDETR specifies "Fire detector failure".
ENGTRANS - FIRE specifies "Fire".
EXPLGS - FLOOD specifies "Flood".
FIRDETR - FUELLEAK specifies "Fuel Leak".
FIRE - FUSE specifies "Fuse failure".
FLOOD - GASALARM specifies "Exp Gas/ Toxic Gas/Vent or Gas Mon
FUELLEAK Fail".
FUSE - GEN specifies "Generator failure".
GASALARM - HATCH specifies "CEV Hatch Fail".
GEN - HIAIR specifies "High airflow".
HATCH - HIHUM specifies "High humidity".
HIAIR - HITEMP specifies "High temperature".
HIHUM - HIWTR specifies "High water".
HITEMP - INTRUDER specifies "Intrusion".
HIWTR - LVDADSL specifies "Secondary ADSL Low Voltage
INTRUDER Disconnect".
LVDADSL

Page 30-918 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.3 RTRV-ALM-ENV Parameters (Continued)

Parameter Value(s) Definition
almtype LWBATVG - LWBATVG specifies "Low battery voltage".
(continue) LWFUEL - LWFUEL specifies "Low fuel".
LWHUM - LWHUM specifies "Low humidity".
LWPRES - LWPRES specifies "Low cable pressure".
LWTEMP - LWTEMP specifies "Low temperature".
LWWTR - LWWTR specifies "Low water".
MISC - MISC specifies "Miscellaneous".
NIR_1_FAILURE - NIR_x_FAILURE specifies "Network Interfaced Raman
NIR_1_WARNING number x failure" where x={1-4}.
NIR_2_FAILURE - NIR_x_WARNING specifies "Network Interfaced Raman
NIR_2_WARNING number x warning" where x={1-4}.
NIR_3_FAILURE - OPENDR specifies "Open door".
NIR_3_WARNING - POWER specifies "Commercial power failure".
NIR_4_FAILURE - PWRMJ specifies "Power Supply Major incl Stdby Engine".
NIR_4_WARNING - PWRMN specifies "Power Supply Minor incl Stdby Engine".
OPENDR - PUMP specifies "Pump failure".
POWER - RECT specifies "Rectifier failure".
PUMP - RECTHI specifies "Rectifier high voltage".
PWRMJ - RECTLO specifies "Rectifier low voltage".
PWRMN - RTACADSL specifies "AC or Rectifier Power Fail ADSL Eqpt".
RECT - RTACTRANS specifies "AC or Rectifier Power Fail Trans
RECTHI Eqpt".
RECTLO - RTACPWR specifies "AC or Rectifier Power Fail DCL Eqpt".
RTACADSL - RTACPWRENG specifies "Comm AC Fail - Site e/w Stdby
RTACCRIT Eng".
RTACPWR - RTBAYPWR specifies "AC power Loss Distributed Power RT
RTACPWRENG Bay".
RTBAYPWR - RTRVENG specifies "Retrieve Stdby Eng - Com AC restored".
RTRVENG - SMOKE specifies "Smoke".
SMOKE - TEMP specifies "High-Low Temperature".
TEMP - TOXICGAS specifies "Toxic gas".
TOXICGAS - TREPEATER specifies "T Repeater Shelf Major".
TREPEATER - VENTN specifies "Ventilation system failure".
VENTN

ocrdat MOY-DOM format:(1)MOY = 1 - Indicates the occurrence date of the alarm by the month of the
12.(2)DOM = 1 - 31. year and the day of the month.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Indicates the occurrence time of the alarm by the hour of the
00 - 59 (3) SS = 00 - 59 day, the minute of the hour, and the second of the minute.

almmsg One to 40 alphanumeric characters. Describes the environmental condition that caused the alarm.
Text string with a maximum of 40 characters and enclosed in
escape quotes.
Refer to section 2 for the applicable characters.

Example
RTRV-ALM-ENV:CORIANT1:ALL:AM0662;

Possible System Response

CORIANT1 15-02-12 16:07:47

M AM0662 COMPLD

"ENV-1:CR,FIRE,02-29,22-41-25,\"FIRE\""
;

76.MTFP50/30, Rev B January 2018 Page 30-919

22. Retrieve Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

REPT^ALM^ENV
RTRV-ATTR-ENV
SET-ATTR-ENV

Page 30-920 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ALMGEN

Command Changes Since Previous Feature Package

• None.

Description
This command retrieves the alarm generation state of the system.

A privilege code of A8 (Admin) is required in order to execute this command.

Restrictions and Exceptions

• None

Command Format
RTRV-ALMGEN:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<almmode>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.4 RTRV-ALMGEN Parameters

Parameter Value(s) Definition
almmode ON Indicates the systems alarm generation state.
OFF - STP-ALMGEN command issued
- STA-ALMGEN command in progress

Example
RTRV-ALMGEN:::AM0045;

Possible System Response

The response shown below reflects that the STA-ALMGEN command is still in progress.
CORIANT1 02-04-16 02:08:15
M AM0045 COMPLD
"ON"
;

The response shown below is output from the RTRV-ALM-ALL command while STA-ALMGEN is executing.

76.MTFP50/30, Rev B January 2018 Page 30-921

22. Retrieve Commands TL1 Command Reference Manual

CORIANT1 02-04-16 02:08:16

M AM0046 COMPLD
"SPM-1-18,EQPT:MN,INHALM,NSA,4-16,1-4-15,NEND,NA:\"Real alarms are currently
inhibited\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
STA-ALMGEN
STP-ALMGEN

Page 30-922 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ALMPF-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-ALMPF-{X} command instructs the network element (NE) to display the attributes (notification codes,
condition types, alarm locations) of any of the alarm profile tables (0, 1 through 20 or 99) assigned for system
equipment, facilities or logical entities. The attributes of the alarm profile tables assigned (1 through 20 only) can be
altered with the ED-ALMPF-{X} command.

{X} specifies the equipment type, facility type or logical type among the following:
• Equipment: EQPT (representing the following acceptable module AIDs: BFM, CDCP, CFP, CFP2, FAN,
FAN8, MFAB, MFAB2, MFM, OADMRS, OADMRS9, OCC, OSM2C, OSM1S, OSM2S, SSM-2S, OSM-
4C, OSM-4F, OSM-4S, OSM-5C, SAIM, SDM, SEIM, SFM, SFP, SFPP, SH, SIOM, SLOT, STIM,
STPM, STPM8).

• Facilities (fac_type): MGTETH, ETH, FGE, GBEP, HGE, OC3, OC12, OC48, OC192, STM1, STM4,
STM16, OCH (for OCH, OCH-L, OCH-P, OCH-OS), ODU0, ODU1, ODU2, ODU4, ODUF, OMS, OSC,
OTS, OTU1, OTU2, OTU4, OTUC2, STS1, STS3C, STS12C, STS48C, STS192C, TTPSTS1,
TTPSTS3C, VCG, TGLAN.

• Logical (logic_type): GCC, NTPPEER, DB, SW, SECU

Restrictions and Exceptions

• When "ALL" is used as second modifier, the AID is optional and defaults to ALL.

• When second modified is different than "ALL", then an AID (including ALL) must be specified.

• The Equipment/Facility/Logic AID must always correspond to the Equipment/Facility/Logic type.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• For all condition types that begin with "T-" (Performance Monitoring related condition types), the only
valid value for the <dirn> parameter is BTH. For these condition types, BTH should be interpreted as
"all directions", meaning all supported directions for the condition type (TDTN, TDTC, RCV, TRMT, NA)
is retrieved.

Command Format
RTRV-ALMPF-{EQPT|<fac_type>|<logic_type>|ALL}:[tid]:[<almProfile_aid>]:ctag::
[<ntfcncde>],[<condtype>],[<srveff>],[<locn>],[<dirn>],[<tmper>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<almProfile_aid>,<aidtype>:<ntfcncde>,<condtype>,<srveff>,<locn>,<dirn>,<tmp
er>";

76.MTFP50/30, Rev B January 2018 Page 30-923

22. Retrieve Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.5 RTRV-ALMPF-{X} Parameters

Parameter Value(s) Definition
almProfile_aid ALMPF-[99,1-20,0] EntityID-TBLID

ntfcncde CR Indicates the notification code (severity level) associated with

MJ the condition type.
MN The codes include: critical, major, minor, not alarmed and not
NA reported.
NR
ALL

condtype Refer to Alarm and Condition Tables Identifies the current standing conditions which cause alarms
for the possible values of Condition and/or events.
Types.

srveff NSA Indicates if an alarm is service affecting or nonservice affecting:

SA - NSA indicates non-service affecting.
- SA indicates service affecting.

locn NEND Indicates if the alarm or event location is near end or far end.
FEND - NEND: Near End (Condition, alarm, or event occurred at the
near end of the system.)
- FEND: Far End (Condition, Alarm, or event occurred at the far
end of the system.)

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies both applicable directions: one type of TDTC
TDTN and one type of TDTN.
RCV - TDTC specifies Transmit direction toward Customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.
- NA indicates Not Applicable (valid in the response only).

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

Page 30-924 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.5 RTRV-ALMPF-{X} Parameters (Continued)

Parameter Value(s) Definition
aidtype EQPT This is the type of the Access Identifier.
ETH
FGE
GBEP
HGE
OC3
OC12
OC48
OC192
OCH
OMS
OSC
OTS
OTU1
OTU2
OTU4
OTUC2
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
RSVPADJ
SECU
STM1
STM4
STM16
STM64
SW
TGLAN
VCG
TTPSTS1
TTPSTS3C

Example
This command retrieves the notification code associated with equipment using alarm profile table 4, and the RUP
condition type:

RTRV-ALMPF-EQPT:CORIANT:ALMPF-4:AM0662::,RUP-FAIL;

Possible System Response

CORIANT 14-02-12 16:07:47
M AM0662 COMPLD
"ALMPF-4,EQPT:CR,RUP-FAIL,SA,NEND,NA"
"ALMPF-4,EQPT:MN,RUP-FAIL,NSA,NEND,NA"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-925

22. Retrieve Commands TL1 Command Reference Manual

Related Commands and Autonomous Messages

REPT^ALM
ED-ALMPF-{X}

Page 30-926 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-AO

Command Changes Since Previous Feature Package

• None.

Description
Use the RTRV-AO command to retrieve copies of Autonomous Output messages that are suspected as missing or
for other verification purposes. Up to 1000 autonomous messages are stored in the NE. Examples of autonomous
messages are REPT^DBCHG, REPT^ALM, and REPT^ EVT.

The autonomous messages retrieved by RTRV-AO are listed in ATAG or DBCHGSEQ order in the output. If none
of the available autonomous messages on the system satisfy the specific selection criteria, then a complete normal
response is issued.

Restrictions and Exceptions

• It is possible to select either ATAGSEQ or DBCHGSEQ keyword parameter in the command.

• The default for all parameters is null. If all parameters are not specified, defaulted null, then RTRV-AO
retrieves none of the available autonomous messages.

• The "LAST" parameter value should be used to retrieve messages from the specified in the ATAGSEQ
or DBCHGSEQ up to the last message.

• When DBCHGSEQ is selected, the command response will include only Database changes (DBCHG).

• This command supports ranging "&&" but does not support grouping "&".

Command Format
RTRV-AO:[tid]::ctag:::[,ATAGSEQ=<atagseq>|DBCHGSEQ=<dbchgseq>];

Proper System Response

There is nothing to report:
<header>

M^^<ctag>^COMPLD<cr><lf>

^^^/* No message to output */

There is one or more autonomous messages that satisfies the criteria:

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^( /* <amessage> */ ) +

Note: + indicates that more that one line can be output.

76.MTFP50/30, Rev B January 2018 Page 30-927

22. Retrieve Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.6 RTRV-AO Parameters

Parameter Value(s) Definition
atagseq 0-999999999 Specifies the autonomous message sequence number of the
retrieved output message.
To specify a range use &&, such as, 245&&256.
If ranging is used, the value "LAST" for the upper range limit
indicates all messages from the lower range limit to the last
message.

dbchgseq [0-9999] Specifies the database (DB) change message sequence

number that is unique to REPT^DBCHG messages.
If ranging is used, the value "LAST" for the upper range limit
indicates all messages from the lower range limit to the last
message.

Example
This example retrieves all autonomous messages having an atag number ranging from atag=12 to atag=14.
RTRV-AO:CORIANT1::AM0662:::ATAGSEQ=12&&14;

A Possible System Response

CORIANT1 02-02-12 16:07:47
M AM0662 COMPLD
/*
CORIANT1 02-02-02 10:02:39
*C12 REPT ALM EQPT
"LOAME-1-2:CR,RUP-FAIL,SA,02-02,00-02-39,NEND,NA:\"Replaceable Unit Problem -
Equipment Failed\""
CORIANT1 02-02-02 10:03:12
A13 REPT EVT EQPT
"TGTME-2-2:T-LBC,TC,02-02,00-02-39,NEND,,103,100,15-MIN:\"Laser Bias Current
Level\""
CORIANT1 02-02-02 10:05:55
*C14 REPT ALM OC3
"OC3-2-1-1:CR,LOS,SA,02-02,00-02-39,NEND,TDTN:\"Loss Of Signal\""
*/
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

Page 30-928 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ARC-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
RTRV-ARC command instructs an NE to send information related to the Alarm Reporting Control (ARC) feature.

ARC has three different modes for inhibiting automatic message reporting.
Qualified inhibition (QI): Inhibition lasts until service affecting failures have cleared and remained clear for a settable
interval. ARC can be terminated with a RLS-ARC command.
• Timed inhibition (TI): Inhibition lasts for a settable interval. ARC can be terminated with a RLS-ARC
command.

• Indefinite inhibition (IND): Inhibition lasts until a RLS-ARC command is received.

Only the QI is supported in this release.

A value for the ARC mode of RLS indicates that ARC is not in operation and that normal alarm and event reporting
is occurring.

{X} specifies the facility or equipment type among the following:

• Facilities (fac_type):STM1, STM4, STM16, STM64, OC3, OC12, OC48, OC192, FGE, GBEP, TGLAN,
HGE, ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4, OTUC2, OCH-P,
OCH-OSP, STS1, STS3C, STS12C, STS48C, STS192C, TTPSTS1, TTPSTS3C.

Restrictions and Exceptions

• For mTera, ARC can apply to each facility independently, while there is no one overall control for whole
module.

• When using RTRV-ARC-ALL or RTRV-ARC-STSn::ALL command to retrieve ARC parameters on all

the STSn, the command response will display <arctmrmg> (ARC time remaining) as NA.

• For STS path ARC, the <fac_aid> field does not support ranging on STS entities.

• The AID must always correspond to the type.

Command Format
RTRV-ARC-
{EQPT|<fac_type>|ALL}:[tid]:[{<eqpt_aid>|<fac_aid>|ALL}]:ctag::[<arcmode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"[<aid>][,<aidtype>]:<arcmode>,<arcinterval>,<arctmrmg>" <cr><lf>

76.MTFP50/30, Rev B January 2018 Page 30-929

22. Retrieve Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.7 RTRV-ARC-{X} Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]

Page 30-930 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.7 RTRV-ARC-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS192C-20-[1-16]-[1-6]-1, STS192C- EntityID-ShelfID-SlotID-PortID
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
T1-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]
VCG-20-[1-16]-[1-32]

arcmode QI Specifies the mode of Alarm Report Control:

RLS - QI: Qualified inhibition.
- RLS: Released (indicates ARC is not in operation).

aidtype GBEP Specifies the access identifier of the selected equipment

FGE module.
HGE
OC3
OC12
C48
OC192
OCH-P
OCH-OS
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
OTU1
OTU2
OTU4
OTUC2
STM1
STM4
STM16
STM64
TGLAN

arcinterval [0-99]-[0-59] Indicates the time interval to be used in the operation of the
Alarm Report Control feature:
- HOD identifies the hours.
- MOH identifies the minutes.

arctmrmg [0-99]-[0-59] or NA Is the current value of the timer in the QI or TI modes, indicating
the time remaining until transition out of ARC. It is only
applicable when the entity is in the TI mode or the Count Down
sub-state of the QI mode; otherwise a null value is returned.
- HOD identifies the hours.
- MOH identifies the minutes.

For STS entities, the command response will display arctmrmg

as NA in the case that RTRV-ARC-ALL or RTRV-ARC-
STSn::ALL command is used.

76.MTFP50/30, Rev B January 2018 Page 30-931

22. Retrieve Commands TL1 Command Reference Manual

Example
RTRV-ARC-ODU2:CORIANT1: ODU2-20-1-5:AM0011;

Possible System Response

CORIANT1 02-04-16 02:08:15

M AM0011 COMPLD

"ODU2-20-1-5,ODU2:QI,10-5,0-2"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-ARC-{X}
RLS-ARC-{X}

Page 30-932 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ATTN-OCH

Command Changes Since Previous Feature Package

• None

Description
The RTRV-ATTN-OCH::{X} command instructs the network element (NE) to retrieve the current power attenuation
level of a EVOA (Electronic Variable Optical Attenuator) on a selected OCH or OCH-L facility.

If the attenuation adjustment mode of egress (AAMEGR) is on manual (AAMEGR=MAN), the EVOA attenuation
level value displayed is the one that has been set with the SET-ATTN-OCH command.

If the AAMEGR is on automatic mode (AAMEGR=AUTO), the egress EVOA attenuation level value displayed is the
one set automatically by the Automatic Power Management algorithm. If the AAMINGR is on automatic mode
(AAMINGR=AUTO), the ingress EVOA attenuation level value displayed is the one set automatically by the
Automatic Power Management algorithm.

The Attenuation Adjustment Mode can be changed with the ED-OCH command.

Restrictions and Exceptions

• When "ALL" is selected, it will display related EVOA attenuation information for all OCH/OCH-L facilities
within the NE.

• AAMINGR and AAMEGR are applicable to OADMRS/OADMRS9 modules.

• ATTNINGR and ATTNEGR are applicable to OADMRS/OADMRS9 modules.

Command Format
RTRV-ATTN-OCH:[tid]:{<och_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<och_aid>::[,AAMINGR=<AttAdjModeIngress>][,AAMEGR=<AttAdjModeEgress>][,ATTNI
NGR=<AttnIngress>][,ATTNEGR=<AttnEgress>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-933

22. Retrieve Commands TL1 Command Reference Manual

Table 22.8 RTRV-ATTN-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]

AttAdjModeIng AUTO Indicates the attenuation adjustment mode at Ingress side of

ress MAN module.
For ingress side (route side) per channel attenuation control of
OADMRS/OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

AttAdjModeEg AUTO Indicates the attenuation adjustment mode at egress side of

ress MAN module.
For egress side (select side) per channel attenuation control of
OADMRS/OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

MAN indicates the facility is on manual adjustment.

AttnIngress Possible values: (1) 0.0 to 18.0 dB Indicates the current power attenuation level measured in dB for
with 0.1 dB increments. ingress attenuator.

Applicable to attenuation of OADMRS/OADMRS9 module

ingress side (Route Side).

AttnEgress Possible values: (1) 0.0 to 18.0 dB Indicates the current power attenuation level measured in dB for
with 0.1 dB increments. egress attenuator.

Applicable to attenuation of OADMRS/OADMRS9 module

egress side (Select Side).

Example
RTRV-ATTN-OCH:CORIANT1:OCH-L-20-1-21-1:AM0102;

Possible System Response

CORIANT1 14-12-02 00:50:03
M AM0102 COMPLD
"OCH-L-20-1-21-1::AAMINGR=AUTO,ATTNINGR=(+2.2),AAMEGR=AUTO,ATTNEGR=(+3.5)"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OCH
SET-ATTN-OCH

Page 30-934 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ATTR-CONT

Command Changes Since Previous Feature Package

• None.

Description
RTRV-ATTR-CONT instructs the network element to send the attributes associated with an external contact. These
attributes are used when an external contact is operated or released. The related input command is SET-ATTR-
CONT.

Restrictions and Exceptions

• The mTera shelf, SAIM-20-21 supports CONT-[1-2].

Command Format
RTRV-ATTR-CONT:[tid]:{<cont_aid>|ALL}:ctag[::<controltype>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<cont_aid>:[<controltype>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.9 RTRV-ATTR-CONT Parameters

Parameter Value(s) Definition
cont_aid CONT-[1-2] EntityID-ContID

76.MTFP50/30, Rev B January 2018 Page 30-935

22. Retrieve Commands TL1 Command Reference Manual

Table 22.9 RTRV-ATTR-CONT Parameters (Continued)

Parameter Value(s) Definition
controltype AIRCOND Specifies the type of contact:
ENGINE - Enter AIRCOND for air conditioning.
FAN - Enter ENGINE for engine.
GEN - Enter FAN for fan.
HEAT - Enter GEN for generator.
LIGHT - Enter HEAT for heat.
MISC - Enter LIGHT for light.
SPKLR - Enter MISC for miscellaneous.
BAMP_1_SHUTDOWN - Enter SPKLR for sprinkler.
BAMP_2_SHUTDOWN - Enter BAMP_x_SHUTDOWN for shutdown of Booster Amp
BAMP_3_SHUTDOWN number x where x={1-4}.
BAMP_4_SHUTDOWN - Enter CRA_x_SHUTDOWN for shutdown of Co-Propagating
CRA_1_SHUTDOWN Raman number x where x={1-4}.
CRA_2_SHUTDOWN - Enter NIR_x_SHUTDOWN for shutdown of Network
CRA_3_SHUTDOWN InterfacedRaman number x where x={1-4}.
CRA_4_SHUTDOWN
NIR_1_SHUTDOWN
NIR_2_SHUTDOWN
NIR_3_SHUTDOWN
NIR_4_SHUTDOWN

Example
RTRV-ATTR-CONT:CORIANT1:CONT-1:AM0662;

Possible System Response

CORIANT1 14-12-12 16:07:47
M AM0662 COMPLD
"CONT-1:SPKLR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

SET-ATTR-CONT

Page 30-936 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ATTR-ENV

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-ATTR-ENV command instructs the network element (NE) to retrieve the current state of alarm conditions
associated with a particular environmental entity.

Restrictions and Exceptions

Command Format
RTRV-ATTR-ENV:[tid]:{<env_aid>|ALL}:ctag::[<ntfcncde>][,<almtype>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^"<env_aid>:[<ntfcncde>,<almtype>[,<almmsg>]]"<cr><lf>*;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.10 RTRV-ATTR-ENV Parameters

Parameter Value(s) Definition
env_aid ENV-[1-5] EntityID-EnvID

ntfcncde CR Indicates the notification code (severity level) associated with

MJ the condition type.
MN The codes include: critical (CR), major (MJ), minor (MN).
NR A null value in this parameter indicates no assignment for the
specified environmental alarm.

76.MTFP50/30, Rev B January 2018 Page 30-937

22. Retrieve Commands TL1 Command Reference Manual

Table 22.10 RTRV-ATTR-ENV Parameters (Continued)

Parameter Value(s) Definition
almtype AIRCOMPR Identifies the current state of the alarm conditions.
AIRCOND The text within "..." below describes the default alarm message
AIRDRYR associated with each alarm type.
BAMP_1_FAILURE - AIRCOMPR specifies "Air compressor failure".
BAMP_1_WARNING - AIRCOND specifies "Air conditioning failure".
BAMP_2_FAILURE - AIRDRYR specifies "Air dryer failure".
BAMP_2_WARNING - BAMP_x_FAILURE specifies "Booster Amp number x failure"
BAMP_3_FAILURE where x={1-4}.
BAMP_3_WARNING - BAMP_x_WARNING specifies "Booster Amp number x
BAMP_4_FAILURE warning" where x={1-4}.
BAMP_4_WARNING - BATDSCHRG specifies "Battery discharging".
BATDSCHRG - BATTERY specifies "Battery failure".
BATTERY - CLFAN specifies "Cooling fan failure".
CLFAN - CPMAJORspecifies "Centralized Power Major Environmental
CPMAJOR Alarm or Major Equipment Failure".
CPMINOR - CPMINOR specifies "Centralized Power Minor Environmental
CRA_1_FAILURE Alarm or Minor Equipment Failure".
CRA_1_WARNING - CRA_x_FAILURE specifies "Co-Propagating Raman number x
CRA_2_FAILURE failure" where x={1-4}.
CRA_2_WARNING - CRA_x_WARNING specifies "Co-Propagating Raman number
CRA_3_FAILURE x warning" where x={1-4}.
CRA_3_WARNING - ENGINE specifies "Engine failure".
CRA_4_FAILURE - ENGOPRG specifies "Engine operating".
CRA_4_WARNING - ENGTRANS specifies "Standby Engine Transfer".
ENGINE - EXPLGS specifies "Explosive gas".
ENGOPRG - FIRDETR specifies "Fire detector failure".
ENGTRANS - FIRE specifies "Fire".
EXPLGS - FLOOD specifies "Flood".
FIRDETR - FUELLEAK specifies "Fuel Leak".
FIRE - FUSE specifies "Fuse failure".
FLOOD - GASALARM specifies "Exp Gas/ Toxic Gas/ Vent or Gas Mon
FUELLEAK Fail".
FUSE - GEN specifies "Generator failure".
GASALARM - HATCH specifies "CEV Hatch Fail".
GEN - HIAIR specifies "High airflow".
HATCH - HIHUM specifies "High humidity".
HIAIR - HITEMP specifies "High temperature".
HIHUM - HIWTR specifies "High water".
HITEMP - INTRUDER specifies "Intrusion".
HIWTR - LVDADSL specifies "Secondary ADSL Low Voltage
INTRUDER Disconnect".
LVDADSL

Page 30-938 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.10 RTRV-ATTR-ENV Parameters (Continued)

Parameter Value(s) Definition
almtype LWBATVG - LWBATVG specifies "Low battery voltage".
(continue) LWFUEL - LWFUEL specifies "Low fuel".
LWHUM - LWHUM specifies "Low humidity".
LWPRES - LWPRES specifies "Low cable pressure".
LWTEMP - LWTEMP specifies "Low temperature".
LWWTR - LWWTR specifies "Low water".
MISC - MISC specifies "Miscellaneous" (default).
NIR_1_FAILURE - NIR_x_FAILURE specifies "Network Interfaced Raman
NIR_1_WARNING number x failure" where x={1-4}.
NIR_2_FAILURE - NIR_x_WARNING specifies "Network Interfaced Raman
NIR_2_WARNING number x warning" where x={1-4}.
NIR_3_FAILURE - OPENDR specifies "Open door".
NIR_3_WARNING - POWER specifies "Commercial power failure".
NIR_4_FAILURE - PWRMJ specifies "Power Supply Major incl Stdby Engine".
NIR_4_WARNING - PWRMN specifies "Power Supply Minor incl Stdby Engine".
OPENDR - PUMP specifies "Pump failure".
POWER - RECT specifies "Rectifier failure".
PUMP - RECTHI specifies "Rectifier high voltage".
PWRMJ - RECTLO specifies "Rectifier low voltage".
PWRMN - RTACADSL specifies "AC or Rectifier Power Fail ADSL Eqpt".
RECT - RTACCRIT specifies "AC or Rectifier Power Fail Trans Eqpt".
RECTHI - RTACPWR specifies "AC or Rectifier Power Fail DCL Eqpt".
RECTLO - RTACPWRENG specifies "Comm AC Fail - Site e/w Stdby
RTACADSL Eng".
RTACCRIT - RTBAYPWR specifies "AC power Loss Distributed Power RT
RTACPWR Bay".
RTACPWRENG - RTRVENG specifies "Retrieve Stdby Eng - Com AC restored".
RTBAYPWR - SMOKE specifies "Smoke".
RTRVENG - TEMP specifies "High-Low Temperature".
SMOKE - TOXICGAS specifies "Toxic gas".
TEMP - TREPEATER specifies "T Repeater Shelf Major".
TOXICGAS - VENTN specifies "Ventilation system failure".
TREPEATER
VENTN

almmsg One to 40 alphanumeric characters. Is the text message associated with the environmental alarm
specified by the <env_aid> parameter.
Text string with a maximum of 40 characters and enclosed
within a pair of escaped quotes. If the alarm message was not
previously modified, then the default alarm message shown
below is displayed with its corresponding alarm message.
A null value in this parameter means there is no message text
for the specified environmental alarm.
Refer to section 2 for the applicable characters.

Example 1
RTRV-ATTR-ENV:CORIANT1:ENV-3:AM0662::,BATTERY;

Possible System Response

CORIANT1 14-07-04 16:07:47
M AM0662 COMPLD
"ENV-3:MJ,BATTERY:\"BATTERY FAILURE\""
;

76.MTFP50/30, Rev B January 2018 Page 30-939

22. Retrieve Commands TL1 Command Reference Manual

Example 2
RTRV-ATTR-ENV:CORIANT1:ALL:AM0662::;

Possible System Response

CORIANT1 14-02-12 16:07:47
M AM0662 COMPLD
"ENV-1:CR,FIRE:\"FIRE\""
"ENV-2:MJ,SMOKE:\"SMOKE\""
"ENV-3:MJ,BATTERY:\"BATTERY FAILURE\""
"ENV-4:NR,MISC:\"MISCELLANEOUS\""
"ENV-5:NR,MISC:\"MISCELLANEOUS\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

REPT^ALM^ENV
SET-ATTR-ENV
RTRV-ALM-ENV

Page 30-940 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-BER

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-BER command instructs the network element (NE) to retrieve the PRBS BER attributes of the specified
facility entity.

The facility types that PRBS BER can be supported are: FGE, HGE, OC3, OC12, OC48, OC192, OTU1, OTU2,
OTU4, ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, GBEP, TGLAN and OCH-P.

Restrictions
• For NULL, this command applies when the supporting module is a OSM-1S, OSM-2S, OSM-2C, SSM-
2S, OSM-4C, OSM-4F, SSM-2S, OSM-4S, OSM-5C.

• TMR (timer_duration) only accumulates when PRBS pattern is synchronized.

Command Format
RTRV-BER:[tid]:{<fac_aid>|<och_p_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"{<fac_type>|<och_p_aid>}::BERTYPE=<bertype>[,PRBSTX=<prbstx>][,PRBSRX=<prbsr
x>][,PRBSSYNC=<prbs_sync>][,PRBSRATE=<prbs_rate>][,TMR=<timer_duration>][,CALCBE
R=<calc_ber>][,ERRCOUNT=<error_count>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-941

22. Retrieve Commands TL1 Command Reference Manual

Table 22.11 RTRV-BER Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID--{PortID[-SupportingODU4
GBEP-20-[1-16]-[1-32] ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
TGLAN-20-[1-16]-[1-40]

bertype PRBS Indicates the type of BER that is generated:

NULL PRBS: PRBS on the line side or port side of a transponder.

prbstx ON Indicates whether PRBS in the transmit direction is ON or OFF.

OFF

prbsrx ON Indicates whether PRBS in the receive direction is ON or OFF.

OFF

Page 30-942 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.11 RTRV-BER Parameters (Continued)

Parameter Value(s) Definition
prbs_sync INSYNC Indicates whether PRBS pattern is synchronized since start of
OUTSYNC PRBSRX.
ERRSYNC - INSYNC indicates the PRBS pattern is synchronized.
NA - OUTSYNC indicates the PRBS pattern is not synchronized.
- ERRSYNC indicates that the PRBS pattern is synchronized,
but has lost synchronization and then regained synchronization
at some point since the PRBS in the Receive direction was
turned ON.
- NA indicates that PRBS in receive direction is OFF.

prbs_rate any integer Indicates the rate that PRBS is being transmitted. This number
is measured in Kbps.

timer_duration HH-MM-SS: (1) HH = 00 - 23 (2) MM = Indicates the amount of time since start of PRBSRX. Reset of
00 - 59 (3) SS = 00 - 59 PRBSRX will reset the timer.

calc_ber any integer above zero(exclusive) Indicates the calculated bit error rate (BER). Values for
CALCBER are restricted to integer values that represent the
closest negative power of 10. For example, a value of 5
indicates a BER of 10e-5.

error_count any integer Indicates the bit error count since the start of PRBSRX.

Example
RTRV-BER:CORIANT:OCH-P-20-12-1:AM0045;

Possible System Response

CORIANT 14-04-16 02:08:15
M AM0045 COMPLD
"OCH-P-20-12-1::BERTYPE=PRBS,PRBSTX=ON,PRBSRX=ON,PRBSRATE=2488320,PRBSSYNC=
INSYNC,TMR=00-01-45,CALCBER=5,ERRCOUNT=5"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
STA-BER
STP-BER

76.MTFP50/30, Rev B January 2018 Page 30-943

22. Retrieve Commands TL1 Command Reference Manual

RTRV-BKUPSCHED-MEM

Command Changes Since Previous Feature Package

• None.

Description
Use the RTRV-BKUPSCHED-MEM command to retrieve the current schedule for autonomous backups of the
Network Element's (NE) primary memory (NE database) to a remote server. Use the SCHED-BKUP-MEM
command to create or change the backup schedule.

The name of the remote server for the scheduled backup is specified in the SCHED-BKUP-MEM command. If no
scheduled backup exists, then the NE returns "ftp://:DBM_UNKNOWN_IP:0/" as value for remServerUrl.

Command Format
RTRV-BKUPSCHED-MEM:[tid]:[<backup_mem_aid>]:ctag::[<datatype>];

Proper System Response:

<header>

M <ctag> COMPLD
"<backup_mem_aid>,<datatype>:<remServerUrl>,<backupInvl>,<date>,<time>,<inhmode>
"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.12 RTRV-BKUPSCHED-MEM Parameters

Parameter Value(s) Definition
backup_mem_ SERVER EntityID
aid

datatype DB Specifies the type of backup memory that is the source.

- Enter DB to specify the NE database.

Page 30-944 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.12 RTRV-BKUPSCHED-MEM Parameters (Continued)

Parameter Value(s) Definition
remServerUrl ftp://userid:pwd@ftphost:[portid]/url- Specifies the remote server FTP URL:
path - <userid> is a valid user identification on the server (OS, EMS,
or other repository). Note
that the following characters are not allowed for <userid>: @ ? /
\{[()]}
- <pwd> is the corresponding password for the valid <userid> on
the server (OS, EMS, or other repository). Note that the
following characters are not allowed for <pwd>: @? / \ { [ ( ) ] }
The password is displayed as "*".
- <ftphost>[:<portid>] is a valid IP address and optional port
number to access the server.
Port number 21 can be used for non-secure FTP file transfer.
Port number 22 is the default value and can be used for secure
FTP (SFTP) file transfer.
- <url-path> specifies the device/drive/directory to put the
backup file. The file name does not need to be specified. The
NE automatically configures this name using the following
generic format:
NE_TID_FP_Date_Time.CURRENT and
NE_TID_FP_Date_Time.BACKUP for the first and second
backup then the process overwrite the previously saved files.

backupInvl x-y format:(1)x can equal a range of: Specifies the time interval between scheduled memory backups
2-24 (hours), 120-1440 (minutes), 1- (see also date and time).
31 (days). (2)y can equal: HR, MIN, or Examples:
DAY - 12-HR: Specifies a backup interval of every 12 hours.
- 750-MIN: Specifies a backup interval of every 12-1/2 hours.
- 3-DAY: Specifies a backup interval of every 3rd day.

date MOY-DOM format:(1)MOY = 1 - Specifies the date of the first scheduled backup:
12.(2)DOM = 1 - 31. - MOY identifies the month of the year.
- DOM identifies the day of the month.

time Enter HOD-MOH format:(1)HOD = 0 - Specifies the time of day of the first scheduled backup:
23 (2)MOH = 0 - 59 - HOD identifies the hour of the day.
- MOH identifies the minute of the hour.

inhmode ALW Indicates if a backup schedule is allowed or inhibited:

INH - ALW indicates it is allowed.
- INH indicates it is inhibited.

Example
The following example retrieves the backup schedule for all of the data bundles in secondary nonvolatile backup
memory:

RTRV-BKUPSCHED-MEM:CORIANT1:SERVER:CTG01::;

Possible System Response

CORIANT1 02-02-02 03:20:21

M CTG01 COMPLD

"SERVER,DB:\"ftp://user1:*@172.112.21.4:21/dir2/\",07-DAY,10-12,00-00,ALW"
;

76.MTFP50/30, Rev B January 2018 Page 30-945

22. Retrieve Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-BKUPSCHED-MEM
INH-BKUPSCHED-MEM
SCHED-BKUP-MEM

Page 30-946 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-BL

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-BL command instructs the network element (NE) to retrieve a bundled link.

Restrictions
• LATENCY only displayed when LATENCYMODE is MANUAL.

Command Format
RTRV-BL:[tid]:{<bl_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<bl_aid>::BLNAME=<BLName>,BLTYPE=<BLType>,COST=<Cost>,IFINDEX=<Ifindex>[,NIF
INDEX=<NeighborIfIndex>],ROUTING=<routing>[,SRLG=<Srlg>],LATENCYMODE=<LatencyMod
e>[,LATENCY=<Latency>][,RESCLASS=<ResourceClass>]:<pst>,[<sst>]";

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.13 RTRV-BL Parameters

Parameter Value(s) Definition
bl_aid BL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-BLID

BLName A double quoted string consisting of 0 Specifies the Bundled Link name.
to 30 printable characters, not
including the quotes.

BLType PROT Specifies the Bundled Link type.

SYMPROT - PROT is for an E-NNI interface.
- SYMPROT is for a NULL link on ODUk/OTUk facility.
There is no default value.

Cost [1-4294967295] Specifies the cost for the link.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

Srlg A double quoted input string of up to Specifies the Shared Risk Link Groups associated with this BL.
32 comma separated 4 byte hex
strings. Example:
"3E04990A,044D1A0C"

76.MTFP50/30, Rev B January 2018 Page 30-947

22. Retrieve Commands TL1 Command Reference Manual

Table 22.13 RTRV-BL Parameters (Continued)

Parameter Value(s) Definition
LatencyMode MANUAL Specifies the latency mode for this BL.
DISABLED MANUAL - the latency value is manually provisioned.
DISABLED - the latency parameter is not populated.

Latency [1-65535] Specifies the latency accross this BL in Micro-Second.

ResourceClas A double quoted 4 byte hex strings. 32-bit long bit-mapped field with each bit representing a specific
s resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
"" and "00000000" are used to reset the RESCLASS value back
to default "".

Example bit-mapped resource class definitions:

"00000000" - None, used to reset to the default value ""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

pst IS-NR Indicates the primary state and primary state qualifier of a BL.
IS-ANR
OOS-AU Possible values for PST:
OOS-MA - IS: In-Service
OOS-MAANR - OOS: Out-of-Service
Possible values for PSTQ:
- ANR: Abnormal
- AU: Autonomous
- NR: Normal
- MA: Management

sst INCOMP Indicates the secondary state of a BL.

SDEA
FAF Possible value for SST:
-INCOMP: indicates that the bundled link is missing TL member.
-SDEA: indicates one TL member of a BL is operational out-of-
service, another TL member is operational in-service.
-FAF: indicates both TL members of a BL are operational out-of-
service.

IfIndex [0-255].[0-255].[0-255].[0-255] Specifies the If Index for this BL. This value is created by the
NE.

Routing PASSIVE Specifies the state of Routing.

DISABLED PASSIVE - This link is advertised, routing messages are not
transported over this link.
DISABLED - This link is not advertised, routing messages are
not transported over this link.

Example
RTRV-BL::BL-3-1-1:AM0011;

Page 30-948 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^"BL-3-1-
1::BLNAME=\"BL1\",BLTYPE=PROT,COST=100,IFINDEX=10.1.1.2,NIFINDEX=8.22.321.22,ROU
TING=PASSIVE,SRLG=\"3E04990A,044D1A0C\",LATENCYMODE=MANUAL,RESCLASS=\"3E04990A\"
:IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-BL
ENT-BL
DLT-BL

76.MTFP50/30, Rev B January 2018 Page 30-949

22. Retrieve Commands TL1 Command Reference Manual

RTRV-BL-MEMBER

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-BL-MEMBER command instructs the network element (NE) to retrieve the membership of a specified
bundled link. Some detailed information of TL members is displayed for brief debugging purpose. For further
information of TL member, debug via RTRV-TL.

Restriction and Exceptions

• RAID only applies to TL members of a PROT type BL.

Command Format
RTRV-BL-MEMBER:[tid]:{<bl_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<bl_aid>::MEMLIST=<Member>"

For each member:

^^^"<TL_aid>::NIFINDEX=<NeighborIfIndex>,NNID=<NeighborNodeId>,NSIGADDR=<Neighbo
rSignalingAddr>,NSIGID=<NeighborSignalingId>,NDISCOVERY=<NeighborDiscovery>,LINK
PF=<LinkpfAID>[,RAID=<RouterAreaId>]:<pst>,[<sst>]"+
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.14 RTRV-BL-MEMBER Parameters

Parameter Value(s) Definition
bl_aid BL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-BLID

Member A list of up to 2 TLs. Link members are Specifies the link members to be added/removed to the BL.
separated by a symbol "&", a link This parameter uses the grouping operator "&" for multiple link
member is specified by the AID of TL. members.

for example, MEMLIST=TL-3-2-1&TL-3-2-5

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index. If this value is not specified the
x 0.0.0.0 is not a valid input value. NE may learn this value.

NeighborNode [0-255].[0-255].[0-255].[0-255] or Specifies the neighbors node ID. If this value is not specified the
Id NULL NE may learn this value.

NeighborSigna [0-255].[0-255].[0-255].[0-255] or Specifies the neighbors signaling address.

lingAddr NULL

NeighborSigna [0-255].[0-255].[0-255].[0-255] or Specifies the neighbors signaling ID.

lingId NULL

Page 30-950 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.14 RTRV-BL-MEMBER Parameters (Continued)

Parameter Value(s) Definition
NeighborDisco ENABLED Specifies whether or not neighbor discovery is used to learn the
very DISABLED neighbor parameters.

LinkpfAID LINKPF-[91-99,1-20] Specifies the access identifier of the Link Profile.

RouterAreaId [0-255].[0-255].[0-255].[0-255] The router area ID specifies an area that common to both link
ends.

pst IS-NR Indicates the primary state and primary state qualifier of a
OOS-AU module.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous management

sst INPROG Indicates the secondary state:

FAF - INPROG: In Progress - Entity is in the process of being
SDEA established.
DISC - FAF: Facility Failure - The associated transport facility has
DISC_FAIL failed.
INCOMP - SDEA: supported entity absent.
- DISC: The neighbor discovery is in progress.
- DISC_FAIL: The neighbor discovery is failed.

Example
RTRV-BL-MEMBER::BL-3-2-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^"BL-3-2-1::MEMLIST=TL-3-2-1&TL-3-2-5"
^^^"TL-3-2-
1::NIFINDEX=0.132.160.0,NNID=21.3.110.5,NSIGADDR=10.3.110.1,NSIGID=20.3.0.110,LI
NKPF=LINKPF-3,NDISCOVERY=DISABLED,LINKPF=LINKPF-2,RAID=0.0.2.33:OOS-AU,FAF"
^^^"TL-3-2-
4::NIFINDEX=0.132.180.0,NNID=21.3.110.5,NSIGADDR=10.3.110.1,NSIGID=20.3.0.110,LI
NKPF=LINKPF-3,NDISCOVERY=DISABLED,LINKPF=LINKPF-2,RAID=0.0.2.33:OOS-AU,FAF"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-BL
ENT-BL
DLT-BL
RTRV-BL
ED-BL-MEMBER

76.MTFP50/30, Rev B January 2018 Page 30-951

22. Retrieve Commands TL1 Command Reference Manual

RTRV-CALL

Command Changes Since Previous Feature Package

• Support Callname up to 100 characters

Description
The RTRV-CALL command instructs the NE Control Plane to retrieve an end-to-end path between network
elements. This command is only relevant for the NE serving as domain boundaries.

Call_aid is an optional input, it would operate with a default value of ALL when it was left blank.
CP_INGRSS&CP_EGRSS are retrieve only parameters for MT=1 call.

When no value populated for the INGRSS/EGRSS/CP_INGRSS/CP_EGRSS parameter, it is displayed as "". Here
are some call retrieving examples:
• If none for INGRSS and EGRSS for MT=1 call is provided, INGRSS, EGRSS will display as "";

• If "Ifindex-Label" for EGRSS is provided, CP_EGRSS will equal to EGRSS at origination node;

• If "Ifindex-Label" for the INGRSS is provided, CP_INGRSS is always equal to INGRSS at the origination
node;

• If none for INGRSS is provided, INGRSS will display as "" and CP_INGRSS will display as the CP
picked labeled;

• When call origination node, intermediate node, destination node locates on different NEs, if "Ifindex-
Label" for EGRSS at origination node is provided, CP_EGRSS is same (equal to EGRSS) along the
path for different node locations;

• When call origination node, intermediate node, destination node locates on different NEs, if none for
EGRSS at origination node is provided. The destination node will display CP picked label for
CP_EGRSS at this NE. The origination node and intermediate nodes will also display CP_EGRSS as
the CP picked label at destination node.

CP_EGRSS or egress interface inside a label set (AUTO or MAN label set when SET_EGRSS=N) can be set to
IfIndex without labels when only IfIndex for egress interface at call creation stage is provided.

The filter of PRPUSE will get all calls associated with the preferred restoration path regardless of the connection
path (working or protect) or the preference order (1 or 2). The PRPUSE does not be part of the output, but the
preferred restoration path info can be found in WKGPRP1, WKGPRP2, PROTPRP1 and/or PROTPRP2.

Figure 22.1 Call end-points

NE NE NE

Call Call
end-point end-point

The call state is determined by the state of the LOCAL connection of the call. If the call traverses multiple nodes at
the same NE and there are multiple LOCAL connections, the call state follows the rules below:
- If any node is ORIG, DEST, DINGRESS or DEGRESS, the call state is determined by the state of LOCAL
connection on that node.

Page 30-952 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

- If no node is ORIG, DEST, DINGRESS or DEGRESS, the call state is determined by the state of LOCAL on the
first node that the call traverses through this NE.
- If both DINGRESS and DEGRESS are on the same NE, the call state is determined by the state of LOCAL
connection on DINGRESS node.
- If both ORIG and DEST are on the same NE, the call state is determined by the state of the LOCAL connection
on ORIG node.

AEND2,ZEND2,NODEID2,INGRSS2,EGRSS2,CP_INGRSS2 and CP_EGRSS2 are parameters to describe the

second path of the 2-port call. On the primary source node of a 2-port call, AEND, ZEND,NODE, INGRSS, EGRSS,
CP_INGRSS and CP_EGRSS is displayed for the first path; AEND2, ZEND2, NODEID2, INGRSS2, EGRSS2,
CP_INGRSS2 and CP_EGRSS2 is displayed for the second path. On the intermediate node of a 2-port call, AEND,
ZEND, NODE, INGRSS, EGRSS, CP_INGRSS and CP_EGRSS is displayed for the path which passes through the
node, whether it is the first path or second path; CP_INGRSS2 is displayed independently for the case when 2
connections traverse a single intermediate node. On the terminal node, the displayed parameters is the same as
the intermediate node, unless both paths share the same termination NE.

Restrictions and Exceptions

• All filtering parameters are not allowed when a specific call_aid is specified.

• String parameters must be used in quotes.

• If no parameters are specified, all calls supported by the NE is retrieved.

• For unprotected service, PROTPATH does not be displayed on response.

• LABELSET is not supported by OTN CP Call.

• LABELSET is not supported by 2-port Call.

• CP_INGRSS, CP_EGRSS are retrieve only parameters for MT=1 call.

• INGRSS2, EGRSS2, CP_INGRSS2 and CP_EGRSS2 only apply to 2-port call.

• Compound value for CALLLOC cannot include UNKNOWN.

• When a BL(s) is referenced in a call, only ifindex is displayed because labels are not applicable to BLs.

• The EXPRATE, GFPTS parameters only apply to ODUF_CBR,ODUF_GFP call.

• WKGXPATH/PROTXPATH only applies when the call has referenced it.

• PROTXPATH only applies when the call is a protected call (e.g 1+1 or FT call).

Command Format
RTRV-
CALL:[tid]:[{<call_aid>|ALL}]:ctag:::[CALLID=<CallId>][,AEND=<A_EndPoint>][,ZEND
=<Z_EndPoint>][,INGRSS=<Interface>][,EGRSS=<Interface>][,AEND2=<A_EndPoint>][,ZE
ND2=<Z_EndPoint>][,INGRSS2=<Interface>][,EGRSS2=<Interface>][,SLPF=<Slpf>][,PRPU
SE=<expp_aid>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<call_aid>::CALLID=<CallId>,CALLNAME=<Callname>,AEND=<A_EndPoint>,ZEND=<Z_En
dPoint>,NODE=<node_aid>[,AEND2=<A_EndPoint>,ZEND2=<Z_EndPoint>,NODEID2=<node_id>
],SIGTYPE=<SignalType>,MULTIPLIER=<MultiplierValue>,DIRECT=<Directionality>,INGR
SS=<Interface>,EGRSS=<Interface>[,CP_INGRSS=<Interface>][,CP_EGRSS=<Interface>][

76.MTFP50/30, Rev B January 2018 Page 30-953

22. Retrieve Commands TL1 Command Reference Manual

,INGRSS2=<Interface>][,EGRSS2=<Interface>][,CP_INGRSS2=<Interface>][,CP_EGRSS2=<
Interface>][,LABELSET=<Labelset_aid>],SRLG=<Srlg>[,TIMEOUT=<Timeout>],SLPF=<Slpf
>,PROTLVL=<ProtectionLevel>,PRIO=<priority>,CALLLOC=<CallLocation>[,WKGPRP1=<exp
p_aid>][,WKGPRP2=<expp_aid>][,PROTPRP1=<expp_aid>][,PROTPRP2=<expp_aid>][,WKGXPA
TH=<exdp_aid>][,PROTXPATH=<exdp_aid>]{,EXPRATE=<ExpClientRate>|GFPTS=<nmbrOfTS_G
FPclient>}:<pst>[,<sst>]"<cr><lf>
;

Table 22.15 Label releated Parameters Applicability for CP Call

SONET/SDH CP Call OTN CP Call
PARAMETER
MT=1 MT>1 MT=1 MT>11

INGRSS X X2 X
2
EGRSS X X X
3 n/a
CP_INGRSS X X

CP_EGRSS3 X X

LABELSET X X

INGRSS2 X X

EGRSS2 X X

CP_INGRSS2 X X

CP_EGRSS2 X X

1. OTN CP MT>1 Call: Not supported.

2.Only display “IfIndex” (If IfIndex of ingress and/or egress for an MT>1 call is provided).
3. CP_INGRSS, CP_EGRSS are retrieve only parameters for MT=1 call.
4. INGRSS2, EGRSS2, CP_INGRSS2 and CP_EGRSS2 only apply to 2-port call.
5. CP_INGRSS2 and CP_EGRSS2 are retrieve-only parameters for MT=1 2-port call.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.16 RTRV-CALL Parameters

Parameter Value(s) Definition
call_aid CALL-[1,3]-[1-4294967295] EntityID-NPID-CallNum

CallId Up to a 55 character string in the This parameter represents the call to be retrieved.
following format: [CNTRY-CAR-AP-
]TYPE-ADDRESS-ID. (1)CNTRY - Examples:
country code (3 alphabetic characters) Global format -
(2)CAR - carrier code (1 to 6 "USA-CAR1-ATT01E-IPV4-192.168.1.1-1895B"
alphanumeric characters. The first Carrier specific format -
character must be alphabetic) (3)AP - "IPV4-192.168.1.1-1895B"
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

Page 30-954 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.16 RTRV-CALL Parameters (Continued)

Parameter Value(s) Definition
A_EndPoint Enter type-xxx.xxx.xxx.xxx format: (1) The EndPoint is a TNA and will follow TNA rules.
type is one of the following: IPV4 In the model this would be AEND/ZEND/AEND2/ZEND2.
(2)xxx = 0-255 AEND2 and ZEND2 are used to specify the second pair of
Endpoints of a 2-port call.

Z_EndPoint Enter type-xxx.xxx.xxx.xxx format: (1) The EndPoint is a TNA and will follow TNA rules.
type is one of the following: IPV4 In the model this would be AEND/ZEND/AEND2/ZEND2.
(2)xxx = 0-255 AEND2 and ZEND2 are used to specify the second pair of
Endpoints of a 2-port call.

Interface A double quoted item sequence for the This parameter specifies the interface being retrieved for the
interfaces. Each item of interfaces is in specified call.
form of IfIndex[-Label] format:
(1)IfIndex is 8 hexadecimal digits. Example: "110ABB11-00040000"
(2)Label is 8 hexadecimal digits for
non ODUk labels or G.709 V2 ODUk
labels; Label is a multiple of 8
hexadecimal digits for G.709 V3
ODUk/j/flex labels.

Slpf SLPF-[99,1-20], Service level profile to be configured by the customer.

NONE

expp_aid EXPPATH-[1,3]-[1-512] Indicates the access identifier of the explicit path being referred
to for a Preferred Restoration Path.

Callname A double quoted string consisting of 0 Specifies the call name.

to 100 printable characters, not
including the quotes. Refer to section 2 for the applicable characters.

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier

node_id [0-255].[0-255].[0-255].[0-255] Specifies the node id.

The parameter NODEID2 is used to specify the second source
node of a 2-port call.

SignalType ODU0 The connection type of the call.

ODU1
ODU2
ODU2e
ODU3
ODU4
ODUF_CBR
ODUF_GFP
OTU2
OTU2e
OTU4
STS1
STS3C
STS12C
STS48C
STS192C

MultiplierValue [1-32] This value is used to indicate the number of channels of

SignalType used in the call.

Note only MultiplierValue=1 supported for both SONET/SDH

services.

76.MTFP50/30, Rev B January 2018 Page 30-955

22. Retrieve Commands TL1 Command Reference Manual

Table 22.16 RTRV-CALL Parameters (Continued)

Parameter Value(s) Definition
Directionality BI This parameter specifies the direction of traffic flow.
Unidirectional does not be supported until a later release

Labelset_aid LABELSET-3-[d] This parameter specifies the access identifier of the label set
being referenced by a call.
Note: LABELSET is not supported by OTN CP Call.

Srlg A double quoted input string of up to Specifies that Shared Risk Link Groups is avoided.
32 comma separated 4 byte hex The Hex string is a group of 4 hex byte strings representing the
strings. SRLGs to avoid.

Example: "3E04990A,044D1A0C"

Timeout [120-900] The maximum number of seconds that the end-to-end call is to
be established within.

ProtectionLeve 1P1TWOSTRIKES Protection levels:

l UNPROTECT 1P1TWOSTRIKES - service is protected but is interrupted when
REROUTE both the working and protect paths have failed
FULLTIME UNPROTECT - no protection is requested
2PORT REROUTE - service is unprotected but attempts to be rerouted
2PORTREROUTE when the path fails
DONOTOVERRIDE FULLTIME - service is 1+1 protected and attempts to reroute
the broken leg while service is ongoing
2PORT - two unprotected paths is created but the paths does
not be rerouted when failure occurs.
2PORTREROUTE - two unprotected paths is created and the
paths is rerouted when failure occurs.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

priority [0-7] This parameter indicates the restoration priority of the given call
instance. It is populated from SLPF or by Path message during
call setup.
0 is the highest priority.

CallLocation ORIG ORIG - origination node of call(s)

DEST DEST- termination node of call(s)
DINGRSS DINGRSS - domain ingress node of call(s)
DEGRSS DEGRSS - domain egress node of call(s)
INT INT - intermediate node of call(s)
UNKNOWN UNKNOWN - unknown

Possible compound value e.g:

- DINGRSS&DEGRSS
- ORIG&INT&DEST
- DINGRSS&DEST
- ORIG&DEGRSS

Note: Compound values can not include UNKNOWN.

exdp_aid EXDPATH-[1,3]-[1-512] Specifies the access identifier of the excluded path being
refered for a call.

Page 30-956 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.16 RTRV-CALL Parameters (Continued)

Parameter Value(s) Definition
ExpClientRate A fixed integer value between Specifies the expected signal rate of the constant bit rate
2488022 and 103688578. mapped client within the payload of the ODUflex.

This value is used by the system to determine the

ODUflex(CBR) "Bit Rate" in the RSVP signaling object. For a
terminated ODUF, the expected client rate is the same as the
Expected Rate of the GOPT facility that is mapped into the
ODUF. The number is specified in Kbps.
A fixed integer value between 2488022 and 9952261 when the
ODUF is supported by an OSM-2S.
A fixed integer value between 2488022 to 103688578 when the
ODUF is supported by an OSM-2C.

nmbrOfTS_GF [1-80] Specify the ODUflex(GFP) rate by entering the number of 1.25G
Pclient Tributary Slots when the ODUflex supports a GFP client.

This value is used by CP to determine the ODUflex(GFP) "Bit

Rate" in the RSVP signaling object.

The supported ODUflex(GFP) rate is GFPTS x 1,249,177.230

kbit/s when GFPTS = 1 to 8, GFPTS x 1,254,470.354 kbit/s
when GFPTS = 9 to 32, or GFPTS x 1,301,467.133 kbit/s when
GFPTS = 33 to 80.

pst IS-NR Indicates the primary state of the call.

IS-ANR
OOS-AU Possible primary states include:
- In-Service, normal (IS-NR)
- In-Service, abnormal (IS-ANR)
- Out-of-Service, autonomous (OOS-AU)

sst CPFAULTED Indicates the secondary state of the call.

FROZEN Possible secondary states include:
LASTEFFORT - Control Plane signaling associated with the call has failed
LASTRVTFAIL (CPFAULTED)
NRDYRVT - The call is frozen (FROZEN)
PATHDN - The call is restored on a "last effort" connection
PATHERR (LASTEFFORT)
PENDING - A call secondary state to indicate the previous reverted
RDYRVT nominal path of the call received a reroute request
RVTCD (LASTRVTFAIL)
UNPROTECTED - A call secondary state to indicate that any connection path of
the call is not ready for reversion (NRDYRVT)
- A call secondary state to indicate that there is a loss of traffic in
data plane (PATHDN)
- A call secondary state to indicate that there is a link fault
detected by the control plane (PATHERR)
- The call is pending due to a call request or due to recovery
after a system restart (PENDING)
- A call secondary state to indicate that the nominal path of the
call is ready for reversion in manual CP reversion mode
(RDYRVT)
- A call secondary state to indicate that CP wait-torestore timer
is started but not expired for the nominal path of the call in auto
CP reversion mode (RVTCD)
- For a protected call, either 1+1 or FULLTIME, there is traffic
loss in one of the legs in data plane (UNPROTECTED)

76.MTFP50/30, Rev B January 2018 Page 30-957

22. Retrieve Commands TL1 Command Reference Manual

Example
The following example retrieves an ODU0 call over ODU4 link:

RTRV-CALL:CORIANT1::AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
"CALL-3-10::CALLID=\"IPV4-1.1.1.1-A1B2C3D4\",CALLNAME=\"\",AEND=IPV4-
111.111.111.111,ZEND=IPV4-222.222.222.222,NODE=NODE-3-
1,SIGTYPE=ODU0,MULTIPLIER=1,DIRECT=BI,INGRSS=\"110ABB22-
00200050ff0000000000000000000000\",EGRSS=\"110ABB11-
00200050ff0000000000000000000000\",CP_INGRSS=\"\",CP_EGRSS=\"\",SRLG=\"\",TIMEOU
T=120,SLPF=SLPF-1,PROTLVL=FULLTIME,PRIO=4,CALLLOC=DINGRSS,WKGPRP1=EXPPATH-3-
1,PROTPRP1=EXPPATH-3-2:IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CALL
ENT-CALL
RTRV-CONN

Page 30-958 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-CALL-DETAIL

Command Changes Since Previous Feature Package

• None.

Description
RTRV-CALL-DETAIL retrieves the related CTP resources of a given call within a network element. The command
represents all local CTPs information that made up the call.

Restrictions and Exceptions

• The CTP information of different connections per multiple nodes on a given NE is displayed on different
lines.

• The CTP infomation of different CONNMODE is displayed on different lines.

• The CTP information of different CONNPATH is displayed on different lines.

• The RESOURCES of a local connection mode is displayed as empty string (that is, "").

• The CALLID and CTPAID in the filtering field is mutually exclusive.

• At least one of the two parameters (CALLID or CTPAID) has to be given on the command line.

• The command is denied if the specified CTPAID is not associated with a call or not owned by CP.

• The command is denied if the specified CALLID is invalid.

Command Format
RTRV-CALL-DETAIL:[tid]::ctag:::[CALLID=<CallId>][,CTPAID=<fac_type>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<call_aid>::CALLID=<CallId>,NODE=<node_aid>,MULTIPLE=<MultiplierValue>"<cr><
lf>

"CONNID=<ConnId>,NODE=<node_aid>,CONNMODE=<ConnMode>,CONNPATH=<ConnPath>,RESOURC
ES=<resources>"<cr><lf>+;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-959

22. Retrieve Commands TL1 Command Reference Manual

Table 22.17 RTRV-CALL-DETAIL Parameters

Parameter Value(s) Definition
CallId Up to a 55 character string in the This parameter represents the call to be retrieved.
following format: [CNTRY-CAR-AP-
]TYPE-ADDRESS-ID. (1)CNTRY - Examples:
country code (3 alphabetic characters) Global format - "USA-CAR1-ATT01E-IPV4-192.168.1.1-1895B"
(2)CAR - carrier code (1 to 6 Carrier specific format - "IPV4-192.168.1.1-1895B"
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

fac_type All CP supported CTP facility aid can The facility AID specified here intends to find the association
be the optional value in this field. Here between the CTP and the associated call/connection.
are the CP supported CTP types:
ODU0, ODU1, ODU2, ODU2E, ODU4,
ODUF, OCH, OCH-P, OCH-L, STS1,
STS3C, STS12C, STS48C, STS192C,
TTPSTS1, TTPSTS3C

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier

MultiplierValue [1-32] This value is used to indicate the number of channels of

SignalType used in the call.

Note only MultiplierValue=1 supported for OTN services.

ConnId A double quoted string in the form of: Specifies the connection ID for the connection.
32 bit destination ID-
32 bit extendedTunnelID- Destination_ID: This ID indicates the destination NE, matching
16 bit tunnelID- the value found in the SESSION object of the RSVP PATH
32 bit source ID- message. For ENNIv1, ENNIv2 and INNIv1 this is the SC PC ID
16 bit lspID of the immediate downstream NE. For INNIv2, this is the
ingress NE of the domain.

ExtendedTunnelID: A 32-bit identifier used in the SESSION

objects to scope the TunnelID.

TunnelID: A 16-bit identifier used in the SESSION objects to

identify a reservation session. When the connection is signaled
with SHARED_EXPLICIT, connections with the same
Destination, ExtendedTunnelID and TunnelID is allowed to
share dataplane resources.

Source SC_PC_ID: This ID indicates the signaling controller of

source NE, matching the value found in the
SENDER_TEMPLATE object of the RSVP PATH message.

LSP_ID: A 16-bit identifier used in the SENDER_TEMPLATE

that allows a sender to distinquish different connections that
share resources.

ConnMode INCOMING Indicates the connection mode.

LOCAL
OUTGOING

Page 30-960 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.17 RTRV-CALL-DETAIL Parameters (Continued)

Parameter Value(s) Definition
ConnPath NOM_WKG Specifies the connection path.
NOM_PROT NOM_WKG - nominal working
CURR_WKG NOM_PROT - nominal protect
CURR_PROT CURR_WKG - current working
CURR_PROT - current protect

Only CURR_WKG indicates the "Last Effort" connection path at

the repair node where the "last effort" connection has been
established.

resources The resource facility AID or related This parameter specifies the facility AIDs for a given call.
IfName of the connection. Resources must be enclosed in double quotes.
Multiple facility AIDs are connected by comma in this field.

Example
The following example retrieves an ODU2 AID and associated call and connection:

RTRV-CALL-DETAIL:::AM0011:::CTPAID=ODU2-2-1-1;

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
""CALL-3-10::CALLID=\"IPV4-21.3.243.14-12\",NODE=NODE-3-2,MULTIPLE=1"
"CONNID=\"140300c3-140300c3-11-140300c3-1\",NODE=NODE-3-
2,CONNMODE=INCOMING,CONNPATH=NOM_WKG,RESOURCES=\"ODU2-2-1-1,OTU2-2-1-1\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-CALL
RTRV-CONN
RTRV-CONN-INFO

76.MTFP50/30, Rev B January 2018 Page 30-961

22. Retrieve Commands TL1 Command Reference Manual

RTRV-CEF

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-CEF command instructs the network element (NE) to retrieve the current version of the specified
Capability Extension File type.

Restrictions and Exceptions

Command Format
RTRV-CEF:[tid]::ctag:::[TYPE=<cef_type>];

Proper System Response

<header>
M^^<ctag>^COMPLD
^^^"<cef_type>::VERSION=<current_cef_ver>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.18 RTRV-CEF Parameters

Parameter Value(s) Definition
cef_type PLUGTF Indicates the type of capability extension file.
ALL - PLUGTF = Pluggable Transceiver File
- ALL (default) = Returns a list of all CEFs supported within the
NE.

current_cef_ve One to 3 alphanumeric characters. Indicates the version of the particular CEF of the specified CEF
r type that is currently running on this particular NE.
Following the format V<n>, where <n> is an integer value from 1
to 99.

Example
RTRV-CEF:::ctag;

Possible System Response

^^^CORIANT1^02-02-02^03:20:21
M^^ctag^COMPLD
^^^"PLUGTF::VERSION=V1
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-962 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Related Commands
INSTALL-CEF

76.MTFP50/30, Rev B January 2018 Page 30-963

22. Retrieve Commands TL1 Command Reference Manual

RTRV-COND-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-COND-{X} command instructs the network element to return the current alarm and standing conditions
associated with the selected equipment or facility entity.

Upon a RTRV-COND TL1 input command, the NE will report standing conditions on the system that are being locally
suppressed by the following conditions but with NR (Not-Reported) as a notification code, instead of the actual
profile value:

a) Suppression by ARC.

b) Suppression by a maintenance command (ED).

{X} specifies the equipment type or facility type among the following:

• Equipment: EQPT: See the Parameter section for supported equipment AIDs.

• SLOT (eqpt_aid must be SLOT)

• Facilities (fac_type): ETH, FGE, GBEP, HGE, MGTETH ,OC3, OC12, OC48, OC192, OCH (for OCH,
OCH-L, OCH-P, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OMS, OSC, OTS,
OTU1, OTU2, OTU4, OTUC2, STS1, STS3C, STS12C, STS48C, STS192C, TTPSTS1, TTPSTS3C,
VCG, TGLAN.

• Logical (logic_type): DB, NTPPEER, SW, SECU, RSVPADJ, GCC, TL.

Restrictions and Exceptions

• The Equipment/Facility AID must always correspond to the Equipment/Facility type.

• The entity AID is optional only if the command's second modifier is "ALL".

Command Format
RTRV-COND-
{EQPT|SLOT|<fac_type>|<logic_type>|ALL}:[tid]:[{<eqpt_aid>|<fac_aid>|<logic_aid>
|ALL}]:ctag::[<condtype>],[<locn>],[<dirn>],;

Proper System Response

There is no alarm condition to report:
<header>

M^^<ctag>^COMPLD<cr><lf>;

There is at least one alarm condition to report:

<header>

Page 30-964 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

M^^<ctag>^COMPLD<cr><lf>
^^^"[<aid>][,<aidtype>]:[<ntfcncde>],<condtype>,[<srveff>],[<ocrdat>],[<ocrtm>],
[<locn>],[<dirn>][,<tmper>],<conddescr>";

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.19 RTRV-COND-{X} Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CDCP-20-[10-16,1-7]-[1-3]
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
FAN-20-[29-32]
FAN8-20-[16,17]
FSM-20-[35,34]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OMD-20-[1-16]-[1-2]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SIOM-20-15
SLOT-20-[1-35]-[1-32], SLOT-[50-58]-
[1-8]
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

76.MTFP50/30, Rev B January 2018 Page 30-965

22. Retrieve Commands TL1 Command Reference Manual

Table 22.19 RTRV-COND-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
FGE-20-[1-16]-[1-2]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
MGTETH-20-[13,14,21,24,25,28]-[1-8]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTS-20-[10-16,1-7]-21,OTS-20-[1-
16]-1

Page 30-966 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.19 RTRV-COND-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) OTU1-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
T1-20-[15,23,26]-[1,2]
TGLAN-20-[1-16]-[1-40]
VCG-20-[1-16]-[1-32]

logic_aid DB-1 EntityID-DBID

GCC0-20-[1-16]-[1-32]
GCC1-20-[1-16]-[1-20], GCC1-20-[1-
16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC1-20-[1-
16]-[1-2]-[D][1-3]-[B,C][1-80]-
[A,B,E,Z,F][1-32], GCC1-20-[1-16]-[1-
2]-[D][1-3]-[A,B,C,E,Z,F][1-80]
GCC12-20-[1-16]-[1-20], GCC12-20-
[1-16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-
32], GCC12-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC12-20-[1-
16]-[1-2]-[D][1-3]-[B,C][1-80]-
[A,B,E,Z,F][1-32], GCC12-20-[1-16]-
[1-2]-[D][1-3]-[A,B,C,E,Z,F][1-80]
GCC2-20-[1-16]-[1-20], GCC2-20-[1-
16]-[1-4]-[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC2-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80], GCC2-20-[1-
16]-[1-2]-[D][1-3]-[B,C][1-80]-
[A,B,E,Z,F][1-32], GCC2-20-[1-16]-[1-
2]-[D][1-3]-[A,B,C,E,Z,F][1-80]
NTPPEER-[2,1]
PPPL-[20]-[1-16]-[1-30], PPPL-[20]-[1-
16]-99-[1-30]
PPPMS-[20]-[1-16]-[1-30], PPPMS-
[20]-[1-16]-99-[1-30]
PPPRS-[20]-[1-16]-[1-30], PPPRS-
[20]-[1-16]-99-[1-30]
PPPS-[20]-[1-16]-[1-30], PPPS-[20]-
[1-16]-99-[1-30]
RSVPADJ-[1,3]-1-[1-40]
SECU
SW-1
TL-[1,3]-[1-512]-[1-1500]

76.MTFP50/30, Rev B January 2018 Page 30-967

22. Retrieve Commands TL1 Command Reference Manual

Table 22.19 RTRV-COND-{X} Parameters (Continued)

Parameter Value(s) Definition
condtype Refer to Alarm and Condition Tables Identifies the current standing conditions which cause alarms
for the possible values of Condition and/or events.
Types.

locn NEND Indicates if the alarm or event location is near end or far end.
FEND - NEND: Near End (Condition, alarm, or event occurred at the
near end of the system.)
- FEND: Far End (Condition, Alarm, or event occurred at the far
end of the system.)

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies both applicable directions: one type of TDTC
TDTN and one type of TDTN.
RCV - TDTC specifies Transmit direction toward Customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.
- NA indicates Not Applicable (valid in the response only).

aidtype EQPT This is the type of the Access Identifier.

ETH
DB
FGE
GBEP
HGE
NTPPEER
OC3
OC12
OC48
OC192
OCH
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
OTU1
OTU2
OTU4
OTUC2
OMS
OSC
OTS
GCC
ROUTER
RSVPADJ
SECU
SW
TGLAN
TL

ntfcncde CR Indicates the notification code (severity level) associated with

MJ the condition type. The codes include: critical, major, minor, not
MN alarmed and not reported.
NA
NR

Page 30-968 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.19 RTRV-COND-{X} Parameters (Continued)

Parameter Value(s) Definition
srveff NSA Indicates if an alarm is service affecting or nonservice affecting:
SA NSA indicates non-service affecting.
SA indicates service affecting.

ocrdat MOY-DOM format:(1)MOY = 1 - Indicates the occurrence date of the alarm by the month of the
12.(2)DOM = 1 - 31. year and the day of the month.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Indicates the occurrence time of the alarm by the hour of the
00 - 59 (3) SS = 00 - 59 day, the minute of the hour, and the second of the minute.

tmper 15-MIN Indicates the time-period increments during which PM data is

1-DAY collected.
Enter 15-MIN to specify 15-minute increments.
Enter 1-DAY to specify daily increments.

conddescr Refer to Alarm and Condition Tables Describes the condition that caused the alarm. Text string with a
for the possible values of Condition maximum of 255 characters and enclosed in escape quotes.
Types.

Example 1
RTRV-COND-OTU1:MONTREAL:OTU1-20-1-1:SS1114;

Possible System Response

MONTREAL 02-02-12 16:07:47

M SS1114 COMPLD

"OTU1-20-1-1,OTU1:CR,LOS,SA,01-01,12-28-14,NEND,TDTN,\"Loss Of Signal\""

Possible System Response When There is No Standing Condition:

MONTREAL 1998-04-16 02:08:15

M SS1114 COMPLD

Example 2
RTRV-COND-ALL:MONTREAL::SS1114::,,,;

Possible System Response

MONTREAL 02-02-12 16:07:47

M AM0662 COMPLD

"OSM2S-20-1,EQPT:CR,REPLUNITMISS,SA,01-01,12-11-25,NEND,NA,\"Replaceable Unit
Missing\""
"OTU2-20-3-1,OTU2:CR,LOS,SA,01-01,12-28-14,NEND,TDTN,\"Loss Of Signal\""

76.MTFP50/30, Rev B January 2018 Page 30-969

22. Retrieve Commands TL1 Command Reference Manual

Example 3
RTRV-COND-TL:SHANGHAI:ALL:100::,,;

Possible System Response

SHANGHAI 12-11-28 23:00:00

M 100 COMPLD

"TL-3-3-102,TL:MJ,CONF_FAIL,NSA,11-28,21-39-50,NEND,NA:\"The Neighbor Discovery

process was unable to successfully negotiate\""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ALM-ALL

Page 30-970 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-CONN

Command Changes Since Previous Feature Package

• None.

Description
Use the RTRV-CONN command to retrieve connection(s) on the NE. The command parameters provide the ability
to filter the list of connections displayed.

Reservation style of the call connections is consistent with that value specified by the SLPF for new calls that have
been established.

The states of INCOMING and OUTGOING connections are determined based on the data plane, PATHERR
messages, and so on The state of LOCAL connection is determined by the state(s) of the INCOMING and
OUTGOING connection(s) currently connected to it. For example, a CP revertible FULLTIME call may have four
OUTGOING connections at the source node after restoration, but the state of LOCAL connection is determined by
the two connections of current working path and current protect path before the paths are reverted.
The LOCAL connection is only expected to be connected to two OUTGOING (INCOMING) connections at source/
domain ingress (destination/domain egress) nodes for 1+1 and FULLTIME calls. The LOCAL connection is
expected to be connected to one OUTGOING (INCOMING) connection in all other cases. When any INCOMING or
OUTGOING connection is missing, the state of LOCAL connection is affected accordingly.
The state of LOCAL connection is determined by OUTGOING connection(s) at ORIG and DINGRESS nodes. It is
determined by INCOMING connection(s) at DEST and DEGRESS. In INT nodes, it is determined by either
INCOMING or OUTGOING side connection(s) whose state is worse. For example, the LOCAL has one INCOMING
conn which is IS-NR and one OUTGOING conn which is OOS-AU,PATHDN, then the LOCAL is OOS-AU,PATHDN.

Restrictions
• String parameters must be used in quotes.

• If no parameters are specified, all calls supported by the NE is retrieved.

• The CONNPATH only applies when the CONNMODE is INCOMING or OUTGOING.

• The ETOESESSIONID only applies when the CONNMODE is INCOMING or OUTGOING.

• For non-CP-revertible calls, the CONNPATH is shown as NOM_WKG (NOM_PROT) regardless

whether link failure reroute or admin-reroute ever happened.

• For CP revertible calls when they are not rerouted or admin-reroute happened, the CONNPATH is
shown as NOM_WKG (NOM_PROT).

• For CP revertible calls when they are link failure rerouted, the CONNPATH is shown as CURR_WKG
(CURR_PROT) for the restoration path.

Command Format
RTRV-CONN:[tid]::<ctag>:::[CALLID=<CallId>][,NODE=<NodeAID>][,CONNID=<ConnId>];

76.MTFP50/30, Rev B January 2018 Page 30-971

22. Retrieve Commands TL1 Command Reference Manual

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::CALLID=<CallId>,NODE=<NodeAID>,CONNID=<ConnId>,SIGTYPE=<SignalType>,MULTIP
LE=<MultiplierValue>,DIRECT=<Directionality>,PROTTYPE=<ProtectionType>,RESVSTYLE
=<ReservationStyle>,CONNMODE=<ConnMode>[,CONNPATH=<ConnPath>][,ETOESESSIONID=<en
d_to_end_session_id>]:<pst>[,<sst>]"<cr><lf>+;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.20 RTRV-CONN Parameters

Parameter Value(s) Definition
CallId Up to a 55 character string in the This parameter represents the call associated with the
following format: [CNTRY-CAR-AP- connection.
]TYPE-ADDRESS-ID. (1)CNTRY -
country code (3 alphabetic characters) Examples:
(2)CAR - carrier code (1 to 6 Global format -
alphanumeric characters. The first "USA-CAR1-ATT01E-IPV4-192.168.1.1-1895B"
character must be alphabetic) (3)AP - Carrier specific format -
access point (1 to 6 alphanumeric "IPV4-192.168.1.1-1895B"
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

NodeAID NODE-[1,3]-[1-512] Specifies the node that the call exists in.

ConnId A double quoted string in the form of: Specifies the connection ID for the connection.
32 bit destination ID-
32 bit extendedTunnelID- Destination_ID: This ID indicates the destination NE, matching
16 bit tunnelID- the value found in the SESSION object of the RSVP PATH
32 bit source ID- message. For ENNIv1, ENNIv2 and INNIv1 this is the SC PC ID
16 bit lspID of the immediate downstream NE. For INNIv2, this is the
ingress NE of the domain.

ExtendedTunnelID: A 32-bit identifier used in the SESSION

objects to scope the TunnelID.

TunnelID: A 16-bit identifier used in the SESSION objects to

identify a reservation session. When the connection is signaled
with SHARED_EXPLICIT, connections with the same
Destination, ExtendedTunnelID and TunnelID is allowed to
share dataplane resources.

Source SC_PC_ID: This ID indicates the signaling controller of

source NE, matching the value found in the
SENDER_TEMPLATE object of the RSVP PATH message.

LSP_ID: A 16-bit identifier used in the SENDER_TEMPLATE

that allows a sender to distinquish different connections that
share resources.

Page 30-972 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.20 RTRV-CONN Parameters (Continued)

Parameter Value(s) Definition
SignalType ODU0 The connection type of the call.
ODU1
ODU2
ODU2e
ODU3
ODU4
OTU2
OTU2e
OTU4
STS1
STS3C
STS12C
STS48C
STS192C

MultiplierValue [1-32] This value is used to indicate the number of channels of

signal_type used in the call.

Directionality BI This parameter specifies the direction of traffic flow.

Unidirectional does not be supported until a later release.

ProtectionTyp 1P1 The connection protection type

e UNPROTECT 1P1 - Linear Automatic Protection Switching
UNPROTECT - No protection

ReservationSt SE This parameter specifies the reservation style of call connection.

yle FF
SE: Shared Explicit
FF: Fixed Filter

ConnMode INCOMING Indicates the connection mode.

LOCAL
OUTGOING

ConnPath NOM_WKG Specifies the connection of a given call to be retrieved.

NOM_PROT NOM_WKG - nominal working
CURR_WKG NOM_PROT - nominal protect
CURR_PROT CURR_WKG - current working
CURR_PROT - current protect

Only CURR_WKG indicates the "Last Effort" connection path at

the repair node where the "last effort" connection has been
established.

end_to_end_s A double quoted string in the form of: Specifies the end-to-end session ID for the connection.
ession_id 32 bit source SC_PC_ID-32 bit
destination SC_PC_ID-16 bit The "32 bit source SC_PC_ID", "32 bit destination SC_PC_ID"
tunnel_ID or NULL and "16 bit tunnel_ID" value should match the value found in the
Coriant proprietary session object of the RSVP PATH message.
A NULL value is shown for the connection of a call that is
upgraded from previous FPs.

Example: "140300f3-140300fa-5"

pst IS-NR Indicates the primary state of the connection.

IS-ANR
OOS-AU Possible primary states include:
- In-Service, normal (IS-NR)
- In-Service, abnormal (IS-ANR)
- Out-of-Service, autonomous (OOS-AU)

76.MTFP50/30, Rev B January 2018 Page 30-973

22. Retrieve Commands TL1 Command Reference Manual

Table 22.20 RTRV-CONN Parameters (Continued)

Parameter Value(s) Definition
sst CPFAULTED Indicates the secondary state of the connection.
LASTEFFORT
LASTRVTFAIL Possible secondary states include:
NRDYRVT - Control Plane signaling associated with the connection has
PATHDN failed (CPFAULTED)
PATHERR - The connection is a "last effort" connection (LASTEFFORT)
PENDING - A connection secondary state (only applies to nominal
UNPROTECTED connection) to indicate the previous reverted nominal path
received a reroute request (LASTRVTFAIL)
- A connection secondary state to indicate that the connection
path is not ready for reversion (NRDYRVT)
- A connection secondary state to indicate that there is a loss of
traffic in data plane (PATHDN)
- A connection secondary state to indicate that there is a link
fault detected by the control plane (PATHERR)
- The connection is pending due to a call request or due to
recovery after a system restart (PENDING)
- There is traffic loss in one of the legs in data plane for a 1+1 or
FULLTIME connection path (UNPROTECTED)

Example
The following example retrieves an existing connection:
RTRV-CONN:::AM0209:::CALLID="IPV4-21.3.101.119-02",NODE=NODE-3-119;

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M AM0209 COMPLD

Example for an ODU/optical switching node:

^^^"::CALLID=\"IPV4-21.3.101.119-02\",NODE=NODE-3-119,CONNID=\"14030065-
14030065-8-14030065-
1\",SIGTYPE=ODU2,MULTIPLE=1,DIRECT=BI,PROTTYPE=1P1,RESVSTYLE=SE,CONNMODE=INCOMIN
G,CONNPATH=NOM_WKG,ETOESESSIONID=\"7ffee9ff-7ffee9f0-1\":IS-NR"
^^^"::CALLID=\"IPV4-21.3.101.119-02\",NODE=NODE-3-119,CONNID=\"14030065-
14030065-9-14030065-
1\",SIGTYPE=ODU2,MULTIPLE=1,DIRECT=BI,PROTTYPE=1P1,RESVSTYLE=SE,CONNMODE=LOCAL:I
S-NR"
^^^"::CALLID=\"IPV4-21.3.101.119-02\",NODE=NODE-3-119,CONNID=\"14030065-
14030065-a-14030065-
1\",SIGTYPE=ODU2,MULTIPLE=1,DIRECT=BI,PROTTYPE=1P1,RESVSTYLE=SE,CONNMODE=OUTGOIN
G,CONNPATH=NOM_WKG,ETOESESSIONID=\"7ffee9ff-7ffee9f0-1\":IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CONN

Page 30-974 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-CONN-INFO

Command Changes Since Previous Feature Package

• None.

Description
RTRV-CONN-INFO retrieves the related resources of a given node (or all nodes) that the given connection has
traversed within a network element. The command represents the local CTP information that made up the CP
connection.

The RESOURCES field indicates the observable entry/exit points for an INCOMING/OUTGOING connection. For a
call that originates/terminates on a module with a SINTF-2, the resources information displayed will only be the entry
point of the card (either OCH-P or ODUk&OCH-P depending on the specific cards).

For an add/drop call that traverses through a directionless module, 2 additional OCH facilities (that is, in addition to
the OCH-L to OCH-P cross-connect for a single add/drop) are displayed as resources due to the directionless
module being included in the connection path.

Restrictions
• MTNUM is an optional input parameter but a mandatory parameter in response format to RTRV-CONN-
INFO command.
MTNUM will default to 1 for input.

• For non-CP-revertible calls, the CONNPATH is shown as NOM_WKG (NOM_PROT) regardless

whether link failure reroute or admin-reroute ever happened.

• For CP revertible calls when they are not rerouted or admin-reroute happened, the CONNPATH is
shown as NOM_WKG (NOM_PROT).

• For CP revertible calls when they are link failure rerouted, the CONNPATH is shown as CURR_WKG
(CURR_PROT) for the restoration path.

Command Format
RTRV-CONN-
INFO:[tid]::ctag:::CALLID=<CallId>[,NODE=<node_aid>][,MTNUM=<mtNumber>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::CALLID=<CallId>,NODE=<node_aid>,CONNID=<ConnId>,MTNUM=<mtNumber>,RESOURCES
=<resources>,CONNMODE=<ConnMode>,CONNPATH=<ConnPath>"<cr><lf>+;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-975

22. Retrieve Commands TL1 Command Reference Manual

Table 22.21 RTRV-CALL-INFO Parameters

Parameter Value(s) Definition
CallId Up to a 55 character string in the This parameter represents the call to be retrieved.
following format: [CNTRY-CAR-AP-
]TYPE-ADDRESS-ID. (1)CNTRY - Examples:
country code (3 alphabetic characters) Global format - "USA-CAR1-ATT01E-IPV4-192.168.1.1-1895B"
(2)CAR - carrier code (1 to 6 Carrier specific format - "IPV4-192.168.1.1-1895B"
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers
Default: NULL

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier.

mtNumber [1-32] This parameter specify the MT component number of the call
which route information is needed to return.

ConnId A double quoted string in the form of: Specifies the connection ID for the connection.
32 bit destination ID-
32 bit extendedTunnelID- Destination_ID: This ID indicates the destination NE, matching
16 bit tunnelID- the value found in the SESSION object of the RSVP PATH
32 bit source ID- message. For ENNIv1, ENNIv2 and INNIv1 this is the SC PC ID
16 bit lspID of the immediate downstream NE. For INNIv2, this is the
ingress NE of the domain.

ExtendedTunnelID: A 32-bit identifier used in the SESSION

objects to scope the TunnelID.

TunnelID: A 16-bit identifier used in the SESSION objects to

identify a reservation session. When the connection is signaled
with SHARED_EXPLICIT, connections with the same
Destination, ExtendedTunnelID and TunnelID is allowed to
share dataplane resources.

Source SC_PC_ID: This ID indicates the signaling controller of

source NE, matching the value found in the
SENDER_TEMPLATE object of the RSVP PATH message.

LSP_ID: A 16-bit identifier used in the SENDER_TEMPLATE

that allows a sender to distinquish different connections that
share resources.

Page 30-976 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.21 RTRV-CALL-INFO Parameters (Continued)

Parameter Value(s) Definition
resources The resource facility AID or related This parameter specifies the incoming facility AID for an
IfName of the connection. INCOMING connection and the outgoing facility AID for an
OUTGOING connection. Resources must be enclosed in double
quotes.

Resource facility type supported:

ODU2, ODU2E, ODU4, ODUF, OTU2, OTU4, OCH, OCH-P,
OCH-L, STS1, STS3C. STS12C, STS48C, STS192C,
TTPSTS1, TTPSTS3C

Possible value:
"OTU2-2-2-1"

ConnMode INCOMING Indicates the connection mode.

OUTGOING

ConnPath NOM_WKG Specifies the connection path.

NOM_PROT NOM_WKG - nominal working
CURR_WKG NOM_PROT - nominal protect
CURR_PROT CURR_WKG - current working
CURR_PROT - current protect

Only CURR_WKG indicates the "Last Effort" connection path at

the repair node where the "last effort" connection has been
established.

Example
The following example retrieves all facilities of a given node and a given call:
RTRV-CONN-INFO:::AM0011:::CALLID="IPV4-1.1.1.1-A1B2C3D4",NODE=NODE-3-1;

Possible System Response

Example: for an ODU switching node as an intermediate node:

^^^CORIANT1 06-05-15 02:08:15

M AM0011 COMPLD
"::CALLID=\"IPV4-21.3.243.11-03\",NODE=NODE-3-1,CONNID=\"14030065-14030065-8-
14030065-1\",MTNUM=1,RESOURCES=\"ODU2-20-3-1,OTU2-20-3-
1\",CONNMODE=INCOMING,CONNPATH=NOM_WKG";
"::CALLID=\"IPV4-21.3.243.11-03\",NODE=NODE-3-1,CONNID=\"14030065-14030065-8-
14030065-1\",MTNUM=1,RESOURCES=\"ODU2-20-4-2,OTU2-20-4-
1\",CONNMODE=OUTGOING,CONNPATH=NOM_WKG";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-CALL
RTRV-CONN

76.MTFP50/30, Rev B January 2018 Page 30-977

22. Retrieve Commands TL1 Command Reference Manual

RTRV-CONN-ROUTE

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-CONN-ROUTE command instructs the NE Control Plane to retrieve the ERO (Explicit Route Objects)
and RRO (Recorded Route Objects) of a specific connection. The connection identified represents an end to end
CP connection of a given call.
The system allows an attempt to retrieve the connection route with CONNPATH of CURR_WKG or CURR_PROT
for the connection that has no link failure reroute ever happened. In this case CURR_WKG and NOM_WKG returns
the same data (similarly with CURR_PROT and NOM_PROT).
The result of retrieving the CURR_WKG (CURR_PROT) path is the same with NOM_WKG (NOM_PROT) for non-
CP-revertible calls, even the calls have experienced reroute.

Restrictions and Exceptions

• The combination of CONNPATH and ROUTETYPE parameters provides the flexibility for displaying the
call route information, the two parameters must be provided at same time.

Figure 22.2 Simple case ERO and RRO

Source node Destination node

ERO={B-y,C-y}
ERO={B-v,C-w}
A D
x
u RRO={B-y-1,C-y-1,D-x}
RRO={B-v-1,C-w-1,D-x} x
y
w ERO={}
x B yv x C RRO={}
ERO={A-x, B-y,
ERO={A-u, B-v, C-y}
C-w}
RRO={A-x-1, B-y-1,
RRO={A-u-1, B-v-1, C-y-1,D-x}
C-w-1,D-x}

NOTE:
1. To simplify the diagram, the route elements here is not in the "real" format. For example, the route element "A-u"
means the interface "u" on the node "A"; the route element "A-u-1" means the lable "1" of interface "u" on the node
"A". Here '1' in A-u-1 is the label in this case but does not mean all hops in an RRO has a '1' as label. Refer to the
Parameters section for the real format of the route element.
2. Refer to command ENT-CALL for the decoding of the Label in the route element.
• The ERO and RRO route retrieving results are different at different nodes across a given end to end
connection as above figure showing.

• The system response should omit the unrelated parameter field(s) according to the input filtering of
CONNPATH and ROUTETYPE parameters.
for example,
1. PROTERO, WKGRRO, PROTRRO does not be displayed when the CONNPATH=NOM_WKG and
ROUTETYPE=ERO is retrieved.
2. WKGRRO, WKGERO, PROTERO does not be displayed when the CONNPATH=NOM_PROT/
CURR_PROT and ROUTETYPE=RRO is retrieved.

Page 30-978 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

• The ERO and RRO route infomation are different from different views for a node that happened loop
routes. Only ERO and RRO from the farest view to call termination node can be retrieved.

• MTNUM is an optional input parameter but a mandatory parameter in response format to RTRV-CONN-
ROUTE command.
MTNUM will default to 1 for input.

• The system denies an attempt to retrieve the connection route with CONNPATH of NOM_PROT or
CURR_PROT if protection level of the call is UNPROTECT or REROUTE.

• The TL1 response will include RRO of the BL, the working component link and the working hops of the
subsequent domains, at the call origination node or domain ingress node, for a BL involved call/
connection; the TL1 response will include RRO of the BL and the specific component links at the node
where BL originated, when the specific connection type is specified. Please refer to diagram below for
the response details, note the BL IfIndex is indicated as interface "b" at Node E/Node F where BL is
originated:

• CP appends the ingress interface†of the last visible destination node as the last route element when
RRO retrieving is performed at upstream nodes. Refer to two diagrams below for the differences when
the visibility of area 30 set as "Passed" and "Masked".

Figure 22.3 BL and component links RRO demo 1

NodeE: RRO of NOM_WKG= NodeF: RRO of NOM_WKG=

{E-b,E-u-1,F-s-1,G-m-1,Z-j} {F-s-1,G-m-1,Z-j}
NodeF: RRO ofNM_PROT
Source node NodeE: RRO of NOM_PROT= {F-t-1,H-n-1,Z-k}
m
{E-b,E-v-1,F-s-1,G-m-1,Z-j} G
A x
y u s j
E v F Z
B w t k
NodeA: RRO of NOM_WKG= Destination Node
{A-x-1, E-b,E-u-1,F-s-1,G-m-1,Z-j} (Area RRO
H area30
NodeA: RRO of NOM_PROT= area20 Visibility Passed) n
{A-y-1, B-w-1,E-b,E-u-1,F-s-1,G-m-1,Z-j}

Figure 22.4 BL and component links RRO demo 2

NodeE: RRO of NOM_WKG= NodeF: RRO of NOM_WKG=

{E-b,E-u-1,M-b} {F-s-1,G-m-1,Z-j}
NodeF: RRO ofNM_PROT
Source node NodeE: RRO of NOM_PROT= {F-t-1,H-n-1,Z-k}
m
{E-b,E-v-1,M-b} G
A x
y u s j
E v F Z
B w t k
NodeA: RRO of NOM_WKG= Destination Node
{A-x-1, E-b,E-u-1,M-b} (Area RRO
area20 H area30
NodeA: RRO of NOM_PROT= Visibility Masked, n
{A-y-1, B-w-1,E-b,E-u-1,M-b} Node in Parent Area is Node M)

76.MTFP50/30, Rev B January 2018 Page 30-979

22. Retrieve Commands TL1 Command Reference Manual

Command Format
RTRV-CONN-
ROUTE:[tid]::ctag:::CALLID=<CallId>[,NODE=<node_aid>][,MTNUM=<mtNumber>],CONNPAT
H=<ConnPath>,ROUTETYPE=<route_type>;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::CALLID=<CallId>,AEND=<A_EndPoint>,ZEND=<Z_EndPoint>,NODE=<node_aid>,CONNID
=<ConnId>[,WKGERO=<routeElements>][,PROTERO=<routeElements>][,WKGRRO=<routeEleme
nts>][,PROTRRO=<routeElements>],MTNUM=<mtNumber>"<cr><lf>+
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.22 RTRV-CALL-ROUTE Parameters

Parameter Value(s) Definition
CallId Up to a 55 character string in the Specifies the CallID for this RRO.
following format: [CNTRY-CAR-AP-
]TYPE-ADDRESS-ID. (1)CNTRY - Examples:
country code (3 alphabetic characters) Global format - "USA-CAR1-ATT01E-IPV4-192.168.1.1-1895B"
(2)CAR - carrier code (1 to 6 Carrier specific format - "IPV4-192.168.1.1-1895B"
alphanumeric characters. The first
character must be alphabetic) (3)AP -
access point (1 to 6 alphanumeric
characters. The first character must be
alphabetic) (4)TYPE - IPV4
(5)ADDRESS - Router address (IPV4
format) (6)ID - up to 16 hexadecimal
numbers

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier.

mtNumber [1-32] This parameter specify the MT component number of the call
which route information is needed to return.

ConnPath NOM_WKG Specifies the connection of a given call to be retrieved.

NOM_PROT NOM_WKG - nominal working
CURR_WKG NOM_PROT - nominal protect
CURR_PROT CURR_WKG - current working
CURR_PROT - current protect

Only CURR_WKG indicates the "Last Effort" connection path at

the repair node where the "last effort" connection has been
established.

route_type RRO Specifies the route type that should be retrieved

ERO

A_EndPoint Enter type-xxx.xxx.xxx.xxx format: (1) The EndPoint is a TNA and will follow TNA rules.
type is one of the following: IPV4 In the model this would be AEND/ZEND
(2)xxx = 0-255

Page 30-980 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.22 RTRV-CALL-ROUTE Parameters (Continued)

Parameter Value(s) Definition
Z_EndPoint Enter type-xxx.xxx.xxx.xxx format: (1) The EndPoint is a TNA and will follow TNA rules.
type is one of the following: IPV4 In the model this would be AEND/ZEND
(2)xxx = 0-255

ConnId A double quoted string in the form of: Specifies the connection ID for the connection.
32 bit destination ID-
32 bit extendedTunnelID- Destination_ID: This ID indicates the destination NE, matching
16 bit tunnelID- the value found in the SESSION object of the RSVP PATH
32 bit source ID- message. For ENNIv1, ENNIv2 and INNIv1 this is the SC PC ID
16 bit lspID of the immediate downstream NE. For INNIv2, this is the
ingress NE of the domain.

ExtendedTunnelID: A 32-bit identifier used in the SESSION

objects to scope the TunnelID.

TunnelID: A 16-bit identifier used in the SESSION objects to

identify a reservation session. When the connection is signaled
with SHARED_EXPLICIT, connections with the same
Destination, ExtendedTunnelID and TunnelID is allowed to
share dataplane resources.

Source SC_PC_ID: This ID indicates the signaling controller of

source NE, matching the value found in the
SENDER_TEMPLATE object of the RSVP PATH message.

LSP_ID: A 16-bit identifier used in the SENDER_TEMPLATE

that allows a sender to distinquish different connections that
share resources.

routeElements Contains a list of route element that Specifies the routing elements that form the explicit path in a
are separated by comma. A route specific format.
element is inform of (S|L)-nodeID-
IfIndex[-Label] (1)IfIndex is 8 S means the route element(s) is(are) strict. The path between a
hexadecimal digits. (2)Label is 8 strict route element and its preceding route element MUST
hexadecimal digits for non ODUk include only network route elements from the strict route
labels or G.709 V2 ODUk labels; Label element and its preceding abstract route element.
is a multiple of 8 hexadecimal digits for L means the route element(s) is(are) loose. The path between a
G.709 V3 ODUk/j labels. loose route element and its preceding route element MAY
include other network route elements that are not part of the
strict route element or its preceding abstract route element.
Two forms of route element:
- (S|L)-Node-Ifindex: L-123.224.187.198-040FAA0C
- S-Node-Ifindex-label: S-123.224.187.198-040FAA0C-
000A0000

Example
Example 1 retrieves the working RRO information of an unprotected service call.
RTRV-CONN-ROUTE:CORIANT1::AM0011:::CALLID="IPV4-21.3.65.11-0F",NODE=NODE-3-
1,CONNPATH=NOM_WKG,ROUTETYPE=RRO;

Example 2 retrieves the working RRO information of a 1+1 protected service call.
RTRV-CONN-ROUTE:CORIANT1::AM0011:::CALLID="IPV4-21.3.65.11-0F",NODE=NODE-3-
1,CONNPATH=NOM_WKG,ROUTETYPE=RRO;

Example 3 retrieves the nominal working RRO information of a full time service call.

76.MTFP50/30, Rev B January 2018 Page 30-981

22. Retrieve Commands TL1 Command Reference Manual

RTRV-CONN-ROUTE:CORIANT1::AM0011:::CALLID="IPV4-21.3.65.11-0F",NODE=NODE-3-
1,CONNPATH=NOM_WKG,ROUTETYPE=RRO;

Example 4 retrieves the nominal working RRO information of an unprotected service call without providing node aid.
RTRV-CONN-ROUTE:CORIANT1::AM0011:::CALLID="IPV4-21.3.65.11-
0F",CONNPATH=NOM_WKG,ROUTETYPE=RRO;

Possible System Response

Example 1 response:
^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
"::CALLID=\"IPV4-21.3.65.11-0F\",AEND=\"IPV4-243.3.11.3\",ZEND=\"IPV4-
245.4.7.2\",NODE=NODE-3-1,CONNID=\"140300f3-140300f3-11-140300f3-1\",WKGRRO=\"S
21.3.243.11-00D6A000-00102000,S-21.3.245.11-010EA000\",MTNUM=1"
;

Example 2 response:
^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
"::CALLID=\"IPV4-21.3.65.11-0F\",AEND=\"IPV4-111.111.111.111\",ZEND="IPV4-
222.222.222.222\",NODE=NODE-3-1,CONNID=\"140300f3-140300f3-11-140300f3-
1\",WKGRRO=\"S-21.3.243.11-00D6A000-00102000,S-21.3.245.11-010EA000\",MTNUM=1"
;

Example 3 response:
^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
"::CALLID=\"IPV4-21.3.65.11-0F\",AEND=\"IPV4-111.111.111.111\",ZEND="IPV4-
222.222.222.222\",NODE=NODE-3-1,CONNID=\"140300f3-140300f3-11-140300f3-
1\",WKGRRO=\"S-21.3.243.11-00D6A000-00102000,S-21.3.245.11-010EA000\",MTNUM=1"
;

Example 4 response:
^^^CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
"::CALLID=\"IPV4-21.3.65.11-0F\",AEND=\"IPV4-111.111.111.111\",ZEND="IPV4-
222.222.222.222\",NODE=NODE-3-1,CONNID=\"140300f3-140300f3-11-140300f3-
1\",WKGRRO=\"S-111.0.10.0-020FAA01-00020000,S-111.0.0.110-030FBB02-00020000,S-
111.0.0.111 040FBB03-00030000,S-111.0.20.0-020FAA01\",MTNUM=1"
"::CALLID=\"IPV4-21.3.65.11-0F\",AEND=\"IPV4-111.111.111.111\",ZEND="IPV4-
222.222.222.222\",NODE=NODE-3-2,CONNID=\"140300f3-140300f3-11-140300f3-
1\",WKGRRO=\"S-111.0.0.110-030FBB02-00020000,S-111.0.0.111-040FBB03-00030000,S-
111.0.20.0 020FAA01\",MTNUM=1"
"::CALLID=\"IPV4-21.3.65.11-0F\",AEND=\"IPV4-111.111.111.111\",ZEND="IPV4-
222.222.222.222\",NODE=NODE-3-3,CONNID=\"140300f3-140300f3-5-140300f3-
1\",WKGRRO=\"S-111.0.0.111-040FBB03-00030000,S-111.0.20.0-020FAA01\",MTNUM=1"
"::CALLID=\"IPV4-21.3.65.11-0F\",AEND=\"IPV4-111.111.111.111\",ZEND="IPV4-
222.222.222.222\",NODE=NODE-3-4,CONNID=\"140300f3-140300f3-6-140300f3-
1\",WKGRRO=\"\",MTNUM=1"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-982 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Related Commands
DLT-EXPPATH
ED-EXPPATH
ENT-EXPPATH
RTRV-EXPPATH
ENT-CALL

76.MTFP50/30, Rev B January 2018 Page 30-983

22. Retrieve Commands TL1 Command Reference Manual

RTRV-CPPF

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-CPPF command instructs the network element (NE) to retrieve a protocol profile.

Restrictions
• When ALL is used as an AID, information for all control frame profile entities is retrieved.

Command Format
RTRV-CPPF:[tid]:{<cppf_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<cppf_aid>::PFNAME=<ProfileName>,GMPLSMODE=<GMPLSMode>
,LSARMAXFP=<LSARefreshMaxPeriod>,CAPACITYADV=<CapacityAdvertisement>,OPTPATHALG=
<OptPathAlg>"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.23 RTRV-CPPF Parameters

Parameter Value(s) Definition
cppf_aid CPPF-[94-99,1-20] EntityID-CPPFID

ProfileName 0 to 31 alphanumeric characters. Specifies the Profile name.

Refer to section 2 for the applicable characters.

GMPLSMode OIF-ENNI-V1 Specifies the GMPLS mode.

OIF-ENNI-V2
OIF-ENNI-V1PV2
INNI-V1
INNI-V2
INNI-V1PV2
NONE

LSARefreshM [1-65535] Specifies the LSA refresh period in seconds.

axPeriod

Page 30-984 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.23 RTRV-CPPF Parameters (Continued)

Parameter Value(s) Definition
CapacityAdver AVAIL Specifies the forms of link capacity to advertise in the local
tisement AVAIL&FAILED routing area. The Link State Advertisement message is sent to
advertise available capacity or to advertise available and failed
capacity.

AVAIL - The Link State Advertisement is sent to advertise

unused capacity on available links.

AVAIL&FAILED - The Link State Advertisement is sent

separately advertising unused capacity on available links and
unused capacity on failed links.

Available links are administratively in-service and operationally

in-service.
Failed links are:
- administratively in-service and operationally out-of-service;
- administratively out-of-service and operationally in-service; or
- administratively out-of-service and operationally out-of-service.

OptPathAlg Possible values are: Specifies the CP routing algorithm uses the discrete optical
DISCRETE impairment parameters or the PMetric information to compute
PMETRIC the path.
OPE
DISCRETE: Use the discrete optical impairment parameters
that are populated via the ENT-TL command for route
computation. These parameters include PMD, OSNR, FWMP,
PDL, RCD, SPMN and XMMN.

PMETRIC: Use PMetric OMS-based figures of merit information

for route computation.

OPE: Use TRANSNET OPE algorithm for route computation.

Requires OPE data files to be loaded on the network element.

Example
RTRV-CPPF:CORIANT1:CPPF-9:AM0011;

Possible System Response

CORIANT1 11-05-15 02:08:15
M AM0011 COMPLD
^^^"CPPF-9::PFNAME=\"Router
Profile\",LSARMAXFP=1800,GMPLSMODE=NONE,CAPACITYADV=AVAIL&FAILED,OPTPATHALG=DISC
RETE"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-CPPF
ENT-OSPFAREA
RTRV-OSPFAREA

76.MTFP50/30, Rev B January 2018 Page 30-985

22. Retrieve Commands TL1 Command Reference Manual

RTRV-CRS-OCH

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-CRS-OCH command instructs the network element (NE) to retrieve the OCH cross-connection
information.

Refer to ENT-CRS-OCH command for a description of OCH cross-connections allowed in the network element.

An OCH-L to OCH-P/OCH-OS cross-connection allows add/drop of a signal from a DWDM interface.

An OCH-L to OCH-L cross-connection allows pass through of a specific wavelength from one DWDM interface to
the other DWDM interface within a network element.

An OCH-L to OCH cross connection allows add/drop of a foreign wavelength to/from a DWDM interface.

Restrictions and Exceptions

• Either "<from_och>, <to_och>", "ALL,ALL", "<from_och>, ALL", "<to_och>, ALL", "ALL,<to_och>",
"ALL,<from_och>" can be used to retrieve the information of the cross-connection.
When GRP is used, all OCH CRS having this Group Id is shown in the command response.

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

Command Format
RTRV-CRS-OCH:[tid]:{<from_och>|<to_och>|ALL},{
from_och>|<to_och>|ALL}:ctag[:::GRP=<grp>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<from_och>,<to_och>:<CCT>:GRP=<grp>[,CKTID=<circuitIdentification>],CCPATH=<
ccPath>[,NPOWNER=<NpOwner>]:<pst>,[<sst>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-986 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.24 RTRV-CRS-OCH Parameters

Parameter Value(s) Definition
from_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]

to_och OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num

OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]

grp One to 45 alphanumeric characters. Specifies the group ID of the cross-connection being
provisioned.
Refer to section 2 for the applicable characters.

CCT 2WAY Specifies the cross-connection type.

1WAY 2WAY = two-way/bidirectional cross-connection
1WAY = one-way/unidirectional cross-connection

circuitIdentifica One to 46 alphanumeric characters. Specifies the circuit ID of the cross-connection being
tion provisioned.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

ccPath CMM-CMM Specifies on which module the crossconnection is going

ADD/DROP through.
ADD - CMM-CMM: represents a DWDM signal going through two
DROP OADMs for an OCH-L to OCH-L pass through connection.
- ADD/DROP: represents a 2-way signal being added/dropped.
- ADD: represents a 1-way signal being added.
- DROP: represents a 1-way signal being dropped.

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state of the crossconnection.

IS-ANR Possible primary states include:
OOS-AU - In-Service, normal (IS-NR)
- In-Service, abnormal (IS-ANR)
- Out-of-Service, autonomous (OOS-AU)

sst SGEO Indicates the secondary state of the crossconnection.

Possible secondary states include:
- Supporting entity outage (SGEO)

Example 1
RTRV-CRS-OCH:CORIANT1:OCH-L-20-1-21-7,OCH-P-20-1-1:AM0012;

76.MTFP50/30, Rev B January 2018 Page 30-987

22. Retrieve Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 15-04-16 02:08:15

M AM0012 COMPLD

"OCH-L-20-1-21-7,OCH-P-20-1-1:2WAY:GRP=\"123456\",CKTID=\"CORIANT1\",CCPATH=ADD/
DROP:IS-NR,"

Example 2
This command retrieves all OCH cross-connections on the NE:

RTRV-CRS-OCH:CORIANT1:ALL,ALL:AM0211;

Possible System Response

CORIANT1 15-04-16 02:08:15

M AM0211 COMPLD

"OCH-L-20-1-21-1,OCH-L-20-16-21-
1:2WAY:GRP=\"123\",CKTID=\"CORIANT12\",CCPATH=CMM-CMM:IS-NR,"

"OCH-L-20-1-21-9,OCH-L-20-6-21-9:2WAY:GRP=\"124\",CKTID=\"BELL1\",CCPATH=CMM-
CMM:IS-NR,"

"OCH-L-20-1-21-26,OCH-P-20-7-1:2WAY:GRP=\"127\",CKTID=\"NEW YORK\",CCPATH=ADD/
DROP:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-OCH
ED-CRS-OCH
ENT-CRS-OCH

Page 30-988 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-CRS-ODUk

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-CRS-ODUk command retrieves the properties of the ODUk cross-connection.

Restrictions and Exceptions

• The SOURCE and DESTINATION terminations must be of type specified in command, and a cross-
connection between them must exist.

• Either "<src_odu>,<dest_odu>", "ALL,ALL", "<src_odu|dest_odu>,ALL", or "ALL,<dest_odu|src_odu>"

can be used to retrieve the information of the cross-connection.

• This command supports TL1 AID Ranging (&&) for ODU0/ODU1/ODU2/ODU3/ODU4/ODUF facility
AIDs in the command syntax as follows:
- source AID is a range of AIDs, destination AID is a single AID
- source AID is a single AID, destination AID is a range of AIDs
- source AID is a range of AIDs, destination AID is the "ALL" AID
- source AID is the "ALL" AID, destination AID is a range of AIDs

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

• For SSM-2S, when 1+1 EPG provisioned for OTN adaption single point failure equipment protection,
the system createsd a protected ODUk cross connection automatically even only the ODUk entity
associated with working SSM-2S module is specifed as source or destination end. The protected cross
connection is retrievable and for the end assoicated with protection SSM-2S module it is indicated by
SRC_PROT_ODU if SSM-2S is the source end or DEST_PROT_ODU if SSM-2S is the destination end.

Command Format
RTRV-CRS-ODUk:[tid]:{<src_odu>|ALL},{<dest_odu>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD
"<src_odu>,<dest_odu>:<CCT>:[SRC_PROT=<src_prot_odu>][,DEST_PROT=<dest_prot_odu>
][,CKTID=<circuit_id>][,SRC_PROT_STATUS=<src_prot_status>][,DEST_PROT_STATUS=<de
st_prot_status>][,SRC_PROTTYPE=<src_ProtectionType>][,DEST_PROTTYPE=<dest_Protec
tionType>][,NPOWNER=<NpOwner>]:<pst>[,<sst>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-989

22. Retrieve Commands TL1 Command Reference Manual

Table 22.25 RTRV-CRS-ODUk Parameters

Parameter Value(s) Definition
src_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

Page 30-990 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.25 RTRV-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_odu ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

CCT 2WAY Specifies the cross connection type:

2WAYPR - 2WAY: Bidirectional connection.
2WAYDRI - 2WAYPR: Bidirectional connection with SNC Protection
1WAY - 2WAYDRI: Bidirectional Dual Ring Interconnected connection
1WAYPR - 1WAY: Unidirectional connection
- 1WAYPR: Unidirectional connection with SNC Protection

circuit_id One to 46 alphanumeric characters. Specifies the circuit ID of the channel being provisioned.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

src_prot_statu NOREQ Specifies the protection status of the Source side.

s DNR
WTR
MANTOPROT
MANTOWKG
FSTOPROT
FSTOWKG
LOCKOUT
SFONWKG
SFONPROT
SDONWKG
SDONPROT
EXERTOPROT
EXERTOWKG

76.MTFP50/30, Rev B January 2018 Page 30-991

22. Retrieve Commands TL1 Command Reference Manual

Table 22.25 RTRV-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_prot_stat NOREQ Identifies the protection status of the Destination side.
us DNR
WTR
MANTOPROT
MANTOWKG
FSTOPROT
FSTOWKG
LOCKOUT
SFONWKG
SFONPROT
SDONWKG
SDONPROT
EXERTOPROT
EXERTOWKG

src_Protection SNCI Specifies the Protection Type (SNC/I or SNC/N) that is applied
Type SNCN to the SRC (source) side of the connection.
- SNCI: SubNetwork Connection protection with Inherent
monitoring. Only the server layer is monitored for protection
switching purposes.
- SNCN: SubNetwork Connection protection with Non-intrusive
monitoring. The end-to-end layer and the server layer are
monitored for protection switching purposes.

dest_Protectio SNCI Specifies the Protection Type (SNC/I or SNC/N) that is applied
nType SNCN to the DEST (destination) side of the connection.
- SNCI: SubNetwork Connection protection with Inherent
monitoring. Only the server layer is monitored for protection
switching purposes.
- SNCN: SubNetwork Connection protection with Non-intrusive
monitoring. The end-to-end layer and the server layer are
monitored for protection switching purposes.

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state of the cross connection.

IS-ANR Possible primary states include:
OOS-AU - In-Service, normal (IS-NR)
- In-Service, abnormal (IS-ANR)
- Out-of-Service, autonomous (OOS-AU)

sst SGEO Indicates the secondary state of the cross connection.

RDLD Possible secondary states include:
- supporting entity outage (SGEO)
- red-lined (RDLD)

Page 30-992 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.25 RTRV-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
src_prot_odu_ ODUF-20-[1-16]-[1-40]-[1-80], Specifies the ODU that is the crossconnection source. It it used
rtrv ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1- only when working and protected ODU have different ODU_IDs
32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-[20]-[1-16]-99-[7-30],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-[20]-[1-16]-99-[1-6],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

76.MTFP50/30, Rev B January 2018 Page 30-993

22. Retrieve Commands TL1 Command Reference Manual

Table 22.25 RTRV-CRS-ODUk Parameters (Continued)

Parameter Value(s) Definition
dest_prot_odu ODUF-20-[1-16]-[1-40]-[1-80], Specifies the ODU that is the crossconnection destination. It it
_rtrv ODUF-20-[1-16]-[1-20]-[B,C][1-80]-[1- used only when working and protected ODU have different
32], ODU_IDs
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-40]-[1-80],
ODU0-20-[1-16]-[1-5]-[B,C][1-80]-[1-
32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
ODU1-20-[1-16]-[1-5]-[B,C][1-80]-[1-
16],
ODU1-[20]-[1-16]-99-[7-30],
ODU1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-16],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-20]-[1-80],
ODU2-20-[1-16]-[1-5]-C[1-80]-[1-4],
ODU2-[20]-[1-16]-99-[1-6],
ODU2-20-[1-16]-[1-2]-[D][1-3]-C[1-80]-
[1-4],
ODU2-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU2E-20-[1-16]-[1-4],
ODU2E-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-5]-C[1-80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-C[1-
80]-[1-32],
ODU2E-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU3-20-[1-16]-[1-5]-[1-80],
ODU3-20-[1-16]-[1-2],
ODU3-20-[1-16]-[1-2]-[D][1-3]-[1-80],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3]

Example1
RTRV-CRS-ODU2:CORIANT1:ODU2-20-1-3-1,ODU2-20-1-5-3:MV0076;

Possible System Response

^^^CORIANT1 09-03-15 02:08:15

M MV0076 COMPLD

"ODU2-20-1-3-1,ODU2-20-1-5-3:2WAY:CKTID="RBOC23":IS-NR"

Example2
RTRV-CRS-ODU2:CORIANT1:ALL,ALL:MV0076;

Page 30-994 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

^^^CORIANT1 09-03-15 02:08:15

"ODU2-20-2-2,ODU2-20-3-2:2WAYPR:SRC_PROT=ODU2-20-2-
2,SRC_PROTTYPE=SNCN,CKTID=\"TWO\":IS-NR,"

"ODU2-20-2-1,ODU2-20-3-1:2WAYPR:DEST_PROT=ODU2-20-2-
1,DEST_PROTTYPE=SNCN,CKTID=\"THREE\":IS-NR,"

"ODU2-20-2-99-4,ODU2-20-3-99-4:2WAYPR:SRC_PROT=ODU2-20-2-99-4,DEST_PROT=ODU2-20-
3-99-4,SRC_PROTTYPE=SNCN,DEST_PROTTYPE=SNCN,CKTID=\"FOUR\":IS-NR,"

"ODU2-20-2-99-1,ODU2-20-3-99-1:2WAY:CKTID=\"ONE\":IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-ODUk
ED-CRS-ODUk
ENT-CRS-ODUk

76.MTFP50/30, Rev B January 2018 Page 30-995

22. Retrieve Commands TL1 Command Reference Manual

RTRV-CRS-STSn (STS1/STS3C/STS12C/STS48C/STS192C)

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-CRS-STS1/3C/12C/48C/192C command instructs the network element (NE) to retrieve an STSn cross-
connection.

Restrictions and Exceptions

• The SOURCE and DESTINATION terminations must be of type specified in command, and a cross-
connection between them must exist.

• Either "<src_sts|src_prot_fac>,<dest_sts|dest_prot_fac>", "ALL,ALL", "<src_sts|src_prot_fac>,ALL", or

"ALL,<dest_sts|dest_prot_fac>" can be used to retrieve the information of the cross-connection.
The command supports either "working" or "protection" entity as filtering parameters, and the retrieving
format defaults as "source entity,destination entity" sequence.

• This command supports TL1 AID Ranging (&&) for STS1/STS3C/STS12C/STS48C/STS192C facility
AIDs in the command syntax as follows:
- source AID is a range of AIDs, destination AID is a single AID
- source AID is a single AID, destination AID is a range of AIDs
- source AID is a range of AIDs, destination AID is the "ALL" AID
- source AID is the "ALL" AID, destination AID is a range of AIDs

• The order of STS vs TTP member output is maintained from one feature package to the next where
TTPs are in use.

• When CP creates the cross-connect, the CKTID value is assigned as the connection id. Use the
connection ID displayed in the response field to find the associated call.

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

• For SSM-2S, when 1+1 FFP or 1+1 EPG provisioned, the system createsd a protected STSn cross
connection automatically even only the STSn entity associated with working facility or working SSM-2S
equipment is specifed as source or destination end. The protected cross connection is retrievable and
for the end assoicated with protection facility or equipment it is indicated by SRC_PROT_FAC if STSn
is the source end or DEST_PROT_FAC if STSn is the destination end.

Command Format
RTRV-CRS-
STSn:[tid]:{<src_sts>|<src_prot_fac>|ALL},{<dest_sts>|<dest_prot_fac>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD
"<src_sts>,<dest_sts>:<CCT>:[SRC_PROT=<src_prot_fac>][,DEST_PROT=<dest_prot_fac>
][,CKTID=<circuit_id>][,SRC_PROT_STATUS=<src_prot_status>][,DEST_PROT_STATUS=<de
st_prot_status>][,NPOWNER=<NpOwner>]:<pst>,[<sst>]"
;

Page 30-996 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.26 RTRV-CRS-STSn (STS1/STS3C/STS12C/STS48C/STS192C) Parameters

Parameter Value(s) Definition
src_sts STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

dest_sts STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID

20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TTPSTS1-20-[1-16]-99-[1-3]-[1-192]
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

CCT 2WAY Specifies the cross connection type:

1WAY - 2WAY: Bidirectional connection (default).
1WAYPR - 1WAY: Unidirectional connection.
2WAYPR - 2WAYPR: Bidirectional protected connection.
- 1WAYPR: Unidirectional protected connection.

76.MTFP50/30, Rev B January 2018 Page 30-997

22. Retrieve Commands TL1 Command Reference Manual

Table 22.26 RTRV-CRS-STSn (STS1/STS3C/STS12C/STS48C/STS192C) Parameters (Continued)

Parameter Value(s) Definition
src_prot_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STS that is the protection STS associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <src_sts>.
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

dest_prot_fac STS1-20-[1-16]-[1-30]-[1-192], Specifies the STS that is the protection STS associated to the
STS1-20-[1-16]-99-[1-30]-[1-192], <dest_sts>.
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1],
STS3C-20-[1-16]-99-[1-30]-[190,-
,13,10,7,4,1],
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1],
STS12C-20-[1-16]-[1-30]-99-[181,-
,37,25,13,1],
STS48C-20-[1-16]-[1-30]-
[145,97,49,1],
STS48C-20-[1-16]-99-[1-30]-
[145,97,49,1],
STS192C-20-[1-16]-[1-6]-1,
STS192C-20-[1-16]-99-[1-6]-1

circuit_id One to 46 alphanumeric characters. Specifies the circuit ID of the channel being provisioned. When
the cross-connection is established by control plane, this field
specifies the CALLID of the call being provisioned.
A value of "" means that this field is not used.
Refer to section 2 for the applicable characters.

src_prot_statu NOREQ Indicates the protection status of SNCP associated with the
s DNR <src_sts>. Possible secondary states include:
WTR - no request (NOREQ)
MANTOPROT - do not revert (DNR)
MANTOWKG - wait-to-restore (WTR)
FSTOPROT - manual switch to protection (MANTOPROT)
FSTOWKG - manual switch to working (MANTOWKG)
LOCKOUT - force switch to protection (FSTOPROT)
SFONWKG - force switch to working (FSTOWKG)
SFONPROT - lockout of protection (LOCKOUT)
SDONWKG - signal fail on working (SFONWKG)
SDONPROT - signal fail on protection (SFONPROT)
- signal degrade on working (SDONWKG)
- signal degrade on protection (SDONPROT)
Applicable only when the source STS is involved in protected
STS cross-connection with SNCP protection.
Note: For 1+1 FFP/EPG Protection, this information is available
by doing RTRV-FFP-OCn or RTRV-EPG.

Page 30-998 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.26 RTRV-CRS-STSn (STS1/STS3C/STS12C/STS48C/STS192C) Parameters (Continued)

Parameter Value(s) Definition
dest_prot_stat NOREQ Indicates the protection status of SNCP associated with the
us DNR <dest_sts>. Possible secondary states include:
WTR - no request (NOREQ)
MANTOPROT - do not revert (DNR)
MANTOWKG - wait-to-restore (WTR)
FSTOPROT - manual switch to protection (MANTOPROT)
FSTOWKG - manual switch to working (MANTOWKG)
LOCKOUT - force switch to protection (FSTOPROT)
SFONWKG - force switch to working (FSTOWKG)
SFONPROT - lockout of protection (LOCKOUT)
SDONWKG - signal fail on working (SFONWKG)
SDONPROT - signal fail on protection (SFONPROT)
- signal degrade on working (SDONWKG)
- signal degrade on protection (SDONPROT)
Applicable only when the destination STS is involved in
protected STS cross-connection with SNCP protection.
Note: For 1+1 FFP/EPG Protection, this information is available
by doing RTRV-FFP-OCn or RTRV-EPG.

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state of the cross connection.

IS-ANR Possible primary states include:
OOS-AU - In-Service, normal (IS-NR)
- In-Service, abnormal (IS-ANR)
- Out-of-Service, autonomous (OOS-AU)

sst SGEO Indicates the secondary state of the cross connection.

RDLD Possible secondary states include:
- supporting entity outage (SGEO)
- red-lined (RDLD)

Example 1
RTRV-CRS-STS1:CORIANT1:STS1-20-11-1-6,STS1-20-11-11-150:AM0077;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0077 COMPLD

"STS1-20-11-1-6,STS1-20-11-11-150:2WAY:CKTID="RBOC23",
SRC_PROT_STATUS=NOREQ,NPOWNER=2:IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-CRS-STSn
ED-CRS-STSn
ENT-CRS-STSn

76.MTFP50/30, Rev B January 2018 Page 30-999

22. Retrieve Commands TL1 Command Reference Manual

RTRV-DA

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-DA command instructs the network element (NE) to retrieve the parameters for the Discovery Agent
(DA).

Restrictions and Exceptions

None.

Command Format
RTRV-DA:[tid]:{<DA_aid>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<DA_aid>:: DADCNIF=<DcnTL>,MGMTDOM=<mgtDomain>:<pst>"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.27 RTRV-DA Parameters

Parameter Value(s) Definition
DA_aid DA-1 EntityID-DAID

DcnTL TL-1-[1-512]-[1-1500] Identifies the IP or SINTF-1 TL to be used for sending and

receiving Discovery PDUs.

mgtDomain A double quoted string consisting of 0 Specifies the Management Domain Name.
to 30 printable characters, not Refer to section 2 for the applicable characters. If not provided
including the quotes. the empty string is used.

pst IS-NR Indicates the primary state of the Discovery Agent

OOS-MA
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- MA: management

Example
RTRV-DA:CORIANT1:DA-1:AM0011;

Page 30-1000 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT1 06-05-15 02:09:11

M AM0011 COMPLD

"DA-1:: DADCNIF=TL-1-1-1,MGMTDOM=\"USEast\":IS-NR"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-DA
ED-DA
ENT-DA

76.MTFP50/30, Rev B January 2018 Page 30-1001

22. Retrieve Commands TL1 Command Reference Manual

RTRV-DB

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-DB command instructs the network element (NE) to retrieve the attributes of the NE database.

Command Format
RTRV-DB:[tid]:[<db_aid>]:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<db_aid>::VEND=<vendor>,DBTYPE=<product>,DBVER=<software_ver>,LASTUPDATE=<la
st_update>,LASTBACKUP=<last_backup>,LOCALBKUP=<local_backup>:<pst>,[<sst>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.28 RTRV-DB Parameters

Parameter Value(s) Definition
db_aid DB-1 EntityID-DBID

vendor CORIANT Indicates the vendor name of this NE.

product MTERA Indicates the network element family this database belongs to.
MTERA8

software_ver One to 11 alphanumeric characters. Indicates the software version that created this NE database.
Following the format FP<x>.<y>.<z>[F<p>], where <x>.<y>.<z>
is the feature package values and F<p> is the patch value. <x>
& <p> are double digit values, <y> & <z> are single digit values.

last_update yyyy-mm-dd-hh-mm-ss Indicates the date at which the NE database was saved in flash.

last_backup yyyy-mm-dd-hh-mm-ss or NONE. Indicates the date at which the NE database was last backup on
a remote server (via manual backup using COPY-RFILE or via
schedule backup using SCHED-BACKUPMEM.
NONE is used when no remote backup has been performed.

local_backup yyyy-mm-dd-hh-mm-ss or NONE. Identies whether a local backup is present based on the last
backup (using COPY-RFILE or SCHED-BACKUP-MEM) with
the values:
<yyyy-mm-dd>-<hh-mm-ss> - date of the local database backup
NONE - no local database backup exists

Page 30-1002 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.28 RTRV-DB Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of the
OOS-AU database.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous and management

sst FLT Indicates the secondary state of the database.

SDEA - FLT: fault
- SDEA: supported entity absent

Example
RTRV-DB:CORIANT1::AM0209;

Possible System Response

CORIANT1 14-09-15 14:20:21

M AM0209 COMPLD

"DB-1::VEND=CORIANT,DBTYPE=METRA,DBVER=FP10.0,LASTUPDATE=2014-09-15-13-50-
10,LASTBACKUP=2014-09-15-01-00-00,LOCALBKUP=2014-09-15-01-00-30:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-DB
ED-DB

76.MTFP50/30, Rev B January 2018 Page 30-1003

22. Retrieve Commands TL1 Command Reference Manual

RTRV-DGNCP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-DGNCP command instructs the network element (NE) to diagnose misconfiguration of CP entities. The
diagnostic result contains the output of following checks:
• Checks if links exist in the TE database.

• Checks for duplicate links in the TE database.

• Checks for protection attribute mismatches in links in the TE database.

• Checks for correct link pairing in the TE database.

• Checks for resource availability for links in the TE database.

• Checks for validity of area ids in the local CP configuration.

• Checks for validity of area ids associated with links in the local CP configuration.

• Checks for valid costs for links in the local CP configuration.

• Checks for existences of nodes for links.

• Checks for missing and incorrect configuration of abstract node RPs

• Checks for dangling resources which are owned by CP but not associated with any call.

The content of diagnostic result is composed of free format strings.

Command Format
RTRV-DGNCP:[tid]::ctag;

Proper System Responses

^^^<header>
M^^<ctag>^COMPLD<cr><lf>
/*<cr><lf>
( <content of diagnostic result> ) +
*/<cr><lf>
;

+ indicates that more that one line may be displayed

Example
RTRV-DGNCP:::las;

Page 30-1004 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT1 10-07-31 15:37:55
M las COMPLD
/*
*** Link 10.1.1.102/0.142.16.0 to 10.13.1.101/0.130.64.0 - no mate found.
*** Link 10.2.1.102/0.142.32.0 to 10.13.1.101/0.138.32.0 - no mate found.
*** Link 10.2.1.102/0.142.48.0 to 10.12.1.101/0.152.16.0 - no mate found.
*** Resource VC4-3-11-3-1 - dangling resource.
*/
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None.

76.MTFP50/30, Rev B January 2018 Page 30-1005

22. Retrieve Commands TL1 Command Reference Manual

RTRV-DHCP

Command Changes Since Previous Feature Package

• None

Description
The RTRV-DHCP command instructs the network element (NE) to retrieve the attributes of the DHCP server
functionality on PGNEs in configurations with SPM module.

The RTRV-DHCP command also instructs the network element (NE) to retrieve the alarm profile table of the DHCP
client functionality on PRNEs. Refer to RTRV-NET for information the DHCP client IP address.

The RTRV-DHCP command is also used to retrieve the L2 DHCP Relay Option 82 attributes on the Port-shelf with
Packet Subsystem.

The RTRV-DHCP command is also used to retrieve the DHCP Option 82 attribute and DHCP Server IP address of
the FlatIP DHCP Relay Agent. The FlatIP DHCP relay agent AID is DHCPRELAY-99.

Restrictions
• DHCPSRVRADDR can only be retrieved on DHCPRELAY-99.

Command Format
RTRV-DHCP:[tid]:{<dhcp_aid|ALL}:ctag;

Proper System Response for DHCP client

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<dhcp_aid>::HWID=<hardware_address>,ALMPF=<almProfile>:<pst>"<cr><lf>
;

Proper System Response for DHCP server

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<dhcp_aid>::DHCPSRVR=<dhcpSrvr>,MINADD=<minIPAddr>,MAXADD=<maxIPAddr>,ALMPF=
<almProfile>:<pst>"<cr><lf>
;

Proper System Response for DHCP Relay

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<dhcp_aid>::OPT82=<option82>,DHCPSRVRADDR=<dhcpserver_address>:<pst>"<cr><lf
>
;

Page 30-1006 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.29 RTRV-DHCP Parameters

Parameter Value(s) Definition
dhcp_aid DHCPRELAY-[1-13,99] EntityID-DHCPID

hardware_add 8 bytes Hex value. Identifies the hardware address.

ress

almProfile 0-20, 99 Specifies the new alarm profile table for the DHCP server or
client.

pst IS-NR Indicates the primary state of the DHCP server.

OOS-MA
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- MA: management

dhcpSrvr ENABLED Specifies whether DHCP server is enabled or disabled.

DISABLED Not applicable for DHCP clients.

minIPAddr Possible values are: IP address. Specifies the minimum IP address values that can be assigned
IPaddress = 10.0.yyy.zzz Where: by the DHCP server.
yyy=1 for PGNE-1 and 2 for PGNE-2, Applies only to DHCP Server.
zzz = 2-127 Not applicable for DHCP clients.

maxIPAddr Possible values are: IP address. Specifies the maximum IP address that can be assigned by the
IPaddress = 10.0.yyy.zzz Where: DHCP server.
yyy=1 for PGNE-1 and 2 for PGNE-2, Applies only to DHCP Server.
zzz = 3-128 Not applicable for DHCP clients.

option82 ENABLED - ENABLED: Enables L2 DHCP Option 82 Relay functionality on

DISABLED the specific port shelf.
- DISABLED: Disables L2 DHCP Option 82 Relay functionality
on the specific port shelf.

dhcpserver_ad [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the DHCP server.

dress

Example
DHCP server example:
RTRV-DHCP:CORIANT1:DHCPSERVER-1:ctag;

DHCP client example:

RTRV-DHCP:CORIANT1:DHCPCLIENT-1:ctag;

DHCP Relay example:

RTRV-DHCP:CORIANT1:DHCPRELAY-2:ctag;

Possible System Response

Possible response for DHCP server:
CORIANT1 02-02-02 03:20:21

76.MTFP50/30, Rev B January 2018 Page 30-1007

22. Retrieve Commands TL1 Command Reference Manual

M AM0209 COMPLD

"DHCPSERVER-1::DHCPSRVR=ENABLED,MINADD=10.0.1.3,MAXADD=10.0.1.125,ALMPF=1:IS-NR"
;

Possible response for DHCP client:

CORIANT1 02-02-02 03:20:21

M AM0209 COMPLD

"DHCPCLIENT-1::HWID=xxx,ALMPF=1:IS-NR"
;

Possible response for DHCP Relay::

CORIANT1 02-02-02 03:20:21

M AM0209 COMPLD

"DHCPRELAY-2::OPT82=ENABLED"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-DHCP
ED-NET
RTRV-NET

Page 30-1008 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-DISP-OCH

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

Description
The RTRV-DISP-OCH command instructs the network element (NE) to retrieve the amount of Chromatic Dispersion
(CD) and Differential Group Delay (DGD) that is present on a 100G DWDM (OCH-P or OCH-OS), 200G DWDM
interface (OCH-OS), or 2 x 150G DWDM interface (300G using 2 x OCH-OS).

Restrictions and Exceptions

• This command applies to OCH-P supported by OSM-2C module.

• This command applies to OCH-OS supported by OSM-4C/OSM-4F module.

Command Format
RTRV-DISP-OCH:[tid]:{<och_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<och_aid>::CD=<cd>,DGD=<dgd>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.30 RTRV-DISP-OCH Parameters

Parameter Value(s) Definition
och-os_aid OCH-OS-20-[1-16]-[1-4] EntityID-Type-ShelfID-SlotID-PortID
OCH-P-[20,1-15]-[1-18]-[1-2]

cd Possible values are: (1)Number Indicates the residual Chromatic Dispersion present at the
ranging from -50000 to +50000 pico- receiver in pico-seconds/nanometer (ps/nm).
seconds/nanometers (ps/nm) in 1 ps/
nm increments. (2)NA if the module
can not provide this value.

dgd Possible values are: (1)Number Indicates the Differential Group Delay value in pico-seconds,
ranging from 0 to 100 pico-seconds in with 1 ps increments.
1 ps increments. (2)NA if the module is
not equipped with Polarization Mode
Dispersion Compensation module.

Example
RTRV-DISP-OCH:CORIANT1:OCH-P-20-1-1:AM0102;

76.MTFP50/30, Rev B January 2018 Page 30-1009

22. Retrieve Commands TL1 Command Reference Manual

Possible System Response

In this case there is -10000 ps/nm chromatic dispersion and 50 ps of instantaneous DGD for a 100G OCH-P.
CORIANT1 14-12-02 00:50:03
M AM0102 COMPLD
"OCH-P-20-1-1::CD=(-10000),DGD=50"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

Page 30-1010 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ENGIDMAP

Command Changes Since Previous Feature Package

• None

Description
The RTRV-ENGIDMAP command instructs the network element (NE) to retrieve the engine ID of the SNMP agent
running in each of the shelves in the NE.

Command Format
RTRV-ENGIDMAP:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"::SHELFNO=<ShelfNumber>,ENGINEID=<EngineId>"*<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.31 RTRV-ENGIDMAP Parameters

Parameter Value(s) Definition
ShelfNumber 20 Indicates the Port Shelf Number.

EngineId Is a string of length 8 to 32 characters, Specifies the EngineId for the SNMP agent running on the port
inclusive. shelf.
Refer to section 2 for the applicable characters.

Example
RTRV-ENGIDMAP:CORIANT1::AM0102;

Possible System Response if there is 1 mTera shelf

^^^CORIANT1 03-12-10 00:50:03

M AM0102 COMPLD

^^^"::SHELFNO=20,ENGINEID=\"SN1234567[01]\" "

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-EQPT
RTRV-INV

76.MTFP50/30, Rev B January 2018 Page 30-1011

22. Retrieve Commands TL1 Command Reference Manual

RTRV-EPG

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-EPG command instructs the network element (NE) to retrieve the attributes of an equipment protection
group (EPG) for adaption traffic in the case of single point failure on equipment level. The adaption include SONET/
SDH clients to OTN adaption and EOS (Ethernet Over SONET/SDH) adaption.

Restrictions and Exceptions

• Either "working AID", "working AID, Protection AID", "ALL", "ALL,ALL", "working AID,ALL", or
"ALL,protection AID" can be used for specifying the facilities involved in the protection group.

Command Format
RTRV-EPG:[tid]:{<protectedModule>|ALL}{,<protectingModule>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^"<protectedModule>,<protectingModule>:::<pst>,[<sst>]"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.32 RTRV-EPG Parameters

Parameter Value(s) Definition
protectedModu SSM2S-20-[1-16] EntityID-ShelfID-SlotID
le

protectingMod SSM2S-20-[1-16] EntityID-ShelfID-SlotID

ule

pst IS-NR Indicates the primary state and primary state qualifier of a
module.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

Page 30-1012 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.32 RTRV-EPG Parameters (Continued)

Parameter Value(s) Definition
sst NOREQ Indicates the secondary state of the 1+1 EPG Protection Group.
DNR - no request (NOREQ)
MANTOPROT - do not revert (DNR)
MANTOWKG - manual switch to protection (MANTOPROT)
FSTOPROT - manual switch to working (MANTOWKG)
FSTOWKG - force switch to protection (FSTOPROT)
LOCKOUT - force switch to working (FSTOWKG)
SFONWKG - lockout of protection (LOCKOUT)
SFONPROT - signal fail on working (SFONWKG)
- signal fail on protection (SFONPROT)

Example
RTRV-EPG:CORIANT1:SSM2S-20-1:CTAG-1;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

^^^SSM2S-20-1,SSM2S-20-3:::ISNR,NOREQ

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EPG
ENT-EPG

76.MTFP50/30, Rev B January 2018 Page 30-1013

22. Retrieve Commands TL1 Command Reference Manual

RTRV-EQPT

Command Changes Since Previous Feature Package

• Added PWS, CD4D8

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-EQPT::{x} command instructs the network element (NE) to retrieve the user provisionable attributes of
equipment entity.

Restrictions and Exceptions

• When ALL is used as an AID, information for all EQPT entities that matches the specified filtering
parameter(s) is retrieved.

• The SHOWSLOT should always be set to YES to display the equipment in each slot.

• The SHOWSUBSLOT should always be set to YES to display the equipment in each subslot of a slot.

• The SHOWSLOT and SHOWSUBSLOT parameters are implied to be set to YES when the "ALL" AID
is used.

• The command is denied if SHOWSLOT is set to YES for a subslot AID.

Command Format
RTRV-
EQPT:[tid]:{<eqpt_aid>|ALL}:ctag:::[ALMPF=<almProfile>][,SHOWSLOT=<showslot>][,S
HOWSUBSLOT=<showsubslot>][,OTN_MAP_GROUP=<OTN_Map_Group>][,EOS_MAP_GROUP=<EOS_Ma
p_Group>][:[<editablePrimaryState>][,<secondaryState>]];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<eqpt_aid>::[CPTYPE=<cp_type>],[CPNAME=<CPName>][,SHELFTYPE=<shelf_type>][,S
HELFNAME=<ShelfName>][,FABRIC=<ShelfFabric>][,CHANRANGE=<ChannelRange>][,MOUNT=<
shelf_mount>][,EXTATTN=<ExternalAttenuator>][,LENGTH=<dcm_fiberLength>][,FIBER=<
dcm_fiberType>][,IL=<dcm_insertionLoss>][,OTN_MAP_GROUP=<OTN_Map_Group>][,EOS_MA
P_GROUP=<EOS_Map_Group>][,DISPCOMPRL=<dispcomprl>][,DISPCOMPRH=<dispcomprh>][,CO
MMCONN=<comm_connection>],ALMPF=<almProfile>:<pst>,[<sst>]"<cr><lf>;

Page 30-1014 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.33 Parameter Applicability When Retrieving the Entity

BFM/FAN/FAN8/OCC/CDCP/CD4D8

SAIM/SDM/SEIM/SFM/SIOM/STIM
OSM1S/OSM1S/OSM2S/OSM4C/

MFAB/MFAB2/STPM/STPM8/
OSM4F/OSM4S/OSM5C
SFP/SFPP/CFP/CFP2

OADMRS/OADMRS9
SSM2S

OMD
PWS

DCM
FSM
1

SH
PARAMETER DEF
ALMPF ND X X X X X X X X X X X

CPTYPE ND X X X X X X X X X

CPNAME ND X X X X X X X X X

SHELFTYPE ND X X

SHELFNAME ND X X

COMMCONN ND X

MOUNT ND X
FABRIC ND X
CHANRANGE ND X X

EXTATTN ND X

LENGTH ND X

FIBER ND X

IL ND X

SHOWSLOT3 ND X X X X X X X X X X
3
SHOWSUBSLOT ND X X X X X X X X X X

OTN_MAP_GROUP ND X

EOS_MAP_GROUP ND X

DISPCOMPRL ND X
2

DISPCOMPRH ND X
2

PST PD X X X X X X X X X X X

SST PD X X X X X X X X X X X

1. ND: Name Defined or PD: Position Defined, in the input command.

2. Applies to CFP only.
3. Parameter is input only.

76.MTFP50/30, Rev B January 2018 Page 30-1015

22. Retrieve Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.34 RTRV-EQPT Parameters

Parameter Value(s) Definition
eqpt_aid BFM-20-[1-16] EntityID-ShelfID-SlotID
CD4D8-[50-58]-[2-4,6-8]
CDCP-20-[10-16,1-7]-[1-3]
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
DCM-20-[1-16]-[1-3]
FAN-20-[29-32]
FAN8-20-[16,17]
FSM-20-[35,34]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
MFM-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OMD-20-[1-16]-[1-2]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
PWS-[50-58]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SFM-20-[26-28,21-23]
SFP-20-[1-16]-[1-32]
SFPP-20-[1-16]-[1-20]
SH-20
SIOM-20-15
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

almProfile 0-20, 99 Indicates the alarm profile table for the equipment.

showslot YES Indicates if the response should include equipment in the slots
NO associated with a particular shelf.
Default: NO
Implied default YES for "ALL" AID

showsubslot YES Indicates if the response should include equipment in the

NO sublsots associated with a particular module.
Default: NO denies if SHOWSUBSLOT is requested and SHOWSLOT is not.

Implied default YES for "ALL" AID

Page 30-1016 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.34 RTRV-EQPT Parameters (Continued)

Parameter Value(s) Definition
OTN_Map_Gr [0-3] Retrieve values identifying which port groups were used within
oup the supporting SSM-2S module to do OTN adaption. The
granularity is 20G, which means when a port group is selected it
reserves 20G ODU mapping capacity. 1 means 1st port group
selected, 2 means 2nd port group selected, 3 means 3rd port
group selected, 1&2&3 means all the three port groups selected
and on a SSM-2S module it could support 60G OTN mapping. 0
means non port group is selected so no resource reserved for
OTN mapping.

Use & for grouping.

Use && for ranging.

EOS_Map_Gr [0-3] Retrieve values identifying which port groups is used within the
oup supporting module to do EoS adaption. The granularity is 10G,
which means when a port group is selected it reserves 10G
Ethernet over SONET/SDH mapping capacity. 1 means 1st port
group selected, 2 means 2nd port group selected, 3 means 3rd
port group selected, 1&2&3 means all the three port groups
selected and on a SSM-2S module it could support 30G EOS
mapping.0 means non port group is selected so no resource
reserved for EOS mapping.

Use & for grouping.

Use && for ranging.

editablePrimar IS Indicates the primary state of a module.

yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

76.MTFP50/30, Rev B January 2018 Page 30-1017

22. Retrieve Commands TL1 Command Reference Manual

Table 22.34 RTRV-EQPT Parameters (Continued)

Parameter Value(s) Definition
cp_type BLANK FILLER MODULE Indicates the type of the equipment.
SMALL FORM PLUGGABLE
MODULE
SMALL FORM PLUGGABLE PLUS
MODULE
COMPACT FORM PLUGGABLE
MODULE
COMPACT FORM PLUGGABLE
MODULE 2
CDC8D6 - 8D PLUGGABLE CDC
MODULE - 6 ADD/DROP PORTS
DISPERSION COMPENSATION
MODULE
MTERA FIBER SHUFFLE - MAIN
OADMRS20 - OPTICAL ADD DROP
OADMRS9 - OPTICAL ADD DROP
MULTIPLEXER ROUTE AND
SELECT - 9 PORTS
OCC - OPTICAL CARRIER CARD
OPTICAL MULTIPLEXER/
DEMULTIPLEXER
OSM2C - OTN SWITCHING MODULE
2 (CFP)
OSM2S - OTN SWITCHING MODULE
2 (SFP+)
OSM1S - OTN SWITCHING MODULE
1 (SFP)
FAN MODULE
FAN MODULE - MTERA8
MTERA FABRIC MODULE
MTERA FABRIC MODULE-2ND GEN
MTERA FABRIC FILLER MODULE
SHELF IO FILLER MODULE
SHELF ALARM INTERFACE
MODULE
SHELF DISPLAY MODULE
SHELF ETHERNET INTERFACE
MODULE
SHELF TIMING INTERFACE
MODULE
SHELF INPUT OUTPUT MODULE
SYSTEM TIMING AND PROCESSOR
MODULE
SYSTEM TIMING AND PROCESSOR
MODULE - MTERA8
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
CD4D8 - COLORLESS
DIRECTIONLESS 4 DEGREES 8
ADD DROP

CPName Is a string of length 0 to 47 characters. Indicates an additional field to identify the module.
Refer to section 2 for the applicable characters.

Page 30-1018 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.34 RTRV-EQPT Parameters (Continued)

Parameter Value(s) Definition
shelf_type MTERA Indicates the type of the shelf.
MTERA8
PASSIVE WDM SHELF

ShelfName Is a string of length 0 to 47 characters. Indicates an additional field to identify the shelf.

Refer to section 2 for the applicable characters.

ChannelRange 48S Indicates the type of OMD based on the channel range.
48O - 1_44 = OMD44 supporting channels 1 through 44
1_44 - 45_88 = OMD44 supporting channels 45 through 88.
45_88

shelf_mount HRZ Indicates how a shelf is physically oriented/mounted.

VRT HRZ = Horizontal
VRT = Vertical

ExternalAttenu [0-20] Indicates the value of any external attenuator that is connected
ator to the input of an input amplifier.

dcm_fiberLeng 0 Indicates the length of fiber supported by a particular DCM in

th 10 units of km.
20
30 The maximum value for dcm fiber length is 120 (km) for fiber
40 type LEAF, or 150 (km) for fiber types SMF28 and TWAVERS.
50
60
70
80
90
100
110
120
130
140
150

dcm_fiberType SMF28 Indicates the type of fiber supported by a particular DCM.

TWAVERS SMF28: SMF-28 Fiber
LEAF TWAVERS: TrueWave RS Fiber
POSITIVE LEAF: Leaf Fiber
POSITIVE: Positive dispersion compensation (not an actual
fiber type).

dcm_insertion [0.0-7.5] Indicates the actual insertion loss through a particular DCM.
Loss

dispcomprl AUTO, -40000 to +39000 Specifies the low end of the range for the chromatic dispersion
picoseconds/nanometer (ps/nm) in 1 search.
ps/nm increments.
When set to AUTO for the CFP parts 81.71T-CDWDMS-R6 and
82.71T-CDWDMS-R6, the low end of the range for the
chromatic dispersion search is set to -40000 picoseconds/
nanometer (ps/nm)

76.MTFP50/30, Rev B January 2018 Page 30-1019

22. Retrieve Commands TL1 Command Reference Manual

Table 22.34 RTRV-EQPT Parameters (Continued)

Parameter Value(s) Definition
dispcomprh AUTO, -39000 to +40000 Specifies the high end of the range for the chromatic dispersion
picoseconds/nanometer (ps/nm) in 1 search.
ps/nm increments.
When set to AUTO for the CFP parts 81.71T-CDWDMS-R6 and
82.71T-CDWDMS-R6, the high end of the range for the
chromatic dispersion search is set to +40000 picoseconds/
nanometer (ps/nm)

pst IS-NR Indicates the primary state and primary state qualifier of a
IS-ANR module.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA The PSTQ is only supported in the command response.
OOS-AUMA Possible values for PSTQ:
OOS-AURST - NR: normal
OOS-MAANR - ANR: abnormal
- RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

secondaryStat ACTIVE Indicates the secondary state of a module.

e/sst APR - ACTIVE: active
DGN - APR: automatic power reduction (amplifiers disabled)
FLT - DGN: diagnostic
MEA - FLT: fault
MT - MEA: mismatch of equipment and attributes
NALMQI - MT: maintenance
PMI - NALMQI: Not alarmed qualified inhibit
PWR - PMI: performance monitoring inhibited
SHTDWN - PWR: power
STBY - SHTDWN: shutdown
SWDL - STBY: standby
TMGMASTER - SWDL: software download
TMGSLAVE - TMGMASTER: Master Timing Source
UEQ - TMGSLAVE: Slave Timing Source
- UEQ: unequipped

shelfFabric NONE Indicates the composition of the fabric.

PARTIAL
MFAB
MFAB2

The following table shows the wavelength/frequency associated with each channel and half-band in a mTera UTP:

Table 22.35 96-Channel Plan, Wavelength/ChannelId Association

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
90 191.4 1566.314 89 191.35 1566.723

92 191.5 1565.496 91 191.45 1565.905

Page 30-1020 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.35 96-Channel Plan, Wavelength/ChannelId Association (Continued)

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
94 191.6 1564.679 93 191.55 1565.087

1 191.7 1563.863 95 191.65 1564.271

2 191.8 1563.047 45 191.75 1563.455

3 191.9 1562.233 46 191.85 1562.64

4 192 1561.419 47 191.95 1561.826

5 192.1 1560.606 48 192.05 1561.013

6 192.2 1559.794 49 192.15 1560.2

7 192.3 1558.983 50 192.25 1559.389

8 192.4 1558.173 51 192.35 1558.578

9 192.5 1557.364 52 192.45 1557.768

10 192.6 1556.555 53 192.55 1556.959

11 192.7 1555.747 54 192.65 1556.151

12 192.8 1554.94 55 192.75 1555.344

13 192.9 1554.134 56 192.85 1554.537

14 193 1553.329 57 192.95 1553.732

15 193.1 1552.525 58 193.05 1552.927

16 193.2 1551.721 59 193.15 1552.123

17 193.3 1550.918 60 193.25 1551.32

18 193.4 1550.116 61 193.35 1550.517

19 193.5 1549.315 62 193.45 1549.716

20 193.6 1548.515 63 193.55 1548.915

21 193.7 1547.716 64 193.65 1548.115

22 193.8 1546.917 65 193.75 1547.316

23 193.9 1546.119 66 193.85 1546.518

24 194 1545.322 67 193.95 1545.721

25 194.1 1544.526 68 194.05 1544.924

26 194.2 1543.731 69 194.15 1544.128

27 194.3 1542.936 70 194.25 1543.333

28 194.4 1542.142 71 194.35 1542.539

29 194.5 1541.35 72 194.45 1541.746

30 194.6 1540.558 73 194.55 1540.953

31 194.7 1539.766 74 194.65 1540.162

32 194.8 1538.976 75 194.75 1539.371

76.MTFP50/30, Rev B January 2018 Page 30-1021

22. Retrieve Commands TL1 Command Reference Manual

Table 22.35 96-Channel Plan, Wavelength/ChannelId Association (Continued)

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
33 194.9 1538.186 76 194.85 1538.581

34 195 1537.397 77 194.95 1537.792

35 195.1 1536.609 78 195.05 1537.003

36 195.2 1535.822 79 195.15 1536.216

37 195.3 1535.036 80 195.25 1535.429

38 195.4 1534.25 81 195.35 1534.643

39 195.5 1533.465 82 195.45 1533.858

40 195.6 1532.681 83 195.55 1533.073

41 195.7 1531.898 84 195.65 1532.29

42 195.8 1531.116 85 195.75 1531.507

43 195.9 1530.334 86 195.85 1530.725

44 196 1529.554 87 195.95 1529.944

96 196.1 1528.773 88 196.05 1529.163

Example
Possible Command and System Response for a mTera Shelf
RTRV-EQPT:CORIANT1:SH-20:CT0102;

^^^CORIANT1 15-02-02 00:50:03

M CT0102 COMPLD

^^^""SH-20::SHELFTYPE=MTERA,SHELFNAME=\"MTERA SHELF
CHICAGO\",MOUNT=HRZ,FABRIC=MFAB,ALMPF=99,:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EQPT-{X}
ED-EQPT-{X}
ENT-EQPT-{X}
RTRV-INV-{X}

Page 30-1022 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ETH

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-ETH command instructs the network element (NE) to retrieve the attributes of a selected Ethernet facility
entity.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• When ALL is used as an AID, information for all ETH entities that matches the specified filtering
parameter(s) is retrieved.

• The ETH facility on mTera has no state information. And it's managed by packet subsystem.

Command Format
RTRV-ETH:[tid]:{<fac_aid>|ALL}:ctag:::[ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.36 RTRV-ETH Parameters

Parameter Value(s) Definition
fac_aid ETH-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID

Example on mTera
RTRV-ETH::ALL:myctag;

Possible System Response

MTERA 05-05-14 11:44:21

M MYCTAG COMPLD

"ETH-20-1-1"

76.MTFP50/30, Rev B January 2018 Page 30-1023

22. Retrieve Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None.

Page 30-1024 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-EXDPATH

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-EXDPATH command instructs the NE Control Plane to retrieve one or all excluded path(s) and display
the corresponding excluded path route elements.

Restrictions and Exceptions

• Maximum 36 excluded path route elements are supported per excluded path object, the total characters
added by the excluded path route elements cannot exceed 1692 chars, these limitations apply to
ROUTE parameter.

Command Format
RTRV-EXDPATH:[tid]:{<EXDP_aid>|ALL}:ctag::;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<EXDP_aid>::EXDPATHNAME=<EXDPathName>,ROUTE=<xRouteElements>"
<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.37 RTRV-EXDPATH Parameters

Parameter Value(s) Definition
EXDP_aid EXDPATH-[1,3]-[1-512] EntityID-NPID-PathID

EXDPathNam 0 to 31 alphanumeric characters. Specifies the string name of excluded path.

e
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1025

22. Retrieve Commands TL1 Command Reference Manual

Table 22.37 RTRV-EXDPATH Parameters (Continued)

Parameter Value(s) Definition
xrouteElement Contains a list of excluded path route Specifies the excluded path route elements that form the
s element that are separated by comma. excluded path in a specific format.
A excluded path route element is
inform of (S|L)-areaID-nodeID[- Maximum 36 excluded path route elements are supported per
IfIndex]. IfIndex is 8 hexadecimal excluded path object.
digits. Maximum 1692 chars are allowed for the total characters added
by the excluded path route elements.

S means the excluded path route element(s) is(are) strict. It

says that the route elements specified MUST be excluded;
L means the excluded path route element(s) is(are) loose. It
says that the route elements specified SHOULD be avoided.
L and S must be explicitly input.

Two forms of excluded path route element:

(S|L)-areaID-nodeID: L-1.1.1.10-123.224.187.198
(S|L)-areaID-nodeID-Ifindex: S-1.1.1.10-123.224.187.198-
040FAA0C

Example
Retrieve one excluded path:

RTRV-EXDPATH:CORIANT1:EXDPATH-3-1:AM0011;

Retrieve all excluded path:

RTRV-EXDPATH:CORIANT1:ALL:AM0011;

Possible System Response

Retrieve one excluded path result:

^^^CORIANT1 06-05-15 02:08:15

M AM0011 COMPLD
"EXDPATH-3-1::EXDPATHNAME=\"WKGEXDPATH-1\",ROUTE=\"S-111.0.10.0-020FAA01,S-
111.0.0.110-030FBB02, S-111.0.0.111-040FBB03\""
;

Retrieve all excluded path result:

^^^CORIANT1 08-03-15 02:08:15

M AM0011 COMPLD
"EXDPATH-3-1::EXDPATHNAME=\"WKGEXDPATH-1\",ROUTE=\"S-111.0.10.0-020FAA01,S-
111.0.0.110-030FBB02, S-111.0.0.111-040FBB03\""
"EXDPATH-3-2::EXDPATHNAME=\"WKGEXDPATH-2\",ROUTE=\"S-111.0.110.0-020FAA01,S-
111.100.0.110-030FAA02, S-111.0.20.111-040FAA03\""
"EXDPATH-3-5::EXDPATHNAME=\"WKGEXDPATH-5\",ROUTE=\"S-111.0.120.0-020FAA01,S-
111.110.0.110-030FAA02, S-111.0.20.121-0010000280000000\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-1026 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Related Commands
DLT-EXDPATH
ED-EXDPATH
ENT-EXDPATH

76.MTFP50/30, Rev B January 2018 Page 30-1027

22. Retrieve Commands TL1 Command Reference Manual

RTRV-EXPPATH

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-EXPPATH command instructs the NE Control Plane to retrieve one or all explicit path(s) and display the
corresponding route elements.

Figure 22.5 Explicit Path Examples

Z Destination Node
Source Node
A

Fully explicit route Partial explicit route

Restrictions and Exceptions

• Maximum 36 route elements are supported per explicit path object, the total characters added by the
explicit path's route elements cannot exceed 1692 chars, these limitations apply to ROUTE parameter.

Command Format
RTRV-EXPPATH:[tid]:{<expp_aid>|ALL}:ctag::;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<expp_aid>::EXPPATHNAME=<ExpPathName>,ROUTE=<RouteElements>"
<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1028 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.38 RTRV-EXPPATH Parameters

Parameter Value(s) Definition
expp_aid EXPPATH-[1,3]-[1-512] EntityID-NPID-PathID

exppathName 0 to 31 alphanumeric characters. Specifies the string name of explicit pth.

It has to be unique for the given NE.
Refer to section 2 for the applicable characters.

routeElements Contains a list of route element that Specifies the route elements that form he explicit path in a
are separated by comma. A route specific format.
element is inform of (S|L)-nodeID- Maximum 36 route elements are supported per explicit path
IfIndex[-Label] (1)IfIndex is 8 object.
hexadecimal digits. (2)Label is 8 Maximum 1692 chars are allowed for the total characters added
hexadecimal digits for non ODUk by the explicit path's route elements.
labels or G.709 V2 ODUk labels; Label
is a multiple of 8 hexadecimal digits for S means the route element(s) is(are) strict.The path between a
G.709 V3 ODUk/j/flex labels. strict route element and its preceding route element MUST
include only network route elements from the strict route
element and its preceding abstract route element.
L means the route element(s) is(are) loose.The path between a
loose route element and its preceding route element MAY
include other network route elements that are not part of the
strict route element or its preceding abstract route element.
Two forms of route element:
(S|L)-Node-Ifindex: L-123.224.187.198-040FAA0C
S-Node-Ifindex-label: S-123.224.187.198-040FAA0C-000A0000

Examples
Retrieve one explicit path:
RTRV-EXPPATH:CORIANT1:EXPPATH-3-1:AM0011;

Retrieve all explicit paths:

RTRV-EXPPATH:CORIANT1:ALL:AM0011;

Possible System Response

Retrieve one explicit path result:

^^^CORIANT1 06-05-15 02:08:15

M AM0011 COMPLD
"EXPPATH-3-1::EXPPATHNAME=\"WORKINGPATH-1\",ROUTE=\"S-111.0.10.0-020FAA01,S-
111.0.0.110-030FBB02, S-111.0.0.111-040FBB03\""
;

Retrieve all explicit paths result:

^^^CORIANT1 08-03-15 02:08:15

M AM0011 COMPLD
"EXPPATH-3-1::EXPPATHNAME=\"WORKINGPATH-1\",ROUTE=\"S-111.0.10.0-020FAA01,S-
111.0.0.110-030FBB02, S-111.0.0.111-040FBB03\""
"EXPPATH-3-2::EXPPATHNAME=\"WORKINGPATH-2\",ROUTE=\"S-111.0.110.0-020FAA01,S-
111.100.0.110-030FAA02, S-111.0.20.111-040FAA03\""
"EXPPATH-3-5::EXPPATHNAME=\"WORKINGPATH-5\",ROUTE=\"S-111.0.120.0-020FAA01,S-
111.110.0.110-030FAA02, S-111.0.20.121-0010000280000000\""
;

76.MTFP50/30, Rev B January 2018 Page 30-1029

22. Retrieve Commands TL1 Command Reference Manual

Retrieve all explicit paths result (includes ODU0 muxed into ODU4 route element):

^^^CORIANT1 08-03-15 02:08:15

M AM0011 COMPLD
"EXPPATH-3-1::EXPPATHNAME=\"WORKINGPATH-1\",ROUTE=\"S-111.0.10.0-020FAA01,S-
111.0.0.110-030FBB02, S-111.0.0.111-040FBB03\""
"EXPPATH-3-2::EXPPATHNAME=\"WORKINGPATH-2\",ROUTE=\"S-111.0.110.0-020FAA01,S-
111.100.0.110-030FAA02, S-111.0.20.111-040FAA03\""
"EXPPATH-3-5::EXPPATHNAME=\"WORKINGPATH-5\",ROUTE=\"S-111.0.120.0-020FAA01,S-
111.110.0.110-030FAA02, S-111.0.20.121-00200050ff0000000000000000000000\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-EXPPATH
ED-EXPPATH
ENT-EXPPATH

Page 30-1030 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-EXT-CONT

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-EXT-CONT command instructs a network element to send the control state of an external contact. The
command can be used to audit the result of an OPR-EXT-CONT or a RLS-EXT-CONT command.

Any NE that has an external contact in effect should include the appropriate condition type information in response
to a RTRV-EXT-CONT request.

Restrictions and Exceptions

Command Format
RTRV-EXT-CONT:[tid]:{<cont_aid>|ALL}:ctag[::<controltype>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<cont_aid>:[<controltype>],<duration>[,<cont_state>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.39 RTRV-EXT-CONT Parameters

Parameter Value(s) Definition
cont_aid CONT-[1-2] EntityID-ContID

76.MTFP50/30, Rev B January 2018 Page 30-1031

22. Retrieve Commands TL1 Command Reference Manual

Table 22.39 RTRV-EXT-CONT Parameters (Continued)

Parameter Value(s) Definition
controltype AIRCOND Specifies the type of contact:
ENGINE - AIRCOND for air conditioning.
FAN - ENGINE for engine.
GEN - FAN for fan.
HEAT - GEN for generator.
LIGHT - HEAT for heat.
MISC - LIGHT for light.
SPKLR - MISC for miscellaneous.
BAMP_1_SHUTDOWN - SPKLR for sprinkler.
BAMP_2_SHUTDOWN - BAMP_x_SHUTDOWN for shutdown of Network Interfaced
BAMP_3_SHUTDOWN Raman number x where x={1-4}.
BAMP_4_SHUTDOWN - CRA_x_SHUTDOWN for shutdown of Network Interfaced
CRA_1_SHUTDOWN Raman number x where x={1-4}.
CRA_2_SHUTDOWN - NIR_x_SHUTDOWN for shutdown of Network Interfaced
CRA_3_SHUTDOWN Raman number x where x={1-4}.
CRA_4_SHUTDOWN
NIR_1_SHUTDOWN
NIR_2_SHUTDOWN
NIR_3_SHUTDOWN
NIR_4_SHUTDOWN

duration CONTS Specifies the duration for which the external contact can be
operated:
- CONTS for continuous duration.

cont_state OPER Indicates the control state of the external contact.

RLS - OPER indicates the specified external contact is operated.
- RLS indicates the specified external contact is released.

Example
RTRV-EXT-CONT:CORIANT1:CONT-1:AM0011::HEAT;

Possible System Response

CORIANT1 02-04-16 02:08:15

M AM0011 COMPLD

"CONT-1:HEAT,CONTS,OPER"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-EXT-CONT
RLS-EXT-CONT

Page 30-1032 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-E1

Command Changes Since Previous Feature Package

• None

Description
Command instructs the network element (NE) to retrieve the attributes of a E1 (2.048 Mb/s) or 2MH(2.048MHz)
facility entity providing an External Synchronization reference.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

Command Format
RTRV-
E1:[tid]:E1_aid:ctag:::[ALMPF=<almProfile>][:<editablePrimaryState>][,<secondary
State>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<{fac_aid}>::CPTYPE=<cp_type>,LINECDE=<LineCode>,FMT=<FrameFormat>,TXREF=<tx
_ref>,RXSSM=<rx_ssm>,TXSSM=<tx_ssm>,
QLOVERRIDE=<qualityLevelOverride>,SABIT=<SaBit>,TERM=<terminationE1>,TXREFSTATUS
=<Txref_status>,ALMPF=<almProfile>,LOOPPRVT=<loopPrevention>:<pst>,[<secondarySt
ate/sst>]"<cr><lf>;

Parameters

Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.40 RTRV-E1 Parameters

Parameter Value(s) Definition
E1_aid 2MH-20-[15,23,26]-[1,2] EntityID-ShelfID-SlotID-PortID
E1-20-[15,23,26]-[1,2]
E1OUT-20-[15,23,26]-[1,2]

almProfile 0-20, 99 Specifies the new alarm profile table for the equipment.

editablePrimar IS Indicates the primary state and primary state qualifier of a

yState OOS module.

cp_type SHELF TIMING INTERFACE Indicates the type of Shelf that this facility is supported on.
MODULE
SHELF INPUT OUTPUT MODULE

LineCode AMI Indicates the line code for a T1 facility.

HDB3 Possible values are High Density Bipolar 3 coding (HDB3) or
Alternate Mark Inverted (AMI)

76.MTFP50/30, Rev B January 2018 Page 30-1033

22. Retrieve Commands TL1 Command Reference Manual

Table 22.40 RTRV-E1 Parameters (Continued)

Parameter Value(s) Definition
FrameFormat NOCRC4 Indicates the digital signal frame format of a E1 facility.
CRC4
UNFRAMED

tx_ref NA, Indicates the derived source signal timing the output
SYNC-20-1, synchronization reference. Applicable only to output
OC3-20-[1-16]-[1-32], synchronization references.
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

rx_ssm PRC Indicates the quality of the clock that is received on the E1 input
SSU-A signal.
SSU-B PRC: Primary Reference Clock, as per G.811.
SEC SSU-A: Timing quality generated by Types I or V slave clock, as
DNU per G.812.
NA SSU-B: Timing quality generated by Types VI slave clock, as
per G.812.
SEC: Ttiming quality generated by a SDH Equipment Clock, as
per G.813 option 1.
DNU: DON'T USE for Synchronization.
STU: Synchronized Traceability Unknown.

tx_ssm PRC Indicates the quality of the clock that is received on the E1
SSU-A output signal.
SSU-B PRC: Primary Reference Clock, as per G.811.
SEC SSU-A: Timing quality generated by Types I or V slave clock, as
DNU per G.812.
NA SSU-B: Timing quality generated by Types VI slave clock, as
per G.812.
SEC: Ttiming quality generated by a SDH Equipment Clock, as
per G.813 option 1.
DNU: DON'T USE for Synchronization.

qualityLevelOv DISABLED Specifies the synchronization signal quality level that is

erride PRC associated with the specified E1 facility instead of the value
SSU-A received in the synchronization status message within the E1
SSU-B signal. This allows to override the quality level that was received
SEC within the E1.
DNU When set to DISABLED, the system uses the quality level
received in the synchronization status message of the E1.

SaBit 4 Specifies which one of the Sa4 to Sa8 bits, is allocated for
5 Synchronization Status Messages.
6
7
8

terminationE1 75 Indicates the terminaton for the E1 facility.

120

Page 30-1034 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.40 RTRV-E1 Parameters (Continued)

Parameter Value(s) Definition
Txref_status Normal Indicates the status of the selected tx reference
SF - Normal: normal
- SF: signal failure. Note: signal failure is a failure of the facility
(such as LOS, LOF or link down and so on) or a failure caused
by system internal transmission (such as loss caused by BP
broken) or a failure caused by out of range frequency offset.

loopPrevention DISABLED Specifies the loop prevention function of the entity.

ENABLED Enable: The SSM of output synchronization is forced to DNU
when the tx_ref is SYNC-20-1 and the SYNC-20-1 source is the
same input synchronization port
Disable: The SSM of output synchronization follows the tx_ref
and squelch result. It does not consider the status of the tx_ref
entity.

pst IS-NR Indicates the primary state and primary state qualifier of a
IS-ANR module.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

secondaryStat ACTTMG Indicates the secondary state of a module.

e/sst FAF - ACTTMG: active synchronization reference
MT - FAF: facility failure
NALMNR - MT: maintenance
NALMCD - NALMQI: Not alarmed qualified inhibit
SGEO - SGEO: supporting entity outage
STBYTMG - STBY: standby synchronization reference

tx_sqlch AIS Indicates output synchronization reference when squelch is

DNU applied. Applicable only to output synchronization references.
SQLCH ²AIS : Force AIS in the output synchronization signal
SSM ²DNU: The SSM of the output synchronization set to DNU, this
parameter is only available when the Frame Format is NOCRC4
or CRC4
²SQLCH: Shutdown the output synchronization signal
²SSM: The SSM function shuts down the output synchronization
signal transmission if the tx-ref signal with a quality that is lower
than the configurable threshold.

ql_min PRC Indicates the QL threshold of the derived source signal timing
SSU-A the output synchronization reference when it is SSM squelch
SSU-B mode. Applicable only to output synchronization references.
SEC
DNU

Example
RTRV-E1:CORIANT1:E1-20-14-1:AM0209;

76.MTFP50/30, Rev B January 2018 Page 30-1035

22. Retrieve Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 15-08-02 03:20:21

M AM0209 COMPLD

"E1-20-14-1::,LINECDE=HDB3,FMT=CRC4,RXSSM=PRC, QLOVERRIDE=DISABLED,SABIT=4,TERM-
120,ALMPF=99:IS-NR,"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-E1
ENT-E1
DLT-{x}

Page 30-1036 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-FFP-HGE

Command Changes Since Previous Feature Package

• Updated for OSM-5C.

Description
The RTRV-FFP-HGE command instructs the network element (NE) to retrieve facility protection information for a
pair of HGE (100GE) facilities.

The following HGE FFP schemes are allowed on an mTera UTP system:
• Y-Cable, using any OSM-2C modules in an mTera shelf.

This command is not applicable to OSM-5C which does not support Y-cable.

Restrictions and Exceptions

• Either "working AID", "working AID, Protection AID", "ALL", "ALL,ALL", "working AID,ALL", or
"ALL,protection AID" can be used for specifying the facilities involved in the protection group.

• Y-cable provisionig applicable only for OSM-2C, the valid PortID of the AID is between [1-2]. If PortID
of [3-5] is entered, the command is denied.

Command Format
RTRV-FFP-HGE:[tid]:{<protectedId>|ALL}{,<protectingId>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<protectedId>,<protectingId>::SCHEME=<scheme>,HOLDOFFPROT=<HoldOffProt>,RVRT
V=<rvrtv>,WTR=<wtr>:<pst>,[<sst>]"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.41 RTRV-FFP-HGE Parameters

Parameter Value(s) Definition
protectedId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

protectingId HGE-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

scheme YCABLE Specifies the protection scheme.

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive.
- NO: not revertive.

76.MTFP50/30, Rev B January 2018 Page 30-1037

22. Retrieve Commands TL1 Command Reference Manual

Table 22.41 RTRV-FFP-HGE Parameters (Continued)

Parameter Value(s) Definition
wtr [300-3600] Wait To Restore. Valid values: 300-3600 seconds. After
expiration of the timer, the working line is restored and a no
request state is transmitted.

pst IS-NR Indicates the primary state and primary state qualifier of a
module.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

sst NOREQ Indicates the secondary state of the 1+1 Protection Group.
DNR - no request (NOREQ)
WTR - do not revert (DNR)
MANTOPROT - wait-to-restore (WTR)
MANTOWKG - manual switch to protection (MANTOPROT)
FSTOPROT - manual switch to working (MANTOWKG)
FSTOWKG - force switch to protection (FSTOPROT)
LOCKOUT - force switch to working (FSTOWKG)
SFONWKG - lockout of protection (LOCKOUT)
SFONPROT - signal degrade on working (SDONWKG)
SDONWKG - signal degrade on protection (SDONPROT)
SDONPROT - signal fail on working (SFONWKG)
- signal fail on protection (SFONPROT)

Example
RTRV-FFP-HGE:CORIANT1:HGE-20-3-1:CTAG-1;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG-1 COMPLD

^^^HGE-20-3-1,HGE-20-14-1::SCHEME=YCABLE,HOLDOFFPROT=0,RVRTV=NO,WTR=300:IS-
NR,NOREQ

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-FFP-HGE
ENT-FFP-HGE

Page 30-1038 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-FFP-OCn{OC3/OC12/OC48/OC192}

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The RTRV-FFP-OCn command instructs the network element (NE) to retrieve the attributes of a facility protection
group for a pair of OCn facilities.

The following OCn FFP are allowed in a mTera UTP:

• OC192 FFP for Y-Cable is supported for OC192 client using any OSM-2S/OSM-4S modules in an
mTera shelf.

• OC3/12/48/192 1+1 APS FFP between two cient interfaces using any SSM-2S modules in an mTera
shelf.

Restrictions and Exceptions

• Either "working AID", "working AID, Protection AID", "ALL", "ALL,ALL", "working AID,ALL", or
"ALL,protection AID" can be used for specifying the facilities involved in the protection group.

• Parameter HOLDOFFPROT apply also for 1+1 APS FFP or Y-Cable protection.

Command Format
RTRV-FFP-OCn:[tid]:{<protectedId>|ALL}{,<protectingId>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<protectedId>,<protectingId>::SCHEME=<scheme>,HOLDOFFPROT=<HoldOffProt>,RVRT
V=<rvrtv>,WTR=<wtr>:<pst>,[<sst>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.42 RTRV-FFP-OCn{OC3/OC12/OC48/OC192/OC768} Parameters

Parameter Value(s) Definition
protectedId OC12-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-{PortID|Vport-n}
OC192-20-[1-16]-[1-40]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-1039

22. Retrieve Commands TL1 Command Reference Manual

Table 22.42 RTRV-FFP-OCn{OC3/OC12/OC48/OC192/OC768} Parameters (Continued)

Parameter Value(s) Definition
protectingId OC12-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-{PortID|Vport-n}
OC192-20-[1-16]-[1-40]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[7-30]
OC48-20-[1-16]-[1-32]

scheme 1P1 Specifies the protection scheme.

YCABLE

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
switch’s back immediately. After expiration of the timer, the
working line is restored and a no request state is transmitted.

300-3600 seconds for Y-CABLE scheme.

pst IS-NR Indicates the primary state and primary state qualifier of a
module.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

sst NOREQ Indicates the secondary state of the 1+1 Protection Group.
DNR - no request (NOREQ)
WTR - do not revert (DNR)
MANTOPROT - wait-to-restore (WTR)
MANTOWKG - manual switch to protection (MANTOPROT)
FSTOPROT - manual switch to working (MANTOWKG)
FSTOWKG - force switch to protection (FSTOPROT)
LOCKOUT - force switch to working (FSTOWKG)
SFONWKG - lockout of protection (LOCKOUT)
SFONPROT - signal fail on working (SFONWKG)
SDONWKG - signal fail on protection (SFONPROT)
SDONPROT - signal degrade on working (SDONWKG)
- signal degrade on protection (SDONPROT)

Example
RTRV-FFP-OC192:CORIANT1:OC192-20-3-6:CTAG-1;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M CTAG-1 COMPLD
^^^OC192-20-3-6,OC192-20-14-6::SCHEME=1P1,HOLDOFFPROT=0,RVRTV=YES,WTR=27:IS-
NR,NOREQ
;

Page 30-1040 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-OCn, ED-FFP-OCn, DLT-FFP-OCn

76.MTFP50/30, Rev B January 2018 Page 30-1041

22. Retrieve Commands TL1 Command Reference Manual

RTRV-FFP-STMn (STM1/STM4/STM16/STM64)

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The RTRV-FFP-STMn command instructs the network element (NE) to retrieve the attributes of a facility protection
group for a pair of STMn facilities.

The following STMn FFP are allowed in an mTera UTP:

• STM64 FFP is supported within a single OSM-2S/OSM-4S, or any two OSM-2S or two OSM-4S over
the whole mTera shelf.

• STM1/4/16/64 1+1 MSP FFP within a single SSM-2S, or any two SSM-2S over the whole mTera shelf.

Restrictions and Exceptions

• Either "working AID", "working AID, Protection AID", "ALL", "ALL,ALL", "working AID,ALL", or
"ALL,protection AID" can be used for specifying the facilities involved in the protection group.

• Parameter HOLDOFFPROT apply also for SSM-2S 1+1 MSP FFP protection.

Command Format
RTRV-FFP-STMn:[tid]:{<protectedId>|ALL}{,<protectingId>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<protectedId>,<protectingId>::SCHEME=<scheme>,HOLDOFFPROT=<HoldOffProt>,RVRT
V=<rvrtv>,WTR=<wtr>:<pst>,[<sst>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.43 RTRV-FFP-STMn (STM1/STM4/STM16/STM64/STM256) Parameters

Parameter Value(s) Definition
protectedId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID
STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

protectingId STM1-20-[1-16]-[7-30] EntityID-ShelfID-SlotID-PortID

STM16-20-[1-16]-[1-32]
STM4-20-[1-16]-[7-30]
STM64-20-[1-16]-[1-40]

scheme 1P1 Specifies the protection scheme.

YCABLE

Page 30-1042 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.43 RTRV-FFP-STMn (STM1/STM4/STM16/STM64/STM256) Parameters (Continued)

Parameter Value(s) Definition
HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
switch’s back immediately. After expiration of the timer, the
working line is restored and a no request state is transmitted.

300-3600 seconds for Y-CABLE scheme.

pst IS-NR Indicates the primary state and primary state qualifier of a
module.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

sst NOREQ Indicates the secondary state of the 1+1 Protection Group.
DNR - no request (NOREQ)
WTR - do not revert (DNR)
MANTOPROT - wait-to-restore (WTR)
MANTOWKG - manual switch to protection (MANTOPROT)
FSTOPROT - manual switch to working (MANTOWKG)
FSTOWKG - force switch to protection (FSTOPROT)
LOCKOUT - force switch to working (FSTOWKG)
SFONWKG - lockout of protection (LOCKOUT)
SFONPROT - signal degrade on working (SDONWKG)
SDONWKG - signal degrade on protection (SDONPROT)
SDONPROT - signal fail on working (SFONWKG)
- signal fail on protection (SFONPROT)

Example
RTRV-FFP-STM64:CORIANT1:STM64-20-3-6:CTAG-1;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15
M CTAG-1 COMPLD
^^^STM64-20-3-6,STM64-20-14-1::SCHEME=YCABLE,HOLDOFFPROT=0,RVRTV=YES,WTR=27:IS-
NR,NOREQ
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-FFP-STMn
ED-FFP-STMn
ENT-FFP-STMn

76.MTFP50/30, Rev B January 2018 Page 30-1043

22. Retrieve Commands TL1 Command Reference Manual

RTRV-FFP-TGLAN

Command Changes Since Previous Feature Package

• Updated for OSM-4S.

Description
The RTRV-FFP-TGLAN command instructs the network element (NE) to retrieve the attributes of a facility protection
group for a pair of TGLAN facilities for Y-Cable protection.

The following TGLAN FFP are allowed in an mTera UTP:

• Y-Cable is supported for TGLAN client using any OSM-2S modules in an mTera shelf.

• Y-Cable is supported for TGLAN client using any OSM-4S modules in an mTera shelf.

Restrictions and Exceptions

• Either "working AID", "working AID, Protection AID", "ALL", "ALL,ALL", "working AID,ALL", or
"ALL,protection AID" can be used for specifying the facilities involved in the protection group.

Command Format
RTRV-FFP-TGLAN:[tid]:{<protectedId>|ALL}{,<protectingId>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<protectedId>,<protectingId>::SCHEME=<scheme>,HOLDOFFPROT=<HoldOffProt>,RVRT
V=<rvrtv>,WTR=<wtr>:<pst>,[<sst>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.44 RTRV-FFP-TGLAN Parameters

Parameter Value(s) Definition
protectedId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

protectingId TGLAN-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

scheme YCABLE Specifies the protection scheme.

HoldOffProt 0,60-1000 in increments of 5 msec Specifies no hold-off time (when set to 0) or a hold-off time
between 60 msec and 1000 msec in increments of 5 msec
before a protection switch takes place.

rvrtv NO Revertive state:

- YES: revertive.
- NO: not revertive.

wtr [300-3600] Wait To Restore. Valid values: 300-3600 seconds. After

expiration of the timer, the working line is restored and a no
request state is transmitted.

Page 30-1044 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.44 RTRV-FFP-TGLAN Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of a
module.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

sst NOREQ Indicates the secondary state of the 1+1 Protection Group.
DNR - no request (NOREQ)
WTR - do not revert (DNR)
MANTOPROT - wait-to-restore (WTR)
MANTOWKG - manual switch to protection (MANTOPROT)
FSTOPROT - manual switch to working (MANTOWKG)
FSTOWKG - force switch to protection (FSTOPROT)
LOCKOUT - force switch to working (FSTOWKG)
SFONWKG - lockout of protection (LOCKOUT)
SFONPROT - signal degrade on working (SDONWKG)
SDONWKG - signal degrade on protection (SDONPROT)
SDONPROT - signal fail on working (SFONWKG)
- signal fail on protection (SFONPROT)

Example
RTRV-FFP-TGLAN:CORIANT1:TGLAN-20-3-1:CTAG-1;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M CTAG-1 COMPLD

^^^TGLAN-20-3-1,TGLAN-20-14-1::SCHEME=YCABLE,HOLDOFFPROT=0,RVRTV=NO,WTR=300:IS-
NR,NOREQ

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FFP-TGLAN
DLT-FFP-TGLAN

76.MTFP50/30, Rev B January 2018 Page 30-1045

22. Retrieve Commands TL1 Command Reference Manual

RTRV-FIBR-EQPT

Command Changes Since Previous Feature Package

• Added support for OSM4S.

Description
This command is used to retrieve the following types of provisioned fiber (non-ribbon) entities:
• Equipment connection from OMD/CDCP add/drop ports to line interfaces of port modules.

• Equipment connection from OADMRS9 Aux ports to OMD DWDM ports.

• Equipment connections between OADMRS9 Express ports.

On the OADMRS-20, this command is used to retrieve the following types of provisioned Ribbon fiber entities:
• Equipment Ribbon fiber connection from OADMRS MPO ports to fiber shuffle MPO ports.

• Equipment Ribbon fiber connection from fiber shuffle MPO ports to CDCP MPO ports.

Restrictions and Exceptions

• "ALL,ALL" must be used in the aid fields to retrieve equipment connections.

• When ALL is used the command response will include all fiber connections of all channel multiplexers
in the NE.

• When the given fiber equipment was assigned to CP, attempts to use ENT/ED/DLT-FIBR-EQPT
commands for that fiber is denied.

Command Format
RTRV-FIBR-EQPT:[tid]:ALL,ALL:ctag:::
[FROMPORT=<fromPort>][,TOPORT=<toPort>][,FROMRBPORT=<fromRibbonPort>][,TORBPORT=
<toRibbonPort>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

^^^"<from_aid>,<to_aid>::[FROMPORT=<fromPort>][,TOPORT=<toPort>]][,FROMRBPORT=<f
romRibbonPort>][,TORBPORT=<toRibbonPort>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.45 RTRV-FIBR-EQPT Parameters

Parameter Value(s) Definition
from_aid CD4D8-[50-58]-[2-4,6-8] EntityID-ShelfID-SlotID-SubslotID
CDCP-20-[10-16,1-7]-[1-3]
FSM-20-[35,34]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OMD-20-[1-16]-[1-2]

Page 30-1046 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.45 RTRV-FIBR-EQPT Parameters (Continued)

Parameter Value(s) Definition
to_aid CD4D8-[50-58]-[2-4,6-8] EntityID-ShelfID-SlotID-SubslotID
CDCP-20-[10-16,1-7]-[1-3]
FSM-20-[35,34]
OMD-20-[1-16]-[1-2]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]

fromPort Possible values are: (1) 9 to 14 when Specifies the "FROM" Aux port on an OADMRS9.
"from_aid" is CDCP (2) 3 to 11 when or
"from_aid" is OADMRS9 (3) 19135 to Specifiies the "FROM" Express port on an OADMRS9.
19610 in increments of 5 when or
"from_aid" is an OMD48. (4) 3 to 6, 9 Specifies the "FROM" add/drop port number on an OMD/CDCP/
to 12 when "from_aid" is a CD4D8. CD4D8.

toPort Possible values are: (1) 1 to 2 when Specifies the "TO" port module.
the "to_aid" is OSM2C. (2) 1 to 20
when the "to_aid" is OSM2S. (3) 1 to 4
when the "to_aid" is OSM4C (4) 1 to 2
when the "to_aid" is OSM4F (5) 3 to
11 when the "to_aid" is OADMRS9 (6)
1,2,7,8 when the "to_aid" is CD4D8 (7)
1 to 40 when the "to_aid" is OSM4S.

fromRibbonPo Possible values are: Specifies the "FROM" Ribbon Fiber MPO port name/number on
rt (1)"columnNumber""MPOName", an FSM.
columnNumber=1 to 21, or
MPOName=V, W, X, Y, Z, when Specifies the "FROM" Ribbon Fiber MPO port name on an
"from_aid" is FSM and "to_aid" is OADMRS.
CDCP. (2) V to Z when "from_aid" is
OADMRS and "to_aid" is FSM.

toRibbonPort Possible values are: (1) Specifies the "TO" Ribbon Fiber MPO port name/number on an
"columnNumber""MPOName", FSM.
columnNumber=1 to 21, or
MPOName=V, W, X, Y, Z, if to_aid is Specifies the "TO" Ribbon Fiber MPO port name on an CDCP.
FSM. (2) V, W if to_aid is CDCP.

Example
RTRV-FIBR-EQPT:CORIANT1:OADMRS-20-1,ALL:AM0074;

RTRV-FIBR-EQPT:CORIANT1:ALL,ALL:AM0074;

Possible System Response

^^^CORIANT1 14-12-15 02:08:15

M AM0074 COMPLD

"OADMRS-20-1,FSM-20-34::FROMRBPORT=V,TORBPORT=1V"

76.MTFP50/30, Rev B January 2018 Page 30-1047

22. Retrieve Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FIBR-EQPT, DLT-FIBR-EQPT

Page 30-1048 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-FPGAVER

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-FPGAVER command instructs the network element (NE) to retrieve the current version of programable
devices (usually FPGAs) on its modules.

Note that multiple FPGA versions may be available on each module and should be matched to the FPGA Version
matrix to determine concurrency with the NE's current feature package.

The command returns a list containing the FPGA name, firmware version, and status of firmware for a module. It is
possible for some devices to be up-to-date and others not. This depends on the current feature package and the
upgrade history of each board.

This command provides additional information not available in the RTRV-INV command which informs if the module
requires a reset to update on-board FPGAs.

The RTRV-FPGAVERMAP command can be used to retrieve the current firmware versions available for each
module type in the NE that can be patched.

Modules which are not up to date require a cold reset to download latest versions, reference the NE Upgrade
Procedure for detailed upgrade procedures in order to minimize or avoid impact to live traffic.

When the command STATUS parameter is set to CURRENT or NOT_CURRENT for the input command, then only
modules with FPGAs that are CURRENT or NOT_CURRENT is shown in the command response respectively.

Restrictions and Exceptions

• AID is mandatory (can not be blank) unless ALL is specified.

• Use of status parameter when ALL is specifed may show all up-to-date or all out-of-date modules.

• The command response only displays modules that have programable/upgradeable devices (FPGAs)
that support patching.

• Setting the input command STATUS parameter to NA is denied. NA is only applicable for the STATUS
command response when there is not FPGA on a queried module.

Command Format
RTRV-FPGAVER:[tid]:{<eqpt_aid>|ALL}:ctag[:::[STATUS=<CURRENT|NOT_CURRENT>]];

Proper System Response

<header>
M^^<ctag>^COMPLD
^^^"<eqpt_aid>::FPGANAME=<FPGA_Name>,VERSION=<FPGA_Version>,STATUS=<CURRENT|NOT_
CURRENT>"

76.MTFP50/30, Rev B January 2018 Page 30-1049

22. Retrieve Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.46 RTRV-FPGAVER Parameters

Parameter Value(s) Definition
eqpt_aid CDCP-20-[10-16,1-7]-[1-3] EntityID-ShelfID-SlotID
CFP-20-[1-16]-[1,2]
CFP2-20-[1-16]-[1-5]
FAN-20-[29-32]
FAN8-20-[16,17]
MFAB-20-[5-6, 8-9, 11-12, 17-20]
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
OSM4C-20-[1-16]
OSM4F-20-[1-16]
OSM4S-20-[1-16]
OSM5C-20-[1-16]
SAIM-20-22
SDM-20-33
SEIM-20-[28,21]
SIOM-20-15
SSM2S-20-[1-16]
STIM-20-[26,23]
STPM-20-[25,24]
STPM8-20-[13,14]

FPGA_Name Alphanumeric string Identifies a programmable device (FPGA) in the hardware

module.

Refer to section 2 for the applicable characters.

FPGA_Version A string typically with hexadecimal Identifies the firmware version of a programmable device
values. (FPGA).

Hexadecimal Example: 0x1000A

status CURRENT Used when ALL is specified in the command line instead of a
NOT_CURRENT specific module.
NA - Enter CURRENT to show only modules with up-to-date
hardware versions.
- Enter NOT_CURRENT to show only modules with out-of-date
hardware versions

If status is not entered the system shows all status information in

the command response for all modules, where CURRENT or
NOT_CURRENT indicates the FPGA versions status. A
response with a status of NA indicates that the module does not
have an FPGA.

Example
CORIANT1> RTRV-FPGAVER::ALL:CTAG01;

Page 30-1050 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT1 14-11-11 11:10:59
M CTAG01 COMPLD
"CD20-20-1::FPGANAME=\"CD20_CPLD_BUNDLE\",VERSION=\"0x111\",STATUS=CURRENT"
"CD20-20-1::FPGANAME=\"CD20_FPGA_BUNDLE\",VERSION=\"0x121\",STATUS=CURRENT"
"CD20-20-1::FPGANAME=\"CD20_WSS_BUNDLE\",VERSION=\"0x124\",STATUS=CURRENT"
"CDCP-20-1-2::FPGANAME=\"CDC8D6_BUNDLE\",VERSION=\"0x15FD4\",STATUS=CURRENT"
"CX12C-20-1-1::FPGANAME=\"CX12C_BUNDLE\",VERSION=\"0x14\",STATUS=CURRENT"
"OADMRS-20-
1::FPGANAME=\"OADMRS20_CPLD_P2BUNDLE\",VERSION=\"0x105\",STATUS=CURRENT"
"OADMRS-20-
1::FPGANAME=\"OADMRS20_EDFA_P2BUNDLE\",VERSION=\"0x13513\",STATUS=CURRENT"
"OADMRS-20-
1::FPGANAME=\"OADMRS20_FPGA_P2BUNDLE\",VERSION=\"0x110\",STATUS=CURRENT"
"OADMRS-20-
1::FPGANAME=\"OADMRS20_OCM_P2BUNDLE\",VERSION=\"0x13F0A\",STATUS=CURRENT"
"OADMRS-20-
1::FPGANAME=\"OADMRS20_WSS_P2BUNDLE\",VERSION=\"0x40505\",STATUS=CURRENT"
"OADMRS9-20-
3::FPGANAME=\"OADMRS9_CPLD_P2BUNDLE\",VERSION=\"0x105\",STATUS=CURRENT"
"OADMRS9-20-
3::FPGANAME=\"OADMRS9_EDFA_P2BUNDLE\",VERSION=\"0x13513\",STATUS=CURRENT"
"OADMRS9-20-
3::FPGANAME=\"OADMRS9_FPGA_P2BUNDLE\",VERSION=\"0x110\",STATUS=CURRENT"
"OADMRS9-20-
3::FPGANAME=\"OADMRS9_OCM_P2BUNDLE\",VERSION=\"0x13F0A\",STATUS=CURRENT"
"OADMRS9-20-
3::FPGANAME=\"OADMRS9_WSS_P2BUNDLE\",VERSION=\"0x40505\",STATUS=CURRENT"
"OCC-20-1::FPGANAME=\"OCC_CPLD_BUNDLE\",VERSION=\"0x12010 \",STATUS=CURRENT"
"OCC-20-1::FPGANAME=\"OCC_FPGA_BUNDLE\",VERSION=\"0x12020 \",STATUS=CURRENT"
"OFP1CC-20-2::FPGANAME=\"OFP1CC_FPGA\",VERSION=\"0x1004\",STATUS=CURRENT"
"OSM1S-20-14::FPGANAME=\"OSM1S_FPGA\",VERSION=\"0x10008\",STATUS=CURRENT"
"OSM2C-20-14::FPGANAME=\"OSM2_FPGA\",VERSION=\"0x10008\",STATUS=CURRENT"
"OSM4F-20-14::FPGANAME=\"OSM4_FPGA\",VERSION=\"0x10008\",STATUS=CURRENT"
"CFP-20-14-
1::FPGANAME=\"TCFP_A1_APP_FW\",VERSION=\"0x1051E\",STATUS=NOT_CURRENT"
"CFP-20-14-
1::FPGANAME=\"TCFP_F1_APP_FW\",VERSION=\"0x1051E\",STATUS=NOT_CURRENT"
"SEIM-20-21::FPGANAME=\"SEIM_FPGA\",VERSION=\"0x4\",STATUS=CURRENT"
"STPM-20-24::FPGANAME=\"STPM_FPGA\",VERSION=\"0x9\",STATUS=CURRENT"
"STPM-20-25::FPGANAME=\"STPM_FPGA\",VERSION=\"0x9\",STATUS=CURRENT"
"FAN-20-29::FPGANAME=\"FAN_FPGA\",VERSION=\"0x7\",STATUS=CURRENT"
"FAN-20-30::FPGANAME=\"FAN_FPGA\",VERSION=\"0x7\",STATUS=CURRENT"
"FAN-20-31::FPGANAME=\"FAN_FPGA\",VERSION=\"0x7\",STATUS=CURRENT"
"FAN-20-32::FPGANAME=\"FAN_FPGA\",VERSION=\"0x7\",STATUS=CURRENT"
"SDM-20-33::FPGANAME=\"SDM_APP_FW\",VERSION=\"0x10004\",STATUS=CURRENT"
"SDM-20-33::FPGANAME=\"SDM_FPGA\",VERSION=\"0xD\",STATUS=CURRENT"
;

Example
CORIANT1> RTRV-FPGAVER:CORIANT1:ALL:CTAG26:::STATUS=NOT_CURRENT;

76.MTFP50/30, Rev B January 2018 Page 30-1051

22. Retrieve Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 14-11-09 10:25:19
M CTAG26 COMPLD
"OSM2S-20-1::FPGANAME=\"OSM2_FPGA\",VERSION=\"0xA\",STATUS=NOT_CURRENT"
;

Example
CORIANT1> RTRV-FPGAVER:CORIANT1:OSM2C-20-10:CTAG23;

Possible System Response

CORIANT1 14-11-10 23:47:26
M CTAG23 COMPLD
"OSM2C-20-10::FPGANAME=\"OSM2_FPGA\",VERSION=\"0xC\", STATUS=CURRENT"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-INV-{X}
RTRV-FPGAVERMAP

Page 30-1052 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-FPGAVERMAP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-FPGAVERMAP command instructs the network element (NE) to retrieve the current firmware version
(patch) available for each programmable device (usually FPGAs) per module type in the NE that support patching.

The command returns a list containing the FPGA name and available firmware version (patch) for a module type.
Note that multiple FPGA versions may be available on each module type.

Use the RTRV-FPGAVER command to retrieve the firmware version (patch) installed for each programmable device
(FPGA) on modules in the NE.

Use the RTRV-SW command to retrieve information regarding the NE feature package software version.

The command response identifies the current version of an available module firmware image file located on the NE.
For firmware image files that are not assigned a numeric value (decimal or hexidecimal), a build date is used to
identify the version.

Restrictions and Exceptions

None.

Command Format
RTRV-FPGAVERMAP:[tid]::ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD
^^^"::FPGANAME=\"<FPGA_Name>\",VERSION=\"<FPGA_Version>\""
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.47 RTRV-FPGAVERMAP Parameters

Parameter Value(s) Definition
FPGA_Name Alphanumeric string Identifies a programmable device (FPGA) in the hardware
module.

Refer to section 2 for the applicable characters.

FPGA_Version Alphanumeric string Identifies the firmware version of a programmable device

(FPGA).

Example:
0x8012
Mon Feb 2 07:15:47 2015

76.MTFP50/30, Rev B January 2018 Page 30-1053

22. Retrieve Commands TL1 Command Reference Manual

Example
CORIANT1> RTRV-FPGAVERMAP:::CT23;

Possible System Response

CORIANT1 14-11-11 11:10:59
M CTAG01 COMPLD
"::FPGANAME=\"CDC8D6_BUNDLE\",VERSION=\"0x15FD4\""
"::FPGANAME=\"FAN_FPGA\",VERSION=\"0x7\""
"::FPGANAME=\"OADMRS20_CPLD_P2BUNDLE\",VERSION=\"0x105\""
"::FPGANAME=\"OADMRS20_EDFA_P2BUNDLE\",VERSION=\"0x13513\""
"::FPGANAME=\"OADMRS20_FPGA_P2BUNDLE\",VERSION=\"0x110\""
"::FPGANAME=\"OADMRS20_OCM_P2BUNDLE\",VERSION=\"0x13F0A\""
"::FPGANAME=\"OADMRS20_WSS_P2BUNDLE\",VERSION=\"0x40505\""
"::FPGANAME=\"OADMRS9_CPLD_P2BUNDLE\",VERSION=\"0x105\""
"::FPGANAME=\"OADMRS9_EDFA_P2BUNDLE\",VERSION=\"0x13513\""
"::FPGANAME=\"OADMRS9_FPGA_P2BUNDLE\",VERSION=\"0x110\""
"::FPGANAME=\"OADMRS9_OCM_P2BUNDLE\",VERSION=\"0x13F0A\""
"::FPGANAME=\"OADMRS9_WSS_P2BUNDLE\",VERSION=\"0x40505\""
"::FPGANAME=\"OCC_CPLD_BUNDLE\",VERSION=\"0x12010 \""
"::FPGANAME=\"OCC_FPGA_BUNDLE\",VERSION=\"0x12020 \""
"::FPGANAME=\"OSM1S_FPGA\",VERSION=\"0x10008\""
"::FPGANAME=\"OSM2_FPGA\",VERSION=\"0x10008\""
"::FPGANAME=\"OSM4_FPGA\",VERSION=\"0x10001\""
"::FPGANAME=\"SAIM_FPGA\",VERSION=\"0x4\""
"::FPGANAME=\"SDM_APP_FW\",VERSION=\"0x10004\""
"::FPGANAME=\"SDM_FPGA\",VERSION=\"0xD\""
"::FPGANAME=\"SEIM_FPGA\",VERSION=\"0x4\""
"::FPGANAME=\"SIOM_FPGA\",VERSION=\"0x2\""
"::FPGANAME=\"SSM2_CES_FPGA\",VERSION=\"0x0221\""
"::FPGANAME=\"SSM2_SFP_FPGA\",VERSION=\"0x0101\""
"::FPGANAME=\"STIM_FPGA\",VERSION=\"0x3\""
"::FPGANAME=\"STPM_FPGA\",VERSION=\"0x9\""
"::FPGANAME=\"STPM8_FPGA\",VERSION=\"0x2\""
"::FPGANAME=\"TCFP_A1_APP_FW\",VERSION=\"0x1051E\""
"::FPGANAME=\"TCFP_F1_APP_FW\",VERSION=\"0x0102\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-INV-{X}
RTRV-FPGAVER

Page 30-1054 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-FTPSERVER

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-FTPSERVER command instructs the network element (NE) to retrieve the properties of the specific
server provisioned via ENT-FTPSERVER for PM file transfer purpose in binary format.

Restrictions and Exceptions

• Only Historical PM file transfer in binary format for STSn or ODUk montypes (for example, Path PM) is
supported.

Command Format
RTRV-FTPSERVER:[tid]:{<ftpserver_aid>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD

^^^"<ftpserver_aid>:<userid>,<pwd>,<ipaddress>,<portid>,<urlPath>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.48 RTRV-FTPSERVER Parameters

Parameter Value(s) Definition
ftpserver_aid FTPSERVER-1 EntityID-FTPSERVERID

userid A string consisting of 6 to 32 Specifies a valid user identification on the FTP server.
characters.
Note that the following characters are not allowed for <userid>:
@?/\{[()]}

pwd A string consisting of 6 to 32 Specifies the corresponding password for the valid <userid> on
characters. the FTP server.

Note that the following characters are not allowed for <pwd>: @
?/\{[()]}
The password is displayed as "*".

ipaddress Format for the IP address is: A double Specifies the IP address of the FTP server.
quoted string representing the IPv4
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

76.MTFP50/30, Rev B January 2018 Page 30-1055

22. Retrieve Commands TL1 Command Reference Manual

Table 22.48 RTRV-FTPSERVER Parameters (Continued)

Parameter Value(s) Definition
portid 21,22 Specifies the logical port number associated with the FTP server
IP address.

- 21 for non-secure FTP file transfer.

- 22 (default value) for secure FTP (SFTP) file transfer

urlPath Possible values are: xxx/yyy/zzz Specifies the device/drive/directory to put the file on FTP server.

Example
RTRV-FTPSERVER:CORIANT1:FTPSERVER-1:AM0074;

Possible System Response

^^^CORIANT1 06-06-15 02:08:15

M AM0074 COMPLD

"FTPSERVER-1:user1,*,172.111.21.4,21,"/dir2/""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FTP-SERVER
RTRV-PMFILESCHED-{x}
DLT-FTPSERVER
ED-FTPSERVER

Page 30-1056 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-GAIN-OTS

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-GAIN-OTS command instructs the network element (NE) to retrieve the current value of the optical gain
level of input and output amplifiers.

In the response it is possible to visualize if the Automatic Power Adjustment (APA) feature is on a manual mode
(MAN) or on automatic (AUTO) mode.

If the APA is on the manual mode, the gain level displayed is the one that has been set with the SET-GAIN-OTS
command. However, an automatic power adjustment mode is available for the amplifiers. In this case, this command
will display the gain set automatically by the Automatic Power Adjustment mode.

Restrictions and Exceptions

Command Format
RTRV-GAIN-OTS:[tid]:{<ots_aid>|ALL}:ctag:::[<APAOutMode>][,<APAInMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<ots_aid>::APAI=<APAInMode>,IGAIN=<igain>,APAO=<APAOutMode>,OGAIN=<ogain>"<c
r><lf>
;

Parameters

Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.49 RTRV-GAIN-OTS Parameters

Parameter Value(s) Definition
ots_aid OTS-20-[10-16,1-7]-21,OTS-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

APAOutMode AUTO Indicates the current output power adjustment mode that is
MAN configured for OADMRS-20.
- AUTO indicates the amplifier is on automatic power
adjustment.
- MAN indicates the amplifier is on manual power adjustment.

APAInMode AUTO Indicates the current input power adjustment mode that is
MAN configured for OADMRS-20.
- AUTO indicates the amplifier is on automatic power
adjustment.
- MAN indicates the amplifier is on manual power adjustment.

76.MTFP50/30, Rev B January 2018 Page 30-1057

22. Retrieve Commands TL1 Command Reference Manual

Table 22.49 RTRV-GAIN-OTS Parameters (Continued)

Parameter Value(s) Definition
igain Possible values are: (1)Number Specifies the current applied input gain level applied on
ranging from 4.5 to 20.5 when set on OADMRS/OADMRS9 in dB, with 0.1 dB increments.
OADMRS or OADMRS9 and
OPGAINRANGE=LOW.(2) Number
ranging from 18.5 to 30.5 when set on
OADMRS and
OPGAINRANGE=HIGH. (3) Number
ranging from 10.0 to 30.5 when set on
OADMRS9 and
OPGAINRANGE=HIGH. (4)NA.

ogain Possible values are: (1)Number Indicates the current applied output gain level measured on
ranging from 12 to 22 when set on OADMRS/OADMRS9 in dB, with 0.1 dB increments.
OADMRS. (2) Number ranging from
10 to 21.6 when set on OADMRS9
(3)NA.

Example
RTRV-GAIN-OTS:CORIANT1:OTS-20-1-21:AM0102;

Possible System Response

CORIANT1 14-12-02 00:50:03

M AM0102 COMPLD

"OTS-20-1-21::APAI=MAN,IGAIN=(+14.2),APAO=AUTO,OGAIN=(+15.0)"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTS, SET-GAIN-OTS

Page 30-1058 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-GCC

Command Changes Since Previous Feature Package

• Added support for GCC of ODUk of an ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

• Added support for ZTC proxy over GCC links.

Description
The RTRV-GCC command enables the customer to view the attributes of GCC entities.

Restrictions and Exceptions

• When ALL is used as an AID, information for all GCCentities that matches the specified filtering
parameter(s) is retrieved.

Command Format
RTRV-
GCC:[tid]:{<gcc_aid>|ALL}:ctag:::[ALMPF=<almProfile>][:<editablePrimaryState>][,
<secondaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
"<gcc_aid>::PPPPF=<ppppf_aid>,ALMPF=<almProfile>,NPOWNER=<NpOwner>,ZTCPROXY=<pro
xy_state>:<pst>,[<sst>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.50 RTRV-GCC Parameters

Parameter Value(s) Definition
almProfile 0-20, 99 Specifies the new alarm profile table for the entity.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

editablePrimar IS Specifies the primary state of the entity. Two states are possible:
yState OOS In-Service (IS) and Out-of-Service (OOS).

76.MTFP50/30, Rev B January 2018 Page 30-1059

22. Retrieve Commands TL1 Command Reference Manual

Table 22.50 RTRV-GCC Parameters (Continued)

Parameter Value(s) Definition
gcc_aid GCC0-20-[1-16]-[1-32], GCC0-ShelfID-SlotID-PortID
GCC1-20-[1-16]-[1-20], GCC1-ShelfID-SlotID-PortID-{Supporting ODUtype}{Supporting
GCC1-20-[1-16]-[1-4]-[B,C][1-80]- ODU Tributary Port}-{ODUtype}{ODUTribPort}
[A,B,E,Z,F][1-32], GCC1-ShelfID-SlotID-PortID-{Supporting ODU4}{Supporting
GCC1-20-[1-16]-[1-20]- ODU4 TributaryPort}-{Supporting ODUtype}{Supporting ODU
[A,B,C,D,E,Z,F][1-80], Tributary Port}-{ODUtype}{ODUTribPort}
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32], Note:
GCC1-20-[1-16]-[1-2]-[D][1-3]- 1. for GCC created on an ODU associated with a client port, the
[A,B,C,E,Z,F][1-80], ODUTribPort is not used
GCC2-20-[1-16]-[1-20], 2. Supporting ODUtype and Supporting ODU Tributary Port are
GCC2-20-[1-16]-[1-4]-[B,C][1-80]- only used for 2-stage ODU multiplexing.
[A,B,E,Z,F][1-32], 3. GCC2 and GCC12 have same format values as GCC1.
GCC2-20-[1-16]-[1-20]- 4. Supporting ODU4 and Supporting ODU4 Tributary Port are
[A,B,C,D,E,Z,F][1-80], only applicable when LO ODU is multiplexed into ODU4 within
GCC2-20-[1-16]-[1-2]-[D][1-3]-[B,C][1- the ODUC2 (when the modulation format of the port on OSM-4F
80]-[A,B,E,Z,F][1-32], is configured to 200G16QAM).
GCC2-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC12-20-[1-16]-[1-20],
GCC12-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[B,C][1-80]-[A,B,E,Z,F][1-32],
GCC12-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]

ppppf_aid PPPPF-[99,1-10] Specifies the access identifier of the PPP protocol profile.

NpOwner 1 Specifies which network partition ownes this entity.

2

proxy_state ENABLED Specifies the ZTC proxy state of the interface.

DISABLED When the ZTC proxy state is ENABLED, the NE can be the ZTC
proxy of the ZTC DUC attached to the port.

pst IS-NR Indicates the primary state and primary state qualifier:
IS-ANR - IS: In-Service
OOS-MAANR - OOS: Out-of-Service
OOS-AU Possible values for PSTQ:
OOS-MA - NR: normal
OOS-AUMA - ANR: abnormal
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- MAANR: management and abnormal

secondaryStat FAF Indicates the secondary state:

e/sst SGEO - FAF for Facility failure.
INCOMP - SGEO for Supporting Entity Outage - used to indicate that the
NALMNR OTN facility associated with this entity has failed
NALMCD - INCOMP - incomplete configuration - used to indicate that the
GCC is not enabled in either MCN or SCN (no TL created on it),
or the GCC is not mapped with OTN entity.
- NALMNR for not alarmed not ready
- NALMCD for not alarmed count down

Page 30-1060 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Example
RTRV-GCC:NE01:ALL:AM0074;

Possible System Response

^^^NE01 11-09-15 02:08:15
M AM0074 COMPLD
"GCC0-20-2-1::PPPPF=PPPPF-1,ALMPF=99,ZTCPROXY=DISABLED:IS-NR,"
"GCC0-20-3-1::PPPPF=PPPPF-1,ALMPF=99,ZTCPROXY=DISABLED:IS-NR,"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-GCC
ED-GCC
ENT-GCC

76.MTFP50/30, Rev B January 2018 Page 30-1061

22. Retrieve Commands TL1 Command Reference Manual

RTRV-HDR

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-HDR command instructs the network element (NE) to retrieve all header information pertaining to the
network element: SID (Source Identifier), system date and time. This commands is often used as a heartbeat (keep
alive) between an OSS and the Network Element, since normal sessions can time-out if there is a period of inactivity
on an open session.

Command Format
RTRV-HDR:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
;

Example
RTRV-HDR:CORIANT1::AM0015;

Possible System Response

CORIANT1 02-04-16 02:08:15

M AM0015 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

Page 30-1062 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-INTIP-SLOT

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-INTIP-SLOT command instructs the network element (NE) to retrieve the IP addresses of the Internal
network. These are the IP addresses of all the modules on the internal LAN. These addresses are normally fixed,
but can be modified by FC Shell commands.

Command Format
RTRV-INTIP-SLOT:[tid]:[{<slot_aid>|ALL}]:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<slot_aid>::INTIP=<slot_ip>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.51 RTRV-INTIP-SLOT Parameters

Parameter Value(s) Definition
slot_aid SLOT-20-[1-35]-[1-32], SLOT-[50-58]- EntityID-ShelfID-SlotID[-SubslotID]
[1-8]

slot_ip [0-255].[0-255].[0-255].[0-255] Specifies the remote NE target identifier (TID) code.

Example
RTRV-INTIP-SLOT:CORIANT1:ALL:AM0209;

Possible System Response

^^^CORIANT1 02-02-02 00:50:03

M AM0102 COMPLD

^^^"SLOT-20-1::INTIP=1.0.1.1"
^^^"SLOT-20-2::INTIP=1.0.1.2"
^^^"SLOT-20-3::INTIP=1.0.1.3"
^^^"SLOT-20-4::INTIP=1.0.1.4"
^^^"SLOT-20-5::INTIP=1.0.1.5"
^^^"SLOT-20-6::INTIP=1.0.1.6"
^^^"SLOT-20-7::INTIP=1.0.1.7"
^^^"SLOT-20-8::INTIP=1.0.1.8"
^^^"SLOT-20-9::INTIP=1.0.1.9"
^^^"SLOT-20-10::INTIP=1.0.1.10"

76.MTFP50/30, Rev B January 2018 Page 30-1063

22. Retrieve Commands TL1 Command Reference Manual

^^^"SLOT-20-11::INTIP=1.0.1.11"
^^^"SLOT-20-12::INTIP=1.0.1.12"
^^^"SLOT-20-13::INTIP=1.0.1.13"
^^^"SLOT-20-14::INTIP=1.0.1.14"
^^^"SLOT-20-15::INTIP=1.0.1.15"
^^^"SLOT-20-16::INTIP=1.0.1.16"
^^^"SLOT-20-17::INTIP=1.0.1.17"
^^^"SLOT-20-18::INTIP=1.0.1.18"
^^^"SLOT-20-19::INTIP=1.0.1.19"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

Page 30-1064 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-INV

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-INV command instructs the network element (NE) to retrieve the inventory attributes of equipment entity
which are physically present in the system. This information, when available, in stored on the EEPROMs module.

It also provides status information on the Firmware version and Software level installed on the module.
If information is not available it returns the value "NA".

Restrictions and Exceptions

• The eqpt_aid is only used to get information for a shelf entity.

• Filler modules are detectable on the mTera UTP.

Command Format
RTRV-INV:[tid]:{<slot_aid>|<eqpt_aid>|ALL}:ctag:::
[SHOWSLOT=<showslot>][,SHOWSUBSLOT=<showsubslot>][,FWSTATUS=<firmware_status>][,
SWSTATUS=<software_status>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"[<slot_aid>|<eqpt_aid>]::TYPE=<module_type>,SN=<serial_num>[,PN=<part_number
>],HWV=<hardware_ver>[,CLEI=<clei_num>],FWSTATUS=<firmware_status>,SWSTATUS=<sof
tware_status>"
;

Proper System Response Equipment is Not Present in the Specified Slot

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.52 RTRV-INV Parameters

Parameter Value(s) Definition
slot_aid SLOT-20-[1-35]-[1-32], SLOT-[50-58]- EntityID-ShelfID-SlotID[-SubslotID]
[1-8]

eqpt_aid SH-20 EntityID-ShelfID

76.MTFP50/30, Rev B January 2018 Page 30-1065

22. Retrieve Commands TL1 Command Reference Manual

Table 22.52 RTRV-INV Parameters (Continued)

Parameter Value(s) Definition
showslot YES Indicates if the response should include equipment in the slots
NO associated with a particular shelf.
Default: NO
Implied default YES for "ALL" AID

showsubslot YES Indicates if the response should include equipment in the

NO sublsots associated with a particular module.
Default: NO denies if SHOWSUBSLOT is requested and SHOWSLOT is not.

Implied default YES for "ALL" AID

firmware_statu CURRENT This parameter provides the status of the Firmware (FW)
s NOT_CURRENT version on the module.
NA CURRENT: indicates that the module has the latest FW version
available.
NOT_CURRENT: indicates that the module does not have the
latest version of FW.
NA: indicates that the module does not have any FW that can be
upgraded.

software_statu CURRENT This parameter provides the status of the Software (SW) version
s NOT_CURRENT on the module.
NA CURRENT: indicates that the module has the latest SW patch
UPGRADE available.
NOT_CURRENT: indicates that the module does not have the
latest patch of SW.
NA: indicates that the module does not have any SW.
UPGRADE: indicates that the module is upgrading its SW.

Page 30-1066 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.52 RTRV-INV Parameters (Continued)

Parameter Value(s) Definition
module_type BFM Indicates the type of module that is populated in this slot in
CDC8D6 accordance to the field "module type" in the EEPROM.
CFP When the information is unavailable the system returns NA (Not
CFP2 Available) or UNKNOWN.
FAN
FAN8
MFAB
MFAB2
MFM
MTERA_SHELF
MTERA8_SHELF
NA
OADMRS20
OADMRS9
OCC
OSM1S
OSM2C
OSM2S
OSM4C
OSM4F
OSM4S
OSM5C
SAIM
SDM
SEIM
SFM
SFP
SFPP
SIOM
STIM
STPM
STPM8
UNKNOWN

serial_num Is a string of length 9 to 18 characters. Identifies the serial number of the module (such as
OP0023122).
When the information is unavailable the system returns NA (Not
Available).

part_number Is a string of length 8 to 18 characters. Identifies the Part Number of the module that populates the slot.
When the information is unavailable the system returns NA (Not
Available).

Refer to section 2 for the applicable characters.

hardware_ver x[yyy]: Where: (1)x = A...Z (2)y = A...Z Identifies the Hardware Version of the module that populates the
or 0...9 slot.
When the information is unavailable the system returns NA (Not
Available).

76.MTFP50/30, Rev B January 2018 Page 30-1067

22. Retrieve Commands TL1 Command Reference Manual

Table 22.52 RTRV-INV Parameters (Continued)

Parameter Value(s) Definition
clei_num CLEI code number is a string of 10 Identifies the CLEI code number of the module that populates
alphanumeric characters in the form: the slot.
XXXXYYYZTT where: (1)XXXX The CLEI code is a 10-character code that identifies
defines family or sub-family of product. communications equipment. It describes product type, features,
(2)YYY defines features. (3)Z is source document, and associated drawings and vintages.
manufacturer and system ID. (4)TTT CLEI codes have 4 data elements:
identifies version, issue and release. - Characters 1 to 4: Define family or subfamily of product.
- Characters 5 to 7: Define features.
- Character 8: Manufacturer and System ID.
- Characters 9 and 10: Identifies version, issue, and release #.
Example of CLEI code may be "SNCLPV42AA".
When the information is unavailable the system returns NA (Not
Available).

Example: Retreive an mTera Shelf

CORIANT1> RTRV-INV::SH-20:CTAG1;

Possible Command Response

CORIANT1 14-11-08 13:35:46
M CTAG1 COMPLD
"SH-20::TYPE=\"MTERA_SHELF\",SN=\"4A5430363\",PN=\"81.71S-MTERA-
R6\",HWV=\"B\",CLEI=\"WMMBJ00ERB\",FWSTATUS=NA,"
;

Example: Retreive all Slots of an mTera Shelf

CORIANT1> RTRV-INV::SH-20:CTAG1:::SHOWSLOT=YES;

Possible Command Response

CORIANT1 14-11-08 13:35:53
M CTAG1 COMPLD
"SH-20::TYPE=\"MTERA_SHELF\",SN=\"4A5430363\",PN=\"81.71S-MTERA-
R6\",HWV=\"B\",CLEI=\"WMMBJ00ERB\",FWSTATUS=NA,"
"SLOT-20-2::TYPE=\"OSM2C\",SN=\"4F4150019\",PN=\"81.71M-OSM2C-
R6\",HWV=\"A\",CLEI=\"WMU1AK2GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-3::TYPE=\"OSM2C\",SN=\"4F5420043\",PN=\"81.71M-OSM2C-
R6\",HWV=\"A\",CLEI=\"WMUIAK2GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-4::TYPE=\"OSM2C\",SN=\"4F4150016\",PN=\"81.71M-OSM2C-
R6\",HWV=\"A\",CLEI=\"WMU1AK2GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-5::TYPE=\"OSM2C\",SN=\"4F4150017\",PN=\"81.71M-OSM2C-
R6\",HWV=\"A\",CLEI=\"WMU1AK2GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-6::TYPE=\"OSM2C\",SN=\"4F4150020\",PN=\"81.71M-OSM2C-
R6\",HWV=\"A\",CLEI=\"WMU1AK2GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-7::TYPE=\"OSM2C\",SN=\"4F4150022\",PN=\"81.71M-OSM2C-
R6\",HWV=\"A\",CLEI=\"WMU1AK2GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-8::TYPE=\"MFAB\",SN=\"4F5400147\",PN=\"81.71C-MFAB-
R6\",HWV=\"B\",CLEI=\"WMUCA6VDAB\",FWSTATUS=NA,SWSTATUS=CURRENT"
"SLOT-20-9::TYPE=\"MFAB\",SN=\"4F5400173\",PN=\"81.71C-MFAB-
R6\",HWV=\"B\",CLEI=\"WMUCA6VDAB\",FWSTATUS=NA,SWSTATUS=CURRENT"
"SLOT-20-10::TYPE=\"OSM2C\",SN=\"4F4150021\",PN=\"81.71M-OSM2C-
R6\",HWV=\"A\",CLEI=\"WMU1AK2GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"

Page 30-1068 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

"SLOT-20-13::TYPE=\"OSM2S\",SN=\"4B4130003\",PN=\"81.71M-OSM2S-
R6\",HWV=\"A\",CLEI=\"WMUIAK3GAA\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-17::TYPE=\"MFAB\",SN=\"4F5400106\",PN=\"81.71C-MFAB-
R6\",HWV=\"B\",CLEI=\"WMUCA6VDAB\",FWSTATUS=NA,SWSTATUS=CURRENT"
"SLOT-20-18::TYPE=\"MFAB\",SN=\"4F5400164\",PN=\"81.71C-MFAB-
R6\",HWV=\"B\",CLEI=\"WMUCA6VDAB\",FWSTATUS=NA,SWSTATUS=CURRENT"
"SLOT-20-19::TYPE=\"MFAB\",SN=\"4F5400113\",PN=\"81.71C-MFAB-
R6\",HWV=\"B\",CLEI=\"WMUCA6VDAB\",FWSTATUS=NA,SWSTATUS=CURRENT"
"SLOT-20-20::TYPE=\"MFAB\",SN=\"4F5400186\",PN=\"81.71C-MFAB-
R6\",HWV=\"B\",CLEI=\"WMUCA6VDAB\",FWSTATUS=NA,SWSTATUS=CURRENT"
"SLOT-20-21::TYPE=\"MSEIM\",SN=\"4F5480097\",PN=\"81.71C-MSEIM-
R6\",HWV=\"B\",CLEI=\"WMUIAK1GAB\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-22::TYPE=\"MSAIM\",SN=\"4F5540014\",PN=\"81.71C-MSAIM-
R6\",HWV=\"B\",CLEI=\"WMUCA6TDAB\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-23::TYPE=\"SFM\",SN=\"NA\",PN=\"81.71B-
MSFM\",HWV=\"A\",CLEI=\"WSIMULATED\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-24::TYPE=\"STPM\",SN=\"3F7310075\",PN=\"81.71C-MSTPM-
R6\",HWV=\"A\",CLEI=\"NO_CLEI_CODE_YET\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-25::TYPE=\"STPM\",SN=\"3F7310077\",PN=\"81.71C-MSTPM-
R6\",HWV=\"A\",CLEI=\"NO_CLEI_CODE_YET\",FWSTATUS=CURRENT,SWSTATUS=CURRENT"
"SLOT-20-26::TYPE=\"SFM\",SN=\"NA\",PN=\"81.71B-
MSFM\",HWV=\"A\",CLEI=\"WSIMULATED\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-27::TYPE=\"SFM\",SN=\"NA\",PN=\"81.71B-
MSFM\",HWV=\"A\",CLEI=\"WSIMULATED\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-28::TYPE=\"MSEIM\",SN=\"4F5480090\",PN=\"81.71C-MSEIM-
R6\",HWV=\"B\",CLEI=\"WMUIAK1GAB\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-29::TYPE=\"FAN\",SN=\"4F4370169\",PN=\"81.71F-MFAN-
R6\",HWV=\"A\",CLEI=\"WMUCA6SDAA\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-30::TYPE=\"FAN\",SN=\"4F4370168\",PN=\"81.71F-MFAN-
R6\",HWV=\"A\",CLEI=\"WMUCA6SDAA\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-31::TYPE=\"FAN\",SN=\"4F4370167\",PN=\"81.71F-MFAN-
R6\",HWV=\"A\",CLEI=\"WMUCA6SDAA\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-32::TYPE=\"FAN\",SN=\"4F4370232\",PN=\"81.71F-MFAN-
R6\",HWV=\"A\",CLEI=\"WMUCA6SDAA\",FWSTATUS=NA,SWSTATUS=NA"
"SLOT-20-33::TYPE=\"SDM\",SN=\"4A5670150\",PN=\"81.71C-MSDM-
R6\",HWV=\"A\",CLEI=\"WMUCA6XDAA\",FWSTATUS=NA,SWSTATUS=NA"
;

Example: Retreive all Slots of an mTera Shelf without Current SW

CORIANT1> RTRV-INV::SH-20:CTAG2:::SHOWSLOT=YES,SWSTATUS=NOT_CURRENT;

Possible Command Response

CORIANT1 14-11-08 13:51:39
M CTAG2 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-EQPT-{X}

76.MTFP50/30, Rev B January 2018 Page 30-1069

22. Retrieve Commands TL1 Command Reference Manual

RTRV-IP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-IP command enables to view the current configuration of the IP address, IP network mask and IP default
gateway for the NE local craft interface.

Restrictions and Exceptions

Command Format
RTRV-IP:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"::IPADDRESS=<lci_ip_address>,IPNETMASK=<ip_network_mask>,IPDFLTGATEWAY=<ip_d
efault_gateway>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.53 RTRV-IP Parameters

Parameter Value(s) Definition
lci_ip_address [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the local craft interface (LCI) port.

ip_network_m [0-255].[0-255].[0-255].[0-255] Specifies the IP network mask applicable to the customer

ask Telecom Network (DCN).

ip_default_gat [0-255].[0-255].[0-255].[0-255] Specifies the local craft interface default gateway IP address to
eway access the customer Telecom Network (DCN).

Example
RTRV-IP:::AM0102;

Possible System Response

CORIANT1 02-02-02 00:50:03

M AM0102 COMPLD

"::IPADDRESS=172.112.121.4,IPNETMASK=255.255.255.0,IPDFLTGATEWAY=172.112.121.12"

Page 30-1070 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-IP

76.MTFP50/30, Rev B January 2018 Page 30-1071

22. Retrieve Commands TL1 Command Reference Manual

RTRV-IPPG

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-IPPG command instructs the mTera UTP to retrieve the attributes of an IPPG and the members of the
IPPG.

Restrictions and Exceptions

Command Format
RTRV-IPPG:[tid]:<ippg_aid>:ctag;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<ippg_aid>::IPPGNAME=<ippgName>,IPPGMEM=<Member>[,NPOWNER=<NpOwner>]:<pst>,[
<sst>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.54 RTRV-IPPG Parameters

Parameter Value(s) Definition
ippg_aid IPPG-1 EntityID-IPPGID

Member A list of two MGTETH entities. The Specifies the two members of IPPG.
members is separated by a symbol This parameter uses the grouping operator "&" for multiple
"&". A member is specified by the AID members.
of MGTETH entity. For example,
IPPGMEM=MGTETH-20-21-8&MGTETH-20-28-8

NpOwner 1 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state and primary state qualifier of an
IS-ANR IPPG.
OOS-MAANR Possible values for PST:
OOS-AU - IS: In-Service
OOS-MA - OOS: Out-of-Service
OOS-AUMA Possible values for PSTQ:
- NR: normal
- ANR: abnormal
- AU: autonomous
- MA: maagement
- AUMA: autonomous management
- MAANR: management and abnormal

IppgName A double quoted string consisting of 0 Specifies the IPPG name.

to 30 printable characters, not
including the quotes. Refer to section 2 for the applicable characters.

Page 30-1072 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.54 RTRV-IPPG Parameters (Continued)

Parameter Value(s) Definition
secondaryStat FLT Indicates the secondary state of an IPPG:
e/sst INCOMP -FLT for Fault. When all the Ethernet ports of the IPPG are
down, the sst of IPPG goes to FLT.
- INCOMP - incomplete configuration - used to indicate that the
entity has not been assigned to a TL.

Example
The following example retrieves attribues of IPPG-1:

RTRV-IPPG:CORIANT1:IPPG-1:KTRP01;

Possible System Response

^^^CORIANT1 06-05-15 02:08:15
M KTRP01 COMPLD
^^^"IPPG-1::IPPGNAME=\"DCN Ports Group\",IPPGMEM=MGTETH-20-21-8&MGTETH-20-28-
8,NPOWNER=1:IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-IPPG
ED-IPPG
ENT-IPPG

76.MTFP50/30, Rev B January 2018 Page 30-1073

22. Retrieve Commands TL1 Command Reference Manual

RTRV-LABELSET

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-LABELSET command instructs the NE Control Plane to retrieve a label set object.

The SET_EGRSS and SET_INGRSS are retrievable only attributes. They indicate how the label(s) in INGRSS or
EGRSS were input by the user. For example, when user only provided labels for INGRSS in ENT-LABELSET
command, the resulted label set object has SET_INGRSS = "Y" and SET_EGRSS = "N". Another example, when
user only provides "IfIndex" but no "Label" for INGRSS or EGRSS (via the ENT-CALL command), the associated
SET_INGRSS or SET_EGRSS flag is set to "N".

When "ALL" is used as an AID, the request will retrieve both MAN and AUTO mode label set objects.

Restrictions and Exceptions

• None.

Command Format
RTRV-LABELSET:[tid]:{<Labelset_aid>|ALL}:<ctag>;

Proper System Response

Proper System Response
^^^<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<Labelset_aid>::SET_INGRSS=<LabelFlag>,SET_EGRSS=<LabelFlag>,INGRSS=<Interfa
ces>,EGRSS=<Interfaces><cr><lf>+;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.55 RTRV-LABELSET Parameters

Parameter Value(s) Definition
Labelset_aid LABELSET-3-[d] EntityID-NPID-LSID

LabelFlag Y This parameter specifies the interfaces setting status.

N Y means the interfaces being retrieved are set by the user while
N means not set by the user.

Interfaces A double quoted item sequence for the This parameter specifies the interfaces being added to a label
interfaces. Each item of interfaces is in set.
form of IfIndex-Label format: (1).
interface is 8 hex numbers. (2). label is Example:
8 hex numbers. "110ABB11-00040000,110ABB11-00050000"

Page 30-1074 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Example
If the LabelSet has been referenced by a CALL.
RTRV-LABELSET:CORIANT1:LABELSET-3-1:AM0011;

Possible System Response

CORIANT1 09-10-22 04:00:55
M AM0011 COMPLD
"LABELSET-3-1::SET_INGRSS=Y,SET_EGRSS=Y,INGRSS=\"110ABB11-00040000,110ABB11-
00050000,110ABB11-00060000\"EGRSS=\"110ABB22-00040000,110ABB22-
00050000,110ABB22-00060000\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-LABELSET
ENT-LABELSET
ED-LABELSET

76.MTFP50/30, Rev B January 2018 Page 30-1075

22. Retrieve Commands TL1 Command Reference Manual

RTRV-LADJ-TL

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-LADJ-TL command instructs the network element (NE) to retrieve the status of Layer Adjacency
Discovery for a specific Topological Link (TL).

If the Discovery Agent is Out-Of-Service (OOS), this is the last negotiated information. When the Discovery Agent
is returned to In-Service (IS), this information is renegotiated if the link has changed state since the DA went OOS.

Restrictions and Exceptions

• RTRV-LADJ-TL is only supported on non-IP Topological Links (OCn-, OTS-, OTUn-, STMn-).

• RTRV-LADJ-TL is only supported on Topological Links with NDISCOVERY set to ENABLED.

• The command is denied if TL_aid is not ALL and the specified TL has no neighbor discovery
information. The neighbor discovery information will only be available when the neighbor discovery
process has been started with all preconditions met (for example,, the TL is set to IS and the fiber is
connected).

Command Format
RTRV-LADJ-TL:[tid]:{<TL_aid>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<TL_aid>:: STATE=<ladState>,TXDT_TTI=<txTTI>,RXDT_TTI=<rxTTI>"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.56 RTRV-LADJ-TL Parameters

Parameter Value(s) Definition
TL_aid TL-[1,3]-[1-512]-[1-1500] EntityID-NPID-NodeID-TLID

ladState START Identifies the state of the LAD process.

DTRCVD
DTACKED
MISWIRED
OPEN

txTTI A double quoted string consisting of 0 Specifies the TTI string being sent by the local NE. The string is
to 15 printable characters, not the base64 encoded form of the DA DCN Addr format specified
including the quotes. in ITU-T G.7714.1.

Page 30-1076 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.56 RTRV-LADJ-TL Parameters (Continued)

Parameter Value(s) Definition
rxTTI A double quoted string consisting of 0 Specifies the TTI string being received by the local NE.
to 15 printable characters, not
including the quotes.

Example
RTRV-LADJ-TL:CORIANT1:TL-3-2-3:AM0011;

Possible System Response

^^^CORIANT1 06-05-15 02:09:11

M AM0011 COMPLD

^^^"TL-3-2-3::
STATE=OPEN,TXDT_TTI=\"+OYdlQyEKoSNFZ4\",RXDT_TTI=\"+OYdlQyEKoSNFZ4\"";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TL
RTRV-TCE-TL

76.MTFP50/30, Rev B January 2018 Page 30-1077

22. Retrieve Commands TL1 Command Reference Manual

RTRV-LEDS

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-LEDS (Retrieve LEDs) command is intended for use by EMS and potentially other operations support
systems (OSS) that are attempting to display LED status to an operator. This command returns a indication of the
color for each LED that defines what state it is in - including blinking.

Each line in the command response will represents one equipment AID, and a request for multiple equipment AIDs
returns multiple lines - one for each equipment AID. For each equipment AIDs, only the parameters (the LED
descriptions) applicable to this equipment AID is included in the command response.

Restrictions and Exceptions

• The first name-defined parameters entered after the ctag must not have its leading comma.

• Transponders with clearly numbered Line Side may reference PORT# rather than LINE in the system
response.

• When a module is in the shutdown state, all non-status LEDs returns a value of NA. Status LEDs are
the LEDs that typically appear at the top of a module and indicate Active, Power, Fault, and in some
cases an additional indication such as Sync or OSC.

• Parameter ACTIVEsl and FAULTsl is applicable only to the SIOM and shows the ACTIVE and FAULT
LED for the module in SlotID "sl".

Command Format
RTRV-LEDS:[TID]:{<eqpt_aid>|ALL}:CTAG;

Proper System Response

<header>

M CTAG COMPLD

^^^"{eqpt_aid}::ACTIVE=<active_led>,POWER=<power_led>,FAULT=<fault_led>,[ACT_FLT
=<act_flt_led>,][SYNC=<sync_led>,][SYNC1=<sync1_led>,][SYNC2=<sync2_led>,][NE_CR
ITICAL=<critical_led>,][NE_MAJOR=<major_led>,][NE_MINOR=<minor_led>,][ACO=<aco_l
ed>,][LINE=<line_led>,][PORT=<port_led>,][PORT1=<port1_led>,][PORT2=<port2_led>,
][PORT3=<port3_led>,][PORT4=<port4_led>,][PORT5=<port5_led>,][PORT6=<port6_led>,
][PORT7=<port7_led>,][PORT8=<port8_led>,][PORT9=<port9_led>,][PORT10=<port10_led
>,][PORT11=<port11_led>,][PORT12=<port12_led>,][PORT13=<port13_led>,][PORT14=<po
rt14_led>,][PORT15=<port15_led>,][PORT16=<port16_led>,][PORT17=<port17_led>,][PO
RT18=<port18_led>,][PORT19=<port19_led>,][PORT20=<port20_led>,][PORT21=<port21_l
ed>,][PORT22=<port22_led>,][PORT23=<port23_led>,][PORT24=<port24_led>,][PORT25=<
port25_led>,][PORT26=<port26_led>,][PORT27=<port27_led>,][PORT28=<port28_led>,][
PORT29=<port29_led>,][PORT30=<port30_led>,][PORT31=<port31_led>,][PORT32=<port32
_led>,][OSC=<osc_led>,][SUBSLOTFAULT=<subslot_fault_led>,][ACTIVE1=<active_led>,
ACTIVE2=<active_led>,ACTIVE3=<active_led>,ACTIVE4=<active_led>,ACTIVE7=<active_l
ed>,ACTIVE8=<active_led>,ACTIVE9=<active_led>,ACTIVE10=<active_led>,FAULT1=<faul
t_led>,FAULT2=<fault_led>,FAULT3=<fault_led>,FAULT4=<fault_led>,FAULT7=<fault_le

Page 30-1078 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

d>,FAULT8=<fault_led>,FAULT9=<fault_led>,FAULT10=<fault_led>,][OFP1=<ofp_led>,][
OFP2=<ofp_led>,][OFP3=<ofp_led>]"<cr><lf>
;

Parameters
Each parameter described in the command response corresponds to a specific LED on a module. The following
Table displays all LEDs supported by all Modules on the NE. Possible values returned for each LED are:
• RED

• RED_BLINK

• GREEN

• GREEN_BLINK

• AMBER

• AMBER_BLINK

• OFF

• NA

LEDs for Each Module

Table 22.57 LEDs for Each Module

LED Parameter Name
NE_CRITICAL/ NE_MAJOR/

ACTIVE(sl=1-4,7-10)
FAULT9sl=1-4,7-10)
SYNC, SYNC(1,2)

Module
SUBSLOTFAULT
A

(AID)
PORT(1 to n)

PORT{1 to 3}
NE_MINOR

OFP(1 to n)
ACT_FLT
POWER
ACTIVE

FAULT

LINE

OSC
ACO

FAN, FAN8 X X

MFAB, X X X
MFAB2
B
OADMRS X X X X 21 X

OADMRS9 X X X 11 X

OCC X X X X X

OSM2C X X X X 2

OSM1S X X X X 32

OSM2S X X X X 20

SSM2S X X X X 30

OSM4C X X X X 4

OSM4F X X X X 2

OSM4S X X X X 40

76.MTFP50/30, Rev B January 2018 Page 30-1079

22. Retrieve Commands TL1 Command Reference Manual

Table 22.57 LEDs for Each Module (Continued)

LED Parameter Name

NE_CRITICAL/ NE_MAJOR/

ACTIVE(sl=1-4,7-10)
FAULT9sl=1-4,7-10)
SYNC, SYNC(1,2)
Module

SUBSLOTFAULT
(AID)

A
PORT(1 to n)

PORT{1 to 3}
NE_MINOR

OFP(1 to n)
ACT_FLT
POWER
ACTIVE

FAULT

LINE

OSC
ACO
OSM5C X X X X 5

STPM X X X X 2
C
STPM8 X X X X 6

SAIM X

SDM X X

SEIM X 8
E C D
SIOM X 1,2 X X 4 X

STIM X X
E
SH X

A - Indicates the number of PORT(n) parameters returned.

B - OADMRS-20 LEDs use the attributes PORT1 through PORT21 for multiPort LEDs, in which PORT1
through PORT20 are for the 20 ports within the MPO fiber interfaces, and PORT21 is for DWDM Line.
C - STPM8 PORT5 and PORT6 physically reside on the SIOM.
D - ACTIVEsl and FAULTsl is applicable only to the SIOM.
E - Applicable to SH for mTera and SIOM for 8-slot mTera.

Example
RTRV-LEDS:CORIANT1:ALL:CTAG;

Possible System Response

CORIANT1 14-04-29 16:50:35
M CTAG COMPLD
"SH-
20::ACTIVE=NA,POWER=NA,FAULT=NA,NE_CRITICAL=OFF,NE_MAJOR=OFF,NE_MINOR=OFF,"
"OSM2C-20-
2::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=AMBER,SYNC=GREEN,"
"OSM2C-20-
3::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=GREEN,SYNC=GREEN,"
"OSM2C-20-
4::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=OFF,PORT2=OFF,SYNC=GREEN,"
"MFAB-20-8::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"MFAB-20-9::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"OSM2C-20-
10::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=GREEN,SYNC=GREEN,"
"OSM2S-20-
13::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=GREEN,PORT3=OFF,PORT4=O
FF,PORT5=OFF,PORT6=OFF,PORT7=OFF,PORT8=OFF,PORT9=OFF,PORT10=OFF,PORT11=OFF,PORT1
2=OFF,PORT13=OFF,PORT14=OFF,PORT15=OFF,PORT16=OFF,PORT17=OFF,PORT18=OFF,PORT19=O

Page 30-1080 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

FF,PORT20=OFF,SYNC=GREEN,"
"OSM2S-20-
14::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=RED,PORT2=RED,PORT3=RED,PORT4=OFF,P
ORT5=OFF,PORT6=OFF,PORT7=OFF,PORT8=OFF,PORT9=OFF,PORT10=OFF,PORT11=OFF,PORT12=OF
F,PORT13=OFF,PORT14=OFF,PORT15=OFF,PORT16=OFF,PORT17=OFF,PORT18=OFF,PORT19=OFF,P
ORT20=OFF,SYNC=GREEN,"
"MFAB-20-17::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"MFAB-20-18::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"MFAB-20-19::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"MFAB-20-20::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"SEIM-20-21::ACTIVE=NA,POWER=NA,FAULT=NA,ACT_FLT=GREEN"
"SAIM-20-22::ACTIVE=NA,POWER=NA,FAULT=NA,ACT_FLT=GREEN"
"STPM-20-24::ACTIVE=AMBER,POWER=GREEN,FAULT=OFF,SYNC=GREEN,"
"STPM-20-25::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,SYNC=GREEN,"
"SEIM-20-28::ACTIVE=NA,POWER=NA,FAULT=NA,ACT_FLT=GREEN"
"FAN-20-29::ACTIVE=NA,POWER=GREEN,FAULT=OFF,"
"FAN-20-30::ACTIVE=NA,POWER=GREEN,FAULT=OFF,"
"FAN-20-31::ACTIVE=NA,POWER=GREEN,FAULT=OFF,"
"FAN-20-32::ACTIVE=NA,POWER=GREEN,FAULT=OFF,"
"SDM-20-33::ACTIVE=NA,POWER=NA,FAULT=NA,ACO=OFF,ACT_FLT=GREEN"
;

Example
When an NE consists of one 8-slot mTera shelf.
RTRV-LEDS:CORIANT1:ALL:CTAG;

Possible System Response

CORIANT1 15-03-14 13:26:35
M CTAG COMPLD
"SH-20::ACTIVE=NA,POWER=NA,FAULT=NA,"
"OSM2C-20-
2::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=AMBER,SYNC=GREEN,"
"OSM2C-20-
3::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=GREEN,SYNC=GREEN,"
"OSM2C-20-4::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=OFF,PORT2=OFF,SYNC=GREEN,"
"MFAB-20-5::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"MFAB-20-6::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"OSM2C-20-
7::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=GREEN,SYNC=GREEN,"
"OSM2S-20-
10::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,PORT1=GREEN,PORT2=GREEN,PORT3=OFF,PORT4=O
FF,PORT5=OFF,PORT6=OFF,PORT7=OFF,PORT8=OFF,PORT9=OFF,PORT10=OFF,PORT11=OFF,PORT1
2=OFF,PORT13=OFF,PORT14=OFF,PORT15=OFF,PORT16=OFF,PORT17=OFF,PORT18=OFF,PORT19=O
FF,PORT20=OFF,SYNC=GREEN,"
"MFAB-20-11::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"MFAB-20-12::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,"
"STPM8-20-13::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,SYNC=GREEN,"
"STPM8-20-14::ACTIVE=GREEN,POWER=GREEN,FAULT=OFF,SYNC=GREEN,"
"SIOM-20-
15::ACTIVE=NA,POWER=NA,FAULT=NA,PORT1=RED,PORT2=GREEN,PORT3=GREEN,PORT4=RED,NE_C
RITICAL=OFF,NE_MAJOR=OFF,NE_MINOR=OFF,ACTIVE1=OFF,ACTIVE2=GREEN,ACTIVE3=GREEN,AC
TIVE4=GREEN,ACTIVE7=GREEN,ACTIVE8=OFF,ACTIVE9=OFF,ACTIVE10=GREEN,FAULT1=OFF,FAUL

76.MTFP50/30, Rev B January 2018 Page 30-1081

22. Retrieve Commands TL1 Command Reference Manual

T2=OFF,FAULT3=OFF,FAULT4=OFF,FAULT7=OFF,FAULT8=OFF,FAULT9=OFF,FAULT10=OFF,"
"FAN8-20-16::ACTIVE=NA,POWER=GREEN,FAULT=OFF,"
"FAN8-20-17::ACTIVE=NA,POWER=GREEN,FAULT=OFF,"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

Page 30-1082 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-LINKPF

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-LINKPF command instructs the network element (NE) to retrieve a link profile.

Restrictions
• When ALL is used as an AID, information for all link profile entities is retrieved.

Command Format
RTRV-LINKPF:[tid]:{<linkpf_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<linkpf_aid>::PFNAME=<ProfileName>,NAT=<NAT>,HELLOINTV=<HelloIntv>,RTRDEADIN
TV=<RtrDeadIntv>,RETRANSINTV=<RetransmissionInterval>,DEFSLPROF=<DefaultSLProfil
e>,SLPOLICY=<SLPolicy>,GMPLSMODE=<GMPLSMode>,ARUSUPPORT=<ARUSupport>,G709MODE=<G
709Mode>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.58 RTRV-LINKPF Parameters

Parameter Value(s) Definition
linkpf_aid LINKPF-[91-99,1-20] EntityID-LINKPFID

ProfileName 0 to 31 alphanumeric characters. Specifies the Node name.

Refer to section 2 for the applicable characters.

NAT ENABLED Specifies if Network Address

DISABLED Translation (NAT) is enabled

HelloIntv [1-255] Specifies the Hello Interval in seconds

RtrDeadIntv [4-1024] Specifies the Router Dead Interval in seconds.

Retransmissio [1-255] Specifies the retransmission interval in seconds.

nInterval

DefaultSLProfil SLPF-[99,1-20] Specifies the default Service Level Profile

e

SLPolicy SLPOLICY-[1-20] Specifies the default Service Level Profile

76.MTFP50/30, Rev B January 2018 Page 30-1083

22. Retrieve Commands TL1 Command Reference Manual

Table 22.58 RTRV-LINKPF Parameters (Continued)

Parameter Value(s) Definition
GMPLSMode OIF-ENNI-V1 Specifies the GMPLS mode supported
OIF-ENNI-V2
INNI-V1
INNI-V2
INNI-V2-HTL
NONE

ARUSupport ENABLED Specifies if the A-bit, R-bit and U-bit are set in the RSVP
DISABLED Protection Object.

ENABLED: The R-bit is set to zero and the U-bit is set to zero
during initial call setup.The R-bit is set to one and the U-bit
is set to zero during call restoration. The R-bit is set to zero and
the U-bit is set to one during ARR. The A-bit is set to zero at all
times.

DISABLED: The A-bit, R-bit and U-bit are all set to zero at all
times and these bits is silently ignored.

G709Mode V2 This attribute specifies the label format and controlling the
V3 switching capability type for ODU signals of the link.

Example
RTRV-LINKPF::LINKPF-9:AM0011;

Possible System Response

CORIANT1 11-05-15 02:08:15
M AM0011 COMPLD
^^^"LINKPF-9::PFNAME=\"Router
Profile\",NAT=DISABLED,HELLOINTV=10,RTRDEADINTV=40,RETRANSINTV=5,DEFSLPROF=SLPF-
1,SLPOLICY=NONE,GMPLSMODE=NONE,ARUSUPPORT=DISABLED,G709MODE=V2";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands and Autonomous Messages

ED-LINKPF

Page 30-1084 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-LOG

Command Changes Since Previous Feature Package

• None.

Description
Use the RTRV-LOG command to retrieve the log records stored in the TL1 log file of a specific NE. The TL1 log file
records all TL1 command requests and responses on all resources that are accessible by a user, including creation,
deletion and modification of entities, software and database Management activities, as well as all security related
events such as user logging, account creation and modification, modification of system security policies, and so on
This log file is accessible to Admin users only (A8). The maximum number of log records that are stored in a NE is
1000. Each log record can be either a TL1 command (CMD), a TL1 command response (RSP) or TL1 event
message related to Security.

The user can retrieve log records for a specific period of time by specifying an interval.

The user can retrieve log records for a specific user ID by specifying the user ID.

The user can retrieve log records for a specific session ID by specifying the session ID.

The user can retrieve log records by specifying a number (xx) which would corresponds to the last (xx) logs recorded
in the NE.

The user can retrieve log records by combining criteria STARTDATE, STARTTIME, ENDDATE, ENDTIME, UID,
and SESID such that, if specified, the record has to meet all the criteria in order to be displayed.

Separate log records are maintained in the log file for commands, responses and security related events.

Restrictions and Exceptions

• If no date and time, user ID, session ID or number of records parameters are specified, the system will
retrieve all records contained in the log file.

• The first name-defined parameters entered after the ctag must not have its leading comma.

Command Format
RTRV-LOG:[tid]::ctag:::[,STARTDATE=<startdate>][STARTTIME=<starttime>]
[,ENDDATE=<enddate>][,ENDTIME=<endtime>][,UID=<uid>][,SESID=<sesid>][,NUMRECORDS
=<numrecords>];

Proper System Response

There is no log record to retrieve in the criteria specified:
<header>

M^^<ctag>^COMPLD<cr><lf>

/* No records to output */

/**/

76.MTFP50/30, Rev B January 2018 Page 30-1085

22. Retrieve Commands TL1 Command Reference Manual

There is one or more log records that satisfies the criteria:

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^( /* <contents of log record> */ ) +

/**/

Note: + indicates that more that one line is displayed.

Each log record contains the following information:

• Date and time of the TL1 command when it was processed

• User ID (UID) and associated Session Id.

• LOGSEQ (<log_seq>) which is a sequence number unique to each log record.

• For a TL1 command, it includes all parameters described in the Input Command Elements Defined table
in section 2.

• For a TL1 output response message, it includes SID, date and time, M, ctag and completion code as
defined in the Output Response Parameters Defined table in section 2. When the completion code is
"deny", the log also includes the error code.

• For a TL1 event message related to security, the log record would include all parameters related to
REPT^DBCHG and REPT^EVT SECU autonomous messages.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.59 RTRV-LOG Parameters

Parameter Value(s) Definition
startdate YOC-MOY-DOM: (1). YOC = 0 - 99 (2) Specifies the date of the oldest log record to be retrieved:
MOY = 1 - 12 (3) DOM = 1 - 31 - YOC identifies the year of the century.
- MOY identifies the month of the year.
- DOM identifies the day of the month.
If starttime is specified but not startdate, the startdate will default
to the current date.
If startdate and starttime are not specified, the system will
retrieve the oldest record available in the log file.

starttime HOD-MOH-SOM: (1) HOD = 0 - 23 (2) Specifies the time of the oldest log record to be retrieved:
MOH = 0 - 59 (3) SOM = 0 - 59 - HOD identifies the hour of the day.
- MOH identifies the minute of the hour.
- SOM identifies the second of the minute.
If startdate is specified but not starttime, the starttime will default
to 0-0-0.

Page 30-1086 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.59 RTRV-LOG Parameters (Continued)

Parameter Value(s) Definition
enddate YOC-MOY-DOM: (1). YOC = 0 - 99 (2) Specifies the date of the most recent log record to be retrieved:
MOY = 1 - 12 (3) DOM = 1 - 31 - YOC identifies the year of the century.
- MOY identifies the month of the year.
- DOM identifies the day of the month.
If endtime is specified but not enddate, the enddate will default
to the current date.
If enddate and endtime are not specified, the system will retrieve
the oldest record available in the log file.

endtime HOD-MOH-SOM: (1) HOD = 0 - 23 (2) Specifies the time of most recent log record to be retrieved:
MOH = 0 - 59 (3) SOM = 0 - 59 - HOD identifies the hour of the day.
- MOH identifies the minute of the hour.
- SOM identifies the second of the minute.
If enddate is specified but not endtime, the endtime will default
to 0-0-0.

uid 6 to 20 alphanumeric characters. Specifies the user's identity (login name) that was assigned in
the ENT-USER-SECU command.
This parameter can be used in conjunction with a date/time
interval (startdate, starttime, enddate, endtime), and/or with a
session_Id.

sesid [0-999999999] Specifies the Session ID on which a user is logged in. It is

unique for any active session on the NE.
This parameter can be used in conjunction with a date/time
interval (startdate, starttime, enddate, endtime), and/or with a
uid.

numrecords [1-1000] Specifies a number of logs which corresponds to the last xx logs
recorded in the NE log file.
This parameter can not be used if a date/time interval (startdate,
starttime, enddate, endtime) has been specified.

Example
This example retrieves all last 10 TL1 log records:

CORIANT> RTRV-LOG:::C:::NUMRECORDS=10;

A Possible System Response:

CORIANT 06-01-12 10:31:06

M C COMPLD

/* L A 06-09-01 13:58:57 LOGSEQ=1 */

/* CORIANT 06-09-01 13:58:57 */

/* A 5 REPT DBCHG */

/* "TIME=13-58-57,DATE=09-01,,,DBCHGSEQ=3:ED-USER-
SECU:Admin1:UAP=A8,TMOUT=15,PAGE=30,PUWP=25,PELN=3,ALMMSG=ALW,DBCHGMSG=ALW,EVTMS
G=ALW,PMMSG=ALW,STATUS=ENABLED" */

/**/

/* L A 06-09-01 13:58:57 LOGSEQ=2 */

76.MTFP50/30, Rev B January 2018 Page 30-1087

22. Retrieve Commands TL1 Command Reference Manual

/* CORIANT 06-09-01 13:58:57 */

/* A 6 REPT DBCHG */

/* "TIME=13-58-57,DATE=09-01,,,DBCHGSEQ=4:ED-USER-
SECU:EMS7100:UAP=A8,TMOUT=15,PAGE=30,PUWP=25,PELN=3,ALMMSG=ALW,DBCHGMSG=ALW,EVTM
SG=ALW,PMMSG=ALW,STATUS=ENABLED" */

/**/

/* L A 06-09-11 15:11:51 LOGSEQ=3 */

/* CORIANT 06-09-11 15:11:51 */

/* A 14 REPT DBCHG */

/* "TIME=15-11-51,DATE=09-11,,,DBCHGSEQ=13:ED-USER-
SECU:Admin1:UAP=A8,TMOUT=15,PAGE=30,PUWP=25,PELN=3,ALMMSG=ALW,DBCHGMSG=ALW,EVTMS
G=ALW,PMMSG=ALW,STATUS=ENABLED" */

/**/

/* L A 06-09-11 15:11:51 LOGSEQ=4 */

/* CORIANT 06-09-11 15:11:51 */

/* A 15 REPT DBCHG */

/* "TIME=15-11-51,DATE=09-11,,,DBCHGSEQ=14:ED-USER-
SECU:EMS7100:UAP=A8,TMOUT=15,PAGE=30,PUWP=25,PELN=3,ALMMSG=ALW,DBCHGMSG=ALW,EVTM
SG=ALW,PMMSG=ALW,STATUS=ENABLED" */

/**/

/* L CMD 06-09-11 15:12:15 UID=,SESID=1,IPADDRESS=127.0.0.1,LOGSEQ=5 */

/* ACT-USER::Admin1:c::********* */

/**/

/* L RSP 06-09-11 15:12:15 LOGSEQ=6 */

/* CORIANT 06-09-11 15:12:15 */

/* M c COMPLD */

/**/

/* L CMD 06-09-11 15:12:30 UID=Admin1,SESID=1,IPADDRESS=127.0.0.1,LOGSEQ=7 */

/* ent-eqpt::ps-2:C */

/**/

/* L RSP 06-09-11 15:12:30 LOGSEQ=8 */

/* CORIANT 06-09-11 15:12:30 */

/* M C COMPLD */

/**/

Page 30-1088 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

/* L CMD 06-09-11 17:35:49 UID=,SESID=1,IPADDRESS=127.0.0.1,LOGSEQ=9 */

/* ACT-USER::Admin1:c::********* */

/**/

/* L RSP 06-09-11 17:35:49 LOGSEQ=10 */

/* CORIANT 06-09-11 17:35:49 */

/* M c COMPLD */

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-AO

76.MTFP50/30, Rev B January 2018 Page 30-1089

22. Retrieve Commands TL1 Command Reference Manual

RTRV-MGTETH

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-MGTETH command instructs the network element (NE) to retrieve the attributes of a selected
management Ethernet facility entity.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• When ALL is used as an AID, information for all management ETH entities that matches the specified
filtering parameter(s) is retrieved.

Command Format
RTRV-
MGTETH:[tid]:{<mgteth_aid>|ALL}:ctag:::[ALMPF=<almProfile>][:<editablePrimarySta
te>][,<secondaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<mgteth_aid>::ALMPF=<almProfile>,MAC=<mac_address>,AUTONEG=<autoNeg>,RATE=<e
thRate>,OPRATE=<opEthRate>,DUPLEX=<duplexMode>,OPDUPLEX=<opDuplexMode>,FLOWCTRL=
<flowCtrl>,OPFLOWCTRL=<opFlowCtrl>,MTU=<mtu>,ZTCASSIST=<assist_state>,NPOWNER=<N
pOwner>:<pst>,[<sst>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.60 RTRV-MGTETH Parameters

Parameter Value(s) Definition
mgteth_aid MGTETH-20-[13,14,21,24,25,28]-[1-8] EntityID-ShelfID-SlotID-PortID

almProfile 0-20, 99 Specifies the alarm profile table for the facility.

editablePrimar IS Specifies the primary state of the facility. Two states are
yState OOS possible: In-Service (IS) and Out-of-Service (OOS).

mac_address 6 bytes Hex value Specifies the MAC address of the interface.

Example:
5C260A7D447C

autoNeg ON Specifies if 802.3 auto-negotiation signaling is enabled(on) or

OFF disabled (off) on the management ETH facility.

Page 30-1090 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.60 RTRV-MGTETH Parameters (Continued)

Parameter Value(s) Definition
ethRate 10 When auto-negotiation is off, specifies the manually configured
100 rate. When auto-negotiation is enabled, this parameter has no
1000 meaning.
10G
AUTO

opEthRate NA Indicates the operational Ethernet rate.

10 The value NA is returned when the hardware is not present or
100 auto-negotiation is in progress.
1000 The value 10 indicates a 10BASE-T facility.
The value 100 indicates a 100BASE-T or 100BASE-FX facility.
The value 1000 indicates a 1000BASE-T or 1000BASE-X
facility.

duplexMode FDPLX When auto-negotiation is off, specifies the manually configured

HDPLX duplex mode (full or half).When auto-negotiation is enabled, this
AUTO parameter has no meaning.

opDuplexMod NA Indicates the operational duplex mode.

e FDPLX The value NA is returned when the hardware is not present or
HDPLX auto-negotiation is in progress.
The value FDPLX indicates full duplex operation.
The value HDPLX indicates half duplex operation.

flowCtrl OFF When auto-negotiation is off, specifies the type of flow control
TXRX support to be supported:
TX - OFF indicates no pause frames are supported
RX - TXRX indicates symmetric (transmit and receive)
- TX indicates transmit direction only
- RX indicates receive direction only
When auto-negotiation is enabled, this parameter has no
meaning.

mtu 576-1500 octets Specifies the maximum number of octets in the Information and
Padding fields.

assist_state ENABLED Specifies the ZTC Assist state of the interface.

DISABLED When the ZTC Assist state is ENABLED, the NE can be the ZTC
Assist of the ZTC DUC attached to the port.

NpOwner 1 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state and primary state qualifier:
IS-ANR - IS: In-Service
OOS-MAANR - OOS: Out-of-Service
OOS-AU Possible values for PSTQ:
OOS-MA - NR: normal
OOS-AUMA - ANR: abnormal
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- MAANR: management and abnormal

76.MTFP50/30, Rev B January 2018 Page 30-1091

22. Retrieve Commands TL1 Command Reference Manual

Table 22.60 RTRV-MGTETH Parameters (Continued)

Parameter Value(s) Definition
secondaryStat FAF Indicates the secondary state:
e/sst SGEO - FAF for Facility failure.
INCOMP - SGEO for Supporting Entity Outage
ACTIVE Indicate that a module associated with this entity has failed.
- INCOMP for incomplete configuration
Indicate that the MGTETH entity is not associated with a TL and
the MGTETH entity is not a member of an IPPG.
-ACTIVE for ACTIVE Member.
Indicate that the MGTETH entity is the active member of an
IPPG on mTera.

Example
Retrieve an management Ethernet facility
RTRV-MGTETH:CORIANT1:MGTETH-20-21-8:myctag;

Possible System Response

CORIANT1 05-05-08 11:44:21

M MYCTAG COMPLD

^^^"MGTETH-20-21-
8::ALPMF=4,MAC=5C260A7D447C,AUTONEG=ON,RATE=AUTO,OPRATE=100,DUPLEX=AUTO,OPDUPLEX
=FDPLX,FLOWCTRL=AUTO,OPFLOWCTRL=OFF,ZTCASSIST=DISABLED,NPOWNER=1:IS-NR,ACTIVE"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-MGTETH
ED-MGTETH
ENT-MGTETH

Page 30-1092 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-MGTINBANDETH

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-MGTINBANDETH command instructs the network element (NE) to retrieve
an inband management P2PVLAN facility on Packet module.

Restrictions and Exceptions

• The P2P management VLAN can only be created over the interface of CEP,PNP and PPNP port with
type of switch

Command Format
RTRV-
MGTINBANDETH:[tid]:{<mgtinbandeth_aid>|ALL}:[CTAG]:::[<editablePrimaryState>];

Proper System Responses

<header>

M^^<ctag>COMPLD<cr><lf>

^^^" <mgtinbandeth_aid>:: LKTTYPE =<lktype>, P2PVLAN

=<p2pvlan>,MACADDR=<mac_address>,ZTCASSIST=<assist_state> :<pst>"<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.61 RTRV-MGTINBANDETH Parameters

Parameter Value(s) Definition
mgtinbandeth_ MGTINBANDETH-20-[10-16,1-7]-[1- EntityID-ShelfID-SlotID-PortID
aid 20]

editablePrimar IS Specifies the primary state of the facility. Two states are
yState OOS possible: In-Service (IS) and Out-of-Service (OOS).

lktype BROADCAST Specified the Ethernet interface link type: Point to Point or
POINTTOPOINT Broadcast

p2pvlan [1-4094] Specifies the VLAN id of the Ethernet point to point port

mac_address 6 bytes Hex value Specifies the MAC address of an interface

assist_state ENABLED Specifies the ZTC Assist state of the interface.

DISABLED When the ZTC Assist state is ENABLED, the NE can be the ZTC
Assist of the ZTC DUC attached to the port

76.MTFP50/30, Rev B January 2018 Page 30-1093

22. Retrieve Commands TL1 Command Reference Manual

Table 22.61 RTRV-MGTINBANDETH Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier:
IS-ANR - IS: In-Service
OOS-MAANR - OOS: Out-of-Service
OOS-AU Possible values for PSTQ:
OOS-MA - NR: normal
OOS-AUMA - ANR: abnormal
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- MAANR: management and abnormal

mtu 64-1500 octets Specifies the maximum number of octets in the Information and
Padding fields for transmission

Example
RTRV-MGTINBANDETH:CORIANT:MGTINBANDETH-20-16-1:100:MYCTAG:::,

Possible System Response

^^^CORIANT 15-10-08 22:00:36

M MYCTAG COMPLD

"MGTINBANDETH-20-16-1::lktype=P2P,p2pvlan=100,ztcassist=DISABLED,mac=:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-MGTINBANDETH
ED-MGTINBANDETH
DLT-MGTINBANDETH

Page 30-1094 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-NE

Command Changes Since Previous Feature Package

• None.

• Added PMALARMS parameter.

Description
The RTRV-NE command instructs the network element (NE) to retrieve the attributes of the system-level
configuration.

The following table displays all NE configurations supported in this release and the allowed reconfigurations without
deleting the NE database:

Supported Configurations

Table 22.62 Supported Configurations

Cfg
Number Allowed
(in sw) type stype hwr SpanA Span B Reconfig
0a NA NA NA NA NA All
(UNKNOWN_SUB
NODE)

4 DC MTERA MTERA NA NA 0

Note:
a 0 indicates that the user can delete the database and return to UNKNOWN_SUBNODE configuration.

Command Format
RTRV-NE:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"NENAME=<nename>,TYPE=<type>,STYPE=<stype>,HWR=<hwr>,SPANA=<spana>,SPANB=<spa
nb>,LOCATION=<location>,SITE=<site>,VER=<software_ver>,VEND=<vendor>,TIMEZONE=<t
imezone>,TZNAME=<timezonename>,DSP=<dsp>,STSVCMDE=<stsvcmde>,STSVCARCINTV=<stsvc
arcintv>,SYNCOSC=<sync_osc>[,CABLMISMCHK=<Cable_Mismatch_Check>],SYSALMPF=<almPr
ofile>,CPINIT=<cpinit>,CPREADY=<CPReady>,XMITIPGDFLT=<transmit_interpacketgap_de
fault>,PMALARMS=<pmAlarms>:<pst>,[<sst>]"<cr><lf>
;

The following parameters are included in the command response for the mTera UTP
but are not applicable to the mTera: SPANA, SPANB, STSVCARCINTV, SYNCOSC,
XMITIPGDFLT.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1095

22. Retrieve Commands TL1 Command Reference Manual

Table 22.63 RTRV-NE Parameters

Parameter Value(s) Definition
nename 0 to 64 alphanumeric characters. Indicates the name assigned to this particular NE.
Refer to section 2 for the applicable characters.

type DC Specifies the type of configuration of this NE.

NA Each NE type represents the Network configuration that the NE
is placed in.

- DC: Direct Connect

- NA: for Unknown configuration #

stype MTERA Specifies the subtype of the configuration of this NE:

- MTERA for mTera UTP

- NA: for Unknown configuration #0.

hwr MTERA Specifies the Hardware Release used in the NE.

NA - MTERA: specifies mTera
- NA: for Unknown configuration #0.

spana NA Specifies the kind of input amplification used in the A direction.

- NA: Not Applicable

spanb NA Specifies the kind of input amplification used in the B direction.

- NA: Not Applicable

location 0 to 31 alphanumeric characters. Indicates the name of the location of this particular NE.

site 0 to 31 alphanumeric characters. Indicates the name or CLLI of the site where this NE is located.

software_ver One to 11 alphanumeric characters. Indicates the software version of this particular NE.

vendor CORIANT Indicates the vendor name of this NE.

timezone [0-75] Indicates the time zone number to which this NE is assigned.
- 0: indicates an unknown time zone.

Page 30-1096 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.63 RTRV-NE Parameters (Continued)

Parameter Value(s) Definition
timezonename Eniwetok-Kwajalein Indicates the Name of the Time Zone of this NE.
Midway Island-Samoa Note that GMT time zone offset value may be adjusted when
Hawaii daylight saving time is active:
Alaska 1: Eniwetok-Kwajalein [GMT-12:00]
Pacific Time 2: Midway Island-Samoa [GMT-11:00]
Arizona 3: Hawaii [GMT-10:00]
Mountain Time 4: Alaska [GMT-09:00]
CentralAmerica 5: Pacific Time[US and Canada] [GMT-08:00]
Central Time 6: Arizona [GMT-07:00]
Mexico City-Tegucigalpa 7: Mountain Time [US and Canada] [GMT-07:00]
Saskatchewan 8: CentralAmerica [GMT-06:00]
Bagota-Lima-Quito 9: Central Time [US and Canada] [GMT-06:00]
Eastern Time 10: Mexico City-Tegucigalpa [GMT-06:00]
Indiana 11: Saskatchewan [GMT-06:00]
Atlantic Time 12: Bagota-Lima-Quito [GMT-05:00]
Caracas-La Paz 13: Eastern Time [US and Canada] [GMT-05:00]
Santiago 14: Indiana[East] [GMT-05:00]
Newfoundland 15: Atlantic Time [Canada] [GMT-04:00]
Brasilia 16: Caracas-La Paz [GMT-04:00]
Buenos Aires 17: Santiago [GMT-04:00]
Georgetown 18: Newfoundland [GMT-03:30]
Greenland 19: Brasilia [GMT-03:00]
Mid-Atlantic 20: Buenos Aires, Georgetown [GMT-03:00]
Azores 21: Greenland [GMT-03:00]
Cape Verde Is. 22: Mid-Atlantic [GMT-02:00]
Casablanca-Monrovia 23: Azores [GMT-01:00]
Greenwich Mean Time-Dublin- 24: Cape Verde Is. [GMT-01:00]
Edinburgh-Lisbon-London 25: Casablanca-Monrovia [GMT]
Amsterdam-Copenhagen-Madrid- 26: Greenwich Mean Time: Dublin-Edinburgh-Lisbon-London
ParisVilnius [GMT]
Belgrade-Sarajevo-Skopje-Sofija- 27: Amsterdam-Copenhagen-Madrid-ParisVilnius [GMT+01:00]
Zargreb 28: Belgrade-Sarajevo-Skopje-Sofija-Zargreb [GMT+01:00]
Bratislava-Budapest-Ljublijana- 29: Bratislava-Budapest-Ljublijana-Prague-Wasaw
Prague-Wasaw [GMT+01:00]
Brussels-Berlin-Bern-Rome- 30: Brussels-Berlin-Bern-Rome-Stockholm-Vienna
Stockholm-Vienna [GMT+01:00]
West Central Africa 31: West Central Africa [GMT+01:00]
Athens-Istanbul-Minsk 32: Athens-Istanbul-Minsk [GMT+02:00]
Bucharest 33: Bucharest [GMT+02:00]
Cairo 34: Cairo [GMT+02:00]
Harare-Pretoria 35: Harare-Pretoria [GMT+02:00]

76.MTFP50/30, Rev B January 2018 Page 30-1097

22. Retrieve Commands TL1 Command Reference Manual

Table 22.63 RTRV-NE Parameters (Continued)

Parameter Value(s) Definition
timezonename Helsinki-Riga-Tallinn 36: Helsinki-Riga-Tallinn [GMT+02:00]
(continue) Jerusalem 37: Jerusalem [GMT+02:00]
Israel 38: Israel [GMT+02:00]
Baghdad 39: Baghdad [GMT+03:00]
Kuwait-Riyadh 40: Kuwait-Riyadh [GMT+03:00]
Moscow-St.Petersburg-Volgograd 41: Moscow-St.Petersburg-Volgograd [GMT+03:00]
Nairobi 42: Nairobi [GMT+03:00]
Tehran 43: Tehran [GMT+03:30]
Abu Dhabi-Muscat 44: Abu Dhabi-Muscat [GMT+04:00]
Baku 45: Baku- [GMT+04:00]
Tbilisi 46: Tbilisi [GMT+04:00]
Kabul 47: Kabul [GMT+04:30]
Ekaterinburg 48: Ekaterinburg [GMT+05:00]
Islamabad-Karachi-Tashkent 49: Islamabad-Karachi-Tashkent [GMT+05:00]
Mumbai-Calcutta-Chennai-NewDelhi 50: Mumbai-Calcutta-Chennai-New Delhi [GMT+05:30]
Kathmandu 51: Kathmandu [GMT+05:45]
Dhaka 52: Dhaka [GMT+06:00]
Almaty 53: Almaty [GMT+06:00]
Colombo 54: Colombo [GMT+06:00]
Rangoon 55: Rangoon [GMT+06:30]
Bangkok 56: Bangkok-Hanoi-Jakarta [GMT+07:00]
Beijing-Chongqing-Hong Kong-Urumqi 57: Beijing-Chongqing-Hong Kong-Urumqi [GMT+08:00]
Perth 58: Perth [GMT+08:00]
Singapore-KualaLumpur 59: Singapore-Kuala Lumpur [GMT+08:00]
Taipei 60: Taipei [GMT+08:00]
Osaka-Sapporo-Tokyo 61: Osaka-Sapporo-Tokyo [GMT+09:00]
Seoul 62: Seoul [GMT+09:00]
Yakutsk 63: Yakutsk [GMT+09:00]
Adelaide 64: Adelaide [GMT+09:30]
Darwin 65: Darwin [GMT+09:30]
Brisbane 66: Brisbane [GMT+10:00]
Canberra-Melbourne-Sydney 67: Canberra-Melbourne-Sydney [GMT+10:00]
Guam-PortMoresby 68: Guam-Port Moresby [GMT+10:00]
Hobart 69: Hobart [GMT+10:00]
Vladivostok 70: Vladivostok [GMT+10:00]
Magadan-Solomon Is.-NewCaledonia 71: Magadan-Solomon Is.-New Caledonia [GMT+11:00]
Auckland-Wellington 72: Auckland-Wellington [GMT+12:00]
Fiji-Kamchatka-Marshall Is 73: Fiji-Kamchatka-Marshall Is. [GMT+12:00]
Nukualofa' 74: Nuku'alofa [GMT+13:00]
Kiritimati 75: Kiritimati [GMT+14:00]
NA

dsp ON Specifies the Time of Day Clock Daylight Saving Policy of this
OFF NE.

stsvcmde STS Specifies the operating mode of the NE. NE can operate in
VC SONET mode (value = STS) or in SDH mode (value=VC).
UNKNOWN

Cable_Mismat DISABLED Specifies the support of cable mismatch check on cable physical
ch_Check connection between transponder line port (OCH-P) and CDC
add/drop port on mTera UTP NE.

DISABLED: In the NE, transponder line port will add/drop

through MCS based CDC module without cable mismatch
check.

almProfile [0-20] or 99 Specifies the default alarm profile table for the NE.

Page 30-1098 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.63 RTRV-NE Parameters (Continued)

Parameter Value(s) Definition
cpinit ALW Specifies the Transport Control Plane Initialization for the NE.
INH Enter ALW to allow the Transport Control Plane to initialize.
Enter INH to inhibit the Transport Control Plane from initializing.
Note, MCN and SCN is initialized even when CPINIT is INH.

pst IS-NR Indicates the primary state of the NE. Possible

IS-ANR primary states include:
IS-RST - in-service, normal (IS-NR)
IS-ANRST - in-service, abnormal (IS-ANR)
OOS-MA - in-service, restricted (IS-RST)
OOS-MAANR - in-service, abnormal and restricted (ISANRST)
- out-of-service, management (OOS-MA)
- out-of-service, management and abnormal (OOS-MAANR)

sst MT Indicates the secondary state of the NE. Possible secondary

states include:
- maintenance (MT)

cpready NONE Specifies the status of all partitions (not just TPCP) initialization,
MCN_SCN since its value can also be MCN_SCN.
INIT_FAIL
ALL INIT_FAIL implies the initialization failure, timeout due to either
MCN/SCN, TPCP or any CP issues caused by NE.

TPCP functionalities does not be available until CPREADY is in

the state of "ALL".

Example
RTRV-NE:::AM0102;

Possible System Response

Followed by lines of data similar to the following output:
CORIANT1 02-02-02 00:50:03

M AM0102 COMPLD

"NENAME=\"7100HAWAII\",TYPE=DC,STYPE=MTERA,HWR=MTERA,SPANA=NA,SPANB=NA,LOCATION=
\"ROOM312B\",SITE=\"MTRLBQDS1203456\"VER=FP2.0.0,VEND=CORIANT,STSVCMODE=STS,STSV
CARCINTV=8-30,TIMEZONE=3,TZNAME=\"HAWAII [GMT-9-
00]\",SYNCOSC=UNKNOWN,DSP=ON,CPREADY=ALL,CPINIT=ALW,XMITIPGDFLT=9,PMALARMS=DISAB
LED,:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-NE

76.MTFP50/30, Rev B January 2018 Page 30-1099

22. Retrieve Commands TL1 Command Reference Manual

RTRV-NETYPE

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-NETYPE command instructs the network element (NE) to retrieve the attributes of the NE software
currently operating on the network element.

Command Format
RTRV-NETYPE:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<vendor>,<product>,<type>,<sw_issue>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.64 RTRV-NETYPE Parameters

Parameter Value(s) Definition
vendor CORIANT Indicates the vendor name of this NE.

product MTERA Indicates the network element family this software belongs to.
MTERA8

type DC Specifies the type of configuration of this NE.

NA Each NE type represents the Network configuration that the NE
is placed in.
- DC: Direct Connect
- NA: for Unknown configuration

sw_issue One to 11 alphanumeric characters. Indicates the software version currently running on this
particular NE.

Example
RTRV-NETYPE:CORIANT1::AM0209;

Possible System Response

CORIANT1 07-07-02 03:20:21

M AM0209 COMPLD

"CORIANT,MTERA,DC,2.0.0"

Page 30-1100 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SW
RTRV-NE

76.MTFP50/30, Rev B January 2018 Page 30-1101

22. Retrieve Commands TL1 Command Reference Manual

RTRV-NODE

Command Changes Since Previous Feature Package

• Add support for the IP parameter

• Remove support for the NODEID parameter

Description
The RTRV-NODE command instructs the network element (NE) to retrieve the Node entity.

Restrictions
• When ALL is used as an AID, information for all node entities is retrieved.

Command Format
RTRV-NODE:[tid]:{<node_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<node_aid>::NODENAME=<NodeName>,RAAID=<RoutingAreaAID>,IP=<SupportIP>:<pst>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.65 RTRV-NODE Parameters

Parameter Value(s) Definition
node_aid NODE-[1,3]-[1-512] EntityID-NPID-NodeID

NodeName A double quoted string consisting of 0 Specifies the Node name.

to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

RoutingAreaAI OSPFAREA-[1,3]-1-[1-32] Identifies the router area entity which represents the lowest
D routing area this node is participating in.

SupportIP NO Specifies if this Node Supports IP or not.

YES
NO - This Node does not support IP
YES - This Node supports IP

pst IS Specifies the primary state of the entity.

OOS Two states are possible: In-Service (IS) and Out-of-Service
(OOS).

Example
RTRV-NODE::NODE-3-1:AM0011;

Page 30-1102 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^"NODE-3-1::NODENAME=\"TPCP Shelf Node\",RAAID=OSPFAREA-3-1-1,IP=NO:IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NODE
ED-NODE
ENT-NODE

76.MTFP50/30, Rev B January 2018 Page 30-1103

22. Retrieve Commands TL1 Command Reference Manual

RTRV-NODEIDMAP

Command Changes Since Previous Feature Package

• Added OTUC2, OTUC3 facility AID.

• Update NETID to support up to 35 characters.

Description
The RTRV-NODEIDMAP command retrieves mappings between TID-AID and NODEID-IFINDEX names. The
command supports TID-AID to NODEID-IFINDEX as well as NODEID-IFINDEX to TID-AID translation. The
direction of translation is determined by the filter parameters provided to the command. When a FACAID is
specified, the translation is from TID-AID to NODEID-IFINDEX. When an IPRTEELEMNT is specified, the
translation is from NODEID-IFINDEX to TID-AID,

Restrictions and Exceptions

• If IPRTEELEMNT is provided, TID, FACAID and IFINDEXLAYER must not be provided.

• If FACAID is provided, IPRTEELEMNT must not be provided.

• If FACAID is provided and NETID is not provided, the local system TID is used for NETID.

Command Format
RTRV-
NODEIDMAP:[tid]::<ctag>:::[,NETID=<targetid>][,FACAID=<fac_aid>][,IFINDEXLAYER=<
ifIndexLayer>][,IPRTEELEMNT=<IP_routeElement>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::NETID=<targetid>,FACID=<fac_aid>,IPRTEELEMNT=<IP_routeElement>,NODEID=<nod
eAID>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.66 RTRV-NODEIDMAP Parameters

Parameter Value(s) Definition
targetid One to 35 alphanumeric characters. Specifies the target NE identifier
The following characters are
supported: (1)A to Z, (2) 0 to 9, (3) .
(period) - (hyphen) and _
(underscore).

Page 30-1104 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.66 RTRV-NODEIDMAP Parameters (Continued)

Parameter Value(s) Definition
fac_aid OC3-20-[1-16]-[1-32], Specifies the target facility identifier
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
ODUF-20-[1-16]-[1-20]-[1-80],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-32]-[1-80],
OTU1-20-[1-16]-[1-32],
OTUC2-20-[1-16]-[1-2],
OTUC3-20-[1-16]-1,
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-40],
ODU2E-20-[1-16]-[1-5]-[1-80],
OTU2-20-[1-16]-[1-40],
OTU4-20-[1-16]-[1-5],
OCH-P-20-[1-16]-[1-40],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6]

ifIndexLayer OTS, OPS, OMS, OCH, OTU, ODU, Specifies the specific layer to provide an ifindex
OC, LINE, STS

IP_routeEleme [0-255].[0-255].[0-255].[0-255]-n Specifies the IP format identifier associated with the requested
nt where n = 8 hexadecimal digits AID in the form of NodeID-ifindex. NodeID is a 32-bit dotted
Decimal Octet string. IfIndex is a 32-bit Hex string.

nodeAID NODE-[1,3]-[1-512] Specifies the Node associated with this facility

Example
RTRV-NODEIDMAP:::AM0011,,,IPRTEELEMNT=10.1.2.3-00FF1122;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^"::NETID=CORIANT1,FACID=ODU2-1-1-1-1,IPRTEELEMNT=10.1.2.3-
00FF1122,NODEID=NODE-3-1"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-TL

76.MTFP50/30, Rev B January 2018 Page 30-1105

22. Retrieve Commands TL1 Command Reference Manual

RTRV-NP

Command Changes Since Previous Feature Package

• None.

Description
Use the RTRV-NP command to retrieve the attributes of the Network Partition entities.

Restrictions
• None

Command Format
RTRV-NP:[tid]:{<np_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<np_aid>::NPNAME=<NpName>,TIMEOUT=<Timeout>:<pst>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.67 RTRV-NP Parameters

Parameter Value(s) Definition
np_aid NP-[1,3] EntityID-NPID

NpName A double quoted string consisting of 0 Specifies the Network Partition name.
to 30 printable characters, not
including the quotes.

Timeout [120-900] Specifies the default timeout for a call setup request.

pst IS-NR Indicates the primary state and primary state qualifier of the
Network Partition.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

Example
RTRV-NP:CORIANT1:NP-3:AM0209;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0209 COMPLD
^^^"NP-3::NPNAME=\"TPCP Partition\",TIMEOUT=200:IS-NR"
;

Page 30-1106 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NP
ED-NP
ENT-NP
RTRV-NP-STATS

76.MTFP50/30, Rev B January 2018 Page 30-1107

22. Retrieve Commands TL1 Command Reference Manual

RTRV-NP-STATS

Command Changes Since Previous Feature Package

• Updated the parameter definitions and added text to the description section describing a crankback
scenario.

Description
Use the RTRV-NP-STATS command to retrieve the statistics for the Network Partition entities. These statistics are
always collected and the counters are reset daily at midnight.

CurrFailCallAttempts will count failed call attempts and crankbacks. Crankbacks can occur for a successful call
setup. For example, if a call is setup successfully, the origination node will increment the CurrActiveCalls count by
1, and if an intermediate node performs crankbacks for this call, the CurrFailCallAttempts is incremented in the
intermediate node to reflect the number of crankbacks performed by the intermediate node for this call.

Restrictions
• Only supported calls on NP-3 apply to this command.

Command Format
RTRV-NP-STATS:[tid]:{<np_aid>|ALL}:ctag;

Proper System Response

The completed response indicates that the call has been establish through all the NE elements between the call
end-points.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<np_aid>::NPNAME=<NpName>,CACTCALL=<CurrActiveCalls>,CCALLATTEMPTS=<CurrCall
Attempts>,CFCALLATTEMPS=<CurrFailCallAttempts>,CFCALLATTEMPSRT=<CurrFailCallAtte
mptsRoute>,PCALLATTEMPTS=<PrevCallAttempts>,PFCALLATTEMPS=<PrevFailCallAttempts>
,PFCALLATTEMPSRT=<PrevFailCallAttemptsRoute>"<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.68 RTRV-NP-STATS Parameters

Parameter Value(s) Definition
np_aid NP-[1,3] EntityID-NPID

NpName A double quoted string consisting of 0 Specifies the Network Partition name.
to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

CurrActiveCall [0-65535] Specifies the number of active calls.

s

CurrCallAttem [0-65535] Specifies the number of call attempts in the current 24-hour
pts period (since midnight (00:00)).

Page 30-1108 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.68 RTRV-NP-STATS Parameters (Continued)

Parameter Value(s) Definition
CurrFailCallAtt [0-65535] Specifies the number of failed call attempts in the current 24-
empts hour period (since midnight (00:00)).

CurrFailCallAtt [0-65535] Specifies the number of failed call attempts due to a routing
emptsRoute failure in the current 24-hour period (since midnight (00:00)).

PrevCallAttem [0-65535] Specifies the number of call attempts in the previous 24 hour
pts period.

PrevFailCallAtt [0-65535] Specifies the number of failed call attempts in the previous 24
empts hour period.

PrevFailCallAtt [0-65535] Specifies the number of failed call attempts due to a routing
emptsRoute failure in the previous 24 hour period.

Example
The following example retrieves the current statistics from Network Partition 3.
RTRV-NP-STATS::NP-3:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^"NP-3::NPNAME=\"Transport CP\" ,CACTCALL=50,CCALLATTEMPTS=100,
CFCALLATTEMPS=2,CFCALLATTEMPSRT=1,PCALLATTEMPTS=200,
PFCALLATTEMPS=5,PFCALLATTEMPSRT=2"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NP
ED-NP
ENT-NP
RTRV-NP

76.MTFP50/30, Rev B January 2018 Page 30-1109

22. Retrieve Commands TL1 Command Reference Manual

RTRV-NTPPEER

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-NTPPEER command instructs the network element (NE) to retrieve the attributes of a NTP Peer. Up to
two NTP Peers can be configured per NE.

Restrictions and Exceptions

• When "ALL" is used as an AID, information for all NTP peer entities is retrieved.

Command Format
RTRV-NTPPEER:[tid]:{<ntppeer_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<ntppeer_aid>::[IPPEER=<IPPeer>][,PEERNAME=<NTPName>][,NTPVERSION=<ntp_ver>]
[,PORT=<ntppeer_port>][,HOSTMODE=<ntppeer_hostmode>]
[,POLLINGINTERVAL=<ntppeer_poll_invl>][,STRATUM=<ntppeer_stratum>]
[,PRECISION=ntppeer_precision][,REACHABLE=<ntppeer_reach>][,DELAY=<ntppeer_delay
>][,DISPERSION=<ntppeer_dispersion>][,ROOTDELAY=<ntppeer_root_delay>][,ROOTDISPE
RSION=<ntppeer_root_dispersion>]: <ntppeer_state>,[<sst>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.69 RTRV-NTPPEER Parameters

Parameter Value(s) Definition
ntppeer_aid NTPPEER-[2,1] EntityID-PeerID

IPPeer [0-255].[0-255].[0-255].[0-255] Indicates the IP address of the NTP Peer being entered.

NTPName 0 to 31 alphanumeric characters. Indicates the customer entered additional field to label the NTP
Peer.
Refer to section 2 for the applicable characters.

ntp_ver 3 Indicates the Network Time Protocol Version.

mTera UTP support NTP Version 3 defined in RFC 1305.

ntppeer_port 123 The port number that is used to transfer NTP Packets on the
HOST. By default, the port 123 is assigned to NTP by the
Internet Assigned Numbers Authority.

ntppeer_hostm CLIENT The association type of the NTP Host and NTP Peer, from
ode viewpoint of the host. The mode can take on Client (Default)
mode only.

Page 30-1110 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.69 RTRV-NTPPEER Parameters (Continued)

Parameter Value(s) Definition
ntppeer_poll_i [64-1024] This is an integer number indicating the HOST polling interval
nvl between transmitted messages, in seconds.

ntppeer_stratu [0-15] This attribute indicates the stratum of local clock. A value of "0",
m indicates that Stratum in "Unspecified".

ntppeer_reach YES Indicates if the NTP Peer is reachable or not.

NO

ntppeer_delay +/- 0.0003 to 32768 This is a signed floating-point number indicating the round-trip
delay of the peer clock relative to the local clock over the
network path between them, in seconds.
Note that this variable can take on both positive and negative
values, depending on clock precision and skew-error
accumulation.

ntppeer_disper [0.0003-32768] This is a signed floating-point number indicating the maximum

sion error of the peer clock relative to the local clock over the network
path between them, in seconds.
Only positive value greater than zero is possible.

ntppeer_root_ +/- 0.0003 to 32768 This is a signed floating-point number indicating the total round-
delay trip delay to the primary reference source at the root of the
synchronization subnet, in seconds.
Note that this variable can take on both positive and negative
values, depending on clock precision and skew.

ntppeer_root_ [0.0003-32768] This is a signed floating-point number indicating the maximum

dispersion error relative to the primary reference source at the root of the
synchronization subnet, in seconds.
Only positive value greater than zero is possible.

ntppeer_state IS-NR Indicates the primary state of the entity.

OOS-AU - IS-NR (In-Service Normal.)
OOS-AUMA - OOS-AU (PEER can not be reached.)
OOS-MA - OOS-AUMA (PEERS is OOS and can not be reached.)
- OOS-MA (PEERS is OOS.)

sst FLT Indicates the secondary state of the entity.

- FLT: fault (PEER cannot be reached)
Only applicable when the entity primary state is OOS-AU or
OOS-AUMA.

ntppeer_precis [0.0-1000.0] This is an unsigned floating-point number indicating the

ion precision of the various clocks, in milliseconds.

Example
Enter the following command to retrieve the first NTPPEER of a NE.
RTRV-NTPPEER:CORIANT1:NTPPEER-1:AM0209;

Possible System Response

^^^CORIANT1 02-02-02 00:50:03

M AM0102 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-1111

22. Retrieve Commands TL1 Command Reference Manual

^^^"NTPPEER-1::IPPEER=138.111.101.1,PEERNAME=\"CORIANT GNE1\",NTPVERSION=3,
PORT=123,HOSTMODE=CLIENT,POLLINGINTERVAL=64,STRATUM=2,PRECISION=(+150.2),
REACHABLE=YES,DELAY=(+0.025),DISPERSION=(+0.0233),ROOTDELAY=(-0.0034),
ROOTDISPERSION=(+0.02):IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-NTPPEER
ED-NTPPEER
ENT-NTPPEER

Page 30-1112 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OCH

Command Changes Since Previous Feature Package

• Added support for OSM-4S.

Description
The RTRV-OCH command instructs the network element (NE) to retrieve the attributes of the specified Optical
Channel (OCH) facility entity. There are different OCH facilities in a mTera UTP system.

Restrictions and Exceptions

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• FECTYPE applies when the supporting module is OSM-2S/OSM-2C/OSM-4C/OSM-4F/OSM-4S

module:
- The OSM-2S/OSM-4S supports 4 FEC types: 1) Regular G.709 FEC 2) Super FEC (G.975.1 I.4
EFEC), 3) SuperI7 FEC (G.975.1 I.7 EFEC) or 4) NOFEC;
- The OSM-2C support Soft-Decision FEC (SOFT) for an OCH-P with CLOCKTYPE=OTU4FEC15 and
Soft Decision FEC 21% + GFEC (SOFT21GFEC) for an OCH-P with CLOCKTYPE=OTU4FEC21;
- The OSM-4C supports only FECTYPE SOFT;
- The OSM-4F supports only FECTYPE SOFT25EFEC.

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

• NPOWNER is displayed when an OCH, OCH-L or OCH-P is owned by Control Plane. For example,
NPOWNER is displayed for OCH-L after cross connection of OCH-L to OCH-P or OCH-L to OCH-L
provisioned by CP; displayed for OCH-P facility after OCH-P TSL provisioned by CP; displayed for OCH
facility when OCH TSL is provisioned if the OCH exists, else it does not be shown/displayed in the
command response

• FREQ is implicitly decided by cross connected OCH-L on OCH entity of OMD, CDC module.

• In mTera UTP NE, when Frequency of OCH or OCH-P entity is decided per the cross-connection or
external connection by setting CHAN, FREQ parameter is implicitly updated to be the decided
frequency. When frequency is not associated, null value is displayed.

• In mTera UTP NE, OCH-OS is only supported on OSM-4C and OSM-4F modules. Only External
connection is supported for OCH-OS.

• Retrieval of parameter ROLLOFF is only applicable for OCH-OS on OSM-4F and OSM-4C. The
applicable values are 0.2 or 0.8 for OSM-4F, and 0.8 for OSM-4C.

Command Format
RTRV-OCH:[tid]:{<och_aid>|ALL}:ctag:::[ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<och_aid>::CPTYPE=<cp_type>[,MONOTI=<MonitorOTI>][,EXTCONNECT=<ExtConnectivi
ty>][,EXTCHAN=<ExtChan>][,CONNECTED=<ConnectedTo>][,OEOREGEN=<oeoregen>][,OTUMAP
=<OTUMapping>][,FECTYPE=<fecType>][,SDTHRESH=<SDThreshold>][,EXPOTUTRC=<OTUExpTr

76.MTFP50/30, Rev B January 2018 Page 30-1113

22. Retrieve Commands TL1 Command Reference Manual

c>][,OTUTRC=<OTUTrc>][,MONOTUTRC=<OTUMonTrc>][,EXPOPER=<ExpOperator>][,EXPDAPI=<
ExpDAPI>][,EXPSAPI=<ExpSAPI>][,TXOPER=<TxOperator>][,TXDAPI=<TxDAPI>][,TXSAPI=<T
xSAPI>][,TIMDEF=<TIMdefinition>][,CLOCKTYPE=<ClkType>][,ALMPF=<almProfile>][,NPO
WNER=<NpOwner>][DEGM=<degrade_interval>][DEGTHR=<degrade_threshold>][,AAMINGR=<A
ttAdjModeIngress>][,AAMEGR=<AttAdjModeEgress>][,FREQ=<frequency>][,MODUFMT=<Modu
lationFormat>][,TXPWR=<TransmitPower>][,ENCDNG=<Encoding>][,ROLLOFF=<rolloff>][,
INGRPWRCORR=<in_pwr_correct>][,OMSPWRCORR=<oms_pwr_correct>]:<pst>,[<sst>]"<cr><
lf>

Table 22.70 Parameter Applicability When Retrieving the Entity

PARAMETER DEFa OCH OCH-L OCH-P OCH-OS
CPTYPE ND X X X X

EXTCHAN ND X X

EXTCONNECT ND Xb

CONNECTED ND Xb X X

AAMEGR ND X

AAMINGR ND X

OTUMAP ND X

FECTYPE ND X X

EXPOPER ND X

EXPOTUTRC ND X

EXPDAPI ND X

EXPSAPI ND X

FREQ ND X

OTUTRC ND X

MONOTUTRC ND X

TIMDEF ND X

TXOPER ND X

TXDAPI ND X

TXSAPI ND X

CLOCKTYPE ND Xc

ALMPF ND X X X X

NPOWNER ND Xb X X

DEGM ND X

DEGTHR ND X

MODUFMT ND X X

TXPWR ND X

ROLLOFF ND Xd

Page 30-1114 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.70 Parameter Applicability When Retrieving the Entity (Continued)

PARAMETER DEFa OCH OCH-L OCH-P OCH-OS
ENCDNG ND X

INGRPWRCORR ND X

OMSPWRCORR ND X

PST PD X X X X

SST PD X X X X

a. ND: Name Defined or PD: Position Defined.

b. This parameter is only applicable to CDCP and OMD.
c. Applies to OSM-2S, OSM-4S and OSM-2C only.
d. Applies to OSM-4C and OSM-4F only.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.71 RTRV-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

editablePrimar IS Indicates the primary state of the facility.

yState OOS Possible values for PST:
IS: In-Service
OOS: Out-of-Service

76.MTFP50/30, Rev B January 2018 Page 30-1115

22. Retrieve Commands TL1 Command Reference Manual

Table 22.71 RTRV-OCH Parameters (Continued)

Parameter Value(s) Definition
cp_type OSM2C - OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
2 (CFP)
OSM2S - OTN SWITCHING MODULE
2
(SFP+)
OADMRS20 - OPTICAL ADD DROP
MULTIPLEXER ROUTE AND
SELECT - 20
OADMRS9 - OPTICAL ADD DROP
MULTIPLEXER ROUTE AND
SELECT - 9 PORTS
CDC8D6 - 8D PLUGGABLE CDC
MODULE - 6 ADD/DROP PORTS
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OPTICAL MULTIPLEXER/
DEMULTIPLEXER
CD4D8 - COLORLESS
DIRECTIONLESS 4 DEGREES 8
ADD DROP
OSM4S - OTN SWITCHING MODULE
4 (SFP+)

ExtConnectivit YES Indicates if an OCH facility on ADD/DROP port of the module is

y NO connected to an Alien (Non Coriant) transponder.

Page 30-1116 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.71 RTRV-OCH Parameters (Continued)

Parameter Value(s) Definition
ExtChan (1)NA (2)1 to 88 (3)191350000 to Specifies the DWDM Channel number or frequency at which the
196100000 in increments of 50000 (4) interface operates and enables the transmit laser when set to a
191338750 to 196111250 in increment value 1 to 88, 191350000 to 196100000 MHz, 191338750 to
of 125 (5) 191150000 to 196100000 in 196111250 MHz, or 191150000 to 196100000 MHz.
increments of 500
Values of 1-88 represent the channel ID in the 88 channel plan
where each channel ID has an associated frequency. Values of
191350000 to 196100000 in increments of 50000 represents the
frequency in MHz in increments of 50 GHz and covers 96
channels. Values of 191338750 to 196111250 in increments of
125 represents the frequency in MHz in increments of 125 MHz
and covers 96+ channels. Values of 191150000 to 196100000
in increments of 500 represents the frequency in MHz in
increments of 500 MHz and covers 96+ channels.

The OSM-2C Tunable CFP supports values of 1 to 88 and

191350000 to 196100000 MHz in increments of 50000 MHz
(covering 96 channels with 50 GHz spacing).
The OSM-4C Tunable optics supports values of 1 to 88 and
values of 191338750 MHz to 196111250 MHz in steps of 125
MHz.
The OSM-4F Tunable optics supports values of 1 to 88 and
191150000 MHz to 196100000 MHz in steps of 500 MHz.
All other modules support values of 1 to 88.

This parameter is used when directly connecting the module to a

separate network element, rather than connecting to an optical
multiplexer/demultiplex module within the same network
element where the channel is provisioned with an OCH-L to
OCH-P OEO Regeneration crossconnection.
When the ExtChan value is NA, the transmit laser is either
disabled and no channel has yet been selected, or the optical
channel is involved in an OCH-L to OCH-P/OCH-L cross-
connection where the frequency is set based on the OCH-L.

ConnectedTo 0 to 36 characters, inclusive. This attribute can be used to indicate remote NE TID & Module/
Facility AID to which the current facility is connected.
This parameter applies to:
1) OCH facility on the Add/Drop port of a CDCP, OMD module
when it was explicitly created for connection to Non-Coriant
transponder.
2) OCH-P/OCH-OS facility on a transponder which is connected
to external equipment.

Refer to section 2 for the applicable characters.

OTUMapping ENABLED Indicates if the OTU mapping is enabled or disabled. This

DISABLED parameter is always ENABLED for transponders.

76.MTFP50/30, Rev B January 2018 Page 30-1117

22. Retrieve Commands TL1 Command Reference Manual

Table 22.71 RTRV-OCH Parameters (Continued)

Parameter Value(s) Definition
fecType REGULAR Specifies the type of Forward Error Correction on the OCH-P
NOFEC facility.
SUPER
SUPERI7 OTU2 and OTU2e based OCH-P interfaces
SOFT (CLOCKTYPE=G709,OVRCLK_FS) support the following
SOFT21GFEC values:
SOFT25EFEC NOFEC = FEC processing disabled.
REGULAR = G.709 compliant GFEC with a 6.2dB coding gain
(at 10e-15 BER).
SUPER = G.975.1 I.4 complaint EFEC with >8 dB coding gain@
10e-15 BER.
SUPERI7 = G.975.1 I.7 complaint EFEC with >8 dB coding
gain@ 10e-15 BER.

OTU4v with 15% FEC Overhead based OCH-P interfaces

(120.579 Gbps, CLOCKTYPE=OTU4FEC15) support only the
SOFT option which is a proprietary Soft-Decision FEC using
15% overhead that provides 11.1 dB of coding gain at 10e-15
BER.

OTU4v with 21% FEC Overhead based OCH-P interfaces

(127.156 Gbps, CLOCKTYPE=OTU4FEC21) support only the
SOFT21GFEC option which is a proprietary Soft-Decision +
GFEC combination using 21% FEC overhead that provides 10.5
dB of coding gain at 10e-15 BER.

For OSM-4F OCH-OS, only the 25% SDFEC Overhead

(SOFT25EFEC) is applicable. This is for all OSM-4F supported
modulation formats (MODUFMT=100GQPSK, 200G16QAM and
2x150G8QAM).

For OSM-4C OCH-OS, only the 15% SDFEC Overhead (SOFT)

is applicable.

OTUExpTrc One to 28 alphanumeric characters Indicates the expected OTU trace identification.
All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id expected.

OTUTrc One to 28 alphanumeric characters Indicates the sent OTU trace identification.
All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id sent.

Refer to section 2 for the applicable characters.

OTUMonTrc ENABLED-AIS Indicates the monitored OTU trace identification mode.

ENABLED-NOAIS ENABLED-AIS to enable monitoring and insert AIS on the port
DISABLED side (TDTC direction) when there is a OTU Trace mismatch.
ENABLED-NOAIS to enable monitoring but not insert AIS.
DISABLED to disable monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

Page 30-1118 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.71 RTRV-OCH Parameters (Continued)

Parameter Value(s) Definition
ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER SAPI (SAPI mismatch only),
SAPI_OPER DAPI (DAPI mismatch only),
DAPI_OPER SAPI_DAPI (SAPI + DAPI Mismatches),
SAPI_OPER (SAPI + OPER mismatches),
DAPI_OPER (DAPI + OPER mismatches),
SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

ClkType G709 Specifies the rate of the OCH-P (OTU4) on OSM-2C:

OVRCLK_FS OTU4FEC15: 120Gbps (OTU4 based with 15% FEC overhead)
OTU4FEC15 OTU4FEC21: 127Gbps (OTU4 based with 21% FEC overhead)
OTU4FEC21
Specifies the rate of the signal on OSM-2S/OSM-4S.
G709: 10.709 Gbps (ODU2 based)
OVRCLK_FS: 11.096 Gbps (ODU2e based)

NpOwner 3 Specifies which network partition owns this entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-856388] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 82026, default of 12304 (ODU2 based)
1 to 84986, default of 12748 (ODU2e based)
1 to 856388, default of 128459 (ODU4 based)

AttAdjModeIng AUTO Indicates the attenuation adjustment mode at Ingress side of

ress MAN module.
For route side per channel attenuation control of OADMRS/
OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

MAN indicated the facility is on manual adjustment.

AttAdjModeEg AUTO Indicates the attenuation adjustment mode at egress side of

ress MAN module.
For select side per channel attenuation control of OADMRS/
OADMRS9 module.

AUTO indicates the facility is on automatic adjustment.

MAN indicates the facility is on manual adjustment.

76.MTFP50/30, Rev B January 2018 Page 30-1119

22. Retrieve Commands TL1 Command Reference Manual

Table 22.71 RTRV-OCH Parameters (Continued)

Parameter Value(s) Definition
frequency From 191350000 to 196100000 with Indicates the center frequency (MHz) of the OCH-L.
increment 50000
Applicable to all OCH-L entities of mTera UTP NE.

Under specific GRIDMODEs, only corresponding frequency

values are valid on an OCH-L:
If GRIDMODE = FIXED88_7100, default value defined per 88
channel plan related to the ID of the OCH-L.
If GRIDMODE = FIXED44_7100, default value defined per 44
channel plan related to the ID of the OCH-L.
If GRIDMODE = FIXED96_MTERA, default value defined per 96
channel plan related to the ID of the OCH-L.

ModulationFor UNKNOWN Specifies the modulation format of the optical channel on the
mat 10GOOK Och-OS and OCH facilities.
40GQPSK
50GBPSK Och-OS on OSM-4F:
100GQPSK - Supports 100GQPSK, 2X150G8QAM or 200G16QAM
2X150G8QAM - When 100GQPSK is selected, the OCh-OS facility supports a
200G16QAM single OTU4 entity;
- When 2X150G8QAM is selected, two OCh-OS facilities are
required and support a single OTUC3, a single ODUC3 and 3 x
ODU4 entities;
- When 200G16QAM is selected, the OCh-OS facility supports a
single OTUC2, a single ODUC2 and 2 x ODU4 entities

Och-OS on OSM-4C:
- Supports 100GQPSK and is not configurable.

OCH:
Any of the following modulation formats can be provisioned for
alien wavelengths.
UNKNOWN
40GQPSK
10GOOK
2X150G8QAM
200G16QAM
100GQPSK
50GBPSK

TransmitPowe [-2000 to 4500] Unit is in thousandths Specifies the Transmit output power of the Och-OS facility.
r of dBm. Incremental step of 100. Applicable for OSM-4F and OSM-4C only.
Default: For OSM-4F:
- Tx Power range: -2 dBm ... + 4.5 dBm, step 0.1 dBm

For OSM-4C:
- Tx Power range: -2 dBm ... +1 dBm, step 0.1 dBm

Encoding DIFFERENTIAL-CODING Specifies the encoding scheme used for the corresponding
NON-DIFFERENTIAL-CODING modulation format on the Och-OS facility. This is for information
only.
Differential-coding is used when MODUFMT=100GQPSK and
FECTYPE=SOFT.
Non-differential-coding is used when (MODUFMT=100GQPSK
and FECTYPE=SOFT25EFEC) or (MODUFMT=2X150G8QAM/
200G16QAM and FECTYPE=SOFT25EFEC).

Page 30-1120 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.71 RTRV-OCH Parameters (Continued)

Parameter Value(s) Definition
rolloff 0.2 Specifies the roll-off factor of the signal which affects the pulse
0.8 shape.
Only for OCH-OS on OSM-4C and OSM-4F.

in_pwr_correct -999 to 200 (dB/10) Specifies a power correction value for an optical channel.
Applies to the complete optical path and is set at the ingress
point to the APC domain.

oms_pwr_corr -999 to 200 (dB/10) Specifies a power correction value for an optical channel for
ect each preemphasis section.

pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

secondaryStat ACTIVE Indicates the secondary state of the facility.

e/sst ACTTMG - ACTIVE: active
BERT - ACTTMG: active synchronization reference
BERT-PRBS-TX - BERT: FEC BER test
BERT-PRBS-RX - BERT-PRBS-TX: transmit PRBS BER test
BUSY - BERT-PRBS-RX: receive PRBS BER test
DTT - BUSY: busy
FAF - DTT: Diagnostic Trace Transmitted
IDLE - FAF: facility failure
MT - IDLE: idle
NALMQI - MT: maintenance
PMI - NALMQI: Not alarmed qualified inhibit
REO - PMI: performance monitoring inhibited
SGEO - REO: related entity outage
STBY - SGEO: supporting entity outage
STBYTMG - STBY: standby
- STBYTMG: standby synchronization reference

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

The following table shows the wavelength/frequency associated with each channelId included in the AID of OCH,
OCH-L:

76.MTFP50/30, Rev B January 2018 Page 30-1121

22. Retrieve Commands TL1 Command Reference Manual

Table 22.72 44-Channel Plan, Wavelength/ChannelId Association

ChannelId Frequency (THz) Wavelength (nm)

1 191.7 1563.86

2 191.8 1563.05

3 191.9 1562.23

4 192.0 1561.42

5 192.1 1560.61

6 192.2 1559.79

7 192.3 1558.98

8 192.4 1558.17

9 192.5 1557.36

10 192.6 1556.55

11 192.7 1555.75

12 192.8 1554.94

13 192.9 1554.13

14 193.0 1553.33

15 193.1 1552.52

16 193.2 1551.72

17 193.3 1550.92

18 193.4 1550.12

19 193.5 1549.32

20 193.6 1548.51

21 193.7 1547.72

22 193.8 1546.92

23 193.9 1546.12

24 194.0 1545.32

25 194.1 1544.53

26 194.2 1543.73

27 194.3 1542.94

28 194.4 1542.14

29 194.5 1541.35

30 194.6 1540.56

31 194.7 1539.77

Page 30-1122 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.72 44-Channel Plan, Wavelength/ChannelId Association (Continued)

ChannelId Frequency (THz) Wavelength (nm)

32 194.8 1538.98

33 194.9 1538.19

34 195.0 1537.40

35 195.1 1536.61

36 195.2 1535.82

37 195.3 1535.04

38 195.4 1534.25

39 195.5 1533.47

40 195.6 1532.68

41 195.7 1531.90

42 195.8 1531.12

43 195.9 1530.33

44 196.0 1529.55

Table 22.73 88 Channel Plan, Wavelength/ChannelId Association

Channels 1-44 Channels 45-88

Frequency Wavelength Frequency Wavelength

Channel ID (THz) (nm) Channel ID (THz) (nm)
1 191.7 1563.863 45 191.75 1563.455

2 191.8 1563.047 46 191.85 1562.64

3 191.9 1562.233 47 191.95 1561.826

4 192 1561.419 48 192.05 1561.013

5 192.1 1560.606 49 192.15 1560.2

6 192.2 1559.794 50 192.25 1559.389

7 192.3 1558.983 51 192.35 1558.578

8 192.4 1558.173 52 192.45 1557.768

9 192.5 1557.364 53 192.55 1556.959

10 192.6 1556.555 54 192.65 1556.151

11 192.7 1555.747 55 192.75 1555.344

12 192.8 1554.94 56 192.85 1554.537

13 192.9 1554.134 57 192.95 1553.732

14 193 1553.329 58 193.05 1552.927

76.MTFP50/30, Rev B January 2018 Page 30-1123

22. Retrieve Commands TL1 Command Reference Manual

Table 22.73 88 Channel Plan, Wavelength/ChannelId Association (Continued)

Channels 1-44 Channels 45-88

Frequency Wavelength Frequency Wavelength

Channel ID (THz) (nm) Channel ID (THz) (nm)
15 193.1 1552.525 59 193.15 1552.123

16 193.2 1551.721 60 193.25 1551.32

17 193.3 1550.918 61 193.35 1550.517

18 193.4 1550.116 62 193.45 1549.716

19 193.5 1549.315 63 193.55 1548.915

20 193.6 1548.515 64 193.65 1548.115

21 193.7 1547.716 65 193.75 1547.316

22 193.8 1546.917 66 193.85 1546.518

23 193.9 1546.119 67 193.95 1545.721

24 194 1545.322 68 194.05 1544.924

25 194.1 1544.526 69 194.15 1544.128

26 194.2 1543.731 70 194.25 1543.333

27 194.3 1542.936 71 194.35 1542.539

28 194.4 1542.142 72 194.45 1541.746

29 194.5 1541.35 73 194.55 1540.953

30 194.6 1540.558 74 194.65 1540.162

31 194.7 1539.766 75 194.75 1539.371

32 194.8 1538.976 76 194.85 1538.581

33 194.9 1538.186 77 194.95 1537.792

34 195 1537.397 78 195.05 1537.003

35 195.1 1536.609 79 195.15 1536.216

36 195.2 1535.822 80 195.25 1535.429

37 195.3 1535.036 81 195.35 1534.643

38 195.4 1534.25 82 195.45 1533.858

39 195.5 1533.465 83 195.55 1533.073

40 195.6 1532.681 84 195.65 1532.29

41 195.7 1531.898 85 195.75 1531.507

42 195.8 1531.116 86 195.85 1530.725

43 195.9 1530.334 87 195.95 1529.944

44 196 1529.554 88 196.05 1529.163

Page 30-1124 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.74 96 Channel Plan, Wavelength/ChannelId Association

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
90 191.4 1566.314 89 191.35 1566.723

92 191.5 1565.496 91 191.45 1565.905

94 191.6 1564.679 93 191.55 1565.087

1 191.7 1563.863 95 191.65 1564.271

2 191.8 1563.047 45 191.75 1563.455

3 191.9 1562.233 46 191.85 1562.64

4 192 1561.419 47 191.95 1561.826

5 192.1 1560.606 48 192.05 1561.013

6 192.2 1559.794 49 192.15 1560.2

7 192.3 1558.983 50 192.25 1559.389

8 192.4 1558.173 51 192.35 1558.578

9 192.5 1557.364 52 192.45 1557.768

10 192.6 1556.555 53 192.55 1556.959

11 192.7 1555.747 54 192.65 1556.151

12 192.8 1554.94 55 192.75 1555.344

13 192.9 1554.134 56 192.85 1554.537

14 193 1553.329 57 192.95 1553.732

15 193.1 1552.525 58 193.05 1552.927

16 193.2 1551.721 59 193.15 1552.123

17 193.3 1550.918 60 193.25 1551.32

18 193.4 1550.116 61 193.35 1550.517

19 193.5 1549.315 62 193.45 1549.716

20 193.6 1548.515 63 193.55 1548.915

21 193.7 1547.716 64 193.65 1548.115

22 193.8 1546.917 65 193.75 1547.316

23 193.9 1546.119 66 193.85 1546.518

24 194 1545.322 67 193.95 1545.721

25 194.1 1544.526 68 194.05 1544.924

26 194.2 1543.731 69 194.15 1544.128

27 194.3 1542.936 70 194.25 1543.333

28 194.4 1542.142 71 194.35 1542.539

29 194.5 1541.35 72 194.45 1541.746

30 194.6 1540.558 73 194.55 1540.953

76.MTFP50/30, Rev B January 2018 Page 30-1125

22. Retrieve Commands TL1 Command Reference Manual

Table 22.74 96 Channel Plan, Wavelength/ChannelId Association (Continued)

Frequency Wavelength Frequency Wavelength
Channel ID (THz) (nm) Channel ID (THz) (nm)
31 194.7 1539.766 74 194.65 1540.162

32 194.8 1538.976 75 194.75 1539.371

33 194.9 1538.186 76 194.85 1538.581

34 195 1537.397 77 194.95 1537.792

35 195.1 1536.609 78 195.05 1537.003

36 195.2 1535.822 79 195.15 1536.216

37 195.3 1535.036 80 195.25 1535.429

38 195.4 1534.25 81 195.35 1534.643

39 195.5 1533.465 82 195.45 1533.858

40 195.6 1532.681 83 195.55 1533.073

41 195.7 1531.898 84 195.65 1532.29

42 195.8 1531.116 85 195.75 1531.507

43 195.9 1530.334 86 195.85 1530.725

44 196 1529.554 87 195.95 1529.944

96 196.1 1528.773 88 196.05 1529.163

Example
RTRV-OCH:CORIANT1:OCH-L-20-1-1-7:AM0181;

Possible System Response

CORIANT1 02-02-02 03:20:21

M AM0181 COMPLD

"OCH-L-20-1-1-7::CPTYPE=\"OADMRS20 - OPTICAL ADD DROP MULTIPLEXER ROUTE AND SELECT

- 20 PORTS\",MONOTI=DISABLED,
TYPE=UNPROTECTED,ALMPF=99,NPOWNER=3,FREQ=192600000:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OCH
ED-OCH
ENT-OCH

Page 30-1126 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ODUF

Command Changes Since Previous Feature Package

• Added support of ODUF mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-ODUF command instruct the network element (NE) to retrieve the properties of an ODUF entity.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• This command is supported for OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C.

• AID ranging is supported by entering two ODUF AIDs combined with the "&&" operator.
Exmaples:
EntityID-ShelfID-SlotID-PortID&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID-TribID&&EntityID-ShelfID-SlotID-PortID-TribID
EntityID-ShelfID-SlotID-PortID-TribID&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID-TribID&&-PortID

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

Command Format
RTRV-ODUF:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,TRIBSLOT=<tr
ibslot>,OPU=<opu>[,GFPTS=<nmbrOfTS_GFPclient>][,EXPRATE=<ExpClientRate>],OPERRAT
E=<operate_rate>,DEGM=<degrade_interval>,DEGTHR=<degrade_threshold>,DMSOURCE=<DM
_source>,EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOpe
rator>,TXDAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,PT
RX=<ptRx>,PT=<pt>,OPUCONFIG=<opu_config>,SWITCHTYPE=<odu_switchtype>[,NPOWNER=<N
pOwner>]:<pst>[,<sst>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.75 RTRV-ODUF Parameters

Parameter Value(s) Definition
fac_aid ODUF-20-[1-16]-[1-40]-[1-80], ODUF- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-20]-[B,C][1-80]-[1-32], ODU4TribPort][-SupportODU ODUTribPort]-TribID
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-1127

22. Retrieve Commands TL1 Command Reference Manual

Table 22.75 RTRV-ODUF Parameters (Continued)

Parameter Value(s) Definition
cp_type OSM2C - OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
2 (CFP)
OSM2S - OTN SWITCHING MODULE
2 (SFP+)
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OSM4S - OTN SWITCHING MODULE
4 (SFP+)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

pmProfile [0-20] or 99 Indicates the performance monitoring profile for the ODU1
entity.

tribslot [1-80] Specifies a single value, or a group of values, or a range of

values identifying which tributary slots is used within the
supporting ODUk/ODUj to carry the ODUF.

A range of {1 to 8} is used for mapping to an ODU2 with 1.25G

tributary slots. Decide which tributary slots within the ODU2 to
use for a particular ODUF.
A range of {1 to 32} is used for mapping to an ODU3 with 1.25G
tributary slots. Decide which tributary slots within the ODU3 to
use for a particular ODUF.
A range of {1 to 80} is used for mapping to an ODU4. Decide
which 1.25G tributary slots within the ODU4 to use for a
particular ODUF.

Use & for grouping.

Use && for ranging.

opu INTACT Indicates of the OPU associated with specified ODUk is

CLIENT supporting a client interface (CLIENT), is supporting an ODU
NA Multiplexing of lower rate ODUs (MUX), is not terminated
(INTACT), or the OPU role is unknown/not available (NA).

nmbrOfTS_GF [1-80] Specify the ODUflex(GFP) rate by entering the number of

Pclient ODU2.ts when the ODUflex supports a GFP client. The
supported ODUflex(GFP) rate is GFPTS x 1,249,177,230 bit/s.

ExpClientRate A fixed integer value between Specifies the expected signal rate of the constant bit rate
2488022 and 103688578. mapped client within the payload of the ODUflex. This value is
used by the system to determine the ODUflex(CBR) rate. The
number is specified in Kbps.

A fixed integer value between 2488022 and 9952261 when the

ODUF is supported by an OSM-2S.
A fixed integer value between 2488022 to 103688578 when the
ODUF is supported by an OSM-2C.

operate_rate A fixed integer value between The OPERRATE parameter shows the OPUflex nominal bit rate.
1250000 and 10000000 The number is measured in Kbps.

Page 30-1128 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.75 RTRV-ODUF Parameters (Continued)

Parameter Value(s) Definition
degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-850910] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Range is 1-81672 for OSM-2S.

Range is 1-850910 for OSM-2C.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

ptRx [0x00 - 0xFF] Identifies the received Payload Type hexadecimal value.

pt [0x00 - 0xFF] Specifies the transmitted Payload Type hexadecimal value on

supported modules.

76.MTFP50/30, Rev B January 2018 Page 30-1129

22. Retrieve Commands TL1 Command Reference Manual

Table 22.75 RTRV-ODUF Parameters (Continued)

Parameter Value(s) Definition
opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT
MUX - AUTO indicates that the system automatically decides how the
CLIENT OPU operates based on additional related provisioning such as
an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

odu_switchtyp OTN Specifies the ODU ownership.

e PKT - OTN indicates that the ODU is owned by the ODU switching
UNUSED domain.
- PKT indicates that the ODU is owned by the Packet switching
domain.
- UNUSED indicates that the ODU is not used by the ODU or
Packet switching domains and can be claimed by either domain.

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state and primary state qualifier of the
OOS-AU facility.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous and management

sst BUSY Indicates the secondary state of the facility.

IDLE - BUSY: busy
SGEO - IDLE: idle
BERT-PRBS-TX - SGEO: supporting entity outage
BERT-PRBS-RX - BERT-PRBS-TX: Bit error test with PRBS signal in progress in
NULL-TX transmit direction.
- BERT-PRBS-RX: Bit error test with PRBS signal in progress in
receive direction.
- NULL-TX: NULL signal transmission in progress.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

Page 30-1130 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.75 RTRV-ODUF Parameters (Continued)

Parameter Value(s) Definition
TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER mismatches).

Example 1
RTRV-ODUF:CORIANT1:ODUF-20-2-6-3:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21
M AM0209 COMPLD
"ODUF-20-2-6-
3::ALMPF=99,EXPRATE=1000000,OPERRATE=1250000,GFPTS=8,TXDAPI=\"\",TXSAPI=\"\",EXP
SAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPER=\"\",MONTRC=DISABLED,PTRX=AUTO,PMPF=9
9,OPU=INTACT,DEGM=7,DEGTHR=1526,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN
Switching Module 2 (SFP+)\":IS-NR,BUSY";

Example 2
RTRV-ODUF:CORIANT1:ALL:AM0209;

Possible System Response

CORIANT1 09-09-13 03:20:21
M AM0209 COMPLD
"ODUF-20-2-6-
3::ALMPF=99,EXPRATE=1000000,OPERRATE=1250000,GFPTS=8,TXDAPI=\"\",TXSAPI=\"\",EXP
SAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPER=\"\",MONTRC=DISABLED,PTRX=AUTO,PMPF=9
9,OPU=INTACT,DEGM=7,DEGTHR=1526,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN
Switching Module 2 (SFP+)\":IS-NR,BUSY"
"ODUF-20-3-6-
3::ALMPF=99,EXPRATE=1000000,OPERRATE=1250000,GFPTS=8,TXDAPI=\"\",TXSAPI=\"\",EXP
SAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPER=\"\",MONTRC=DISABLED,PTRX=AUTO,PMPF=9
9,OPU=INTACT,DEGM=7,DEGTHR=1526,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN
Switching Module 2 (SFP+)\":IS-NR,BUSY";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODUF
ENT-ODUF
ED-ODUF

76.MTFP50/30, Rev B January 2018 Page 30-1131

22. Retrieve Commands TL1 Command Reference Manual

RTRV-ODU0

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-ODU0 command instruct the network element (NE) to retrieve the properties of an ODU0 entity.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• This command is supported for OSM-1S, OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C.

• AID Ranging is supported by entering two ODU0 AIDs combined with the "&&" operator.
Examples:
EntityID-ShelfID-SlotID-PortID&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID-SupportODU ODUTribPort-TribID&&EntityID-ShelfID-SlotID-PortID-
SupportODU ODUTribPort-TribID
EntityID-ShelfID-SlotID-PortID-SupportODU4 ODU4TribPort-SupportODU ODUTribPort-
TribID&&EntityID-ShelfID-SlotID-PortID-SupportODU4 ODU4TribPort-SupportODU ODUTribPort-
TribID
EntityID-ShelfID-SlotID-PortID-TribID&&EntityID-ShelfID-SlotID-PortID-TribID
EntityID-ShelfID-SlotID-PortID-TribID&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID&&-PortID

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

Command Format
RTRV-ODU0:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,TRIBSLOT=<tr
ibslot>,OPU=<opu>,DEGM=<degrade_interval>,DEGTHR=<degrade_threshold>,DMSOURCE=<D
M_source>,EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOp
erator>,TXDAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,P
TRX=<ptRx>,PT=<pt>,OPUCONFIG=<opu_config>,SWITCHTYPE=<odu_switchtype>[,NPOWNER=<
NpOwner>]:<pst>[,<sst>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1132 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.76 RTRV-ODU0 Parameters

Parameter Value(s) Definition
fac_aid ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]

cp_type OSM1S - OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
1 (SFP)
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OSM4S - OTN SWITCHING MODULE
4 (SFP+)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

pmProfile [0-20] or 99 Indicates the performance monitoring profile for the ODU1
entity.

tribslot [1-8] Specifies the tribslot that is used to carry the ODU0 within its
supporting ODUk/ODUj. Decide which tributary slot within the
ODUk/ODUj to use for a particular ODU0.
Range is [1-2] for mapping an ODU0 into an ODU1.
Range is [1-8] for mapping an ODU0 into an ODU2.
Range is [1-32] for mapping an ODU0 into an ODU3.
Range is [1-80] for mapping an ODU0 into an ODU4.

opu INTACT Indicates of the OPU associated with specified ODUk is

CLIENT supporting a client interface (CLIENT), is supporting an ODU
NA Multiplexing of lower rate ODUs (MUX), is not terminated
(INTACT), or the OPU role is unknown/not available (NA).

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-10168] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1133

22. Retrieve Commands TL1 Command Reference Manual

Table 22.76 RTRV-ODU0 Parameters (Continued)

Parameter Value(s) Definition
txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

ptRx [0x00 - 0xFF] Identifies the received Payload Type hexadecimal value.

pt [0x00 - 0xFF] Specifies the transmitted Payload Type hexadecimal value on

supported modules.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

odu_switchtyp OTN Specifies the ODU ownership.

e PKT - OTN indicates that the ODU is owned by the ODU switching
UNUSED domain.
- PKT indicates that the ODU is owned by the Packet switching
domain.
- UNUSED indicates that the ODU is not used by the ODU or
Packet switching domains and can be claimed by either domain.

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state and primary state qualifier of the
OOS-AU facility.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous and management

Page 30-1134 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.76 RTRV-ODU0 Parameters (Continued)

Parameter Value(s) Definition
sst BUSY Indicates the secondary state of the facility.
IDLE - BUSY: busy
SGEO - IDLE: idle
BERT-PRBS-TX - SGEO: supporting entity outage
BERT-PRBS-RX - BUSY: busy
NULL-TX - IDLE: idle
- SGEO: supporting entity outage
- BERT-PRBS-TX: Bit error test with PRBS signal in progress in
transmit direction.
- BERT-PRBS-RX: Bit error test with PRBS signal in progress in
receive direction.
- NULL-TX: NULL signal transmission in progress.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER
mismatches).

Example 1
RTRV-ODU0:CORIANT1:ODU0-20-2-3-5:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21

M AM0209 COMPLD

"ODU0-20-2-3-
5::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2 (SFP+)\":IS-NR,BUSY"

Example 2
RTRV-ODU0:CORIANT1:ALL:AM0209;

Possible System Response

CORIANT1 09-09-13 03:20:21

M AM0209 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-1135

22. Retrieve Commands TL1 Command Reference Manual

"ODU0-20-1-1-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2
(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU0-20-1-1-
2::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2
(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU0-20-1-2-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2
(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU0-20-1-
20::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOP
ER=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=1
526,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2
(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU0
ENT-ODU0
ED-ODU0

Page 30-1136 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ODU1

Command Changes Since Previous Feature Package

• Added support of ODU1 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-ODU1 command instruct the network element (NE) to retrieve the properties of an ODU1 entity.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The MBR option only applies to an ODU1 which is the supporting entity for multiplexed ODU0
members.

• AID Ranging is supported by entering two ODU1 AIDs combined with the "&&" operator.
Examples:
EntityID-ShelfID-SlotID-PortID&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID-TribID&&EntityID-ShelfID-SlotID-PortID-TribID
EntityID-ShelfID-SlotID-PortID-TribID&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID&&-PortID

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

Command Format
RTRV-ODU1:[tid]:{<fac_aid>|ALL}:ctag:::[MBR=<showDetails>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,TRIBSLOT=<tr
ibslot>,OPU=<opu>,DEGM=<degrade_interval>,DEGTHR=<degrade_threshold>,DMSOURCE=<D
M_source>,EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOp
erator>,TXDAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,P
TRX=<ptRx>,PT=<pt>,OPUCONFIG=<opu_config>[,NPOWNER=<NpOwner>]:<pst>,[<sst>]"<cr>
<lf>;

The following also appears if MBR=YES is specified when the ODU1 supports multiplexed ODU0 members.
^^^"<ODU_aid>::
CPTYPE=<cp_type>,TRIBSLOT=<tribslot>,OPU=<opu>,ALMPF=<almProfile>,PMPF=<pmProfil
e>,DEGM=<degrade_interval>,DEGTHR=<degrade_threshold>,DMSOURCE=<DM_source>,EXPOP
ER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOperator>,TXDAPI=
<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,OPUCONFIG=<opu_c
onfig>[,NPOWNER=<NpOwner>]:<editablePrimaryState>:<pst>,[<sst>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1137

22. Retrieve Commands TL1 Command Reference Manual

Table 22.77 RTRV-ODU1 Parameters

Parameter Value(s) Definition
fac_aid ODU1-20-[1-16]-[1-32], ODU1-20-[1- EntityID-ShelfID-SlotID--{PortID[-SupportingODU4
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]

showDetails YES Specifies whether show details.

NO

cp_type OSM1S - OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
1 (SFP)
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OSM4S - OTN SWITCHING MODULE
4 (SFP+)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

pmProfile [0-20] or 99 Indicates the performance monitoring profile for the ODU1
entity.

tribslot [1-80] Specifies a single value, or a group of values, or a range of

values identifying which tributary slots is used within the
supporting ODUk/ODUj to carry the ODU1.
Example: TRIBSLOT=1
TRIBSLOT is set to a group of two values in the range of 1 to 8
for mapping to an ODU2 with 1.25G Tributary Slots on the OSM-
2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C.
TRIBSLOT is set to a group of two values in the range of 1 to 32
for mapping to an ODU3 with 1.25G Tributary Slots on the OSM-
2C, OSM-4C, OSM-4F, OSM-5C.
TRIBSLOT is set to a group of two values in the range of 1 to 80
for mapping to an ODU4 on the OSM-2C, OSM-4C, OSM-4F,
OSM-5C.
Example: TRIBSLOT=1&5

opu INTACT Indicates of the OPU associated with specified ODUk is

CLIENT supporting a client interface (CLIENT), is supporting an ODU
MUX Multiplexing of lower rate ODUs (MUX), is not terminated
NA (INTACT), or the OPU role is unknown/not available (NA).

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-20421] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

Page 30-1138 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.77 RTRV-ODU1 Parameters (Continued)

Parameter Value(s) Definition
ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

ptRx [0x00 - 0xFF] Identifies the received Payload Type hexadecimal value.

pt [0x00 - 0xFF] Specifies the transmitted Payload Type hexadecimal value on

supported modules.
Note: not support on OTNM's ODU1.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

NpOwner 3 Specifies which network partition owns this entity.

76.MTFP50/30, Rev B January 2018 Page 30-1139

22. Retrieve Commands TL1 Command Reference Manual

Table 22.77 RTRV-ODU1 Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of the
OOS-AU facility.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous and management

sst BUSY Indicates the secondary state of the facility.

IDLE - BUSY: busy
SGEO - IDLE: idle
BERT-PRBS-TX - SGEO: supporting entity outage
BERT-PRBS-RX - BERT-PRBS-TX: Bit error test with PRBS signal in progress in
NULL-TX transmit direction.
- BERT-PRBS-RX: Bit error test with PRBS signal in progress in
receive direction.
- NULL-TX: NULL signal transmission in progress.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI or DAPI Mismatches),
- SAPI_OPER (SAPI or OPER mismatches),
- DAPI_OPER (DAPI or OPER mismatches),
- SAPI_DAPI_OPER (SAPI or DAPI or OPER
mismatches).

Example 1
RTRV-ODU1:CORIANT1:ODU1-20-1-5:AM0209;

Possible System Response

^^^CORIANT1 09-09-09 03:20:21

M AM0209 COMPL

"ODU1-2-1-5:CPTYPE=\"OSM20 - OTN SWITCHING MODULE

20G\",ALMPF=99,PMPF=99,SDTHRESH=DISABLED,RXDAPI=\"NorthEast09\",EXSAPI=\"NorthEa
st09\",EXPOPER=\"Coriant1NorthEast\",EXPDAPI=\"NorthEast09\",EXPSAPI=\"NorthEast
09\",TXOPER=\"Coriant1NorthEast\",TXDAPI=\"NorthEast09\",TXSAPI=\"NorthEast09\",
TIMDEF=SAPI_DAPI_OPER,MONTRC=ENABLED-NOAIS,PT=0x05,PTRX=0x05,TRIBSLOT=NA:IS-
NR,BUSY

Page 30-1140 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Example 2
RTRV-ODU1:CORIANT1:ALL:AM0209;

Possible System Response

CORIANT1 09-09-13 03:20:21

M AM0209 COMPLD

"ODU1-1-1-1-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM20 - OTN SWITCHING MODULE
20G\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU1-1-1-1-
2::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM20 - OTN SWITCHING MODULE
20G\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU1-1-1-2-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM20 - OTN SWITCHING MODULE
20G\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU1-1-1-
5::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM20 - OTN SWITCHING MODULE
20G\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU1-1-1-5-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM20 - OTN SWITCHING MODULE
20G\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU1-1-1-5-
2::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM20 - OTN SWITCHING MODULE
20G\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU1-1-1-
20::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOP
ER=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=1
526,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM20 - OTN SWITCHING MODULE
20G\",DMSOURCE=DISABLED:IS-NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU1
ENT-ODU1
ED-ODU1

76.MTFP50/30, Rev B January 2018 Page 30-1141

22. Retrieve Commands TL1 Command Reference Manual

RTRV-ODU2

Command Changes Since Previous Feature Package

• Added support of ODU2 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-ODU2 command instructs the Network Element (NE) to retrieve the properties of an ODU2.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The MBR option only applies to an ODU2 which is the supporting entity for multiplexed ODU1, ODU0,
or ODUF members.

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

• For OTN CP direct mapped ODU service, the NPOWNER (ownership) propagation is from OCH-P/
OTUk to ODUk. The ownership does not be propagated to ODUk for FGTM-M since those are not direct
mapped ODU.

• AID ranging is supported by entering two ODU2 AIDs combined with the "&&" operator.
Exmaples:
EntityID-ShelfID-SlotID-PortID&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID-Num&&EntityID-ShelfID-SlotID-PortID-Num
EntityID-ShelfID-SlotID-PortID-Num&&EntityID-ShelfID-SlotID-PortID
EntityID-ShelfID-SlotID-PortID&&-PortID

• DEGM and DEGTHR are applicable to mTera.

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

• SDTHRSH, CLOCKTYPE, and OPTRIBSIZE are not applicable to mTera.

Command Format
RTRV-
ODU2:[tid]:{<fac_aid>|ALL}:ctag:::[MBR=<showDetails>][,ALMPF=<almProfile>][:<edi
tablePrimaryState>][,<secondaryState>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,SDTHRESH=<SD
Threshold>,TRIBSLOT=<tribslot>,OPU=<opu>,DEGM=<degrade_interval>,DEGTHR<degrade_
threshold>,DMSOURCE=<DM_source>,EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=
<ExpSAPI>,TXOPER=<txOperator>,TXDAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinit

Page 30-1142 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

ion>,MONTRC=<montrc>,CLOCKTYPE=<ClkType>[,PT=<pt>],PTRX=<ptRx>,OPTRIBSIZE=<opera
tional_tribslot_size>,OPUCONFIG=<opu_config>,SWITCHTYPE=<odu_switchtype>,NPOWNER
=<NpOwner>:<pst>,[<sst>]"<cr><lf>;

The following also appears if MBR=YES is specified when the ODU2 supports multiplexed ODUj members.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,TRIBSLOT=<tr
ibslot>,OPU=<opu>,DEGM=<degrade_interval>,DEGTHR=<degrade_threshold>,DMSOURCE=<D
M_source>,EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOp
erator>,TXDAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,P
TRX=<ptRx>,OPUCONFIG=<opu_config>,SWITCHTYPE=<odu_switchtype>:<pst>,[<sst>]"<cr>
<lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.78 RTRV-ODU2 Parameters

Parameter Value(s) Definition
fac_aid ODU2-20-[1-16]-[1-40], ODU2-20-[1- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]

showDetails YES Specifies whether show details.

NO

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

editablePrimar IS Indicates the primary state of the facility.

yState OOS Possible values:
- IS: In-Service
- OOS: Out-of-Service

cp_type OSM2C - OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
2 (CFP)
OSM2S - OTN SWITCHING MODULE
2 (SFP+)
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OSM4S - OTN SWITCHING MODULE
4 (SFP+)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU2
entity.

76.MTFP50/30, Rev B January 2018 Page 30-1143

22. Retrieve Commands TL1 Command Reference Manual

Table 22.78 RTRV-ODU2 Parameters (Continued)

Parameter Value(s) Definition
tribslot [1-80] or NA Specifies a group of values, or a range of values identifying
which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU2. Decide which tributary slots within the ODUk to
use for a particular ODU2.

Range is [1-32] for mapping an ODU2 into an ODU3.

Range is [1-80] for mapping an ODU2 into an ODU4.

Use & for grouping.

Use && for ranging.

NA = Not Applicable.

opu INTACT Indicates of the OPU associated with specified ODUk is

CLIENT supporting a client interface (CLIENT), is supporting an ODU
MUX Multiplexing of lower rate ODUs (MUX), is not terminated
NA (INTACT), or the OPU role is unknown/not available (NA).

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-82026] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 82026, default of 12304 (ODU2)
1 to 84986, default of 12748 (ODU2e)

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

TxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

TxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

Page 30-1144 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.78 RTRV-ODU2 Parameters (Continued)

Parameter Value(s) Definition
TIMDefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

ClkType G709 Specifies the rate of the ODU2 port side facility.
G.709: ODU2
OVRCLK_FS: ODU2e

pt AUTO Specifies the transmitted Payload Type hexadecimal value on

0x02 supported modules.
0x03 Typical Values:
0x05 - AUTO (implies the pt is set based on the connected facility
0x09 type). If a PT value is not assigned or AUTO is configured to the
0x10 PT value upon mapping to a port, the ODU2 PT value is set to
0x11 the appropriate value by the system. When the ODU2 is
0x80 unmapped from a port, the ODU2 PT value returns to AUTO.
0x81 - 0x09, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x82 TRANSMAP=PREAMBLE payload
0x83 - 0x03, 0x10, 0x11, 0x80 to 0x8F for a TGLAN with
0x84 TRANSMAP=LINE_FS payload
0x85 - 0x05 for a TGLAN with TRANSMAP=FRAME_STD payload
0x86 - 0x03 for an OC192/STM64 with CBRMAP=SYNC payload
0x87 - 0x02 for an OC192/STM64 with CBRMAP=ASYNC payload
0x88
0x89 Note that the Payload Type value cannot be changed from the
0x8A typical value if a TGLAN with TRANSMAP=FRAME_STD or for
0x8B an OC192/STM64 is connected to the ODU2.
0x8C
0x8D
0x8E
0x8F

ptRx [0x00 - 0xFF] Identifies the received Payload Type hexadecimal value.

76.MTFP50/30, Rev B January 2018 Page 30-1145

22. Retrieve Commands TL1 Command Reference Manual

Table 22.78 RTRV-ODU2 Parameters (Continued)

Parameter Value(s) Definition
opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

odu_switchtyp OTN Specifies the ODU ownership.

e PKT - OTN indicates that the ODU is owned by the ODU switching
UNUSED domain.
- PKT indicates that the ODU is owned by the Packet switching
domain.
- UNUSED indicates that the ODU is not used by the ODU or
Packet switching domains and can be claimed by either domain.

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

tribslot_size_fa ENABLED Specifies the automatic fallback mode for the tributary size (PT
llback DISABLED value) for ODU2 on the OSM20.

Page 30-1146 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.78 RTRV-ODU2 Parameters (Continued)

Parameter Value(s) Definition
secondaryStat BUSY Indicates the secondary state of the facility.
e/sst FAF - BUSY: busy
IDLE - FAF: facility failure
MT - IDLE: idle
NALMNR - MT: maintenance
NALMCD - NALMCD: not alarmed count down
PMI - NALMNR: not alarmed not ready
SGEO - PMI: performance monitoring inhibited
- SGEO: supporting entity outage
- BERT-PRBS-TX: Bit error test with PRBS signal in progress in
transmit direction.
- BERT-PRBS-RX: Bit error test with PRBS signal in progress in
receive direction.
- NULL-TX: NULL signal transmission in progress.

Example 1
RTRV-ODU2:CORIANT1:ODU2-20-2-1:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21

M AM0209 COMPLD

"ODU2-20-2-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,SDTHRESH=DISABLED,PTRX=AUTO,PT=AUTO,PMPF=99,DEGM=7,DEGTHR
=12304,TIMDEF=SAPI,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2 (SFP+)\":IS-NR,BUSY"

Example 2
RTRV-ODU2:CORIANT1:ALL:AM0209;

Possible System Response

CORIANT1 09-09-13 03:20:21

M AM0209 COMPLD

"ODU2-20-1-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2
(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU2-20-1-
2::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15
26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2
(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU2-20-1-
5::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=15

76.MTFP50/30, Rev B January 2018 Page 30-1147

22. Retrieve Commands TL1 Command Reference Manual

26,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2

(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"
"ODU2-20-1-
20::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOP
ER=\"\",MONTRC=DISABLED,TRIBSLOT=NA,PTRX=AUTO,PMPF=99,OPU=INTACT,DEGM=7,DEGTHR=1
526,TIMDEF=SAPI,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2
(SFP+)\",DMSOURCE=DISABLED:IS-NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU2
ENT-ODU2
ED-ODU2

Page 30-1148 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ODU2E

Command Changes Since Previous Feature Package

• Added support of ODU2E mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-ODU2E commands instruct the network element (NE) to retrieve the properties of an ODU2E entity.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The command is supported on OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C in mTera
shelf.

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

Command Format
RTRV-ODU2E:[tid]:{<fac_aid>|ALL}:ctag:::[ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,SDTHRESH=<SD
Threshold>,TRIBSLOT=<tribslot>,DEGM=<degrade_interval>,DEGTHR<degrade_threshold>
,DMSOURCE=<DM_source>,EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,
TXOPER=<txOperator>,TXDAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTR
C=<montrc>,PT=<pt>,PTRX=<ptRx>,OPUCONFIG=<opu_config>,OPU=<opu>,NPOWNER=<NpOwner
>:<pst>,[<sst>]"<cr><lf>;
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.
Table 22.79
Table 22.80 RTRV-ODU2E Parameters
Parameter Value(s) Definition
fac_aid ODU2E-20-[1-16]-[1-4], ODU2E-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

76.MTFP50/30, Rev B January 2018 Page 30-1149

22. Retrieve Commands TL1 Command Reference Manual

Table 22.80 RTRV-ODU2E Parameters (Continued)

Parameter Value(s) Definition
editablePrimar IS Indicates the primary state of the facility.
yState OOS Possible values:
- IS: In-Service
- OOS: Out-of-Service

cp_type OSM2C - OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
2 (CFP)
OSM2S - OTN SWITCHING MODULE
2 (SFP+)
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OSM4S - OTN SWITCHING MODULE
4 (SFP+)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU2E
entity.

tribslot [1-80] Specifies a group of values, or a range of values, identifying

which tributary slots is used within the supporting ODUk/ODUj to
carry the ODU2E. Decide which tributary slots within the ODUk
to use for a particular ODU2E.

Range is [1-32] for mapping an ODU2E into an ODU3. Nine

tribslot values must be entered for an ODU2E mapped into an
ODU3.
Range is [1-80] for mapping an ODU2E into an ODU4.
Eight tribslot values must be entered for an ODU2E mapped into
an ODU3.

Use & for grouping.

Use && for ranging.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-84986] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

Page 30-1150 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.80 RTRV-ODU2E Parameters (Continued)

Parameter Value(s) Definition
txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

pt [0x00 - 0xFF] Specifies the transmitted Payload Type hexadecimal value.

ptRx [0x00 - 0xFF] Identifies the received Payload Type hexadecimal value.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

NpOwner 3 Specifies which network partition owns this entity.

showDetails YES Specifies whether show details.

NO

secondaryStat BUSY Indicates the secondary state of the facility.

e/sst FAF - BUSY: busy
IDLE - FAF: facility failure
MT - IDLE: idle
NALMNR - MT: maintenance
NALMCD - NALMCD: not alarmed count down
PMI - NALMNR: not alarmed not ready
SGEO - PMI: performance monitoring inhibited
- SGEO: supporting entity outage

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1151

22. Retrieve Commands TL1 Command Reference Manual

Table 22.80 RTRV-ODU2E Parameters (Continued)

Parameter Value(s) Definition
TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace
SAPI_DAPI identifier mismatch purposes.
SAPI_DAPI_OPER - OPER (Operator Specific mismatch only),
SAPI_OPER - SAPI (SAPI mismatch only),
DAPI_OPER - DAPI (DAPI mismatch only),
- SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER
mismatches),
- DAPI_OPER (DAPI + OPER
mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

opu-odu2e INTACT Indicates of the OPU associated with specified ODUk is

CLIENT supporting a client interface (CLIENT), is supporting an ODU
MUX Multiplexing of lower rate ODUs (MUX), is not terminated
NA (INTACT), or the OPU role is unknown/not available (NA).

Example 1
This following command retrieve the properties of an ODU2E entity on an OSM-2S.

RTRV-ODU2E:CORIANT1:ODU2E-20-2-1:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21

M AM0209 COMPLD

"ODU2E-20-2-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,DMSOURCE=DISABLED,PMPF=99,DEGM=7,DEGTHR=12304,TIMDEF=SAPI
,OPUCONFIG=AUTO,CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2 (SFP+)\":IS-NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU2E
ENT-ODU2E
ED-ODU2E

Page 30-1152 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ODU3

Command Changes Since Previous Feature Package

• Added support of ODU3 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-5C.

Description
The RTRV-ODU3 commands instruct the network element (NE) to retrieve the properties of an ODU3 entity.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

Command Format
RTRV-ODU3:[tid]:{<fac_aid>|ALL}:ctag:::[MBR=<showDetails>][,ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,TRIBSLOT=<tr
ibslot>,DEGM=<degrade_interval>,DEGTHR<degrade_threshold>,DMSOURCE=<DM_source>,E
XPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOperator>,TXD
API=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,PT=<pt>,PTRX
=<ptRx>,OPUCONFIG=<opu_config>,OPU=<opu>,NPOWNER=<NpOwner>:<pst>,[<sst>]"<cr><lf
>;

The following also appears if MBR=YES is specified when the ODU3 supports multiplexed ODUj members.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,TRIBSLOT=<tr
ibslot>,DEGM=<degrade_interval>,DEGTHR=<degrade_threshold>,DMSOURCE=<DM_source>,
EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOperator>,TX
DAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,PT=<pt>,PTR
X=<ptRx>,OPUCONFIG=<opu_config>,OPU=<opu>,NPOWNER=<NpOwner>:<pst>,[<sst>]"<cr><l
f>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.81 RTRV-ODU3 Parameters

Parameter Value(s) Definition
fac_aid ODU3-20-[1-16]-[1-5]-[1-80], ODU3- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]- ODU4TribPort]-TribID
[D][1-3]-[1-80]

76.MTFP50/30, Rev B January 2018 Page 30-1153

22. Retrieve Commands TL1 Command Reference Manual

Table 22.81 RTRV-ODU3 Parameters (Continued)

Parameter Value(s) Definition
showDetails YES Specifies whether show details.
NO

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

editablePrimar IS Indicates the primary state and primary state qualifier of the
yState OOS facility.
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

cp_type OSM2C - OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
2 (CFP)
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU3
entity.

tribslot [1-80] Specifies a group of values, or a range of values, identifying

which tributary slots is used within the supporting ODU4 to carry
the ODU3. Decide which tributary slots within the ODU4 to use
for a particular ODU3.
Use & for grouping.
Use && for ranging.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-329492] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Page 30-1154 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.81 RTRV-ODU3 Parameters (Continued)

Parameter Value(s) Definition
montrc ENABLED-NOAIS Specifies the monitored trace identification mode.
DISABLED - Enter ENABLED-AIS to enable trace monitoring and insert AIS
maintenance signal when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
insert AIS when there is a trace mismatch (signal is passed
through intact).
- Enter DISABLED to disable trace monitoring.

pt [0x00 - 0xFF] Specifies the transmitted Payload Type hexadecimal value on

supported modules.

ptRx [0x00 - 0xFF] Identifies the received Payload Type hexadecimal value.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

opu INTACT Indicates of the OPU associated with specified ODUk is

CLIENT supporting a client interface (CLIENT), is supporting an ODU
MUX Multiplexing of lower rate ODUs (MUX), is not terminated
NA (INTACT), or the OPU role is unknown/not available (NA).

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

76.MTFP50/30, Rev B January 2018 Page 30-1155

22. Retrieve Commands TL1 Command Reference Manual

Table 22.81 RTRV-ODU3 Parameters (Continued)

Parameter Value(s) Definition
secondaryStat BUSY Indicates the secondary state of the facility.
e/sst FAF - BUSY: busy
IDLE - IDLE: idle
MT - SGEO: supporting entity outage
NALMNR
NALMCD
PMI
SGEO

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

Example
This following command retrieve the properties of an ODU3 entity on an OSM-2C.

RTRV-ODU3:CORIANT1:ODU3-20-2-1-1:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21

M AM0209 COMPLD

"ODU3-20-2-1-
1::ALMPF=99,TXDAPI=\"\",TXSAPI=\"\",EXPSAPI=\"\",EXPDAPI=\"\",TXOPER=\"\",EXPOPE
R=\"\",MONTRC=DISABLED,DMSOURCE=DISABLED,PMPF=99,DEGM=7,DEGTHR=49424,TIMDEF=SAPI
,OPUCONFIG=AUTO,CPTYPE=\"OSM2C - OTN SWITCHING MODULE 2 (CFP)\",PT=21,PTRX=21:IS-
NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-ODU3
ENT-ODU3
ED-ODU3

Page 30-1156 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-ODU4

Command Changes Since Previous Feature Package

• Updated for OSM-2C.

• Added support of ODU4 mux into the ODUC3 on OSM-4F.

• Added support for OSM-5C.

Description
The RTRV-ODU4 command instructs the Network Element (NE) to retrieve the properties of an ODU4.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• This command is supported for OSM-2C, OSM-4C, OSM-4F, OSM-5C.

• AID ranging is supported by entering two ODU4 AIDs combined with the "&&" operator.
Exmaples:
EntityID-ShelfID-SlotID-PortID&&EntityID-ShelfID-SlotID-PortID

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

• The ODU4TribPort field in the AID is only applicable for ODU4 within an ODUC2 or ODUC3 on OSM-4F.

Command Format
RTRV-
ODU4::{<fac_aid>|ALL}:ctag:::[MBR=<showDetails>][,ALMPF=<almProfile>][:<editable
PrimaryState>][,<secondaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>,PMPF=<pmProfile>,DEGM=<degrad
e_interval>,DEGTHR=<degrade_threshold>,DMSOURCE=<DM_source>,EXPOPER=<ExpOperator
>,EXPDAPI=<ExpDAPI>,EXPSAPI=<ExpSAPI>,TXOPER=<txOperator>,TXDAPI=<TxDAPI>,TXSAPI
=<TxSAPI>,TIMDEF=<TIMDefinition>,MONTRC=<montrc>,PT=<pt>,PTRX=<ptRx>,OPUCONFIG=<
opu_config>,OPU=<opu>,SWITCHTYPE=<odu_switchtype>,NPOWNER=<NpOwner>:<pst>,[<sst>
]"<cr><lf>;

The following also appears if MBR=YES is specified when the ODU4 supports multiplexed ODUj members.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,TRIBSLOT=<tribslot>,ALMPF=<almProfile>,PMPF=<pmP
rofile>,TRIBSLOT=<tribslot>,OPU=<opu>,DEGM=<degrade_interval>,DEGTHR<degrade_thr
eshold>,DMSOURCE=<DM_source>,EXPOPER=<ExpOperator>,EXPDAPI=<ExpDAPI>,EXPSAPI=<Ex
pSAPI>,TXOPER=<txOperator>,TXDAPI=<TxDAPI>,TXSAPI=<TxSAPI>,TIMDEF=<TIMDefinition
>,MONTRC=<montrc>,CLOCKTYPE=<ClkType>[,PT=<pt>],PTRX=<ptRx>,OPUCONFIG=<opu_confi
g>,SWITCHTYPE=<odu_switchtype>,NPOWNER=<NpOwner>,PKTMAP=<pktmap>:<pst>,[<sst>]"<
cr><lf>;

76.MTFP50/30, Rev B January 2018 Page 30-1157

22. Retrieve Commands TL1 Command Reference Manual

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.82 RTRV-ODU4 Parameters

Parameter Value(s) Definition
fac_aid ODU4-20-[1-16]-[1-5], ODU4-20-[1- EntityID-ShelfID-SlotID-PortID[-ODU4TribPort]
16]-[1-2]-[1-3]

showDetails YES Specifies whether show details.

NO

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

editablePrimar IS Indicates the primary state and primary state qualifier of the
yState OOS facility.
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

cp_type OSM2C-OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
2 (CFP)
OSM4F-OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C-OTN SWITCHING MODULE
4 (CFP2)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

pmProfile [0-20] or 99 Specifies the performance monitoring profile for the ODU4
entity.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-856388] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

DM_source ENABLED Specifies whether or not the entity is acting as the Source of the
DISABLED Delay Measurement function for performance monitoring.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Page 30-1158 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.82 RTRV-ODU4 Parameters (Continued)

Parameter Value(s) Definition
montrc ENABLED-NOAIS Specifies the monitored trace identification mode.
DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

pt [0x00 - 0xFF] Specifies the transmitted Payload Type hexadecimal value on

supported modules.

- 0x07 when HGE maps into ODU4 via GMP

- 0x05 when HGE maps into ODU4 via GFP-F

Note: NA on HGTM's ODU4.

ptRx [0x00 - 0xFF] Identifies the received Payload Type hexadecimal value.

opu_config AUTO Pre-provisions the OPU configuration for the specified ODU.
INTACT - AUTO indicates that the system automatically decides how the
MUX OPU operates based on additional related provisioning such as
CLIENT an ODU cross-connection or an ODUj being multiplexed into the
ODU. When no additional related provisioning is present, the
ODU ishave as CTP (connection termination point) that has an
open connection and thus is transmitting an ODU-OCI
maintenance signal.
- INTACT indicates that the ODU operates as if there is an ODU
intact cross-connect provisioned.
- MUX indicates that the ODU operates as a TTP (Trail
Termination Point) supporting the multiplexing of ODUj entities
into the ODU.
- CLIENT indicates tha the ODU operates as a TTP (Trail
Termination Point) supporting the CBR mapping of a client
facility into the ODU.

opu INTACT Indicates of the OPU associated with specified ODUk is

CLIENT supporting a client interface (CLIENT), is supporting an ODU
MUX Multiplexing of lower rate ODUs (MUX), is not terminated
NA (INTACT), or the OPU role is unknown/not available (NA).

odu_switchtyp OTN Specifies the ODU ownership.

e PKT - OTN indicates that the ODU is owned by the ODU switching
UNUSED domain.
- PKT indicates that the ODU is owned by the Packet switching
domain.
- UNUSED indicates that the ODU is not used by the ODU or
Packet switching domains and can be claimed by either domain.

NpOwner 3 Specifies which network partition owns this entity.

msim_config ENABLED Specifies msim alarm reporting or not when msi value received
DISABLED does not follow G.709 definition.

76.MTFP50/30, Rev B January 2018 Page 30-1159

22. Retrieve Commands TL1 Command Reference Manual

Table 22.82 RTRV-ODU4 Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

secondaryStat BUSY Indicates the secondary state of the facility.

e/sst FAF - BUSY: busy
IDLE - FAF: facility failure
MT - IDLE: idle
NALMNR - MT: maintenance
NALMCD - NALMCD: not alarmed count down
PMI - NALMNR: not alarmed not ready
SGEO - PMI: performance monitoring inhibited
BERT-PRBS-TX - SGEO: supporting entity outage
BERT-PRBS-RX - BERT-PRBS-TX: Bit error test with PRBS signal in progress in
NULL-TX transmit direction.
- BERT-PRBS-RX: Bit error test with PRBS signal in progress in
receive direction.
- NULL-TX: NULL signal transmission in progress

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

pktmap GFP Specifies the type of mapping/demapping used for packet traffic
GMP within an ODU owned by the packet subsystem.
- GFP indicates that GFP-F is used to map/demap the packets
into/out of the ODU
- GMP indicates that a constant bit rate mapping using GMP is
used to map/demap the packets into/out of the ODU.

ClkType G709 Specifies the rate of the ODU2 that is mapped to the ODU4:
G.709: ODU2
OVRCLK_FS: ODU2e

Page 30-1160 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Example
RTRV-ODU4:CORIANT1:ODU4-20-15-1:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21

M AM0209 COMPLD

"ODU4-20-15-1::ALMPF=99,CPTYPE=\"OSM2C - OTN SWITCHING MODULE 2 (CFP)\"::IS-

NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU4

76.MTFP50/30, Rev B January 2018 Page 30-1161

22. Retrieve Commands TL1 Command Reference Manual

RTRV-ODUC2

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-ODUC2 command instructs the Network Element (NE) to retrieve the properties of an ODUC2.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• This command is supported for OSM-4F.

• AID ranging is supported by entering two ODUC2 AIDs combined with the "&&" operator.
Exmaples:
EntityID-ShelfID-SlotID-PortID&&EntityID-ShelfID-SlotID-PortID

Command Format
RTRV-ODUC2::{<fac_aid>|ALL}:ctag::::<editablePrimaryState>][,<secondaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>:<pst>,[<sst>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.83 RTRV-ODUC2 Parameters

Parameter Value(s) Definition
fac_aid ODUC2-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID

editablePrimar IS Indicates the primary state and primary state qualifier of the
yState OOS facility.
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

cp_type OSM4F-OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
4(FLEXRATE)

Page 30-1162 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.83 RTRV-ODUC2 Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

secondaryStat SEGO Indicates the secondary state of the facility.

e/sst - - SGEO: supporting entity outage

Example
RTRV-ODUC2:CORIANT1:ODUC2-20-15-1:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21

M AM0209 COMPLD

"ODUC2-20-15-1::CPTYPE=\"OSM4F - OTN SWITCHING MODULE 4 (FLEXRATE)\"::IS-NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODUC2

76.MTFP50/30, Rev B January 2018 Page 30-1163

22. Retrieve Commands TL1 Command Reference Manual

RTRV-ODUC3

Command Changes Since Previous Feature Package

• New command for OSM-4F 300G support.

Description
The RTRV-ODUC3 command instructs the Network Element (NE) to retrieve the properties of an ODUC3.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• This command is supported for OSM-4F.

• AID ranging is supported by entering two ODUC3 AIDs combined with the "&&" operator.
Exmaples:
EntityID-ShelfID-SlotID-PortID&&EntityID-ShelfID-SlotID-PortID

Command Format
RTRV-ODUC3::{<fac_aid>|ALL}:ctag::::<editablePrimaryState>][,<secondaryState>];

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>:<pst>,[<sst>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.84 RTRV-ODUC3 Parameters

Parameter Value(s) Definition
fac_aid ODUC3-20-[1-16]-1 EntityID-ShelfID-SlotID-PortID

editablePrimar IS Indicates the primary state and primary state qualifier of the
yState OOS facility.
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

cp_type OSM4F-OTN SWITCHING MODULE Indicates the type of module that this facility is supported on.
4(FLEXRATE)

Page 30-1164 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.84 RTRV-ODUC3 Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

secondaryStat SEGO Indicates the secondary state of the facility.

e/sst - - SGEO: supporting entity outage

Example
RTRV-ODUC3:CORIANT1:ODUC3-20-15-1:AM0209;

Possible System Response

CORIANT1 09-09-09 03:20:21

M AM0209 COMPLD

"ODUC3-20-15-1::CPTYPE=\"OSM4F - OTN SWITCHING MODULE 4 (FLEXRATE)\"::IS-NR,BUSY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODUC3

76.MTFP50/30, Rev B January 2018 Page 30-1165

22. Retrieve Commands TL1 Command Reference Manual

RTRV-OMS

Command Changes Since Previous Feature Package

• None

Description
The RTRV-OMS command instructs the network element (NE) to retrieve the attributes of the specified optical
multiplex section (OMS) facility entity.

Restrictions and Exceptions

• When ALL is used as an AID, information for all OMS entities that matches the specified filtering
parameter(s) is retrieved.

• CHANTYPES, CHANALLOW and GRIDMODE are only applicable to OMS entity on DWDM Line port
of OADMRS/OADMRS9.

• When GRIDMODE=FIXED96_NOCHANPLAN, CHANALLOW does not be displayed.

• OCHAAMINGR and OCHAAMEGR does not be returned for an OMS associated with an OTS with
OTSMODE=7100.

Command Format
RTRV-OMS:[tid]:{<oms_aid>|ALL}:ctag:::[,ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<oms_aid>::CPTYPE=<cp_type>,ALMPF=<almProfile>[,CHANALLOW=<channels_allowed>
][,CHANTYPES=<channelTypes>][,GRIDMODE=<gridmode>][,TXLINKSTATUS=<txLinkStatus>]
[,RXLINKSTATUS=<rxLinkStatus>][,TXLINKSTATUSRMT=<txLinkStatusRemote>][,RXLINKSTA
TUSRMT=<rxLinkStatusRemote>][,COEFFK=<coefficient_k>][,OSNRPC100G=<osnr_pwr_corr
ect_100g>][,OSNRPC40G=<osnr_pwr_correct_40g>][,OSNRPC10G=<osnr_pwr_correct_10g>]
[,EOLCHNLCNT=<eol_channel_count>][,OCHAAMINGR=<ochAttAdjModeIngress>][,OCHAAMEGR
=<ochAttAdjModeEgress>]:<pst>,[<sst>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.85 RTRV-OMS Parameters

Parameter Value(s) Definition
oms_aid OMS-20-[10-16,1-7]-[1-21],OMS-20- EntityID-ShelfID-SlotID[-SubslotID]-PortID
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

Page 30-1166 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.85 RTRV-OMS Parameters (Continued)

Parameter Value(s) Definition
editablePrimar IS Indicates the primary state of the facility.
yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

cp_type OADMRS20 - OPTICAL ADD DROP Indicates the type of module that this facility is supported on:
MULTIPLEXER ROUTE AND OADMRS/OADMRS9, CDCP.
SELECT - 20 PORTS
OADMRS9 - OPTICAL ADD DROP
MULTIPLEXER ROUTE AND
SELECT - 9 PORTS
CDC8D6 - 8D PLUGGABLE CDC
MODULE - 6 ADD/DROP PORTS

channels_allo [1-96] Indicates the set of channels that are allowed to use.
wed The parameter is only supported when GRIDMODE of the
OADMRS/OADMRS9 is = FIXED96_mTera, or FIXED44_7100,
or FIXED88_7100.

On OADMRS/OADMRS9, the set of channels allowed is limited

by the GRIDMODE.
On OADMRS/OADMRS9, if its GRIDMODE is FIXED96_mTera,
then the max channel number is 96.
On OADMRS/OADMRS9, if its GRIDMODE is FIXED44_7100,
then the max channel number is 44.
On OADMRS/OADMRS9, if its GRIDMODE is FIXED88_7100,
then the max channel number is 88.
If the GRIDMODE value or CHANTYPES value changes, then
the default value for CHANALLOW also implicitly change to
match the channel range.

Note: This parameter allows use of the grouping operator "&" or

the ranging operator "&&" (eg. CHANALLOW=1&3&5&7&9 or
CHANALLOW=1&&9).

channelTypes MIXED Indicates the channel type that the specified OMS carries
COHERENTONLY wavelengths.
COHERENTONLYHIPWR
COHERENTONLYHIPWR are only applicable when
GRIDMODE = FIXED44_7100.

MIXED = Any mixture of 2.5G, 10G, 40G, 100G coherent or

non-coherent wavelengths on the OMS.

COHERENTONLYHIPWR = The OMS can contain only

coherent wavelength up to the number allowed by GRIDMODE.
The target ouput power per channel is increased to 3 dB more
than the normal target per channel in order to gain improved
optical performance, for example, when 44 channels or less are
required for the module capable to support more than 88
channels. This OMS is not intended to be used to carry any
direct detect 2.5G, 10G, or 40G wavelengths.

COHERENTONLY = The OMS can contain wavelengths up to

the maximum allowed on the interface of only coherent
wavelengths. This OMS is not intended to be used to carry any
direct detect 2.5G, 10G, or 40G wavelengths.

76.MTFP50/30, Rev B January 2018 Page 30-1167

22. Retrieve Commands TL1 Command Reference Manual

Table 22.85 RTRV-OMS Parameters (Continued)

Parameter Value(s) Definition
gridmode FIXED96_NOCHANPLAN Indicates the grid mode that the specified OMS. Grid mode
FIXED44_7100 includes the grid type and channel plan information. 'FIXED'
FIXED88_7100 indicates the grid is fixed frequency grid.
FIXED96_MTERA
FIXED96_NOCHANPLAN: 96 channels of fixed frequency grid.
Channel Center Frequency (FREQ) is configurable but not
decided per OCH-L ID - No channel plan. Channel Number is
limited to 96.

FIXED44_7100: 44 channels of fixed frequency grid. Channel

Center Frequency (FREQ) is implicitly decided per OCH-L ID
according to channel plan of 7100 OTS/Nano 44 channel plan.
Channel Number is limited to 44.

FIXED88_7100: 88 channels of fixed frequency grid. Channel

Center Frequency (FREQ) is implicitly decided per OCH-L ID
according to channel plan of 7100 OTS/Nano 88 channel plan.
Channel Number is limited to 88.

FIXED96_MTERA: 96 channels of fixed frequency grid. Channel

Center Frequency (FREQ) is implicitly decided per OCH-L ID
according to channel plan of 96 channel plan of mTera UTP
system. Channel Number is limited to 96.

txLinkStatus PRESTART Indicates the status of the link control in the Transmit direction.
STARTUP PRESTART: Amplifiers are shutdown, link control is not
RUNNING operating (for example, module is OOS)
FROZEN STARTUP: Transient state during link startup until all amplifiers
NA in the link are turned on
RUNNING: Normal state for link operation, all control algorithms
running
FROZEN: Due to some abnormal situation (for example, OSC
communication interrupted) control algorithms and
corresponding hardware settings (for example, attenuations) are
frozen.
NA: Not Available

rxLinkStatus PRESTART Indicates the status of the link control in the Receive direction.
STARTUP PRESTART: Amplifiers are shutdown, link control is not
RUNNING operating (for example, module is OOS)
FROZEN STARTUP: Transient state during link startup until all amplifiers
NA in the link are turned on
RUNNING: Normal state for link operation, all control algorithms
running
FROZEN: Due to some abnormal situation (for example, OSC
communication interrupted) control algorithms and
corresponding hardware settings (for example, attenuations) are
frozen.
NA: Not Available

Page 30-1168 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.85 RTRV-OMS Parameters (Continued)

Parameter Value(s) Definition
txLinkStatusR PRESTART Indicates the status of the link control in the Transmit direction at
emote STARTUP the remote end of the link.
RUNNING PRESTART: Amplifiers are shutdown, link control is not
FROZEN operating (for example, module is OOS)
NA STARTUP: Transient state during link startup until all amplifiers
in the link are turned on
RUNNING: Normal state for link operation, all control algorithms
running
FROZEN: Due to some abnormal situation (for example, OSC
communication interrupted) control algorithms and
corresponding hardware settings (for example, attenuations) are
frozen.
NA: Not Available

rxLinkStatusR PRESTART Indicates the status of the link control in the Receive direction at
emote STARTUP the remote end of the link.
RUNNING PRESTART: Amplifiers are shutdown, link control is not
FROZEN operating (for example, module is OOS)
NA STARTUP: Transient state during link startup until all amplifiers
in the link are turned on
RUNNING: Normal state for link operation, all control algorithms
running
FROZEN: Due to some abnormal situation (for example, OSC
communication interrupted) control algorithms and
corresponding hardware settings (for example, attenuations) are
frozen.
NA: Not Available

coefficient_k [0-100] Specifies the K Coefficient which is the correction factor for
power preemphasis calculation.

osnr_pwr_corr -50 to 50 (dB/10) Specifies the power correction factor to consider for 100G
ect_100g wavelengths within the OMS.

osnr_pwr_corr -50 to 50 (dB/10) Specifies the power correction factor to consider for 40G
ect_40g wavelengths within the OMS.

osnr_pwr_corr -50 to 50 (dB/10) Specifies the power correction factor to consider for 10G
ect_10g wavelengths within the OMS.

eol_channel_c [1-96] Specifies the planned end-of-life channel count for the link.
ount

ochAttAdjMod AUTO Specifies is all OCH-L within an OMS are in Automatic or

eIngress MAN Manual attenuation adjustment mode within the Ingress WSS
when OTSMODE=MTERA or HIT7300.
AUTO = Automatic Attenuation Adjustment for OCH-Ls within
OMS
MAN = Manual Attenuation Adjustment for OCH-Ls within OMS.

ochAttAdjMod AUTO Specifies is all OCH-L within an OMS are in Automatic or

eEgress MAN Manual attenuation adjustment mode within the Egress WSS
when OTSMODE=MTERA or HIT7300.
AUTO = Automatic Attenuation Adjustment for OCH-Ls within
OMS
MAN = Manual Attenuation Adjustment for OCH-Ls within OMS.

76.MTFP50/30, Rev B January 2018 Page 30-1169

22. Retrieve Commands TL1 Command Reference Manual

Table 22.85 RTRV-OMS Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

SecondaryStat BUSY Indicates the secondary state of the facility.

e/sst FAF - BUSY: busy
IDLE - FAF: facility failure
MT - IDLE: idle
PMI - MT: maintenance
SGEO - PMI: performance monitoring inhibited
- SGEO: supporting entity outage

Example
RTRV-OMS:CORIANT1:OMS-20-1-1-1:AM0209;

Possible System Response

CORIANT1 14-12-02 03:20:21

M AM0209 COMPLD

"OMS-20-1-1-1::CPTYPE=\""OMS1-1-1::CPTYPE=\"ENHANCED LINE INPUT AMPLIFIER

MODULE\",ALMPF=99:IS-NR,IDLE"\",ALMPF=99:IS-NR,IDLE"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OMS

Page 30-1170 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OPEDATA

Command Changes Since Previous Feature Package

• New Command

Description
The RTRV-OPEDATA command instructs the network element (NE) to retrieve the information for the OPE
(OPEPROJ and OPENE) data files that are currently installed.

Restrictions and Exceptions

• None.

Command Format
RTRV-OPEDATA:[tid]::ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::DATASET=\"<opeDataset>\",NAME=\"<opeName>\",SERIAL=\"<opeSerial>\",VERSION
=\"<opeTnVersion>\""<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.86 RTRV-OPEDATA Parameters

Parameter Value(s) Definition
opeDataset OPENE Indicates the type of OPE data file.
OPEPROJ

opeName A string of 1 to 256 characters. Indicates the project or NE name from the OPE data file.

opeSerial A 32-bit integer in the form of a string. Indicates the serial number from the OPE data file.

opeTnVersion A string consisting of 1 to 18 Indicates the Transnet version of the OPE data file.
characters.

Example
RTRV-OPEDATA:::CTG1;

Possible System Response

MTERA 14-09-09 03:20:21
M^^ CTG1 ^COMPLD
^^^"::DATASET=OPEPROJ,NAME="Example Project 1",SERIAL="123456",VERSION="TN 8.50
30 b123"
^^^"::DATASET=OPENE,NAME="Example NE 1",SERIAL="98765",VERSION="TN 8.50 30 b255"
;

76.MTFP50/30, Rev B January 2018 Page 30-1171

22. Retrieve Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE

Page 30-1172 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OPTPWR-OTS

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OPTPWR-OTS command instructs the network element (NE) to retrieve the average value of the optical
power level of the individual channels (OCH-L) at the output of the OADMRS/OADMRS9 module and at the input of
the OADMRS/OADMRS9 module after input amplification.
In the response it is possible to visualize if the Automatic Power Adjustment feature is on a manual mode or on
automatic mode.

If the APA is on the automatic mode, the power level displayed is the one that has been previously set with the SET-
OPTPWR-OTS command (OPLADJ=ENABLED), or the implicitly decided power level per measured span loss
(OPLADJ=DISABLED).

If the APA is on the manual mode, the power level displayed is the one that has been calculated by the system based
on the gain set previously with the SET-GAIN-OTS command, or the default value if these were never modified.

Restrictions and Exceptions

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-OPTPWR-OTS:[tid]:{<ots_aid>|ALL}:ctag:::[<APAOutMode>][,<APAInMode>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<ots_aid>::APAO=<APAOutMode>,OPL=<opl>,APAI=<APAInMode>,
IPL=<ipl>,OPLADJ=<oplAdj>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.87 RTRV-OPTPWR-OTS Parameters

Parameter Value(s) Definition
ots_aid OTS-20-[10-16,1-7]-21,OTS-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

APAOutMode AUTO Indicates the current output power adjustment mode that is
MAN configured for the selected OCH or OTS facility.
- AUTO indicates the facility is on automatic power adjustment.
- MAN indicates the facility is on manual power adjustment.

76.MTFP50/30, Rev B January 2018 Page 30-1173

22. Retrieve Commands TL1 Command Reference Manual

Table 22.87 RTRV-OPTPWR-OTS Parameters (Continued)

Parameter Value(s) Definition
APAInMode AUTO Indicates the current input power adjustment mode that is
MAN configured for the selected OTS facility.
- AUTO indicates the facility is on automatic power adjustment.
- MAN indicates the facility is on manual power adjustment.

opl Possible values: (1) Number ranging Indicates the output power level on the OTS facility, in dBm/ch.
from -12.0 to +2.0 with 0.1 increments (with increments of 0.1).
(2) Number ranging from -18.0 to
+13.7 with 0.1 increments (3) +3.0 For OADMRS in AUTO APAOutMode, 0.0 dBm/channel if
OTSMODE=7100, -12.0 to +2.0 dBm/channel if
OTSMODE=MTERA or HIT7300.

For OADMRS9 in AUTO APAOutMode, 0.0 dBm/channel if

OTSMODE=7100, -18.0 to +13.7 dBm/channel if
OTSMODE=MTERA or HIT7300.

For OADMRS/OADMRS9 with OTSMODE=7100 and

CHANTYPES=COHERENTONLYHIPWR, +3.0 dBm.

ipl Possible values: Number ranging from Indicates the target input power level on the OTS facility after
-1.0 to +4.5 with 0.1 increments. input amplification, in dBm/ch. (with increments of 0.1).

For OADMRS/OADMRS9 in AUTO APAInMode, +4.5 dBm/

channel.

oplAdj ENABLED Indicates the support of manual provisioning the output power
DISABLED level (opl) on the OTS facility.

When OPLADJ = ENABLED, the opl does not be decided per

measured span loss but the manually input opl value. The
retrieved opl value is the manually input opl value.

When OPLADJ = DISABLED, the opl is decided per measured

span loss. The retrieved opl value is the automatically calculated
target opl value.

Example
RTRV-OPTPWR-OTS:CORIANT1:OTS-20-1-21:AM0102;

Possible System Response

CORIANT1 14-12-02 00:50:03
M AM0102 COMPLD
"OTS-20-1-21::APAO=AUTO,OPL=(+0.0),APAI=AUTO,IPL=(+4.5),OPLADJ=DISABLED"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTS
SET-OPTPWR-OTS

Page 30-1174 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OSC

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OSC command instructs the network element (NE) to retrieve the attributes of the specified optical
supervisory channel (OSC) facility entity.

Restrictions and Exceptions

• When ALL is used as an AID, information for all OSC entities that matches the specified filtering
parameter(s) is retrieved.

Command Format
RTRV-OSC:[tid]:{<osc_aid>|ALL}:ctag:::[,ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<osc_aid>::CPTYPE=<cp_type>,EONMSG=<eon_msg>,OSCMODE=<OSC_mode>,ALMPF=<almPr
ofile>:<pst>,[<sst>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.88 RTRV-OSC Parameters

Parameter Value(s) Definition
osc_aid OSC-20-[10-16,1-7]-21,OSC-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

editablePrimar IS Indicates the primary state of a entity.

yState OOS Possible values for PST:
IS: In-Service
OOS: Out-of-Service

cp_type OADMRS20 - OPTICAL ADD DROP Indicates the type of module that this facility is supported on.
MULTIPLEXER ROUTE AND
SELECT - 20 PORTS
OADMRS9 - OPTICAL ADD DROP
MULTIPLEXER ROUTE AND
SELECT - 9 PORTS

eon_msg ENABLED Specifies if EON traffic is going through the OSC facility
DISABLED (ENABLED) or is blocked (DISABLED).

76.MTFP50/30, Rev B January 2018 Page 30-1175

22. Retrieve Commands TL1 Command Reference Manual

Table 22.88 RTRV-OSC Parameters (Continued)

Parameter Value(s) Definition
OSC_mode 155M52 Indicates the OSC format used for the OSC signal.
150M Applicable to OADMRS/OADMRS9 module.

155M52: OSC format of OC-3 which is compatible with 7100

OTS/Nano system.
150M: OSC format of 150Mbps which is compatible with hiT
7300 system.

pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous.
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

secondaryStat FAF Indicates the secondary state of the facility.

e/sst MT - FAF: facility failure
PMI - MT: maintenance
SGEO - PMI: performance monitoring inhibited
- SGEO: supporting entity outage

Example
RTRV-OSC:CORIANT1:OSC-20-1-21:AM0209;

Possible System Response

CORIANT1 14-12-02 03:20:21

M AM0209 COMPLD

"OSC-20-1-21::CPTYPE=\"OADMRS20 - OPTICAL ADD DROP MULTIPLEXER ROUTE AND SELECT -

20 PORTS\",EONMSG=ENABLED, OSCMODE=150M,ALMPF=99:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OSC

Page 30-1176 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OSCX

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OSCX command instructs the network element (NE) to retrieve a OSCX entity.

Restrictions and Exceptions

• When ALL is used as an AID, information for all OSCX entities that matches the specified filtering
parameter(s) is retrieved.

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

Command Format
RTRV-
OSCX:[tid]:{<oscx_aid>|ALL}:ctag:::[:<editablePrimaryState>][,<secondaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<oscx_aid>::CPTYPE=<cp_type>,TRAFFIC=<Traffic>,EONMSG=<eon_msg>,NPOWNER=<NpO
wner>:<pst>[,<sst>]"<CR><LF>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.89 RTRV-OSCX Parameters

Parameter Value(s) Definition
oscx_aid OSCX-20-[10-16,1-7]-21-[2,1],OSCX- EntityID-ShelfID-SlotID-PortID-N
20-[1-16]-1-[2,1]

editablePrimar IS Indicates the primary state of a entity.

yState OOS Possible values for PST:
IS: In-Service
OOS: Out-of-Service

cp_type OADMRS20 - OPTICAL ADD DROP Indicates the type of module that this facility is supported on.
MULTIPLEXER ROUTE AND
SELECT - 20 PORTS
OADMRS9 - OPTICAL ADD DROP
MULTIPLEXER ROUTE AND
SELECT - 9 PORTS

Traffic ENABLED Controlls traffic flow on OSCX entity.

DISABLED

eon_msg ENABLED Provides the value of the eon_msg parameter. This parameter
DISABLED reflects the value of the eon_msg parameter in the parent OSC.

76.MTFP50/30, Rev B January 2018 Page 30-1177

22. Retrieve Commands TL1 Command Reference Manual

Table 22.89 RTRV-OSCX Parameters (Continued)

Parameter Value(s) Definition
NpOwner 1 Specifies which network partition ownes this entity.
2

pst IS-NR Indicates the primary state and primary state qualifier of a entity.
OOS-AU Possible values for PST:
IS: In-Service
OOS: Out-of-Service
Possible values for PSTQ:
NR: normal
AU: autonomous

secondaryStat SGEO Indicates the secondary state:

e/sst SGEO: Supporting Entity Outage

Example
RTRV-OSCX::OSCX-1-1-21-2:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^\"OSCX-A-2::CPTYPE=\"ENHANCED LINE INPUT AMPLIFIER
MODULE\",TRAFFIC=ENABLED,EONMSG=ENABLED,NPOWNER=1:IS-NR\"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSCX
ED-OSCX
ENT-OSCX

Page 30-1178 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OSPF

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OSPF command enables to view the current configuration of the an OSPF routing instance.

Restrictions
• When ALL is used as an AID, information for all OSPF entities that matches the specified filtering
parameter(s) is retrieved.

Command Format
RTRV-OSPF:[tid]:{<ospf_aid>|ALL}:ctag:::[:<editablePrimaryState>];

Proper System Response

The completed response indicates that an ospf routing instance has been establish for the network partition.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<ospf_aid>::RTRID=<router_id>,ASBR=<autonomous_system_border_router>:<pst>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.90 RTRV-OSPF Parameters

Parameter Value(s) Definition
ospf_aid OSPF-[1,3]-1 EntityID-NPID-OSPFID

editablePrimar IS Indicates the primary state of the OSI router

yState OOS Possible values for PST:
IS: In-Service
OOS: Out-of-Service

router_id [0-255].[0-255].[0-255].[0-255] The router ID attribute of the OSPF routing controller forms its
identity in the context of its network. Though formatted to look
like an IP address, this value doesn't need to be an actual IP
address.
The router ID needs to be unique within a network. Each
network partition represents a network. A network spans
multiple NEs.

autonomous_s ENABLED Specifies if the OSPF instance is being configured as a border

ystem_border_ DISABLED router.
router

76.MTFP50/30, Rev B January 2018 Page 30-1179

22. Retrieve Commands TL1 Command Reference Manual

Table 22.90 RTRV-OSPF Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of the OSI
OOS-AU router
OOS-MA Possible values for PST:
OOS-AUMA IS: In-Service
OOS: Out-of-Service
Possible values for PSTQ:
NR: normal
MA: management

Example
The following example changes the router_id of an ospf routing controller to 192.168.2.1.
RTRV-OSPF:NE01:OSPF-1-1:AM0011;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD

^^^"OSPF-1-1::RTRID=192.168.2.1,ASBR=DISABLED:IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSPF
ED-OSPF
ENT-OSPF

Page 30-1180 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OSPFADJ

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OSPFADJ command enables to view the current configuration of the manual or automatic adjacencies
of TLs.

Restrictions
• When ALL is used as an AID, information for all OSPF adjacent entities that matches the specified
filtering parameter(s) is retrieved.

• The command is denied if a TSL interface is specified to INTRFC.

Command Format
RTRV-OSPFADJ:[tid]:{<ospfadj_aid>|ALL}:ctag:::[INTRFC=<interface_aid>]
[,OSPFAREA=<ospfarea_aid>][,ADJST=<adjacency_status>][:<editablePrimaryState>];

Proper System Response

The completed response indicates that the adjacency has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^^"<ospfadj_aid>::INTRFC=<interface_aid>,INTRFCTYP=<interface_type>,OSPFAREA=<
ospfarea_aid>,ADJST=<adjacency_status>,NGHBRID=<neighbor_routingid>,NGHBRADDR=<n
eighbor_address>:<pst>[,<sst>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.91 RTRV-OSPFADJ Parameters

Parameter Value(s) Definition
ospfadj_aid OSPFADJ-[1,3]-1-[1-40], OSPFADJ- EntityID-NPID-OSPFID-OSPFADJID
AUTO

interface_aid TL-[1,3]-[1-512]-[1-1500] Specifies the access identifier of the topological link being used
for this adjacency.

ospfarea_aid OSPFAREA-[1,3]-1-[1-32] Specifies the access identifier of the OSPF Area.

76.MTFP50/30, Rev B January 2018 Page 30-1181

22. Retrieve Commands TL1 Command Reference Manual

Table 22.91 RTRV-OSPFADJ Parameters (Continued)

Parameter Value(s) Definition
adjacency_stat DOWN Specifies the adjacency status.
us INIT - DOWN: It is the beginning of the neighbor formation.
ATTEMPT INIT: The router has sent a hello packet out its OSPF interfaces
TWOWAY and is awaiting a response from its neighbor(s).
EXSTART - EXSTART: The router receives a response from other routers.
EXCHANGE It sees its RID (routerID) in the hello packets that it receives
LOADING (neighbor field), which indicates that the neighbor router has
FULL received the initial hello and is responding to it. It is during the
EXSTART stage that the routers determine which is the master
and slave for the purposes of controlling the database
exchange.
- EXCHANGE: Routers send database description packets that
describe their entire database. The receiving router uses these
packets to see what LSAs it is missing or are out of date. This
information is used to generate link state requests (LSRs) that is
sent in the next step.
- LOADING: The router has a list of LSRs that is sent to ensure it
gets all the information needed from its neighbor.
After the LSRs are sent, the router receives link state update
(LSU) packets containing the missing or outof-date information.
Once the LSUs have been received from the router's neighbors'
databases, they is installed into its topology tables.
- FULL: The routers have become neighbors and have
experienced a successful exchange of database.
- ATTEMPT: No recent information has not been received from
the neighbor. Hello packets are being sent to contact neighbor.
- TWOWAY: Communications to the neighbor is bidirectional.

editablePrimar IS Indicates the primary state of the OSI router.

yState OOS Possible values for PST:
IS: In-Service
OOS: Out-of-Service

interface_type POINTTOPOINT Specifies the type of propagation that is performed on this

BROADCAST adjacency.
POINTTOMP - POINTTOPOINT - point to point
- BROADCAST - broadcast
- POINTTOMP - point to multipoint

neighbor_routi Possible values are: (1)32-bit value in Routing ID of the peer entity on the adjacency.
ngid dotted decimal format in the range
0.0.0.1 - 255.255.255.255 (2)NA -The
neighbor routing ID has not been
received from the neighbor.

neighbor_addr [0-255].[0-255].[0-255].[0-255] MCN/SCN address of the peer entity on the adjacency.

ess

pst IS-NR Indicates the primary state and primary state qualifier of the OSI
OOS-AU router
OOS-MA Possible values for PST:
OOS-AUMA IS: In-Service
OOS: Out-of-Service
Possible values for PSTQ:
NR: normal
AU: autonomous
MA: management
AUMA: autonomous and management

Page 30-1182 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.91 RTRV-OSPFADJ Parameters (Continued)

Parameter Value(s) Definition
sst SGEO Indicates the secondary state.
SGEO for Supporting Entity Outage

Example
RTRV-OSPFADJ:NE01:ALL:AM0011;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
^^^^"OSPFADJ-3-1-1::INTRFC=TL-1-1-1,INTRFCTYP=POINTTOMP,OSPFAREA=OSPFAREA-3-1-
1,ADJST=FULL,NGHBRID=20.3.0.12,NGHBRADDR=10.3.12.1:IS-NR,"
†††"OSPFADJ-3-1-2::INTRFC=TL-1-1-2,INTRFCTYP=POINTTOMP,OSPFAREA=OSPFAREA-3-1-
2,ADJST=FULL,NGHBRID=20.3.0.12,NGHBRADDR=10.3.12.2:IS-NR,"
†††"OSPFADJ-3-1-3::INTRFC=TL-1-1-1,INTRFCTYP=POINTTOMP,OSPFAREA=OSPFAREA-3-1-
1,ADJST=FULL,NGHBRID=20.3.0.11,NGHBRADDR=10.3.11.1:IS-NR,"
†††"OSPFADJ-3-1-4::INTRFC=TL-1-1-2,INTRFCTYP=POINTTOMP,OSPFAREA=OSPFAREA-3-1-
2,ADJST=FULL,NGHBRID=20.3.0.11,NGHBRADDR=10.3.11.2:IS-NR,"
†††"OSPFADJ-3-1-12::INTRFC=TL-1-1-1,INTRFCTYP=POINTTOMP,OSPFAREA=OSPFAREA-3-1-
1,ADJST=FULL,NGHBRID=20.3.0.84,NGHBRADDR=10.3.84.1:IS-NR,"
†††"OSPFADJ-AUTO::INTRFC=TL-1-1-7,INTRFCTYP=POINTTOPOINT,OSPFAREA=OSPFAREA-2-1-
1,ADJST=FULL,NGHBRID=20.2.0.84,NGHBRADDR=10.3.84.1:IS-NR,"
†††"OSPFADJ-AUTO::INTRFC=TL-1-1-4,INTRFCTYP=BROADCAST,OSPFAREA=OSPFAREA-2-1-
1,ADJST=FULL,NGHBRID=20.2.0.11,NGHBRADDR=150.200.2.11:IS-NR,"
†††"OSPFADJ-AUTO::INTRFC=TL-1-1-8,INTRFCTYP=POINTTOPOINT,OSPFAREA=OSPFAREA-2-1-
1,ADJST=FULL,NGHBRID=20.2.0.11,NGHBRADDR=10.3.11.1:IS-NR,"
†††"OSPFADJ-AUTO::INTRFC=TL-1-1-4,INTRFCTYP=BROADCAST,OSPFAREA=OSPFAREA-2-1-
1,ADJST=FULL,NGHBRID=20.2.0.12,NGHBRADDR=150.200.2.12:IS-NR,"
†††"OSPFADJ-AUTO::INTRFC=TL-1-1-5,INTRFCTYP=POINTTOPOINT,OSPFAREA=OSPFAREA-2-1-
1,ADJST=FULL,NGHBRID=20.2.0.12,NGHBRADDR=10.3.12.1:IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSPFADJ
ED-OSPFADJ
ENT-OSPFADJ

76.MTFP50/30, Rev B January 2018 Page 30-1183

22. Retrieve Commands TL1 Command Reference Manual

RTRV-OSPFAREA

Command Changes Since Previous Feature Package

• Added STUBTYPE attribute.

Description
The RTRV-OSPFAREA command enables to view the current configuration of an OSPF routing area.

Restrictions
• When ALL is used as an AID, information for all OSPF area entities that matches the specified filtering
parameter(s) is retrieved.

Command Format
RTRV-OSPFAREA:[tid]:{<ospfarea_aid>|ALL}:ctag::::[<editablePrimaryState>];

Proper System Response

The completed response indicates that the ospf area has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^^"<ospfarea_aid>::RAID=<RouterAreaId>,PRTPF=<prtpf_aid>,HUB=<hub>,RROVISIBILI
TY=<RRoFlag>;STUBTYPE=<stubtype>:<pst>[,sst]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.92 RTRV-OSPFAREA Parameters

Parameter Value(s) Definition
ospfarea_aid OSPFAREA-[1,3]-1-[1-32] EntityID-NPID-OSPFID-OSPFAREAID

editablePrimar IS Indicates the primary state of the OSI router.

yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

RouterAreaId [0-255].[0-255].[0-255].[0-255] The ID attribute of the OSPF area.

The area ID needs to be unique within a network. Each network
partition represents a network. A network spans multiple NEs.

prtpf_aid CPPF-[94-99,1-20] Specifies the access identifier of the Protocol Profile.

hub YES This attribute identifies the routing area is a hub.

NO

RRoFlag Masked This attribute identifies the visibility of a given OSPF area.
Passed
This state value applies to RRO only.
"Masked" means the RRO for this area is to be propagated
within the area but not to be propagated outside of the area,
whereas "Passed" would mean that the RRO for this area is to
be propagated outside of the area as well as within the area.

Page 30-1184 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.92 RTRV-OSPFAREA Parameters (Continued)

Parameter Value(s) Definition
stubtype DISABLED This attribute identifies the IPv4 stub area behavior for a given
STUB OSPF area.
NSSA The StubTypes have the following behavior:
- DISABLED - no Stub Area behavior. This is the default
behavior.
- STUB - No Type 5 AS-external LSAs propagated from the
Backbone area to this area. Default route inserted by ABR.
- NSSA - No Type 5 AS-external LSAs propagated from the
Backbone area to this area. Default route inserted by the ABR.
Type 7 LSAs generated within this area are converted at the
ABR to Type 5 LSAs and propagated into the Backbone Area.

pst IS-NR Indicates the primary state and primary state qualifier of the OSI
OOS-AU router.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous and management

sst SGEO Indicates the secondary state

- SGEO for Supporting Entity Outage

Example
RTRV-OSPFAREA:NE01:OSPFAREA-1-1-1:AM0011;

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD

^^^"OSPFAREA-1-1-1::RAID=192.168.1.1,PRTPF=CPPF-
1,HUB=YES,RROVISIBILITY=Masked;;STUBTYPE=DISABLED:IS-NR"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSPFAREA
ED-OSPFAREA
ENT-OSPFAREA

76.MTFP50/30, Rev B January 2018 Page 30-1185

22. Retrieve Commands TL1 Command Reference Manual

RTRV-OSPFRP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OSPFRP command enables to view one or more entries in a redistribution point table.

Restrictions
• When ALL is used as an AID, information for all OSPF redistribution point entities that matches the
specified filtering parameter(s) is retrieved.

• The creation of ABSTRACTNODE type RP is denied if the referenced child link Ifindex does not have
an associated TL provisioned.

Command Format
RTRV-
OSPFRP:[tid]:{<ospfrp_aid>|ALL}:ctag:::[CRTAREAID=<child_routing_area_id>][,PRTA
REAID=<parent_routing_area_id>][,ENTTYP=<entry_type>];

Proper System Response

The completed response indicates that the ospf area has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<ospfrp_aid>::CRTAREAID=<child_routing_area_id>,PRTAREAID=<parent_routing_ar
ea_id>,ENTTYP=<entry_type>[,PNDID=<parent_node_id>][,PTADDR=<parent_target_addre
ss>][,PTADDRMSK=<parent_target_address_mask>][,CTADDR=<child_target_address>][,C
TADDRMSK=<child_target_address_mask>][,PLADDR=<parent_link_address>][,PLIFINDEX=
<parent_link_ifindex>][,CLADDR=<child_link_address>][,CLIFINDEX=<child_link_ifin
dex>][,PRCDNC=<precedence>][,VALIDITY=<Validity>]"<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.93 RTRV-OSPFRP Parameters

Parameter Value(s) Definition
ospfrp_aid OSPFRP-[1,3]-1-[1-3]-[1-100] EntityID-NPID-OSPFID-OSPFRPMAPID-OSPFRPID

child_routing_ Enter 32-bit value in dotted decimal The ID attribute of the Child OSPF area.
area_id format. Possible values are: 0.0.0.1 to This parameter is used for all types of redistribution point.
255.255.255.255

parent_routing Enter 32-bit value in dotted decimal The ID attribute of the Parent OSPF area.
_area_id format. Possible values are: 0.0.0.0 to This parameter is used for all types of redistribution point.
255.255.255.255

Page 30-1186 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.93 RTRV-OSPFRP Parameters (Continued)

Parameter Value(s) Definition
entry_type REACHABILITY Specifies the type of map entry.
ABSTRACTNODE
HIERARCHY

parent_node_i Enter 32-bit value in dotted decimal Specifies the ID of the parent node for the redistribution point.
d format. Possible values are: 0.0.0.1 to This parameter is used for the hierarchy and reachability
255.255.255.255 redistribution point.

parent_target_ Enter 32-bit value in dotted decimal Specifies the target address of the parent node for the
address format. Possible values are: 0.0.0.1 to reachability redistribution point. The target address specifies the
255.255.255.255 dotted decimal portion of a TNA address.

parent_target_ Enter 32-bit value in dotted decimal Specifies the target address mask of the parent node for the
address_mask format. Possible values are: 0.0.0.0 to reachability redistribution point.
255.255.255.255

child_target_a Enter 32-bit value in dotted decimal Specifies the target address of the child node for the reachability
ddress format. Possible values are: 0.0.0.1 to redistribution point. The target address specifies the dotted
255.255.255.255 decimal portion of a TNA address.

child_target_a Enter 32-bit value in dotted decimal Specifies the target address mask of the child node for the
ddress_mask format. Possible values are: 0.0.0.0 to reachability redistribution point.
255.255.255.255

parent_link_ad Enter 32-bit value in dotted decimal Specifies the parent link address for the abstract node
dress format. Possible values are: 0.0.0.1 to redistribution point. The link address specifies the node ID
255.255.255.255 associated with the link.

parent_link_ifi Enter 32-bit value in dotted decimal Specifies the parent if index for the abstract node redistribution
ndex format. Possible values are: 0.0.0.1 to point.
255.255.255.255

child_link_addr Enter 32-bit value in dotted decimal Specifies the child link address for the abstract node
ess format. Possible values are: 0.0.0.1 to redistribution point. The link address specifies the node ID
255.255.255.255 associated with the link.

child_link_ifind Enter 32-bit value in dotted decimal Specifies the child if index for the abstract node redistribution
ex format. Possible values are: 0.0.0.1 to point.
255.255.255.255

precedence [0-255] Specifies the priority of the map entry for the hierarchy
redistribution point.

Validity YES Specifies the valid/invalid of RP entries.

NO
- YES: valid
- NO: invalid

Example
RTRV-OSPFRP:NE01:OSPFRP-3-1-1-1:AM0074;

76.MTFP50/30, Rev B January 2018 Page 30-1187

22. Retrieve Commands TL1 Command Reference Manual

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0074 COMPLD

^^^"OSPFRP-3-1-3-1::CRTAREAID=1.0.1.1,PRTAREAID=0.0.1.1,ENTTYPE=ABSTRACTNODE,
PNDID=1.111.111.111,PLADDR=192.28.255.255,PLIFINDEX=0.0.0.1,CLADDR=190.28.20.20,
CLIFINDEX=0.0.0.11"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSPFRP
ENT-OSPFRP

Page 30-1188 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-OSPFRPMAP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OSPFRPMAP command enables to view one or more redistribution map entities.

Restrictions
• When ALL is used as an AID, information for all OSPF redistribution point map entities is retrieved.

Command Format
RTRV-OSPFRPMAP:[tid]:{<ospfrpmap_aid>|ALL}:ctag;

Proper System Response

The completed response indicates that the ospf area has been configured for the routing controller.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<ospfrpmap_aid>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.94 RTRV-OSPFRPMAP Parameters

Parameter Value(s) Definition
ospfrpmap_aid OSPFRPMAP-[1,3]-1-[1-3] EntityID-NPID-OSPFID-OSPFRPMAPID

Example
RTRV-OSPFRPMAP:NE01:OSPFRPMAP-3-1-1:AM0074;

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0074 COMPLD

^^^"OSPFRPMAP-3-1-1"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-OSPFRPMAP
ENT-OSPFRPMAP

76.MTFP50/30, Rev B January 2018 Page 30-1189

22. Retrieve Commands TL1 Command Reference Manual

RTRV-OTS

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-OTS command instructs the network element (NE) to retrieve the attributes of the specified Line Side
Interface (OTS) facility entity.

Restrictions and Exceptions

• When ALL is used as an AID, information for all OTS entities that matches the specified filtering
parameter(s) is retrieved.

• ATPS does not be displayed when OTSMODE of OADMRS/OADMRS9 is not 7100.

• On OADMRS/OADMRS9, when OTSMODE=7100, EXPOTSTRC/MONOTSTRC/OTSTRC are

appliable.

• On OADMRS/OADMRS9, when OTSMODE=MTERA or HIT7300, ExpOPER/ExpDAPI/ExpSAPI/

txOPER/txDAPI/txSAPI/TIMDEF/MONOTSTRC are appliable.

Command Format
RTRV-OTS:[tid]:{<ots_aid>|ALL}:ctag:::[ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<ots_aid>::CPTYPE=<cp_type>,APAO=<APAOutMode>,APAI=<APAInMode>,ATPS=
<ATPSEnabled>,[,EXPOTSTRC=<OTSExpTrc>][,OTSTRC=<ots_trc>][,EXPSAPI=<ExpSAPI>][,T
XSAPI=<txSAPI>][,EXPDAPI=<ExpDAPI>][,TXDAPI=<txDAPI>][,EXPOPER=<ExpOperator>][,T
XOPER=<txOperator>],MONOTSTRC=<ots_
montrc>,ALMPF=<almProfile>[,FIBRTYPE=<fiberType>][,OTSMODE=<OTSMode>][,OPLADJ=<o
plAdj>][,GAINRANGE=<gainrange>][,OPGAINRANGE=<operating_gainrange>][,FSATILT=<fs
a_tilt>][,RMNTILTCOE=<raman_tilt_coeff>]:<pst>,[<sst>]" <cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.95 RTRV-OTS Parameters

Parameter Value(s) Definition
ots_aid OTS-20-[10-16,1-7]-21,OTS-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

Page 30-1190 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.95 RTRV-OTS Parameters (Continued)

Parameter Value(s) Definition
editablePrimar IS Indicates the primary state of the facility.
yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

cp_type OADMRS20 - OPTICAL ADD DROP Indicates the type of Module that this facility is supported on.
MULTIPLEXER ROUTE AND
SELECT - 20 PORTS
OADMRS9 - OPTICAL ADD DROP
MULTIPLEXER ROUTE AND
SELECT - 9 PORTS

APAOutMode AUTO Indicates the current output power adjustment mode.

MAN - AUTO indicates the facility is on automatic power adjustment.
- MAN indicates the facility is on manual power adjustment.

APAInMode AUTO Indicates the current input power adjustment mode.

MAN - AUTO indicates the facility is on automatic power adjustment.
- MAN indicates the facility is on manual power adjustment.

ATPSEnabled ENABLED Indicates the state of the automatic laser shutdown functionality
DISABLED at the line side interface. When there is a detection of LOS on
the line side interface the laser will automatically shutdown if the
ATPS is set to ENABLED. If ATPS is set to DISABLED, then the
laser remains on.

OTSExpTrc One to 28 alphanumeric characters Indicates the expected OTS trace identification.
All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id expected.

Refer to section 2 for the applicable characters.

ots_trc One to 28 alphanumeric characters Indicates the sent OTS trace identification.

For mTera UTP system, the default OTS trace consists of NE

TID and the shelfID and slotID the OTS locates,
"TID,ShelfID,SlotID" when OTSMODE=7100.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no SAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1191

22. Retrieve Commands TL1 Command Reference Manual

Table 22.95 RTRV-OTS Parameters (Continued)

Parameter Value(s) Definition
txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

For mTera UTP system, the default OTS trace consists of NE

TID and the shelfID and slotID the OTS locates,
"TID,ShelfID,SlotID" when OTSMODE=MTERA or HIT7300.

fiberType SMF28 Indicates the span fiber type that the specified OTS port is
TERALIGHT connected.
TRUEWAVEREACH
TRUEWAVERS
TRUEWAVEXL
LEAF
G.654
DSF
LS
TWCLASSIC
TWPLUS

OTSMode MTERA Indicates the interoperating optical system at the other end of
7100 the span that the OTS port connects:
HIT7300 - MTERA, Interoperation optical system is mTera UTP system
- 7100, Interoperation optical system is 7100 Nano or 7100 OTS
system
- HIT7300, Interoperation optical system is hiT 7300 optical
system

oplAdj ENABLED Indicates the support of manual provisioning the output power
DISABLED level (opl) on the OTS facility.

When OPLADJ = ENABLED, the opl does not be decided per

measured span loss but the manually input opl value. The
retrieved opl value is the manually input opl value.

When OPLADJ = DISABLED, the opl is decided per measured

span loss. The retrieved opl value is the automatically calculated
target opl value.

Default: DISABLED, when OTSMODE=MTERA

Always ENABLED, when OTSMODE=HIT7300
Always DISABLED, when OTSMODE=7100.

gainrange AUTO Specifies the gain range of the OADMRS/OADMRS9 module:

HIGH LOW = gain range 4.5~20.5dB
LOW HIGH = gain range 18.5~30.5dB (OADMRS), gain range
10.0~30.5 dB (OADMRS9)
AUTO, indicating the gain range is not decided by power
management, which is only supported when the module is
controlled under APC/ALC power management in OTSMODE of
MTERA or HIT7300.

Default value of gainrange for OADMRS/OADMRS9 when its

OTSMODE is configured to corresponding value:
AUTO, if OTSMODE of the module is HIT7300 or MTERA.
LOW, if OTSMODE of the module is 7100.

Page 30-1192 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.95 RTRV-OTS Parameters (Continued)

Parameter Value(s) Definition
operating_gain NA Indicates the operating gain range of the OADMRS/OADMRS9
range HIGH module:
LOW LOW = gain range 4.5~20.5dB
HIGH = gain range 18.5~30.5dB (OADMRS), gain range
10.0~30.5 dB (OADMRS9)
NA indicates operating gainrange is not decided.

fsa_tilt -200 to 200 (dB/THz/100) Specifies the Fiber Spectral Attenuation Tilt.

raman_tilt_coe 0 to 2000 ((dB/(THz*W))/100) Specifies the Raman Tilt Coefficient.

ff

pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

OTSMonTrc ENABLED-NOAIS Indicates the monitored OTS trace identification mode.

DISABLED - ENABLED-NOAIS indicates OTS trace monitoring is enabled.
- DISABLED indicates OTS trace monitoring is disabled.

secondaryStat APIP Indicates the secondary state of the facility.

e/sst DISC_INPROG - APIP: automatic power management in progress
FAF - DISC_INPROG: neighbor discovery in progress
MT - FAF: facility failure
SGEO - MT: maintenance
- SGEO: supporting entity outage

Example
RTRV-OTS:CORIANT1:OTS-20-1-21:AM0209;

Possible System Response

CORIANT1 14-12-02 03:20:21

M AM0209 COMPLD

"OTS-20-1-21::CPTYPE=\"OADMRS20 - OPTICAL ADD DROP MULTIPLEXER ROUTE AND SELECT -

20 PORTS\", APAO=AUTO,APAI=AUTO,
ATPS=ATPS,EXPOTSTRC=\"\",OTSTRC=\"\",MONTRC=ENABLED-
NOAIS,FIBRTYPE=SMF28,OTSMODE=7100,GAINRANGE=LOW,OPGAINRANGE=LOW,OPLADJ=DISABLED,
ALMPF=99:IS-NR,"

76.MTFP50/30, Rev B January 2018 Page 30-1193

22. Retrieve Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTS

Page 30-1194 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PM-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) Support.

• Added support for OSM-4S, OSM-5C.

• Added support of far-end PM on OSM-4C, OSM-4F.

Description
The RTRV-PM-{X} command instructs the network element (NE) to retrieve its current set of Performance
Monitoring data associated with the selected facility entity.

The following operation rules apply to the RTRV-PM command:

• The MONTM and MONDAT always appears in the output response.

• Output lines are not generated for MONTYPES that are not valid for the given termination and format.

Refer to Operation Rules table below for additional operation rules.

Table 22.96 Operation Rules

IF AND THEN
TMPER=15-MIN The Network Element (NE) is in 15 minute The current 15-minute register is
PM data collection mode and MONTM is retrieved.
null or represents the current time period.

TMPER=15-MIN The NE is in 15 minute PM data collection The command is accepted if

mode and MONDAT and MONTM specify a otherwise syntactically correct.
register that is maintained in the NE (past This acceptance does not depend
32 fifteen minute registers). upon the availability of the data
from the specified register.

TMPER=1-DAY MONDAT is null. The current daily register is

retrieved.

TMPER=1-DAY MONDAT and MONTM specify a register The acceptance does not depend
that is maintained in the NE (past 7 daily upon the availability of the data
registers). from the specified register.

Register specified with MONDAT, VLDTY and MONVAL fields

MONTM and TMPER has no shows NA.
associated data available.

Register specified with MONDAT, The command is denied.

MONTM and TMPER is not supported
or maintained within the NE.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): GBEP, TGLAN, FGE, HGE, OC3, OC12, OC48, OC192, STM1, STM4, STM16,
STM64, OCH (for OCH, OCH-L, OCH-P, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3,
ODU4, OTU1, OTU2, OTU4, OTUC2, OTUC3, OMS, OSC, STS1, STS3C, STS12C, STS48C,
STS192C.

Restrictions and Exceptions

• The Facility AID must always correspond to the Facility type.

76.MTFP50/30, Rev B January 2018 Page 30-1195

22. Retrieve Commands TL1 Command Reference Manual

• When OCH is used, it represents OCH, OCH-L, OCH-P, OCH-OS.

• When ALL is used as a second modifier, possible value for AID can only be "ALL" or blank. In this case,
it will address all entities except for ODUk montypes.

• When ALL is used as a second modifier, possible value for AID can only be "ALL" or blank. In this case,
it will address all entities except for STSn and ODUk montypes.

• AID is mandatory (can not be blank) unless second modifier is ALL.

• When no MONTYPE is specified, command response will include values for all MONTYPES supported
by the facility or equipment (except for STSn montypes).

• When the threshold level <thlev> parameter is set to 0 for a counter montype, then no automatic
message (TCA) is generated for this montype. Also, any TCAs announced during the time period, prior
to setting the parameter to 0 will still be visible via RTRV-TCA.

• NA is returned for PM parameters when the PM data is valid but not available due to provisioning such
as in the case where an ODUk is not mapped to an OTUk.

• When a supporting layer (for example, OCH-P) is taken OOS, the supported layers (for example, ODUx/
OTUx) will continue count UAS but will inhibit EB/CV, ES, SES counting.

• On OADMRS/OADMRS9, partial is returned for the PM parameters when the PM data is valid but
experienced the event of OPGAINRANGE value change on the module.

• The units for the retrieved delay value on an ODUk entity for DELAY-ODU(current value), DELAY-ODU-
F(floor value) and DELAY-ODU-C(ceiling value) are microseconds.

• PM is not supported for the ODUC2 and ODUC3 facilities on the OSM-4F module.

• Far-end PM is only applicable for OSM-4C and OSM-4F, and are applicable for the OTUC3, OTUC2,
OTU4, ODU4, ODU3, ODU2E, ODU2, ODU1, ODU0 and ODUF layers.

• The following PM are supported for each Module and facilities in this release: (Note: these figures
illustrate performance monitoring points for the various modules in the system. It is not intended to be
an exhaustive list of every performance parameter that is monitored. Please refer to the next 'Montypes
Supported' table for the details.)

• Far-end PM can be enabled and disabled via the SET-PMMODE command.

• Register initialization (via INIT-REG command) is not supported for far-end PM.

• When far-end PM is enabled, 0 is always returned for the far end Errored Blocks montype.

Page 30-1196 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Figure 22.6 PM with OADMRS/OADMRS9

Performance Monitoring
with OADMRS/OADMRS9
TDTN
LOSS,
SONET PM: TDTC
Section PM (CVS, ESS, SESS, SEFSS, UASS)
Line PM (CVL, ESL, SESL, FC-L, UASL)
Path PM (CVP, ESP, SESP, FCP, UASP,
PJCDIFFP, PJCSPDET, PJCSPGEN)

SONET PM:
Section PM (CVS, ESS, SESS, SEFS, UASS)
SSM-2S SONET/OTU
Line PM (CVL, ESL, SESL, FC-L, UASL)
Path PM (CVP, ESP, SESP, FCP, UASP, Section/RS
MFABs PM (OSC)
PJCDIFFP, PJCSPDET, PJCSPGEN)

OADMRS/OADMRS9
OCH-L/OMS/
OPT

ODU PM (TRMT:EB-ODU, ES-ODU, SES-ODU, MFABs

UAS-ODU) OCH/OMS/
OSC/OPR

LOSS,
BE-FEC, UBE-FEC,
CV-OTU, ES-OTU, OSM
SES-OTU, UAS-OTU
EB-ODU, ES-ODU, OPR,
SES-ODU, UAS-ODU, BE-FEC, UBE-FEC,
CVS, ESS, SESS, SEFSS, UASS, CV-OTU, ES-OTU,
SE, DROP, PKT, BCPKT, MCPKT, CRCAE SES-OTU, UAS-OTU,
EB-ODU, ES-ODU, SES-ODU, UAS-ODU,
USPKT, OSPKT, FRAG, JABR, UTIL PSC, PSD
PSC, PSD

For OSM-4C/OSM-4F, only external connections are supported. The following provides an overview of PM
supported on these modules. For details, refer to 'Montypes Supported' tables.

76.MTFP50/30, Rev B January 2018 Page 30-1197

22. Retrieve Commands TL1 Command Reference Manual

Figure 22.7 PM with OSM-4C/OSM-4F

Performance Monitoring
with OSM-4C/OSM-4F TDTN

TDTC

OSM-4C/
OSM-4F

Backplane
Near-end (NEND)
LOSS, OPR, DGD, CD, OSNR
BE-FEC, UBE-FEC, BER-FEC
CV-OTU, ES-OTU, SES-OTU, UAS-OTU
DELAY-ODU
EB-ODU, ES-ODU, SES-ODU, UAS-ODU,
PSC, PSD

Far-end (FEND)
CV-OTU-FE, ES-OTU-FE, SES-OTU-FE, UAS-OTU-FE
EB-ODU-FE, ES-ODU-FE, SES-ODU-FE, UAS-ODU-FE

Montypes Supported

Table 22.97 Montypes Supported

Module/Facilities PM SUPPORTED (MONTYPE) LOCN DIRN

OADMRS/OADMRS9
OCH-L Optical Power Transmitted: OPT (gauge) NEND TDTN

OCH-L Optical Power Received: OPR (gauge) NEND TDTC

OMS Optical Power Transmitted: OPT (gauge) NEND TDTN

OMS Optical Power Received: OPR (gauge) NEND TDTC

OSC Optical Power Received: OPR (gauge) NEND TDTC

OSC Bit Errors: CVS NEND TDTC

Errored Seconds: ESS
Severely Errored Seconds: SES
Severely Errored Frame Seconds: SEFSS
Loss of Signal Seconds: LOSS

OSM-1S
OTU1 Loss of Signal Seconds: LOSS NEND TDTN
OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction: UBE-
FEC
Errored Blocks on OTU: CV-OTU or EB-OTU
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

Page 30-1198 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.97 Montypes Supported (Continued)

Module/Facilities PM SUPPORTED (MONTYPE) LOCN DIRN
ODU1 Errored Block on ODU: EB-ODU NEND RCV
ODU0 Errored Seconds on ODU: ES-ODU
(Related to OTUk) Severely Errored Seconds on ODU: SES-ODU
Unavailable Seconds on ODU: UAS-ODU
Delay Measurement on ODU: DELAY-ODU (gauge)
Protection Switch Count/Duration: PSC, PSD

ODU1 Errored Block on ODU: EB-ODU NEND TRMT

ODU0 Errored Seconds on ODU: ES-ODU
(Related to Non-OTUk Severely Errored Seconds on ODU: SES-ODU
Interfaces) Unavailable Seconds on ODU: UAS-ODU
Delay Measurement on ODU: DELAY-ODU (gauge)
Protection Switch Count/Duration: PSC*, PSD*(*only retrieve)

OC48/STM16 SONET Section PM (CVS, ESS, SESS, SEFSS, UASS) NEND TDTN
OC12/STM4 Loss of Signal Seconds: LOSS
OC3/STM1

GBEP Loss of Signal Seconds: LOSS, NEND TDTN

Symbol Errors: SE
Ethernet PM: DROP, PKT, BCPKT, MCPKT, CRCAE, USPKT,
OSPKT, FRAG, JABR, UTIL (gauge)

OSM-2S
OCH-P Optical Power Received: OPR (gauge) NEND TDTC
OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction: UBE-
FEC
Coding Violations on OTU: CV-OTU
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

OTU2 Loss of Signal Seconds: LOSS NEND TDTN

OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction: UBE-
FEC
Errored Blocks on OTU: CV-OTU or EB-OTU
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

ODU2E Errored Block on ODU: EB-ODU NEND RCV

ODU2 Errored Seconds on ODU: ES-ODU
ODU1 Severely Errored Seconds on ODU: SES-ODU
ODU0 Unavailable Seconds on ODU: UAS-ODU
ODUF Delay Measurement on ODU: DELAY-ODU (gauge)
(Related to OTUk/OCH-P) Protection Switch Count/Duration: PSC, PSD

ODU2E Errored Block on ODU: EB-ODU NEND TRMT

ODU2 Errored Seconds on ODU: ES-ODU
ODU1 Severely Errored Seconds on ODU: SES-ODU
ODU0 Unavailable Seconds on ODU: UAS-ODU
ODUF Delay Measurement on ODU: DELAY-ODU (gauge)
(Related to Client Protection Switch Count/Duration: PSC, PSD
Interfaces)

76.MTFP50/30, Rev B January 2018 Page 30-1199

22. Retrieve Commands TL1 Command Reference Manual

Table 22.97 Montypes Supported (Continued)

Module/Facilities PM SUPPORTED (MONTYPE) LOCN DIRN
OC192 SONET Section PM (CVS, ESS, SESS, SEFSS, UASS) NEND TDTN
Loss of Signal Seconds: LOSS
Protection Switch Count/Duration: PSC, PSD

TGLAN Loss of Signal Seconds: LOSS NEND TDTN

Symbol Errors: SE
Ethernet: DROP, PKT, BCPKT, MCPKT, CRCAE, USPKT,
OSPKT, FRAG, JABR, UTIL (gauge)
Protection Switch Count/Duration: PSC, PSD

OSM-2C
OCH-P Optical Power Received: OPR (gauge) NEND TDTC
OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction:
UBE-FEC
OTU Bit Error Rate before Forward Error Correction: BER-
FEC (gauge)
Errored Block on OTU: CV-OTU (SONET mode)/EB-
OTU (SDH mode)
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU
Differential Group Delay: DGD (gauge)
Chromatic Dispersion: CD (gauge)
Optical Signal to Noise Ratio: OSNR (gauge)

OTU4 Loss of Signal Seconds: LOSS NEND TDTN

OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction: UBE-
FEC
Errored Blocks on OTU: CV-OTU or EB-OTU
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

ODU4 Errored Block on ODU: EB-ODU NEND RCV

ODU3 Errored Seconds on ODU: ES-ODU
ODU2E Severely Errored Seconds on ODU: SES-ODU
ODU2 Unavailable Seconds on ODU: UAS-ODU
ODU1 Delay Measurement on ODU: DELAY-ODU (gauge)
ODU0 Protection Switch Count/Duration: PSC, PSD
ODUF
(Related to OTUk/OCH-P)

ODU4 Errored Block on ODU: EB-ODU NEND TRMT

ODU3 Errored Seconds on ODU: ES-ODU
ODU2E Severely Errored Seconds on ODU: SES-ODU
ODU2 Unavailable Seconds on ODU: UAS-ODU
ODU1 Delay Measurement on ODU: DELAY-ODU (gauge)
ODU0 Protection Switch Count/Duration: PSC, PSD
ODUF
(Related to Client
Interfaces)

FGE Loss of Signal Seconds: LOSS NEND TDTN

Symbol Errors: SE
Ethernet: DROP, PKT, BCPKT, MCPKT, CRCAE, USPKT,
OSPKT, UTIL (gauge)

Page 30-1200 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.97 Montypes Supported (Continued)

Module/Facilities PM SUPPORTED (MONTYPE) LOCN DIRN
HGE Loss of Signal Seconds: LOSS NEND TDTN
Symbol Errors: SE
Ethernet: DROP, PKT, BCPKT, MCPKT, CRCAE, USPKT,
OSPKT, UTIL (gauge)
Protection Switch Count/Duration: PSC, PSD

SSM-2S
OCn SONET Section PM (CVS, ESS, SESS, SEFSS, UASS) NEND TDTN
Port side SONET Line PM (CVL, ESL, SESL, FC-L, UASL)
Loss of Signal Seconds: LOSS
Protection Switch Count/Duration: PSC, PSD (for 1+1 APS
only)

OCn SONET Section PM (CVS, ESS, SESS, SEFSS, UASS) NEND TDTC
Backplane side with virtual SONET Line PM (CVL, ESL, SESL, FC-L, UASL)
port

ODU2 Errored Block on ODU: EB-ODU NEND TRMT

ODU1 Errored Seconds on ODU: ES-ODU
(Related to backplane OCn Severely Errored Seconds on ODU: SES-ODU
facility with virtual port) Unavailable Seconds on ODU: UAS-ODU
Delay Measurement on ODU: DELAY-ODU (gauge)

STSn SONET Path PM (CVP, ESP, SESP, FCP, UASP, PJCDIFFP, NEND TDTN
Port side PJCSPDET, PJCSPGEN)

STSn SONET Path PM (CVP, ESP, SESP, FCP, UASP, PJCDIFFP, NEND TDTC
Backplane side with virtual PJCSPDET, PJCSPGEN)
port

OSM-4C

OCH-OS Loss of Signal Seconds: LOSS NEND TDTC

Optical Power Received: OPR (gauge)
Bit Error Forward Error Correction: BE-FEC
Uncorrected Block Error Forward Error Correction:
UBE-FEC
Bit Error Rate before Forward Error Correction: BER-FEC
(gauge)
Differential Group Delay: DGD (gauge)
Chromatic Dispersion: CD (gauge)
Optical Signal to Noise Ratio: OSNR (gauge)

OTU4 Errored Blocks on OTU: CV-OTU NEND TDTC

Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

Errored Blocks on OTU: CV-OTU-FE FEND TDTC

Errored Seconds on OTU: ES-OTU-FE
Severely Errored Seconds on OTU: SES-OTU-FE
Unavailable Seconds on OTU: UAS-OTU-FE

76.MTFP50/30, Rev B January 2018 Page 30-1201

22. Retrieve Commands TL1 Command Reference Manual

Table 22.97 Montypes Supported (Continued)

Module/Facilities PM SUPPORTED (MONTYPE) LOCN DIRN
ODU4 Errored Block on ODU: EB-ODU NEND RCV
ODU3 Errored Seconds on ODU: ES-ODU
ODU2E Severely Errored Seconds on ODU: SES-ODU
ODU2 Unavailable Seconds on ODU: UAS-ODU
ODU1 Delay Measurement on ODU: DELAY-ODU (gauge)
ODU0 Protection Switch Count/Duration: PSC, PSD
ODUF
(Related to OTUk/OCH- Errored Block on ODU: EB-ODU-FE FEND RCV
OS) Errored Seconds on ODU: ES-ODU-FE
Severely Errored Seconds on ODU: SES-ODU-FE
Unavailable Seconds on ODU: UAS-ODU-FE

OSM-4F

OCH-OS Loss of Signal Seconds: LOSS NEND TDTC

Optical Power Received: OPR (gauge)
Bit Error Forward Error Correction: BE-FEC
Uncorrected Block Error Forward Error Correction:
UBE-FEC
Bit Error Rate before Forward Error Correction: BER-FEC
(gauge)
Differential Group Delay: DGD (gauge)
Chromatic Dispersion: CD (gauge)
Optical Signal to Noise Ratio: OSNR (gauge)

OTUC2 Errored Blocks on OTU: CV-OTU NEND TDTC

OTUC3 Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

Errored Blocks on OTU: CV-OTU-FE FEND TDTC

Errored Seconds on OTU: ES-OTU-FE
Severely Errored Seconds on OTU: SES-OTU-FE
Unavailable Seconds on OTU: UAS-OTU-FE

OTU4 Errored Blocks on OTU: CV-OTU NEND TDTC

Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

Errored Blocks on OTU: CV-OTU-FE FEND TDTC

Errored Seconds on OTU: ES-OTU-FE
Severely Errored Seconds on OTU: SES-OTU-FE
Unavailable Seconds on OTU: UAS-OTU-FE

ODU4 Errored Block on ODU: EB-ODU NEND RCV

ODU3 Errored Seconds on ODU: ES-ODU
ODU2E Severely Errored Seconds on ODU: SES-ODU
ODU2 Unavailable Seconds on ODU: UAS-ODU
ODU1 Delay Measurement on ODU: DELAY-ODU (gauge)
ODU0 Protection Switch Count/Duration: PSC, PSD
ODUF
(Related to OTUk/OCH- Errored Block on ODU: EB-ODU-FE FEND RCV
OS) Errored Seconds on ODU: ES-ODU-FE
Severely Errored Seconds on ODU: SES-ODU-FE
Unavailable Seconds on ODU: UAS-ODU-FE

OSM-4S

Page 30-1202 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.97 Montypes Supported (Continued)

Module/Facilities PM SUPPORTED (MONTYPE) LOCN DIRN
OCH-P Optical Power Received: OPR (gauge) NEND TDTC
OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction: UBE-
FEC
Errored Block on OTU: CV-OTU or EB-OTU
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

OTU2 Loss of Signal Seconds: LOSS NEND TDTN

OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction: UBE-
FEC
Errored Blocks on OTU: CV-OTU or EB-OTU
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

ODU2E Errored Block on ODU: EB-ODU NEND RCV

ODU2 Errored Seconds on ODU: ES-ODU
ODU1 Severely Errored Seconds on ODU: SES-ODU
ODU0 Unavailable Seconds on ODU: UAS-ODU
ODUF Delay Measurement on ODU: DELAY-ODU (gauge)
(Related to OTU2/OCH-P) Protection Switch Count/Duration: PSC, PSD

ODU2E Errored Block on ODU: EB-ODU NEND TRMT

ODU2 Errored Seconds on ODU: ES-ODU
ODU1 Severely Errored Seconds on ODU: SES-ODU
ODU0 Unavailable Seconds on ODU: UAS-ODU
ODUF Delay Measurement on ODU: DELAY-ODU (gauge)
(Related to Client Protection Switch Count/Duration: PSC, PSD
Interfaces)

TGLAN Loss of Signal Seconds: LOSS NEND TDTN

Symbol Errors: SE
Ethernet: DROP, PKT, BCPKT, MCPKT, CRCAE, USPKT,
OSPKT, FRAG, JABR, UTIL (gauge)

OSM-5C
OTU4 Loss of Signal Seconds: LOSS NEND TDTN
OTU Bit Error Forward Error Correction: BE-FEC
OTU Uncorrected Block Error Forward Error Correction: UBE-
FEC
Errored Blocks on OTU: CV-OTU or EB-OTU
Errored Seconds on OTU: ES-OTU
Severely Errored Seconds on OTU: SES-OTU
Unavailable Seconds on OTU: UAS-OTU

ODU4 Errored Block on ODU: EB-ODU NEND RCV

ODU3 Errored Seconds on ODU: ES-ODU
ODU2E Severely Errored Seconds on ODU: SES-ODU
ODU2 Unavailable Seconds on ODU: UAS-ODU
ODU1 Delay Measurement on ODU: DELAY-ODU (gauge)
ODU0 Protection Switch Count/Duration: PSC, PSD
ODUF
(Related to OTU4)

76.MTFP50/30, Rev B January 2018 Page 30-1203

22. Retrieve Commands TL1 Command Reference Manual

Table 22.97 Montypes Supported (Continued)

Module/Facilities PM SUPPORTED (MONTYPE) LOCN DIRN
ODU4 Errored Block on ODU: EB-ODU NEND TRMT
ODU3 Errored Seconds on ODU: ES-ODU
ODU2E Severely Errored Seconds on ODU: SES-ODU
ODU2 Unavailable Seconds on ODU: UAS-ODU
ODU1 Delay Measurement on ODU: DELAY-ODU (gauge)
ODU0 Protection Switch Count/Duration: PSC, PSD
ODUF
(Related to Client
Interfaces)

HGE Loss of Signal Seconds: LOSS NEND TDTN

Symbol Errors: SE
Ethernet: DROP, PKT, BCPKT, MCPKT, CRCAE, USPKT,
OSPKT, UTIL (gauge)

PM Register Sizes and Default Thresholds

Note: The following tables include Counter and Gauge values. For single value
montypes, they are considered counters (there are no ceiling/floor
thresholds). For multi-value montypes they are considered gauges and
include a base value, a max value and a min value.

Some gauges do not include a min value. Reference the Restrication and
Exceptions section for notes on Gauge limits for specific montypes.

Note: Register sizes for the supported far-end montypes are the same as the
corresponding near-end montypes.

Table 22.98 Performance Monitoring Register Sizes

Counter Size or Gauge Value Threshold Range

Parameter 15-minute 1-day 15-minute 1-day

OPT, OPR at OMS layer -60 dBm to +60 -60 dBm to not supported not supported
dBm +60 dBm
OPT, OPR at OCH layer -60 dBm to +60 -60 dBm to -45 dBm to +20 -45 dBm to +20
dBm +60 dBm dBm dBm
OSC OPR -60 dBm to +60 -60 dBm to -45 dBm to +4 -45 dBm to +4
dBm +60 dBm dBm dBm
BE-FEC (100G) 922337203685 922337203685 1 to 1 to
4775807 4775807 92233720368547 9223372036854
75807 775807
BE-FEC (Applicable to 9.22337E+18 9.22337E+18 1 to 1 to
100G/200G/2X150G on 92233720368547 9223372036854
OCH-OS) 75807 775807

Page 30-1204 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.98 Performance Monitoring Register Sizes (Continued)

Counter Size or Gauge Value Threshold Range

Parameter 15-minute 1-day 15-minute 1-day

BE-FEC (10G) 2147483647 2147483647 1 to 2147483647 1 to 2147483647
(each unit (each unit (each unit (each unit
represents represents represents 8000 represents 8000
8000 errors) 8000 errors) errors) errors)
UBE-FEC, SE 2147483647 2147483647 1 to 2147483647 1 to 2147483647
UBE-FEC (Applicable to 2147483647 2147483647 1 to 2147483647 1 to 2147483647
100G/200G/2X150G on
OCH-OS)

SE (HGE and FGE) 184467440737 184467440737 1 to 1 to

09551615 09551615 18446744073709 1844674407370
551615 9551615
BER-FEC (OCH-P on 1.9E-2 to 2.3E- 1.9E-2 to 2.3E- 1.9E-2 to 2.3E-11 1.9E-2 to 2.3E-
OSM-2C) 11 and 0 11 and 0 and 0 11 and 0
BER-FEC (OCH-OS on 1.9E-2 to 2.3E- 1.9E-2 to 2.3E- 1.9E-2 to 2.3E-11 1.9E-2 to 2.3E-
OSM-4C/OSM-4F with 11 and 0 11 and 0 and 0 11 and 0
15% SDFEC)

BER-FEC (OCH-OS on 0.5 to 1E-11 0.5 to 1E-11 0.5 to 1E-11 and 0 0.5 to 1E-11 and
OSM-4F with 25% and 0 and 0 0
SDFEC)

Ethernet PM: DROP, PKT, 2147483647 2147483647 0 to 2147483647 0 to 2147483647

BCPKT, MCPKT, CRCAE,
USPKT, OSPKT, FRAG,
JABR

Ethernet PM on FGE/ 184467440737 184467440737 0 to 0 to

HGE: DROP, PKT, 09551615 09551615 18446744073709 1844674407370
BCPKT, MCPKT, CRCAE, 551615 9551615
USPKT, OSPKT,UTIL

Ethernet PM: UTIL 100 % 100 % 0 to 100 % 0 to 100 %

CVP 57600000 2147483647 0 to 57600000 0 to 2147483647
CVS, CVL, CV-OTU 57600000 2147483647 1 to 57600000 1 to 2147483647
CV-OTU (OTU4/OTUC2/ 922337203685 922337203685 1 to 1 to
OTUC3), EB-ODU 4775807 4775807 92233720368547 9223372036854
(ODU4), EB-ODUT 75807 775807
(ODU4T)

ESS, SESS, SEFSS, 900 86400 1 to 900 1 to 86400

UASS, ESL, SESL, UASL,
FC-L,
ES-OTU, SES-OTU, UAS-
OTU,
ES-ODU, SES-ODU,
UAS-ODU,
ES-ODUT, SES-ODUT,
UAS-ODUT,
LOSS

76.MTFP50/30, Rev B January 2018 Page 30-1205

22. Retrieve Commands TL1 Command Reference Manual

Table 22.98 Performance Monitoring Register Sizes (Continued)

Counter Size or Gauge Value Threshold Range

Parameter 15-minute 1-day 15-minute 1-day

ESP, SESP, UASP 900 86400 0 to 900 0 to 86400
PJCSPDET, PJCSPGEN 900 86400 0 to 900 0 to 86400
FCP, FCHP 900 86400 0 to 900 0 to 86400
PJCDIFFP 1048575 16777215 0 to 1048575 0 to 16777215
PSC, PSC 18000 17280000 not supported not supported
PSD, PSD 900 s 86400 s not supported not supported
DELAY-ODU, DELAY- 0 to 0 to 0 to 2147483647 0 to 2147483647
ODUT 2147483647 2147483647 us us
us us
DGD (Applicable to 100G 0 to 70 ps 0 to 70 ps 0 to 71 ps 0 to 71 ps
OCH-P)

DGD (Applicable to 100G/ 0 to 100 ps 0 to 100 ps 0 to 101 ps 0 to 101 ps

200G/2X150G OCH-OS)

CD (Applicable to 100G -40000 to -40000 to -40000 to +40000 -40000 to

OCH-P) +40000 ps/nm +40000 ps/nm ps/nm +40000 ps/nm
CD (Applicable to 100G/ -280,000 to -280,000 to -280,000 to -280,000 to
200G/2X150G OCH-OS) +280,000 ps/ +280,000 ps/ +280,000 ps/nm +280,000 ps/nm
nm nm
OSNR (Applicable to LT+12.0, +12.0 LT+12.0, +12.0 0, +12.0 to +20.0 0, +12.0 to +20.0
100G OCH-P) to +20.0, to +20.0, dB dB
GT+20.0 dB GT+20.0 dB
OSNR (Applicable to 0, LT+12.0, 0, LT+12.0, 0, +12.0 to +20.0 0, +12.0 to +20.0
100G/200G/2X150G +12.0 to +20.0, +12.0 to +20.0, dB dB
OCH-OS) GT+20.0 dB GT+20.0 dB

Table 22.99 Default Thresholds OC3 Signal

Default Threshold Value
Monitored Parameter Montype
15-Minute 1-Day
Coding Violation - Section CVS, 140 13440
Background Block Error - RS BBERS

Errored Second - Section/RS ESS, 25 250

ESSRS

Severely Errored Seconds - Section/RS SESS, 4 40

SESSRS

Severely Errored Frame Second - Section SEFSS, 2 8

Out of Frame Seconds - RS OFSRS

Loss of Signal Seconds LOSS 2 8

Page 30-1206 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.99 Default Thresholds OC3 Signal (Continued)

Default Threshold Value
Monitored Parameter Montype
15-Minute 1-Day
Coding Violation - Line CVL, 138 13290
Background Block Error - MS BBEMS

Errored Second - Line/MS ESL, 25 250

ESMS

Severely Errored Seconds - Line/MS SESL, 4 40

SESMS

Unavailable Second - Line/MS UASL, 10 10

Unavailable Second - Section/RS UASMS,
UASS,
UASRS

Failure Count - Line/MS FC-L, 1 1

FCMS

Table 22.100 Default Thresholds for OC12 Signal

Threshold Threshold
Monitored Parameter Montype
15-Minute 1-Day
Coding Violation - Section CVS, 560 53760
Background Block Error - RS BBERS

Errored Second - Section/RS ESS, 25 250

ESSRS

Severely Errored Seconds - Section/RS SESS, 4 40

SESSRS

Severely Errored Frame Second - Section SEFSS, 2 8

Out of Frame Seconds - RS OFSRS

Loss of Signal Seconds LOSS 2 8

Coding Violation - Line CVL, 554 53150
Background Block Error - MS BBEMS

Errored Second - Line/MS ESL, 25 250

ESMS

Severely Errored Seconds - Line/MS SESL, 4 40

SESMS

Unavailable Second - Line/MS UASL, 10 10

Unavailable Second - Section/RS UASMS
UASS,
UASRS

Failure Count - Line/MS FC-L, 1 1

FCMS

76.MTFP50/30, Rev B January 2018 Page 30-1207

22. Retrieve Commands TL1 Command Reference Manual

Table 22.101 Default Threshold for OC48 Signal

Threshold Threshold
Monitored Parameter Montype
15-Minute 1-Day
Coding Violation - Section CVS, 2240 215040
Background Block Error - RS BBERS

Errored Second - Section/RS ESS, 25 250

ESSRS

Severely Errored Seconds - Section/RS SESS, 4 40

SESSRS

Severely Errored Frame Second - Section SEFSS, 2 8

Out of Frame Seconds - RS OFSRS

Loss of Signal Seconds LOSS 2 8

Coding Violation - Line CVL, 2208 212640
Background Block Error - MS BBEMS

Errored Second - Line/MS ESL, 25 250

ESMS

Severely Errored Seconds - Line/MS SESL, 4 40

SESMS

Unavailable Second - Line/MS UASL, 10 10

Unavailable Second - Section/RS UASMS,
UASS,
UASRS

Failure Count - Line/MS FC-L, 1 1

FCMS

Table 22.102 Default Threshold for OC192/STM64 Signal

Threshold Threshold
Monitored Parameter Montype
15-Minute 1-Day
Coding Violation - Section CVS, 8960 860160
Background Block Error - RS BBERS

Errored Second - Section/RS ESS, 25 250

ESSRS

Severely Errored Seconds - Section/RS SESS, 4 40

SESSRS

Severely Errored Frame Second - Section SEFSS, 2 8

Out of Frame Seconds - RS OFSRS

Loss of Signal Seconds LOSS 2 8

Coding Violation - Line CVL, 8832 850560
Background Block Error - MS BBEMS

Errored Second - Line/MS ESL, 25 250

ESMS

Page 30-1208 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.102 Default Threshold for OC192/STM64 Signal (Continued)

Threshold Threshold
Monitored Parameter Montype
15-Minute 1-Day
Severely Errored Seconds - Line/MS SESL, 4 40
SESMS

Unavailable Second - Line/ UASL, 10 10

Unavailable Second - Section/RS UASMS,
UASS,
UASRS

Failure Count - Line/MS FC-L, 1 1

FCMS

Table 22.103 Default Thresholds for STS1/STS3C/STS12C/STS48C/192C

Threshold Threshold
Monitored Parameter Montype
15-Minute 1-Day

Coding Violation - Path, STS1 CVP 15 125

Coding Violation - Path, STS3C CVP 25 250
Coding Violation - Path, STS12C CVP 75 750
Coding Violation - Path, STS48C CVP 320 3200
Coding Violation - Path, STS192C a CVP 20 200
Errored Second - Path, STS1 ESP 12 100
Errored Second - Path, STS3C ESP 20 200
Errored Second - Path, STS12C ESP 60 600
Errored Second - Path, STS48C ESP 250 2500
Errored Second - Path, STS192C a ESP 16 160
Severely Errored Seconds - Path (All STS) SESP 3 7
Unavailable Second - Path (All STS) UASP 10 10
Pointer Justification Count Seconds - Generate PJCSPGEN 0 0
(All STS)

Pointer Justification Count Seconds - Detect PJCSPDET, 0 0

(All STS)

Pointer Justification Count Seconds - Difference PJCDIFFP 0 0

(All STS)

Failure Count - Path FCP 1 1

-12
a - The STS192C values assume the path is carried over a facility with a BER of 1x10 (that is, over
OC192).

76.MTFP50/30, Rev B January 2018 Page 30-1209

22. Retrieve Commands TL1 Command Reference Manual

Table 22.104 BIP Errors required to Trigger SESS or SESL

Rate Section BIP Errors for SESS Line BIP Errors for SESL
OC3 155 154

OC12 616 615

OC48 2392 2459

OC192 8554 9835

Table 22.105 Default Thresholds for Data Signals (GBEP, TGLAN, FGE, HGE)
Threshold Threshold

Monitored Parameter Montype 15-Minute 1-Day

Symbol Error During SE 113 10800
Carrier

Symbol Error During SE 452 43200

Carrier (for FGE)

Symbol Error During SE 1130 108000

Carrier (for HGE)

Loss of Signal Seconds LOSS 2 8

Table 22.106 Default Thresholds for G.709 ODU/OTU Signals

Threshold Threshold

Monitored Parameter Montype 15-Minute 1-Day

Block Error - Forward Error BE-FEC 29993 2879342
Correction (applies to (each unit represents (each unit represents
OTU1) 8000 errors) 8000 errors)
Block Error - Forward Error BE-FEC 120479 11565963
Correction (applies to (each unit represents (each unit represents
OTU2, applies to OCH-P 8000 errors) 8000 errors)
on 10G Transponders)

Block Error - Forward Error BE-FEC 124827 11983386

Correction (applies to (each unit represents (each unit represents
OTU2(OTU2e), applies to 8000 errors) 8000 errors)
OCH-P(OTU2e) on 10G
Transponders)

Block Error - Forward Error BE-FEC 1085211000000 104180256000000

Correction (applies to (each unit represents 1 (each unit represents 1
OCH-P on 100G error) error)
Transponder)

Block Error - Forward Error BE-FEC 10062897621 966038171630

Correction (applies to (each unit represents 1 (each unit represents 1
OTU4) error) error)

Page 30-1210 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.106 Default Thresholds for G.709 ODU/OTU Signals (Continued)

Threshold Threshold

Monitored Parameter Montype 15-Minute 1-Day

Block Error - Forward Error BE-FEC 1085211000000 104180256000000
Correction (applies to (each unit represents 1 (each unit represents 1
OCH-OS on 100G with error) error)
15% SFEC, 120.579 Gb/s)

Block Error - Forward Error BE-FEC 1236194046360 118674628450560

Correction (applies to (each unit represents 1 (each unit represents 1
OCH-OS on 100G with error) error)
25% SFEC, 137.355 Gb/s)

Block Error - Forward Error BE-FEC 2472388092720 237349256901120

Correction (applies to (each unit represents 1 (each unit represents 1
OCH-OS on 2X150G with error) error)
25% SFEC, 206.035 Gb/s)

Block Error - Forward Error BE-FEC 2472388092720 237349256901120

Correction (applies to (each unit represents 1 (each unit represents 1
OCH-OS on 200G with error) error)
25% SFEC, 273.328 Gb/s)

Uncorrectable Block UBE-FEC 875 84000

Errors, Forward Error
Correction (applies to
OCH-P, OTU1, OTU2)

Uncorrectable Block UBE-FEC 875 84000

Errors, Forward Error
Correction (applies to
OCH-OS on 100G with
15% SFEC, 120.579 Gb/s)

Uncorrectable Block UBE-FEC 875 84000

Errors, Forward Error
Correction (applies to
OCH-OS on 100G with
25% SFEC, 137.355 Gb/s)

Uncorrectable Block UBE-FEC 875 84000

Errors, Forward Error
Correction (applies to
OCH-OS on 2X150G with
25% SFEC, 206.035 Gb/s)

Uncorrectable Block UBE-FEC 875 84000

Errors, Forward Error
Correction (applies to
OCH-OS on 200G with
25% SFEC, 273.328 Gb/s)

Bit Error Rate, before BER-FEC-HT 1.0E-2 1.0E-2

Forward Error Correction (High Threshold) (High Threshold)
(applies to OCH-P on
OSM2C)

76.MTFP50/30, Rev B January 2018 Page 30-1211

22. Retrieve Commands TL1 Command Reference Manual

Table 22.106 Default Thresholds for G.709 ODU/OTU Signals (Continued)

Threshold Threshold

Monitored Parameter Montype 15-Minute 1-Day

Bit Error Rate, before BER-FEC-HT 1.0E-2 1.0E-2
Forward Error Correction (High Threshold) (High Threshold)
(applies to OCH-OS on
100G with 15% SFEC,
120.579 Gb/s)

Bit Error Rate, before BER-FEC-HT 1.0E-3 1.0E-3

Forward Error Correction (High Threshold) (High Threshold)
(applies to OCH-OS on
100G with 25% SFEC,
137.355 Gb/s)

Bit Error Rate, before BER-FEC-HT 2.0E-3 2.0E-3

Forward Error Correction (High Threshold) (High Threshold)
(applies to OCH-OS on
2X150G with 25% SFEC,
206.035 Gb/s)

Bit Error Rate, before BER-FEC-HT 8.0E-3 8.0E-3

Forward Error Correction (High Threshold) (High Threshold)
(applies to OCH-OS on
200G with 25% SFEC,
273.328 Gb/s)

Code Violations/Error CV-OTU (SONET) 735 70575

blocks - OTU (applies to EB-OTU (SDH)
OTU1 on OSM-1S)

Code Violations/Error CV-OTU (SONET) 738 70870

blocks - OTU (applies to EB-OTU (SDH)
OTU2 on OSM-2S/OSM-
4S)

Code Violations/Error CV-OTU (SONET) 765 73428

blocks - OTU (applies to EB-OTU (SDH)
OTU2e on OSM-2S/OSM-
4S)

Code Violations/Error CV-OTU (SONET) 771 73992

blocks - OTU (applies to EB-OTU (SDH)
OTU4)

Code Violations/Error CV-OTU (SONET) 1943 186541

blocks - OTU (applies to EB-OTU (SDH)
OTU4 - 25% FEC, 137.355
Gb/s)

Code Violations/Error CV-OTU (SONET) 3886 373081

blocks - OTU (applies to EB-OTU (SDH)
OTUC2)

Code Violations/Error CV-OTU (SONET) 5829 559622

blocks - OTU (applies to EB-OTU (SDH)
OTUC3)

Errored Seconds - OTUk/ ES-OTU 25 250

OTUC2/OTUC3

Page 30-1212 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.106 Default Thresholds for G.709 ODU/OTU Signals (Continued)

Threshold Threshold

Monitored Parameter Montype 15-Minute 1-Day

Severely Errored Seconds SES-OTU 4 40
- OTUk/OTUC2/OTUC3

Unavailable Seconds - UAS-OTU 10 10

OTUk/OTUC2/OTUC3

Errored Blocks - ODUF EB-ODU 0.00025 (%) 0.00025 (%)

Errored Blocks - ODU0 EB-ODU 92 8786
Errored Blocks - ODU1 EB-ODU 735 70575
Errored Blocks - ODU2 EB-ODU 738 70870
Errored Blocks - ODU2e EB-ODU 765 73428
Errored Blocks - ODU4 EB-ODU 771 73992
Errored Seconds - ODUk ES-ODU 25 250
Severely Errored Seconds SES-ODU 4 40
- ODUk

Unavailable Seconds - UAS-ODU 10 10

ODUk

Loss of Signal Seconds LOSS 2 8

(applies to OTUk only)

Loss of Signal Seconds LOSS 2 8

(applies to OCH-OS only)

Delay measurement - DELAY-ODU-LT 0 0

ODU - Low Threshold
Delay measurement - DELAY-ODU-HT 2147483647 2147483647
ODU - High Threshold
Differential Group Delay DGD-HT +71 +71
- High Threshold
Differential Group Delay - DGD-HT 101 101
High Threshold (applies to
OCH-OS)

Chromatic Dispersion - CD-LT -40000 -40000

Low Threshold
Chromatic Dispersion - CD-LT -40000 -40000
Low Threshold (applies to
OCH-OS)

Chromatic Dispersion - CD-HT +40000 +40000

High Threshold
Chromatic Dispersion - CD-HT +40000 +40000
High Threshold (applies to
OCH-OS)

76.MTFP50/30, Rev B January 2018 Page 30-1213

22. Retrieve Commands TL1 Command Reference Manual

Table 22.106 Default Thresholds for G.709 ODU/OTU Signals (Continued)

Threshold Threshold

Monitored Parameter Montype 15-Minute 1-Day

Optical Signal to Noise OSNR-LT 0 0

Ratio - Low Threshold
Optical Signal to Noise OSNR-LT 0 0
Ratio - Low Threshold
(applies to OCH-OS)

Table 22.107 Default Thresholds for Optical Power Levels

Monitored Point Low Threshold High Threshold

Monitored Parameter Montype 15-Minute/1-Day 15-Minute/1-Day

OSC OPR OSC on OADMRS/ -18.0 dBm +1.0 dBm
Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=LOW,
and OTSMODE= 7100

OSC OPR OSC on OADMRS/ -32.0 dBm -12.0 dBm

Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=HIGH,
and OTSMODE= 7100

OSC OPR OSC on OADMRS/ -20.0 dBm +1.0 dBm

Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=LOW,
and OTSMODE= MTERA
or HIT7300

OSC OPR OSC on OADMRS/ -35.0 dBm -12.0 dBm

Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=HIGH,
and OTSMODE= MTERA
or HIT7300

OCH-L (wavelength) OPR OCH-L on OADMRS/ -18.0 dBm +1.0 dBm

Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=LOW,
and OTSMODE= 7100

OCH-L (wavelength) OPR OCH-Lon OADMRS/ -34.0 dBm -12.0 dBm

Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=HIGH,
and OTSMODE= 7100

OCH-L (wavelength) OPR OCH-L on OADMRS/ -18.0 dBm -11.0 dBm

Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=LOW,
and OTSMODE= MTERA
or HIT7300

OCH-L (wavelength) OPR OCH-L on OADMRS/ -37.0 dBm -12.0 dBm

Optical Power Receive OADMRS9 for
DWDM Input OPGAINRANGE=HIGH,
and OTSMODE= MTERA
or HIT7300

Page 30-1214 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.107 Default Thresholds for Optical Power Levels (Continued)

Monitored Point Low Threshold High Threshold

Monitored Parameter Montype 15-Minute/1-Day 15-Minute/1-Day

OCH-L (wavelength) OPT OCH-L on OADMRS/ -6.0dB +6.0dB
Optical Power Transmit OADMRS9 (offset to target (offset to target
DWDM Output level) level)
OCH-P OPR OCH-P on 100G line side -18 dBm 0 dBm
Optical Power Receive interface, OSM-2C
100G Line side Interface,
OSM-2C

OCH-P OPR OCH-P on 10G line side -18 dBm -5.0 dBm
Optical Power Receive interface
10G Line side Interface

OCH-OS OPR OCH-OS on 100G line side -18 dBm +15 dBm
Optical Power Receive interface, OSM-4C
100G Line side Interface,
OSM-4C

OCH-OS OPR OCH-OS on 100G/200G/ -18 dBm +15 dBm

Optical Power Receive 2X150G line side interface,
100G/200G/2X150G Line OSM-4F
side Interface, OSM-4F

Table 22.108 Default Thresholds and Range for Ethernet PM

Threshold Threshold

Monitored Parameter Montype 15-Minute 1-Day

DropEvents * DROP 0 0

Pkts PKT 0 0

BroadcastPkts BCPKT 0 0

MulticastPkts MCPKT 0 0

CRCAlignErrors CRCAE 0 0

UndersizePkts USPKT 0 0

OversizePkts OSPKT 0 0

Fragments FRAG 0 0

Jabbers JABR 0 0

Utilization UTIL 0 0

Note:
* Per RFC 2819, the DropEvents statistic is a count of frames that are dropped due to a lack of resources and does not
include frames dropped due to errors.

Note: When the default threshold level value is set to 0 for a counter montype,
then no automatic message (TCA) is generated for this montype.

76.MTFP50/30, Rev B January 2018 Page 30-1215

22. Retrieve Commands TL1 Command Reference Manual

Command Format
RTRV-PM-{<fac_type>|ALL}:[tid]:[{<fac_aid>|ALL}]:ctag::
[<montype>],[<monlev>],[<locn>],[<dirn>],[<tmper>],[<mondat>] [,<montim>];

Proper System Response when the PM Mode is set to ON, but there are currently no register values:
<header>

M <ctag> COMPLD

Proper System Response when PM mode is set to ON, and there are values:
<header>

M <ctag> COMPLD

"<fac_aid>,<aidtype>:<montype>,<monval>,<vldty>,<locn>,<dirn>,<tmper>,
<mondat>,<montim>"
.
.
"<fac_aid>,<aidtype>:<montype>,<monval>,<vldty>,<locn>,<dirn>,<tmper>,
<mondat>,<montim>"
;

Proper System Response when the PM mode is currently OFF and has remained OFF for the entire collection period
(specified with the SET-PMMODE-{X} command):
<header>

M <ctag> COMPLD

"<fac_aid>,<aidtype>:<montype>,NA,NA,NEND,,< tmper>, <mondat>,<montim>"

.
.
"<fac_aid>,<aidtype>:<montype>,NA,NA,NEND,, <tmper>, <mondat>,<montim>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1216 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.109 RTRV-PM-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID[-ODU4TribPort]
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-21,OMS-20-[1-
16]-1
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]

76.MTFP50/30, Rev B January 2018 Page 30-1217

22. Retrieve Commands TL1 Command Reference Manual

Table 22.109 RTRV-PM-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-PortID[-ODU4TribPort]
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

montype x,x-C,x-F Specifies the type of performance monitoring for the specified
entity.
- x: To be used to specify current value for <montype> x.
- x-C: To be used to specify highest value for gauge <montype>
x. C=Ceiling.
- x-F: To be used to specify lowest value for gauge <montype>
x. F=Floor.

monlev LEV-DIRN. Where: LEV is a value Specifies the level at which the performance monitoring type is
within the range supported for each reported:
montype. DIRN is either UP or DN. - UP means that values equal to or greater than LEV are
reported.
- DN means that values less than LEV are reported.
The system defaults to -60-UP for OPR and OPT montypes.
The system defaults to 1-UP for all counters montypes. This
means that all counter with value=0 (with no accumulation) does
not be shown when default <monlev> value is selected.

locn NEND specifies the location of an event/occurrence in the system:

FEND - Enter NEND to specify a near-end location.
- Enter FEND to specify a far-end location

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies both applicable directions: one type of TDTC
TDTN and one type of TDTN.
RCV - TDTC specifies Transmit direction toward Customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.
- NA indicates Not Applicable (valid in the response only).

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.
The system defaults to 15-minute increments.

mondat MOY-DOM format:(1)MOY = 1 - Specifies the one day index during which PM data is collected.
12.(2)DOM = 1 - 31. The system defaults to the current date.

montim x-y format:(1). x is any number in the Specifies the beginning of the 15-minute performance
range 0-23. (2). y is one of the monitoring collection time period.
following 15-minute increments: 00, The system defaults to the current 15-minute collection time
15, 30, or 45. period.

Page 30-1218 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.109 RTRV-PM-{X} Parameters (Continued)

Parameter Value(s) Definition
aidtype GBEP The access identifier contains one or more simple or compound
FGE parameters that uniquely identifies the selected entity within the
HGE NE.
OC3
OC12
OC48
OC192
OCH
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
OMS
OTU1
OTU2
OTU4
OTUC2
OTUC3
OSC
STM1
STM4
STM16
STM64
TGLAN

monval (1)-60.0 to +60.0, LT+12.0, GT+20.0, This value specifies the value of a performance monitoring
1.9E-2 to 2.3E-11, -40000 to +40000 counter or gauge.
for gauges. (2)0 to - NA specifies that the parameter value is not available at the
18446744073709551615 for counters. time of retrieval.
(3)NA

vldty COMPL Indicates whether or not a performance monitoring value is valid

NA - COMPL indicates that performance monitoring data are
PRTL accumulated.
- NA indicates that performance monitoring data are not
available.
- PRTL indicates that performance monitoring data are
accumulated during a partial time period.

Example 1
RTRV-PM-OTU2::OTU2-20-1-2:ctag::,,,,,,;

Possible System Response

CORIANT 14-11-04 14:49:47
M ctag COMPLD
"OTU2-20-1-2,OTU2:LOSS,NA,NA,NEND,TDTN,15-MIN,11-04,14-45"
"OTU2-20-1-2,OTU2:BE-FEC,NA,NA,NEND,TDTN,15-MIN,11-04,14-45"
"OTU2-20-1-2,OTU2:UBE-FEC,NA,NA,NEND,TDTN,15-MIN,11-04,14-45"
"OTU2-20-1-2,OTU2:CV-OTU,NA,NA,NEND,TDTN,15-MIN,11-04,14-45"
"OTU2-20-1-2,OTU2:ES-OTU,NA,NA,NEND,TDTN,15-MIN,11-04,14-45"

76.MTFP50/30, Rev B January 2018 Page 30-1219

22. Retrieve Commands TL1 Command Reference Manual

"OTU2-20-1-2,OTU2:SES-OTU,NA,NA,NEND,TDTN,15-MIN,11-04,14-45"
"OTU2-20-1-2,OTU2:UAS-OTU,NA,NA,NEND,TDTN,15-MIN,11-04,14-45"
;

Example 2
RTRV-PM-OTUC2::OTUC2-20-1-1:ctag::,-100-UP;

Possible System Response

CORIANT 17-05-12 11:47:18
M ctag COMPLD
"OTUC2-20-1-1,OTUC2:CV-OTU,0,PRTL,NEND,TDTC,15-MIN,05-12,11-45"
"OTUC2-20-1-1,OTUC2:ES-OTU,0,PRTL,NEND,TDTC,15-MIN,05-12,11-45"
"OTUC2-20-1-1,OTUC2:SES-OTU,0,PRTL,NEND,TDTC,15-MIN,05-12,11-45"
"OTUC2-20-1-1,OTUC2:UAS-OTU,1,PRTL,NEND,TDTC,15-MIN,05-12,11-45"
"OTUC2-20-1-1,OTUC2:CV-OTU-FE,0,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
"OTUC2-20-1-1,OTUC2:ES-OTU-FE,0,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
"OTUC2-20-1-1,OTUC2:SES-OTU-FE,0,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
"OTUC2-20-1-1,OTUC2:UAS-OTU-FE,1,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
;

Example 3
RTRV-PM-ODU4::ODU4-20-1-1:ctag::,-100-UP,FEND;

Possible System Response

CORIANT 17-05-12 11:47:18
M ctag COMPLD
"ODU4-20-1-1,ODU4:EB-ODU-FE,0,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
"ODU4-20-1-1,ODU4:ES-ODU-FE,0,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
"ODU4-20-1-1,ODU4:SES-ODU-FE,0,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
"ODU4-20-1-1,ODU4:UAS-ODU-FE,1,PRTL,FEND,TDTC,15-MIN,05-12,11-45"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
INH-PMREPT-{X}
RTRV-PMMODE-{X}
SET-PMMODE-{X}

Page 30-1220 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PMDAY

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PMDAY command instructs the network element to retrieve the start time of a NE's daily PM data
collection period. The current start time of the daily data collection period may be set by using the SET-PMDAY
command.

Command Format
RTRV-PMDAY:[tid]::ctag;

Proper System Response:

<header>
M <ctag> COMPLD
^^^"<daystart>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.110 RTRV-PMDAY Parameters

Parameter Value(s) Definition
daystart [0-23] Indicates the hour of starting collecting 1-DAY monitoring
parameters.

Example
RTRV-PMDAY:::CTG01;

Possible System Response

CORIANT1 02-02-02 03:20:21

M CTG01 COMPLD

"12"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
SET-PMDAY

76.MTFP50/30, Rev B January 2018 Page 30-1221

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PMFILESCHED-{X}

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PMFILESCHED-{X} command instructs the network element to retrieve scheduled ODUk or STS
historical PM file transfer for the specified entity. Scheduled file transfer are provisioned using SCHED-PMFILE-{x}
command.
{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): OCH(for OCH-L), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, STS1,
STS3C, STS12C, STS48C, STS192C.

Restrictions and Exceptions

• Current PM data can not be retrieved using this command, only historical PM data.

• The Facility AID {fac_aid} must always correspond to the Facility type {fac_type}.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier
(for example, {fac_type}).

Command Format
RTRV-PMFILESCHED-<fac_type>:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Response

If at least one schedule exists:
<header>

M <ctag> COMPLD

^^^"<{fac_aid}>,<fac_type>:<ftpserver_aid>,<tmper>,<inhmode>"*<cr><lf>

Proper System Response

If no schedule exists
<header>
M <ctag> COMPLD

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1222 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.111 RTRV-PMFILESCHED-{X} Parameters

Parameter Value(s) Definition
fac_aid ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

fac_type ODUF Specifies the facility type.

ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
STS1
STS3C
STS12C
STS48C
STS192C

76.MTFP50/30, Rev B January 2018 Page 30-1223

22. Retrieve Commands TL1 Command Reference Manual

Table 22.111 RTRV-PMFILESCHED-{X} Parameters (Continued)

Parameter Value(s) Definition
ftpserver_aid FTPSERVER-1 Specifies the FTP server.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- 15-MIN to specify 15-minute increments.
- 1-DAY to specify daily increments.
The system defaults to 15-minute increments.

inhmode ALW Indicates if a report is allowed or inhibited:

INH - ALW indicates it is allowed.
- INH indicates it is inhibited.

Example 1
RTRV-PMFILESCHED-ODU1::ODU1-20-1-1:CTG01;

Possible System Response

CORIANT1 02-02-02 03:20:21
M CTG01 COMPLD

^^^"ODU1-20-1-1,ODU1:FTPSERVER-1,15-MIN,ALW"

Example 2
RTRV-PMFILESCHED-ODU1::ALL:CTG01;

Possible System Response

CORIANT1 02-02-02 03:20:21
M CTG01 COMPLD

^^^"ODU1-20-1-1,ODU1:FTPSERVER-1,15-MIN,ALW"

^^^"ODU1-20-2-2,ODU1:FTPSERVER-1,15-MIN,ALW"

^^^"ODU1-20-3-1,ODU1:FTPSERVER-1,15-MIN,ALW"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-FTPSERVER
ED-FTPSERVER
RTRV-FTPSERVER
SCHED-PMFILE-{x}
INH-PMFILE-{x}
ALW-PMFILE-{x}

Page 30-1224 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PMMODE-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

• Added far-end PM support for OSM-4C, OSM-4F.

Description
The RTRV-PMMODE-{X} command instructs the network element to retrieve the Performance Monitoring (PM)
status of the selected facility entity.

The PM mode of this entity is set with the SET-PMMODE-{X} command. Refer to the RTRV-PM-{X} command for
a list of all supported PM.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): GBEP, TGLAN, FGE, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L,
OCH-P, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4,
OTUC2, OTUC3, OMS, OSC, STS1, STS3C, STS12C, STS48C, STS192C.

Restrictions and Exceptions

• The Facility AID must always correspond to the Facility type.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• The parameter <locn> can be either NEND (near-end) or FEND (far-end). The command does not
support both near-end and far-end at the same time.

Command Format
RTRV-PMMODE-<fac_type>:[tid]:{<fac_aid>|ALL}:ctag::[<locn>];

Proper System Response:

<header>
M <ctag> COMPLD
"<fac_aid>:<locn>,<modetype>,<pmstate>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1225

22. Retrieve Commands TL1 Command Reference Manual

Table 22.112 RTRV-PMMODE-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1

Page 30-1226 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.112 RTRV-PMMODE-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) OTU1-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

locn NEND specifies the location of an event/occurrence in the system:

FEND - Enter NEND to specify a near-end location.
- Enter FEND to specify a far-end location
Default is NEND.

modetype ALL Indicates the type of performance monitoring control attribute:

- ALL indicates all PM montypes for the specified AID.

pmstate ON Indicates wether or not PM data is being collected:

OFF - ON indicates PM data is collected.
- OFF indicates PM data is not collected.

Example
RTRV-PMMODE-OTU2::ALL:ctag::;

Possible System Response

CORIANT 14-11-05 16:21:59
M ctag COMPLD
"OTU2-20-1-2:NEND,ALL,OFF"
"OTU2-20-1-3:NEND,ALL,OFF"
"OTU2-20-1-4:NEND,ALL,OFF"
"OTU2-20-1-5:NEND,ALL,OFF"
"OTU2-20-1-6:NEND,ALL,OFF"
"OTU2-20-1-7:NEND,ALL,OFF"
"OTU2-20-1-8:NEND,ALL,OFF"
"OTU2-20-1-12:NEND,ALL,OFF"
"OTU2-20-1-15:NEND,ALL,OFF"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-1227

22. Retrieve Commands TL1 Command Reference Manual

Related Commands
INH-PMREPT-{X}
RTRV-PM-{X}
SET-PMMODE-{X}

Page 30-1228 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PMPF-{X}

Command Changes Since Previous Feature Package

• Added support of ODUk mux into ODUC3 on OSM-4F.

Description
The RTRV-PMPF command instructs the network element (NE) to display the threshold values of the specified
performance monitoring profile. These PM profiles are used on SONET or ODUk path facilities that, when exceeded,
triggers an automatic message (TCA).
• Facilities (fac_type): ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, STS1, STS3C, STS12C,
STS48C, STS192C.

Restrictions and Exceptions

• When no MONTYPE is specified, command response will include values for all MONTYPES supported
by the facility.

• When "ALL" is used as second modifier, the AID is optional and defaults to ALL.

• When second modified is different than "ALL", then an AID (including ALL) must be specified.

• The Facility AID must always correspond to the Facility type.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-PMPF-
{<fac_type>|ALL}:[tid]:[<pmpf_aid>|ALL]:ctag::[<montype>],[<dirn>][,<tmper>];

Proper System Responses

<header>
M <ctag> COMPLD
^^^"<pmpf_aid>,<aidtype>:<montype>,<locn>,<dirn>,<thlev>,<tmper>"* <cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.113 RTRV-PMPF-{X} Parameters

Parameter Value(s) Definition
pmpf_aid PMPF-[99,1-20,0] EntityID-PMPFID

montype x Specifies the type of performance monitoring for the specified

entity.
- x: To be used to specify current threshold value for <montype>
x.

76.MTFP50/30, Rev B January 2018 Page 30-1229

22. Retrieve Commands TL1 Command Reference Manual

Table 22.113 RTRV-PMPF-{X} Parameters (Continued)

Parameter Value(s) Definition
dirn BTH Specifies the direction of an event/occurrence in the system:
TDTC - BTH specifies both applicable directions: one type of TDTC
TDTN and one type of TDTN.
RCV - TDTC specifies Transmit direction toward customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.
- NA specifies the direction is not applicable.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

aidtype ODUF This is the type of the Access Identifier.

ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4

thlev (1)0-9223372036854775807 (2)0, Specifies the desired threshold value of the selected
0.00001 to 15 (3)DFLT performance monitoring parameter.

locn-rept NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end location.
Only NEND is supported.

Example
RTRV-PMPF-STS1::PMPF-1:AM0011;

RTRV-PMPF-ODU1::PMPF-1:AM0011;

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0011 COMPLD

"PMPF-1,ODU1:EB-ODU,NEND,TRMT,735,15-MIN"
"PMPF-1,ODU1:ES-ODU,NEND,TRMT,25,15-MIN"
"PMPF-1,ODU1:SES-ODU,NEND,TRMT,4,15-MIN"
"PMPF-1,ODU1:UAS-ODU,NEND,TRMT,10,15-MIN"
"PMPF-1,ODU1:DELAY-ODU-LT,NEND,TRMT,0,15-MIN"
"PMPF-1,ODU1:DELAY-ODU-HT,NEND,TRMT,2147483647,15-MIN"
"PMPF-1,ODU1:EB-ODU,NEND,TRMT,70575,1-DAY"
"PMPF-1,ODU1:ES-ODU,NEND,TRMT,250,1-DAY"
"PMPF-1,ODU1:SES-ODU,NEND,TRMT,40,1-DAY"
"PMPF-1,ODU1:UAS-ODU,NEND,TRMT,10,1-DAY"
"PMPF-1,ODU1:DELAY-ODU-LT,NEND,TRMT,0,1-DAY"
"PMPF-1,ODU1:DELAY-ODU-HT,NEND,TRMT,2147483647,1-DAY"
"PMPF-1,ODU1:EB-ODU,NEND,RCV,735,15-MIN"
"PMPF-1,ODU1:ES-ODU,NEND,RCV,25,15-MIN"
"PMPF-1,ODU1:SES-ODU,NEND,RCV,4,15-MIN"
"PMPF-1,ODU1:UAS-ODU,NEND,RCV,10,15-MIN"

Page 30-1230 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

"PMPF-1,ODU1:DELAY-ODU-LT,NEND,RCV,0,15-MIN"
"PMPF-1,ODU1:DELAY-ODU-HT,NEND,RCV,2147483647,15-MIN"
"PMPF-1,ODU1:EB-ODU,NEND,RCV,70575,1-DAY"
"PMPF-1,ODU1:ES-ODU,NEND,RCV,250,1-DAY"
"PMPF-1,ODU1:SES-ODU,NEND,RCV,40,1-DAY"
"PMPF-1,ODU1:UAS-ODU,NEND,RCV,10,1-DAY"
"PMPF-1,ODU1:DELAY-ODU-LT,NEND,RCV,0,1-DAY"
"PMPF-1,ODU1:DELAY-ODU-HT,NEND,RCV,2147483647,1-DAY"
;

"PMPF-1,STS1:CVP,NEND,TDTC,15,15-MIN"
"PMPF-1,STS1:ESP,NEND,TDTC,12,15-MIN"
"PMPF-1,STS1:SESP,NEND,TDTC,3,15-MIN"
"PMPF-1,STS1:FCP,NEND,TDTC,1,15-MIN"
"PMPF-1,STS1:UASP,NEND,TDTC,10,15-MIN"
"PMPF-1,STS1:PJCSPDET,NEND,TDTC,0,15-MIN"
"PMPF-1,STS1:PJCSPGEN,NEND,TDTC,0,15-MIN"
"PMPF-1,STS1:PJCDIFFP,NEND,TDTC,0,15-MIN"
"PMPF-1,STS1:CVP,NEND,TDTC,125,1-DAY"
"PMPF-1,STS1:ESP,NEND,TDTC,100,1-DAY"
"PMPF-1,STS1:SESP,NEND,TDTC,7,1-DAY"
"PMPF-1,STS1:FCP,NEND,TDTC,1,1-DAY"
"PMPF-1,STS1:UASP,NEND,TDTC,10,1-DAY"
"PMPF-1,STS1:PJCSPDET,NEND,TDTC,0,1-DAY"
"PMPF-1,STS1:PJCSPGEN,NEND,TDTC,0,1-DAY"
"PMPF-1,STS1:PJCDIFFP,NEND,TDTC,0,1-DAY"
"PMPF-1,STS1:CVP,NEND,TDTN,15,15-MIN"
"PMPF-1,STS1:ESP,NEND,TDTN,12,15-MIN"
"PMPF-1,STS1:SESP,NEND,TDTN,3,15-MIN"
"PMPF-1,STS1:FCP,NEND,TDTN,1,15-MIN"
"PMPF-1,STS1:UASP,NEND,TDTN,10,15-MIN"
"PMPF-1,STS1:PJCSPDET,NEND,TDTN,0,15-MIN"
"PMPF-1,STS1:PGCSPGEN,NEND,TDTN,0,15-MIN"
"PMPF-1,STS1:PJCDIFFP,NEND,TDTN,0,15-MIN"
"PMPF-1,STS1:CVP,NEND,TDTN,125,1-DAY"
"PMPF-1,STS1:ESP,NEND,TDTN,100,1-DAY"
"PMPF-1,STS1:SESP,NEND,TDTN,7,1-DAY"
"PMPF-1,STS1:FCP,NEND,TDTN,1,1-DAY"
"PMPF-1,STS1:UASP,NEND,TDTN,10,1-DAY"
"PMPF-1,STS1:PJCSPDET,NEND,TDTN,0,1-DAY"
"PMPF-1,STS1:PGCSPGEN,NEND,TDTN,0,1-DAY"
"PMPF-1,STS1:PJCDIFFP,NEND,TDTN,0,1-DAY"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-PMPF
RTRV-PMPFUSE

76.MTFP50/30, Rev B January 2018 Page 30-1231

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PMPFUSE-{X}

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PMPFUSE command instructs the network element (NE) to display whether the performance monitoring
profile is in use by a facility.
• Facilities (fac_type): ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4.

Restrictions and Exceptions

• When "ALL" is used as second modifier, the AID is optional and defaults to ALL.

• When second modified is different than "ALL", then an AID (including ALL) must be specified.

• The Facility AID must always correspond to the Facility type.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-PMPFUSE-{<fac_type>|ALL}:[tid]:[{<pmpf_aid>|ALL}]:ctag::[<dirn>];

Proper System Responses

<header>
M <ctag> COMPLD
^^^"<pmpf_aid>,<aidtype>:<dirn>,<in_use>"* <cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.114 RTRV-PMPFUSE-{X} Parameters

Parameter Value(s) Definition
pmpf_aid PMPF-[99,1-20,0] EntityID-PMPFID

dirn TDTC Specifies the direction of an event/occurrence in the system:

TDTN - TDTC specifies Transmit direction toward customer.
RCV - TDTN specifies Transmit direction toward DWDM network.
TRMT - RCV specifies Receive direction.
NA - TRMT specifies Transmit direction.
- NA specifies the direction is not applicable.

aidtype ODUF This is the type of the Access Identifier

ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4

Page 30-1232 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.114 RTRV-PMPFUSE-{X} Parameters (Continued)

Parameter Value(s) Definition
in_use YES Specifies whether the profile is in use for the given entity and
NO direction:
- YES specifies in use.
- NO specifies not in use.

Example
RTRV-PMPFUSE-ODU1::PMPF-1:AM0011;

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0011 COMPLD

"PMPF-1,ODU1:RCV,NO"
"PMPF-1,ODU1:TRMT,NO"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-PMPF
RTRV-PMPF

76.MTFP50/30, Rev B January 2018 Page 30-1233

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PMSCHED-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PMSCHED-{X} command instructs the network element to retrieve the Performance Monitoring
Schedule of the selected equipment or facility entity.

The PM Schedule of this entity was set with the SCHED-PMREPT-{X} command.

{X} specifies the equipment type or facility type among the following AIDs:
• Facilities (fac_type): GBEP, FGE, HGE, OC3, OC12, OC48, OC192, OCH (for OCH-P, OCH-OS),
OTU1, OTU2, OTU4, OTUC2, OTUC3, TGLAN.

Restrictions and Exceptions

• The facility AID must always correspond to the facility type.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-PMSCHED-{<fac_type>|ALL}:[tid]:{<fac_aid>|ALL}:ctag::[<locn>][,<tmper>];

Proper System Response

If at least one schedule exists:
<header>
M <ctag> COMPLD
^^^"<fac_aid>[,<aidtype>]:<reptinvl>,<date>,<time>,[<numinvl>],
[<montype>],[<monlev>],<locn>,<dirn>,[<tmper>],[<tmofst>][,<inhmode>]"*<cr><lf>

Proper System Response

If a schedule does not exist
<header>
M <ctag> COMPLD

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1234 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.115 RTRV-PMSCHED-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
TGLAN-20-[1-16]-[1-40]

locn NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end location. Only NEND is
supported.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

aidtype GBEP Specifies the type of the Access Identifier

HGE
OC3
OC12
OC48
OC192
OCH
OTU1
OTU2
OTU4
OTUC2
OTUC3
OMS
OSC
TGLAN

reptinvl Enter the appropriate interval in the X- Specifies the time interval between scheduled PM reports.
UNIT format:(1)UNIT = DAY, HR or Example:
MIN. (2)X = 1 - 31 if UNIT = DAY. (3)X - 1-DAY indicates a PM report every day.
= 1 - 24 if UNIT = HR. (4)X = 15 - 480 - 12-HR indicates a PM report every 12 hours.
(specified in multiples of 15) if UNIT = - 30-MIN indicates a PM report every 30 minutes.
MIN.

date MOY-DOM format:(1)MOY = 1 - Specifies the date of the next scheduled PM report:
12.(2)DOM = 1 - 31. - MOY identifies the month of the year.
- DOM identifies the day of the month.

time Enter HOD-MOH format:(1)HOD = 0 - Indicates the time of day in which the schedule will occur:
23 (2)MOH = 0 - 59 - HOD identifies the hour of the day.
- MOH identifies the minute of the hour.

76.MTFP50/30, Rev B January 2018 Page 30-1235

22. Retrieve Commands TL1 Command Reference Manual

Table 22.115 RTRV-PMSCHED-{X} Parameters (Continued)

Parameter Value(s) Definition
numinvl Enter the appropriate interval in the X- Specifies the number of intervals during which a report will
UNIT format:(1)UNIT = DAY, HR or occur:
MIN. (2)X = 1 - 31 if UNIT = DAY. (3)X - If this field is null, the report will run continuously at its
= 1 - 24 if UNIT = HR. (4)X = 15 - 480 scheduled time.
(specified in multiples of 15) if UNIT =
MIN.

montype x,x-C,x-F Specifies the type of performance monitoring for the specified
entity.
- x: To be used to specify current value for <montype> x.
- x-C: To be used to specify highest value for gauge <montype>
x. C=Ceiling.
- x-F: To be used to specify lowest value for gauge <montype>
x. F=Floor.

monlev LEV-DIRN. Where: LEV is a value Specifies the level at which the performance monitoring type is
within the range supported for each reported:
montype. DIRN is either UP or DN. - UP means that values equal to or greater than LEV are
reported.
- DN means that values less than LEV are reported.
The system defaults to 50-UP for LBC montype.
The system defaults to 2-UP for LT montype.
The system defaults to -34-UP for OPR and OPT montypes.
The system defaults to 1-UP for all counters montypes.
This means that all counters with value=0 (such as no
accumulation) does not be shown when default <monlev> value
is selected.

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - Enter BTH for Both directions.
TDTN - Enter TDTC for Transmit direction toward customer.
NA - Enter TDTN for Transmit direction toward network.
Note: If a value is specified for EQPT or for a montype that does
not support that direction, the specified direction is ignored.

tmofst DAY-HR-MIN : (1) DAY is any number Specifies the time offset from the end of the last complete
in the range 0-99. (2)HR is any accumulation time period to the beginning of the accumulation
number in the range 0-23. (3) MIN is time period specified in <tmper>.
any number in the range 0-59. <tmofst> should be an integral multiple of <tmper>.
<tmofst> is limited to 7 days for 1-DAY periods and to 8 hours
for 15-MIN periods.
A null value for <tmofst> defaults to 0-0-0.

inhmode ALW Indicates if a backup schedule is allowed or inhibited:

INH - ALW indicates it is allowed.
- INH indicates it is inhibited.
When no scheduled backup exist, default mode is INH.

lcon NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end location. Only NEND is
supported.

Example
RTRV-PMSCHED-OTU2::OTU2-2-2-3:CTG01;

Page 30-1236 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT 14-10-20 15:48:05

M CTG01 COMPLD

"OTU2-2-2-3,OTU2:8-HR,10-21,6-15,,ES-OTU,150-UP,NEND,BTH,15-MIN,0-0-0,ALW"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-PMREPT-{X}
INH-PMREPT-{X}
SCHED-PMREPT-{X}

76.MTFP50/30, Rev B January 2018 Page 30-1237

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PPG-ODUk

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PPG-ODUk (Retrieve ODUk Path Protection Group) command provides for retrieving information about
an entire path protection group.

Restrictions and Exceptions

• Either "protected AID", "protected AID,protecting AID", "ALL", "ALL,ALL", "protected AID,ALL", or
"ALL,protecting AID" can be used for specifying the facilities involved in the protection group.

Command Format
RTRV-PPG-<fac_type>:[tid]:{<protectedId>|ALL},{<protectingId>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

^^^"<protectedId>,<protectingId>::RVRTV=<rvrtv>,WTR=<wtr>,HOLDOFFPROT=<HoldOffPr
ot>,BIDIR_SWITCH=<Bidir_Switch>,Current_Request=<Current_Request>[,NPOWNER=<NpOw
ner>]:<pst>"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1238 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.116 RTRV-PPG-ODUk Parameters

Parameter Value(s) Definition
protectedId ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-Num]|[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

76.MTFP50/30, Rev B January 2018 Page 30-1239

22. Retrieve Commands TL1 Command Reference Manual

Table 22.116 RTRV-PPG-ODUk Parameters (Continued)

Parameter Value(s) Definition
protectingId ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-Num]|[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive.

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
switch’s back immediately.

HoldOffProt 0,60-1000 in increments of 5 msec If no additional hold-off time for a protection switch is desired,
then the value is set to zero. Hold off timer is typically employed
when supporting nested protection domains and a hold off time
is required to allow another protection domain to execute a
switch before doing so on the subject PPG.

Page 30-1240 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.116 RTRV-PPG-ODUk Parameters (Continued)

Parameter Value(s) Definition
Current_Requ LO-P Indicates the higher priority request between local request and
est FS-P remote request for a protection group switch.
FS-W LO: Lockout of Protection
SF-W FS: Forced Switch
SF-P SF: Signal Fail
SD-W SD: Signal Degrade
SD-P MS: Manual Switch
MS-W WTR: Wait to Restore
MS-P EXER: Exercise
WTR DNR: Do Not Revert
EXER-W NR: No Request
EXER-P -P: Protection path
-W: Working path
DNR -R: Remote request
NR
LO-R
FS-P-R
FS-W-R
SF-W-R
SF-P-R
SD-W-R
SD-P-R
MS-W-R
MS-P-R
WTR-R
EXER-W-R
EXER-P-R
DNR-R
NR-R

NpOwner 3 Specifies which network partition owns this entity.

pst IS-NR Indicates the primary state and primary state

qualifier of the protection group.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

bidir_switch ENABLED Specifies if the SNC protection is unidirectional or bidirectional

DISABLED switching.
- DISABLED: unidirectional SNC
- ENABLED: bidrectional SNC

Example
RTRV-PPG-ODU1:CORIANT1:ODU1-20-6-1-25,ODU1-20-7-2-5:AM0075;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0075 COMPLD

"ODU1-20-6-1-25,ODU1-20-7-2-
5::RVRTV=YES,WTR=600,HOLDOFFPROT=60,BIDIR_SWITCH=DISABLED,CURRENT_REQUEST=NR:IS-
NR"

76.MTFP50/30, Rev B January 2018 Page 30-1241

22. Retrieve Commands TL1 Command Reference Manual

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-PPG-ODUk

Page 30-1242 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PPG-STSn

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PPG-STSn (Retrieve STSn Path Protection Group) command provides for retrieving information about
an entire path protection group.

Restrictions and Exceptions

• Either "protected AID", "protected AID,protecting AID", "ALL", "ALL,ALL", "protected AID,ALL", or
"ALL,protecting AID" can be used for specifying the facilities involved in the protection group.

• This command is used to retrieve information about an entire path protection group for facility that
configured with Flexiable Path Protecton (SNCP).

• This command is used to retrieve information about an entire path protection group for the STSn
unprotect to protect conversion application with 1WAY STSn XC to 1WAYPR STSn XC or 2WAY STSn
XC to 2WAYPR STSn XC which creates the corresponding PPG automatically.

• For 1+1 APS protection or 1+1 EPG (Equipment Protection Group for the Sonet/SDH to OTN adaption)
this command not valid for the STSn involved in the cross connection, there is no STSn PPG for 1+1
APS or 1+1 EPG.

Command Format
RTRV-PPG-<fac_type>:[tid]:{<protectedId>|ALL},{<protectingId>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

^^^"<protectedId>,<protectingId>::RVRTV=<rvrtv>,WTR=<wtr>[,NPOWNER=<NpOwner>][,H
OLDOFFPROT=<HoldOffProt>]:<pst>"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1243

22. Retrieve Commands TL1 Command Reference Manual

Table 22.117 RTRV-PPG-STSn (for STS1/STS3C/STS12C/STS48C) Parameters

Parameter Value(s) Definition
protectedId STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

protectingId STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-{PortID|Vport-n}-StsID

20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

rvrtv YES Revertive state:

NO - YES: revertive
- NO: not revertive.

wtr [0-3600] Wait To Restore. Valid values: 0-3600 seconds. A value of zero
switch’s back immediately.

NpOwner 3 Specifies which network partition ownes this entity.

HoldOffProt 0,60-1000 in increments of 5 msec If no additional hold-off time for a protection switch is desired,
then the value is set to zero. Hold off timer is typically employed
when supporting nested protection domains and a hold off time
is required to allow another protection domain to execute a
switch before doing so on the subject PPG.

pst IS-NR Indicates the primary state and primary state qualifier of the
protection group.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

Example
RTRV-PPG-STS1:CORIANT1:STS1-20-6-1-25:AM0075;

Page 30-1244 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0075 COMPLD

"STS1-20-6-1-25,STS1-2-7-2-5:RVRTV=YES,WTR=75:IS-NR"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-PPG-STSn

76.MTFP50/30, Rev B January 2018 Page 30-1245

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PPP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PPP command enables the customer to view the attributes of a PPP session over the DCC of an OCn
facility.

Restrictions and Exceptions

• When ALL is used as an AID, information for all PPP entities that matches the specified filtering
parameter(s) is retrieved.

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

Command Format
RTRV-
PPP:[tid]:{<ppp_aid>|ALL}:ctag:::[ALMPF=<almProfile>][:<editablePrimaryState>][,
<secondaryState>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
"<ppp_aid>::PPPPF=<ppppf_aid>,ALMPF=<almProfile>,NPOWNER=<NpOwner>:<pst>,[<sst>]
"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.118 RTRV-PPP Parameters

Parameter Value(s) Definition
ppp_aid PPPL-[20]-[1-16]-[1-30], PPPL-[20]-[1- EntityID-ShelfID-SlotID-PortID[-Index]
16]-99-[1-30]
PPPMS-[20]-[1-16]-[1-30], PPPMS-
[20]-[1-16]-99-[1-30]
PPPRS-[20]-[1-16]-[1-30], PPPRS-
[20]-[1-16]-99-[1-30]
PPPS-[20]-[1-16]-[1-30], PPPS-[20]-
[1-16]-99-[1-30]

almProfile 0-20, 99 Specifies the alarm profile to use for this entity.

editablePrimar IS Indicates the primary state:

yState OOS - IS: In-Service
- OOS: Out-of-Service

ppppf_aid PPPPF-[99,1-10] Specifies the access identifier of the PPP protocol profile.

Page 30-1246 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.118 RTRV-PPP Parameters (Continued)

Parameter Value(s) Definition
NpOwner 1 Specifies which network partition ownes this entity.
2

pst IS-NR Indicates the primary state and primary state qualifier:
IS-ANR - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
- ANR: abnormal
- AU: autonomous
- MA: management
- AUMA: autonomous and management

sst FAF Indicates the secondary state

SGEO - FAF for Facility failure.
INCOMP - SGEO for Supporting Entity Outage - used to indicate that the
NALMNR OCn associated with this entity has failed
NALMCD - INCOMP - incomplete configuration - used to indicate that this
entity has not been assigned to a TL
- NALMNR for not alarmed not ready
- NALMCD for not alarmed count down

secondaryStat FAF Indicates the secondary state

e/sst SGEO - FAF for Facility failure.
INCOMP - SGEO for Supporting Entity Outage - used to indicate that the
NALMNR OCn associated with this entity has failed
NALMCD - INCOMP - incomplete configuration - used to indicate that this
entity has not been assigned to a TL
- NALMNR for not alarmed not ready
- NALMCD for not alarmed count down

Example
RTRV-PPP:NE01:PPPL-20-3-6:AM0074;

Possible System Response

^^^NEO1 06-09-15 02:08:15
M AM0074 COMPLD
"PPPL-20-3-6::PPPPF=PPPPF-1,ALMPF=99,NPOWNER=2:IS-NR,"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-PPP
ED-PPP
ENT-PPP

76.MTFP50/30, Rev B January 2018 Page 30-1247

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PPPPF

Command Changes Since Previous Feature Package

• None.

Description
Use the RTRV-PPPPF command review the attributes of the PPP profile. PPP profiles are used to specify the data
link layer attributes of a PPP session over GCC of an OTN facility.

Restrictions
• When ALL is used as an AID, information for all PPP profile entities is retrieved.

Command Format
RTRV-PPPPF:[tid]:{<ppppf_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<ppppf_aid>::PFNAME=<pfname>,MRU=<maximum_receive_units>,FCS=<fcs>,RESTARTMR
=<restart_timer>,MAXFAILCNT=<max_failure_count>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.119 RTRV-PPPPF Parameters

Parameter Value(s) Definition
ppppf_aid PPPPF-[99,1-10] EntityID-PPPPFID

pfname 0 to 31 alphanumeric characters. Specifies the customer entered additional field to lable the PPP
profile.
Refer to section 2 for the applicable characters.

maximum_rec 576-1500 octets Specifies the maximum number of octets in the Information and
eive_units Padding fields.

fcs 16 Specifies whether the frame check sequence is a 16-bit or 32-bit

32 value.

restart_timer [1-10] Specifies the restart timer of the PPP protocol profile.
Unit: seconds

max_failure_c [2-10] Specifies the maximum failure value of the PPP protocol profile.
ount

Example
RTRV-PPPPF:NE01:PPPPF-1:AM0011;

Page 30-1248 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

^^^NE01 06-09-15 02:08:15
M AM0011 COMPLD
^^^"PPPPF-1::PFNAME=\"Default
Profile\",MRU=1500,FCS=16,RESTARTMR=3,MAXFAILCNT=5"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-PPPPF

76.MTFP50/30, Rev B January 2018 Page 30-1249

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PROXY

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PROXY command instructs the mTera UTP to retrieve the proxy mode of the NE.

Command Format
RTRV-PROXY:[tid]::ctag;

Proper System Responses

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::PROXYMODE=<ProxyMode>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.120 RTRV-PROXY Parameters

Parameter Value(s) Definition
ProxyMode DISABLED Specifies the Applications proxy mode on the NE.
CLIENT

Example
The following example retrieves the Proxy Mode of the NE:

RTRV-PROXY:CORIANT1::KTRP01;

Possible System Response

CORIANT1 06-05-15 02:08:15
M KTRP01 COMPLD
^^^"::PROXYMODE=DISABLED"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-PROXY

Page 30-1250 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PTHTRC-OCH

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PTHTRC-OCH command instructs the network element (NE) to retrieve the OTU trace information for
the specified OCH termination. This command is used to retrieve the following attributes:

• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies to facilities <och_aid> = OCH-P in mTera.

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related OTU Trace information for all OCH-P facilities within the
NE.

Command Format
RTRV-PTHTRC-OCH:[tid]:{ALL|<och_aid>}:ctag::[<msgtype>];

Proper System Response

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<och_aid>::[RXSAPI=<rxSAPI>][,RXDAPI=<rxDAPI>][,RXOPER=<rxOPER>][,EXPSAPI=<E
xpSAPI>][,EXPOPER=<ExpOperator>][,TXSAPI=<txSAPI>][,EXPDAPI=<ExpDAPI>][,TXDAPI=<
txDAPI>][,TXOPER=<TxOperator>][,EXPOTUTRC=<OTUExpTrc>][,INCOTUTRC=<otu_inctrc>][
,OTUTRC=<OTUTrc>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.121 RTRV-PTHTRC-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-P-20-[1-16]-[1-40] EntityID-Type-ShelfID-SlotID-PortID

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

76.MTFP50/30, Rev B January 2018 Page 30-1251

22. Retrieve Commands TL1 Command Reference Manual

Table 22.121 RTRV-PTHTRC-OCH Parameters (Continued)

Parameter Value(s) Definition
rxSAPI One to 15 alphanumeric characters Identifies the value of the received SAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Identifies the value of the received DAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Identifies the value of the received Operator
Specific trace value with up to 32 alphanumeric
characters.Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

OTUExpTrc One to 28 alphanumeric characters Specifies the expected trace identification.

All printable characters are allowed except for the semi-colon
and double quote. A value of \"\" means that there is no Trail
Trace Id expected.

otu_inctrc One to 28 alphanumeric characters Specifies the received trace identification.

All printable characters are allowed except for the semi-colon
and double quote. A value of \"\" means that there is no Trail
Trace Id received.

OTUTrc One to 28 alphanumeric characters Specifies the transmitted trace identification.

All printable characters are allowed except for the semi-colon
and double quote. A value of \"\" means that there is no Trail
Trace Id sent.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-OCH:CORIANT1:OCH-P-20-1-1:AM0072::EXPTRC;

Possible System Response

CORIANT1 02-04-16 02:08:15
M AM0072 COMPLD
"OCH-P-20-1-1::EXPOTUTRC=\"TRACE22\"";

Page 30-1252 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OCH

76.MTFP50/30, Rev B January 2018 Page 30-1253

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PTHTRC-ODUF

Command Changes Since Previous Feature Package

• Added support of ODUF mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PTHTRC-ODUF command instructs the network element (NE) to retrieve the ODU trace information for
the specified ODUF entity. This command is used to retrieve the following attributes:
• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies to ODUF facilities for which the supporting module are OSM-2C, OSM-2S, OSM-
4C, OSM-4F, OSM-4S, OSM-5C.

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related ODU Trace information for all ODUF facilities supported
by all OSM20 / OSM-2C / OSM-2S / OSM-4C / OSM-4F / OSM-4S / OSM-5C modules within the NE.

Command Format
RTRV-PTHTRC-ODUF:[tid]:{ALL|<oduf_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<oduf_aid>::[RXSAPI=<rxSAPI>][,RXDAPI=<rxDAPI>][,RXOPER=<rxOPER>][,EXPSAPI=<
ExpSAPI>][,TXSAPI=<txSAPI>][,EXPDAPI=<ExpDAPI>][,TXDAPI=<txDAPI>][,EXPOPER=<ExpO
perator>][,TXOPER=<txOperator>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.122 RTRV-PTHTRC-ODUF Parameters

Parameter Value(s) Definition
oduf_aid ODUF-20-[1-16]-[1-40]-[1-80], ODUF- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-20]-[B,C][1-80]-[1-32], ODU4TribPort][-SupportODU ODUTribPort]-TribID
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]

Page 30-1254 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.122 RTRV-PTHTRC-ODUF Parameters (Continued)

Parameter Value(s) Definition
msgtype EXPTRC This specifies the type of trace message to be retrieved.
INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-ODUF:CORIANT:ODUF-20-2-2-1:AM0072::INCTR;

Possible System Response

CORIANT1 10-10-16 02:08:15
M AM0072 COMPLD
"ODUF-20-2-2-1::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NE5""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODUF
ENT-ODUF

76.MTFP50/30, Rev B January 2018 Page 30-1255

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PTHTRC-ODU0

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PTHTRC-ODU0 command instructs the network element (NE) to retrieve the ODU trace information for
the specified ODU0 entity. This command is used to retrieve the following attributes:
• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies to ODU0 facilities for which the supporting module is OSM-2C/OSM-2S/OSM-
1S/OSM-4C/OSM-4F/OSM-4S/OSM-5C.

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related ODU Trace information for all ODU0 facilities supported
by all OSM-2C/OSM-2S/OSM-1S/OSM-4C/OSM-4F/OSM-4S/OSM-5C modules within the NE.

Command Format
RTRV-PTHTRC-ODU0:[tid]:{ALL|<odu0_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<odu0_aid>::[RXSAPI=<rxSAPI>][,RXDAPI=<rxDAPI>][,RXOPER=<rxOPER>][,EXPSAPI=<
ExpSAPI>][,TXSAPI=<txSAPI>][,EXPDAPI=<ExpDAPI>][,TXDAPI=<txDAPI>][,EXPOPER=<ExpO
perator>][,TXOPER=<txOperator>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.123 RTRV-PTHTRC-ODU0 Parameters

Parameter Value(s) Definition
odu0_aid ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]

Page 30-1256 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.123 RTRV-PTHTRC-ODU0 Parameters (Continued)

Parameter Value(s) Definition
msgtype EXPTRC This specifies the type of trace message to be retrieved.
INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-ODU0:CORIANT1:ODU0-20-1-2-1:AM0072::INCTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15
M AM0072 COMPLD
"ODU0-20-1-2-1::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NanoE1TONE5""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU0
ENT-ODU0

76.MTFP50/30, Rev B January 2018 Page 30-1257

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PTHTRC-ODU1

Command Changes Since Previous Feature Package

• Added support of ODU1 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PTHTRC-ODU1 command instruct the network element (NE) to retrieve the ODU trace information for
the specified ODU1 entity. This command is used to retrieve the following attributes:

Restrictions and Exceptions

• This command applies only to ODU1 facilities for which the supporting module is OSM-2C/OSM-2S/
OSM-1S/OSM-4C/OSM-4F/SSM-2S.

• When "ALL" is selected, it will display related ODU Trace information for all ODU1 facilities supported
by all OSM-2C/OSM-2S/OSM-1S/OSM-4C/OSM-4F/SSM-2S/OSM-4S/OSM-5C modules within the
NE. modules within the NE.

Command Format
RTRV-PTHTRC-ODU1:[tid]:{ALL|<odu1_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"{<odu1_aid>}::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>
\"][,EXPSAPI=\"<ExpSAPI>\"[,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI>\"][,TXDAPI
=\"<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.124 RTRV-PTHTRC-ODU1 Parameters

Parameter Value(s) Definition
odu1_aid ODU1-20-[1-16]-[1-32], ODU1-20-[1- EntityID-ShelfID-SlotID--{PortID[-SupportingODU4
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Identifies the value of the received SAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

Page 30-1258 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.124 RTRV-PTHTRC-ODU1 Parameters (Continued)

Parameter Value(s) Definition
rxDAPI One to 15 alphanumeric characters Identifies the value of the received DAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Identifies the value of the received Operator Specific trace value
with up to 32 alphanumeric characters.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example

RTRV-PTHTRC-ODU1:CORIANT1:ODU1-20-8-3-16:AM0072::INCTRC;

Possible System Response

^^^CORIANT 14-09-09 03:20:21

M AM0072 COMPL

"ODU1-20-8-3-16::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NanoE1TONE5"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU1
ENT-ODU1

76.MTFP50/30, Rev B January 2018 Page 30-1259

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PTHTRC-ODU2

Command Changes Since Previous Feature Package

• Added support of ODU2 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PTHTRC-ODU2 command instructs the network element (NE) to retrieve the ODU trace information for
the specified ODU2 entity. This command is used to retrieve the following attributes:
• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies only to ODU2 facilities for which the supporting module is SSM-2S, OSM-2C,
OSM-2S, OSM-4C, OSM-4F, OSM-4S, OSM-5C.

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related ODU Trace information for all ODU2 facilities supported
by all OSM-2C/OSM-2S/OSM-4C/OSM-4F/SSM-2S/OSM-4S/OSM-5C modules within the NE.

Command Format
RTRV-PTHTRC-ODU2:[tid]:{ALL|<odu2_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"{<odu2_aid>}::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>
\"][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][EXPDAPI=\"<ExpDAPI>\"][TXDAPI=
\"<txDAPI>\"][EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.125 RTRV-PTHTRC-ODU2 Parameters

Parameter Value(s) Definition
odu2_aid ODU2-20-[1-16]-[1-40], ODU2-20-[1- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]

Page 30-1260 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.125 RTRV-PTHTRC-ODU2 Parameters (Continued)

Parameter Value(s) Definition
msgtype EXPTRC This specifies the type of trace message to be retrieved.
INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Identifies the value of the received SAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Identifies the value of the received DAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Identifies the value of the received Operator Specific trace value
with up to 32 alphanumeric characters.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-ODU2:CORIANT1:ODU2-20-1-2-1:AM0072::INCTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15

M AM0072 COMPLD

"ODU2-20-1-2-1::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NanoE1TONE5"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-1261

22. Retrieve Commands TL1 Command Reference Manual

Related Commands
ED-ODU2
ENT-ODU2

Page 30-1262 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PTHTRC-ODU2E

Command Changes Since Previous Feature Package

• Added support of ODU2E mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-PTHTRC-ODU2E command instructs the network element (NE) to retrieve the ODU trace information
for the specified ODU2E entity. This command is used to retrieve the following attributes:
• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related ODU Trace information for all ODU2E facilities supported
by all OSM-2S, OSM-2C, OSM-4C, OSM-4F, OSM-4S, OSM-5C modules within the NE.

Command Format
RTRV-PTHTRC-ODU2E:[tid]:{ALL|<odu2e_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"{<odu2e_aid>}::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER
>\"][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][EXPDAPI=\"<ExpDAPI>\"][TXDAPI
=\"<txDAPI>\"][EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.126 RTRV-PTHTRC-ODU2E Parameters

Parameter Value(s) Definition
odu2e_aid ODU2E-20-[1-16]-[1-4], ODU2E-20-[1- EntityID-ShelfID-SlotID-PortID{[-SupportingODU4
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1- ODU4TribPort][-SupportODUODUTribPort][-TribID]}
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]

76.MTFP50/30, Rev B January 2018 Page 30-1263

22. Retrieve Commands TL1 Command Reference Manual

Table 22.126 RTRV-PTHTRC-ODU2E Parameters (Continued)

Parameter Value(s) Definition
msgtype EXPTRC This specifies the type of trace message to be retrieved.
INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Identifies the value of the received SAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Identifies the value of the received DAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Identifies the value of the received Operator Specific trace value
with up to 32 alphanumeric characters.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-ODU2E:CORIANT1:ODU2E-20-2-2-1:AM0072;

Possible System Response

CORIANT1 10-10-16 02:08:15

M AM0072 COMPLD

"ODU2E-20-2-2-1::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NanoE1TONE5"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-1264 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Related Commands
ED-ODU2E
ENT-ODU2E

76.MTFP50/30, Rev B January 2018 Page 30-1265

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PTHTRC-ODU3

Command Changes Since Previous Feature Package

• Added support of ODU3 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-5C.

Description
The RTRV-PTHTRC-ODU3 command instructs the network element (NE) to retrieve the ODU trace information for
the specified ODU3 entity. This command is used to retrieve the following attributes:
• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related ODU Trace information for all ODU3 facilities supported
by all OSM-2C, OSM-4C, OSM-4F, OSM-5C modules within the NE.

Command Format
RTRV-PTHTRC-ODU3:[tid]:{ALL|<odu3_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"{<odu3_aid>}::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>
\"][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI>\"][,TXDAP
I=\"<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.127 RTRV-PTHTRC-ODU3 Parameters

Parameter Value(s) Definition
odu3_aid ODU3-20-[1-16]-[1-5]-[1-80], ODU3- EntityID-ShelfID-SlotID-PortID[-SupportingODU4
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]- ODU4TribPort]-TribID
[D][1-3]-[1-80]

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

Page 30-1266 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.127 RTRV-PTHTRC-ODU3 Parameters (Continued)

Parameter Value(s) Definition
rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-ODU3:CORIANT1:ODU3-20-2-1-1:AM0072::INCTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15

M AM0072 COMPLD

"ODU3-20-2-1-1::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NanoE1TONE5""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU3
ENT-ODU3

76.MTFP50/30, Rev B January 2018 Page 30-1267

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PTHTRC-ODU4

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-5C.

Description
The RTRV-PTHTRC-ODU4 command instructs the network element (NE) to retrieve the ODU trace information for
the specified ODU4 entity. This command is used to retrieve the following attributes:
• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies to ODU4 facilities for which the supporting module is OSM-2C, OSM-4C, OSM-
4F, OSM-5C.

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related ODU Trace information for all ODU4 facilities supported
by OSM-2C, OSM-4C, OSM-4F, OSM-5C modules within the NE.

• The ODU4TribPort filed in the AID is only applicable for ODU4 within an ODUC2 or ODUC3 on OSM-4F.

Command Format
RTRV-PTHTRC-ODU4:[tid]:{ALL|<odu4_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"{<odu4_aid>}::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>
\"][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI>\"][,TXDAP
I=\"<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.128 RTRV-PTHTRC-ODU4 Parameters

Parameter Value(s) Definition
odu4_aid ODU4-20-[1-16]-[1-5], ODU4-20-[1- EntityID-ShelfID-SlotID-PortID[-ODU4TribPort]
16]-[1-2]-[1-3]

Page 30-1268 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.128 RTRV-PTHTRC-ODU4 Parameters (Continued)

Parameter Value(s) Definition
msgtype EXPTRC This specifies the type of trace message to be retrieved.
INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-ODU4:CORIANT:ODU4-20-2-1-1:AM0072::INCTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15
M AM0072 COMPLD
"ODU4-20-2-1-1::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NE5""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-ODU4
ENT-ODU4

76.MTFP50/30, Rev B January 2018 Page 30-1269

22. Retrieve Commands TL1 Command Reference Manual

RTRV-PTHTRC-OTS

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PTHTRC-OTS command instructs the network element (NE) to retrieve OTS trace information for the
specified OTS termination.

This command is used to retrieve the following attributes:

• Expected OTS trace.

• Received or Incoming OTS trace.

• Transmitted OTS trace.

Restrictions and Exceptions

• On OADMRS/OADMRS9, when OTSMODE=7100, EXPOTSTRC/OTSTRC/INCOTSTRC are
appliable.

• On OADMRS/OADMRS9, when OTSMODE=MTERA or HIT7300, ExpOPER/ExpDAPI/ExpSAPI/

txOPER/txDAPI/txSAPI/rxOPER/rxDAPI/rxSAPI/ are appliable.

Command Format
RTRV-PTHTRC-OTS:[tid]:{ALL|<ots_aid>}:ctag::[<msgtype>];

Proper System Response

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<ots_aid>::[EXPOTSTRC=\"<OTSExpTrc>\"][,INCOTSTRC=\"<ots_inctrc>\"][,OTSTRC=
\"<ots_trc>\"][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI
>\"][,TXDAPI=\"<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]
[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.129 RTRV-PTHTRC-OTS Parameters

Parameter Value(s) Definition
ots_aid OTS-20-[10-16,1-7]-21,OTS-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming Path trace message.
TRC - INCTRC - Received incoming path trace message.
ALL - TRC - Outgoing Path trace message.
- ALL - all 3 trace messages.

Page 30-1270 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.129 RTRV-PTHTRC-OTS Parameters (Continued)

Parameter Value(s) Definition
OTSExpTrc One to 28 alphanumeric characters Specifies the expected trace identification.
All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id expected.
Refer to section 2 for the applicable characters.

ots_inctrc One to 28 alphanumeric characters Specifies the received trace identification.

All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id received.
Refer to section 2 for the applicable characters.

ots_trc One to 28 alphanumeric characters Specifies the trace identification.

All printable characters are allowed except for the semi-colon
and double quote. A value of "" means that there is no Trail
Trace Id sent.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

For mTera UTP system, the default OTS trace consists of NE

TID and the shelfID and slotID the OTS locates,
"TID,ShelfID,SlotID" when OTSMODE=MTERA or HIT7300.

rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-OTS:CORIANT1:OTS-20-1-21:AM0072::ALL;

76.MTFP50/30, Rev B January 2018 Page 30-1271

22. Retrieve Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 14-12-16 02:08:15

M AM0072 COMPLD

"OTS-20-1-21::EXPOTSTRC=\"MTERA1,20,1\",INCOTSTRC=\"MTERA1,20,1\",OTSTRC=
\"CORIANT1,20,1\""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTS

Page 30-1272 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PTHTRC-OTU1

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-PTHTRC-OTU1 command instruct the network element (NE) to retrieve the OTU trace information for
the specified OTU1 entity. This command is used to retrieve the following attributes:
• Received SAPI, DAPI and Operator Specific ID

• Expected SAPI, DAPI and Operator Specific ID

• Transmitted SAPI, DAPI and Operator Specific ID

Restrictions and Exceptions

• This command applies to OTU1 facilities for modules supported in mTera.

• When "ALL" is selected, it will display related OTU Trace information for all OTU1 facilities supported
by all modules within the mTera NE.

Command Format
RTRV-PTHTRC-OTU1:[tid]:{ALL|<otu1_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<otu1_aid>::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>\"
[.EXPSAPI=\"<ExpSAPI>\"[,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI>\"][,TXDAPI=\"
<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.130 RTRV-PTHTRC-OTU1 Parameters

Parameter Value(s) Definition
otu1_aid OTU1-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Identifies the value of the received SAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Identifies the value of the received DAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1273

22. Retrieve Commands TL1 Command Reference Manual

Table 22.130 RTRV-PTHTRC-OTU1 Parameters (Continued)

Parameter Value(s) Definition
rxOPER One to 32 alphanumeric characters. Identifies the value of the received Operator Specific trace value
with up to 32 alphanumeric characters.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example

RTRV-PTHTRC-OTU1:CORIANT1:OTU1-20-3-5:AM0072::EXPTRC;

Possible System Response

^^^CORIANT1 09-09-09 03:20:21

M AM0072 COMPL

"OTU1-20-3-5::RXSAPI=CHICAGO23,RXDAPI=NEWYORK45,RXOPER=CORIANT1 NanoE1TONE5"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTU1

Page 30-1274 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PTHTRC-OTU2

Command Changes Since Previous Feature Package

• Added support for OSM-4S.

Description
The RTRV-PTHTRC-OTU2 command instructs the network element (NE) to retrieve the OTU trace information for
the specified OTU2 termination. This command is used to retrieve the following attributes:
• Received Trail Trace Identifier (TTI)
- Includes SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies only to OTU2 facilities for the modules supported in mTera.

• If the Trace received contains characters that are not listed in TL1 Quoted Allowable Characters table
in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM alarm
generation is the "real" trace as received on the physical line.

• When "ALL" is selected, it will display related OTU Trace information for all OTU2 facilities supported
by the modules within the mTera NE.

Command Format
RTRV-PTHTRC-OTU2:[tid]:{ALL|<otu2_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<otu2_aid>::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>\"
][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][EXPDAPI=\"<ExpDAPI>\"][TXDAPI=\"
<txDAPI>\"][EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.131 RTRV-PTHTRC-OTU2 Parameters

Parameter Value(s) Definition
otu2_aid OTU2-20-[1-16]-[1-40] EntityID-ShelfID-SlotID-PortID

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

76.MTFP50/30, Rev B January 2018 Page 30-1275

22. Retrieve Commands TL1 Command Reference Manual

Table 22.131 RTRV-PTHTRC-OTU2 Parameters (Continued)

Parameter Value(s) Definition
rxSAPI One to 15 alphanumeric characters Identifies the value of the received SAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Identifies the value of the received DAPI with up to 15
alphanumeric characters.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Identifies the value of the received Operator Specific trace value
with up to 32 alphanumeric characters.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-OTU2:CORIANT1:OTU2-20-1-2:AM0072::EXPTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15

M AM0072 COMPLD

"OTU2-20-1-2::EXPSAPI=\"CHICAGO23\",EXPDAPI=\"NEWYORK45\",EXPOPER=\"CORIANT1
NanoE1TONE5\"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTU2

Page 30-1276 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PTHTRC-OTU4

Command Changes Since Previous Feature Package

• Added support for OSM-5C.

Description
The RTRV-PTHTRC-OTU4 command instructs the network element (NE) to retrieve the OTU trace information for
the specified OTU4 termination. This command is used to retrieve the following attributes:
• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies to OTU4 facilities for which the supporting module is in mTera NE.

• When "ALL" is selected, it will display related OTU Trace information for all OTU4 facilities supported
by mTera modules within the NE.

Command Format
RTRV-PTHTRC-OTU4:[tid]:{ALL|<otu4_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<otu4_aid>::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>\"
][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI>\"][,TXDAPI=
\"<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.132 RTRV-PTHTRC-OTU4 Parameters

Parameter Value(s) Definition
otu4_aid OTU4-20-[1-16]-[1-5] EntityID-ShelfID-SlotID-PortID

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1277

22. Retrieve Commands TL1 Command Reference Manual

Table 22.132 RTRV-PTHTRC-OTU4 Parameters (Continued)

Parameter Value(s) Definition
rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-OTU4:CORIANT1:OTU4-20-2-1:AM0072::EXPTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15

M AM0072 COMPLD

"OTU4-20-2-1::EXPSAPI=\"CHICAGO23\",EXPDAPI=\"NEWYORK45\",EXPOPER=\"CORIANT1
NanoE1TONE5\""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTU4
ENT-OTU4

Page 30-1278 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PTHTRC-OTUC2

Command Changes Since Previous Feature Package

• New Command

Description
The RTRV-PTHTRC-OTUC2 command instructs the network element (NE) to retrieve the OTU trace information for
the specified OTUC2 termination. This command is used to retrieve the following attributes:
• Received Trail Trace Identifier (TTI)
- Includes SAPI, DAPI, and Operator Specific ID

• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies to OTUC2 facilities for which the supporting module is OSM-4F in mTera NE..

• When "ALL" is selected, it will display related OTU Trace information for all OTUC2 facilities supported
by mTera modules within the NE.

Command Format
RTRV-PTHTRC-OTUC2:[tid]:{ALL|<otuc2_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<otuc2_aid>::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>\
"][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI>\"][,TXDAPI
=\"<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.133 RTRV-PTHTRC-OTUC2 Parameters

Parameter Value(s) Definition
otuc2_aid OTUC2-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1279

22. Retrieve Commands TL1 Command Reference Manual

Table 22.133 RTRV-PTHTRC-OTUC2 Parameters (Continued)

Parameter Value(s) Definition
rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-OTUC2:CORIANT1:OTUC2-20-2-1:AM0072::EXPTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15

M AM0072 COMPLD

"OTUC2-20-2-1::EXPSAPI=\"CHICAGO23\",EXPDAPI=\"NEWYORK45\",EXPOPER=\"CORIANT1
NanoE1TONE5\""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTUC2
ENT-OTUC2

Page 30-1280 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-PTHTRC-OTUC3

Command Changes Since Previous Feature Package

• New Command

Description
The RTRV-PTHTRC-OTUC3 command instructs the network element (NE) to retrieve the OTU trace information for
the specified OTUC3 termination. This command is used to retrieve the following attributes:
• Received Trail Trace Identifier (TTI)
- Includes SAPI, DAPI, and Operator Specific ID

• Received SAPI, DAPI, and Operator Specific ID

• Expected SAPI, DAPI, and Operator Specific ID

• Transmitted SAPI, SAPI, and Operator Specific ID

Restrictions and Exceptions

• This command applies to OTUC3 facilities for which the supporting module is OSM-4F in mTera NE..

• When "ALL" is selected, it will display related OTU Trace information for all OTUC3 facilities supported
by mTera modules within the NE.

Command Format
RTRV-PTHTRC-OTUC3:[tid]:{ALL|<otuc3_aid>}:ctag::[<msgtype>];

Proper System Responses

<header>

M^^ctag^COMPLD<cr><lf>
^^^"<otuc3_aid>::[RXSAPI=\"<rxSAPI>\"][,RXDAPI=\"<rxDAPI>\"][,RXOPER=\"<rxOPER>\
"][,EXPSAPI=\"<ExpSAPI>\"][,TXSAPI=\"<txSAPI>\"][,EXPDAPI=\"<ExpDAPI>\"][,TXDAPI
=\"<txDAPI>\"][,EXPOPER=\"<ExpOperator>\"][,TXOPER=\"<txOperator>\"]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.134 RTRV-PTHTRC-OTUC3 Parameters

Parameter Value(s) Definition
otuc3_aid OTUC3-20-[1-16]-1 EntityID-ShelfID-SlotID-PortID

msgtype EXPTRC This specifies the type of trace message to be retrieved.

INCTRC - EXPTRC - Expected incoming trace message.
TRC - INCTRC - Received incoming trace message.
ALL - TRC - Outgoing trace message.
- ALL - all 3 trace messages.

rxSAPI One to 15 alphanumeric characters Specifies 15 characters representing the received SAPI.
Refer to section 2 for the applicable characters.

76.MTFP50/30, Rev B January 2018 Page 30-1281

22. Retrieve Commands TL1 Command Reference Manual

Table 22.134 RTRV-PTHTRC-OTUC3 Parameters (Continued)

Parameter Value(s) Definition
rxDAPI One to 15 alphanumeric characters Specifies 15 characters representing the received DAPI.
Refer to section 2 for the applicable characters.

rxOPER One to 32 alphanumeric characters. Specifies 32 characters representing the received Operator
Specific trace.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
\"\" means that there is no SAPI expected.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
\"\" means that there is no DAPI expected.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
\"\" means that there is no DAPI sent.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

Example
RTRV-PTHTRC-OTUC3:CORIANT1:OTUC3-20-2-1:AM0072::EXPTRC;

Possible System Response

CORIANT1 10-10-16 02:08:15

M AM0072 COMPLD

"OTUC3-20-2-1::EXPSAPI=\"CHICAGO23\",EXPDAPI=\"NEWYORK45\",EXPOPER=\"CORIANT1
NanoE1TONE5\""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTUC3
ENT-OTUC3

Page 30-1282 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-RFILE

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-RFILE command is used to retrieve a list of files on the NE. The command will also return the storage
usage and available (free) storage information. If no parameters are specified, then the NE will only return the
storage usage information.

Command Format
RTRV-
RFILE:[tid]::ctag:::[LOCATION=<fileUrl>][,LEVEL=<level>][,STORUSG=<storusg>];

Proper System Response

<header>

M^^<ctag>^COMPLD

^^^"::[SIZE=<storsize>,USED=<storused>,FREE=<storfree>,FILENAME=<filename>,FILES
IZE=<filesize>,DATE=<date>]"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.135 RTRV-RFILE Parameters

Parameter Value(s) Definition
fileUrl file://url-path Specifies a file or a directory:
- <url-path> specifies the device/drive/directory/file to access the
file to transfer.
The file name for the software generic to transfer must be
provided without the extension.

level 1 Identifies whether to retrieve the contents of the specified

ALL directory or all.
This parameter would only apply when a <dirurl> is specified as
the location.
- Enter 1 to indicates to retrieve at the current (single) level.
- Enter ALL to recursively retrieve all levels.

storusg YES Indicates whether to return the storage usage and available free
NO storage of the storage entity. This
parameter has the following values:
- YES: Return the storage usage/free information.
- NO: Do not include the storage usage/free information.

storsize A number in integer format in kbytes. Indicates the capacity of the storage device.

storused A number in integer format in kbytes. Indicates the amount spaced used on the storage device.

76.MTFP50/30, Rev B January 2018 Page 30-1283

22. Retrieve Commands TL1 Command Reference Manual

Table 22.135 RTRV-RFILE Parameters (Continued)

Parameter Value(s) Definition
storfree A number in integer format in kbytes. Indicates the amount of free space available on the storage
device.

filename An alphanumeric string containing Identifies the name of the file.

allowed special characters defining a
path or a directory.

filesize A number in integer format in kbytes. Indicates the size of the file.

date The format is YY-MM-DD HH:MM:SS Indicates the date the file was last modified.
where: (1) YY is the year 00-99. (2)
MM is the month 01-12. (3) DD is the
day 01-31. (4) HH is the hour 00-23.
(5) MM is the minutes 00-59. (6) SS is
the seconds 00-59.

Example 1
Retrieve only the storage usage information from the NE storage device:
RTRV-RFILE:CORIANT1::AM0662:::STORUSG=YES;

Possible System Response

CORIANT1 02-12-30 16:07:47
M AM0662 COMPLD
^^^"::SIZE=482102,USED=62786,FREE=419316"
;

Example 2
Retrieve the RFILE "root1/dir1/file2" from the NE storage device:
RTRV-RFILE:CORIANT1::AM0662:::LOCATION="file://root1/dir1/file2";

Possible System Response

CORIANT1 02-12-30 16:07:47
M AM0662 COMPLD
^^^"::SIZE=482102,USED=62786,FREE=419316,FILENAME=FILE2,FILESIZE=5128,DATE=02-
12-24-18-44-33"
;

Example 3
Retrieve the contents of RFILE directory "/download/" from the NE storage device:
RTRV-RFILE:CORIANT1::MK0665:::LOCATION="/download/",LEVEL=all;

Possible System Response

CORIANT1 11-12-30 16:07:47
M MK0665 COMPLD
^^^"::SIZE=1559440,USED=432504,FREE=1126936,FILENAME=\"./
CORIANT_FP6_2_1NZ118.dcr\",FILESIZE=1,DATE=11-08-01 17:38:12"
^^^"::,,,FILENAME=\"./CORIANT_FP6_2_1NZ118.zip\",FILESIZE=255789,DATE=11-08-01
17:58:18"
^^^"::SIZE=1559440,USED=432504,FREE=1126936,FILENAME=\"./

Page 30-1284 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

FP6_2_1_NZ118_PATCHLOAD_A.dcr\",FILESIZE=1,DATE=11-08-01 17:38:12"
^^^"::,,,FILENAME=\"./FP6_2_1_NZ118_PATCHLOAD_A.zip\",FILESIZE=255789,DATE=11-
08-01 17:58:18"
^^^"::,,,FILENAME=\"FP1_0_PLUGTF_V2.tlf\",FILESIZE=255789,DATE=11-08-01
17:58:18"
^^^"::,,,FILENAME=\"./../\",FILESIZE=0,DATE=11-08-22 14:42:01"
^^^"::,,,FILENAME=\"././\",FILESIZE=0,DATE=11-08-01 18:08:08"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE
DLT-RFILE
REPT^EVT^FXFR

76.MTFP50/30, Rev B January 2018 Page 30-1285

22. Retrieve Commands TL1 Command Reference Manual

RTRV-RSVP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-RSVP command instructs the network element (NE) to retrieve a RSVP Signaling Controller (RSVP SC)
entity.

Restrictions
• When ALL is used as an AID, information for all RSVP entities that matches the specified filtering
parameter(s) is retrieved.

Command Format
RTRV-RSVP:[tid]:{<rsvp_aid>|ALL}:ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<rsvp_aid>::SIGID=<SignalingControllerId>,INTRFC=<interface_aid>:<pst>"<CR><
LF>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.136 RTRV-RSVP Parameters

Parameter Value(s) Definition
rsvp_aid RSVP-[1,3]-1 EntityID-NPID-RSVPID

SignalingContr [0-255].[0-255].[0-255].[0-255] Specifies the signaling controller ID.

ollerId The Signaling Controller ID needs to be unique within a network.
Each network partition represents a network. A network spans
multiple NEs.

interface_aid TL-1-[1-512]-[1-1500] Identifies the TL used to transport signaling messages.

pst IS Specifies the primary state of the entity.

Example
RTRV-RSVP::RSVP-3-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPL8
^^^\"RSVP-3-1::SIGID=127.254.233.256,INTRFC=TL-1-3-1:IS-NR\"
;

Page 30-1286 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-RSVP
ENT-RSVP

76.MTFP50/30, Rev B January 2018 Page 30-1287

22. Retrieve Commands TL1 Command Reference Manual

RTRV-RSVPADJ

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-RSVPADJ command instructs the network element (NE) to retrieve an RSVP signaling adjacency.

RSVP Signaling Adjacency entities (that is, RSVPADJ) are automatically created and deleted by the control plane
software. The control plane attempts to create a signaling adjacency to a neighbor if at least one TL with signaling
enabled to the neighbor. Only one signaling adjacency is created per neighbor. The control plane deletes a signaling
adjacency if the last TL with signaling enabled to a neighbor is deleted.

Restrictions
• None

Command Format
RTRV-
RSVPADJ:[tid]:{<rsvpadj_aid>|ALL}:ctag:::[:<editablePrimaryState>][,<secondarySt
ate>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<rsvpadj_aid>::NSIGADDR=<NeighborSignalingAddr>:<pst>[,<sst>]"<CR><LF>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.137 RTRV-RSVPADJ Parameters

Parameter Value(s) Definition
rsvpadj_aid RSVPADJ-[1,3]-1-[1-40] EntityID-NPID-RSVPID-RSVPADJID

editablePrimar IS Indicates the primary state of an entity.

yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling address.

lingAddr

Page 30-1288 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.137 RTRV-RSVPADJ Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of a
OOS-AU module.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous and
management

secondaryStat FAF Indicates the secondary state:

e/sst - FAF: Facility Failure

Example
RTRV-RSVPADJ::RSVPADJ-3-1-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^\"RSVPADJ-3-1::NSIGADDR=127.121.233.221:IS-NR,"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-RSVPADJ
REPT^ALM^ADJ

76.MTFP50/30, Rev B January 2018 Page 30-1289

22. Retrieve Commands TL1 Command Reference Manual

RTRV-RTE-ALL

Command Changes Since Previous Feature Package

• Added OTUC2, OTUC3 as Resource.

Description
The RTRV-RTE-ALL command instructs the network element (NE) to retrieve all (static and dynamic) route
information from the IP packets forwarding table.

Restrictions
• Since the parameters RESOURCE and IFNAME are mutually exclusive, only one of these parameters
is returned.

• Route on MCN GCC is displayed with INTERFACE = MCN TL of GCC.

Command Format
RTRV-RTE-ALL:[tid]::<ctag>;

Proper System Response

The completed response indicates that the static and dynamic route(s) have been successfully retrieved from the
IP forwarding table. The table retrieved contains active (in-use) routes only. Any route running over disabled (down)
interfaces does not be returned.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::DEST=<destination>[,NETMASK=<netmask>][,INTERFACE=<interface>],
NEXTHOP=<next_hop>[,RESOURCE=<resource>][,IFNAME=<ifName>],R_TYPE=<r_type>"
<cr><lf>;

Note: The "ADVERTISE" field is a configurable parameter that is not part of the
active routes table and therefore does not be returned.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.138 RTRV-RTE-ALL Parameters

Parameter Value(s) Definition
destination Format for the IP address is: A double Specifies the host or the network destination where the IP
quoted string representing the IPv4 packet is attempting to reach.
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

netmask [0-255].[0-255].[0-255].[0-255] The netmask is bitwise 'AND'ed with the destination IP address
of the packet and compared with the 'destination' field of this IP
forwarding table entry.

Page 30-1290 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.138 RTRV-RTE-ALL Parameters (Continued)

Parameter Value(s) Definition
interface TL-[1,3]-[1-512]-[1-1500] Specifies the local host interface through which the IP packet
egresses.
If a TL is associated with the interface, the TL_aid of the
associated TL is returned. Else, the If Index of the interface is
returned.

next_hop [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the next_hop to be taken by the IP

packet enroute to the destination.

resource IPPG-1, If the TL is assigned to an entity with an AID, this parameter is

MGTETH-20-[13,14,21,28]-[1-8], returned to specify the AID of the resource.
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
ODUF-20-[1-16]-[1-20]-[1-80],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-32]-[1-80],
OTU1-20-[1-16]-[1-32],
MGTINBANDETH-20-[10-16,1-7]-[1-
20],
OSCX-20-[10-16,1-7]-21-[2,1],OSCX-
20-[1-16]-1-[2,1],
PPPS-[20]-[1-16]-[1-30],
PPPS-[20]-[1-16]-99-[1-30],
PPPL-[20]-[1-16]-[1-30],
PPPL-[20]-[1-16]-99-[1-30],
PPPRS-[20]-[1-16]-[1-30],
PPPRS-[20]-[1-16]-99-[1-30],
PPPMS-[20]-[1-16]-[1-30],
PPPMS-[20]-[1-16]-99-[1-30],
OC48-20-[1-16]-[1-32],
OC192-20-[1-16]-[1-20],
TPOOL-20-[1-16]-[1-32],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-40],
ODU2E-20-[1-16]-[1-5]-[1-80],
OTU2-20-[1-16]-[1-40],
OCH-P-20-[1-16]-[1-40],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3],
OTU4-20-[1-16]-[1-5],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
OTUC2-20-[1-16]-[1-2],
OTUC3-20-[1-16]-1,
ODU3-20-[1-16]-[1-5]-[1-80]

76.MTFP50/30, Rev B January 2018 Page 30-1291

22. Retrieve Commands TL1 Command Reference Manual

Table 22.138 RTRV-RTE-ALL Parameters (Continued)

Parameter Value(s) Definition
resource GCC0-20-[1-16]-[1-32], If the TL is assigned to an entity with an AID, this parameter is
(contd)' GCC1-20-[1-16]-[1-20], returned to specify the AID of the resource.
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC2-20-[1-16]-[1-20],
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC12-20-[1-16]-[1-20],
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]

ifName LCI If the TL is assigned to an entity without an AID or no TL is

associated with the route being displayed, this parameter is
returned to specify the interface name.

- LCI for the Local Craft Interface

r_type DIRECT This is the route type.

STATIC DIRECT - The network for the prefix associated with the route is
OSPF directly attached to the NE. An example would be an ethernet
with multiple hosts on it connected to an NE ethernet port.
STATIC - The route is manually provisioned.
OSPF - The route is dynamically created by OSPF.

Example
The following example retrieves the NE route information
RTRV-RTE-ALL:::AM0011;

Possible System Response

MTERA001 06-05-15 02:08:15
M AM0011 COMPLD
"::DEST=140.201.1.122,NETMASK=255.255.255.255,INTERFACE=TL-1-1-
3,NEXTHOP=140.204.2.122,RESOURCE=MGTETH-20-28-1,R_TYPE=OSPF_MCN"
"::DEST=140.201.2.102,NETMASK=255.255.255.255,INTERFACE=TL-1-1-
3,NEXTHOP=140.204.2.109,RESOURCE=MGTETH-20-28-1,R_TYPE=OSPF_MCN"
"::DEST=140.204.2.0,NETMASK=255.255.255.0,INTERFACE=TL-1-1-
3,NEXTHOP=0.0.0.0,RESOURCE=MGTETH-20-28-1,R_TYPE=DIRECT"

Page 30-1292 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

"::DEST=140.204.2.109,NETMASK=255.255.255.255,INTERFACE=TL-1-1-
3,NEXTHOP=0.0.0.0,RESOURCE=MGTETH-20-28-1,R_TYPE=OSPF_MCN"

"::DEST=0.0.0.0,NETMASK=0.0.0.0,NEXTHOP=172.29.157.1,IFNAME=LCI,R_TYPE=DIRECT"

"::DEST=172.29.157.0,NETMASK=255.255.255.0,NEXTHOP=0.0.0.0,IFNAME=LCI,R_TYPE=DIR
ECT"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-STAT-RTE
DLT-STAT-RTE
RTRV-STAT-RTE
ED-STAT-RTE

76.MTFP50/30, Rev B January 2018 Page 30-1293

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SECU-SYS

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SECU-SYS command instructs the network element (NE) for a system administrator to retrieve the
following system security attributes for all users and their current values: the number of allowed invalid login
attempts (MXINV), the suspension period after unsuccessful login (DURAL), the number of remembered password
(PCNT), if password complexity checking (PWDCOMPL) is enabled or disabled, the interval for disabling inactive
users (UOUT), the interval for generating an event for inactive user (IRT) and whether the system security is
operating in FIPS compliance mode.

Command Format
RTRV-SECU-SYS:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^":MXINV=<loginTriesNum>,DURAL=<suspensionDuration>,PCNT=<passwordCount>,PWDCO
MPL=<pwdcompl>,UOUT=<uout>,IRT=<irt>,SECURE=<secureMode>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.139 RTRV-SECU-SYS Parameters

Parameter Value(s) Definition
loginTriesNum [0-9] This attribute is the maximum number of consecutive and invalid
login attempts before an account is suspended.

A value of 0 indicates that this parameter is disabled.

suspensionDur [0-300] This attribute is the duration of UID suspension following

ation consecutive invalid login attempts.

A value of 0 indicates that this parameter is disabled.

passwordCoun [0-10] This attribute specifies the number of previously used

t passwords remembered bythe system for one UID, which
cannot be repeated when changing to a new password.

A value of 0 indicates that this parameter is disabled.

Page 30-1294 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.139 RTRV-SECU-SYS Parameters (Continued)

Parameter Value(s) Definition
pwdcompl YES This attribute specifies if password complexity checking is
NO enabled (YES) or disabled (NO) on the TL1 interface. When the
value is YES, the password <pid> must conform to the following
rules:
-Password length must be 8 characters minimum, 12 characters
maximum.
-At least 3 of the 4 following character types must be present:
numeric character, lowercase alphabetical character, uppercase
alphabetical character, special character.
-Special character consists of any of the following: ! # $ % & @ ^
*
-The Password must not include more than 2 consecutive
repetitions of the same character.
-UID (UserId) must not be contained in password (case
insensitive).
If the password complexity parameter is set to NO, then the
<pid> can be between 6 and 12 characters long using any of the
characters mentioned above, with no restriction on upper case
or character repetition.

uout [0-365] Specifies the time interval (in days) for disabling a user account
that has not been used during that interval. Inactive users has
their STATUS=DISABLED once this interval is reached.
Note: this parameter does not apply to TL1 user with UAP=A8.

A value of 0 indicates that this parameter is disabled.

irt [0-365] Specifies the time interval (in days) for generating an INACTIVE
Event Condition type for a user account that has not been used
during that interval.
Note: this parameter does not apply to TL1 user with UAP=A8.
The value for this parameter must always be inferior or equal to
the UOUT (uout) parameter.

A value of 0 indicates that this parameter is disabled.

secureMode FIPS This attribute specifies whether the system security is operating
NONFIPS in FIPS compliance mode.

Example
To retrieve ALL the security attributes assigned to all users:
RTRV-SECU-SYS:CORIANT1::AM0549;

Possible System Response

CORIANT1 02-01-06 23:53:01
M^^<ctag>^COMPLD<cr><lf>
^^^":MXINV=5,DURAL=90,PCNT=6,PWDCOMPL=YES,UOUT=90,IRT=89,SECURE=NONFIPS";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-SECU-SYS

76.MTFP50/30, Rev B January 2018 Page 30-1295

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SESSION

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SESSION command instructs the network element (NE) to retrieve the session attributes.

The session ID is the TCP/IP session ID and it applies to both Raw TCP and Telnet.

Restrictions and Exceptions

• The login status (LOGIN or NOT LOGIN) applies to the TL1 session only, and does not apply to the
TCP/IP session. There can be an opened session at TCP/IP level but the customer has not logged in
at TL1 layer (then their STATUS is NOTLOGIN).

• The login status (LOGIN or NOT LOGIN) applies to the CLI session also, and does not apply to the TCP/
IP session. If there is an opened session at the TCP/IP level but the customer is not logged in through
CLI, then their STATUS is NOTLOGIN.

Command Format
RTRV-SESSION:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"SESID=<sesid>:STATUS=<login_status>,TYPE=<session_type>,UID=<uid>,CREATED=<s
ession_created>,IDLE=<idle>,PROTO=<protocol>,IPADDRESS=<session_ip_address>,REPT
MSG=<inhmode>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.140 RTRV-SESSION Parameters

Parameter Value(s) Definition
sesid [0-999999999] Specifies the Session ID on which a user is logged in. It is
unique for any active session on the NE.

login_status LOGIN Indicates the login status of the UID. If a UID is logged into a NE
NOTLOGIN on a specific session, then value is LOGIN. If there is an opened
session, but no user is connected, value is NOTLOGIN.
Only user with user_status=ENABLED or PASSWORD AGED
can be logged into a NE.

session_type TL1 Indicates the user type of the current session. If the login_status
CLI is NOTLOGIN, then session_type is unknown and this field is
blank.

Page 30-1296 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.140 RTRV-SESSION Parameters (Continued)

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. Specifies the user identity (login name) that was assigned in the
ENT-USER-SECU command and is presently connected to a
NE in the specified session. If the login_status is NOTLOGIN,
then UID is unknown and this field is blank.

session_creat The format is YY-MM-DD-HH-MM-SS Identifies the creation date of the session.
ed where: (1)YY is the year 00-99 (2) MM
is the month 01-12 (3) DD is the day
01-31 (4) HH is the hour 0-23. (5) MM
is the minutes 0-59. (6) SS is the
seconds 0-59.

idle positive integer Indicates the Idle time on the current session in seconds.

protocol TELNET Indicates which protocol has been used to establish the session.
RAW
SERIAL
SSH
SSHRAW

session_ip_ad [0-255].[0-255].[0-255].[0-255] Specifies the IP address associated with a session.

dress When the session is initiated from the RS232C serial port, the
value is NA.

inhmode ALW Indicates if REPT messages are allowed or inhibited for the
INH session.

Example
RTRV-SESSION:CORIANT::AM0549;

Possible System Response

CORIANT 03-03-22 23:53:01

M AM0549 COMPLD

"SESID=1:STATUS=LOGIN,TYPE=TL1,UID=Admin1,CREATED=03-03-
22,IDLE=0,PROTO=TELNET,IPADDRESS=172.112.121.12,REPTMSG=ALW"

"SESID=2:STATUS=NOT LOGIN,TYPE=,UID=,CREATED=03-03-
22,IDLE=2,PROTO=TELNET,IPADDRESS=172.112.122.15,REPTMSG=ALW"

"SESID=3:STATUS=LOGIN,TYPE=CLI,UID=jsmith2,CREATED=03-03-
22,IDLE=0,PROTO=TELNET,IPADDRESS=172.112.121.14,REPTMSG=ALW"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-SESSION
ALW-MSG-ALL
INH-MSG-ALL

76.MTFP50/30, Rev B January 2018 Page 30-1297

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SLOT

Command Changes Since Previous Feature Package

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-SLOT command instructs the network element (NE) to retrieve the attributes of any slot in the system.

This command enables to retrieve the supported type of module for the specified slot in regards to the Network
Element Type and Sub-Type (Refer to RTRV-NE for NE-Type and Sub-Type).

Restrictions
• Pluggable modules will appear in a command response if there is a supporting module currently
provisioned in the slot.

• The SHOWSLOT should always be set to YES to display the equipment in each slot.

• The SHOWSUBSLOT should always be set to YES to display the equipment in each subslot of a slot.

• The SHOWSLOT and SHOWSUBSLOT parameters are implied to be set to YES when the "ALL" AID
is used.

• The command is denied if SHOWSLOT is set to YES for a subslot AID.

• COMMCONN is only applicable to SLOT 34 and 35 on shelf of mTera NE.

• EXTENSIONSLOT is only applicable to OADMRS subslot entity.

Command Format
RTRV-SLOT:[tid]:{<slot_aid>|ALL}:ctag:::[ALMPF=<almProfile>]
[,SHOWSLOT=<showslot>][,SHOWSUBSLOT=<showsubslot>][:<editablePrimaryState>][,<se
condaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<slot_aid>::SLOTTYPE=<slot_type>,ALMPF=<almProfile>[,COMMCONN=<comm_connecti
on>][,EXTENSIONSLOT=<
extension_slot>]:<pst>,[<sst>]"<cr><lf>
;

Parameters

Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1298 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.141 RTRV-SLOT Parameters

Parameter Value(s) Definition
slot_aid SLOT-20-[1-35]-[1-32], SLOT-[50-58]- EntityID-ShelfID-SlotID[-SubslotID]
[1-8]

almProfile 0-20, 99 Indicates the alarm profile table for the equipment.

showslot YES Indicates if the response should include equipment in the slots
NO associated with a particular shelf.
Default: NO
Implied default YES for "ALL" AID

showsubslot YES Indicates if the response should include equipment in the

NO sublsots associated with a particular module.
Default: NO denies if SHOWSUBSLOT is requested and SHOWSLOT is not.

Implied default YES for "ALL" AID

editablePrimar IS Indicates the primary state of the slot.

yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

slot_type BFM Indicates the type of module that should be populated in this
CDCP slot in accordance to the NE Configuration (Type, Subtype,
CFP Release, Spans).
CFP2 When multiple modules are possible, they will all be listed
DCM separated by a ampersand (&) character.
FAN
FAN8 RESERVED indicates that a slot is no longer available for
FSM module assignment
MFAB
MFAB2
MFM
OADMRS
OADMRS9
OCC
OMD
OSM2C
OSM1S
OSM2S
OSM4C
OSM4F
OSM4S
OSM5C
SAIM
SDM
SEIM
SFM
SFP
SFPP
SIOM
STIM
STPM
STPM8
RESERVED

76.MTFP50/30, Rev B January 2018 Page 30-1299

22. Retrieve Commands TL1 Command Reference Manual

Table 22.141 RTRV-SLOT Parameters (Continued)

Parameter Value(s) Definition
comm_connec NA, SLOT-20-[1-16]-[1-3] Specifies the OADMRS/OADMRS9 subslot of same shelf used
tion as communication connection (COMM port) for the module on
the SLOT.

NA indicates there is no COMM connection subslot specified.

Other value of subslot AID indicates the OADMRS/OADMRS9
subslot.

pst IS-NR Indicates the primary state and primary state qualifier of the slot.
OOS-AU Possible values for PST:
OOS-MA - IS: In-Service
OOS-AUMA - OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: management
- AUMA: autonomous and management

secondaryStat MEA Indicates the secondary state of the slot.

e/sst - MEA: mismatch of equipment and attributes.

extension_slot NA, SLOT-20-[34,35] Specifies the extension SLOT, for which the OADMRS subslot is
used as COMM connection.

NA indicates the OADMRS subslot is not used for COMM

connection of extension SLOT. Instead, it is used to support
DCM or OMD COMM connection.
Other value of subslot AID indicates the extension SLOT AID.

Example
CORIANT1> RTRV-SLOT::ALL:CT;

Possible System Response

CORIANT1 03-17-15 10:14:09

M CT COMPLD

"SLOT-20-1::SLOTTYPE=BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99,:IS-
NR,"
"SLOT-20-1-1::SLOTTYPE=DCM&OMD,ALMPF=99,EXTENSIONSLOT=NA:OOS-AU,SGEO"
"SLOT-20-1-2::SLOTTYPE=DCM&OMD,ALMPF=99,EXTENSIONSLOT=NA:OOS-AU,SGEO"
"SLOT-20-1-3::SLOTTYPE=RESERVED,ALMPF=99,EXTENSIONSLOT=SLOT-20-34: IS-NR,"
"SLOT-20-2::SLOTTYPE= BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-
NR,"
"SLOT-20-3::SLOTTYPE= BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-
NR,"
"SLOT-20-3-1::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-3-2::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-4::SLOTTYPE= BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-
NR,"
"SLOT-20-4-1::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-4-2::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-5::SLOTTYPE= BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-
NR,"

Page 30-1300 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

"SLOT-20-5-1::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-5-2::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-6::SLOTTYPE= BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-
NR,"
"SLOT-20-6-1::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-6-2::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-7::SLOTTYPE= BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-
NR,"
"SLOT-20-7-1::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-7-2::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-8::SLOTTYPE=MFAB&MFAB2&MFM,ALMPF=99:IS-NR,"
"SLOT-20-9::SLOTTYPE=MFAB&MFAB2&MFM,ALMPF=99:IS-NR,"
"SLOT-20-10::SLOTTYPE=
BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-NR,"
"SLOT-20-10-1::SLOTTYPE=CFP,ALMPF=99:IS-NR,"
"SLOT-20-11::SLOTTYPE=
BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-NR,"
"SLOT-20-12::SLOTTYPE=
BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-NR,"
"SLOT-20-13::SLOTTYPE=
BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-NR,"
"SLOT-20-13-1::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-2::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-3::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-4::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-5::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-6::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-7::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-8::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-9::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-10::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-11::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-12::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-13::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-14::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-15::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-16::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-17::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-18::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-19::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-13-20::SLOTTYPE=SFPP,ALMPF=99:IS-NR,"
"SLOT-20-14::SLOTTYPE=
BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-NR,"
"SLOT-20-15::SLOTTYPE=
BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-NR,"
"SLOT-20-16::SLOTTYPE=
BFM&CDCM&OADMRS&OADMRS9&OCC&OSM1S&OSM2C&OSM2S,ALMPF=99:IS-NR,"
"SLOT-20-17::SLOTTYPE=MFAB&MFAB2&MFM,ALMPF=99,:IS-NR,"
"SLOT-20-18::SLOTTYPE=MFAB&MFAB2&MFM,ALMPF=99,:IS-NR,"
"SLOT-20-19::SLOTTYPE=MFAB&MFAB2&MFM,ALMPF=99,:IS-NR,"
"SLOT-20-20::SLOTTYPE=MFAB&MFAB2&MFM,ALMPF=99,:IS-NR,"
"SLOT-20-21::SLOTTYPE=SEIM&SFM,ALMPF=99:IS-NR,"
"SLOT-20-22::SLOTTYPE=SAIM&SFM,ALMPF=99:IS-NR,"
"SLOT-20-23::SLOTTYPE=SFM,ALMPF=99:IS-NR,"
"SLOT-20-24::SLOTTYPE=STPM,ALMPF=99:IS-NR,"
"SLOT-20-25::SLOTTYPE=STPM,ALMPF=99:IS-NR,"

76.MTFP50/30, Rev B January 2018 Page 30-1301

22. Retrieve Commands TL1 Command Reference Manual

"SLOT-20-26::SLOTTYPE=SFM,ALMPF=99:IS-NR,"
"SLOT-20-27::SLOTTYPE=SFM,ALMPF=99:IS-NR,"
"SLOT-20-28::SLOTTYPE=SEIM&SFM,ALMPF=99:IS-NR,"
"SLOT-20-29::SLOTTYPE=FAN,ALMPF=99:IS-NR,"
"SLOT-20-30::SLOTTYPE=FAN,ALMPF=99:IS-NR,"
"SLOT-20-31::SLOTTYPE=FAN,ALMPF=99:IS-NR,"
"SLOT-20-32::SLOTTYPE=FAN,ALMPF=99:IS-NR,"
"SLOT-20-33::SLOTTYPE=SDM,ALMPF=99:IS-NR,"
"SLOT-20-34::SLOTTYPE=FSM,ALMPF=99,COMMCONN=SLOT-20-1-3,:IS-NR,"
"SLOT-20-35::SLOTTYPE=FSM,ALMPF=99,COMMCONN=NA,:IS-NR,"†

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-SLOT

Page 30-1302 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-SLPF

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SLPF command instructs the network element's (NE) Control Plane to retrieve service level profile
related information.

Restrictions
• PROFNAME must be specified in quotes.

• TRANSLINEMSDCC, TRANSSECTIONRSDCC do not apply to mTera platform, the setting is ignored

by mTera.

Command Format
RTRV-SLPF:[tid]:{<aid>|ALL}:ctag:[PROFNAME=<profile_name>];

Proper System Response

The completed response indicates that the service level profile under the service level profile <aid> has been
successfully retrieved.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<aid>::PROFNAME=<profile_name>,PROTLVL=<protection_level>,DIVERSITY=<diversi
ty>,REVERSION=<reversion>,COROUTING=<corouting>,TRANSLINEMSDCC=<transparent_line
_MS_DCC>,TRANSSECTIONRSDCC=<transparent_section_RS_DCC>,TRANSOTUGCC0=<transparen
t_OTU_GCC0>,TRANSODUGCC12=<transparent_ODU_GCC1_2>,WTR=<reversiontime>,RRTCALLSE
TUP=<rrt_call_setup>,RRTMAXREROUTE=<rrt_max_reroute_attempts>,RRTBOFFIVAL=<rrt_b
ack_off_interval>,RRTBDRYREROUTE=<rrt_boundary_reroute>,RRTETOEREROUTE=<rrt_end_
to_end_reroute>,LATENCY=<latency>,RESCLASS=<ResourceClass>,PRIO=<priority>,RESVS
TYLE=<ReservationStyle>,RESCONNA=<ResourceConnA>,RESCONNB=<ResourceConnB>,CPREVE
RSION=<cp_reversion>,CPWTR=<cp_wtr>,DIVERSITYCHECK=<diversity_check>"<cr><lf>;

Note: following parameters are not applied to mTera system:

TRANSLINEMSDCC, TRANSSECTIONRSDCC

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.142 RTRV-SLPF Parameters

Parameter Value(s) Definition
aid SLPF-[99,1-20] EntityID-SLPFID

profile_name One to 31 alphanumeric characters. Name of the service level profile.

This parameter identifies one of twenty(20) pre-defined service
level profiles.
It is highly recommended that a name that maps uniquely to an
'aid' is entered.

76.MTFP50/30, Rev B January 2018 Page 30-1303

22. Retrieve Commands TL1 Command Reference Manual

Table 22.142 RTRV-SLPF Parameters (Continued)

Parameter Value(s) Definition
protection_lev 1P1TWOSTRIKES Protection levels:
el UNPROTECT 1P1TWOSTRIKES - service is protected but is interrupted when
REROUTE both the working and protect paths have failed
FULLTIME UNPROTECT - no protection is requested
2PORT REROUTE - service is unprotected but attempts to be rerouted
2PORTREROUTE when the path fails
DONOTOVERRIDE FULLTIME - service is 1+1 protected and attempts to reroute
the broken leg while service is ongoing
2PORT - two unprotected paths is created but the paths does
not be rerouted when failure occurs.
2PORTREROUTE - two unprotected paths is created and the
paths is rerouted when failure occurs.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

diversity LINK Used to avoid/exclude nodes and/or links in the routing of a call.
SRLG LINK - The call will avoid common links..
DONOTOVERRIDE SRLG - is used in diversity path computation. The SRLG values
list is extracted from the path which a subsequent path is
diversed from.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists).

NOTE: While this parameter share the same semantics as the

parameter for CALL and shares a superset of parameter values,
only the subset of parameter values listed above applies in the
service level profile application context.

reversion NO Specifies whether to perform reversion back to the path prior to

YES protection action after restoration.
DONOTOVERRIDE DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

transparent_O NO Provides transparency for the OTU GCC0 channel.

TU_GCC0 DONOTOVERRIDE DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

transparent_O NO Provides transparency for the ODU GCC-1 and GCC-2

DU_GCC1_2 DONOTOVERRIDE channels.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

rrt_call_setup NO Reroute at call setup

YES
DONOTOVERRIDE

rrt_max_rerout [0-3] Maximum number of reroute attempts.

e_attempts NOTE: This is the number of attempts on top of the initial
reroute.

rrt_back_off_in [0-60] Back-off time between reroute attempts

terval

Page 30-1304 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.142 RTRV-SLPF Parameters (Continued)

Parameter Value(s) Definition
rrt_boundary_r NO Reroute is performed at domain boundary points.
eroute YES
DONOTOVERRIDE

rrt_end_to_en NO Reroute is performed at call end points.

d_reroute YES
DONOTOVERRIDE

latency [0-65535] The maximum aggregated data transmission delay allowed for
the endto-end circuit.

priority Possible values are: (1)0 to 7 This parameter indicates the restoration priority.
(2)DONOTOVERRIDE 0 is the highest priority.
DONOTOVERRIDE - use the parameter value found in the
signaling message or in a separate local NE configured
parameter (if it exists)

ReservationSt SE This parameter specifies the reservation style of service level

yle FF profile (to use for new calls).

SE: Shared Explicit

FF: Fixed Filter

ResourceConn AVAIL During connection setup of the nominal working path for
A AVAIL&FAILED 1P1TWOSTRIKES, UNPROTECT, REROUTE, FULLTIME,
2PORT and 2PORTREROUTE calls, this parameter specifies
the following:

AVAIL - During connection setup, the end-to-end connection is

established over unused capacity on links that are
administratively in-service and operationally in-service.
AVAIL&FAILED - During connection setup, the end-to-end
connection is established over unused capacity on links that are
administratively in-service. The link state can be operationally
in-service or operationally out-of-service.

ResourceConn AVAIL During connection setup of the nominal working path for
B AVAIL&FAILED 1P1TWOSTRIKES, UNPROTECT, REROUTE, FULLTIME,
2PORT and 2PORTREROUTE calls, this parameter specifies
the following:

AVAIL - During connection setup, the end-to-end connection is

established over unused capacity on links that are
administratively in-service and operationally in-service.
AVAIL&FAILED - During connection setup, the end-to-end
connection is established over unused capacity on links that are
administratively in-service. The link state can be operationally
in-service or operationally out-of-service.

cp_reversion NO Specifies whether to revert traffic back to nominal working/

AUTO protect path after the fault is cleared.
MAN NO: do not revert when fault on nominal connection path has
cleared.
AUTO: automatically revert traffic back to nominal path.
MAN: revert traffic back to nominal path upon request.

76.MTFP50/30, Rev B January 2018 Page 30-1305

22. Retrieve Commands TL1 Command Reference Manual

Table 22.142 RTRV-SLPF Parameters (Continued)

Parameter Value(s) Definition
cp_wtr [0-3600] Specifies Control Plane Wait To Revert timer.
Unit: second
A value of zero causes the connection path to be reverted
immediately.
Note this parameter may always be configured but applies only
when cp_reversion in the SLPF is AUTO.

diversity_chec HARD HARD: Perform diversity check when the preferred restoration
k SOFT path is specified for a connection.
SOFT: No diversity check of the preferred restoration path is
done in the provisioning phase.

co_routing NO Specifies signaling of component connections along the same

route or through different routes.
A co-signaled VCAT group implies corouting.

wtr [0-3600] Specifies Wait To Restore time to provisioned on a PPG. Valid

values: 0-3600 seconds. A value of zero causes the PPG switch
back immediately.
Note this parameter may always be configured but applies only
when reversion in the SLPF is YES or reversion in the SLPF is
DONOTOVERRIDE and the signaling message indicates
reversion is YES.

resource_clas A double quoted 4 byte hex strings. 32-bit long bit-mapped field with each bit representing a specific
s resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Example:
"3E04990A"
The default is an empty string ""
Example bit-mapped resource class definitions:
"00000000" - None
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

Note:
Empty string "" is displayed when RESCLASS is not specified or
after being reset.

Example
The following example retrieves the service level profile parameters associated with service level profile <aid>
"SLPF-1".
RTRV-SLPF::SLPF-1:AM0011;

Possible System Response

CORIANT1 11-05-15 02:08:15
M AM0011 COMPLD
"SLPF-1::PROFNAME=\"TwoNinesService\",PROTLVL=UNPROTECT,DIVERSITY=NONE,
REVERSION=NO,COROUTING=NO,TRANSLINEMSDCC=NO,TRANSSECTIONRSDCC=NO,TRANSOTUGCC0=NO
,TRANSODUGCC12=NO,WTR=0,RRTCALLSETUP=NO,RRTMAXREROUTE=1,RRTBOFFIVAL=5,RRTBDRYRER

Page 30-1306 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

OUTE=YES,RRTETOEREROUTE=YES,LATENCY=1000,RESCLASS="0070002D",PRIO=DONOTOVERRIDE,
RESVSTYLE=SE,RESCONNA=AVAIL,RESCONNB=AVAIL&FAILED,CPREVERSION=NO,CPWTR=300,DIVER
SITYCHECK=SOFT";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-SLPOLICY
ED-SLPF

76.MTFP50/30, Rev B January 2018 Page 30-1307

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SLPOLICY

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SLPOLICY command instructs the network element's (NE) Control Plane to retrieve a pre-defined
service level policy.

Note: A service level policy can support multiple service level code-points.

Restrictions
• None

Command Format
RTRV-SLPOLICY:[tid]:{<aid>|ALL}:ctag;

Proper System Response

The completed response indicates that the service level policy associated with the service level policy <aid> has
been successfully retrieved.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<aid>::POLICYNAME=<policy_name>,SLCODE1=<service_level_code_point>,SLPFAID1=
<service_level_profile_aid>,SLPFNAME1=<service_level_profile_name>,SLCODE2=<serv
ice_level_code_point>,SLPFAID2=<service_level_profile_aid>,SLPFNAME2=<service_le
vel_profile_name>,SLCODE3=<service_level_code_point>,SLPFAID3=<service_level_pro
file_aid>,SLPFNAME3=<service_level_profile_name>,SLCODE4=<service_level_code_poi
nt>,SLPFAID4=<service_level_profile_aid>,SLPFNAME4=<service_level_profile_name>,
SLCODE5=<service_level_code_point>,SLPFAID5=<service_level_profile_aid>,SLPFNAME
5=<service_level_profile_name>,SLCODE6=<service_level_code_point>,SLPFAID6=<serv
ice_level_profile_aid>,SLPFNAME6=<service_level_profile_name>,SLCODE7=<service_l
evel_code_point>,SLPFAID7=<service_level_profile_aid>,SLPFNAME7=<service_level_p
rofile_name>,SLCODE8=<service_level_code_point>,SLPFAID8=<service_level_profile_
aid>,SLPFNAME8=<service_level_profile_name>,SLCODE9=<service_level_code_point>,S
LPFAID9=<service_level_profile_aid>,SLPFNAME9=<service_level_profile_name>,SLCOD
E10=<service_level_code_point>,SLPFAID10=<service_level_profile_aid>,SLPFNAME10=
<service_level_profile_name>"
<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.143 RTRV-SLPOLICY Parameters

Parameter Value(s) Definition
aid SLPOLICY-[1-20] EntityID-SLPOLICYID

Page 30-1308 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.143 RTRV-SLPOLICY Parameters (Continued)

Parameter Value(s) Definition
policy_name Alpha-numeric text string up to 30 The name of the service level policy to be retrieved.
characters.

service_level_ (1)0-255 (2)NONE (3)DFLT The service level code-point corresponding to a specific service
code_point level profile associated with an internetworked carrier.

service_level_ SLPF-[99,1-20] The 'aid' of the service level profile associated with the service
profile_aid level codepoint.
A service level profile can service multiple code-points.

service_level_ Alpha-numeric text string up to 30 Name of the service level profile to be associated with the
profile_name characters service level codepoint.
A service level profile can service multiple code-points.

Example
The following example retrieves the service level policy assoicated with <aid> "SLPOLICY-3" :
RTRV-SLPOLICY::SLPOLICY-3:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
"SLPOLICY-3::POLICYNAME=\"PlatinumAccess\",SLCODE1=150,SLPFAID1=SLPF-
1,SLPFNAME1=\"FiveNinesByReroute\",SLCODE2=160,SLPFAID2=SLPF-
2,SLPFNAME2=\"FiveNinesByFullTimeOnePlusOne\",SLCODE3=170,SLPFAID3=SLPF-
3,SLPFNAME3=\"FiveNinesByFullTimeOnePlusOne\",SLCODE4=180,SLPFAID4=SLPF-
4,SLPFNAME4=\"FiveNinesByFullTimeOnePlusOne\",SLCODE5=190,SLPFAID5=SLPF-
5,SLPFNAME5=\"FiveNinesByFullTimeOnePlusOne\",SLCODE6=200,SLPFAID6=SLPF-
6,SLPFNAME6=\"FiveNinesByFullTimeOnePlusOne\",SLCODE7=210,SLPFAID7=SLPF-
7,SLPFNAME7=\"FiveNinesByFullTimeOnePlusOne\",SLCODE8=220,SLPFAID8=SLPF-
8,SLPFNAME8=\"FiveNinesByFullTimeOnePlusOne\",SLCODE9=230,SLPFAID9=SLPF-
9,SLPFNAME9=\"FiveNinesByFullTimeOnePlusOne\",SLCODE10=240,SLPFAID10=SLPF-
10,SLPFNAME10=\"FiveNinesByFullTimeOnePlusOne\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
None

76.MTFP50/30, Rev B January 2018 Page 30-1309

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SNMP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SNMP command instructs the network element (NE) to retrieve the attributes of the SNMP entity.

Command Format
RTRV-SNMP:[tid]:[<snmp_aid>]:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<snmp_aid>::[,ROCNAME=<rocname>][,RWCNAME=<rwcname>]:<pst>"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.144 RTRV-SNMP Parameters

Parameter Value(s) Definition
snmp_aid SNMP EntityID

rocname Is a string of length 1 to 30 characters. Specifies the read-only community string.

Refer to section 2 for the applicable characters.

rwcname Is a string of length 1 to 30 characters. Specifies the read-write community string.

Refer to section 2 for the applicable characters.

pst IS-NR Indicates the primary state and primary state qualifier of the
OOS-MA entity.
Possible values for PST-PSTQ:
- IS-NR: In-Service Normal
- OOS-MA: Out-of-Service Autonomous

Example
Enter the following command to retrieve the attributes of the SNMP entity.
RTRV-SNMP:CORIANT1::AM0209;

Possible System Response

^^^CORIANT1 05-11-16 00:50:03

M AM0209 COMPLD

^^^"SNMP::ROCNAME="NE-87-RO",RWCNAME="NE-87-RW":IS-NR"

Page 30-1310 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-SNMP

76.MTFP50/30, Rev B January 2018 Page 30-1311

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SNMP-COMM

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SNMP-COMM command instructs the network element to retrieve all community strings for supporting
SNMPv2c for Packet Subsystem.

Restrictions and Exceptions

• The command should be denied if the SNMPv2C is not turned on by ALW-PKT-SNMPV2 command.

• This command applies to mTera in the DISABLED proxy mode. The proxy mode can be retrieved by
ED-PROXY command.

Command Format
RTRV-SNMP-COMM:[tid]::ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"CSTR=<cstr>" <cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.145 RTRV-SNMP-COMM Parameters

Parameter Value(s) Definition
cstr Is a string of length 1 to 30 characters. Specifies the community strings used for SNMPv2c
management of Packet subsystem.
Refer to section 2 for the applicable characters.

Example
RTRV-SNMP-COMM:CORIANT1::AM0074;

Possible System Response

CORIANT1 02-04-16 02:08:15
M AM0074 COMPLD
^^^"CSTR=PREFIX1-1-1"
"CSTR=PREFIX1-1-2"
"CSTR=PREFIX1-1-3"
"CSTR=PREFIX1-1-1"
"CSTR=PREFIX1-1-2"
"CSTR=PREFIX1-1-3"
;

Page 30-1312 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SNMP-COMMPREFIX
ED-SNMP-COMMPREFIX
INH-PKT-SNMPV2
ALW-PKT-SNMPV2

76.MTFP50/30, Rev B January 2018 Page 30-1313

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SNMP-COMMPREFIX

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SNMP-COMMPREFIX command instructs the network element to retrieve the authentication portion of
the community strings for supporting SNMPv2c for Packet Subsystem.

Restrictions and Exceptions

• The command should be denied if the SNMPv2C is not turned on by ALW-PKT-SNMPV2 command.

• This command applies to mTera in the DISABLED proxy mode. The proxy mode can be retrieved by
ED-PROXY command.

Command Format
RTRV-SNMP-COMMPREFIX:[tid]::ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"AUTHCSTR=<authcstr>" <cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.146 RTRV-SNMP-COMMPREFIX Parameters

Parameter Value(s) Definition
authcstr Is a string of length 1 to 8 characters, Specifies the authentication portion of the community string.
inclusive. Refer to section 2 for the applicable characters.

Example
RTRV-SNMP-COMMPREFIX:CORIANT1::AM0074;

Possible System Response

CORIANT1 02-04-16 02:08:15
M AM0074 COMPLD
^^^"AUTHCSTR=PREFIX1"
"AUTHCSTR=PREFIX2";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-1314 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Related Commands
RTRV-SNMP-COMM
ED-SNMP-COMMPREFIX
INH-PKT-SNMPV2
ALW-PKT-SNMPV2

76.MTFP50/30, Rev B January 2018 Page 30-1315

22. Retrieve Commands TL1 Command Reference Manual

RTRV-STAT-RTE

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-STAT-RTE command instructs the network element (NE) to retrieve static route information from the IP
packets forwarding table.

Restrictions and Exceptions

• Since the parameters IFNAME and INTERFACE are mutually exclusive, only one of these parameters
is returned.

• The NEXTHOP parameter is not returned for interfaces with IFNAME RT-1, RT-2, or OSC-[A-H] since
these are point-to-point links and a next hop does not need to be specified.

• The NEXTHOP parameter is not returned for TL interfaces on resources of PPP, GCC or OSCX since
these are point-to-point links and a next hop does not need to be specified.

Command Format
RTRV-STAT-RTE:[tid]::<ctag>:::[DEST=<destination>];

To retrieve all static routes in the NE:

RTRV-STAT-RTE:[tid]::<ctag>;

Proper System Response

The completed response indicates that the static route(s) has been successfully retrieved from the IP forwarding
table.
<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::DEST=<destination>,NETMASK=<netmask>[,INTERFACE=<TL_aid>][,IFNAME=<IfName>
][,NEXTHOP=<next_hop>],ADVERTISE=<advertise>"
<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.147 RTRV-STAT-RTE Parameters

Parameter Value(s) Definition
destination Format for the IP address is: A double All static routes to the destination is retrieved.
quoted string representing the IPv4
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

netmask [0-255].[0-255].[0-255].[0-255] The netmask is bitwise 'AND'ed with the destination IP address
of the packet and compared with the 'destination' field of this IP
forwarding table entry.

TL_aid TL-1-[1-512]-[1-1500] Specifies the local host interface (TL) through which the IP
packet egresses.

Page 30-1316 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.147 RTRV-STAT-RTE Parameters (Continued)

Parameter Value(s) Definition
next_hop [0-255].[0-255].[0-255].[0-255] Specifies the IP address of the next_hop to be taken by the IP
packet en route to the destination.

advertise YES When set to YES, the static route is advertised in the routing
NO protocol.
For OSPF, the static route is advertised as an AS external route,
and OSPF must be configured as an ASBR.

Example
The following example retrieves the static route(s) in the NE:
RTRV-STAT-RTE:::AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^"::DEST=192.168.2.0,NETMASK=255.255.255.0,INTERFACE=TL-1-1-7,
NEXTHOP=192.168.2.50,ADVERTISE=YES"
^^^"::DEST=192.168.5.0,NETMASK=255.255.255.0,INTERFACE=TL-1-1-8, ADVERTISE=NO";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-STAT-RTE
ENT-STAT-RTE
RTRV-RTE-ALL
ED-STAT-RTE

76.MTFP50/30, Rev B January 2018 Page 30-1317

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SW

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SW command instructs the network element (NE) to retrieve the attributes of the NE software currently
operating on the network element.

Use the RTRV-SWVER and RTRV-FPGAVER commands to retrieve the current software patch level and firmware
versions operating on modules in the NE.

Command Format
RTRV-SW:[tid]:[<sw_aid>]:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<sw_aid>::VEND=<vendor>,SWTYPE=<product>,SWVER=<software_ver>,PATCHLEVEL=<pa
tch_level>[,SWCONTXT=<sw_context>],SIZE=<file_size>,LOCATION=<active_sw_director
y>,LASTUPDATE=<date_of_last_update>,PATH=<upgrade_to_software_ver>:<pst>,[<sst>]
"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.148 RTRV-SW Parameters

Parameter Value(s) Definition
sw_aid SW-1 EntityID-SWID

vendor CORIANT Indicates the vendor name of this NE.

product MTERA Indicates the network element family this software belongs to.
MTERA8

software_ver One to 11 alphanumeric characters. Indicates the software version currently running on this
particular NE. Following the format FP<x>.<y>.<z>, where
<x>.<y>.<z> is the feature package values. <x> is a double digit
value, <y> & <z> are single digit values.

patch_level [0-255] Indicates the highest patch level installed in the NE. Patch level
0 is the initial feature package release (that is,, no patches).

sw_context One to 20 alphanumeric characters Includes additional information about the number of the software
load used during the load compilation. For example: GP310.

file_size One to 20 alphanumeric characters Indicates the size of the software release as it is installed on the
disk in "Bytes".

active_sw_dire an url accord with Windows path Indicates the NE directory where the NE software is located.
ctory naming convention

Page 30-1318 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.148 RTRV-SW Parameters (Continued)

Parameter Value(s) Definition
date_of_last_u yyyy-mm-dd-hh-mm-ss Indicates the date at which the software was compiled.
pdate

upgrade_to_so One to 11 alphanumeric characters. Indicates the software version that is used to upgrade this
ftware_ver particular NE.
NONE is displayed when no valid upgrade is started (no
upgrade files have been downloaded to the NE).

pst IS-NR Indicates the primary state and primary state qualifier of the
IS-ANR entity.
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- ANR: abnormal

sst SWDL Indicates the secondary state of the entity.

- SWDL: software upgrade in-progress.

Example
RTRV-SW:CORIANT1::AM0209;

Possible System Response

CORIANT1 07-10-02 03:20:21

M AM0209 COMPLD

"SW-
1::VEND=CORIANT,SWTYPE=MTERA,SWVER=\"FP2.0.0\",PATCHLEVEL=2,SWCONTXT=\"NZ118\",S
IZE=279778705,LOCATION=\"/ata0/IMAGES/ACTIVE/\",LASTUPDATE=\"2011-07-30 02-10-
15\",PATH=\"NONE\":IS-NR,"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-NETYPE

76.MTFP50/30, Rev B January 2018 Page 30-1319

22. Retrieve Commands TL1 Command Reference Manual

RTRV-SWVER

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SWVER command instructs the network element (NE) to retrieve the software version and software
patch level installed on modules in the NE.

The software version number and software patch level of the module are retrieved along with a status indication. It
is possible for some modules to be up-to-date and others not. This depends on the current feature package and the
software patch history of each module.

This command provides additional information not available in the RTRV-INV command which informs if the module
is running the current software version.

The RTRV-SWVERMAP command can be used to retrieve the current software patch level available for each
module type in the NE.

Use the RTRV-SW command to retrieve information regarding the NE feature package software version.

Entering a software status (STATUS) on the command line will filter the command output and shows only modules
with a matching software status.

This command only supports modules that can be software patched.

Restrictions and Exceptions

• AID is mandatory (cannot be blank) unless ALL is specified.

• When ALL is specified instead of an AID, the STATUS parameter will display both up-to-date and out-
of-date modules.

Command Format
RTRV-SWVER:[tid]:{<eqpt_aid>|ALL}:ctag[:::STATUS=<status>];

Proper System Response

<header>

M^^<ctag>^COMPLD

^^^"<eqpt_aid>::VERSION=<software_version>,PATCHLEVEL=<patch_level>,STATUS=<stat
us>"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1320 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.149 RTRV-SWVER Parameters

Parameter Value(s) Definition
eqpt_aid MFAB-20-[5-6, 8-9, 11-12, 17-20] EntityID-ShelfID-SlotID
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
SSM2S-20-[1-16]
STPM-20-[25,24]
STPM8-20-[13,14]

status NOT_CURRENT Module software and patch status.

CURRENT
UPGRADE - NOT_CURRENT, modules has out-of-date software patch
NA levels.
- CURRENT, modules has current software patch levels.
- UPGRADE, module software is being upgraded.
- NA, module software version is 'Not Available'.

If status is not entered the system defaults to showing all status

information.

software_versi One to 11 alphanumeric characters. Indicates the software version currently running on this
on particular NE. Following the format FP<x>.<y>.<z>, where
<x>.<y>.<z> is the feature package values. <x> is a double digit
value, <y> & <z> are single digit values.

patch_level [0-255] or NA Indicates the software patch level installed and running on the
module. Patch level 0 is the initial feature package release (no
patches).

'NA' could be returned when 'Not Available' or the module is

being patched and before the module has its load committed to
flash.

Example
RTRV-SWVER:CORIANT1:ALL:MK003;

Possible System Response

^^^CORIANT1^11-02-02^03:20:21

M^^MK003^COMPLD

^^^"OSM2C-20-1::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=0,STATUS=CURRENT"
^^^"STPM-20-24::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=1,STATUS=NOT_CURRENT"
^^^"STPM-20-25::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=2,STATUS=CURRENT"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-1321

22. Retrieve Commands TL1 Command Reference Manual

Related Commands
RTRV-INV
RTRV-SWVERMAP

Page 30-1322 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-SWVERMAP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SWVERMAP command instructs the network element (NE) to retrieve the current software patch level
available for each module type in the NE.

Use the RTRV-SWVER command to retrieve the software version and software patch level installed on modules
and in the NE.

Use the RTRV-SW command to to retrieve information regarding the NE feature package software version.

This command only supports modules that can be software patched.

Command Format
RTRV-SWVERMAP:[tid]::ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD
^^^"<module_type>::VERSION=<latest_software_ver>,PATCHLEVEL=<type_patch_level>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.150 RTRV-SWVERMAP Parameters

Parameter Value(s) Definition
module_type Indicates the type of module that is populated in this slot in
accordance to the field "module type" in the EEPROM.
When the information is unavailable the system returns NA (Not
Available) or UNKNOWN.

software_versi One to 11 alphanumeric characters. Indicates the software version currently running on this
on particular NE. Following the format FP<x>.<y>.<z>, where
<x>.<y>.<z> is the feature package values. <x> is a double digit
value, <y> & <z> are single digit values.

patch_level [0-255] or NA Indicates the software patch level installed and running on the
module. Patch level 0 is the initial feature package release (no
patches).

Example
RTRV-SWVERMAP:::ctag;

76.MTFP50/30, Rev B January 2018 Page 30-1323

22. Retrieve Commands TL1 Command Reference Manual

Possible System Response

^^^CORIANT1^02-02-02^03:20:21

M^^ctag^COMPLD

^^^"OSM2C::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=0"
^^^"OSM1S::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=0"
^^^"OSM2S::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=0"
^^^"OADMRS20::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=0"
^^^"OCC::VERSION=\"FP2.0.0SZ391\",PATCHLEVEL=0"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-SWVER
RTRV-INV

Page 30-1324 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-SYNC

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-SYNC command instructs the network element (NE) to retrieve the synchronization status, the
references clock status and the protection switching status (source locked, system timing status for example,
Locked, HoldOver, Free Running,and so on).

Command Format
RTRV-SYNC:[tid]:<sync_aid>:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^"<sync_aid>::SYNCSTATUS=<syncstatus>[,REFCLK1=<refclk1>][,REFCLK1STATUS=<refc
lk1status>][,REFCLK1QL=<refclk1qualitylevel>][,REFCLK2=<refclk2>][,REFCLK2STATUS
=<refclk2status>][,REFCLK2QL=<refclk2qualitylevel>]:<pst>,<sst>"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.151 RTRV-SYNC Parameters

Parameter Value(s) Definition
sync_aid SYNC-20-1 EntityID-ShelfID-SYNCID

syncstatus Locked It is used to indicate the system PLL's status:

Holdover - Free-running
Free-running - Holdover
- Lock

refclk1 T1-20-[15,23,26]-[1,2], Indicates the selected reference clock source 1

E1-20-[15,23,26]-[1,2],
2MH-20-[15,23,26]-[1,2],
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

76.MTFP50/30, Rev B January 2018 Page 30-1325

22. Retrieve Commands TL1 Command Reference Manual

Table 22.151 RTRV-SYNC Parameters (Continued)

Parameter Value(s) Definition
refclk1status NA Indicates the status of the selected reference clock source 1
NR-ACT - NA: Status is unavailable.
NR-STBY - NR-ACT: normal, active
SF - NR-STBY: normal, standby. Note: when both reference clocks
are NR-STBY, it means the NE does not lock to any reference
clock although there are reference clocks available;
- SF: signal failure. Note: signal failure is a failure of the facility
(such as LOS, LOF or link down and so on) or a failure caused
by system internal transmission (such as loss caused by BP
broken) or a failure caused by out of range frequency offset.

refclk1qualityle NA Indicates the QL value of the selected reference clock source 1

vel PRS - NA: no quality level information available.
ST2 QL value:
TNC - Option II: QL-PRS, QL-ST2, QL-TNC, QL-ST3E, QL-ST3, QL-
ST3E SMC, QL-ST4, QL-PROV, QL-DUS
ST3 - Option I: QL-PRC, QL-SSU-A, QL-SSU-B, QL-SEC, QL-DNU
SMC
ST4
PROV
DUS
PRC
SSU-A
SSU-B
SEC
DNU

refclk2 T1-20-[15,23,26]-[1,2], Indicates the selected reference clock source 2

E1-20-[15,23,26]-[1,2],
2MH-20-[15,23,26]-[1,2],
NA,
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

refclk2status NA Indicates the status of the selected reference clock source 2

NR-ACT - NA: Status is unavailable.
NR-STBY - NR-ACT: normal, active
SF - NR-STBY: normal, standby. Note: when both reference clocks
are NR-STBY, it means the NE does not lock to any reference
clock although there are reference clocks available;
- SF: signal failure. Note: signal failure is a failure of the facility
(such as LOS, LOF or link down and so on) or a failure caused
by system internal transmission (such as loss caused by BP
broken) or a failure caused by out of range frequency offset.

Page 30-1326 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.151 RTRV-SYNC Parameters (Continued)

Parameter Value(s) Definition
refclk2qualityle NA Indicates the QL value of the selected reference clock source 2
vel PRS - NA: no quality level information available.
ST2 QL value:
TNC - Option II: QL-PRS, QL-ST2, QL-TNC, QL-ST3E, QL-ST3, QL-
ST3E SMC, QL-ST4, QL-PROV, QL-DUS
ST3 - Option I: QL-PRC, QL-SSU-A, QL-SSU-B, QL-SEC, QL-DNU
SMC
ST4
PROV
DUS
PRC
SSU-A
SSU-B
SEC
DNU

pst IS-NR Indicates the primary state and primary state qualifier of a
module.
Possible values for PST:
- IS: In-Service
Possible values for PSTQ:
- NR: normal

sst NOREQ Indicates the secondary state of a module.

MANTOSEC - NOREQ (no request.)
MANTOPRI - MANSWON (manual switch is in operational)
DNR - DNR (Do not revert)
SFONPRI
SFONSEC

Example
RTRV-SYNCSW:CORIANT1:SYNC-20-1:AM0074;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0074 COMPLD

^^^"SYNC-20-1:: SYNCSTATUS=Locked,REFCLK1=STM16-20-1-1,REFCLK1STATUS=NR-
ACT,REFCLK1QL=QL-PRC,REFCLK2=STM16-20-2-4,REFCLK2STATUS=NR-STBY,REFCLK2QL=QL-
SEC:IS-NR, NOREQ";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
OPR-SYNCSW
RLS-SYNCSW
ENT-SYNC
DLT-SYNC
ED-SYNC

76.MTFP50/30, Rev B January 2018 Page 30-1327

22. Retrieve Commands TL1 Command Reference Manual

RTRV-T1

Command Changes Since Previous Feature Package

• None

Description
Command instructs the network element (NE) to retrieve the attributes of the T1 facility providing an External
Synchronization reference.

Restrictions
• The facility AID must always correspond to the facility type.

Command Format
RTRV-T1:[tid]:T1_aid:ctag:::[ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState/sst>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>,LINECDE=<LineCode>,FMT=<FrameFormat>,TXREF=<tx_r
ef>,RXSSM=<rx_ssm>,TXSSM=<tx_ssm>,
QLOVERRIDE=<qualityLevelOverride>,TERM=<terminationT1>,TXREFSTATUS=<Txref_status
>,ALMPF=<almProfile>,LOOPPRVT=<loopPrevention>:<pst>,[<secondaryState/
sst>]"<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.152 RTRV-T1 Parameters

Parameter Value(s) Definition
T1_aid T1-20-[15,23,26]-[1,2] EntityID-ShelfID-SlotID-PortID
T1OUT-20-[15,23,26]-[1,2]

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

editablePrimar IS Indicates the primary state of a module.

yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

secondaryStat ACTTMG Indicates the secondary state of a module.

e/sst FAF - ACTTMG: active synchronization reference
MT - FAF: facility failure
NALMNR - MT: maintenance
NALMCD - NALMQI: Not alarmed qualified inhibit
SGEO - SGEO: supporting entity outage
STBYTMG - STBY: standby synchronization reference

Page 30-1328 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.152 RTRV-T1 Parameters (Continued)

Parameter Value(s) Definition
LineCode AMI Indicates the line code for a T1 facility. Possible values are
B8ZS Alternate Mark Inversion (AMI) or Bipolar with 8 zero
substitution (B8ZS).

FrameFormat SF Indicates the digital signal frame format of a T1 facility. Possible

ESF values are Extended Superframe (ESF), Superframe (SF), or no
framing (NONE).

tx_ref NA, Indicates the derived source signal timing the output
SYNC-20-1, synchronization reference. Applicable only to output
OC3-20-[1-16]-[1-32], synchronization references.
OC12-20-[1-16]-[1-32],
OC48-20-[1-16]-[1-32],
OC48-20-[1-16]-99-[7-30],
STM1-20-[1-16]-[1-32],
STM4-20-[1-16]-[1-32],
STM16-20-[1-16]-[1-32],
STM16-20-[1-16]-99-[7-30],
OC192-20-[1-16]-[1-40],
OC192-20-[1-16]-99-[1-6],
STM64-20-[1-16]-[1-40],
STM64-20-[1-16]-99-[1-6]

rx_ssm PRS Indicates the quality of the clock that is received on the T1
STU signal.
ST2
TNC
ST3E
ST3
SMC
ST4
PROV
DUS
NA

tx_ssm PRS Indicates the quality of the clock that is tranmitted on the T1
STU output signal.
ST2
TNC
ST3E
ST3
SMC
ST4
PROV
DUS
NA

qualityLevelOv DISABLED Indicates the synchronization signal quality level that is

erride PRS associated with the specified synchronization facility instead of
ST2 the value received in the synchronization status message. This
TNC allows to override the received synchronization quality level.
ST3E When set to DISABLED, the system uses the quality level
ST3 received in the synchronization status message.
SMC
ST4
PROV
DUS

terminationT1 100 Indicates the facility termination.

76.MTFP50/30, Rev B January 2018 Page 30-1329

22. Retrieve Commands TL1 Command Reference Manual

Table 22.152 RTRV-T1 Parameters (Continued)

Parameter Value(s) Definition
Txref_status Normal Indicates the status of the selected tx reference
SF - Normal: normal
- SF: signal failure. Note: signal failure is a failure of the facility
(such as LOS, LOF or link down and so on) or a failure caused
by system internal transmission (such as loss caused by BP
broken) or a failure caused by out of range frequency offset.

loopPrevention DISABLED Specifies the loop prevention function of the entity.

ENABLED Enable: The SSM of output synchronization is forced to DNU
when the tx_ref is SYNC-20-1 and the SYNC-20-1 source is the
same input synchronization port
Disable: The SSM of output synchronization follows the tx_ref
and squelch result. It does not consider the status of the tx_ref
entity.

pst IS-NR Indicates the primary state and primary state qualifier of a
IS-ANR module.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

tx_sqlch AIS Indicates output synchronization reference when squelch is

DNU applied. Applicable only to output synchronization references.
SQLCH
SSM

ql_min PRS Indicates the QL threshold of the derived source signal timing
ST2 the output synchronization reference when it is SSM squelch
TNC mode. Applicable only to output synchronization references.
ST3E
ST3
SMC
ST4
PROV
DUS

Example
RTRV-T1:CORIANT1:T1-20-14-1:CT0181;

Possible System Response

CORIANT1 15-03-14 03:20:21
M CT0181 COMPLD
"T1-20-14-1::LINECDE=B8ZS,FMT=ESF,RXSSM=STU,QLOVERRIDE=DNU,TERM=100,ALMPF=99:IS-
NR,";

Page 30-1330 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ED-T1
ENT-T1

76.MTFP50/30, Rev B January 2018 Page 30-1331

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TCA-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-TCA-{X} command instructs the network element (NE) to return reported instance of threshold violations
within the current period for selected facility entity.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): GBEP, TGLAN, FGE, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L,
OCH-P, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4,
OTUC2, OTUC3, OSC, STS1, STS3C, STS12C, STS48C, STS192C.

The following facilities do support PM but do not have TCA for some MONTYPES: OMS (No TCA for OPR/OPT
MONTYPES); GBEP/OC3/OC12/OC48/OC192/TGLAN/FGE/HGE (No TCA for PSC/PSD MONTYPES).

Restrictions and Exceptions

• The Facility AID must always correspond to the Facility type.

• When ALL is used as a second modifier, possible value for AID can only be "ALL" or blank. In this case,
it will address all entities except for STSn, and ODUk montypes.

• AID is mandatory (can not be blank) unless second modifier is ALL.

• When no TCATYPE is specified, command response will include values for all possible threshold
violations supported by the facility.

• UTIL Montype is a gauge that supports HT only.

Command Format
RTRV-TCA-{<fac_type>|ALL}:[tid]:[{<fac_aid>|ALL}]:ctag::[<tcatype>],
[<locn>],[<dirn>],[<tmper>];

Proper System Response

If there is no threshold violation to report:

<header>
M^^<ctag> COMPLD
;

Proper System Response

If there is at least one threshold violation to report:

<header>
M <ctag> COMPLD
"{<fac_aid>},<aidtype>:<condtype>,<ocrdat>,<ocrtm>,<locn>,<dirn>,<tmper>"
<cr><lf>*
;

Page 30-1332 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.153 RTRV-TCA-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1

76.MTFP50/30, Rev B January 2018 Page 30-1333

22. Retrieve Commands TL1 Command Reference Manual

Table 22.153 RTRV-TCA-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) OTU1-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-PortID
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

tcatype T-x Specifies the type of threshold violation for the specified entity.
T-x-HT - T-x: To be used with one or more AIDs to request the return of
T-x-LT reported threshold violations for register <montype> x.
- T-x-HT: To be used with one or more AIDs to request the
return of reported high threshold violations for gauge <montype>
x.
- T-x-LT: To be used with one or more AIDs to request the return
of reported low threshold violations for gauge <montype> x.
A null value causes all threshold crossings to be retrieved.

locn NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end
location. Only NEND is supported.

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies both applicable directions:
TDTN one type of TDTC and one type of TDTN.
RCV - TDTC specifies Transmit direction toward Customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.
- NA indicates Not applicable (valid in the response only).

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.
The system defaults to 15-minute increments.

Page 30-1334 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.153 RTRV-TCA-{X} Parameters (Continued)

Parameter Value(s) Definition
aidtype GBEP Specifies the type of the access identifier of the entity.
FGE
HGE
OC3
OC12
OC48
OC192
OCH
ODUF
ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
OTU1
OTU2
OTU4
OTUC2
OSC
TGLAN

condtype T-x Specifies the type of performance monitoring for the specified
T-x-HT entity.
T-x-LT The valid values for <condtype> are:
For Registers:
- T-x, which indicates a threshold violation for <montype> x.
For Gauges:
- T-x-HT, which indicates a high threshold violation for
<montype> x.
- T-x-LT, which indicates a low threshold violation for
<montype> x.

ocrdat MOY-DOM format:(1)MOY = 1 - Indicates the current date when the threshold violation occurred.
12.(2)DOM = 1 - 31.

ocrtm HH-MM-SS: (1) HH = 00 - 23 (2) MM = Indicates the time within the current period when the threshold
00 - 59 (3) SS = 00 - 59 violation occurred.

Example
RTRV-TCA-OTU2::OTU2-20-1-2:ctag::,,,15-MIN;

Possible System Response

CORIANT 14-11-04 14:44:25
M ctag COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-TH-{X}
SET-TH-{X}

76.MTFP50/30, Rev B January 2018 Page 30-1335

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TCAMODE-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-TCAMODE-{X} command instructs the network element to retrieve the Threshold Crossing Alert (TCA)
status of the selected facility entity.
The TCA mode of this entity was set with the SET-TCAMODE-{X} command.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): GBEP, TGLAN, FGE, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L,
OCH-P, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4,
OTUC2, OTUC3, OSC, STS1, STS3C, STS12C, STS48C, STS192C.

The following facilities do support PM but do not have TCA for some MONTYPES: OMS (No TCA for OPR/OPT
MONTYPES); GBEP/OC3/OC12/OC48/OC192/TGLAN/FGE/HGE (No TCA for PSC/PSD MONTYPES).

Restrictions and Exceptions

• The Facility AID must always correspond to the Facility type.

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-TCAMODE-<fac_type>:[tid]:{<fac_aid>|ALL}:ctag;

Proper System Response:

<header>
M <ctag> COMPLD
"<fac_aid>:<locn>,<modetype>,<tcastate>"*
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1336 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.154 RTRV-TCAMODE-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1

76.MTFP50/30, Rev B January 2018 Page 30-1337

22. Retrieve Commands TL1 Command Reference Manual

Table 22.154 RTRV-TCAMODE-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS1-20-[1-16]-[1-30]-[1-192], STS1- EntityID-ShelfID-SlotID-PortID
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

locn NEND Specifies the location of the event/occurrence in the system:

- NEND specifies a near-end location.

modetype ALL Indicates the type of performance monitoring control attribute:

- ALL indicates all PM montypes for the specified AID.

tcastate ON Indicates TCA are being reported or not:

OFF - ON indicates TCA are reported.
- OFF indicates TCA are not reported.

Example
RTRV-TCAMODE-OTU2::OTU2-20-1-2:CTG01::;

Possible System Response

CORIANT 14-11-04 14:46:21
M CTG01 COMPLD
"OTU2-20-1-2:NEND,ALL,OFF"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
SET-TCAMODE-{X}

Page 30-1338 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-TCE-TL

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-TCE-TL command instructs the network element (NE) to retrieve the status of Transport Capability
Exchange for a specific Topological Link (TL).

The Hello Timers used for adjacency maintenance are specified using the HELLO and DEADROUTER attributes
found in the TL's associated LINKPF.

If the Discovery Agent is Out-Of-Service (OOS), this is the last negotiated information. When the Discovery Agent
is returned to In-Service (IS), this information is renegotiated if the link has changed state since the DA went OOS.

Restrictions and Exceptions

• RTRV-TCE-TL is only supported on non-IP Topological Links.

• RTRV-TCE-TL is only supported on Topological Links with NDISCOVERY set to ENABLED.

• The first name-defined parameter must not include a leading comma.

• The command is denied if TL_aid is not ALL and the specified TL has no neighbor discovery
information. The neighbor discovery information will only be available when the neighbor discovery
process has been started with all preconditions met (for example,, the TL is set to IS and the fiber is
connected).

Command Format
RTRV-TCE-TL:[tid]:{<TL_aid>|ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<TL_aid>::[LCPSTAT=<lcpState>][,MPSTAT=<lcpState>],MGTNDOM=<mgtDomain>,MGTNS
YSNAM=<nodeName>,MGTNPTNAM=<portName>[,CPHSTAT=<lcpState>],RAID=<RoutingAreaID>[
,CPCSTAT=<lcpState>],NNID=<NeighborNodeId>,NIFINDEX=<NeighborIfIndex>,SIGPROT=<s
igProto>,NSIGADDR=<NeighborSignalingAddr>,NSIGID=<NeighborSignalingId>"

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.155 RTRV-TCE-TL Parameters

Parameter Value(s) Definition
TL_aid TL-[1,3]-[1-512]-[1-1500] EntityID-NPID-NodeID-TLID

76.MTFP50/30, Rev B January 2018 Page 30-1339

22. Retrieve Commands TL1 Command Reference Manual

Table 22.155 RTRV-TCE-TL Parameters (Continued)

Parameter Value(s) Definition
lcpState START Identifies the state of the respective link capability exchange.
CLOSED Separate state exists for each link capability exchange.
STOPPED
CLOSING LCP (TCE Adjacency Maintenance) exchange must achieve the
STOPPING OPEN state before MP or CPH exchange is attempted.
REQSENT MP (TCE Management Plane) exchange must achieve the
ACKRCVD OPEN state before CPH exchange is attempted.
ACKSENT CPH (TCE Control Plane Hierarchy) exchange must achieve the
OPENED OPEN state before CPC is attempted.
CPC (TCE Control Plane Configuration) exchange must achieve
the OPEN state for Neighbor Discovery to complete on a TL.

mgtDomain A double quoted string consisting of 0 Identifies the Management Domain Name received.
to 20 printable characters, not
including the quotes. String is empty when no NeighborNodeID proposal has been
received from the peer during this TCE negotiation session.

nodeName A double quoted string consisting of 0 Identifies the Management Node Name received.
to 20 printable characters, not
including the quotes. String is empty when no NeighborNodeID proposal has been
received from the peer during this TCE negotiation session.

portName A double quoted string consisting of 0 Identifies the Management Port Name received.
to 20 printable characters, not
including the quotes.

RoutingAreaID [0-255].[0-255].[0-255].[0-255], NA Identifies the neighbor's proposed router area for this TL. Field
shows NA when no NeighborNodeID proposal has been
received from the peer during this TCE negotiation session.

NeighborIfInde [0-255].[0-255].[0-255].[0-255], NA Identifies the neighbor's proposed ifIndex. Field shows NA when
x no NeighborIfIndex proposal has been received from the peer
during this TCE negotiation session.

sigProto OIF-ENNI-V1 Identifies the neighbor's proposed Signaling Protocol for use on
OIF-ENNI-V2 the link. Field is empty when no Signaling Protocol proposal has
INNI-V1 been received from the peer during this TCE negotiation
INNI-V2 session.
NONE

NeighborSigna [0-255].[0-255].[0-255].[0-255], NA Identifies the neighbor's proposed signaling address. Field

lingAddr shows NA when no signaling address proposal has been
received from the peer during this TCE negotiation session.

NeighborSigna [0-255].[0-255].[0-255].[0-255], NA Identifies the neighbor's proposed signaling ID. Field shows NA
lingId when no signaling ID proposal has been received from the peer
during this TCE negotiation session.

NeighborNode [0-255].[0-255].[0-255].[0-255], NA Identifies the neighbor's proposed nodeID. Field shows NA

ID when no NeighborNodeID proposal has been received from the
peer during this TCE negotiation session.

Example
RTRV-TCE-TL:CORIANT1:TL-3-2-3:AM0011;

Page 30-1340 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

^^^CORIANT1 06-05-15 02:09:11

M AM0011 COMPLD

^^^\"TL-3-2-3::
LCPSTAT=OPEN,MPSTAT=OPEN,MGTNDOM=\"USEast\",MGTNSYSNAM=\"CHCGILUX01\",MGTNPTNAM=
\"OC48-1-1-
1\",CPHSTAT=OPEN,RAID=0.0.0.100,CPCSTAT=OPEN,NNID=20.1.1.1,NIFINDEX=42.65.112.34
,SIGPROT=\"INNI-V1\",NSIGADDR=30.1.1.1,NSIGID=40.1.1.1\"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TL
RTRV-LADJ-TL
RTRV-LINKPF

76.MTFP50/30, Rev B January 2018 Page 30-1341

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TCPIP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-TCPIP command instructs the network element (NE) to retrieve the attributes a TCPIP entity.

Restrictions and Exceptions

• The first name-defined parameter entered after the ctag must not have its leading comma.

Command Format
RTRV-TCPIP:[TID]:<tcpip_aid>:ctag:::[,SHOWFP=<showFP>][,SHOWKEY=<showKey>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<tcpip_aid>::DADCNT=<dupAddrDand so
onnt>,DADTMR=<dupAddrDetTmr>,FTP=<ftp>,HTTP=<http>,TELNET=<telnet>,SSHAUTH=<sshA
uthentication>,sshKeyStrength=<sshKeyStrength>,ASINTRFC=<AppSrcInterface>[,PUBLI
CKEYFP=<publicKeyFingerprint>][,PUBLICKEY=<publicKey>]"<cr><lf>

Note: DADCNT and DADTMR don't apply to mTera.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.156 RTRV-TCPIP Parameters

Parameter Value(s) Definition
tcpip_aid TCPIP-1 EntityID-TCPIPID

showFP HEX Specifies whether or not to display the fingerprint of the system
BABBLE public key string stored in the database and what encoding
NO scheme should be used to display the fingerprint.
Default: NO HEX to display the fingerprint encoded in hex.
BABBLE to display the fingerprint encoded in Bubble Babble.
NO to not display the fingerprint.

showKey YES Specifies whether or not to display the system public key string
NO stored in the database.
Default: NO YES to display the public key string.
NO to not display the public key string.

dupAddrDand [0-600] Specifies the number of neighbor solicitation messages sent

so onnt when performing duplicate address detection on the interface.
Setting the value to 0 disables this attribute.

Page 30-1342 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.156 RTRV-TCPIP Parameters (Continued)

Parameter Value(s) Definition
dupAddrDetT [1000-3600000] Specifies the time interval between neighbor solicitation
mr messages sent when performing duplicate address detection.

ftp ALW Specifies whether the file transfer application is allowed for both
SECURE nonsecure or secure mode, only secure mode or inhibited.
INH ALW, to allow both non-secure and secure mode.
SECURE, to allow secure mode only.
INH, to inhibit the terminal application.

http ALW Specifies whether the http server is allowed for both non-secure
INH or secure mode, only secure mode or inhibited.
ALW, to allow both non-secure and secure mode.
SECURE, to allow secure mode only.
INH, to inhibit the terminal application.

telnet ALW Specifies whether telnet is allowed for both non-secure or

SECURE secure mode, only secure mode or inhibited.
INH ALW, to allow both non-secure and secure mode.
SECURE, to allow secure mode only, that is,, only SSH.
INH, to inhibit the application.

sshKeyStrengt 512,1024,2048 Specifies the strength of the key for regenerating the private/
h public key pair in the SSH or sFTP.
Specifying this parameter causes the existing keys in the
system to be replaced with newly generated private/public key
pair of the specified key strength. There is no change to the
existing keys if this parameter is not specified.

AppSrcInterfac NA, The Application Source Interface is used by an application (for

e TL-1-[1-512]-[1-1500] example, RADIUS) to identify the NE IP address that is used for
the application.

The TL AID is used to determine the NE address that is used for

an application.

A setting of NA (Not Applicable) indicates that no Application

Source Address is specified.

publicKeyFing A double quoted string representing 0 Specifies the fingerprint of the system's public key which is used
erprint to 128 ASCII character string. with SSH or sFTP protocols.

publicKey In hex, x:x:x:x:x:x:x:x, where x Specifies the system's public key for use with SSH or sFTP
represents a 2 digit hexadecimal protocols in the ssh2 format.
number. In babble, x-x-x-x-x-x-x-x-x-
x-x, where x represents 5
alphanumeric characters.

Example
Retrieve the TCP/IP entity provisioned:
RTRV-TCPIP:CORIANT1:TCPIP-1:MYCTAG;

Possible System Response

^^^CORIANT1 10-02-10 07:53:00

M MYCTAG COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-1343

22. Retrieve Commands TL1 Command Reference Manual

"TCPIP-
1::DADCNT=,DADTMR=,FTP=INH,HTTP=ALW,TELNET=ALW,SSHAUTH=ALL,sshKeyStrength=1024",
ASINTRFC=NA

Example
Display secure communication service settings, including the system public key fingerprint (in Bubble Babble
format) and the system public key.
RTRV-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::SHOWFP=BABBLE;

Possible System Response

^^^CORIANT1 10-02-10 07:58:00

M MYCTAG COMPLD

"TCPIP-1::DADCNT=,DADTMR=,FTP=SECURE,HTTP=ALW,SSHAUTH=ALL,
sshKeyStrength=1024,ASINTRFC=NA,PUBLICKEYFP=\"ugev-soloh-tosor-vohac-bapok-
segof-fimym-nyhub-pucez-cugak-daxux\""

Example
Display secure communication service settings, including the public key fingerprint (in hex format).
RTRV-TCPIP:CORIANT1:TCPIP-1:MYCTAG:::SHOWFP=HEX;

Possible System Response

^^^CORIANT1 10-02-10 07:59:00

M MYCTAG COMPLD

"TCPIP-1::DADCNT=,DADTMR=,FTP=SECURE,HTTP=ALW,SSHAUTH=ALL,
sshKeyStrength=1024,ASINTRFC=NA,PUBLICKEYFP=\"e1:bd:f2:8b:2d:c1:03:e5:e1:26:66:c
1:a7:2e:bd\""

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TCPIP

Page 30-1344 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-TH-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-TH-{X} command instructs the network element (NE) to send the current threshold level of one or more
monitored parameters associated with the selected facility entity, for which violation will trigger an automatic
message. Note that these threshold levels may apply to one or more facilities in the NE.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): GBEP, TGLAN, FGE, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L,
OCH-P, OCH-OS), OTU1, OTU2, OTU4, OTUC2, OTUC3, OSC.

The following facilities do support PM but do not have TCA for some MONTYPES: OMS (No TCA for OPR/OPT
MONTYPES); GBEP/OC3/OC12/OC48/OC192/TGLAN/FGE/HGE (No TCA for PSC/PSD MONTYPES).

Restrictions and Exceptions

• The Facility AID must always correspond to the Facility type.

• When ALL is used as a second modifier, possible value for AID can only be "ALL" or blank. In this case,
it will address all entities.

• AID is mandatory (can not be blank) unless second modifier is ALL.

• When no MONTYPE is specified, command response will include values for all MONTYPES supported
by the facility.

• UTIL Montype is a gauge that supports HT only.

Command Format
RTRV-TH-{<fac_type>|ALL}:[tid]:[{<fac_aid>|ALL}]:ctag[::[<montype>],
[<locn>][,<tmper>]];

Proper System Response

<header>
M <ctag> COMPLD
^^^"<fac_aid>>[,<aidtype>]:<montype>,<locn>,<dirn>,<thlev>,<tmper>"* <cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1345

22. Retrieve Commands TL1 Command Reference Manual

Table 22.157 RTRV-TH-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

montype x,x-HT,x-LT Specifies the type of performance monitoring for the specified
entity.
- x: To be used to specify current threshold value for <montype>
x.
- x-HT: To be used to specify highest threshold value for gauge
<montype> x.
x-LT: To be used to specify lowest threshold value for gauge
<montype> x.

locn NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end location.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.
The system defaults to both 15-MIN and 1-DAY increments.

Page 30-1346 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.157 RTRV-TH-{X} Parameters (Continued)

Parameter Value(s) Definition
aidtype GBEP The access identifier contains one or more simple or compound
FGE parameters that uniquely identifies the selected entity within the
HGE NE.
OC3
OC12
OC48
OC192
OCH
OTU1
OTU2
OTU4
OTUC2
OTUC3
OSC
TGLAN

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - BTH specifies both applicable directions:
TDTN one type of TDTC and one type of TDTN.
RCV - TDTC specifies Transmit direction toward Customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
- TRMT specifies Transmit direction.
- NA indicates Not Applicable (valid in the response only).

thlev (1)-45 to 18446744073709551615 Indicates the threshold value of the performance-monitoring

(2)DFLT parameter.

Example
RTRV-TH-OTU2::OTU2-20-5-20:ctag::,,;

Possible System Response

CORIANT 14-11-04 02:35:02
M ctag COMPLD
"OTU2-20-5-20,OTU2:LOSS,NEND,TDTN,2,15-MIN"
"OTU2-20-5-20,OTU2:BE-FEC,NEND,TDTN,120479,15-MIN"
"OTU2-20-5-20,OTU2:UBE-FEC,NEND,TDTN,875,15-MIN"
"OTU2-20-5-20,OTU2:CV-OTU,NEND,TDTN,738,15-MIN"
"OTU2-20-5-20,OTU2:ES-OTU,NEND,TDTN,25,15-MIN"
"OTU2-20-5-20,OTU2:SES-OTU,NEND,TDTN,4,15-MIN"
"OTU2-20-5-20,OTU2:UAS-OTU,NEND,TDTN,10,15-MIN"
"OTU2-20-5-20,OTU2:LOSS,NEND,TDTN,8,1-DAY"
"OTU2-20-5-20,OTU2:BE-FEC,NEND,TDTN,11565963,1-DAY"
"OTU2-20-5-20,OTU2:UBE-FEC,NEND,TDTN,84000,1-DAY"
"OTU2-20-5-20,OTU2:CV-OTU,NEND,TDTN,70870,1-DAY"
"OTU2-20-5-20,OTU2:ES-OTU,NEND,TDTN,250,1-DAY"
"OTU2-20-5-20,OTU2:SES-OTU,NEND,TDTN,39,1-DAY"
"OTU2-20-5-20,OTU2:UAS-OTU,NEND,TDTN,10,1-DAY"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

76.MTFP50/30, Rev B January 2018 Page 30-1347

22. Retrieve Commands TL1 Command Reference Manual

Related Commands
RTRV-TCA-{X}
SET-TH-{X}

Page 30-1348 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-TL

Command Changes Since Previous Feature Package

• Add new secondary state of INCOMP

• Added OTUC2, OTUC3 as Resource.

Description
The RTRV-TL command instructs the network element (NE) to retrieve a topological link.

For the protected TL (e.g The Y-Cable FFP for OTUk facilities has to be created before the creation of a protected
OTUk TL), the states of both facilities is monitored by the system. The TL PST,SST state is displayed according to
these rules:

a) When both facilities are in IS state, the PST (in the PST-PSTQ format) of the TL is IS-NR;
b) When either protection or working facility is in OOS state (one facility of the FFP), the PST,SST of the TL is IS-
NR,SDEA.
c) When both facilities are in OOS state, the PST,SST of the TL is OOS-AU,FAF.

When using the "Transnet" based optical impairment algorithm (see ED-CPPF), an INCOMP secondary state
indicates the optical impairment parameters for the TL were not contained in the OPE data file. These links is treated
as having no available capacity until the INCOMP state is resolved by uploading a new OPE data file with the
required parameters for this TL. For L0 links that are included in the OPE data file but associated TLs have not been
created on the network element, RTRV-TL cannot be used to retrieve the TL/link.

Restrictions
• When ALL is used as an AID, information for all TL entities that matches the specified filtering
parameter(s) is retrieved.

• ALL cannot be used as an AID of NP or NODE as filtering parameters.

• The NE does not display NEMASK in the results if the NEADDRT parameter is setting to UNNUM.

• NP, NODE, RESOURCE and IFINDEX are mutually exclusive as filtering parameters, NP and NODE
does not show in response field.

• The RESOURCE_LAYER only applies to OCH-P TL.

• While the cost for interfaces that are in loopback (for example, STBL interfaces) may be configured with
a non-zero cost; consistent with IP control planes, IP interfaces that are in loopback is advertised as a
stub host with a cost of zero.

Command Format
RTRV-
TL:[tid]:{<tl_aid>|ALL}:ctag:::[RESOURCE=<Resource>][,IFINDEX=<IfIndex>][,NP=<np
_aid>][,NODE=<node_aid>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<tl_aid>::TLNAME=<TLname>,NEADDRT=<NearEndAddrType>,NEADDR=<NearEndAddr>[,NE
MASK=<NearEndMask>][,NEPTL=<NearEndParentTL>],COST=<Cost>,IFINDEX=<IfIndex>,NDIS
COVERY=<NeighborDiscovery>,NID=<NodeId>[,NIFINDEX=<NeighborIfIndex>][,NNID=<Neig

76.MTFP50/30, Rev B January 2018 Page 30-1349

22. Retrieve Commands TL1 Command Reference Manual

hborNodeId>],LINKPF=<LinkpfAID>[,NSIGADDR=<NeighborSignalingAddr>][,NSIGID=<Neig
hborSignalingId>],ROUTING=<Routing>,SIGNALING=<Signaling>[,RAID=<RouterAreaId>][
,SRLG=<Srlg>],LATENCYMODE=<LatencyMode>,LATENCY=<Latency>,CARRID=<CarrierId>[,PM
D=<Pmd>][,OSNR=<Osnr>][,FWMP=<FWMP>][,PDL=<Pdl>][,RCD=<ResidualCD>][,SPMN=<SpmNo
ise>][,XPMN=<XpmNoise>][,RESCLASS=<ResourceClass>][,RESOURCE=<Resource>][,IFNAME
=<IfName>][,RESOURCE_LAYER=<ResourceLayer>]:<PST>,[<SST>]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.158 RTRV-TL Parameters

Parameter Value(s) Definition
tl_aid TL-[1,3]-[1-512]-[1-1500] EntityID-NPID-NodeID-TLID

Resource IPPG-1, If the TL is assigned to a entity with a AID this parameter

MGTETH-20-[13,14,21,28]-[1-8], specifies the AID of the resource.
OC3-20-[1-16]-[1-32],
OC12-20-[1-16]-[1-32],
ODUF-20-[1-16]-[1-20]-[1-80],
ODU0-20-[1-16]-[1-32],
ODU0-20-[1-16]-[1-32]-[1-80],
OTU1-20-[1-16]-[1-32],
MGTINBANDETH-20-[10-16,1-7]-[1-
20],
OSCX-20-[10-16,1-7]-21-[2,1],OSCX-
20-[1-16]-1-[2,1],
PPPS-[20]-[1-16]-[1-30],
PPPS-[20]-[1-16]-99-[1-30],
PPPL-[20]-[1-16]-[1-30],
PPPL-[20]-[1-16]-99-[1-30],
PPPRS-[20]-[1-16]-[1-30],
PPPRS-[20]-[1-16]-99-[1-30],
PPPMS-[20]-[1-16]-[1-30],
PPPMS-[20]-[1-16]-99-[1-30],
OC48-20-[1-16]-[1-32],
OC192-20-[1-16]-[1-20],
TPOOL-20-[1-16]-[1-32],
ODU2-20-[1-16]-[1-40],
ODU2-20-[1-16]-[1-5]-[1-80],
ODU2E-20-[1-16]-[1-40],
ODU2E-20-[1-16]-[1-5]-[1-80],
OTU2-20-[1-16]-[1-40],
OCH-P-20-[1-16]-[1-40],
ODU4-20-[1-16]-[1-5],
ODU4-20-[1-16]-[1-2]-[1-3],
OTU4-20-[1-16]-[1-5],
ODU1-20-[1-16]-[1-32],
ODU1-20-[1-16]-[1-40]-[1-80],
OTUC2-20-[1-16]-[1-2],
OTUC3-20-[1-16]-1,
ODU3-20-[1-16]-[1-5]-[1-80]

Page 30-1350 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.158 RTRV-TL Parameters (Continued)

Parameter Value(s) Definition
Resource GCC0-20-[1-16]-[1-32], If the TL is assigned to a entity with a AID this parameter
(contd)' GCC1-20-[1-16]-[1-20], specifies the AID of the resource.
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC2-20-[1-16]-[1-20],
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80],
GCC12-20-[1-16]-[1-20],
GCC1-20-[1-16]-[1-4]-[B,C][1-80]-
[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-20]-
[A,B,C,D,E,Z,F][1-80],
GCC1-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[A,B,E,Z,F][1-32],
GCC1-20-[1-16]-[1-2]-[D][1-3]-
[A,B,C,E,Z,F][1-80]

IfIndex [0-255].[0-255].[0-255].[0-255] Specifies the If Index for this TL. This value is created by the
NE.

np_aid NP-[1,3] Specifies the network partition id of the TL.

node_aid NODE-[1,3]-[1-512] Specifies the node access identifier of the TL.

TLname A double quoted string consisting of 0 Specifies the Topological Link name.
to 30 printable characters, not Refer to section 2 for the applicable characters.
including the quotes.

NearEndAddrT NUM Specifies if this link is numbered or unnumbered.

ype UNNUM

NearEndAddr [0-255].[0-255].[0-255].[0-255] Identifies the near end address used for this link.

When NearEndAddrType=NUM, this is a mandatory parameter.

When NearEndAddrType=UNNUM, this parameter reflects the
value stored in the NearEndAddr parameter of the TL identified
by NearEndParentTL.

NearEndMask [0-255].[0-255].[0-255].[0-255] Specifies the near end mask for a numbered link.

When NearEndAddrType=UNNUM, this parameter reflects the

value stored in the NearEndMask parameter of the TL identified
by NearEndParentTL.

NearEndParen TL-[1,3]-[1-512]-[1-1500] The identifier used to address a TL entity. This attribute is used
tTL for an unnumbered TL.

Cost [1-4294967295] Specifies the cost for the link.

76.MTFP50/30, Rev B January 2018 Page 30-1351

22. Retrieve Commands TL1 Command Reference Manual

Table 22.158 RTRV-TL Parameters (Continued)

Parameter Value(s) Definition
NeighborDisco ENABLED Specifies whether or not neighbor discovery is used to learn the
very DISABLED neighbor parameters.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index. If this value is not specified the
x 0.0.0.0 is not a valid input value. NE may learn this value.

NeighborNode [0-255].[0-255].[0-255].[0-255] Specifies the neighbors node ID. If this value is not specified the
Id NE may learn this value.

LinkpfAID LINKPF-[91-99,1-20] Specifies the access identifier of the Link Profile.

NeighborSigna [0-255].[0-255].[0-255].[0-255] or Specifies the neighbors signaling address.

lingAddr NULL

NeighborSigna [0-255].[0-255].[0-255].[0-255] or Specifies the neighbors signaling ID.

lingId NULL

Routing ACTIVE Specifies if Routing is enabled and if so, if Routing is passive or

PASSIVE active.
DISABLED ACTIVE - This link is advertised and routing messages are
transported over this link.
PASSIVE - This link is advertised, routing messages are not
transported over this link.
DISABLED- This link is not advertised, routing messages are
not transported over this link.

Signaling ENABLED Specifies if Signaling is enabled.

DISABLED ENABLED - Signaling is used to reserve resources on this link.
DISABLED - Signaling is not used to reserve resources on this
link.

RouterAreaId [0-255].[0-255].[0-255].[0-255] Identifies the router area for this TL.

Srlg A double quoted input string of up to Specifies the Shared Risk Link Groups associated with this TL.
32 comma separated 4 byte hex
strings. Example:
"3E04990A,044D1A0C"

LatencyMode MANUAL MANUAL - the latency value is manually provisioned

DISABLED DISABLED - the latency parameter is not populated

Latency [0-65535] Specifies the latency accross this TL in Micro-Second.

CarrierId Is a string of length 1 to 30 characters. Specifies the carrier ID.

Refer to section 2 for the applicable characters.

Pmd [0-6500] Unit is in hundredths of Specifies the value for polarization mode dispersion.
picoseconds.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Osnr [0-8000] Unit is in hundredths of dB. Specifies the value for Optical Signal to Noise Ratio.

This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Page 30-1352 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.158 RTRV-TL Parameters (Continued)

Parameter Value(s) Definition
FWMP -8000 to -1500 Unit is in hundredth of Specifies the value for Four Wave Mixing crosstalk Power.
dB.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

Pdl NA or [0-100000] Unit is in one- Specifies the value for Polarization Dependent Loss.
hundred-thousandths
of dB. This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

ResidualCD NA or [-200000-2500000] Unit is in Specifies the value for Residual Chromatic Dispersion.
hundredth of ps/nm
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

SpmNoise NA or [0-56000] Unit is in one- Specifies the value for Self Phase Modulation - Noise.
hundred-thousandths of a Radian.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

XpmNoise NA or [0-112000] Unit is in one- Specifies the value for Cross-Phase Modulation - Noise.
hundred-thousandths of a Radian.
This parameter is advertised and used only when the CPPF for
this link has OPTPATHALG set to DISCRETE.† For all other
settings of OPTPATHALG, this parameter may be provided but
is ignored.

ResourceClas A double quoted 4 byte hex strings. 32-bit long bit-mapped field with each bit representing a specific
s resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
Empty string "" is displayed when RESCLASS is not specified or
after being reset.

Example bit-mapped resource class definitions:

""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

76.MTFP50/30, Rev B January 2018 Page 30-1353

22. Retrieve Commands TL1 Command Reference Manual

Table 22.158 RTRV-TL Parameters (Continued)

Parameter Value(s) Definition
IfName SINTF-1 If the TL is assigned to a entity without an AID this parameter
SINTF-2 specifies the interface name.
SINTF-3
The purpose of the stable interface is to provide a link whose
state is independent of port failures. Since the stable interface is
a logical interface and not associated with a physical port its
state is not affected by port failures.
SINTF-1/2/3 has this "stable" characteristic.
Stable Interface-1, the purpose is to ensure the TPCP RSVP
signaling controller and OSPF routing adjacencies specified in
the TPCP partition reference a TL associated with SINTF-1 so
that the transmission of signaling and routing messages are not
affected by port failures. Multiple entities can be assigned to
SINTF-1, but it prevents unnumbered TLs from being defined on
that interface.
Stable Interface-2, the purpose of associating a NULL TL with
an unnumbered SINTF-2 is to apply a TNA to a TL, then use
that TNA as a source or destination for a call to terminate at a
node (network interface) rather than on a client port.
Stable Interface-3, the purpose is to indicate the TPCP node
support the 2-port diverse connections call. One SINTF-3 TL is
created per one single node which supports 2-port call.

ResourceLaye OTU The OCH-P is a compound entity composed of three G.800

r TTPs: one each in the OCh, OTU and ODU layers. The
"ResourceLayer" parameter is used to identify the specific TTP
being referenced in this command.

PST IS-NR Indicates the primary state and primary state qualifier of a
OOS-AU module.
OOS-MA Possible values for PST:
OOS-AUMA - IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- AU: autonomous
- MA: maagement
- AUMA: autonomous management

SST INPROG Indicates the secondary state:

FAF - INPROG: In Progress - Entity is in the process of being
SDEA established.
DISC - FAF: Facility Failure - The associated transport facility has
DISC_FAIL failed.
INCOMP - SDEA: supported entity absent.
- DISC: The neighbor discovery is in progress.
- DISC_FAIL: The neighbor discovery is failed.
- INCOMP: Optical impairment parameters are not available

Example
Retrieve all TLs under TPCP partition per CORIANT1:
RTRV-TL:CORIANT1::ALL:100:::NP=NP-3;

Page 30-1354 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT1 12-03-20 05:48:58
M 100 COMPLD
^^^"TL-3-1-1::TLNAME=\"CORIANT1 TPCP stable
1\",NEADDRT=NUM,NEADDR=10.3.115.1,NDISCOVERY=DISABLED,NEMASK=255.255.255.255,COS
T=10,LINKPF=LINKPF-
94,ROUTING=PASSIVE,SIGNALING=DISABLED,RAID=0.0.0.40,SRLG=\"\",LATENCY=200,CARRID
=\"\",RESCLASS=\"\",IFNAME=SINTF-
1,IFINDEX=137.2.113.2,NID=21.3.115.1,LATENCYMODE=MANUAL,:IS-NR,"
^^^"TL-3-1-
2::TLNAME=\"\",NEADDRT=UNNUM,NEADDR=10.3.115.1,NDISCOVERY=DISABLED,NEPTL=TL-3-1-
1,COST=10,LINKPF=LINKPF-
2,ROUTING=DISABLED,SIGNALING=DISABLED,SRLG=\"\",LATENCY=200,CARRID=\"\",RESCLASS
=\"0000000F\",RESOURCE=OTU2-3-1-
1,IFINDEX=0.194.16.0,NID=21.3.115.1,LATENCYMODE=MANUAL,:OOS-AU,FAF";

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TL
ENT-TL
DLT-TL

76.MTFP50/30, Rev B January 2018 Page 30-1355

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TNALNKMAP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-TNALNKMAP command instructs the network element (NE) to retrieve entries from the TNA Link Map.

Restrictions
• If no parameters are specified, all calls supported by the NE is retrieved.

Command Format
RTRV-TNALNKMAP:[tid]::<ctag>:::[TNA=<TNA>][,LINKAID=<LinkAID> |
NODEAID=<NodeAID>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"::TNA=<TNA>,LINKAID=<LinkAID> | NODEAID=<NodeAID>"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.159 RTRV-TNALNKMAP Parameters

Parameter Value(s) Definition
TNA Enter type-xxx.xxx.xxx.xxx format: (1) Specifies the TNA
type is one of the following: IPV4
(2)xxx = 0-255

LinkAID TL-[1,3]-[1-512]-[1-1500], BL-[1,3]-[1- Specifies the AID of the link

512]-[1-500]

NodeAID NODE-[1,3]-[1-512] Specifies the AID of the node

Example
RTRV-TNALNKMAP:::AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^"::TNA=IPV4-127.254.233.256,LINKAID=TL-3-2-4"
^^^"::TNA=IPV4-222.254.233.256,LINKAID=TL-3-3-4"
;

Page 30-1356 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-TNALNKMAP
ENT-TNALNKMAP

76.MTFP50/30, Rev B January 2018 Page 30-1357

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TOD

Command Changes Since Previous Feature Package

• None.

Description
RETRIEVE-TIME-OF-DAY allows the NE, to relate or share Time-Of-Day (TOD) information with an OS, or any
other NE interface, which directly requires accurate and stable TOD information.

Command Format
RTRV-TOD:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<tmody>,<tmsrcdv_current>,<tmsrcdv_alternate>,<tmsrc_state>" <cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.160 RTRV-TOD Parameters

Parameter Value(s) Definition
tmody YYYY,MM,DD,HH,MM,SS.sss,tmtype Specifies the Time-Of-Day Recipient Component (TRC)
information.
- YYYY is the current calendar year
- MM is the month of the year
- DD is the day of the month
- HH is the hour of the day
- MM is the minute
- SS is the second
- sss are the sub-seconds
- <tmtype> is the type of time being returned. The value of this
parameter is fixed at UTC which represents Coordinated
Universal Time. <tmtype> was defined as a variable parameter
to allow for future enhancements in TOD technology.

tmsrcdv_curre IPPEER1 Specifies the time source derivation. It indicates the IP address
nt IPPEER2 of the NTPPEER that is being currently selected as the clock
source.

tmsrcdv_altern IPPEER1 Specifies the time source derivation. It indicates the IP address
ate IPPEER2 of the alternate NTPPEER that can be used for Clock source.
Must be different from the "tmsrcdv_current".

Page 30-1358 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.160 RTRV-TOD Parameters (Continued)

Parameter Value(s) Definition
tmsrc_state IS-NR-External Indicates the mode of the time source, provided by the
IS-NR-FreeRun secondary state of TOD entity.
- IS-NR-External (Indicates that NE uses NTP for
synchronization.)
- IS-NR-FreeRun (indicates that NE uses NE internal clock for
Synchronization.)
This might be because:
- All NTPPEERS are in OOS-MA state.
- NE has lost External Timing reference by losing connection to
all provisioned and in-service NTPPEERS.
- No NTPPEERS provisioned.

Example
Enter the following command to retrieve the TOD of a NE.

RTRV-TOD:CORIANT1::AM0209;

Possible System Response

CORIANT1 02-11-14 03:20:21

M AM0209 COMPLD

"2014,11,25,13,45,00.122,UTC,138.111.1.101,138.111.1.102,IS-NR-External"

or:
CORIANT1 02-11-14 03:20:21

M AM0209 COMPLD

"2014,11,25,13,45,00.123,,,,IS-NR-FreeRun;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
SET-DAT
ENT-NTPPEER
DLT-NTPPEER
RTRV-NTPPEER
ED-NTPPEER

76.MTFP50/30, Rev B January 2018 Page 30-1359

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TRAPIP

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-TRAPIP command instructs the network element (NE) to retrieve all the trap target IP addresses,
optional names, SNMP Ports and the SNMP version for all SNMP managers.

Restrictions and Exceptions

• Only the trap target IP addresses for SNMP managers that were provisoined using ENT-TRAPIP can
be retrieved with this command.

• Up to 10 trap target IP addresses for SNMP managers can be provisioned via ENT-TRAPIP command.

• This command applies to the mTera NE regardless of its PROXY mode

Command Format
RTRV-TRAPIP:[tid]::ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

TRPTGTADDR=<trptgtAddr>[,MGRNAME=<mgrName][,PORT=<snmpPort>][,SNMPVER=<snmpVersi
on>] [,UID=<uid>]

.....

TRPTGTADDR
=<trptgtAddr>[,MGRNAME=<mgrName>][,PORT=<snmpPort>][,SNMPVER=<snmpVersion>]
[,UID=<uid>]"<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.161 RTRV-TRAPIP Parameters

Parameter Value(s) Definition
trptgtAddr Format for the IP address is: A double Specifies the IP address of the SNMP Manager (Trap Target IP
quoted string representing the IPv4 address).
address. IPv4 address = "[0-255].[0-
255].[0-255].[0-255]".

mgrName 0 to 31 alphanumeric characters. Specifies the customer entered additional field to label the
SNMP Manager.
Refer to section 2 for the applicable characters.

snmpVersion 2 Specifies the SNMP version used by the NE to send SNMP

3 notifications to the manager.

Page 30-1360 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.161 RTRV-TRAPIP Parameters (Continued)

Parameter Value(s) Definition
snmpPort Possible values are : SNMP Port = Specifies the SNMP port at which the manager receives the
nnnnn,where n = 0-9. notifications.

uid 6 to 20 alphanumeric characters. Specifies the user's identity (login name).

Example
RTRV-TRAPIP:CORIANT1::AM0074;

Possible System Response

^^^CORIANT1 07-09-15 02:08:15
M AM0074 COMPLD
TRPTGTADDR=192.168.203.12,MGRNAME=\"NOC25\",PORT=162,SNMPVER=3,UID=Johnson93
TRPTGTADDR=192.168.203.13,MGRNAME=\"OSSLAB16\",PORT=1042,SNMPVER=3,UID=Peterson2
1
TRPTGTADDR=192.168.203.13,MGRNAME=\"HP_OPENVIEW\",PORT=1193,SNMPVER=2
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-TRAPIP
DLT-TRAPIP

76.MTFP50/30, Rev B January 2018 Page 30-1361

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TSL

Command Changes Since Previous Feature Package

• Updated the Proper System Response to indicate that the NEPTL parameter is a mandatory parameter.
Also updated the example to add the NEPTL parameter.

• Added INCOMP secondary state

• Update the ModuleAID parameter to support OSM-4S.

Description
The RTRV-TSL command instructs the network element (NE) to retrieve a transitional link.

When using the "TRANSET" based optical impairment algorithm (see ED-CPPF), an INCOMP secondary state
indicates the optical impairment parameters for the TSL were not contained in the OPE data file. These links is
treated as having no available capacity until the INCOMP state is resolved by uploading a new OPE data file with
the required parameters for this TSL. For links that are included in the OPE data file but associated TSLs have not
been created on the network element, RTRV-TSL cannot be used to retrieve the TSL.

Restrictions and Exceptions

• When ALL is used as an AID, information for all TSL entities that matches the specified filtering
parameter(s) is retrieved.

• MODULE, FACTYPE, ADAPT and IFINDEX are mutually exclusive as filtering parameters.

Command Format
RTRV-
TSL:[tid]:[{<tsl_aid>|ALL}]:ctag:::[MODULE=<ModuleAID>][,FACTYPE=<FacilityType>]
[,ADAPT=<Adaptation>][,IFINDEX=<IfIndex>];

Proper System Response

^^^<header>
M^^<ctag>^COMPLD<cr><lf>
^^^"<tsl_aid>::[TSLNAME=<TSLname>][,COST=<Cost>][,IFINDEX=<IfIndex>][,NID=<NodeI
d>][,NIFINDEX=<NeighborIfIndex>],NNID=<NeighborNodeId>,NSIGADDR=<NeighborSignali
ngAddr>,NSIGID=<NeighborSignalingId>,PMD=<Pmd>,OSNR=<Osnr>[,PDL=<Pdl>],LINKPF=<L
inkpfAID>,RAID=<RouterAreaId>[,RESCLASS=<ResourceClass>],MODULE=<ModuleAID>,PORT
ID=<PortId>,FACTYPE=<FacilityType>,ADAPT=<Adaptation>,NEPTL=<NearEndParentTL>:<P
ST>,[SST]"
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.162 RTRV-TSL Parameters

Parameter Value(s) Definition
tsl_aid TSL-[1,3]-[1-512]-[1-500] EntityID-NPID-NodeNum-TSLID

Page 30-1362 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.162 RTRV-TSL Parameters (Continued)

Parameter Value(s) Definition
ModuleAID OSM2C-20-[1-16], Specifies the AID of Module that the link is terminated.
OSM2S-20-[1-16],
OMD-20-[1-16]-[1-2],
OSM4S-20-[1-16]

FacilityType OCH Specifies the sub-type of facility that is used to terminated the
OCH-P link end.

Adaptation OCH Specifies the topmost layer if the adaptation functions used at
ODU2 the given link end.
ODU2e
ODU3
ODU4

IfIndex [0-255].[0-255].[0-255].[0-255] Specifies the IfIndex for this TSL. This value is created by the
NE.

TSLname Alpha-numeric text string up to 30 Specifies the transitional link name.

characters. Refer to section 2 for the applicable characters.

Cost [1-4294967295] Specifies the cost for the link.

NeighborIfInde xxx.xxx.xxx.xxx where xxx= 0-255 and Specifies the neighbors If Index.
x 0.0.0.0 is not a valid input value.

NeighborNode [0-255].[0-255].[0-255].[0-255] Specifies the neighbors node ID.

Id

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling address.

lingAddr

NeighborSigna [0-255].[0-255].[0-255].[0-255] Specifies the neighbors signaling ID.

lingId

Pmd [0-6500] Unit is in hundredths of Specifies the value for polarization mode dispersion.
picoseconds.
This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

Osnr [0-8000] Unit is in hundredths of dB. Specifies the value for Optical Signal to Noise Ratio.

This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

Pdl NA or [0-100000] Unit is in one- Specifies the value for Polarization Dependent Loss.
hundred-thousandths
of dB. This parameter is advertised and used only when the CPPF for
this transitional link has OPTPATHALG set to DISCRETE.† For
all other settings of OPTPATHALG, this parameter may be
provided but is ignored.

LinkpfAID LINKPF-[91-99,1-20] Specifies the access identifier of the Link Profile.

RouterAreaId [0-255].[0-255].[0-255].[0-255] Identifies the router area ID for this TSL.

The router area ID specifies an area that common to both link
ends.

76.MTFP50/30, Rev B January 2018 Page 30-1363

22. Retrieve Commands TL1 Command Reference Manual

Table 22.162 RTRV-TSL Parameters (Continued)

Parameter Value(s) Definition
ResourceClas A double quoted 4 byte hex strings. Specifies the resource class for the TSL.
s 32-bit long bit-mapped field with each bit representing a specific
resource classification.
The total number of distinct resource classes supported is 32.
Multiple resource classes can be specified by setting their
corresponding bit locations.
Note:
Empty string "" is displayed when RESCLASS is not specified or
after being reset.

Example bit-mapped resource class definitions:

""
"00000001" - Class 1
"00000002" - Class 2
"00000004" - Class 3

PortId 1 to maximum PortId of each module. Specifies the port on the given equipment module which the link
Note: PortId ranges from 4 to 11 for is terminated.
OADMF8.

NearEndParen TL-[1,3]-[1-512]-[1-1500] Identifies the TL to be used to specify an address for this TSL
tTL entity.

PST IS-NR Indicates the primary state and primary state qualifier of a
OOS-AU module.
OOS-MA Possible values for PST:
OOS-AUMA IS: In-Service
OOS: Out-of-Service
Possible values for PSTQ:
NR: normal
AU: autonomous
MA: management
AUMA: autonomous management

SST INPROG Indicates the secondary state:

FAF INPROG: In Progress - Entity is in the process of being
INCOMP established, used to indicate that neighbor discovery is in
progress.
FAF: Facility Failure - The associated transport facility has failed
INCOMP: Optical impairment parameters are not available

Example
RTRV-TSL::TSL-3-1-1:AM0011;

Possible System Response

CORIANT1 06-05-15 02:08:15
M AM0011 COMPLD
^^^\"TSL-3-1-1::TSLNAME=\"OCH-P TSLink
1\",IFINDEX=10.1.1.2,NIFINDEX=10.2.3.1,NID=123.222.132.111,NSIGADDR=130.200.2.25
4,NSIGID=120.1.1.254,PMD=0,OSNR=8000,PDL=NA,LINKPF=LINKPF-
1,RAID=122.231.222.121,MODULE=OSM2S-2-1,PORTID=1,FACTYPE=OCH-
P,ADAPT=ODU2,NEPTL=TL-3-1-2:IS-NR"
;

Page 30-1364 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-TSL
ENT-TSL
DLT-TSL

76.MTFP50/30, Rev B January 2018 Page 30-1365

22. Retrieve Commands TL1 Command Reference Manual

RTRV-TTP-{x}

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-TTP command instructs the network element (NE) to retrieve the attributes of the specified trail
termination point entity.

{x} can be STS1 or STS3C.

Restrictions and Exceptions

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

Command Format
RTRV-TTP-{x}:[tid]:{<ttp_aid> | ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<ttp_aid>::AUTOCFG=<autocfg>[,VCG=<vcg_aid>][,NPOWNER=<NpOwner>],CPTYPE=<cp_
type>:<pst>[,<sst>]"<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.163 RTRV-TTP-{x} Parameters

Parameter Value(s) Definition
ttp_aid TTPSTS1-20-[1-16]-99-[1-3]-[1-192] EntityID-ShelfID-SlotID-Vport-GroupId-n
TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

autocfg YES Specifies whether the TTP was automatically or manually

NO configured.
The value YES indicates automatic configuration (associated
with a VCG with VCGTYPE=AUTO).
The value NO indicates manual configured (associated with a
VCG with VCGTYPE=MAN).

vcg_aid VCG-20-[1-16]-[1-32] Specifies the AID of the VCG of which this TTP is a member.
This parameter is omitted if the TTP is not a member of a VCG.

NpOwner 3 Specifies which network partition owns this entity.

cp_type SONET SWITCHING MODULE - Indicates the type of module on which this TTP is supported
DWDM INTERFACE
SONET SWITCHING MODULE - XFP
WHITE LIGHT INTERFACE

Page 30-1366 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.163 RTRV-TTP-{x} Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier for the trail
OOS-MA termination point.
Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service
Possible values for PSTQ:
- NR: normal
- MA: management

sst BUSY Indicates the secondary state of the trail termination point.
IDLE - BUSY: busy (involved in a cross-connection)
- IDLE: idle (not involved in a cross-connection)

almProfile 0-20, 99 Specifies the new alarm profile table for Trail Termination Point.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

Example
Retrieve a STS3C TTP

RTRV-TTP-STS3C:CORIANT1:TTPSTS3C-20-12-99-1-4:myctag;

Possible System Response

CORIANT1 02-02-02 03:20:21

M MYCTAG COMPLD

"TTPSTS3C-20-12-99-1-4::AUTOCFG=NO,VCG=VCG-20-12-3,CPTYPE=\"SONET SWITCHING
MODULE - XFP WHITE LIGHT INTERFACE\":IS-NR,IDLE"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-TTP
ED-TTP
ENT-TTP

76.MTFP50/30, Rev B January 2018 Page 30-1367

22. Retrieve Commands TL1 Command Reference Manual

RTRV-UPG-STATE

Command Changes Since Previous Feature Package

• None

Description
The RTRV-UPG-STATE command instructs the network element (NE) to retrieve its software upgrade status. This
command applies to both software upgrading and patching.

The optional parameter LEVEL may be used to condition the command response. When the optional LEVEL is not
specified, then only SW-1 upgrade state is returned. When LEVEL is set to ALL, the response contains the
concatenation of each of the other values of LEVEL. When LEVEL is set to SW, only the SW-1 upgrade state is
retrieved. When LEVEL is set to MODULE, each module's upgrade state is retrieved.

The optional parameter PHASE is only applicable when there is a response containing module upgrade states. It is
used as a matching filter to retrieve only equipment upgrade phases matching the filter.

Restrictions and Exceptions

• The Patching process supports three upgrade states, beginning with the transfer of a patch load
package to the NE, and ending after the patch files have been extracted from the patch load package
and copied to the active software directory on the NE.

Command Format
RTRV-UPG-
STATE:[tid]::ctag[:::[LEVEL=<upg_level>,[MOD_UPGSTATE=<mod_upgrade_state>]]];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<sw_aid>::UPGSTATE=<upgrade_state>"<cr><lf>
[^^^"<eqpt_aid>::MOD_UPGSTATE=<mod_upgrade_state>[,PHASE=<mod_upgrade_phase>]"<c
r><lf>]
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1368 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.164 RTRV-UPG-STATE Parameters

Parameter Value(s) Definition
eqpt_aid MFAB-20-[5-6, 8-9, 11-12, 17-20] EntityID-ShelfID-SlotID
MFAB2-20-[5-6, 8-9, 11-12, 17-20]
OADMRS-20-[10-16,1-7]
OADMRS9-20-[1-16]
OCC-20-[10-16,1-7]
OSM1S-20-[1-16]
OSM2C-20-[1-16]
OSM2S-20-[1-16]
SSM2S-20-[1-16]
STPM-20-[25,24]
STPM8-20-[13,14]

upg_level ALL Description of enumeration:

MODULE - ALL = Retreive all possible upgrade states
SW - MODULE = Retreive all module upgrade states
- SW = Retreive the SW upgrade state (Default)

mod_upgrade COMPLD Description of each state:

_state FAIL - COMPLD = Upgrade has Completed
IP - FAIL = Upgrade has Failed
NONE - IP = Upgrade is In-Progress
- NONE = No Active Upgrade

sw_aid SW-1 Specifies the access identifier of the selected entity.

upgrade_state NONE Description of each state:

DELVIP - NONE = No Active Upgrade or Patch
DELVCOMPLD - DELVIP = Software Upgrade Delivery In- Progress
INSTIP - DELVCOMPLD = Software Upgrade Delivery Completed
INSTCOMPLD - INSTIP = Software Upgrade Installation In-Progress
EXECIP - INSTCOMPLD = Software Upgrade Installation Completed
EXECCOMPLD - EXECIP = Software Upgrade Execution In-Progress
EXECPARTIAL - EXECCOMPLD = Software Upgrade Execution Completed
COMMITIP - EXECPARTIAL = Software Upgrade Execution Partially
ABORTIP Completed
ABORTFAIL - COMMITIP = Software Upgrade Commit In-Progress
ABORTPENDING - ABORTIP = Software Upgrade Abort In-Progress
PATCHDELVIP - ABORTFAIL = Software Upgrade Abort Fail
PATCHDELVCOMPLD - ABORTPENDING = Software Abort execution is pending
PATCHAPPLYIP - PATCHDELVIP = Patch Delivery In-Progress
- PATCHDELVCOMPLD = Patch Delivery Completed
- PATCHAPPLYIP = Patch Apply in Progress

mod_upgrade a string value String with detailed Upgrade state information.

_phase

upg_timerem_ Variable Remaining seconds for the upgrade phase.

s

Example
RTRV-UPG-STATE:CORIANT1::AM0209;

Possible System Response

CORIANT1 02-02-02 03:20:21

76.MTFP50/30, Rev B January 2018 Page 30-1369

22. Retrieve Commands TL1 Command Reference Manual

M AM0209 COMPLD

" SW-1::UPGSTATE=NONE"
;

Example
RTRV-UPG-STATE:CORIANT1::CTAG:::LEVEL=ALL,MOD_UPGSTATE=IP;

Possible System Response

CORIANT1 15-03-14 09:26:54

M CTAG COMPLD

" SW-1::UPGSTATE=EXECIP"
"OSM2C-20-7::MOD_UPGSTATE=IP,PHASE=\"Verifying\""
"OSM2S-20-12::MOD_UPGSTATE=IP,PHASE=\"Verifying\""
"OSM2S-20-13::MOD_UPGSTATE=IP,PHASE=\"Verifying\""
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
COPY-RFILE
OPR-UPG-EXECUTE
OPR-UPG-COMMIT
OPR-UPG-ABORT
OPR-UPG-PATCHAPPLY

Page 30-1370 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-USER-SECU

Command Changes Since Previous Feature Package

• Added the parameters FIPSTL1, FIPSAUTH, FIPSPRIV

• Change the value of snmp_priv_protocol from DES3 to DES

• Added text to describe how to save a password or pass phrase using a FIPS compliant algorithm.

Description
The RTRV-USER-SECU command instructs the Network Element (NE) to retrieve the user attribute "privilege
codes" (UAP, UAPCLI and UAPSNMP), "Session time-out" (TMOUT), "Password Aging" (PAGE), "Password
Update Waiting Period" (PUWP) values, "Number of grace login attempts once a password has expired" (PELN),
autonomous report messages parameters (ALMMSG, DBCHGMSG, EVTMSG and PMMSG), the user status
(STATUS), snmp user security level (USERSECLEVEL), snmp authentication protocol (SNMPAUTHPROT), and
snmp privacy protocol(SNMPPRIVPROT).

This command can be used by any user. When the command is executed by any user, it will retrieve only his/her
own security credentials. When the command is executed by System Administrator, it can retrieve the security
credentials of any/all users.

If the user profile contains Secure Shell information, the user public key information is displayed. The last used
remote key location is displayed as well as each of up to 6 stored public keys. Stored public keys are displayed with
a fingerprint of the actual key. As keys can be well over 1000 chars, the system displays only a small subset of the
key string which allows for unique identification of each key.

If a password or pass phrase is not saved using a FIPS compliant algorithm, the following actions can be taken to
save the password or pass phrase with a FIPS compliant algorithm:
-If the system is not in FIPS mode (ED-SECU-SYS parameter SECURE=NONFIPS): logging into the account will
save the password or pass phrase using a FIPS compliant algorithm or changing the password or pass phrase will
save the password or pass phrase using a FIPS compliant algorithm.
-If the system is in FIPS mode (ED-SECU-SYS parameter SECURE=FIPS): Changing the password or pass phrase
will save the password or pass phrase using a FIPS compliant algorithm.

This command can be run on DIR_OSC, PGNE-1, PGNE-2 and PRNE.

Restrictions and Exceptions.

• When no UID is specified, the system returns response for all UID when the command is executed by
A8 user.

• When no UID is specified, the system returns response for the UID corresponding to the user that
executed the command.

• When STATUS is specified in the command, no UID or ALL is specified for UID.

• If the user running the commands does not have the privilege to run with the parameters provided, it
returns PICC error code.

Command Format
RTRV-USER-
SECU:[tid]:[<uid>]:ctag:::[STATUS=<user_status>][,FIPSTL1=<fipstl1>][,FIPSAUTH=<
fipsauth>][,FIPSPRIV=<fipspriv>];

76.MTFP50/30, Rev B January 2018 Page 30-1371

22. Retrieve Commands TL1 Command Reference Manual

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

^^^"<uid>:UAP=<uap>,UAPCLI=<uap_cli>,UAPSNMP=<uap_snmp>,TMOUT=<session_timeout>,
PAGE=<password_aging>,PUWP=<pwd_update_waiting_period>,PELN=<pwdexpire_login_num
>,MAXSES=<max_sessions>,ALMMSG=<almmsg>,EVTMSG=<evtmsg>,DBCHGMSG=<dbchgmsg>,PMMS
G=<pmmsg>,STATUS=<user_status>,FIPSTL1=<fipstl1>,FIPSAUTH=<fipsauth>,FIPSPRIV=<f
ipspriv>,USERSECLEVEL=<snmp_user_sec_level>,SNMPAUTHPROT=<snmp_auth_protocol>,SN
MPPRIVPROT=<snmp_priv_protocol>[,KEYLCN=<public_key_location>][,KEY1=<public_key
>][,KEY2=<public_key>][,KEY3=<public_key>][,KEY4=<public_key>][,KEY5=<public_key
>][,KEY6=<public_key>][,SHOWKEY=<showKey>]"<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.165 RTRV-USER-SECU Parameters

Parameter Value(s) Definition
uid 6 to 20 alphanumeric characters. UID

user_status ENABLED Specifies the current status of the user login.

DISABLED - Enabled: user can log into a NE.
LOCK-OUT - Disabled: user can not log into a NE because Admin has
PASSWORD AGED disabled it via ED-USER-SECU or due to inactivity for a long
time.
- LOCK-OUT: user is lock-out due to unsuccessful login
attempts.
- -Password Aged: User who has a password expired. He is
requested to change his password on next login.
- -RADIUS: User is RADIUS authenticated.

fipstl1 TRUE TRUE- indicates that the TL1 password has been saved using a
FALSE FIPS compliant algorithm
FALSE- indicates that the TL1 password has not been saved
using a FIPS compliant algorithm

fipsauth TRUE TRUE- indicates that the SNMP authentication pass phrase has
FALSE been saved using a FIPS compliant algorithm
FALSE- indicates that the SNMP authentication pass phrase
has not been saved using a FIPS compliant algorithm

fipspriv TRUE TRUE- indicates that the SNMP privacy pass phrase has been
FALSE saved using a FIPS compliant algorithm
FALSE- indicates that the SNMP privacy pass phrase has not
been saved using a FIPS compliant algorithm

Page 30-1372 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.165 RTRV-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
uap A0 This attribute specifies the TL1 user access privilege code
A2 (UAP) assigned to the login (uid). It
A4 indicates the commands the user is allowed to execute as
A6 described in Table 6.2, page 30-135.
A7 - A0 indicates that TL1 interface access is blocked, except for
A8 ACT-USER, CANCUSER and ED-PID commands.
- A2 indicates Public privilege.
- A4 indicates Test privilege.
- A6 indicates Provisioning privilege.
- A7 indicates Operator privilege.
- A8 indicates Admin privilege.
Refer to Security and Administration, page 2007-134, for
detailed information on the UAP.

uap_cli A0 This attribute specifies the CLI (Command Line Interface) user
A2 access privilege code (CLIUAP)
A4 assigned to the login (uid).
A6 - A0 indicates that CLI interface access is blocked.
A7 - A2 specifies Public privilege.
A8 - A4 specifies Test privilege.
- A6 specifies Provisioning privilege.
- A7 specifies Operator privilege.
- A8 indicates Admin privilege.

uap_snmp A0 This attribute specifies the SNMP (Simple Network

A2 Management Protocol) user access privilege code (UAP)
A8 assigned to the login (uid).
- Enter A0 to block access to SNMP interface.
- Enter A2 to specify Public privilege. (A2 indicates full read-only
and notify access to the MIBs, write access to change its own
SNMP Passphrases)
- Enter A8 to specify Admin privilege.(A8 indicates full read-write
access to all the MIBs )

session_timeo [0-99] This attribute is the Session Time Out Interval. If there are no
ut messages between the user and the
NE over the Time Out interval, the session is logged off.

password_agi [0-255] This attribute is the Password Aging Interval.

ng

pwd_update_ [0-60] This attribute specifies the number of days that a user must wait
waiting_period before he can update his password.

pwdexpire_logi [0-5] This attribute specifies the number of times that an existing
n_num password can still be used once it has expired.

max_sessions [1-128] This attribute specifies the maximum number of sessions

allowed for a user.

almmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
REPT^ALM and REPT^ALM-ENV.

evtmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
REPT^BKUP, REPT^EVT, REPT^EVT^FXFR, REPT^EVT-
SESSION.

76.MTFP50/30, Rev B January 2018 Page 30-1373

22. Retrieve Commands TL1 Command Reference Manual

Table 22.165 RTRV-USER-SECU Parameters (Continued)

Parameter Value(s) Definition
dbchgmsg ALW This attribute specifies if this user receives (value=ALW), not
INH receive (value=INH), or receive
INH-OWN all, except those that are a result of administrative actions that
they perform (value=INH-OWN),
autonomous messages reported through REPT^DBCHG.

pmmsg ALW This attribute specifies if this user receives (value=ALW) or not
INH receive (value=INH) autonomous messages reported through
REPT^PM.

snmp_user_se authPriv Specifies the SNMPv3 user security level.

c_level authNoPriv
noAuthnoPriv

snmp_auth_pr MD5 Specifies the authentication protocol that the SNMPv3 user
otocol SHA being created uses.

public_key_loc ftp://userid:pwd@ftphost:[portid]/url- Specifies the location of the public key.

ation path Port number 21 can be used for non-secure FTP file transfer.
Port number 22 is the default value and can be used for secure
FTP (SFTP) file transfer.
<url-path> specifies the device/drive/directory/
publickeyfilename.
NE automatically attempts to connect to the server holding the
public key file and store the key in the lowest available KEY
variable (that is, KEY1, KEY2...KEY6).

public_key In hex, x:x:x:x:x:x:x:x, where x Specifies the remote server's public key strings installed in the
represents a 2 digit hexadecimal NE.
number. In babble, x-x-x-x-x-x-x-x-x-
x-x, where x represents 5
alphanumeric characters.

showKey HEX Specifies whether or not to display the key string stored in the
BABBLE database and what encoding scheme should be used to display
NO it.
HEX to display the key encoded in hex.
BABBLE to display the key encoded in Bubble Babble.
NO to not display the key.

Example 1
RTRV-USER-SECU:CORIANT1:Smith22:AM0549;

Possible System Response

CORIANT1 06-06-06 23:53:01

M AM0549 COMPLD

"Smith22:UAP=A8,UAPCLI=A0,UAPSNMP=A2,TMOUT=15,PAGE=60,PUWP=55,PELN=4,ALMMSG=ALW,
DBCHGMSG=INH,EVTMSG=ALW,PMMSG=INH,STATUS=LOCK-
OUT,FIPSTL1=TRUE,FIPSAUTH=FALSE,FIPSPRIV=FALSE,USERSECLEVEL=authPriv,SNMPAUTHPRO
T=MD5,SNMPPRIVPROT=DES"
"Malhotra85:UAP=A4,TMOUT=30,PAGE=60,PUWP=50,PELN=4,DBCHGMSG=INH,KEYLCN=\"sftp://
173.39.13.3/ssh/
id_rsa.pub\",KEY1=\"53:0b:af:e9:b0:91:37:08:d5:e6:c1:a0:74:ef:bf:77\",KEY4=\"61:
0b:af:e9:b0:91:37:08:d5:e6:c1:a0:74:ef:bf:68\"";

Page 30-1374 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Example 2
The following initial conditions are assumed:

UID STATUS UAP

TEST2 LOCK-OUT A2
PROV1 DISABLED A4
ADMIN2 ENABLED A6
To retrieve all users established in the system:

RTRV-USER-SECU:CORIANT1:ALL:AM0549;

Possible System Response

CORIANT1 06-06-06 23:53:01

M AM0549 COMPLD

"TEST2:UAP=A2,UAPCLI=A2,UAPSNMP=A0,TMOUT=25,PAGE=60,PUWP=55,PELN=3,MAXSES=6,ALMM
SG=ALW,DBCHGMSG=INH,EVTMSG=ALW,PMMSG=INH,STATUS=LOCK-
OUT,FIPSTL1=TRUE,FIPSAUTH=FALSE,FIPSPRIV=FALSE,""

"PROVISION1:UAP=A4,UAPCLI=A0,UAPSNMP=A2,TMOUT=45,PAGE=60,PUWP=55,PELN=4,MAXSES=6
,ALMMSG=ALW,DBCHGMSG=INH,EVTMSG=ALW,PMMSG=INH,STATUS=DISABLED,FIPSTL1=TRUE,FIPSA
UTH=FALSE,FIPSPRIV=FALSE,USERSECLEVEL=authNoPriv,SNMPAUTHPROT=SHA"

"ADMINSNMP2:UAP=A6,UAPCLI=A0,UAPSNMP=A8,TMOUT=15,PAGE=30,PUWP=25,PELN=3,MAXSES=6
,ALMMSG=ALW,DBCHGMSG=ALW,EVTMSG=ALW,PMMSG=ALW,STATUS=ENABLED,FIPSTL1=TRUE,FIPSAU
TH=TRUE,FIPSPRIV=TRUE,USERSECLEVEL=authPriv,SNMPAUTHPROT=MD5,SNMPPRIVPROT=DES";

Example 3
To retrieve all DISABLED users established in the system:

RTRV-USER-SECU:CORIANT1:ALL:AM0549:::STATUS=DISABLED;

Possible System Response

CORIANT1 06-06-06 23:53:01

M AM0549 COMPLD

"PROVISION3:UAP=A4,UAPCLI=A0,UAPSNMP=A2,TMOUT=45,PAGE=60,PUWP=55,PELN=4,MAXSES=6
,ALMMSG=ALW,DBCHGMSG=INH,EVTMSG=ALW,PMMSG=INH,STATUS=DISABLED,FIPSTL1=TRUE,FIPSA
UTH=TRUE,FIPSPRIV=TRUE,USERSECLEVEL=authNoPriv,SNMPAUTHPROT=SHA"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-USER-SECU
ED-USER-SECU
ENT-USER-SECU

76.MTFP50/30, Rev B January 2018 Page 30-1375

22. Retrieve Commands TL1 Command Reference Manual

RTRV-VCG

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-VCG command instructs the network element (NE) to retrieve the attributes of the specified virtual
concatenation group (VCG) entity.

The RTRV-VCG command is designed to filter VCG responses based on Alarm Profile, Primary, and Secondary
state. All specified filters must match for the VCG to be retrieved.

The RTRV-VCG command can retrieve member information for in addition to VCG summary information by setting
a command parameter.

Restrictions and Exceptions

• When "ALL" is used as an AID, it addresses all entities compatible with the specified second modifier.

• When "ALL" is used as an AID, MBR=YES can not be specified.

• All the parameters which specify the LCAS related does not be applicable for SSM2S since only non-
LCAS mode is supported

Command Format
RTRV-VCG:[tid]:{<vcg_aid>| ALL}:ctag:::
[,MBR=<showDetails>][,ALMPF=<almProfile>][:<editablePrimaryState>[,<secondarySta
te>]];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<vcg_aid>:<vcgType>:CPTYPE=<cp_type>,ALMPF=<almProfile>,PVID=<pVID>,TPID=<tp
ID>,TAGMODE=<tagMode>,VCAT=<VcatType>,CCPATH=<ccPath>,PLCTHR=<plcThr>,TLCTHR=<tl
cThr>,HOTMR=<hoTmrEn>,WTRTMR=<wtrTmrEn>,NVALUE=<NValue>[,XAR=<vcatXar>][,XAT=<vc
atXat>][,VCATXARCAP=<vcatXarCap>][,VCATXATCAP=<vcatXatCap>],VCATDD=<vcatDd>,PROT
=<vcgProt>,LCAS=<lcas>,LCASACT=<lcasAct>[,TTPMAP=<ttpMap>][,VCGSTAT=<VCGCurrentS
lot>][,NPOWNER=<NpOwner>]:<pst>[,<sst>]"<cr><lf>

Response parameters are conditional on the VCG CCPATH parameter.

When CCPATH is ADD, then transmit parameters is returned; XAT, VCATXATCAP.
When CCPATH is DROP, then receive parameters is returned; XAR, VCATXARCAP.
When CCPATH is ADD/DROP, then both tranmit and receive parameters are returned.

Response parameters for MBR=YES are conditional on the VCG CCPATH parameter.
When CCPATH is ADD, then transmit parameters is returned; AT, VCATSQT.
When CCPATH is DROP, then receive parameters is returned; DD, AR, VCATSQR.
When CCPATH is ADD/DROP, then both tranmit and receive parameters are returned.

Page 30-1376 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.166 RTRV-VCG Parameters

Parameter Value(s) Definition
vcg_aid VCG-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-n

showDetails YES Response shows only VCG group state.

NO Response shows VCG group and all individual member state
and attributes.

almProfile 0-20, 99 Specifies the alarm profile table to condition the response.
Note: Default value is 99 or the value specified by SYSALMPF
parameter in ED-/RTRV-NE command.

editablePrimar IS Indicates the primary state of a VCG.

yState OOS Possible values for PST:
- IS: In-Service
- OOS: Out-of-Service

vcgType AUTO Specifies what type of entities may be added to the virtual
MAN concatenation group.
vcgtype=MAN, TTP entities are added to the VCG.
The TTPs must be explicitly created and cross-connected to
STS1 or STS3 prior to being added to the VCG.

cp_type SDH SERVICES MODULE-MSA LINE Indicates the type of module on which this VCG is supported.
INTERFACE
SDH SERVICES MODULE-XFP White
Light interface

VcatType STS1 Specifies the type of facilities that can be added as members of
STS3C the virtual concatenation group.

ccPath ADD Specifies the directionality of the virtual concatenation group.

DROP When vcgtype=MAN, this is used to validate that the cross-
ADD/DROP connections between STSn and TTP are made correctly. When
vcgtype=AUTO, this is used to determine the type of connection
to provision between the STSn and the TTP.
ADD indicates that the VCG is a source only (supports 1WAY or
1WAYBR connections)
DROP indicates that the VCG is sink only (supports 1WAY or
1WAYPR connections)
ADD/DROP indicates that the VCG is bidirectional (supports
2WAY, 2WAYPR, 2WAYAUTO connections)

plcThr (1) 0 (2) 1 though n, where n is the Specifies the partial loss of capacity threshold. When the
number of members in the group (3) number of active members drops below this number, a PLC
the value n is greater than the number alarm is generated.
of members associated with the VCG The value 0 disables the PLC thresholding function.
(causes a PLCR alarm). Setting a value for any given group greater than the number of
members in the group causes a PLCR alarm.
When set to a non-zero value, PLC threshold must be set higher
than TLC threshold. Setting of PLC thresholds is meaningless
unless LCAS is enabled.
(Note: the absolute maximum number for PLCTHR is 192)

76.MTFP50/30, Rev B January 2018 Page 30-1377

22. Retrieve Commands TL1 Command Reference Manual

Table 22.166 RTRV-VCG Parameters (Continued)

Parameter Value(s) Definition
tlcThr (1)0 (2) 1-n, where n is the number of Specifies the total loss of capacity threshold. When the number
members in the group of active members drops below this number, a TLC alarm is
generated.
The value 0 behaves as value 1. When there are one or more
members associated with the VCG and all members of the VCG
are failed, a TLC alarm is generated. When there is no member
associated with the VCG, no TLC alarm is generated.
The maximum value for any given group is the number of
members in the group.
When set to a non-zero value, TLC threshold must be set lower
than PLC threshold.
A request to remove a member from the group is denied if it
would cause the number of members in the group to drop below
TLC threshold.

NValue [0-192] Specifies the number of members in the virtual concatenation

group.

vcatXar [0-192] Specifies the number of active receive members in the virtual
concatenation group.
Valid when ccPath is DROP or ADD/DROP.

vcatXat [0-192] Specifies the number of active transmit members in the virtual
concatenation group.
Valid when ccPath is ADD or ADD/DROP.

vcatXarCap [0-9600] Specifies the approximate receive capacity of the virtual

concatenation group, in Mbps. Each STS1 equivalent is counted
as 50 Mbps.
Valid when ccPath is DROP or ADD/DROP.

vcatXatCap [0-9600] Specifies the approximate transmit capacity of the virtual

concatenation group, in Mbps. Each STS1 equivalent is counted
as 50 Mbps.
Valid when ccPath is ADD or ADD/DROP.

vcatDd [0-128] Specifies the largest differential delay for the group, in
milliseconds.

lcas ON Specifies whether LCAS has been manually turned ON or OFF.

OFF

lcasAct ON Specifies whether LCAS is active. The value is determined by

OFF network operation. When the system is set to use LCAS (that is,
LCAS=ON) but the peer system is not LCAS-capable or has
LCAS disabled, LCAS is inactive (off) in the system to ensure
inter operability.

VCGCurrentSl SLOT-20-[1-35]-[1-32], Indicates the slot in which the active SSM resides.
ot SLOT-[50-58]-[1-8]

NpOwner 3 Specifies which network partition owns this entity.

Page 30-1378 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.166 RTRV-VCG Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier for the
IS-ANR virtual concatenation group.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

ttpmap TTPSTS1-20-[1-16]-99-[1-3]-[1-192], Specifies the TTPs that are members of the virtual
TTPSTS3C-20-[1-16]-99-[1-3]- concatenation group. This parameter is only returned when the
[190,187,-,10,7,4,1] input parameter MBR=NO. When MBR=YES, detailed
information for each member of the virtual concatenation group
is provided instead.

secondaryStat BUSY Indicates the secondary state of the virtual concatenation group.
e/sst IDLE - BUSY: when the VCG is involved in one or more EVCs or
MT when it is connected to another VCG
NALMNR - IDLE: idle
NALMCD - MT: maintenance
SGEO - NALMNR: not alarmed not ready
- NALMCD: not alarmed count down
- SGEO: supporting entity outage

ttp_aid TTPSTS1-20-[1-16]-99-[1-3]-[1-192], Specifies the access identifier of the member TTP.

TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

cct 1WAY Specifies the type of connection between the STSn and the
1WAYBR associated TTP. This parameter is returned only when
1WAYPR VCGTYPE=AUTO.
2WAY
2WAYPR
2WAYAUTO

autocfg YES Specifies the type of connection between the STSn and the
NO associated TTP. This parameter is returned only when
VCGTYPE=AUTO.

lcasActT YES Specifies whether the member is active in the Transmit and
NO Receive direction respectively.

lcasActR YES Specifies whether the member is active in the Transmit and
NO Receive direction respectively.

vcatSqT [0-191] Specifies the sequence number for this member in the Transmit
and Receive direction respectively.

vcatSqR [0-191] Specifies the sequence number for this member in the Transmit
and Receive direction respectively.

76.MTFP50/30, Rev B January 2018 Page 30-1379

22. Retrieve Commands TL1 Command Reference Manual

Table 22.166 RTRV-VCG Parameters (Continued)

Parameter Value(s) Definition
GroupId [1-3] The groupId is used to indicate the VCG id belonged to which
port group. Due to HW restriction , the list of ttpmap must
belong to same port group with VCG ID which TTPs are
assigned to

Example
Retrieve a VCG with MAN attribute.
RTRV-VCG:CORIANT1:VCG-20-12-4:myctag;

Possible System Response

<header>

M MYCTAG COMPLD

"VCG-20-12-4:MAN:CPTYPE=\"SONET SWITCHING MODULE - MSA LINE INTERFACE\", ALMPF=4,

VCAT=STS3C, CCPATH=ADD/DROP, PLCTHR=0, TLCTHR=0, NVALUE=3, XAR=3, XAT=3,
VCATXARCAP=150, VCATXATCAP=150, VCATDD=128, PROT=NO, LCASACT=ON:IS-
NR,BUSY"<cr><lf>

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-VCG
ED-VCG
ENT-VCG
RTRV-VCG-MEMBER

Page 30-1380 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

RTRV-VCG-MEMBER

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-VCG-MEMBER command instructs the network element (NE) to retrieve the members comprising of the
specified virtual concatenation group entity.

Restrictions and Exceptions

Command Format
RTRV-VCG-MEMBER:[tid]:{<vcg_aid> | ALL}:ctag;

Proper System Responses

<header>

M^^<ctag>^<COMPLD><cr><lf>

Response parameters are conditional on the VCG CCPATH parameter.

When CCPATH is ADD, then transmit parameters is returned; XAT, VCATXATCAP.
When CCPATH is DROP, then receive parameters is returned; XAR, VCATXARCAP.
When CCPATH is ADD/DROP, then both tranmit and receive parameters are returned.

Response parameters for MBR=YES are conditional on the VCG CCPATH parameter.
When CCPATH is ADD, then transmit parameters is returned; AT, VCATSQT.
When CCPATH is DROP, then receive parameters is returned; DD, AR, VCATSQR.
When CCPATH is ADD/DROP, then both tranmit and receive parameters are returned.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.167 RTRV-VCG-MEMBER Parameters

Parameter Value(s) Definition
vcg_aid VCG-20-[1-16]-[1-32] EntityID-ShelfID-SlotID-n

ttp_aid TTPSTS1-20-[1-16]-99-[1-3]-[1-192], Specifies the access identifier of the member TTP.

TTPSTS3C-20-[1-16]-99-[1-3]-
[190,187,-,10,7,4,1]

cct 1WAY Specifies the type of connection between the STSn and the
1WAYBR associated TTP. This parameter is returned only when
1WAYPR VCGTYPE=AUTO.
2WAY
2WAYPR
2WAYAUTO

vcatDd [0-128] Specifies the differential delay for this member, in milliseconds.
The member with the least overall delay has a differential delay
of 0. All other members has larger values. A member that is not
active returns the value NA.

76.MTFP50/30, Rev B January 2018 Page 30-1381

22. Retrieve Commands TL1 Command Reference Manual

Table 22.167 RTRV-VCG-MEMBER Parameters (Continued)

Parameter Value(s) Definition
lcasActT YES Specifies whether the member is active in the Transmit and
NO Receive direction respectively.

lcasAcrT YES Specifies whether the member is active in the Transmit and
NO Receive direction respectively.

vcatSqT [0-191] Specifies the sequence number for this member in the Transmit
and Receive direction respectively.

vcatSqR [0-191] Specifies the sequence number for this member in the Transmit
and Receive direction respectively.

pst IS-NR Indicates the primary state and primary state qualifier for the
IS-ANR virtual concatenation group.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

sst BUSY Indicates the secondary state of the virtual concatenation group.
IDLE - BUSY: when the VCG is involved in one or more EVCs or
MT when it is connected to another VCG
NALMNR - IDLE: idle
NALMCD - MT: maintenance
SGEO - NALMNR: not alarmed not ready
- NALMCD: not alarmed count down
- SGEO: supporting entity outage

condition Text string Standing condition posted against the path layer member.

GroupId [1-3] The groupId is used to indicate the VCG id belonged to which
port group. Due to HW restriction , the list of ttpmap must
belong to same port group with VCG ID which TTPs are
assigned to

Example
Retrieve a VCG with member details:
RTRV-VCG-MEMBER:CORIANT1:VCG-20-12-4:MYCTAG;

Possible System Response

For a VCG with VCGTYPE=MAN
<header>

M MYCTAG COMPLD

Page 30-1382 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

"VCG-20-12-4::TTP=TTPSTS3C-20-12-99-1-1,AUTOCFG=NO,DD=0, AT=YES, AR=YES,

VCATSQT=0, VCATSQR=0:IS-NR,BUSY"
"VCG-20-12-4::TTP=TTPSTS3C-20-12-99-1-4,AUTOCFG=NO, DD=4, AT=YES, AR=YES,
VCATSQT=1, VCATSQR=1:IS-NR,BUSY"
"VCG-20-12-4::TTP=TTPSTS3C-20-12-99-1-7,AUTOCFG=NO, DD=0, AT=YES, AR=YES,
VCATSQT=2, VCATSQR=2:IS-NR,BUSY"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-VCG
ED-VCG
RTRV-VCG

76.MTFP50/30, Rev B January 2018 Page 30-1383

22. Retrieve Commands TL1 Command Reference Manual

RTRV-WARNING

Command Changes Since Previous Feature Package

• None.

Description
The RTRV-WARNING command instructs the network element (NE) to allow a system administrator to retrieve the
message displayed at user login. Note that only the portion of the message modified through ED-WARNING
command is displayed. The default Notice about unauthorized user access, last login time, number of unsuccessful
attempts and default Notice about password expiration can not be modified.

Command Format
RTRV-WARNING:[tid]::ctag::;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
<warningMesg><cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.168 RTRV-WARNING Parameters

Parameter Value(s) Definition
warningMesg Up to 18 lines with maximum of 80 Specifies the warning message to be displayed in the response
characters per line. to ACT-USER command when a user logs into the NE.
Refer to section 2 for the applicable characters.

Example
RTRV-WARNING:CORIANT1::AM0011;

Possible System Response

^^^CORIANT1 02-03-15 02:08:15

M AM0011 COMPLD
/* This system is property of PTT TELCO. \n Use of this system by unauthorized
personnel may lead to jail.*/

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Page 30-1384 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Related Commands
ACT-USER
ED-WARNING

76.MTFP50/30, Rev B January 2018 Page 30-1385

22. Retrieve Commands TL1 Command Reference Manual

RTRV-WCG

Command Changes Since Previous Feature Package

• New command.

Description
The RTRV-WCG command instructs the network element (NE) to retrieve the attributes of the specified Wavelength
Contention Group (WCG) entity.
Command response with just the WCG AID and without any frequency information means the WCG is empty. for
example, "WCG-50-2::"

Restrictions and Exceptions

• When ALL is used as an AID, information for all WCG entities in the NE is retrieved.

Command Format
RTRV-WCG:[tid]:{<wcg_aid>|ALL}:ctag;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<wcg_aid>::FREQ=<centerFrequency>,NPOWNER=<NpOwner>,CC=<crossConnection>"<cr
><lf>
^^^"<wcg_aid>::FREQ=<centerFrequency>,NPOWNER=<NpOwner>,CC=<crossConnection>"<cr
><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.169 RTRV-WCG Parameters

Parameter Value(s) Definition
wcg_aid WCG-20-[1-16],WCG-[50-58]-[2-4,6-8] EntityID-ShelfID-SlotID
WCG-20-[1-16],WCG-[50-58]-[2-4,6-8]

centerFrequen From 191350000 to 196100000 with Indicates a center frequency in MHz within the WCG.
cy increment 50000

NpOwner NONE Indicates the network partition owner of the specified center
3 frequency.

NONE = No owner
3 = Control Plane

crossConnecti YES Indicates if the center frequency in the WCG is used in a cross-
on NO connection.

Example
RTRV-WCG:CORIANT1:WCG-50-2:AM0209;

Page 30-1386 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Possible System Response

CORIANT1 02-02-02 03:20:21

M AM0209 COMPLD

"WCG-50-2::FREQ=191350000,NPOWNER=NONE,CC=NO"
"WCG-50-2::FREQ=192300000,NPOWNER=NONE,CC=YES"

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-WCG

76.MTFP50/30, Rev B January 2018 Page 30-1387

22. Retrieve Commands TL1 Command Reference Manual

RTRV-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The RTRV-{X} command instructs the network element (NE) to retrieve the attributes of the specified facility entity.

{X} specifies the facility type among the following:

• Facilities (fac_type): GBEP, FGE, HGE, OC3, OC12, OC48, OC192, STM1, STM4, STM16, STM64,
OTU1, OTU2, OTU4, OTUC2, OTUC3, STS1, STS3C, STS12C, STS48C, STS192C, TGLAN.

Restrictions and Exceptions

• Intrusive J0 Trace Monitoring and J0 Generation options should be available only when the supporting
module is a SSM-2S (EXPTRC, MONTRC, TRC on OCn port side facilities).

• OSM-1S, OSM-2S provide transparent transport of SONET signals and may only monitor the J0 trace
message non-intrusively. OCn port facilities support INCTRC, EXPTRC and MONTRC parameters. The
J0 message cannot be altered, only read and optionally compared to an expected value.

• The facility AID must always correspond to the facility type.

• When ALL is used as an AID, information for all the entities that matches the specified filtering
parameter(s) is retrieved.

• RTRV-{X} supports TL1 AID Ranging for the following facilities (fac_type): STS1, STS3C, STS12C,
STS48C, STS192C.

• If the Trace received contains characters that are not listed in the TL1 Quoted Allowable Characters
table in section 2, it will replace these characters by the <space> character. This replacement will only
happen at the management interface level, the incoming trace used for purpose of TIM (Trace Identifier
Mismatch) alarm generation is the "real" trace as received on the physical line.

• The secondary state BERT-PRBS-TX and BERT-PRBS-RX are only applicable to facilities OC3, OC12,
OC48, OC192, STM1, STM4, STM16, STM64, OTU1, OTU2, OTU4.

• The secondary state DISC_INPROG is only applicable to facilities OC3, OC12, OC48, OC192, STM1,
STM4, STM16, STM64, OTU1, OTU2, OTU4.

• For TGLAN facility, only TRANSMAP=PREAMBLE/ LINE/ LINE_FS includes support to transport RF/
LF ordered sets to far-end client connected device.

• The NPOWNER parameter indicates the network partition which the CP owned entity belongs to, it does
not be shown for management plane owned entities.

• NPOWNER is valid for OCn/OTUk facility when OCn/OTUk TL has been created or valid for STSn
facility when associated cross-connection created by control plane.

• The retrieved PT value does not reflect the inserted Payload type byte in OPUk when NULL/PRBS is
enabled (0xFD/0xFE). It only shows the provisioned value, or the PT value correlated to the mapped
client facility signal or multiplexed low order ODU.

Page 30-1388 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Command Format
RTRV-<fac_type>:[tid]:{<fac_aid>|ALL}:ctag:::[ALMPF=<almProfile>]
[:<editablePrimaryState>][,<secondaryState>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>
^^^"<fac_aid>::CPTYPE=<cp_type>[,OEOREGEN=<oeoregen>][,EXPRATE=<ExpectRate>][,AC
TRATE=<actual_rate>][,SIGTYPE=<SigType>][,STSCRSMAP=<sts1crs_map>][,STSCSTMAP=<s
ts1cst_map>][,TRC=<trc>][,EXPTRC=<exptrc>][,INCTRC=<inctrc>][,MONTRC=<montrc>][,
PROT=<protection>][,EXTCONNECT=<ExtConnectivity>][,TRANSMAP=<Transmap>][,UPI=<UP
Ivalues>][,FECTYPE=<fecType>][,SFTHRESH=<SFThreshold>][,SDTHRESH=<SDThreshold>][
,BAND=<band>][,NVALUE=<NValue>][TRANSPARENT=<transparent>][,NENDALS=<NendALS>][,
LOSTHRES=<losThres>][,SWTHRES=<swThres>][,AISTYPE=<AIStype>][,SSMSUPP=<ssmSuppor
ted>][,SSMRX=<rx_ssm>][,QLOVERRIDE=<qualityLevelOverride>][,GFPMAPPING=<GFPMap>]
[,VCAT=<VcatType>][,CLOCKTYPE=<ClkType>][,PT=<pt>][,CBRMAP=<cbrMap>][,AUTONEG=<A
utoneg>][,AUTOCFG=<autocfg>][,ALMPF=<almProfile>][,PMPF=<pmProfile>][,NPOWNER=<N
pOwner>][RXDAPI=<RxDAPI>][,RXSAPI=<RxSAPI>][,EXPDAPI=<ExpDAPI>][,EXPSAPI=<ExpSAP
I>][,EXPOPER=<ExpOperator>][,TXDAPI=<txDAPI>][,TXSAPI=<txSAPI>][,TXOPER=<txOpera
tor>][,TIMDEF=<TIMdefinition>][,MONTRC=<montrc>][,CHAN=<channel>][,DISCARDPAUSE=
<discardPauseFrames>][,PROPFEFI=<propagateFEFI>][,DEGM=<degrade_interval>][,DEGT
HR=<degrade_threshold>],[XMITIPG=<transmit_interpacketgap>][,MAP=<map>][,OTNMAP=
<OTNMap>][,MAPMODE=<mapMode>]:<pst>,[<sst>]"<cr><lf>;

Table 22.170 Parameter Applicability When Retrieving The Entity

STS1, STS3C, STS12C,

STS48C, STS192C
OTUC2, OTUC3
PARAMETER

TGLAN
GBEP

STMn

OTU1

OTU2

OTU4
1

HGE

OCn
DEF

CPTYPE ND X X X X X X X X X X

TRC ND X3 X3

SSMSUPP ND X3

QLOVERRIDE ND X3

InQL ND X3

INCTRC ND X X

EXPTRC ND X X

MONTRC ND X X X X X
5 5
PROT ND X X X X X

NENDALS ND X X X

76.MTFP50/30, Rev B January 2018 Page 30-1389

22. Retrieve Commands TL1 Command Reference Manual

Table 22.170 Parameter Applicability When Retrieving The Entity (Continued)

STS1, STS3C, STS12C,

STS48C, STS192C
OTUC2, OTUC3
PARAMETER

TGLAN
GBEP

STMn

OTU1

OTU2

OTU4
1

HGE

OCn
DEF

SFTHRES ND X3 X3 X
3
SDTHRES ND X X3 X

FECTYPE ND X X

TRANSMAP ND X

UPI ND X

AISTYPE ND X4 X4

CBRMAP ND X6 X6

CLOCKTYPE ND X

ALMPF ND X X X X X X X X X X

PMPF ND X

NPOWNER ND X X X X X X X

EXPDAPI ND X X X X

EXPSAPI ND X X X X

EXPOPER ND X X X X

TXDAPI ND X X X X

TXSAPI ND X X X X

TXOPER ND X X X X

TIMDEF ND X X X X

CHAN ND X X

DEGM ND X X X X

DEGTHR ND X X X X

MAP ND X

PST PD X X X X X X X X X X

SST PD X X X X X X X X X X

1. ND: Name Defined or PD: Position Defined

2. Apply to TGLAN supported with T-SFP+
3. Apply to facility supported on SSM-2S only
4. Not applly to facility supported on SSM-2S
5. Not applly to OC/STMn facility associated with virtual port 99 on SSM-2S
6. Not applly to OC/STMn facility associated with front panel on SSM-2S

Page 30-1390 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 22.171 RTRV-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STM1-20-[1-16]-[1-32]
STM16-20-[1-16]-[1-32], STM16-20-
[1-16]-99-[7-30]
STM4-20-[1-16]-[1-32]
STM64-20-[1-16]-[1-40], STM64-20-
[1-16]-99-[1-6]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

almProfile 0-20, 99 Indicates the alarm profile table for the entity.

editablePrimar IS Indicates the primary state and primary state qualifier of a

yState OOS facility.
Possible values for PST:
IS: In-Service
OOS: Out-of-Service

76.MTFP50/30, Rev B January 2018 Page 30-1391

22. Retrieve Commands TL1 Command Reference Manual

Table 22.171 RTRV-{X} Parameters (Continued)

Parameter Value(s) Definition
cp_type OSM1S - OTN SWITCHING MODULE Indicates the type of Module that this facility is supported on.
1 (SFP)
OSM2C - OTN SWITCHING MODULE
2 (CFP)
OSM2S - OTN SWITCHING MODULE
2
(SFP+)
SSM2S - SONET/SDH Switching
Module 2 (SFP/SFP+)
OSM4F - OTN SWITCHING MODULE
4 (FLEXRATE)
OSM4C - OTN SWITCHING MODULE
4 (CFP2)
OSM4S - OTN SWITCHING MODULE
4 (SFP+)
OSM5C - OTN SWITCHING MODULE
5 (CFP2)

trc One to 15 alphanumeric characters Specifies the sent trail trace identification (J0). A value of ""
means that there is no Trail Trace Id sent.

exptrc One to 15 alphanumeric characters Specifies the expected trail trace identification (J0).

A value of "" means that there is no Trail Trace Id expected.

Applies to OCn/STMn facilities supported by OSM-1S/OSM-2S.

inctrc One to 15 alphanumeric characters for Specifies the received trail trace identification (J0).
OCn, TGBEP or STMn port side
facilities (J0). A value of "" means that there is no Trail Trace Id expected.

Applies to OCn/STMn port side facilities supported by OSM-1S/

OSM-2S.

montrc ENABLED-NOAIS Specifies the monitored trace identification mode.

DISABLED - Enter ENABLED-AIS to enable trace monitoring and perform
consequent actions, including protection switches and AIS
maintenance signal insertion when there is a trace mismatch.
- Enter ENABLED-NOAIS to enable trace monitoring but not
perform consequent actions, including protection switches and
AIS maintenance signal insertion when there is a trace
mismatch.
- Enter DISABLED to disable trace monitoring.

Note that AIS insertion is only performed on a terminated entity.

protection YES Indicates if the facility on the transponder has been provisioned
NO as protected.

Setting the value to YES shuts down the output client port side
laser on the transponder instead of sending a maintenance
signal (AIS or LF depending on the type of facility provisioned)
when there is a signal failure detected on the line side of a
transponder.

Setting the value to NO does not shut down the laser on the line
or port side of the transponder. When this value is set standard
maintenance signaling is used.

Page 30-1392 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.171 RTRV-{X} Parameters (Continued)

Parameter Value(s) Definition
fecType REGULAR Specifies the type of FEC supported on the OTU1/OTU2/OTU4
NOFEC client side facility.
SUPER REGULAR FEC is the G.709 FEC.
SUPERI7 The SUPER FEC provides more than 8 dB of coding
gain.(Applicable for OTU2 facility supported on OSM-2S/OSM-
4S)
Only OSM-2S/OSM-4S supports SuperI7 which is an alternative
enhanced FECTYPE.
NOFEC: FEC is disabled.

Applies to OTU1 facility supported by OSM-1S, OTU2 facility

supported by OSM-2S/OSM-4S.

The OSM-2C/OSM-5C supports the following FEC values for

the OTU4 facility:
REGULAR

SFThreshold 10E-3 Specifies the threshold for Signal Failure on OCn and STSn on
10E-4 SSM-2S.
10E-5

SDThreshold 10E-5 Specifies the threshold for Signal Degrade on OCn and STSn on
10E-6 SSM-2S.
10E-7
10E-8
10E-9

NendALS YES This parameter, when set to YES, shuts down port side laser
NO upon a port side incoming failure (such as LOS/LOF/LOSYNC).

Applies only to GBEP supported by OSM-1S, to TGLAN

supported by OSM-2S/OSM-4S, to HGE supported by OSM-2C/
OSM-5C.

AIStype AISL When a network failure occurs, AIS is transmitted out of the
GENAIS OCn port to suppress subsequent LOS or LOF alarms on
SONET connected equipment.

There are two types of signals which may be inserted. A setting

of AISL inserts client based AIS-L out of the port per Telecordia
GR.253. A setting of GENAIS inserts a generic AIS signal based
on a PN-11 sequence per ITU-T G.709.

ssmSupported YES It is used to indicate whether this facility supports SSM

NO generation or not.
Yes: the transmitted QL is based on synchronization selection
process.
NO: the transmitted QL on the facility is DUS/DNU by forced.

76.MTFP50/30, Rev B January 2018 Page 30-1393

22. Retrieve Commands TL1 Command Reference Manual

Table 22.171 RTRV-{X} Parameters (Continued)

Parameter Value(s) Definition
rx_ssm PRS Indicates the quality of the clock that is received on
STU corresponding facility that used as line timing source.
ST2
TNC PRS: Stratum 1/PRS Traceable
ST3E STU: Synchronized Traceability Unknown
ST3 ST2: Stratum 2 Traceable
SMC TNC: Transit Node Clock Traceable
ST4 ST3E: Stratum 3E Traceable
PNO ST3: Stratum 3 Traceable
DUS SMC: SONET Minimum Clock Traceable
ALL ST4: Stratum 4 Traceable
PNO: Reserved for Network Sync.
DUS: DON'T USE for Synchronization
ALL: Supporting module is not equipped, or an unrecognized
value is received for the SSM.

Applicable to OCn facilities supported by SSM2S

qualityLevelOv DISABLED It is used to show the override QL value by operator, when it is

erride PRS disabled, there is no override operation.
ST2 DISABLED
TNC QL value:
ST3E Option II: QL-PRS, QL-ST2, QL-TNC, QL-ST3E, QL-ST3, QL-
ST3 SMC, QL-ST4, QL-PROV, QL-DUS
SMC Option I: QL-PRC, QL-SSU-A, QL-SSU-B, QL-SEC, QL-DNU
ST4
PROV
DUS
PRC
SSU-A
SSU-B
SEC
DNU

ClkType G709 Specifies the rate of the OTU2 port side facility.
OVRCLK_FS G.709: 10.7 Gb/s.
OVRCLK_NOFS OVRCLK_FS: 11.095 Gb/s

cbrMap SYNC Specifies the mapping type of the constant bit rate signal into an
ASYNC OPU, either bit-synchronously (SYNC) or asynchronously
(ASYNC).

NpOwner 3 Specifies which network partition ownes this entity.

ExpDAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected DAPI.
Refer to section 2 for the applicable characters.

ExpSAPI One to 15 alphanumeric characters Specifies 15 characters representing the expected SAPI.
Refer to section 2 for the applicable characters.

ExpOperator One to 32 alphanumeric characters. Specifies 32 characters representing the expected value for the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

txDAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted DAPI.
Refer to section 2 for the applicable characters.

txSAPI One to 15 alphanumeric characters Specifies 15 characters representing the transmitted SAPI.
Refer to section 2 for the applicable characters.

Page 30-1394 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.171 RTRV-{X} Parameters (Continued)

Parameter Value(s) Definition
txOperator One to 32 alphanumeric characters. Specifies 32 characters representing the transmitted value in the
Operator Specific area of the TTI.
Refer to section 2 for the applicable characters.

TIMdefinition SAPI Specifies the definition of the trace identifier mismatch alarm by
DAPI identifying which portion(s) of the TTI message are compared
OPER for trace identifier mismatch purposes.
SAPI_DAPI - OPER (Operator Specific mismatch only),
SAPI_DAPI_OPER - SAPI (SAPI mismatch only),
SAPI_OPER - DAPI (DAPI mismatch only),
DAPI_OPER - SAPI_DAPI (SAPI + DAPI Mismatches),
- SAPI_OPER (SAPI + OPER mismatches),
- DAPI_OPER (DAPI + OPER mismatches),
- SAPI_DAPI_OPER (SAPI + DAPI + OPER mismatches).

channel (1) NA (2) 1-88 (3) 191700000 to Specifies either the DWDM channel number or the DWDM
196050000 in increments of 50000 frequency at which the interface operates when the supporting
SFP+ for the facility is a tunable DWDM SFP+.

The channel number can be set to an integer value from 1-88,

corresponding to the DWDM wavelength/frequency in the 7100
88-Channel Plan.
Or the frequency can be set to a value between 191700000 to
196050000 MHz in increments of 50000 MHz which covers a
total of 88 DWDM frequencies (191.7 THz to 196.05 THz in 50
GHz increments.)
A setting of NA (Not Applicable) allows the supporting SFP+ to
operate at its default wavelength.

degrade_interv [2-10] Indicates the consecutive number of one second intervals with
al the number of detected block errors exceeding the block error
threshold for each of those seconds for the purposes of SDBER
detection.

degrade_thres [1-2590844] Indicates the threshold number of block errors at which a one
hold second interval is considered degraded for the purposes of
SDBER detection.

Possible values are:

1 to 20421, default of 3064 (OTU1)
1 to 82026, default of 12304 (OTU2)
1 to 84986, default of 12748 (OTU2e)
1 to 856388, default of 128459 (OTU4)
1 to 863615, default of 129543 (OTU4 with 25% SD-FEC)
1 to 1727230, default of 259085 (OTUC2)
1 to 2590844, default of 388627 (OTUC3)

map GMP Specifies the Transparent mapping variance of the HGE facility
GFP-F on OSM-2C/OSM-5C.

GMP: Per section 17.7.5 of ITU-T G.709, HGE is GMP mapped

to ODU4 with PSI=0x07. Preamble and IPG transported.
GFP-F: Per section 17.4 of ITU-T G.709, HGE is GFP-mapped
frames to ODU4 with PSI=0x05. Neither Preamble nor IPG
transported.

76.MTFP50/30, Rev B January 2018 Page 30-1395

22. Retrieve Commands TL1 Command Reference Manual

Table 22.171 RTRV-{X} Parameters (Continued)

Parameter Value(s) Definition
pst IS-NR Indicates the primary state and primary state qualifier of a
IS-ANR facility.
IS-RST Possible values for PST:
IS-ANRST - IS: In-Service
OOS-AU - OOS: Out-of-Service
OOS-MA Possible values for PSTQ:
OOS-AUMA - NR: normal
OOS-AURST - ANR: abnormal
OOS-MAANR - RST: restricted
- ANRST: abnormal and restricted
- AU: autonomous
- MA: management
- AUMA: autonomous and management
- AURST: autonomous and restricted
- MAANR: management and abnormal

UPI GSUPP43 Specifies the GFP UPI values transmitted for a TGLAN with
G709AMD3 TRANSMPA=PREAMBLE.

GSUPP43 - 0xFD for data frames and 0xFE for ordered sets.
Provides compatibility with ITU-T Supplemental43
recommendation.
G709AMD3 - 0x13 for data frames and 0x14 for ordered sets.
Provides compatibility with ITU-T G.709 recommendation values
first introduced in Amendment 3.

secondaryStat ACTIVE Indicates the secondary state of a facility.

e/sst ACTTMG - ACTIVE: active
BERT-PRBS-TX - ACTTMG: active synchronization reference
BERT-PRBS-RX - BERT-PRBS-TX: transmit PRBS BER test
BUSY - BERT-PRBS-RX: receive PRBS BER test
DISC_INPROG - BUSY: busy
FAF - DISC_INPROG: neighbor discovery in progress
IDLE - FAF: facility failure
LPBKF - IDLE: idle
LPBKT - LPBKF: loopback facility
MT - LPBKT: loopback terminal
NALMQI - MT: maintenance
PMI - NALMQI: Not alarmed qualified inhibit
SGEO - PMI: performance monitoring inhibited
PARTIAL - SGEO: supporting entity outage
STBY - STBY: standby
STBYTMG - STBYTMG: standby synchronization reference

Page 30-1396 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 22. Retrieve Commands

Table 22.171 RTRV-{X} Parameters (Continued)

Parameter Value(s) Definition
Transmap FRAME_STD Specifies the Transparent mapping variance of the TGLAN
PREAMBLE facility on a OSM-2S/OSM-4S transponders:
LINE_FS
- FRAME_STD: GFP-mapped frames for frame Transparent
10G LAN using mapping via OTU2 in standard mode. Neither
Preamble nor IPG transported (Standard G.709 GFP mapped
Payload).
G.709 17.4/G.7041 7.1: GFP-F to OPU2

- PREAMBLE: GFP-mapped frames. Preamble transported

(GFP-mapped payload with OPU overhead used for extra
needed bandwidth).
G.709 17.4.1/G.7041 7.9: GFP-F to Extended OPU2
Note: For TGLAN, TRANSMAP=PREAMBLE includes support
to transport RF/LF ordered sets to far-end client connected
device.

- LINE_FS: Frame, Preamble and IPG all transported with over

clocked G.709 (OTU2) with fixed stuff (64/66B).
G.709 17.2.4: CBR 10.3G to OPU2e

Example 1
RTRV-OC192:CORIANT1:OC192-20-3-1:AM0181;

Possible System Response

CORIANT1 02-02-02 03:20:21

M AM0209 COMPLD

"OC192-20-3-1::CPTYPE=\"OSM2S - OTN SWITCHING MODULE 2 (SFP+)\",

EXPTRC=\"BELL\",INCTRC=\"BELL\",MONTRC=ENABLED-AIS,PROT=YES,ALMPF=99:IS-NR,"
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
DLT-{X}
ED-{X}
ENT-{X}

76.MTFP50/30, Rev B January 2018 Page 30-1397

23. Schedule Commands TL1 Command Reference Manual

23. Schedule Commands

SCHED-BKUP-MEM

Command Changes Since Previous Feature Package

• None.

Description
Use the SCHED-BKUP-MEM command to schedule automatic backups of the primary memory of the NE to a
remote server. The scheduling allows to set up these backups to occur periodically.

Once executed, the SCHED-BKUP-MEM function runs in the background. Therefore, additional TL1 commands can
be entered once a COMPLD message is displayed. This COMPLD message indicates that the specified backup is
scheduled and will run at the time specified in the command.

Note 1: For a backup to a remote server, the password and user id of the remote
server are verified at the time of scheduling, if the remote server is
available. If the remote server is unavailable at the time of scheduling,
then the backup may not occur because of an invalid user id or password
and an error message is displayed to that effect. If the databases of
multiple NEs are being backed up to the same remote server, stagger
the backup times of the individual NEs.

Note 2: The first time a database backup schedule is created, it is inhibited.

Enter the ALW-BKUPSCHED-MEM command to allow database
backups to occur according to the schedule specified.

The backup schedule that is specified in the most recently executed SCHED-BKUP-MEM command overwrites any
pre-existing schedule. A single backup schedule can be configured per network element.

The file with the .CURRENT extension indicates the latest backup available.

The file with the .BACKUP extension indicates an older version of the backup.

The format of the backup file name is: SID_SWVersion.CURRENT or SID_SWVersion.BACKUP. The .BACKUP file
is created when a new .CURRENT file is added. The filename extension is changed, so two possible backups can
be used to restore from.

Note: File transfers done using this command are done using binary format.

Command Format
SCHED-BKUP-MEM:[tid]:[<backup_mem_aid>]:ctag::[<datatype>],<remServerUrl>,
<backupInvl>,[<date>],[<time>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>;

Page 30-1398 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 23. Schedule Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 23.1 SCHED-BKUP-MEM Parameters

Parameter Value(s) Definition
backup_mem_ SERVER EntityID
aid

datatype DB Specifies the type of backup memory that is the source.

- Enter DB to specify the NE database.

remServerUrl ftp://userid:pwd@ftphost:[portid]/url- Specifies the remote server FTP URL:

path - <userid> is a valid user identification on the server (OS, EMS,
or other repository). Note that the following characters are not
allowed for <userid>: @ ? / \ { [ ( ) ] }.
- <pwd> is the corresponding password for the valid <userid> on
the server (OS, EMS, or other repository). Note that the
following characters are not allowed for <pwd>: @ ? / \ { [ ( ) ] } .
- <ftphost>[:<portid>] is a valid IP address and optional port
number to access the server.Port number 21 can be used for
non-secure FTP file transfer. Port number 22 is the default value
and can be used for secure FTP (SFTP) file transfer.
- Note: If the NE is a PRNE and the IP address is also in the
same Private Domain (such as Local Craft Interface Port on the
HDP), then the following must be added before the IP address:
"NOPROXY-xxx.yyy.zzz.a".
- <url-path> specifies the device/drive/directory/ to put the
backup file. The file name should not be specified. The NE
automatically configures this name using the following generic
format:
- SID_SWversion.CURRENT for the first backup.
- SID_SWversion.BACKUP for the second backup.

date MOY-DOM format:(1)MOY = 1 - Specifies the date of the first scheduled backup:
12.(2)DOM = 1 - 31. - MOY identifies the month of the year.
- DOM identifies the day of the month.

time Enter HOD-MOH format:(1)HOD = 0 - Specifies the time of day of the first scheduled backup:
23 (2)MOH = 0 - 59 - HOD identifies the hour of the day.
- MOH identifies the minute of the hour.

backupinvl x-y format:(1)x can equal a range of: Specifies the time interval between scheduled memory backups
2-24 (hours), 120-1440 (minutes), 1- (see also date and time).
31 (days). (2)y can equal: HR, MIN, or Examples:
DAY - to specify a backup interval of every 12 hours, enter 12-HR.
- to specify a backup interval of every 12.5 hours, enter 750-
MIN.
- to specify a backup interval of every 3rd day, enter 3-DAY.

Example
The following example schedules a database backup from primary memory to a remote server named
"NYSERVER". This backup will occur daily, starting on April 19 at 1:05 a.m.

SCHED-BKUP-MEM:CORIANT1::AM0045::DB,"ftp://user1:passwd1@172.112.21.4:21/dir2/
",1-DAY,4-19,1-05;

76.MTFP50/30, Rev B January 2018 Page 30-1399

23. Schedule Commands TL1 Command Reference Manual

Possible System Response

CORIANT1 02-04-16 02:08:15

M AM0045 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-BKUPSCHED-MEM
INH-BKUPSCHED-MEM
RTRV-BKUPSCHED-MEM

Page 30-1400 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 23. Schedule Commands

SCHED-PMFILE-{X}

Command Changes Since Previous Feature Package

• Added support of ODUk mux into the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
The SCHED-PMFILE-{X} command instructs the network element to schedule the reporting of SONET, ODUk
historical performance-monitoring data on a selected STS, ODUk entity in binary file format. When this command is
used, it is expected that the NE will periodically send STS Path PM or ODUk PM data in a binary file using the
automatic REPORT EVENT TRANSFER MESSAGE (REPT^EVT^FXFR) message.

Once executed, the SCHED-PMFILE-{X} function runs in the background, therefore, any TL1 commands can be
entered once a COMPLD message is displayed. This COMPLD message indicates that the specified performance-
monitoring file transfer is scheduled. File transfer report would run every 15 minutes at x:00, x:15, x:30, x:45 (where
x=00 to 23) when tmper=15-MIN or would run at 12:00 am everyday when tmper=1-DAY.

The PM mode of the selected STS, ODUk entity may be retrieved by using the RTRV-PMMODE-{X} command.
Refer to the RTRV-PM-{X} command for a list of all STS, ODUk PM supported by the network element in this
release.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type):ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, STS1, STS3C, STS12C,
STS48C, STS192C.

Restrictions and Exceptions

• Only ODUk path PM is contained in the binary file.

• The Facility AID {fac_aid} must always correspond to the Facility type {fac_type}.

• The file name does not need to be specified. The NE automatically configures this name using the
following generic format: TID-RrTMMDDhhmmnnSSsspp.xx where TID= NE SID, R = report interval
(value Q=15 min, D= 1 Day), r= report type (value H=Historical), T=type of Data (value P= Path PM,
O=ODU), SS = ShelfId (value between 01 and 15 or 00 for ALL), ss = SlotId (value between 01 and 19
or 00 for ALL), pp= PortId (value between 01 and 11 or 00 for ALL), MMDDhhmm = scheduled report
interval time in Months (01-12), Days (01-31), Hours (00-23), Minutes (00-59), nn= 00, xx= file suffix
(GZ or ZIP for compressed file, DAT for uncompressed file, TMP for temporary file).

Command Format
SCHED-PMFILE-<fac_type>:[tid]:<fac_aid>:ctag::[<ftpserver_aid>],[<tmper>];

Proper System Response:

<header>
M <ctag> COMPLD
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1401

23. Schedule Commands TL1 Command Reference Manual

Table 23.2 SCHED-PMFILE-{X} Parameters

Parameter Value(s) Definition
fac_aid ODU0-20-[1-16]-[1-32], ODU0-20-[1- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1- ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]

fac_type ODUF Specifies the facility type.

ODU0
ODU1
ODU2
ODU2E
ODU3
ODU4
STS1
STS3C
STS12C
STS48C
STS192C

ftpserver_aid FTPSERVER-1 Specifies the FTP server.

Default: FTPSERVER-1 - Enter FTPSERVER to specify a remote server.

Page 30-1402 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 23. Schedule Commands

Table 23.2 SCHED-PMFILE-{X} Parameters (Continued)

Parameter Value(s) Definition
tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

Example
The following example schedules a report to be generated in binary file format for a STS3C facility for historical 15-
min PM data. This report is generated every 15 minutes and will include data for the previous 15-min period.

SCHED-PMFILE-STS3C::STS3C-20-1-1-4:CTG01::FTPSERVER-1,15-MIN;

The following example schedules a report to be generated in binary file format for a ODU1 facility for historical 15-
min PM data. This report is generated every 15 minutes and will include data for the previous 15-min period.

SCHED-PMFILE-ODU1::ODU1-20-1-1:CTG01::FTPSERVER-1,15-MIN;

Possible System Response

CORIANT1 07-08-02 03:20:21

M CTG01 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-PMFILE-{X}
INH-PMFILE-{X}
RTRV-PMFILESCHED-{X}
ENT-FTPSERVER
RTRV-FTPSERVER
ED-FTPSERVER
DLT-FTPSERVER

76.MTFP50/30, Rev B January 2018 Page 30-1403

23. Schedule Commands TL1 Command Reference Manual

SCHED-PMREPT-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The SCHED-PMREPT-{X} command instructs the network element to start, reschedule, or remove the reporting of
performance-monitoring data on a selected equipment or facility entity. When this command is used, it is expected
that the NE will periodically return data using the automatic REPORT PERFORMANCE MONITORING message.

Once executed, the SCHED-PMREPT-{X} function runs in the background, therefore, any TL1 commands can be
entered once a COMPLD message is displayed. This COMPLD message indicates that the specified performance-
monitoring report is scheduled and will run at the time specified in the command.

The PM mode of this entity may be retrieved by using the RTRV-PMMODE-{X} command. Refer to the RTRV-PM-
{X} command for a list of all PM supported by the network element in this release.

The value of <tmofst> should be selected to correspond to a point backward in time from the completion time of the
most recently completed accumulation period. Furthermore, <tmofst> should be related to the value specified for
<tmper> such that the end of every <tmper> coincides with the end of one of the reporting intervals (<reptinvl>).
Usually the key value of <tmofst> is an integral multiple of <reptinvl>, meaning that the reports contains only
completed accumulation periods. By convention, however, a 0-0-0 value for <tmofst>, or any value less than that of
<tmper>, will result in the selection of the current register (with partial data) or that same register just having
completed its accumulation.

Only one <montype> or all <montype> per selected equipment or facility can be scheduled for a given time period
(<tmper>). For a given entity (EQPT or facility), one 15 min. scheduled report and one 24 hour scheduled report is
allowed. Scheduling a report for another <montype> with the same <tmper> will supersede or overwrite the previous
report.
• Facilities (fac_type): GBEP, TGLAN, FGE, HGE, OC3, OC12, OC48, OC192, OCH (for OCH-P, OCH-
OS), OTU1, OTU2, OTU4, OTUC2, OTUC3.

Restrictions and Exceptions

• The Facility AID must always correspond to the Facility type.

• When no MONTYPE is specified, the command applies to all MONTYPES supported by the facility or
equipment.

Command Format
SCHED-PMREPT-{<fac_type>}:[tid]:{<fac_aid>}:ctag::[<reptinvl>],
[<start_time>],[<numrept>],[<montype>],[<monlev>],[<locn>],[<dirn>],[<tmper>]
[,<tmofst>]
;

Proper System Response:

<header>
M <ctag> COMPLD
;

Page 30-1404 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 23. Schedule Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 23.3 SCHED-PMREPT-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
TGLAN-20-[1-16]-[1-40]

reptinvl Enter the appropriate interval in the X- Specifies the time interval between scheduled PM reports.
UNIT format: (1) UNIT = DAY, HR or Example:
MIN. (2) X = 1 - 24 if UNIT = DAY. (3) - Enter 1-DAY to schedule a PM report every day.
X = 1 - 24 if UNIT = HR. (3) X = 15 - - Enter 12-HR to schedule a PM report every 12 hours.
480 (specified in multiples of - Enter 30-MIN to schedule a PM report every 30 minutes.
15) if UNIT = MIN. The system default is the type of time period being scheduled,
as specified in the "tmper" variable (such as, 15-MIN if TMPER
is 15-MIN).

start_time HR-MIN format: (1) HR is any number Specifies the starting time for performance monitoring reporting.
in the range 0-23. (2) MIN is any The default is the start of the next collection interval.
number in the range 0-59.

numrept (1)0 (2)1 - 32767 (3)blank field Specifies the number of intervals during which a report will
occur:
- If this field is 0, the report is cancelled.
- If this field is null, the report will run continuously at its
scheduled time.
The system default is the blank (null) field.

montype x,x-C,x-F Specifies the type of performance monitoring for the specified
entity.
- x: To be used to specify current value for <montype> x.
- x-C: To be used to specify highest value for gauge <montype>
x. C=Ceiling.
- x-F: To be used to specify lowest value for gauge <montype>
x. F=Floor.

76.MTFP50/30, Rev B January 2018 Page 30-1405

23. Schedule Commands TL1 Command Reference Manual

Table 23.3 SCHED-PMREPT-{X} Parameters (Continued)

Parameter Value(s) Definition
monlev LEV-DIRN. Where: LEV is a value Specifies the level at which the performance monitoring type is
within the range supported for each reported:
montype. DIRN is either UP or DN. - UP means that values equal to or greater than LEV are
reported.
- DN means that values less than LEV are reported.
The system defaults to 50-UP for LBC montype.
The system defaults to 2-UP for LT montype.
The system defaults to -34-UP for OPR and OPT montypes.
The system defaults to 1-UP for all counters montypes. This
means that all counters with value=0 (such as no accumulation)
does not be shown when default <monlev> value is selected.

locn NEND Specifies the location of an event/occurrence in the system:

- Enter NEND to specify a near-end location. Only NEND is
supported.

dirn BTH Specifies the direction of an event/occurrence in the system:

TDTC - Enter BTH for Both directions.
TDTN - Enter TDTC for Transmit direction toward customer.
NA - Enter TDTN for Transmit direction toward network.
Note: If a value is specified for EQPT or for a montype that does
not support that direction, the specified direction is ignored.

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
- Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

tmofst DAY-HR-MIN : (1) DAY is any number Specifies the time offset from the end of the last complete
in the range 0-99. (2)HR is any accumulation time period to the beginning of the accumulation
number in the range 0-23. (3) MIN is time period specified in <tmper>.
any number in the range 0-59. <tmofst> should be an integral multiple of <tmper>.
<tmofst> is limited to 7 days for 1-DAY periods and to 8 hours
for 15-MIN periods.
A null value for <tmofst> defaults to 0-0-0.

Example
SCHED-PMREPT-OTU2::OTU2-2-2-3:CTG01::8-HR,06-15,,ES-OTU,150-UP;

Possible System Response

CORIANT1 02-02-02 03:20:21

M CTG01 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ALW-PMREPT-{X}
INH-PMREPT-{X}
RTRV-PMSCHED-{X}

Page 30-1406 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

24. Set Commands

SET-ATTN-OCH

Command Changes Since Previous Feature Package

• None

Description
The SET-ATTN-OCH command instructs the Coriant mTera UTP network element (NE) to set the current power
attenuation level of a EVOA (Electronic Variable Optical Attenuator) on a selected OCH-L facility of an OADMRS/
OADMRS9 when the Automatic Power Adjustment mode has been disabled.

Restrictions and Exceptions

• This command applies to facilities <och_aid> = OCH-L, for which there are EVOAs on OADMRS/
OADMRS9 modules.

• This command should be denied with the appropriate error code if the Automatic Power Adjustment
mode has not been previously set to MANUAL using the ED-OMS (OTSMODE=MTERA or HIT7300)
or ED-OCH (OTSMODE=7100) command.

• Note that this command has no effect if the OCH facility is not involved in OCH cross-connection. EVOA
is at maximum value for facility not involved in OCH cross-connection.

• This command is denied if the OCH facility is not OOS-MA. Therefore OCH facility must be OOS-MA
prior to executing this command. Putting the OCH facility OOS-MA does not affect the traffic.

• An attempt to set ATTNEGR value of OCH-L is denied if AAMEGR of the OCH-L is not MAN.

• An attempt to set ATTNINGR value of OCH-L is denied if AAMINGR of the OCH-L is not MAN.

Command Format
SET-ATTN-
OCH:[tid]:<och_aid>:ctag:::[,ATTNEGR=<attnegress>][,ATTNINGR=<attningress>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1407

24. Set Commands TL1 Command Reference Manual

Table 24.1 SET-ATTN-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-ShelfID-SlotID[-SubslotID]-PortID
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]

attnegress Possible values: (1) 0.0 to 18.0 dB Indicates the current power attenuation level of egress side
with 0.1 dB increments. measured in dB.

attningress Possible values: (1) 0.0 to 18.0 dB Indicates the current power attenuation level of ingress side
with 0.1 dB increments. measured in dB.

Example
SET-ATTN-OCH:CORIANT1:OCH-L-20-1-21:AM0045:::ATTNEGR=2.6,ATTNINGR=0.5;

Possible System Response

CORIANT1 14-12-16 02:08:15

M AM0045 COMPLD

Error Messages
All error codes used by the network element are defined and explained in Table 3.4, page3056.

Related Commands
ED-OCH
RTRV-ATTN-OCH

Page 30-1408 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-ATTR-CONT

Command Changes Since Previous Feature Package

• None.

Description
The SET-ATTR-CONT command instructs the network element to set the attributes associated with an external
contact. These attributes are used when an external contact is operated or released. The related input command is
RTRV-ATTR-CONT.

Restrictions and Exceptions

The mTera shelf SAIM-20-21 supports CONT-[1-2].

Command Format
SET-ATTR-CONT:[tid]:<cont_aid>:ctag::[<controltype>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 24.2 SET-ATTR-CONT Parameters

Parameter Value(s) Definition
cont_aid CONT-[1-2] EntityID-ContID

controltype AIRCOND Specifies the type of contact:

ENGINE - Enter AIRCOND for air conditioning.
FAN - Enter ENGINE for engine.
GEN - Enter FAN for fan.
HEAT - Enter GEN for generator.
LIGHT - Enter HEAT for heat.
MISC - Enter LIGHT for light.
SPKLR - Enter MISC for miscellaneous.
BAMP_1_SHUTDOWN - Enter SPKLR for sprinkler.
BAMP_2_SHUTDOWN - Enter BAMP_x_SHUTDOWN for shutdown of Network
BAMP_3_SHUTDOWN Interfaced Raman number x where x={1-4}.
BAMP_4_SHUTDOWN - Enter CRA_x_SHUTDOWN for shutdown of Network
CRA_1_SHUTDOWN Interfaced Raman number x where x={1-4}.
CRA_2_SHUTDOWN - Enter NIR_x_SHUTDOWN for shutdown of Network Interfaced
CRA_3_SHUTDOWN Raman number x where x={1-4}.
CRA_4_SHUTDOWN
NIR_1_SHUTDOWN
NIR_2_SHUTDOWN
NIR_3_SHUTDOWN
NIR_4_SHUTDOWN
Default: LIGHT

76.MTFP50/30, Rev B January 2018 Page 30-1409

24. Set Commands TL1 Command Reference Manual

Example
SET-ATTR-CONT:CORIANT1:CONT-1:AM0045::HEAT;

Possible System Response

CORIANT1 14-04-16 02:08:15
M AM0045 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ATTR-CONT

Page 30-1410 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-ATTR-ENV

Command Changes Since Previous Feature Package

• None.

Description
Set the notification code, description and condition name or type for environmental alarm or status points.

Restrictions and Exceptions

• String parameters must be used in quotes.

• Default value for <ntfcncde> is NR. Default value for <almmsg> is "Miscellaneous". Default value for the
alarm type <almtype> is MISC.

• A value of NR (Not reported) unassigns an alarm.

• Modifying only the notification code <ntfcnde> leaves the current alarm message <almmsg> and alarm
type <almtype> unchanged.

• Modifying the alarm type <almtype> without modifying the alarm message <almmsg> resets the alarm
message <almmsg> to the definition associated with each alarm type described in "text" below.

Command Format
SET-ATTR-ENV:[tid]:<env_aid>:ctag::[<ntfcncde>],[<almtype>][,<almmsg>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 24.3 SET-ATTR-ENV Parameters

Parameter Value(s) Definition
env_aid ENV-[1-5] EntityID-EnvID

ntfcncde CR Indicates the notification code (severity level) associated with

MJ the condition type.
MN The codes include: critical (CR), major (MJ), minor (MN), or not
NR reported (NR).
The default is not reported (NR) and unassigns an alarm.

76.MTFP50/30, Rev B January 2018 Page 30-1411

24. Set Commands TL1 Command Reference Manual

Table 24.3 SET-ATTR-ENV Parameters (Continued)

Parameter Value(s) Definition
almtype AIRCOMPR Identifies the current state of the alarm conditions.
AIRCOND The text within "..." below describes the default alarm message
AIRDRYR associated with each alarm type.
BAMP_1_FAILURE - AIRCOMPR specifies "Air compressor failure".
BAMP_1_WARNING - AIRCOND specifies "Air conditioning failure".
BAMP_2_FAILURE - AIRDRYR specifies "Air dryer failure".
BAMP_2_WARNING - BAMP_x_FAILURE specifies "Booster Amp number x failure"
BAMP_3_FAILURE where x={1-4}.
BAMP_3_WARNING - BAMP_x_WARNING specifies "Booster Amp number x
BAMP_4_FAILURE warning" where x={1-4}.
BAMP_4_WARNING - BATDSCHRG specifies "Battery discharging".
BATDSCHRG - BATTERY specifies "Battery failure".
BATTERY - CLFAN specifies "Cooling fan failure".
CLFAN - CPMAJORspecifies "Centralized Power Major Environmental
CPMAJOR Alarm or Major Equipment Failure".
CPMINOR - CPMINOR specifies "Centralized Power Minor Environmental
CRA_1_FAILURE Alarm or Minor Equipment Failure".
CRA_1_WARNING - CRA_x_FAILURE specifies "Co-Propagating Raman number x
CRA_2_FAILURE failure" where x={1-4}.
CRA_2_WARNING - CRA_x_WARNING specifies "Co-Propagating Raman number
CRA_3_FAILURE x warning" where x={1-4}.
CRA_3_WARNING - ENGINE specifies "Engine failure".
CRA_4_FAILURE - ENGOPRG specifies "Engine operating".
CRA_4_WARNING - ENGTRANS specifies "Standby Engine Transfer".
ENGINE - EXPLGS specifies "Explosive gas".
ENGOPRG - FIRDETR specifies "Fire detector failure".
ENGTRANS - FIRE specifies "Fire".
EXPLGS - FLOOD specifies "Flood".
FIRDETR - FUELLEAK specifies "Fuel Leak".
FIRE - FUSE specifies "Fuse failure".
FLOOD - GASALARM specifies "Exp Gas/ Toxic Gas/ Vent or Gas Mon
FUELLEAK Fail".
FUSE - GEN specifies "Generator failure".
GASALARM - HATCH specifies "CEV Hatch Fail".
GEN - HIAIR specifies "High airflow".
HATCH - HIHUM specifies "High humidity".
HIAIR - HITEMP specifies "High temperature".
HIHUM - HIWTR specifies "High water".
HITEMP - INTRUDER specifies "Intrusion".
HIWTR - LVDADSL specifies "Secondary ADSL Low Voltage
INTRUDER Disconnect".
LVDADSL

Page 30-1412 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

Table 24.3 SET-ATTR-ENV Parameters (Continued)

Parameter Value(s) Definition
almtype LWBATVG - LWBATVG specifies "Low battery voltage".
(continue) LWFUEL - LWFUEL specifies "Low fuel".
LWHUM - LWHUM specifies "Low humidity".
LWPRES - LWPRES specifies "Low cable pressure".
LWTEMP - LWTEMP specifies "Low temperature".
LWWTR - LWWTR specifies "Low water".
MISC - MISC specifies "Miscellaneous" (default).
NIR_1_FAILURE - NIR_x_FAILURE specifies "Network Interfaced Raman
NIR_1_WARNING number x failure" where x={1-4}.
NIR_2_FAILURE - NIR_x_WARNING specifies "Network Interfaced Raman
NIR_2_WARNING number x warning" where x={1-4}.
NIR_3_FAILURE - OPENDR specifies "Open door".
NIR_3_WARNING - POWER specifies "Commercial power failure".
NIR_4_FAILURE - PWRMJ specifies "Power Supply Major incl Stdby Engine".
NIR_4_WARNING - PWRMN specifies "Power Supply Minor incl Stdby Engine".
OPENDR - PUMP specifies "Pump failure".
POWER - RECT specifies "Rectifier failure".
PUMP - RECTHI specifies "Rectifier high voltage".
PWRMJ - RECTLO specifies "Rectifier low voltage".
PWRMN - RTACADSL specifies "AC or Rectifier Power Fail ADSL Eqpt".
RECT - RTACCRIT specifies "AC or Rectifier Power Fail Trans Eqpt".
RECTHI - RTACPWR specifies "AC or Rectifier Power Fail DCL Eqpt".
RECTLO - RTACPWRENG specifies "Comm AC Fail - Site e/w Stdby
RTACADSL Eng".
RTACCRIT - RTBAYPWR specifies "AC power Loss Distributed Power RT
RTACPWR Bay".
RTACPWRENG - RTRVENG specifies "Retrieve Stdby Eng - Com AC restored".
RTBAYPWR - SMOKE specifies "Smoke".
RTRVENG - TEMP specifies "High-Low Temperature".
SMOKE - TOXICGAS specifies "Toxic gas".
TEMP - TREPEATER specifies "T Repeater Shelf Major".
TOXICGAS - VENTN specifies "Ventilation system failure".
TREPEATER
VENTN

almmsg One to 40 alphanumeric characters. The text message to be associated with the environmental
alarm specified by the <env_aid> parameter.
All the values in "<text>" above are the defaults for each
almtype.
Not entering the parameter in the command does not overwrite
the value unless the alarm type is modified. Only a null value in
this parameter means there is no message text for the
environmental alarm.
Refer to section 2 for the applicable characters.

Example 1
SET-ATTR-ENV:CORIANT1:ENV-1:AM0045::MJ,INTRUDER,"INTRUSION";

Possible System Response

CORIANT1 14-11-16 02:08:15

M AM0045 COMPLD

76.MTFP50/30, Rev B January 2018 Page 30-1413

24. Set Commands TL1 Command Reference Manual

Example 2
To unassign environmental alarm #3, enter the following command:
SET-ATTR-ENV:CORIANT1:ENV-3:AM0045::NR,,;

Possible System Response

CORIANT1 14-04-16 02:08:15

M AM0045 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
REPT^ALM^ENV
RTRV-ATTR-ENV
RTRV-ALM-ENV

Page 30-1414 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-DAT

Command Changes Since Previous Feature Package

• None.

Description
Use the SET-DAT command to adjust the Network Element's system time and date. The year_date and year_time
parameters represent the new local date and local time.

This command is denied if there is at least one NTPPEER configured on the NE. The command is only valid when
NTP is not configured.

Note that all Performance Monitoring parameters for the current 15-min. and 24-hr. period are invalid if the system
time is modified by more than 10 seconds.

Command Format
SET-DAT:[tid]::ctag::[<date>],[<time>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Note: The SET-DAT command changes the system date and time only if NTP is
disabled.

The following is the system response when NTP is enabled for the system.

Note: The system responds with a DENY message when NTP is enabled; the
date and time does not be changed.

<header>

M^^<ctag>^DENY <cr><lf>

^^^"NTP is currently active, NE's date and time unchanged"<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1415

24. Set Commands TL1 Command Reference Manual

Table 24.4 SET-DAT Parameters

Parameter Value(s) Definition
date YY-MM-DD: (1). YY = 00 - 99 (2) MM = Specifies the local Date information.
01 - 12 (3) DD = 01 - 31 - YY is the current calendar year.
- MM is the month of the year.
- DD is the day of the month.

time HH-MM-SS: (1) HH = 00 - 23 (2) MM = Specifies the local Time-Of-Day Recipient Component (TRC)
00 - 59 (3) SS = 00 - 59 information.
- HH is the hour of the day.
- MM is the minute.
- SS is the second.

Example
SET-DAT:CORIANT1::AM0045::02-11-20,14-44-41;

Possible System Response

CORIANT1 02-11-20 14:44:44

M AM0045 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-TOD

Page 30-1416 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-GAIN-OTS

Command Changes Since Previous Feature Package

• None.

Description
The SET-GAIN-OTS command instructs the network element (NE) to set the amplifier gain level to a fixed value on
the selected OTS facility when the Automatic Power Adjustment mode has been disabled.

{X} specifies the equipment type or facility type among the following:
• Facilities (fac_type): OTS.

Restrictions and Exceptions.

• This command is denied with the appropriate error code, if the Automatic Power Adjustment mode has
not been previously set to manual (MAN) using the ED-OTS command.

• This command is denied with the appropriate error code if the ots_aid does not have an input or output
amplifier provisioned.

Command Format
SET-GAIN-OTS:[tid]:<ots_aid>:ctag:::[OGAIN=<ogain>][,IGAIN=<igain>];

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 24.5 SET-GAIN-OTS Parameters

Parameter Value(s) Definition
ots_aid OTS-20-[10-16,1-7]-21,OTS-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

ogain Possible values are: (1)Number Indicates the current applied output gain level applied on the
ranging from 12 to 22 when set on OADMRS/OADMRS9 in dB, with 0.1 dB increments.
OADMRS. (2)Number ranging from 10
to 21.6 when set on OADMRS9.

76.MTFP50/30, Rev B January 2018 Page 30-1417

24. Set Commands TL1 Command Reference Manual

Table 24.5 SET-GAIN-OTS Parameters (Continued)

Parameter Value(s) Definition
igain Possible values are: (1)Number Specifies the current applied input gain level applied on the
ranging from 4.5 to 20.5 when set on OADMRS/OADMRS9 in dB, with 0.1 dB increments.
OADMRS/OADMRS9 and
OPGAINRANGE=LOW. (2)Number
ranging from 18.5 to 30.5 when set on
OADMRS and
OPGAINRANGE=HIGH. (3)Number
ranging from 10.0 to 30.5 when set on
OADMRS9 and
OPGAINRANGE=HIGH.(4)NA.

Example
This command sets the output gain level on the output amplifier to 15 dB:

SET-GAIN-OTS:CORIANT1:OTS-20-1-21:AM0045:::OGAIN=15.0;

Possible System Response

CORIANT1 14-12-16 02:08:15

M AM0045 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTS
RTRV-GAIN-OTS

Page 30-1418 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-OPTPWR-OTS

Command Changes Since Previous Feature Package

• None.

Description
The SET-OPTPWR-OTS command instructs the network element (NE) to set the per channel optical power level
on the selected OTS facility, at the output of the input amplifier and on the DWDM output.

{X} specifies the equipment type or facility type among the following:
• Facilities (fac_type): OTS.

Restrictions and Exceptions

• This command is denied with the appropriate error code if the Automatic Power Adjustment mode has
not been previously set to AUTO using the ED command.

• This command is denied with the appropriate error code if the ots_aid does not have an input (for IPL
parameter) or output amplifier (for OPL parameter) provisioned.

• On OADMRS/OADMRS9, the attempt to edit OPL is denied if OPLADJ of the OTS entity is not
ENABLED which is retrievable through RTRV-OTS.

• OADMRS9 supports an OPL range from -18.0 to +13.7 dBm/channel in increments of 0.1.
OADMRS supports an OPL range from -12.0 to +2.0 dBm/channel in increments of 0.1.

Command Format
SET-OPTPWR-OTS:[tid]:<ots_aid>:ctag:::OPL=opl;

Proper System Response

<header>

M^^<ctag>^COMPLD<cr><lf>

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 24.6 SET-OPTPWR-OTS Parameters

Parameter Value(s) Definition
ots_aid OTS-20-[10-16,1-7]-21,OTS-20-[1- EntityID-ShelfID-SlotID-PortID
16]-1

76.MTFP50/30, Rev B January 2018 Page 30-1419

24. Set Commands TL1 Command Reference Manual

Table 24.6 SET-OPTPWR-OTS Parameters (Continued)

Parameter Value(s) Definition
opl Possible values: (1) Number ranging Specifies the current per-channel output power level set at the
from -12.0 to +2.0 with 0.1 increments DWDM output of the OADMRS/OADMRS9 in the port-to-line
(2) Number ranging from -18.0 to direction (such as TDTN) in dBm/ch, with 0.1 dB increments.
+13.7 with 0.1 increments.
For OADMRS in AUTO APAOutMode, -12.0 to +2.0 dBm/
channel if OTSMODE=MTERA or HIT7300.

For OADMRS9 in AUTO APAOutMode, -18.0 to +13.7 dBm/

channel if OTSMODE=MTERA or HIT7300.

OPL of OADMRS/OADMRS9 module is allowed to be edited

when OPLADJ of its OTS entity is ENABLED.

Example
This command sets the output power level on the OADMRS-20 to +1.0 dBm per channel.
SET-OPTPWR-OTS:CORIANT1:OTS-20-1-21:AM0045:::OPL=1.0;

Possible System Response

CORIANT1 14-12-16 02:08:15

M AM0045 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-OTS
RTRV-OPTPWR-OTS

Page 30-1420 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-OPTTH-OCH

Command Changes Since Previous Feature Package

• None.

Description
The SET-OPTTH-OCH command instructs the network element to set the OPR and OPT minimum and maximum
threshold levels for all PM points of the specified optical channel throughout the NE.

The threshold is set to the +/- value specified in the thoffset parameter.

When this command is successfully executed, these new minimum and maximum threshold values replace the
current minimum and maximum threshold values for the specified OCH AID (which can be either an OCH, OCH-P
or OCH-L AID). The SET-OPTTH-OCH command only modifies what is in the AID specified in the command.

Note that if the current minimum and maximum threshold values were manually set using the SET-TH command
(and set to a value other than the default threshold value), then these threshold values does not be modified by the
SET-OPTTH command. The SET-OPTTH command modifies threshold values only if the current threshold values
are the default ones as defined in the tables in the RTRV-PM command or if the current threshold values were
previously set by the SET-OPTTH command. So this command can be used multiple times over the same montype.

To reset a threshold value for a specific PM point to its default value use SET-TH command with <thlev> = DFLT.

The threshold value set with this command cannot exceed the value range specified for the PM point (-45 to+20
dBm). If the new calculated threshold value is outside the range, the minimum or maximum threshold value is
applied.

It is recommended that PM be enabled on all OCH facilities for at least one 15-minute collection period before
applying this command. The system must be stable with minor power variations on OCH facilities.

Restrictions and Exceptions

• This command applies only to OCH-L and OCH-P.

• On OADMRS-20, this command is only applicable to OPR optical power of OCH-L but not apply to OPT
optical power threshold setting.

Command Format
SET-OPTTH-OCH:[tid]:<och_aid>:ctag::<thoffset>;

Proper System Response:

<header>
M <ctag> COMPLD
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1421

24. Set Commands TL1 Command Reference Manual

Table 24.7 SET-OPTTH-OCH Parameters

Parameter Value(s) Definition
och_aid OCH-20-[10-16,1-7]-[1-3]-[1-88], EntityID-Type-ShelfID-SlotID-PortID-Num
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-P-20-[1-16]-[1-40]

thoffset 0.0 to 6.0 dB, in 0.1 dB increments Specifies threshold offsets in dB from the current power
measurement.
For example, if the offset is 2.0, the maximum threshold is
current power plus 2.0 dB and the minimum threshold is current
power minus 2.0 dB.
Setting the value = 0.0 will restore the TH values to the original
Threshold defaults defined in the RTRV-PM section.

Example
SET-OPTTH-OCH::OCH-P-20-1-1:CTG01::4.0;

Possible System Response

CORIANT1 14-12-02 03:20:21
M CTG01 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-TH-{X}

Page 30-1422 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-PMDAY

Command Changes Since Previous Feature Package

• None.

Description
SET-PMDAY allows the start time of the daily PM data collection period to begin at any hour of the day. The current
start time of the daily data collection period may be retrieved using the RTRV-PMDAY command.

Restrictions and Exceptions

• If 1-DAY PM data experiences the PMDAY change, the attempt to retrieve the 1-DAY PM data will
possibly be denied when the adjusted period results in a collection length greater than 24 hours.

Command Format
SET-PMDAY:[tid]::ctag::<daystart>;

Proper System Response:

<header>
M <ctag> COMPLD
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 24.8 SET-PMDAY Parameters

Parameter Value(s) Definition
daystart [0-23] Specifies the hour of starting collecting 1-DAY monitoring
parameters.
To reset the NE clock to the default value of 00:00 hours, the
parameter should contain the value 0.

Example
SET-PMDAY:::CTG01::12;

Possible System Response

CORIANT1 02-02-02 03:20:21
M CTG01 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-PMDAY

76.MTFP50/30, Rev B January 2018 Page 30-1423

24. Set Commands TL1 Command Reference Manual

SET-PMMODE-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

• Added far-end PM support for OSM-4C, OSM-4F.

Description
The SET-PMMODE-{X} command instructs the network element to activate or deactivate the Performance
Monitoring (PM) status of the selected facility entity for a specific location and modetype. When PM data collection
is activated, the data is stored in registers for eventual output in a scheduled PM report. Refer to the RTRV-PM-{X}
command for a list of all PM supported by the network element in this release.
The PM mode of this entity may be retrieved by using the RTRV-PMMODE-{X} command.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): GBEP, FGE, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L and OCH-
P, OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4, OTUC2,
OTUC3, OMS, OSC, STS1, STS3C, STS12C, STS48C, STS192C, TGLAN.

Restrictions and Exceptions

• Setting PMMODE to OFF for a specific equipment/facility sets both PMMODE and TCAMODE OFF for
this equipment/facility on the specified direction and modetype.

• PMMODE should be ON for a specific equipment/facility in order to SET-TCAMODE-{x} to ON,

otherwise the command is denied.

• The Facility AID must always correspond to the Facility type.

• The parameter <locn> can be either NEND (near-end) or FEND (far-end). The command does not
support both near-end and far-end at the same time.

Command Format
SET-PMMODE-{<fac_type>}:[tid]:{<fac_aid>}:ctag::[<locn>],<modetype>
[,<pmstate>];

Proper System Response:

<header>
M <ctag> COMPLD
;

Parameters

Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1424 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

Table 24.9 SET-PMMODE-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OMS-20-[10-16,1-7]-[1-21],OMS-20-
[1-16]-[1,3-11], OMS-20-[10-16,1-7]-
[1-3]-[1-8]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]

76.MTFP50/30, Rev B January 2018 Page 30-1425

24. Set Commands TL1 Command Reference Manual

Table 24.9 SET-PMMODE-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS12C-20-[1-16]-[1-30]-[181,- EntityID-ShelfID-SlotID-PortID
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]
STS192C-20-[1-16]-[1-6]-1, STS192C-
20-[1-16]-99-[1-6]-1
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

locn NEND specifies the location of an event/occurrence in the system:

FEND - Enter NEND to specify a near-end location.
Default: NEND - Enter FEND to specify a far-end location
Default is NEND.

modetype ALL Specifies the type of performance monitoring control attribute:

- Enter ALL to specify all applicable layers and supported
montypes for the specified entity. Only ALL is supported.

pmstate ON Specifies whether or not PM data is being collected:

OFF - ON indicates PM data is collected.
Default: OFF - OFF indicates PM data is not collected.
The default is OFF.

Example
SET-PMMODE-ODU0::ODU0-20-1-1:CTG01::NEND,ALL,ON;

Possible System Response

CORIANT1 02-02-02 03:20:21

M CTG01 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
INH-PMREPT-{X}
RTRV-PM-{X}
RTRV-PMMODE-{X}

Page 30-1426 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-SID

Command Changes Since Previous Feature Package

• Extend SID to support string up to 35 characters.

Description
Use the SET-SID command to set the Network Element's system identification code. Where appropriate, the value
of this SID code is used as the target identifier (TID) in an input command and as the source identifier in an output
or autonomous message.

Changing the SID may result in a mismatch of the SID value in the response headers with TID value in commands
received prior to the change.

It is recommended the system_id_code be set to the CLLI code. The system_id_code needs to be entered in all
capital letters.

Restrictions and Exceptions

String parameters must be used in quotes.

Command Format
SET-SID:[tid]::ctag::<sid>;

Proper System Response

<cr><lf><lf>

^^^<SID>^<YY-MM-DD>^<HH:MM:SS><cr><lf>

M^^<ctag>^COMPLD<cr><lf>

Note: The SID in this response has the same value as the new system
identification code in the input command.

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 24.10 SET-SID Parameters

Parameter Value(s) Definition
sid One to 35 characters Specifies the system identification code to be assigned to the
Default: CORIANT NE. The value of SID may be any valid simple or compound TL1
identifier or text string. Uppercase letters, the digits 0-9,
underscore, dash, and period characters are allowed.

Example
SET-SID:CORIANT1::AM0045::"CORIANT-MTL_2";

76.MTFP50/30, Rev B January 2018 Page 30-1427

24. Set Commands TL1 Command Reference Manual

Possible System Response

CORIANT-MTL_2 02-11-20 14:44:44

M AM0045 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ED-NE

Page 30-1428 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

SET-TCAMODE-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The SET-TCAMODE-{X} command instructs the network element to activate or deactivate the Threshold Crossing
Alert (TCA) status of the selected facility entity. It allows or denies the reporting of the TCAs of all monitored types
of the selected entity.
The TCA mode of this entity may be retrieved by using the RTRV-TCAMODE-{X} command.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): FGE, GBEP, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L, OCH-P,
OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4, OTUC2,
OTUC3, OSC, STS1, STS3C, STS12C, STS48C, STS192C, TGLAN.

The following facilities do support PM but do not have TCA for some MONTYPES: OMS (No TCA for OPR/OPT
MONTYPES); GBEP/OC3/OC12/OC48/OC-192/TGLAN/FGE/HGE (No TCA for PSC/PSD MONTYPES).

Restrictions and Exceptions

• When the threshold level value <thlev> parameter is set to 0 for a counter montype, then no automatic
message (TCA) is generated for this montype, even if TCAMODE is set to ON.

• PMMODE should be ON in order to SET-TCAMODE-{x} to ON or OFF. TCA is not generated unless

both PMMODE and TCAMODE are set to ON for a specific facility.

• Setting PMMODE to ON for a specific facility sets both PMMODE and TCAMODE ON for this facility on
the specified direction and modetype.

• Setting PMMODE to OFF for a specific facility sets both PMMODE and TCAMODE OFF for this facility
on the specified direction and modetype.

• Setting TCAMODE to OFF for a specific facility disables TCA for this facility on all directions and
modetypes supported by this facility.

• The Facility AID must always correspond to the Facility type.

Command Format
SET-TCAMODE-{<fac_type>}:[tid]:{<fac_aid>}:ctag::[<tcastate>];

Proper System Response:

<header>
M <ctag> COMPLD
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1429

24. Set Commands TL1 Command Reference Manual

Table 24.11 SET-TCAMODE-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
GBEP-20-[1-16]-[1-32] ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
STS1-20-[1-16]-[1-30]-[1-192], STS1-
20-[1-16]-99-[1-30]-[1-192]
STS12C-20-[1-16]-[1-30]-[181,-
,37,25,13,1], STS12C-20-[1-16]-[1-
30]-99-[181,-,37,25,13,1]

Page 30-1430 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

Table 24.11 SET-TCAMODE-{X} Parameters (Continued)

Parameter Value(s) Definition
fac_aid (cont.) STS192C-20-[1-16]-[1-6]-1, STS192C- EntityID-ShelfID-SlotID-{PortID[-SupportingODU4
20-[1-16]-99-[1-6]-1 ODU4TribPort][-SupportODU ODUTribPort][-TribID]|Vport-n}
STS3C-20-[1-16]-[1-30]-[190,-
,13,10,7,4,1], STS3C-20-[1-16]-99-[1-
30]-[190,-,13,10,7,4,1]
STS48C-20-[1-16]-[1-30]-
[145,97,49,1], STS48C-20-[1-16]-99-
[1-30]-[145,97,49,1]
TGLAN-20-[1-16]-[1-40]

tcastate ON Specifies whether or not TCAs are being reported:

OFF - ON specifies TCAs are reported.
Default: ON - OFF specifies TCAs are not reported.

Example
SET-TCAMODE-ODU0::ODU0-20-1-1:CTG01::OFF;

Possible System Response

CORIANT1 02-02-02 03:20:21

M CTG01 COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-TCAMODE-{X}

76.MTFP50/30, Rev B January 2018 Page 30-1431

24. Set Commands TL1 Command Reference Manual

SET-TH-{X}

Command Changes Since Previous Feature Package

• Added OSM-4F OTUC3 (300G) support.

• Added support for OSM-4S, OSM-5C.

Description
The SET-TH-{X} command instructs the network element to set the threshold level for a monitored parameter of the
selected facility entity that, when exceeded, triggers an automatic message (TCA). The threshold setting for multiple
monitored parameters or time periods requires multiple commands from the OS.

The threshold settings of this entity may be retrieved using the RTRV-TH-{X} command.

{X} specifies the facility type among the following AIDs:

• Facilities (fac_type): FGE, GBEP, TGLAN, HGE, OC3, OC12, OC48, OC192, OCH (for OCH, OCH-L,
OCH-P and OCH-OS), ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3, ODU4, OTU1, OTU2, OTU4,
OTUC2, OTUC3, OSC.

The following facilities do support PM but do not have TCA for some MONTYPES: OMS (No TCA for OPR/OPT
MONTYPES); GBEP/OC3/OC12/OC48/OC-192/TGLAN/FGE/HGE (No TCA for PSC/PSD MONTYPES).
See the RTRV-PM command for the valid threshold ranges supported for each montype.

Restrictions and Exceptions

• For montypes that support a threshold range that includes the value 0, when the threshold level <thlev>
parameter is set to 0 for a counter montype, no automatic message (TCA) is generated for this montype.
Also, any TCAs announced during the time period, prior to setting the parameter to 0 will still be visible
via RTRV-TCA.

• The value specified for High Threshold (HT) should always be greater than the value specified for Low
Threshold (LT).

• The Facility AID must always correspond to the Facility type.

• UTIL Montype is a gauge that supports HT only.

• BER-FEC Montype is a gauge that supports HT only.

• The OCH-L OPT threshold of OADMRS/OADMRS9 is an offset value reference to OPL (RTRV-
OPTPWR-OTS). Note that it is necessary to enter a negative value for the low threshold to be below
the reference value.

Command Format
SET-TH-
<fac_type>:[tid]:<fac_aid>:ctag::<montype>,<thlev>,[<locn>],[<dirn>][,<tmper>];

Proper System Response:

<header>
M <ctag> COMPLD
;

Page 30-1432 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 24. Set Commands

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 24.12 SET-TH-{X} Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-20-[10-16,1-7]-[1-3]-[1-88],
OCH-20-[1-16]-[1-2]-[19135-19610],
OCH-20-[10-16,1-7]-[1-20], OCH-20-
[10-16,1-7]-[1-3]-[2-13], OCH-[50-58]-
[2-4,6-8]-[3-6,9-12]
OCH-L-20-[10-16,1-7]-21-[1-96],OCH-
L-20-[1-16]-1-[1-96]
OCH-OS-20-[1-16]-[1-4]
OCH-P-20-[1-16]-[1-40]
OSC-20-[10-16,1-7]-21,OSC-20-[1-
16]-1
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
OTUC2-20-[1-16]-[1-2]
OTUC3-20-[1-16]-1
TGLAN-20-[1-16]-[1-40]

montype x,x-HT,x-LT Specifies the type of performance monitoring for the specified
entity.
- x: To be used to specify current threshold value for <montype>
x.
- x-HT: To be used to specify highest threshold value for gauge
<montype> x.
- x-LT: To be used to specify lowest threshold value for gauge
<montype> x.

Where possible values of <montypes> can be found in RTRV-

PM command.

thlev (1)-45 to 18446744073709551615 Specifies the desired threshold value of the selected
(2)DFLT performance monitoring parameter.
Enter DFLT to set threshold level back to the default value.

locn NEND Specifies the location of an event/occurrence in the system:

Default: NEND - Enter NEND to specify a near-end location.
Only NEND is supported.

76.MTFP50/30, Rev B January 2018 Page 30-1433

24. Set Commands TL1 Command Reference Manual

Table 24.12 SET-TH-{X} Parameters (Continued)

Parameter Value(s) Definition
dirn BTH Specifies the direction of an event/occurrence in the system:
TDTC - BTH specifies both applicable directions: one type of TDTC
TDTN and one type of TDTN.
RCV - TDTC specifies Transmit direction toward customer.
TRMT - TDTN specifies Transmit direction toward DWDM network.
NA - RCV specifies Receive direction.
Default: BTH - TRMT specifies Transmit direction.
- NA indicates Not Applicable (valid in the response only).

tmper 15-MIN Specifies the time-period increments during which PM data are
1-DAY collected.
Default: 15-MIN - Enter 15-MIN to specify 15-minute increments.
- Enter 1-DAY to specify daily increments.

Example
SET-TH-OTU2::OTU2-20-5-20:CTG01::SES-OTU,39,,,1-DAY;

Possible System Response

CORIANT1 02-02-02 03:20:21
M CTG01 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-TCA-{X}
RTRV-TH-{X}

Page 30-1434 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 25. Start Commands

25. Start Commands

STA-ALMGEN

Command Changes Since Previous Feature Package

• None.

Description
This command initiates alarm generation for all the entities provisioned in the system. An alarm for each condition
type is generated and cleared with the given ALMTIME in between. Only a single STA-ALMGEN can be in progress
at a time. The STP-ALMGEN command is used to stop all alarm generation.

When the STA-ALMGEN command is executed, an Inhibit Alarm (INHALM) condition is annunciated to inform that
generation of real alarms are now suppressed. This condition is annunciated against the system controller module.
The INHALM can be cleared with the STP-ALMGEN command.

A user privilege code of A8 (Admin) is required in order to execute this command.

Restrictions and Exceptions

• This command does not output transient conditions (for example, threshold crossings). The command
will output a single alarm per condition type even though entities may have multiple alarms per condition
type, which are differentiated by their condition description. This implies that not all alarms per entity is
output, only all unique condition type alarms is output.

• Alarms is generated for provisioned entities only.

• Real alarms are suppressed while this command runs. This command may also clear existing real
alarms, but they is reposted when the STP-ALMGEN is executed.

Command Format
STA-ALMGEN:[tid]:ALL:ctag:::[ALMTIME=<almtime>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

76.MTFP50/30, Rev B January 2018 Page 30-1435

25. Start Commands TL1 Command Reference Manual

Table 25.1 STA-ALMGEN Parameters

Parameter Value(s) Definition
almtime 0 Indicates the number of seconds between alarms
1 Specifiy 0 for no delay between alarms.
2
4
8
16
32
64
Default: 1

Example
The following command will generate a specific condition type alarm for all the provisioned entities, two seconds
later it will clear and then two seconds after that it will generate a different condition type for the same entity. It will
continue doing this until it has gone through all possible condition types for that entity and then move on to the next
provisioned entity.
STA-ALMGEN::ALL:AM0045:::ALMTIME=2;

Possible System Response

CORIANT1 02-04-16 02:08:15
M AM0045 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ALMGEN
STP-ALMGEN

Page 30-1436 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 25. Start Commands

STA-BER

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
This command can be used for two main purposes, test signal (PRBS, Null Signal)generation/detection and FEC
error generation/detection. The specific functions that can be inititated are as follows:
• This command initiates the transmission of a one or several correctable FEC block errors. This
diagnostic allows to verify that the FEC PM at the far end NE is working. This diagnostic can be service
affecting if there are already FEC block errors on the lightpath that are corrected. In that case, injecting
additional errors might generate uncorrected errors (UBE-FEC).

• This command initiates this same transmission of a one or several correctable FEC block errors only
on the port side OTUk facility of OSM-1S module.

• This command is also used to initiate the transmission of the PRBS pattern on the line side or port side
of a transponder. The facility types that support PRBS are: ODUF, ODU0, ODU1, ODU2, ODU2E,
ODU3, ODU4, OC3, OC12, OC48, OC192, GBEP, TGLAN, FGE, HGE.

• On the OSM-1S, when PRBS is specified for an OC3, OC12, OC48, GBEP, the entire client signal is
replaced with a PRBS signal in the transmit direction.

• On the OSM-2S, when PRBS is specified for an OC192/STM64, or TGLAN, the entire client signal is
replaced with a PRBS signal in the transmit direction.

• On the OSM-4S, when PRBS is specified for the TGLAN, the entire client signal is replaced with a PRBS
signal in the transmit direction.

• On the OSM-2C/OSM-4C, when PRBS is specified for an HGE, the entire client signal is replaced with
a test signal in the transmit direction.

• On the SSM-1S, when PRBS is specified for an OC3, OC12 or OC48 client associated with front panel
physical port, the entire client signal is replaced with a PRBS signal in the transmit direction.

• On the OSM-1S when PRBS or NULL is specified for a terminated ODUF, ODU0, ODU1 associated
with a non-OTU client port, the entire payload of the ODUF, ODU0, or ODU1 is replaced by the PRBS
or NULL signal towards the switch fabric.

• On the OSM-2S/OSM-4S, when PRBS or NULL is specified for a terminated ODU2 or ODU2E with a
non-OTU client port, the entire payload of the ODU2 or ODU2E is replaced by the PRBS or NULL signal
towards the switch fabric.

• On the OSM-2C/OSM-4C, when PRBS or NULL is specified for a terminated ODU4 with an HGE port,
the entire payload of the ODU4 is replaced by the PRBS or NULL signal towards the switch fabric.

• On the SSM-2S when PRBS or NULL is specified for a terminated ODU1/ODU2, the entire payload of
the ODU1/ODU2 is replaced by the PRBS or NULL signal towards the switch fabric.

• On the OSM-1S when PRBS or NULL is specified for a terminated ODU1 associated with an OTU1
port, the entire payload of the ODU1 is replaced by the PRBS or NULL signal towards the OTUk port.

• On the OSM-2S/OSM-4S when PRBS or NULL is specified for a terminated ODU2 associated with an
OTU2 or OCH-P port, the entire payload of the ODU2 is replaced by the PRBS or NULL signal towards
the OTUk port.

76.MTFP50/30, Rev B January 2018 Page 30-1437

25. Start Commands TL1 Command Reference Manual

• On the OSM-2C when PRBS or NULL is specified for a terminated ODU4, ODU3, or ODU2 associated
with an OTU4 or OCH-P port, the entire payload of the ODU4, ODU3, ODU2, is replaced by the PRBS
or NULL signal towards the OTUk port.

• On the OSM-4C/OSM-4F, when PRBS or NULL is specified for a terminated ODUk/j associated with an
OCH-OS port, the entire payload of the ODUk/j is replaced by the PRBS or NULL signal towards the
OCH-OS port.

A user privilege code of A4 (Test) is required in order to execute this command.

Restrictions and Exceptions

• For FEC, this command is limited to OTUk facilities with FECTYPE=REGULAR when supported on
OSM-1S.

• For FEC, this command can be done when the facility is in-service (IS) or out-of-service (OOS).

• For FEC, an attempt to FEC error generation/detection is denied when the facility with
FECTYPE=NOFEC. And if the facility has already started FEC error generation/detection, the system
will also deny the attempt that changes FECTYPE to NOFEC value.

• For PRBS, this command applies when the supporting module is a OSM-1S, OSM-2S, OSM-2C, OSM-
4C, OSM-4F, SSM-2S, OSM-4S, OSM-4C.

• For NULL, this command applies when the supporting module is a OSM-2S, OSM-2C, OSM-1S, OSM-
4C, OSM-4F, SSM-2S, OSM-4S, OSM-4C.

• Parameter BERTYPE is mandatory for OSM-1S, OSM-2S, OSM-2C, OSM-4C, OSM-4F, SSM-2S,
OSM-4S, OSM-5C.

• For PRBS, this command can be done only when the facility is out-of-service (OOS) only.

• For NULL, this command is only allowed for ODUk/ODUj/ODUi facilities on the OSM-2S/OSM-2C/OSM-
1S/OSM-4S/OSM-4C.

• The system denies an attempt to start the PRBS or NULL test signal on an ODUk on the OSM-2S/OSM-
2C/OSM-1S/OSM-4C/OSM-4F/OSM-4S/OSM-5C that has a TribID in its AID and the ODUk is cross-
connected.

• On the OSM-2S/OSM-2C/OSM-1S/OSM-4S/OSM-5C, the system denies an attempt to start the PRBS

or NULL test signal on an ODUk that is cross-connected and associated with an OTUk/OCH-P.

• On the OSM-4C/OSM-4F, the system denies an attempt to start the PRBS or NULL test signal on an
ODUk that is cross-connected and associated with an OTUk/OCH-OS.

• TPRBSTX and PRBSRX can only be specified when BERTYPE=PRBS.

• To start PRBS generation for transmit direction, PRBSTX=ON must be specified.

• To start PRBS generation for receive direction, PRBSRX=ON must be specified.

• PRBS or NULL can only be applied to one ODU0 or ODUflex per OSM-1S at a time.

• On an OSM-2C, the system denies an attempt to enable PRBS generation/detection on an ODU that is
the lowest layer of a two stage multiplexing hierarchy. ODUi is the lowest layer in a two stage
multiplexing scenario with ODUi multiplexed into an ODUj which is multiplexed into an ODUk. An
example would be that PRBS could not be enabled for an ODU0 if the ODU0 is mapped to an ODU2
which is mapped to an ODU4 on the OSM-2C.

• On an OSM-2S and OSM-2C, the system denies an attempt to enable NULL generation/detection on
high order ODUk in case of one stage ODU Mux (ODUk-ODUj)

Page 30-1438 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 25. Start Commands

• On an OSM-2C, the system denies an attempt to enable NULL generation/detection on all the three
layers (ODUk, ODUj, and ODUi) for two stages ODU Mux/Demx (ODUk-ODUj-ODUi), which means
NULL test can not be conduct for two stages ODU Mux/Demux case.

• For PRBS, this command is only allowed for ODUk facilities where k is any supported ODU level on
the OSM-4C/OSM-4F/OSM-5C/OSM-4S according to the table PRBS signal support for OSM-4C/
OSM-4F/OSM-5C/OSM-4S.

Table 25.2 PRBS signal support for OSM-4C/OSM-4F/OSM-5C/OSM-4S.

Module ODUk Support PRBS Signal

OSM-4F ODUCn (n=2,3) No

ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

ODUk (k=4,3,2,2e,1,0,flex) which is not the Yes

lowest stage of two stages multiplexing into
the ODU4

OSM-4C ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

ODUk (k=4,3,2,2e,1,0,flex) which is not the Yes

lowest stage of two stages multiplexing into
the ODU4

OSM-5C ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

ODUk (k=4,3,2,2e,1,0,flex) which is not the Yes

lowest stage of two stages multiplexing into
the ODU4

OSM-4S ODUk (k=1,0,flex) which is not terminated No

ODUk (k=2,2e,1,0,flex) which is terminated Yes

Non-OTN facility (TGLAN) Yes

• For NULL, this command is only allowed for ODUk facilities where k is any supported ODU level on the
OSM-4C/OSM-4F according to the table NULL signal support for OSM-4C/OSM-4F/OSM-5C/OSM-4S.

76.MTFP50/30, Rev B January 2018 Page 30-1439

25. Start Commands TL1 Command Reference Manual

Table 25.3 NULL signal support for OSM-4C/OSM-4F/OSM-5C/OSM-4S

Module Case # ODUk Support NULL Signal

OSM-4F 1 ODUCn (n=2,3) No

2 ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

3 ODUk (k=4,3,2) which has ODUj multiplexed No

into it

4 ODUk (k is any supported ODU level) that Yes

does not fall into case 1, 2, and 3

OSM-4C 1 ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

2 ODUk (k=4,3,2) which has ODUj multiplexed No

into it

3 ODUk (k is any supported ODU level) that Yes

does not fall into case 1, 2, and 3

OSM-5C 1 ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

2 ODUk (k=4,3,2) which has ODUj multiplexed No

into it

3 ODUk (k is any supported ODU level) that Yes

does not fall into case 1, 2, and 3

OSM-4S 1 ODUk (k=2) which has ODUj multiplexed No

into it

2 ODUk (k is any supported ODU level) that Yes

does not fall into case 1

• An attempt to start more than 12 simultaneous PRBS/NULL tests across all ODU0, ODU1, ODU2,
ODU2E, ODU3 and ODUF entities that are multiplexed directly into an ODU4 on the OSM-2C is denied.

• An attempt to start more than 12 simultaneous PRBS/NULL tests across all ODU0, ODU1, and ODUF
entities on an OSM-2S is denied.

• An attempt to start a PRBS/NULL test on an ODU4 that is involved in two-stage multiplexing (for
example, ODU0->ODU2->ODU4) on the OSM-2C is denied.

Command Format
STA-BER:[tid]::ctag::{<fac_aid>|<och-
p_aid>}:[BERTYPE=<bertype>][,PRBSTX=<prbstx>][,PRBSRX=<prbsrx>];

Page 30-1440 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 25. Start Commands

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 25.4 STA-BER Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
TGLAN-20-[1-16]-[1-40]

76.MTFP50/30, Rev B January 2018 Page 30-1441

25. Start Commands TL1 Command Reference Manual

Table 25.4 STA-BER Parameters (Continued)

Parameter Value(s) Definition
bertype FEC Specifies the type of BER that is generated:
PRBS FEC: FEC block errors on the line side or OTUk facility of a
NULL transponder.
Default: FEC PRBS: PRBS on the line side or port side of a transponder.

prbstx ON Specifies PRBS in the transmit direction is ON.

prbsrx ON Specifies PRBS in the receive direction is ON.

RESET ON and RESET will zero PRBS counters and reset timer.

Example
STA-BER:::AM0045::OCH-P-20-12-1:BERTYPE=PRBS,PRBSTX=ON,PRBSRX=ON;

Possible System Response

CORIANT 14-04-16 02:08:15
M AM0045 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
STP-BER
RTRV-BER

Page 30-1442 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 26. Stop Commands

26. Stop Commands

STP-ALMGEN

Command Changes Since Previous Feature Package

• None.

Description
This command stops alarm generation for all entities. Any real alarms that were previously cleared by STA-ALMGEN
will now be output with their original time stamp of occurrence.

A user privilege code of A8 (Admin) is required in order to execute this command.

Restrictions and Exceptions

• None

Command Format
STP-ALMGEN:[tid]::ctag;

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Example
The following command will stop alarm generation for the previous STA-ALMGEN command entered.
STP-ALMGEN:::AM0045;

Possible System Response

CORIANT1 02-04-16 02:08:15
M AM0045 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
RTRV-ALMGEN
STA-ALMGEN

76.MTFP50/30, Rev B January 2018 Page 30-1443

26. Stop Commands TL1 Command Reference Manual

STP-BER

Command Changes Since Previous Feature Package

• Added support of ODU0 mux into ODU4 of the ODUC3 on OSM-4F.

• Added support for OSM-4S, OSM-5C.

Description
This command stops the transmission of a BER or PRBS test signal on a specific optical channel or port side facility.
A user privilege code of A4 (Test) is required in order to execute this command.

Restrictions and Exceptions

• For FEC, this command is limited to OTUk facilities with FECTYPE=REGULAR when supported on
OSM-1S.

• For PRBS, this command applies when the supporting module is a OSM-1S, OSM-2S, OSM-2C, OSM-
4C, OSM-4F, SSM-2S, OSM-4S, OSM-5C.

• PRBS command is allowed for facilities provisioned as ODUF, ODU0, ODU1, ODU2, ODU2E, ODU3,
ODU4, OC3, OC12, OC48, OC192, GBEP, TGLAN, FGE, HGE.

• For PRBS on the OSM-4C/OSM-4F, this command is only allowed for ODUk facilities where k is any
supported ODU level according to the table: PRBS signal support for OSM-4C/OSM-4F/OSM-5C/OSM-
4S.

Table 26.1 PRBS signal support for OSM-4C/OSM-4F/OSM-5C/OSM-4S

Module ODUk Support PRBS Signal

OSM-4F ODUCn (n=2,3) No

ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

ODUk (k=4,3,2,2e,1,0,flex) which is not the Yes

lowest stage of two stages multiplexing into
the ODU4

OSM-4C ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

ODUk (k=4,3,2,2e,1,0,flex) which is not the Yes

lowest stage of two stages multiplexing into
the ODU4

OSM-5C ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

ODUk (k=4,3,2,2e,1,0,flex) which is not the Yes

lowest stage of two stages multiplexing into
the ODU4

Page 30-1444 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 26. Stop Commands

Module ODUk Support PRBS Signal

OSM-4S ODUk (k=1,0,flex) which is not terminated No

ODUk (k=2,2e,1,0,flex) which is terminated Yes

Non-OTN facility (TGLAN) Yes

• For NULL, this command applies when the supporting module is a OSM-2S, OSM-2C, OSM-1S, OSM-
4C, OSM-4F, SSM-2S, OSM-4S, OSM-5C.

• For NULL, this command is only allowed for ODUk/ODUj/ODUi facilities on the OSM-2S/OSM-2C/OSM-
1S.

• For NULLon the OSM-4C/OSM-4F, this command is allowed for ODUk facilities where k is any
supported ODU level according to the table: NULL signal support for OSM-4C/OSM-4F/OSM-5C/OSM-
4S.

Table 26.2 NULL signal support for OSM-4C/OSM-4F/OSM-5C/OSM-4S

Module Case # ODUk Support NULL Signal

OSM-4F 1 ODUCn (n=2,3) No

2 ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

3 ODUk (k=4,3,2) which has ODUj multiplexed No

into it

4 ODUk (k is any supported ODU level) that Yes

does not fall into case 1, 2, and 3

OSM-4C 1 ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

2 ODUk (k=4,3,2) which has ODUj multiplexed No

into it

3 ODUk (k is any supported ODU level) that Yes

does not fall into case 1, 2, and 3

OSM-5C 1 ODUk (k=2,2e,1,0,flex) which is the lowest No

stage of two-stages multiplexing into the
ODU4

2 ODUk (k=4,3,2) which has ODUj multiplexed No

into it

3 ODUk (k is any supported ODU level) that Yes

does not fall into case 1, 2, and 3

76.MTFP50/30, Rev B January 2018 Page 30-1445

26. Stop Commands TL1 Command Reference Manual

Module Case # ODUk Support NULL Signal

OSM-4S 1 ODUk (k=2) which has ODUj multiplexed No

into it

2 ODUk (k is any supported ODU level) that Yes

does not fall into case 1

• PRBSTX and PRBSRX can only be specified when BERTYPE=PRBS.

• To stop PRBS generation for transmit direction, PRBSTX=OFF must be specified.

• To stop PRBS for receive direction, PRBSRX=OFF must be specified.

Command Format
STP-BER:[tid]::ctag::{<och_p_aid>|<fac_aid>}:[,BERTYPE=<bertype>]
[,PRBSTX=<prbstx>][,PRBSRX=<prbsrx>];

Proper System Response

<header>
M^^<ctag>^COMPLD<cr><lf>
;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Page 30-1446 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 26. Stop Commands

Table 26.3 STP-BER Parameters

Parameter Value(s) Definition
fac_aid FGE-20-[1-16]-[1-2] EntityID-ShelfID-SlotID-PortID
GBEP-20-[1-16]-[1-32]
HGE-20-[1-16]-[1-5]
OC12-20-[1-16]-[1-32]
OC192-20-[1-16]-[1-40], OC192-20-[1-
16]-99-[1-6]
OC3-20-[1-16]-[1-32]
OC48-20-[1-16]-[1-32], OC48-20-[1-
16]-99-[7-30]
OCH-P-20-[1-16]-[1-40]
ODU0-20-[1-16]-[1-32], ODU0-20-[1-
16]-[1-40]-[1-80], ODU0-20-[1-16]-[1-
5]-[B,C][1-80]-[1-32], ODU0-20-[1-16]-
[1-2]-[D][1-3]-[B,C][1-80]-[1-32],
ODU0-20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU1-20-[1-16]-[1-32], ODU1-20-[1-
16]-[1-40]-[1-80], ODU1-20-[1-16]-[1-
5]-[B,C][1-80]-[1-16], ODU1-[20]-[1-
16]-99-[7-30], ODU1-20-[1-16]-[1-2]-
[D][1-3]-[B,C][1-80]-[1-16]
ODU2-20-[1-16]-[1-40], ODU2-20-[1-
16]-[1-20]-[1-80], ODU2-20-[1-16]-[1-
5]-C[1-80]-[1-4], ODU2-[20]-[1-16]-99-
[1-6], ODU2-20-[1-16]-[1-2]-[D][1-3]-
C[1-80]-[1-4], ODU2-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU2E-20-[1-16]-[1-4], ODU2E-20-[1-
16]-[1-5]-[1-80], ODU2E-20-[1-16]-[1-
5]-C[1-80]-[1-32], ODU2E-20-[1-16]-
[1-2]-[D][1-3]-C[1-80]-[1-32], ODU2E-
20-[1-16]-[1-2]-[D][1-3]-[1-80]
ODU3-20-[1-16]-[1-5]-[1-80], ODU3-
20-[1-16]-[1-2], ODU3-20-[1-16]-[1-2]-
[D][1-3]-[1-80]
ODU4-20-[1-16]-[1-5], ODU4-20-[1-
16]-[1-2]-[1-3]
ODUF-20-[1-16]-[1-40]-[1-80], ODUF-
20-[1-16]-[1-20]-[B,C][1-80]-[1-32],
ODUF-20-[1-16]-[1-2]-[D][1-3]-[B,C][1-
80]-[1-32]
OTU1-20-[1-16]-[1-32]
OTU2-20-[1-16]-[1-40]
OTU4-20-[1-16]-[1-5]
TGLAN-20-[1-16]-[1-40]

bertype FEC Specifies the type of BER that is generated:

PRBS FEC: FEC block errors on the line side or OTUk facility of a
NULL transponder.
Default: FEC PRBS: PRBS on the line side or port side of a transponder.

prbstx OFF For PRBS, specifies PRBS in the transmit direction is OFF.

prbsrx OFF For PRBS, specifies PRBS in the receive direction is OFF.

76.MTFP50/30, Rev B January 2018 Page 30-1447

26. Stop Commands TL1 Command Reference Manual

Example
STP-BER:::AM0045::OCH-P-20-12-1;

Possible System Response

CORIANT 14-04-16 02:08:15
M AM0045 COMPLD
;

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
STA-BER
RTRV-BER

Page 30-1448 January 2018 76.MTFP50/30, Rev B

TL1 Command Reference Manual 27. Switch Commands

27. Switch Commands

SW-DX-EQPT

Command Changes Since Previous Feature Package

• None.

Description
The SW-DX-EQPT command instructs the network element (NE) to request a switch of redundant processor
modules or packet controller module. When this command is executed for a module, the ACTIVE controller becomes
STANDBY and the STANDBY controller becomes ACTIVE.

A switch occurs if the "switched to" reference controller is IS-NR (in-service, normal). A switch can be preempted by
another switch. During the controller switch, visibility to equipped transponder is temporarily lost and replaceable
unit missing alarms may post and then clear for these transponders.

Restrictions and Exceptions

• Only switching between shelf controller modules (such as STPM) is allowed.

• This command is denied if it would cause a switch to a failed controller or a module that is not present
or unavailable (including OOS-MA).

• This command is denied if the Control Plane is in the midst of call setup and/or call reroute operation.

Command Format
SW-DX-EQPT:[tid]:<eqpt_aid>:ctag:::[CMDMDE=<commandMode>];

Proper System Responses

<header>

M^^<ctag>^COMPLD<cr><lf>;

Parameters
Refer to AID restrictions table in Section 2 for specific information on AID range restrictions.

Table 27.1 SW-DX-EQPT Parameters

Parameter Value(s) Definition
eqpt_aid STPM-20-[25,24] EntityID-ShelfID-SlotID
STPM8-20-[13,14]

76.MTFP50/30, Rev B January 2018 Page 30-1449

27. Switch Commands TL1 Command Reference Manual

Table 27.1 SW-DX-EQPT Parameters (Continued)

Parameter Value(s) Definition
commandMod NORM Specifies the way in which the command is executed:
e FRCD Enter NORM to specify a normal mode of execution (any state
Default: NORM inconsistencies prevents the command from executing).
Enter FRCD to specify a forced mode of execution (any state
inconsistencies does not prevent the command from executing).

If MODE=FRCD is used and if Control Plane is in the midst of a

call setup and/or a call reroute, the calls may be left in an
undesirable state.

Example
This command operates a Controller switch from the STPM located in slot 24 to the STPM located in slot 25.
SW-DX-EQPT:CORIANT1:STPM-20-24:CTAG::;

Possible System Response

^^^CORIANT1 05-07-15 02:08:15

M CTAG COMPLD

Error Messages
Error codes are defined and explained in Section 3, Error Codes for TL1 Output Responses.

Related Commands
ENT-EQPT
ED-EQPT
RTRV-EQPT

Page 30-1450 January 2018 76.MTFP50/30, Rev B