8DG61100EAAAQZZA - V1 - Alcatel-Lucent 1830 Photonic Service Switch (PSS) Release 3.6.50 and 3.6.51 TL1 Commands and Messages Guide

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 3374

Title page

Alcatel-Lucent 1830
Photonic Service Switch (PSS) | Release 3.6.50 and 3.6.51
TL1 Commands and Messages Guide
8DG61100EAAAQZZA
Issue 1 | December 2011
Legal notice

Legal notice

Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-Lucent. All other trademarks are the property of their respective
owners.

The information presented is subject to change without notice. Alcatel-Lucent assumes no responsibility for inaccuracies contained herein.
Copyright © 2011 Alcatel-Lucent. All rights reserved.

Conformance statements

Interference Information: Part 15 of FCC Rules


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. If the equipment is not installed and used in accordance with the guidelines in this document, the
equipment 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 the expense of the user

Security statement

In rare instances, unauthorized individuals make connections to the telecommunications network through the use of remote access features. In such an event,
applicable tariffs require that the customer pay all network charges for traffic. Alcatel-Lucent cannot be responsible for such charges and will not make any
allowance or give any credit for charges that result from unauthorized access.

Limited warranty

For terms and conditions of sale, contact your Alcatel-Lucent Account Team.
ALCATEL PRACTICE 8DG61100 EAAAQZZA
Standard Table of Contents Issue 1, December 2011

Notes and Limitations for this edition


NOTE: 11QTA4 hardware is referenced in this document but is not supported in this release.

INTRODUCTION
INTRODUCTION ............................................................................................... 1
1.1 GENERAL ........................................................................................................................... 1
1.2 CONVENTIONS .................................................................................................................. 1
1.2.1 TL1 SYNTAX CHARACTERS ....................................................................................... 1
1.2.2 VALID CHARACTER SET ............................................................................................. 2
1.2.3 PARAMETER VALUE SET NOTATION ........................................................................ 7
1.2.4 COMMAND INPUT FORMAT NOTATION .................................................................... 8
1.2.5 OUTPUT RESPONSE FORMAT NOTATION ............................................................... 8
1.3 COMMAND ENTRY ............................................................................................................ 10
1.3.1 DIRECT INPUT COMMAND ENTRY MODE................................................................. 10
1.4 COMMAND DESCRIPTIONS ............................................................................................. 10
1.4.1 COMMAND HEADER .................................................................................................... 10
1.4.2 PURPOSE ..................................................................................................................... 11
1.4.3 COMMAND INPUT FORMAT........................................................................................ 11
1.4.4 INPUT PARAMETERS .................................................................................................. 12
1.4.4.1 TID Parameter Block .................................................................................................. 12
1.4.4.2 AID Parameter Block .................................................................................................. 13
1.4.4.3 CTAG Parameter Block .............................................................................................. 13
1.4.4.4 General (Delayed Activation) Parameter Block .......................................................... 14
1.4.4.5 Positional Parameter Block......................................................................................... 14
1.4.4.6 Keyword Parameter Block .......................................................................................... 14
1.4.4.7 State Parameter Block ................................................................................................ 15
1.4.5 SUCCESSFUL RESPONSE FORMAT ......................................................................... 15
1.4.6 OUTPUT PARAMETERS .............................................................................................. 15
1.4.7 UNSUCCESSFUL RESPONSE FORMAT .................................................................... 15
1.4.8 ERROR CODES ............................................................................................................ 16
1.4.9 EXAMPLES.................................................................................................................... 16
1.4.10 RELATED COMMANDS .............................................................................................. 16
1.4.11 RELATED AUTONOMOUS RESPONSES.................................................................. 16
1.5 AUTONOMOUS RESPONSE FORMAT............................................................................. 16
1.5.1 RESPONSE HEADER ................................................................................................... 16
1.5.2 PURPOSE ..................................................................................................................... 16
1.5.3 RESPONSE FORMAT................................................................................................... 17
1.5.4 OUTPUT PARAMETERS .............................................................................................. 17
1.5.5 EXAMPLES.................................................................................................................... 17

©Alcatel-Lucent 2011 - All Rights Reserved i


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
1.5.6 RELATED COMMANDS ................................................................................................ 17
1.5.7 RELATED AUTONOMOUS RESPONSES.................................................................... 17
1.6 COMMAND RESPONSES .................................................................................................. 17
1.6.1 ACKNOWLEDGEMENT RESPONSE FORMAT........................................................... 19
1.6.2 SUCCESSFUL RESPONSE FORMAT ......................................................................... 19
1.6.3 UNSUCCESSFUL RESPONSE FORMAT .................................................................... 20
1.6.4 RETRIEVALS................................................................................................................. 22
1.6.5 CONTINUATION MESSAGE FORMAT (OUTPUT GREATER THAN 4096 BYTES)... 23
1.7 AUTONOMOUS RESPONSES........................................................................................... 23
1.7.1 AUTONOMOUS MESSAGE FORMAT.......................................................................... 24
1.7.2 AUTONOMOUS KEEP^ALIVE MESSAGE FORMAT ................................................... 25
1.12 APPENDICES ................................................................................................................... 25
TL1 COMMANDS
ACT-USER ........................................................................................................ 27
ALW-MSG-ALL ................................................................................................. 31
ALW-MSG-RR ................................................................................................... 35
ALW-SWTOPROTN-EQPT ............................................................................... 41
ALW-SWTOWKG-EQPT ................................................................................... 45
ALW-USER-SECU............................................................................................. 49
CANC-COPY-RFILE.......................................................................................... 53
CANC-USER-SECU .......................................................................................... 57
CANC-USER...................................................................................................... 61
CNVT-CCTPR-ODUK ........................................................................................ 65
CNVT-CCTU-ODUK .......................................................................................... 71
COMMIT-ISU ..................................................................................................... 75
COPY-RFILE ..................................................................................................... 79
DLT-100GBE ..................................................................................................... 87
DLT-10GBE ....................................................................................................... 91
DLT-1GBE ......................................................................................................... 95
DLT-CBR2G5 .................................................................................................... 99
DLT-CBRAR ...................................................................................................... 103
DLT-CRS-OCH .................................................................................................. 107
DLT-CRS-ODUK ............................................................................................... 117
DLT-CRS-VTS ................................................................................................... 123
DLT-CRSPROT-ODUK...................................................................................... 127
DLT-EQPT ......................................................................................................... 131
DLT-FC100 ........................................................................................................ 137

ii 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

DLT-FC1200 ...................................................................................................... 141


DLT-FC200 ........................................................................................................ 145
DLT-FC400 ........................................................................................................ 149
DLT-FC800 ........................................................................................................ 153
DLT-FE .............................................................................................................. 157
DLT-FFP-EQPT ................................................................................................. 161
DLT-IPACL-FILTER .......................................................................................... 167
DLT-IPACL-PATTERN ...................................................................................... 171
DLT-NE-IPRT .................................................................................................... 175
DLT-NTP-ADDR ................................................................................................ 179
DLT-OC12 ......................................................................................................... 183
DLT-OC192 ....................................................................................................... 187
DLT-OC3 ........................................................................................................... 191
DLT-OC48 ......................................................................................................... 195
DLT-OC768 ....................................................................................................... 199
DLT-OCH........................................................................................................... 203
DLT-OSPF-AREA.............................................................................................. 207
DLT-OTS ........................................................................................................... 211
DLT-OTU1 ......................................................................................................... 215
DLT-OTU2 ......................................................................................................... 219
DLT-OTU3 ......................................................................................................... 223
DLT-RADIUS-SERVER ..................................................................................... 227
DLT-SESSION................................................................................................... 231
DLT-STM16 ....................................................................................................... 235
DLT-STM1 ......................................................................................................... 239
DLT-STM256 ..................................................................................................... 243
DLT-STM4 ......................................................................................................... 247
DLT-STM64 ....................................................................................................... 251
DLT-TOPOLOGY-OCONN ................................................................................ 255
DLT-USER-SECU.............................................................................................. 263
DLT-VTS............................................................................................................ 267
ED-100GBE ....................................................................................................... 271
ED-10GBE ......................................................................................................... 277
ED-1GBE ........................................................................................................... 285
ED-CBR2G5 ...................................................................................................... 293

1830PSS R3.6.50 - TL1 Commands and Messages iii


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
ED-CBRAR ........................................................................................................ 301
ED-CRS-OCH .................................................................................................... 307
ED-CRS-ODUK ................................................................................................. 319
ED-CRS-VTS ..................................................................................................... 325
ED-DAT ............................................................................................................. 331
ED-EQPT-FW .................................................................................................... 335
ED-EQPT ........................................................................................................... 339
ED-FC100 .......................................................................................................... 351
ED-FC1200 ........................................................................................................ 357
ED-FC200 .......................................................................................................... 363
ED-FC400 .......................................................................................................... 369
ED-FC800 .......................................................................................................... 375
ED-FE ................................................................................................................ 381
ED-FFP-EQPT ................................................................................................... 387
ED-GCC............................................................................................................. 391
ED-IP-IF ............................................................................................................. 397
ED-IPACL-FILTER ............................................................................................ 409
ED-IPACL-IF...................................................................................................... 413
ED-IPACL-PATTERN ........................................................................................ 419
ED-LAN ............................................................................................................. 427
ED-NE-IPRT ...................................................................................................... 431
ED-NE................................................................................................................ 435
ED-NTP.............................................................................................................. 437
ED-OC12 ........................................................................................................... 441
ED-OC192 ......................................................................................................... 449
ED-OC3 ............................................................................................................. 457
ED-OC48 ........................................................................................................... 465
ED-OC768 ......................................................................................................... 473
ED-OCH............................................................................................................. 479
ED-ODU0........................................................................................................... 493
ED-ODU1........................................................................................................... 497
ED-ODU2........................................................................................................... 503
ED-ODU3........................................................................................................... 511
ED-ODU4........................................................................................................... 517
ED-ODUF........................................................................................................... 523

iv 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

ED-ODUPTF ...................................................................................................... 527


ED-OSPF-AREA................................................................................................ 535
ED-OSPF-IF....................................................................................................... 541
ED-OSPF ........................................................................................................... 549
ED-OTS ............................................................................................................. 553
ED-OTU1 ........................................................................................................... 565
ED-OTU2 ........................................................................................................... 575
ED-OTU3 ........................................................................................................... 591
ED-OTU4 ........................................................................................................... 605
ED-PID............................................................................................................... 615
ED-PWRMGMT-EGRESS ................................................................................. 619
ED-PWRMGMT-INGRESS ................................................................................ 627
ED-PWRMGMT-TYPE ....................................................................................... 633
ED-RADIUS-SERVER ....................................................................................... 639
ED-SESSION..................................................................................................... 643
ED-STM16 ......................................................................................................... 647
ED-STM1 ........................................................................................................... 657
ED-STM256 ....................................................................................................... 665
ED-STM4 ........................................................................................................... 671
ED-STM64 ......................................................................................................... 679
ED-TRANSFER-INFO........................................................................................ 687
ED-USER-SECU................................................................................................ 695
ED-VTS.............................................................................................................. 699
ENT-100GBE..................................................................................................... 705
ENT-10GBE....................................................................................................... 711
ENT-1GBE......................................................................................................... 719
ENT-CBR2G5 .................................................................................................... 727
ENT-CBRAR...................................................................................................... 733
ENT-CRS-OCH.................................................................................................. 739
ENT-CRS-ODUK ............................................................................................... 751
ENT-CRS-VTS................................................................................................... 757
ENT-CRSPROT-ODUK ..................................................................................... 765
ENT-EQPT......................................................................................................... 771
ENT-FC100........................................................................................................ 783
ENT-FC1200...................................................................................................... 789

1830PSS R3.6.50 - TL1 Commands and Messages v


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
ENT-FC200........................................................................................................ 795
ENT-FC400........................................................................................................ 801
ENT-FC800........................................................................................................ 807
ENT-FE .............................................................................................................. 813
ENT-FFP-EQPT................................................................................................. 819
ENT-IPACL-FILTER .......................................................................................... 827
ENT-IPACL-PATTERN ...................................................................................... 831
ENT-NE-IPRT .................................................................................................... 839
ENT-NTP-ADDR ................................................................................................ 845
ENT-OC12 ......................................................................................................... 849
ENT-OC192 ....................................................................................................... 857
ENT-OC3 ........................................................................................................... 865
ENT-OC48 ......................................................................................................... 873
ENT-OC768 ....................................................................................................... 881
ENT-OCH........................................................................................................... 887
ENT-OSPF-AREA.............................................................................................. 891
ENT-OTS ........................................................................................................... 897
ENT-OTU1 ......................................................................................................... 903
ENT-OTU2 ......................................................................................................... 911
ENT-OTU3 ......................................................................................................... 923
ENT-RADIUS-SERVER ..................................................................................... 927
ENT-STM16 ....................................................................................................... 931
ENT-STM1 ......................................................................................................... 939
ENT-STM256 ..................................................................................................... 947
ENT-STM4 ......................................................................................................... 953
ENT-STM64 ....................................................................................................... 961
ENT-TOPOLOGY-OCONN................................................................................ 969
ENT-USER-SECU ............................................................................................. 983
ENT-VTS............................................................................................................ 987
INH-MSG-ALL ................................................................................................... 993
INH-MSG-RR ..................................................................................................... 997
INH-SWTOPROTN-EQPT ................................................................................. 1001
INH-USER-SECU .............................................................................................. 1005
INIT-REG-100GBE ............................................................................................ 1009
INIT-REG-10GBE .............................................................................................. 1013

vi 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

INIT-REG-1GBE ................................................................................................ 1017


INIT-REG-CBR2G5 ........................................................................................... 1021
INIT-REG-CBRAR ............................................................................................. 1025
INIT-REG-EQPT ................................................................................................ 1029
INIT-REG-FC100 ............................................................................................... 1033
INIT-REG-FC1200 ............................................................................................. 1037
INIT-REG-FC200 ............................................................................................... 1041
INIT-REG-FC400 ............................................................................................... 1045
INIT-REG-FC800 ............................................................................................... 1049
INIT-REG-FE ..................................................................................................... 1053
INIT-REG-OC12................................................................................................. 1057
INIT-REG-OC192............................................................................................... 1061
INIT-REG-OC3................................................................................................... 1065
INIT-REG-OC48................................................................................................. 1069
INIT-REG-OC768............................................................................................... 1073
INIT-REG-OCH .................................................................................................. 1077
INIT-REG-ODU1 ................................................................................................ 1085
INIT-REG-ODU2 ................................................................................................ 1089
INIT-REG-ODU3 ................................................................................................ 1093
INIT-REG-ODU4 ................................................................................................ 1097
INIT-REG-OSC .................................................................................................. 1101
INIT-REG-OTS................................................................................................... 1105
INIT-REG-OTU1 ................................................................................................ 1109
INIT-REG-OTU2 ................................................................................................ 1113
INIT-REG-OTU3 ................................................................................................ 1117
INIT-REG-OTU4 ................................................................................................ 1121
INIT-REG-STM16 .............................................................................................. 1125
INIT-REG-STM1 ................................................................................................ 1129
INIT-REG-STM256 ............................................................................................ 1133
INIT-REG-STM4 ................................................................................................ 1137
INIT-REG-STM64 .............................................................................................. 1141
INIT-SSH-KEY ................................................................................................... 1145
INIT-SSL-CERT ................................................................................................. 1149
INIT-SSL-CSR ................................................................................................... 1153
INIT-SSL-KEY ................................................................................................... 1157

1830PSS R3.6.50 - TL1 Commands and Messages vii


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
INIT-SYS-NEW .................................................................................................. 1161
INIT-SYS-OLD ................................................................................................... 1165
INIT-SYS............................................................................................................ 1169
OPR-ACO-ALL .................................................................................................. 1175
OPR-LPBK-EQPT ............................................................................................. 1179
OPR-PROTNSW-ODUK .................................................................................... 1183
OPR-PWRMGMT............................................................................................... 1189
RLS-EXT-CONT ................................................................................................ 1193
RLS-LPBK-EQPT.............................................................................................. 1197
RLS-PROTNSW-ODUK..................................................................................... 1201
RMV-100GBE .................................................................................................... 1205
RMV-10GBE ...................................................................................................... 1209
RMV-1GBE ........................................................................................................ 1213
RMV-CBR2G5 ................................................................................................... 1217
RMV-CBRAR ..................................................................................................... 1221
RMV-EQPT ........................................................................................................ 1225
RMV-FC100 ....................................................................................................... 1231
RMV-FC1200 ..................................................................................................... 1235
RMV-FC200 ....................................................................................................... 1239
RMV-FC400 ....................................................................................................... 1243
RMV-FC800 ....................................................................................................... 1247
RMV-FE ............................................................................................................. 1251
RMV-OC12 ........................................................................................................ 1255
RMV-OC192 ...................................................................................................... 1259
RMV-OC3 .......................................................................................................... 1263
RMV-OC48 ........................................................................................................ 1267
RMV-OC768 ...................................................................................................... 1271
RMV-OCH.......................................................................................................... 1275
RMV-OTS .......................................................................................................... 1279
RMV-OTU1 ........................................................................................................ 1283
RMV-OTU2 ........................................................................................................ 1287
RMV-OTU3 ........................................................................................................ 1291
RMV-OTU4 ........................................................................................................ 1295
RMV-STM16 ...................................................................................................... 1299
RMV-STM1 ........................................................................................................ 1303

viii 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

RMV-STM256 .................................................................................................... 1307


RMV-STM4 ........................................................................................................ 1311
RMV-STM64 ...................................................................................................... 1315
RST-100GBE..................................................................................................... 1319
RST-10GBE....................................................................................................... 1323
RST-1GBE......................................................................................................... 1327
RST-CBR2G5 .................................................................................................... 1331
RST-CBRAR...................................................................................................... 1335
RST-EQPT......................................................................................................... 1339
RST-FC100........................................................................................................ 1345
RST-FC1200...................................................................................................... 1349
RST-FC200........................................................................................................ 1353
RST-FC400........................................................................................................ 1357
RST-FC800........................................................................................................ 1361
RST-FE .............................................................................................................. 1365
RST-OC12 ......................................................................................................... 1369
RST-OC192 ....................................................................................................... 1373
RST-OC3 ........................................................................................................... 1377
RST-OC48 ......................................................................................................... 1381
RST-OC768 ....................................................................................................... 1385
RST-OCH........................................................................................................... 1389
RST-OTS ........................................................................................................... 1393
RST-OTU1 ......................................................................................................... 1397
RST-OTU2 ......................................................................................................... 1401
RST-OTU3 ......................................................................................................... 1405
RST-OTU4 ......................................................................................................... 1409
RST-STM16 ....................................................................................................... 1413
RST-STM1 ......................................................................................................... 1417
RST-STM256 ..................................................................................................... 1421
RST-STM4 ......................................................................................................... 1425
RST-STM64 ....................................................................................................... 1429
RTRV-100GBE .................................................................................................. 1433
RTRV-10GBE .................................................................................................... 1439
RTRV-1GBE ...................................................................................................... 1447
RTRV-ALM-ALL ................................................................................................ 1455

1830PSS R3.6.50 - TL1 Commands and Messages ix


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
RTRV-ALM-ENV................................................................................................ 1473
RTRV-ALM-RR .................................................................................................. 1477
RTRV-ALMPRFL-RR......................................................................................... 1503
RTRV-ATTR-100GBE........................................................................................ 1513
RTRV-ATTR-10GBE.......................................................................................... 1519
RTRV-ATTR-1GBE............................................................................................ 1525
RTRV-ATTR-CBR2G5....................................................................................... 1531
RTRV-ATTR-CBRAR......................................................................................... 1537
RTRV-ATTR-COM ............................................................................................. 1543
RTRV-ATTR-CONT ........................................................................................... 1549
RTRV-ATTR-ENV .............................................................................................. 1553
RTRV-ATTR-EQPT............................................................................................ 1557
RTRV-ATTR-FC100........................................................................................... 1569
RTRV-ATTR-FC1200......................................................................................... 1575
RTRV-ATTR-FC200........................................................................................... 1581
RTRV-ATTR-FC400........................................................................................... 1587
RTRV-ATTR-FC800........................................................................................... 1593
RTRV-ATTR-FE................................................................................................. 1599
RTRV-ATTR-OC12 ............................................................................................ 1605
RTRV-ATTR-OC192 .......................................................................................... 1611
RTRV-ATTR-OC3 .............................................................................................. 1617
RTRV-ATTR-OC48 ............................................................................................ 1623
RTRV-ATTR-OC768 .......................................................................................... 1629
RTRV-ATTR-OCH ............................................................................................. 1635
RTRV-ATTR-ODU0 ........................................................................................... 1647
RTRV-ATTR-ODU1 ........................................................................................... 1653
RTRV-ATTR-ODU2 ........................................................................................... 1659
RTRV-ATTR-ODU3 ........................................................................................... 1665
RTRV-ATTR-ODU4 ........................................................................................... 1671
RTRV-ATTR-ODUF ........................................................................................... 1677
RTRV-ATTR-OPTSG......................................................................................... 1683
RTRV-ATTR-OTS .............................................................................................. 1689
RTRV-ATTR-OTU1............................................................................................ 1697
RTRV-ATTR-OTU2............................................................................................ 1703
RTRV-ATTR-OTU3............................................................................................ 1709

x 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

RTRV-ATTR-OTU4............................................................................................ 1715
RTRV-ATTR-PLK .............................................................................................. 1721
RTRV-ATTR-STM16.......................................................................................... 1727
RTRV-ATTR-STM1............................................................................................ 1733
RTRV-ATTR-STM256........................................................................................ 1739
RTRV-ATTR-STM4............................................................................................ 1745
RTRV-ATTR-STM64.......................................................................................... 1751
RTRV-ATTR-VTS .............................................................................................. 1757
RTRV-ATTRSUP-CBRAR ................................................................................. 1763
RTRV-ATTRSUP-RR......................................................................................... 1769
RTRV-AUDIT-SECULOG .................................................................................. 1789
RTRV-BASELINE-10GBE ................................................................................. 1793
RTRV-BASELINE-CBR2G5 .............................................................................. 1799
RTRV-BASELINE-CBRAR ................................................................................ 1803
RTRV-BASELINE-FC100 .................................................................................. 1807
RTRV-BASELINE-FC1200 ................................................................................ 1811
RTRV-BASELINE-FC200 .................................................................................. 1815
RTRV-BASELINE-FC400 .................................................................................. 1819
RTRV-BASELINE-FC800 .................................................................................. 1823
RTRV-BASELINE-FE ........................................................................................ 1827
RTRV-BASELINE-GBE ..................................................................................... 1831
RTRV-BASELINE-OC12 ................................................................................... 1835
RTRV-BASELINE-OC192 ................................................................................. 1839
RTRV-BASELINE-OC3 ..................................................................................... 1845
RTRV-BASELINE-OC48 ................................................................................... 1849
RTRV-BASELINE-OC768 ................................................................................. 1853
RTRV-BASELINE-OCH..................................................................................... 1857
RTRV-BASELINE-OSC ..................................................................................... 1861
RTRV-BASELINE-OTU1 ................................................................................... 1867
RTRV-BASELINE-OTU2 ................................................................................... 1871
RTRV-BASELINE-OTU3 ................................................................................... 1877
RTRV-BASELINE-OTU4 ................................................................................... 1881
RTRV-BASELINE-STM16 ................................................................................. 1885
RTRV-BASELINE-STM1 ................................................................................... 1889
RTRV-BASELINE-STM256 ............................................................................... 1893

1830PSS R3.6.50 - TL1 Commands and Messages xi


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
RTRV-BASELINE-STM4 ................................................................................... 1897
RTRV-BASELINE-STM64 ................................................................................. 1901
RTRV-CBR2G5 ................................................................................................. 1905
RTRV-CBRAR ................................................................................................... 1913
RTRV-COND-ALL ............................................................................................. 1919
RTRV-COND-ENV ............................................................................................. 1937
RTRV-CRS-OCH ............................................................................................... 1941
RTRV-CRS-ODUK............................................................................................. 1961
RTRV-CRS-VTS ................................................................................................ 1967
RTRV-CRSPROT-ODUK................................................................................... 1977
RTRV-DB-STATUS ........................................................................................... 1983
RTRV-DFLT-SECU............................................................................................ 1987
RTRV-EQPT-FW ............................................................................................... 1993
RTRV-EQPT ...................................................................................................... 1999
RTRV-EXT-CONT.............................................................................................. 2023
RTRV-FC100 ..................................................................................................... 2027
RTRV-FC1200 ................................................................................................... 2033
RTRV-FC200 ..................................................................................................... 2039
RTRV-FC400 ..................................................................................................... 2045
RTRV-FC800 ..................................................................................................... 2051
RTRV-FE ........................................................................................................... 2057
RTRV-FFP-EQPT .............................................................................................. 2063
RTRV-GCC ........................................................................................................ 2071
RTRV-HDR ........................................................................................................ 2075
RTRV-INV-CARD............................................................................................... 2077
RTRV-INV-PLUG............................................................................................... 2083
RTRV-IP-IF ........................................................................................................ 2091
RTRV-IPACL-FILTER........................................................................................ 2101
RTRV-IPACL-IF ................................................................................................. 2109
RTRV-IPACL-PATTERN ................................................................................... 2115
RTRV-IPACL ..................................................................................................... 2121
RTRV-ISU-STATUS........................................................................................... 2125
RTRV-LAN......................................................................................................... 2131
RTRV-LIB-FW ................................................................................................... 2137
RTRV-LPBK-EQPT ........................................................................................... 2143

xii 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

RTRV-MAP ........................................................................................................ 2149


RTRV-NE-IPIPT................................................................................................. 2153
RTRV-NE-IPRT.................................................................................................. 2157
RTRV-NE ........................................................................................................... 2161
RTRV-NETYPE.................................................................................................. 2163
RTRV-NTP-ADDR ............................................................................................. 2167
RTRV-NTP......................................................................................................... 2169
RTRV-OC12....................................................................................................... 2175
RTRV-OC192..................................................................................................... 2183
RTRV-OC3......................................................................................................... 2191
RTRV-OC48....................................................................................................... 2199
RTRV-OC768..................................................................................................... 2209
RTRV-OCH-WAVEKEY..................................................................................... 2215
RTRV-OCH ........................................................................................................ 2227
RTRV-ODU0 ...................................................................................................... 2247
RTRV-ODU1 ...................................................................................................... 2251
RTRV-ODU2 ...................................................................................................... 2257
RTRV-ODU3 ...................................................................................................... 2265
RTRV-ODU4 ...................................................................................................... 2271
RTRV-ODUF...................................................................................................... 2277
RTRV-ODUPTF ................................................................................................. 2281
RTRV-OPT-INTRUSION.................................................................................... 2287
RTRV-OSPF-AREA ........................................................................................... 2291
RTRV-OSPF-IF.................................................................................................. 2297
RTRV-OSPF ...................................................................................................... 2305
RTRV-OTS......................................................................................................... 2309
RTRV-OTU1 ...................................................................................................... 2325
RTRV-OTU2 ...................................................................................................... 2335
RTRV-OTU3 ...................................................................................................... 2351
RTRV-OTU4 ...................................................................................................... 2363
RTRV-PATH-OCH ............................................................................................. 2373
RTRV-PM-100GBE............................................................................................ 2387
RTRV-PM-10GBE.............................................................................................. 2397
RTRV-PM-1GBE................................................................................................ 2409
RTRV-PM-CBR2G5 ........................................................................................... 2421

1830PSS R3.6.50 - TL1 Commands and Messages xiii


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
RTRV-PM-CBRAR............................................................................................. 2431
RTRV-PM-EQPT................................................................................................ 2441
RTRV-PM-FC100............................................................................................... 2449
RTRV-PM-FC1200............................................................................................. 2459
RTRV-PM-FC200............................................................................................... 2469
RTRV-PM-FC400............................................................................................... 2479
RTRV-PM-FC800............................................................................................... 2489
RTRV-PM-FE..................................................................................................... 2499
RTRV-PM-OC12 ................................................................................................ 2511
RTRV-PM-OC192 .............................................................................................. 2521
RTRV-PM-OC3 .................................................................................................. 2531
RTRV-PM-OC48 ................................................................................................ 2541
RTRV-PM-OC768 .............................................................................................. 2551
RTRV-PM-OCH ................................................................................................. 2561
RTRV-PM-ODU1 ............................................................................................... 2579
RTRV-PM-ODU2 ............................................................................................... 2587
RTRV-PM-ODU3 ............................................................................................... 2597
RTRV-PM-ODU4 ............................................................................................... 2607
RTRV-PM-OSC.................................................................................................. 2615
RTRV-PM-OTS .................................................................................................. 2625
RTRV-PM-OTU1................................................................................................ 2635
RTRV-PM-OTU2................................................................................................ 2645
RTRV-PM-OTU3................................................................................................ 2657
RTRV-PM-OTU4................................................................................................ 2667
RTRV-PM-STM16.............................................................................................. 2679
RTRV-PM-STM1................................................................................................ 2689
RTRV-PM-STM256............................................................................................ 2699
RTRV-PM-STM4................................................................................................ 2709
RTRV-PM-STM64.............................................................................................. 2719
RTRV-PROTNSW-EQPT................................................................................... 2729
RTRV-PWRMGMT-EGRESS............................................................................. 2737
RTRV-PWRMGMT-INGRESS ........................................................................... 2745
RTRV-PWRMGMT-TYPE .................................................................................. 2753
RTRV-PWRMGMT............................................................................................. 2759
RTRV-RADIUS-AUTH ....................................................................................... 2763

xiv 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

RTRV-RADIUS-SERVER .................................................................................. 2767


RTRV-SESSION ................................................................................................ 2771
RTRV-SSH-KEY ................................................................................................ 2775
RTRV-SSL-CERT .............................................................................................. 2779
RTRV-SSL-CSR ................................................................................................ 2783
RTRV-SSL-KEY ................................................................................................ 2787
RTRV-STATUS.................................................................................................. 2791
RTRV-STM16 .................................................................................................... 2795
RTRV-STM1 ...................................................................................................... 2805
RTRV-STM256 .................................................................................................. 2815
RTRV-STM4 ...................................................................................................... 2821
RTRV-STM64 .................................................................................................... 2831
RTRV-TH ........................................................................................................... 2839
RTRV-THPRFL-NAME ...................................................................................... 2847
RTRV-THPRFL.................................................................................................. 2851
RTRV-TOD ........................................................................................................ 2857
RTRV-TOPOLOGY-OCONN ............................................................................. 2861
RTRV-TRANSFER-INFO ................................................................................... 2873
RTRV-USER-SECU........................................................................................... 2879
RTRV-USER ...................................................................................................... 2885
RTRV-VTS ......................................................................................................... 2891
SET-ALMPRFL-RR ........................................................................................... 2897
SET-ATTR-100GBE .......................................................................................... 2901
SET-ATTR-10GBE ............................................................................................ 2905
SET-ATTR-1GBE .............................................................................................. 2909
SET-ATTR-CBR2G5.......................................................................................... 2913
SET-ATTR-CBRAR ........................................................................................... 2917
SET-ATTR-COM................................................................................................ 2921
SET-ATTR-CONT .............................................................................................. 2925
SET-ATTR-ENV................................................................................................. 2929
SET-ATTR-EQPT .............................................................................................. 2933
SET-ATTR-FC100 ............................................................................................. 2943
SET-ATTR-FC1200 ........................................................................................... 2947
SET-ATTR-FC200 ............................................................................................. 2951
SET-ATTR-FC400 ............................................................................................. 2955

1830PSS R3.6.50 - TL1 Commands and Messages xv


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
SET-ATTR-FC800 ............................................................................................. 2959
SET-ATTR-FE.................................................................................................... 2963
SET-ATTR-OC12............................................................................................... 2967
SET-ATTR-OC192............................................................................................. 2971
SET-ATTR-OC3................................................................................................. 2975
SET-ATTR-OC48............................................................................................... 2979
SET-ATTR-OC768............................................................................................. 2983
SET-ATTR-OCH ................................................................................................ 2987
SET-ATTR-ODU0 .............................................................................................. 2993
SET-ATTR-ODU1 .............................................................................................. 2997
SET-ATTR-ODU2 .............................................................................................. 3001
SET-ATTR-ODU3 .............................................................................................. 3005
SET-ATTR-ODU4 .............................................................................................. 3009
SET-ATTR-ODUF .............................................................................................. 3013
SET-ATTR-OPTSG............................................................................................ 3017
SET-ATTR-OTS................................................................................................. 3021
SET-ATTR-OTU1............................................................................................... 3027
SET-ATTR-OTU2............................................................................................... 3031
SET-ATTR-OTU3............................................................................................... 3035
SET-ATTR-OTU4............................................................................................... 3039
SET-ATTR-PLK ................................................................................................. 3043
SET-ATTR-SECUDFLT ..................................................................................... 3047
SET-ATTR-STM16............................................................................................. 3053
SET-ATTR-STM1............................................................................................... 3057
SET-ATTR-STM256........................................................................................... 3061
SET-ATTR-STM4............................................................................................... 3065
SET-ATTR-STM64............................................................................................. 3069
SET-ATTR-VTS ................................................................................................. 3073
SET-BASELINE-10GBE.................................................................................... 3077
SET-BASELINE-1GBE...................................................................................... 3082
SET-BASELINE-CBR2G5 ................................................................................. 3086
SET-BASELINE-CBRAR................................................................................... 3090
SET-BASELINE-FC100..................................................................................... 3094
SET-BASELINE-FC1200................................................................................... 3098
SET-BASELINE-FC200..................................................................................... 3102

xvi 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

SET-BASELINE-FC400..................................................................................... 3106
SET-BASELINE-FC800..................................................................................... 3110
SET-BASELINE-FE ........................................................................................... 3114
SET-BASELINE-OC12 ...................................................................................... 3118
SET-BASELINE-OC192 .................................................................................... 3122
SET-BASELINE-OC3 ........................................................................................ 3126
SET-BASELINE-OC48 ...................................................................................... 3130
SET-BASELINE-OC768 .................................................................................... 3134
SET-BASELINE-OCH........................................................................................ 3138
SET-BASELINE-OSC........................................................................................ 3142
SET-BASELINE-OTU1 ...................................................................................... 3146
SET-BASELINE-OTU2 ...................................................................................... 3150
SET-BASELINE-OTU3 ...................................................................................... 3154
SET-BASELINE-OTU4 ...................................................................................... 3158
SET-BASELINE-STM16 .................................................................................... 3162
SET-BASELINE-STM1 ...................................................................................... 3166
SET-BASELINE-STM256 .................................................................................. 3170
SET-BASELINE-STM4 ...................................................................................... 3174
SET-BASELINE-STM64 .................................................................................... 3178
SET-IPACL ........................................................................................................ 3182
SET-OPT-INTRUSION ...................................................................................... 3186
SET-RADIUS-AUTH .......................................................................................... 3190
SET-SID............................................................................................................. 3194
SET-TH .............................................................................................................. 3198
SET-THPRFL-NAME ......................................................................................... 3204
SET-THPRFL..................................................................................................... 3208
STA-ISU............................................................................................................. 3214
SW-DX-EQPT .................................................................................................... 3218
SW-TOPROTN-EQPT ....................................................................................... 3222
SW-TOWKG-EQPT ........................................................................................... 3226
TEST-LED ......................................................................................................... 3230
AUTONOMOUS MESSAGE DESCRIPTIONS
REPT^ALM^ENV .............................................................................................. 3232
REPT^ALM^RR ................................................................................................ 3236
REPT^CANC ..................................................................................................... 3252

1830PSS R3.6.50 - TL1 Commands and Messages xvii


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents
REPT^COPY^RFILE......................................................................................... 3254
REPT^DBCHG .................................................................................................. 3260
REPT^EVT^RR ................................................................................................. 3264
REPT^EVT^SECU ............................................................................................ 3280
REPT^EVT^SESSION ...................................................................................... 3284
REPT^INFORMATION ...................................................................................... 3288
REPT^ISU ......................................................................................................... 3290
REPT^SW ......................................................................................................... 3292
APPENDICES
APPENDIX A: ACRONYMS AND ABBREVIATIONS ....................................... 3294
A.1 ACRONMYNS AND ABBREVIATIONS ............................................................................. 3294
APPENDIX B: ACCESS IDENTIFIERS............................................................. 3296
B.1 Facility AIDs....................................................................................................................... 3296
B.2 Fast Facility Protection Group AIDs ............................................................................... 3297
B.3 General Equipment AIDs.................................................................................................. 3297
B.4 DWDM Equipment AIDs: Packs, Ports/Facilities, Channels ........................................ 3299
B.5 FPGA AIDs ......................................................................................................................... 3310
B.6 Common AIDs ................................................................................................................... 3311
B.7 Software AIDs.................................................................................................................... 3311
B.8 THP AIDs............................................................................................................................ 3311
B.9 Edge Device Slot Numbering .......................................................................................... 3312
................................................................................................................................................... 3313
................................................................................................................................................... 3313
B10. Shelf Types and Slot Numbering ................................................................................. 3314
Shelf Types ............................................................................................................................ 3314
Slot range ................................................................................................................................ 3314
Housekeeping IN Ports ........................................................................................................... 3315
APPENDIX C: CONDITION TYPES .................................................................. 3318
APPENDIX D: DENIAL SCENARIOS AND ERROR CODES ........................... 3320
................................................................................................................................................... 3320
D.1 Generic deny scenarios ................................................................................................... 3320
D.1.1General Syntax deny scenarios .................................................................................... 3320
D.1.2 Internal System deny scenarios .................................................................................... 3322
D.1.3 System Not Ready deny scenarios ............................................................................... 3322
D.1.4 Application deny scenarios............................................................................................ 3322
................................................................................................................................................... 3324
D.2 COMMAND PARSER ERROR CODES ............................................................................. 3324
APPENDIX E: USER COMMAND PRIVILEGE DEFAULTS AND LOG INDICATION
............................................................................................................................ 3328

xviii 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Table of Contents Issue 1, December 2011

E.1. GENERAL USER PRIVILEGES ....................................................................................... 3328


E.2. USER PRIVILEGE DEFAULTS ........................................................................................ 3328
APPENDIX F: FACILITY STATE TRANSITIONSS ........................................... 3341
F.1 Port State Definitions........................................................................................................ 3341
Primary State .......................................................................................................................... 3352
Secondary State ..................................................................................................................... 3352

1830PSS R3.6.50 - TL1 Commands and Messages xix


8DG61100 EAAAQZZA
Issue 1, December 2011 Table of Contents

xx 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, Dec 2011

INTRODUCTION

1.1 GENERAL
This Manual describes the Transaction Language 1 (TL1) command and response messages available
in this release of the NE. These messages consist of input commands, command output response
(successful and unsuccessful) messages, acknowledgement output messages, and autonomous
output messages.
The general description and syntax for these messages is provided in this section (section 1) of the
manual.
A description of each input command and its associated output (successful and unsuccessful)
responses is presented in section 2 in alphabetical order by command code.
A description of each autonomous output message is presented in section 3 in alphabetical order by
response code.
Supplementary information is included in the appendices which follow section 3. A list of the
appendices is provided at the end of this Introduction.
This manual is intended for use by personnel involved in system installation and acceptance, technical
support, facility provisioning, plant maintenance, remote administration, and Operations Support
Systems development.

1.2 CONVENTIONS
The following conventions, described below, are used in this manual.
1.2.1 TL1 SYNTAX CHARACTERS
The following symbols are used as TL1 command input and response output syntax characters. Some
of these symbols are also used in this manual for notational purposes in describing command input
format and response output format, but these characters are only used as a literal character in an
actual command input or response output as described below.

1830PSS R3.6.50 - TL1 Commands and Messages 1


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION

Symbol Description
: A colon is used to separate parameter blocks in an input command or in a
parsable text output message.
, A comma is used to separate parameters within a parameter block of an input
command or an output response message.
; A semi-colon is used as a terminator to indicate the completion, and identify the
end, of an input command, a successful or unsuccessful output message, or an
autonomous message. A semi-colon does not appear within a parsable text
string or within free form, non-parsable, informational text.
> A greater-than sign is used as a continuation message terminator and indicates
additional output associated with the response will follow. A greater-than sign
does not appear within a parsable text string or within free form informational
text.
< A less-than sign is used as an acknowledgement message terminator and
identifies the end of an acknowledgement output message. A less-than sign
does not appear within a parsable text string or within free form informational
text.
- A hyphen is used to separate a command verb and modifiers (the command
code) and to separate arguments of a compound parameter.
= An equal sign is used to separate a keyword parameter from the keyword
parameter value.
& An ampersand is used to group parameter values in an input command (a list of
parameter values is generated).
& An ampersand is used to combine parameter values in an output message (for
example, secondary states).
&& A double-ampersand is used to represent numeric ranging on single or multiple
argument values of a (simple or compound) parameter in an input command (a
sequential series of parameter values is generated beginning with the first term
specified to the last term specified).
.++. A period - plus sign - plus sign - period is used to indicate a numeric
incrementing value, other than zero, is being specified for a numeric &&-range.
(Adding the notation .++.N after the last argument value specified in a numeric
&&-range results in a sequential series of values where the last argument value
of the parameter is incremented by N.)
" ... " Enclosing quotation marks are used to enclose parsable text strings in an output
response message line or to enclose a literal string used for an input parameter
value.
/* ... */ Beginning slash-asterisk and ending asterisk-slash is used to enclose
non-parsable free-form text strings in an output response message line.
\" ... \" Enclosing back-slash-quotation is used to enclose non-parsable free-form text
strings within a parsable text string in an output response message line.

1.2.2 VALID CHARACTER SET


In the context of this document, a format affector is defined as one of the following characters:
Horizontal Tab (<ht>)

Vertical Tab (<vt>)

2 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

Space (<sp>)

Form Feed (<ff>)

Line Feed (<lf>)

Carriage return (<cr>)

The valid character set for non-string (i.e., characters not enclosed in double quotes "") command
input and command output (i.e. characters not enclosed in backslash double quotes sequences \" \")
is:
Upper and lower case alphabetical characters unless otherwise specified in a command's descriptions.

Decimal numbers 0 through 9

Special characters:

Character Description
- underscore
+ addition or plus sign
% percent sign
# number or pound sign
. single period (for decimal representation)
(-<value>) negative number representation where <value> is a numerical value

In addition, the following special characters are reserved for TL1 command input syntax and may not be
used as part of a parameter’s value unless otherwise specified in a command's description

Character Description
: colon
; semi-colon
, comma
- hyphen or dash sign
= equal sign
& ampersand
" quotation mark

The maximum acceptable value of a numeric parameter is 4294967295. Beyond that limit, the parser
will reject the command with a syntax error.
The following ASCII characters are allowed (valid) to be entered as input parameter values when
enclosed in double quotes (””):
Upper and lower case alphabetical characters unless otherwise specified in a command's description.

Decimal numbers 0 through 9

1830PSS R3.6.50 - TL1 Commands and Messages 3


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
Special characters:

Character Description
_ underscore
+ addition or plus sign
% percent sign
# number or pound sign
. single period (for decimal representation)
! exclamation
& ampersand
* asterisk
() parenthesis
' apostrophe
, comma
- dash
. period
/ forward dash
: colon
= equal sign
? question mark
space character, ASCII code 32
[] square brackets
^ caret
$ dollar sign
{} curly brackets
| pipe
~ tilde
@ at sign

NOTE: terminator characters are excluded from the allowed ones.


The following ASCII characters are allowed (valid) to be displayed as text string in output parameter
values:
Upper and lower case alphabetical characters unless otherwise specified in a command's description.

Decimal numbers 0 through 9

Special characters:

4 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

Character Description
_ underscore
+ addition or plus sign
% percent sign
# number or pound sign
. single period (for decimal representation)
! exclamation
& ampersand
* asterisk
() parenthesis
' apostrophe
, comma
- dash
. period
/ forward dash
: colon
= equal sign
? question mark
space character, ASCII code 32
[] square brackets
^ caret
$ dollar sign
{} curly brackets
| pipe
~ tilde
@ at sign

SONET NEs may support the display of the incoming trace. The incoming trace may contain
characters outside the character set listed as valid ASCII characters in a output text string parameter .
Character substitution (where the incoming trace character is replaced with a character from the valid
character set) occurs for these special cases.
All alpha characters entered by the user must in upper case except:
Command code (verb-modifier-modifier), which may be entered in either upper or lower case, or a mixture
of upper and lower case.

Values for CTAG (Correlation Tag), which may be entered in upper or lower case.

Values for PID (Password Identifier), UID (User Identifier), which must be entered in the same case as
when created.

Values for TID (Target Identifier), which is converted to upper case for comparison to the provisioned SID
(Site Identifier) value.

1830PSS R3.6.50 - TL1 Commands and Messages 5


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
Values for SID (Site Identifier), which is converted to upper case for comparison to the entered TID
(Target Identifier) value.

Values for ISUKEY which may be entered in upper or lower case, or mixture of upper and lower case in
the STA–ISU command.

Values for WARN which may be entered in upper or lower case, or mixture of upper and lower case in the
SET-ATTR-SECULOG command.

Values for LOCATION which may be entered in upper or lower case, or mixture of upper and lower case
in the COPY-RFILE and RTRV-FILE commands.

Values for NODENAME (TCP/IP Network Name) which must be entered using the case as shown in the
ED-IP-PRMTR command.

Format affectors are ignored by the system’s command parser when entered in a command input
message in the following cases:
Before or after a command verb or verb modifier in a command code.

Before or after a command syntax punctuation or operator character, that is:

Character Description
: colon
, comma
; semi-colon
- dash
= equal
& ampersand
&& double ampersand
&- ampersand dash
&&- double ampersand dash
.++. period plus sign plus sign period
( left parenthesis
) right parenthesis

Before or after a command parameter name or a parameter value.

The case of characters displayed by output messages will be the same case as entered or as when
created except:
Values for TID (Target Identifier), which is always displayed in upper case.

Values for SID (Site Identifier), which is always displayed in upper case.

Values for <VERB>-<MODIFIER>[-<MODIFIER>], which is always displayed in upper case.

6 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

Values for parameters names, which are always displayed in upper case.

Command echo is always displayed in the same case as entered except for the Command code which as
noted above is always displayed in upper case.

The system will ignore all leading zeroes (that are not enclosed in double quotes "") in a command
input parameter (e.g., DAT=000002, DAT=02 are accepted). The retrieval output parameter will
display the entered parameter in the fixed format specified in such command descriptions (e.g., in the
previous example, the output DAT parameter would be displayed as DAT=02 for both cases).
Whenever a parameter value takes a negative number (real or integer), this value must be preceded
by the minus sign, and enclosed between parentheses. Valid examples are (-3) or ( -2.4).
1.2.3 PARAMETER VALUE SET NOTATION
In most cases, an input parameter of a command has more than one possible value. A parameter’s set
of values, or domain, is defined in this manual by using the following notation:
Notation Description
, A comma is used to separate parameter values when multiple values exist.
- A hyphen is used to indicate a range of values for the parameter, or a range of
values within an argument of a compound parameter. For example, 1-12
indicates a value set of 12 discrete values from one through twelve. A hyphen
may also be a literal character of a compound parameter’s value.
<...> Enclosing less-than and greater-than signs are used to enclose a description of
the parameter’s domain when this is more understandable than an exact
definition of the domain. For example, < 1 - 6 VALID CTAG CHARACTERS >
describes the CTAG domain of 1-6 case sensitive alphanumeric characters.
{...} Enclosing braces are used to enclose a set of values. Enclosing braces may be
nested. For example:
Enclosing braces as used to enclose a set of values. {LOF, LOS} describes
a value set consisting of the values LOF and LOS.
Enclosing braces as used to enclose an argument of a compound parameter
when a range of values exist for the argument of the compound parameter. {ABC
- {1-16} - {1-16} }describes a value set of 256 discrete values from ABC-1-1
through ABC-16-16 (note that the hyphens outside of the braces are literal
characters in the parameter’s value).
Braces as used to enclose a value subset that has been named to provide
additional clarity. A value subset may be named when the possible values of a
parameter consist of more than one type of value (or when naming the value set
provides additional clarity). When a value subset is named, the name of the
value subset and the value subset are separated by a colon (:). {Date:{0-99} -
{1-12} - {1-31}, Day:{SUN,MON,TUE,WED,THU,FRI,SAT,ALL,ODD,EVEN} }
describes a value set that consists of two types of value subsets, one value
subset named Date and the other value subset named Day.
: A colon is used to separate the name of a value subset and the value subset
when the value subset has been named for additional clarity. Refer to the
example above.

The parameter value <NoVal> is used to indicate a parameter value of "no value". <NoVal> is used in
describing input parameters when an unpopulated (not entered) parameter value has an explicit
definition other than another specific parameter value or "previously existing value". <NoVal> is used in
describing output parameters when no displayed output parameter value is part of the output
parameter value set.

1830PSS R3.6.50 - TL1 Commands and Messages 7


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
Assuming the output parameter is supported for a given output response (i.e., output parameter is
supported for specified retrieval of a provisioned AID), if <NoVal> or a Null value is a part of the output
parameter set and if <NoVal> or a null value is assigned to a keyword defined output parameter then
that output parameter will display no output to the right of the "=" sign.
1.2.4 COMMAND INPUT FORMAT NOTATION
The following notation is used in this manual to describe a command’s input format:
Notation Description
[...] Enclosing brackets are used to enclose an optional command input parameter.
<...> Enclosing less-than and greater-than signs are used to indicate a value
substitution. The enclosing less-than and greater-than signs are not part of the
actual input command. Generally, this notation is only used in this section to
provide additional clarity in the syntax descriptions for an input command.

Also refer to section 1.2.1., TL1 Syntax Characters, for a description of the TL1 command input syntax
characters, and to section 1.4.3, Command Input Format, for a description of each command input
parameter block.
1.2.5 OUTPUT RESPONSE FORMAT NOTATION
The following notation is used in this manual to describe a command’s output response message or an
autonomous output response message:

8 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

Notation Description
^ A caret is used to identify a space in a output response message. Generally, this
notation is only used in this section to provide additional clarity in the syntax
descriptions for output messages.
cr "cr" (carriage return) is used to indicate a carriage return in an output response
message. Generally, this notation is only used in this section to provide additional
clarity in the syntax descriptions for output messages.
lf "lf" (line feed) is used to indicate a line feed in an output response message.
Generally, this notation is only used in this section to provide additional clarity in
the syntax descriptions for output messages.
(...) Enclosing parenthesis may be used to enclose a group of symbols in an output
response, generally to provide additional notational clarity. Enclosing parenthesis
are also used in the non-parsable command echo line to enclose the Session
Number pertaining to the output response message. The enclosing parenthesis
are not part of the actual output message, except when used in the command
echo line of an output response.
[...] Enclosing brackets are used to enclose an optional item or group of items (for
example, a parameter or output response message line) in an output response.
Enclosing brackets are also used in the non-parsable command echo line to
enclose the CTAG value pertaining to the output response message. The
enclosing brackets are not part of the actual output message, except when used
in the command echo line of an output response.
<...> Enclosing less-than and greater-than signs are used to indicate a value
substitution. The enclosing less-than and greater-than signs are not part of the
actual output message.
{...} Enclosing braces are used to enclose a set of values. Generally, enclosing
braces are used in the notation for the non-parsable command echo line and in
describing an output parameter’s value set. The enclosing braces are not part of
the actual output message.
, A comma is used to separate parameters within an output response message,
and is also used as part of a parameter’s value set notation to separate
parameter values. When used to separate parameter values within a value set,
the separating comma is not part of the actual output message.
- A hyphen is used in describing an output parameter’s value set to indicate a
range of values for the parameter, or a range of values within an argument of a
compound parameter. A hyphen may also be a literal character of a compound
parameter’s value.
* An asterisk that is following enclosing brackets or parenthesis is used to indicate
the enclosed item may appear in an output response message zero, one or more
times. The enclosing brackets or parenthesis and asterisk are not part of the
actual output message. Generally, this notation is only used in this section to
provide additional clarity in the syntax descriptions for output messages.
+ A plus sign that is following enclosing brackets or parenthesis is used to indicate
the enclosed item may appear in an output response message one or more
times. The enclosing brackets or parenthesis and plus sign are not part of the
actual output message. Generally, this notation is only used in this section to
provide additional clarity in the syntax descriptions for output messages.

1830PSS R3.6.50 - TL1 Commands and Messages 9


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
1.3 COMMAND ENTRY
Network and User access is provided through TCP/IP on the LAN port of the LAN Switch board.
One command entry mode is available, Direct Input Command Entry mode. In Direct Input Command
Entry mode, commands are entered in their entirety by the user.
1.3.1 DIRECT INPUT COMMAND ENTRY MODE
In Direct Input Command Entry mode, commands are entered by typing the desired command on the
command input line, ending with a ; (semi-colon).

1.4 COMMAND DESCRIPTIONS


Command descriptions for each command are located in section 2 of this manual. Each command
description consists of the following subsections:
Command Header consists of the command code and name.
Purpose provides information on the function of the command.
Input Format shows the command’s TL1 input syntax. Refer to section 1.4.3, Command Input
Format, for a description of the format and notation for a TL1 command as used in this
manual.
Input Parameters describes the input parameters and parameter values that can be used
with the command. With regards to the input order of the Keyword-defined parameters
as the appear in this manual, Keyword-defined parameters may be entered in any
order (the keyword defines the parameter value being entered). Refer to section 1.4.4.,
Input Parameter Descriptions, for a description of the format used for this section of a
command description.
Successful Response Format shows the normal (successful) response format for the
command. With regards to the output order of the Keyword-defined parameters as the
appear in this manual, the system may generate an output response message with the
keyword parameters in non-alphabetical order (the keyword in the output response
defines the parameter value being reported). Refer to section 1.6., Command
Response Messages, for a description and syntax of command output response
messages.
Output Parameters describes the output parameters and parameter values shown in the
output response message, if any, except for parameters in the response header. An
Output Parameters section is not shown if the command does not provide output
parameters. Refer to paragraph 1.4.6., Output Parameter Descriptions, for a
description of the format used for this section of a command description.
Unsuccessful Response Format shows the error (unsuccessful) response format for the
command. Refer to section 1.6., Command Response Messages, for a description
and syntax of command output response messages.
Error Codes lists the error codes associated with the command’s unsuccessful response.
Examples provides one or more illustrations on the use of the command.
Related Commands provides a list of closely related or prerequisite (commands that must be
executed before the described command can be executed) commands.
Related Autonomous Responses provides a list of closely related autonomous response
messages, if any.
1.4.1 COMMAND HEADER
The Command Header section of a command description is at the top of the first page of the
command’s description. The command header consists of two parts, the command code which
provides the command verb and one or two modifiers as applicable:

10 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

COMMAND CODE: ACT-USER


and the command name, which provides the command’s full name:
COMMAND NAME: ACTIVATE USER
1.4.2 PURPOSE
The Purpose section of a command description describes the use or effect of the command and
discusses the command’s functionality.
1.4.3 COMMAND INPUT FORMAT
The Input Format section of a command description shows the command’s valid TL1 syntax. A TL1
command is an input message which consists of a command code, blocks of parameters, and
punctuation. The input message begins with the command verb and must end with a semicolon ( ; )
terminator. The general command input format takes the form:
VERB-MODIFIER[-MODIFIER]:[TID]:[AID]:[CTAG]:[GENERAL]:[POSITIONAL]:[KEYWORD]:[STATE];
The maximum character length of any input message is 1024 characters.
When this limit is reached, the incomplete truncated command as typed is sent to the parser which will
th
return a syntax error (unless the 1024 character happens to be a semi–colon), as it would for any
incomplete command.
A few commands (for example, the Telcordia OPR-PROTNSW-rr command) have an input format
where all parameter blocks following the General Block are positional parameter blocks. In these
cases, the command input format takes the form:
VERB-MODIFIER[-MODIFIER]:[TID]:[AID]:[CTAG]:[GENERAL]:[POSITIONAL]: ... :[POSITIONAL];
A series of parameter blocks follow the command code. Parameter blocks contain zero, one or more
parameters. Parameter blocks are separated from the command code, and from each other, by a
colon ( : ). Parameters within a parameter block are separated from each other by a comma ( , ). All
parameter blocks are not required by all commands, nor are all parameters always required for each
block.
Brackets [...] are used in the command input format to indicate optional parameters within a block.
Absence of brackets indicate the parameter must be entered. The brackets are not entered as part of
the actual command and are only shown for notational purposes. The syntax characters , (comma) or :
(colon) can also be optional (as described below), but brackets are not necessarily used to indicate
that they are optional.
If one or more parameter blocks are omitted from the end of a command (no parameters are entered
in the last block(s) of a command), the trailing colons associated with them may be omitted. In addition,
if one or more parameters are omitted from the end of a parameter block, the trailing commas
associated with them may be omitted. However, if an optional parameter value in a positional
parameter block is omitted with other positional parameter values following, all of the intervening
place-holder commas must be provided to indicate no value is being entered for that positional
parameter. No additional commas are needed if an optional keyword parameter is omitted from a
keyword parameter block; only commas separating each keyword parameter are required in the
keyword parameter block.
Trailing commas at the end of a Positional, AID, or State block are optional. The parser accepts 0 to n
trailing commas (e.g.,[a],, or [a]) where n is the maximum number of input parameters in a block minus
1.
Commas in the Keyword block are used to separate keyword parameters.
An Example of syntactically correct keyword parameter block is:
PARM1=VALUE1, PARM2=VALUE2
Examples of syntactically incorrect keyword parameter blocks are:
,,PARM1=VALUE1, PARM2=VALUE2 (incorrect because of the two leading commas)
PARM1=VALUE1,,PARM2=VALUE2 (incorrect because of the two separating commas)

1830PSS R3.6.50 - TL1 Commands and Messages 11


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
PARM1=VALUE1, PARM2=VALUE2,, (incorrect because of the two trailing commas)
Trailing colons at the end of any command are optional. The parser accepts 0 to n trailing colons
(e.g.,“RTRV-HDR:::;” or “RTRV-HDR;”) where n is the maximum number of blocks minus 1.
1.4.4 INPUT PARAMETERS
The Input Parameters section of a command description describes all required and optional
parameters listed in the Input Format section of a command description, and describes the possible
values, default value, and any addressing or restrictions for each parameter. The general format of the
Input Parameters section is:
PARM {PARAMETER_VALUE_SET}
Default: {Default Value}
Addressing: Any parameter addressing or grouping rules
Description: Description of the parameter. Values are:
PARM_VALUE Value's Name: Description of the input parameter’s values.
Restrictions: Any restrictions pertaining to the parameter or parameter’s values.
where:
PARM: The parameter identifier. A positional parameter is identified by PARM, a keyword
parameter is identified by PARM=.
PARAMETER_VALUE_SET: The parameter’s set of values or domain.
Default: The default value of the parameter if the parameter is omitted from the input command
(the parameter value assumed by the system and/or obtained via an associated
retrieve command if the parameter is not entered in the command).
Addressing: Any parameter ranging and grouping addressing rules.
Description: The input parameter’s name and a brief description of the parameter.
PARM_VALUE: The parameter’s value identifier and description for each of the parameter’s
values. PARM_VALUE is only shown when applicable, for example, it’s not shown for
the TID or CTAG parameters.
Restrictions: Tny restrictions pertaining to the parameter or the parameter’s values.
Restrictions are only described when applicable.
Input parameters in this release will all abide by the following rules.
Omitting an optional keyword or positional parameter from a TL1 command other than an "ED" or a
"SET" type TL1 command will have the identical effect as actually entering that TL1 parameter with its
default value assigned.
Except for keyword defined CMDMDE or MODE parameter (whose default is always NORM), omitting
an optional keyword or positional parameter from an "ED" or a "SET" type TL1 command will have no
effect on that parameter (i.e. the default is "previously existing value" for "ED" or "SET" TL1 command).
Upper or lower case alphabetical characters (a-z, A-Z), decimal numbers (0 through 9), and the special
characters underscore (_), plus (+), percentage (%), pound (#) will be the only valid characters for
symbolic name values (eg., UID parameter values). Dash (-) is also allowed for separating compound
values (eg., TL1 command names, TID, SID, AID parameter values).

1.4.4.1 TID Parameter Block


The Target Identifier (TID) is optional and is the first block after the command code. The TID value is
used to specify the target system for remotely issued commands. If unpopulated (not entered), the
system assumes a TID value of the (upper case) Site Identifier (SID) value. If a value is entered for
TID, that value is converted to upper case and compared with the provisioned (upper case) SID value.
The command is denied if the converted upper case TID value and provisioned (upper case) SID value
don’t match and DCC is not supported.

12 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

A TID is the first parameter block after the command code. TID may be optional.
Valid values for TID are:
1 to 20 alphanumeric characters or hyphens (-). A TID value begins with an alpha character and end
with an alphanumeric character. Consecutive hyphens (-) will not be allowed.
OR
1 to 20 characters quoted string, that is any string of maximum 20 characters, including special
characters, included in double quotes.
The values for TID may be entered in upper or lower case. If unpopulated (not entered), the system
assumes a TID value of the (upper case) Site Identifier (SID) value.

1.4.4.2 AID Parameter Block


The Access Identifier (AID) value is generally a letters and digits compounded value and directs an
input command to its intended equipment, facility, or data entity.
An AID is the second parameter block after the command code. An AID may be optional, and may be
a compounded value comprised of alphanumeric characters and dashes (where dashes are
separators).
An AID value directs an input command to its intended equipment, facility, or data entity.

1.4.4.3 CTAG Parameter Block


The Correlation Tag (CTAG) is an optional block and is used to correlate an input command with its
associated output message by copying the command’s CTAG value into the appropriate field of the
command’s output response. An optional CTAG value can be generated by the OS for every
command. If an invalid CTAG value is identified in a command, the NE denies the command and
responds with the error code IICT and with the number "0" in the CTAG field(s) in the TL1 response,
except for the actual command echo. Note that the CTAG value received in a command need not be
unique.
The CTAG shall be the third parameter block after the command code. The CTAG is optional, and if
present and valid it shall be used to correlate an input command with its associated output message by
copying the command’s CTAG value into the appropriate field of the command’s output response.
In the case where an invalid CTAG value is received with a command, or the NE is unable to parse the
CTAG field in the input command, the NE shall deny the command with a IICT (Input, Invalid
Correlation Tag) error code, and shall provide a single decimal character zero (0) CTAG value in the
deny output response for the command, except for the actual command echo.
In the case where the CTAG value is not received with a command, i.e. CTAG is missing, the NE shall
accept the command if not otherwise invalid, and shall use an internally generated CTAG in the
response.
Valid values for CTAG shall consist of a TL1 identifier or non-zero decimal number of no more than 6
characters from GR-831 listed below:

<ctag> ::= <ident> | <dec num>


Where
<ident> ::= <let> (<let> | <dig>)*
and
<dec num> ::= [D'] <dig>* [.] <dig>+
The definition of a letter is
<let> ::= A | B | ... | Z | a | b | ... | z
and the definition of a digit is
<dig> ::= 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

1830PSS R3.6.50 - TL1 Commands and Messages 13


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION

1.4.4.4 General (Delayed Activation) Parameter Block


Delayed Activation is not supported in this release.
The general block is used for specifying delayed activation (DA) parameters. Delayed activation is only
supported by those commands that include the general block in the command’s input format. Brackets
are used to indicate an optional parameter value. If one or more parameter values are omitted from the
end of the block, the trailing commas associated with them may be omitted. However, if a parameter
value is omitted with other positional parameter values following, all of the intervening place-holder
commas must be provided to indicate no value is being entered for that parameter. The system
assumes the default parameter value for omitted optional parameter values.
The format of the general block is:
:[<ON>],[<DATE>],[<TIME>],[<FLAG>]

1.4.4.5 Positional Parameter Block


Parameters in the positional block are defined by their position or sequence in the block. Brackets are
used to indicate optional parameter values. Absence of brackets indicate the parameter value must be
entered. If one or more parameter values are omitted from the end of the block, the trailing commas
associated with them may be omitted. However, if an optional parameter value is omitted with other
positional parameter values following, all of the intervening place-holder commas must be provided to
indicate no value is being entered for that parameter. The system assumes the default or existing
parameter value for omitted optional parameter values. Parameter value combinations are verified by
the system whether the value is determined from a default value or explicitly entered in the command.
The format for a positional parameter block is:
:[<PARM#1_Value>],[<PARM#2_Value>],[<PARM#3_Value>],....,[<PARM_Value#n>]
For notational simplicity, the enclosing less-than and greater-than signs are not shown in a command
description when describing a command’s TL1 syntax. Only the parameter name, and any brackets to
identify an optional parameter, is shown in the parameter block (:[PARAMETER#1],[PARAMETER#2]
etc.), but the appropriate parameter value is entered for a parameter in an actual input command.

1.4.4.6 Keyword Parameter Block


Parameters in the keyword block are defined by the use of a keyword parameter name. A value for a
keyword parameter is specified by entering the parameter name followed by an = (equal sign) followed
by the parameter value. Keyword parameters may be entered in any order within the keyword block but
must be separated by a comma. Only commas separating each keyword parameter are required in the
keyword parameter block, but the keyword block may not begin or end with a comma. Brackets are
used to indicate optional parameters and their associated comma separators. Absence of brackets
indicate the parameter and any comma separator must be entered. The system assumes the default
parameter value for omitted keyword parameters. Parameter value combinations are verified by the
system whether the value is determined from a default value or explicitly entered in the command.
The format for a keyword parameter block is:
:[KEYWORD#1=VALUE#1][,KEYWORD#2=VALUE#2]....[,KEYWORD#n=VALUE#n]
For notational simplicity, keyword input parameters in a command input description are (generally)
shown in alphabetical order, but the keyword input parameter value is not shown when describing a
command’s TL1 input syntax. Only the keyword input parameter name followed by an equal sign, and
any brackets to identify an optional parameter, is shown in the input parameter block
(:[KEYWORD#1=][,KEYWORD#2=] etc.), but the keyword input parameter and keyword value is
entered in an actual input command.
For keyword output parameters, the parameters in a command ouput description are also (generally)
shown in alphabetical order. The keyword output parameter name followed by an equal sign followed
by <value>, and any brackets to identify an optional parameter, is shown in the output parameter block
(:[KEYWORD#1=<value>] [,KEYWORD#2=<value>] etc.).

14 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

1.4.4.7 State Parameter Block


The state parameter block is a positional block with parameters defined by their position or sequence
in the block. The state block is only supported by those commands that include it in the command’s
input format. When supported, up to two parameters are possible for the state block, the PST (Primary
State) parameter and SST (Secondary State) parameter. Brackets are used to indicate optional
parameter values. Absence of brackets indicate the parameter value must be entered. If the SST
parameter value is omitted from the end of the block, the trailing comma associated with it may be
omitted. However, if an optional PST parameter value is omitted with a SST positional parameter value
following, the intervening place-holder comma must be provided to indicate no value is being entered
for the PST parameter. The system assumes the default parameter value for omitted optional
parameter values. Parameter value combinations are verified by the system whether the value is
determined from a default value or explicitly entered in the command.
The format for a state parameter block is:
:[<PST>],[<SST>]
For notational simplicity, the enclosing less-than and greater-than signs are not shown in a command
description when describing a command’s TL1 syntax. Only the parameter name, and any brackets to
identify an optional parameter, is shown in the parameter block (:[PST,[SST]]), but the appropriate
parameter value is entered for a parameter in an actual input command.
1.4.5 SUCCESSFUL RESPONSE FORMAT
Command response messages provide information about responses that would result from entering a
command. Commands entered result in response messages which provide results or status of the
command. A successfully executed command results in a successful response. If a successful
response cannot be sent within two seconds of receipt of an input command, an In-Progress
acknowledgement response message is sent to the user. Refer to section 1.6., Command Response,
for a description and syntax of command output response messages.
1.4.6 OUTPUT PARAMETERS
The Output Parameters section of a command description describes all output parameters included in
the command’s successful response message, except those in the response header. If the command
does not produce output parameters, this section does not appear. The format of the Output
Parameters section is:
PARM { PARAMETER VALUE SET }
Description: Description of the Output parameter. Values are:
PARM_VALUE Value's Name: Description of the output parameter’s values.
where:
PARM: the output parameter’s identifier.
PARAMETER VALUE SET: the output parameter’s set of values or domain.
PARM_VALUE: the parameter’s value identifier and description for each of the output parameter’s
values. PARM_VALUE is only shown when applicable.
1.4.7 UNSUCCESSFUL RESPONSE FORMAT
Command response messages provide information about responses that would result from entering a
command. Commands entered result in response messages which provide results or status of the
command. Commands which did not execute properly result in an unsuccessful response. If an
unsuccessful response cannot be sent within two seconds of receipt of an input command, an
In-Progress acknowledgement response message is sent to the user. Refer to section 1.6, Command
Response, for a description and syntax of command output response messages.

1830PSS R3.6.50 - TL1 Commands and Messages 15


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
1.4.8 ERROR CODES
The Error Codes section of a command description lists the error codes associated with the
command’s unsuccessful response. The error code acronym, the expanded error code description,
and any informational error description text that may be generated by the system for the Error Code, is
provided for each Error Code listed. Error Codes common to all commands that are generated
because of a Command Parser/Common Application error are shown in Appendix D, Error Codes, and
are not duplicated in this section. Only non-Parser generated Error Codes are shown in this
subsection. The Command Parser/Common Application error codes are also described in section
1.11.
1.4.9 EXAMPLES
The Examples section of a command description illustrates the use of the command.
1.4.10 RELATED COMMANDS
The Related Commands section of a command description provides a list of closely related or
prerequisite commands.
1.4.11 RELATED AUTONOMOUS RESPONSES
The Related Autonomous Messages section of a command description provides a list of closely related
autonomous messages, if any.

1.5 AUTONOMOUS RESPONSE FORMAT


Autonomous response descriptions for each autonomous response are located in section 3 of this
manual. Refer to section 1.7, Autonomous Responses, for a description and syntax of autonomous
response messages. Each autonomous response description consists of the following subsections:
Response Header consists of the response code and name.
Purpose provides information on the function or cause of the autonomous response.
Response Format shows the response format for the autonomous response.
Output Parameters describes the parameters and parameter values shown in the
autonomous response, except for parameters in the response header. The description
format for this section is the same as that used for describing a command’s output
parameter. (Refer to paragraph 1.4.6., Output Parameter Descriptions.)
Examples provides one or more illustrations of the autonomous response.
Related Commands identifies any closely related commands, if any.
Related Autonomous Responses provides a list of closely related autonomous responses,
if any.
1.5.1 RESPONSE HEADER
The autonomous response Header section of an autonomous response description is at the top of the
first page of the autonomous response description. The autonomous response header consists of two
parts, the autonomous response code which provides the response verb (e.g., REPT) and one or two
modifiers, as applicable, separated by a ^ (caret) to represent a space:
RESPONSE CODE: REPT^EVT^EQPT
and the autonomous response name, which provides the full name of the autonomous response:
RESPONSE NAME: REPORT EVENT EQUIPMENT
1.5.2 PURPOSE
The Purpose section of the autonomous response description describes the use or cause of the
autonomous response.

16 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

1.5.3 RESPONSE FORMAT


Refer to section 1.7., Autonomous Responses, for a description and syntax of command output
response.
1.5.4 OUTPUT PARAMETERS
See section 1.4.6.
1.5.5 EXAMPLES
The Examples section of each autonomous response description illustrates the autonomous response.
1.5.6 RELATED COMMANDS
The Related Commands section of an autonomous response description provides a list of closely
related commands, if any.
1.5.7 RELATED AUTONOMOUS RESPONSES
The Related Response section of an autonomous response description provides a list of closely
related responses, if any.

1.6 COMMAND RESPONSES


Command response messages provide information (data, status, etc.) as a result of entering a
command. A successfully executed command results in a successful response. Commands which did
not execute properly result in an unsuccessful response. If a successful or unsuccessful response
cannot be sent within two seconds of receipt of an input command, one In-Progress acknowledgement
response message is sent to the user.
All responses, except an Acknowledgement Response, begin with a header line:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS>

where:
SID is the upper case Site Identifier as created by the SET-SID command.
YY-MM-DD is the year-month-day, where YY is the last two digits of the year, MM is the
month, and DD is the day of the month.
HH:MM:SS is the current time of day, where HH is the hour with a range from 00 to 23, MM is
the minutes, SS is the seconds, with a range for MM and SS is from 00 to 59.
The last response line before the message terminator is a non-parsable “command echo” line. The
format of a command echo line is:
^^^/*^<Command_Echo>^[<CTAG>]^(<CID[-VCNUM]>)^*/
or
^^^/*^<Command_Echo>^[<CTAG>]^(CRON:<Order_Number>)^*/
or
^^^/*^<Command_Echo>^[<CTAG>]^([<PORT>-]<Session_Number>)^*/
or
^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/
with a composite format representation of

1830PSS R3.6.50 - TL1 Commands and Messages 17


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
^^^/*^<Command_Echo>^[<CTAG>]^({<CID[-VCNUM]>,CRON:<Order_Number>,[<PORT>-]<Se
ssion_Number>})^*/
where:
<Command_Echo> is an exact matching of the input command entered, except for
commands that have password as an input parameter (ACT-USER, ENT-USER,
ED-PID commands) do not display any parameter values after the CTAG as part of
the command echo.
<CTAG> is the associated CTAG value, displayed within brackets [...].
<CID[-VCNUM]> is the communication port number and virtual channel number, if any,
used to enter the command, displayed within parentheses (...).
CRON:<Order_Number> is the delayed activation order number used to enter the
command, displayed within parentheses (...).
[<PORT>-]<Session_Number> is the communication port number (if any) and LAN session
number used to enter the command, displayed within parentheses (...)
<Session_Number> is the LAN session number used to enter the command, displayed within
parentheses (...)
The last response line, as well as any other comment line in the response, shall not contain any
terminator character (e.g. ";" at the end of the command echo). This is because any terminator char will
be interpreted as the end of the response by the NMA system. So, the only allowed terminator char in a
response shall be the last char of the response itself.
The maximum character length of any output response line is 1024 characters (before the output is
truncated excluding cr lf).
Output response lines that are longer than the terminal display line automatically wrap to the first
character position of the next line if the terminal is supporting an auto-wrap capability. The system
does not insert a "cr lf" within a single output response line to prevent line "run-off" on terminals that do
not have an auto-wrap capability.
Up to six two-character acknowledgment codes (IP, OK, RL, NG, NA, PF) and five completion codes
(i.e.., COMPLD, DELAY, PRTL, CANCLD and DENY) can be supported in the output responses.
Two two-character acknowledgment codes (IP, and OK) and four completion codes (i.e.., COMPLD,
PRTL, CANCLD and DENY) can be supported in the output responses.
When a valid TL1 command with an AID field that specifies an input range of AIDs is executed, only
one complete (COMPLD), partially complete (PRTL), or fail message (DENY) for the entire elements
will be sent to the user.
The output response will support the following completion codes:
DELAY: Represents successful queuing of the input command submitted for delayed activation. (DELAY
response is not implemented in R2.0 and R2.5 of 1830PSS)

CANCLD: Represents the cancellation of an in-progress operation (e.g., cancellation of database backup
in progress). (CANCLD response is not implemented in R2.0 and R2.5 of 1830PSS)

COMPLD: Represents total successful execution of the input command.

PRTL: Represents partial successful execution of the input command. This response code is returned for
output response to input commands specifying multiple AIDs of which only a subset (but not an empty
subset) have been successfully executed. If all AIDs have failed to be executed, the response code will
be DENY. (PRTL response is not implemented in R2.0 and R2.5 of 1830PSS)

DENY: Represents total denial of the input command.

18 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

Commands which uses a range will send response(s) (whether one or multiple responses) containing
the same CTAG.
1.6.1 ACKNOWLEDGEMENT RESPONSE FORMAT
IP (In-Progress) Acknowledgement Message: If the system experiences an excessive delay in the
processing of an input command such that a response to a command (successful or unsuccessful)
cannot be sent within two seconds of receipt of the command, one command acknowledgement
response (In-Progress message) will be automatically generated and sent to the user. An
acknowledgement response does not interrupt other output responses currently in progress. The IP
(In-Progress) acknowledgement message indicates the command has been initiated and a completion
message follows.
The "cr lf lf" at the beginning of an acknowledgement message, any non-parsable (/* ... */) lines
containing informational text in an acknowledgement response, and the non-parsable command echo
line in an acknowledgement response shall be always present
The general format of an IP acknowledgement message is:

[cr lf lf]
IP^<CTAG> cr lf *
[^^^/*^<Free_Form_Informational_Text>^*/ cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf ]
<

For the IP acknowledgement message described above, all the messages will have the same CTAG
as the command that the system is unable to respond to within two seconds.
The IP acknowledgement response shall be the only type of acknowledgement message provided. The
PF (Printout Follows), NA (No Acknowledgement), NG (No Good), OK (Good) and RL (Repeat Later)
acknowledgement messages shall not be supported. The system shall generate an unsuccessful
DENY response in lieu of any unsupported acknowledgement response that may occur.
If the system experiences an excessive delay in the processing of an input command, the system will
send an acknowledgement message indicating the pending state to an OS. If a successful or
unsuccessful response can not be sent within two seconds of receipt of an input command, one IP
acknowledgement response message will be sent to the user.
1.6.2 SUCCESSFUL RESPONSE FORMAT
A single successful response message is generated if a command with a single AID specified is
successfully executed. Information displayed in the response varies with each command and is
specified in the command description. The general format of a successful response message is shown
below.

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^“<Parsable_Output_Data>” cr lf ]*
[^^^/*^<Free_Form_Informational_Text>^*/ cr lf ]* *
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>) ^*/ cr lf ]
;

Unless otherwise specified in the individual I/O manual pages, the output format for any TL1 command
that has successfully executed is:

1830PSS R3.6.50 - TL1 Commands and Messages 19


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^”[AID1[,AID2]]:[<position-defined parameter
value1>,<position-defined parameter
valueN>]:[keyword1=<value>[,keywordN=<value>]]:[PST[,SST]]” cr lf]*
[^^^/* <Free_Form_Informational_Text> */ cr lf]*
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1.6.3 UNSUCCESSFUL RESPONSE FORMAT


A single unsuccessful response message is generated if:
A command (other than to establish a log-on session) with a single AID specified fails to execute.

A Retrieval or Non-Retrieval command is issued using &&-ranging or &-grouping and the command fails
to execute for all of the specified AIDs for a single error code (fails to execute for only one type of error
- Single Error Denial Response generated).

A Retrieval or Non-Retrieval command is issued using &&-ranging or &-grouping and the command fails
to execute for all of the specified AIDs for multiple error codes (fails to execute for more than one type
of error - Multiple Error Denial Response generated).

An ACT-USER command to establish a log-on session fails to execute (Session Attempt Denial
Response generated).

The information displayed in an unsuccessful response message varies for different commands and is
specified in the command description. If a parsable line of output data is provided, the
<Parameter_Block> field provides information about the location of any error(s) in the input command.
Single Error Denial Response: The general format of a Single Error Denial Response is:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<Error_Code> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf ]
([^^^“[AID1[,AID2]]:[<position-defined parameter
value1>,<position-defined parameter
valueN>]:[keyword1=<value>[,keywordN=<value>]]:[PST[,SST]]” cr lf ]
[^^^/*^<Informational_Error_Description_Text>^*/ *cr* lf ]*
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf] )
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf ]
;

Multiple Error Denial Response: The general format of a Multiple Error Denial Response is:

20 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^MERR cr lf
(^^^“[<AID1>[,<AID2>]]:ERCDE=<Error_Code>[,<position-defined
parameter value1>,<position-defined parameter
valueN>]:[keyword1=<value>[,keywordN=<value>]]:[PST[,SST]]” cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf ] *
[^^^/*^<Informational_Error_Description_Text>^*/ cr
* +
lf ]
[^^^/*^<Optional Suggested Action Text>^*/ cr lf ] )
[^^^/*^Multiple ERRor^*/ cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf ]
;

Session Attempt Denial Response: In the special case where a user attempts to log-on to the
system (with the ACT-USER command) but enters an incorrect UID (User Identifier) or an incorrect
PID (Password Identifier), the system will generate the following unsuccessful response message. For
security reasons, an Error Code is not provided with this response.

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^/*^session^not^active^*/ cr lf
;

<Error CODE> and additional expanded error description text will not be provided for any command or
any unparsable character sequence prior to a user successfully logging into the system. The output
response is:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^/*^session^not^active^*/ cr lf
;

Unless otherwise specified in the individual I/O manual pages, the output format for any TL1 command
that has partially completed is:

1830PSS R3.6.50 - TL1 Commands and Messages 21


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^PRTL cr lf
(^^^”[<AID1>[,<AID2>]]:ERCDE=<Error_Code>[,<position-defined
parameter value1>,<position-defined parameter
valueN>]:[keyword1=<value>[,keywordN=<value>]]:[PST[,SST]]” cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr
* +
lf]*
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf] )
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1.6.4 RETRIEVALS
Successful RETRIEVAL Response: Unless otherwise specified in the individual I/O manual pages,
the general format of a Successful Retrieval Response is:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^”[AID1[,AID2]]:[<position-defined parameter
value1>,<position-defined parameter
valueN>]:[keyword1=<value>[,keywordN=<value>]]:[PST[,SST]]” cr lf]*
[^^^/* <Free_Form_Informational_Text> */ cr lf]*
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Partially Successful RETRIEVAL Response: Unless otherwise specified in the individual I/O manual
pages, the general format of a Partially Successful Retrieval Response is:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^PRTL cr lf
(^^^"[<AID1>[,<AID2>]]:[ERCDE=<Error_Code>,][<position-defined
parameter value1>,<position-defined parameter
valueN>]:[keyword1=<value>[,keywordN=<value>]]:[PST[,SST]]" cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf ]
[^^^/*^<Informational_Error_Description_Text>^*/* cr
+
lf ]*
[^^^/*^<Free_Form_Informational_Text>^*/ cr lf ] )
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

The optional use of those parts of the syntax format above described, included in the parenthesis
followed by the plus sign "(...)+", shall be considered as following described:
Those rows of the response that are related to AIDs with error report shall include only the AID block, the
ERCDE parameter, the Expanded_Error_Code_Description and the
Informational_Error_Description_Text.

22 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

Those rows of the response that are related to AIDs with successful report shall not include the ERCDE
parameter, the Expanded_Error_Code_Description and the Informational_Error_Description_Text.

The rows compounding the response shall be sorted by increasing AID, no matter about the error or
successful condition of each row.
For the RTRV-rr command (where rr=facility), when the user specifies an AID or range of AIDs, the
primary and secondary state output parameters shall display information about an object entity that
matches the search criteria regardless of whether the entity is provisioned or not.
If a range and/or group or ALL is specified for the retrieval AID, each line of parsable output data for
each AID successfully retrieved shall be sorted in ascending (numerical and alphabetical) order by the
first AID mnemonic/name in the AID block then by bay-shelf-slot-instance fields.
When the user specifies an AID on a RTRV-EQPT or other equipment related retrieve commands, the
primary and secondary state output parameters shall display information about an object entity that
matches the search criteria regardless of whether the entity is provisioned or not.
For all other retrievals (e.g., RTRV-CRS, RTRV-CRS-rr, RTRV-FFP-rr, RTRV-PM-rr, etc), the retrieval
command shall only retrieve information about the provisioned entities when the AID block specifies a
range of AIDs (if applicable) or the ALL AID.
1.6.5 CONTINUATION MESSAGE FORMAT (OUTPUT GREATER THAN 4096
BYTES)
If a user receives output on a TTY terminal and a response message contains more than 4096 bytes of
data, the data block will end in a > (greater than sign) terminator and subsequent data blocks
containing the remainder of the data follow. The subsequent data blocks repeat the message header,
the command echo line, and continue the data. The last data block ends with the normal ; (semi-colon)
terminator.
The general format for continuation of a response message is:

(cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^<Completion_Code> cr lf
[^^^“<Parsable_Output_Data>” cr lf ]*
[^^^/*^<Free_Form_Informational_Text>^*/ cr lf ]*
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/
+
cr lf]
>)
cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^<Completion_Code> cr lf
[^^^“<Parsable_Output_Data>” cr lf ]*
[^^^/*^<Free_Form_Informational_Text>^*/ cr lf ]*
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf ]
;

For the output responses described above, all output responses will have the same CTAG and
completion code.

1.7 AUTONOMOUS RESPONSES


Autonomous response messages are unsolicited and generated automatically because of an
autonomous event detected by the system, as opposed to solicited response messages generated in
response to a command entered by a user. There are three general categories of autonomous
responses, autonomous system event messages (alarms, events, database changes, scheduled

1830PSS R3.6.50 - TL1 Commands and Messages 23


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION
performance monitoring reports, and system initialization), autonomous informational messages, and
autonomous keep-alive messages.
All autonomous response messages will begin with a header line:
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> where
SID is the upper case Site Identifier as created by the SET-SID command.
YY-MM-DD is the year-month-day, where YY is the last two digits of the year, MM is the
month, and DD is the day of the month.
HH:MM:SS is the current time of day, where HH is the hour with a range from 00 to 23, MM is
the minutes, SS is the seconds, and the range for MM and SS is from 00 to 59.
1.7.1 AUTONOMOUS MESSAGE FORMAT
The general format of an autonomous message is:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
<CDE>^{<ATAG>,<ITAG>,<KATAG>}^<VERB>^<MODIFIER>[^<MODIFIER>] cr lf
[^^^“<Parsable_Output_Data>” cr lf ]*
[^^^/*^<Free_Form_Informational_Text>^*/ cr lf ]*
;

where
CDE identifies the type of autonomous message. Values are:
Value Description
*C autonomous critical alarm being reported.
** autonomous major alarm being reported.
*^ autonomous minor alarm being reported.
A^ autonomous non-alarm event being reported.

ATAG is the autonomous message tag used to correlate autonomous messages.


KATAG is the autonomous keep-alive message tag used to correlate keep-alive messages.
VERB^<MODIFIER>[^<MODIFIER>] is the autonomous response or informational response
code name (e.g.,
REPT^ALM^{EQPT|[COM]|<facility-level>}

REPT^DBCHG

REPT^EVT^{EQPT|[COM]|<facility-level>|[SESSION]|[SECU]}

KEEP^ALIVE^MESSAGE

REPT^PM^{<facility-level>})

where REPT^ALM, REPT^DBCHG, REPT^EVT, REPT^DEBUG are used with autonomous response
messages (ATAG), while KEEP^ALIVE^MESSAGE are used with autonomous keep-alive messages
(KATAG). )
where REPT^PM is used with an autonomous response message (has an ATAG),

24 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INTRODUCTION Issue 1, Dec 2011

The ATAG value is sequentially generated by the system for every autonomous message (CDE has a
value other than I^ ). The format for an ATAG is modulo nnnnn where n is decimal 0-9 with leading
zeroes suppressed.
The KATAG value will be sequentially generated by the system and per system for every keep-alive
message. The format for a KATAG will be modulo 99999.
1.7.2 AUTONOMOUS KEEP^ALIVE MESSAGE FORMAT
The KEEP ALIVE MESSAGE autonomous response is generated by the system to maintain user
session communication link activity to any logged-in user provisioned with a KAMINTVL parameter
value of {0, 240} (refer to the SET-ATTR-SECUDFLT command).
The format of an autonomous KEEP^ALIVE message is:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
I^^<KATAG>^KEEP^ALIVE^MESSAGE cr lf
;

1.12 APPENDICES
The appendices contain supplementary information useful in using this manual. The following
appendices are provided:
Appendix A, Acronyms and Abbreviations contains an alphabetized list of general
acronyms and abbreviations used within this manual.
Appendix B Access Identifiers (AIDs) contains a description of AID formats and an
alphabetized list of equipment, facility, and common names.
Appendix C, Condition Types contains a list of all equipment, facility, and common condition
types.
Appendix D, Denial Scenarios and Error Codes contains a list of all Error Codes that
may be used in an unsuccessful response message, and a list of Error Codes
generated by the system’s Command Parser.
Appendix E, User Command Privilege Defaults contains the Command Access Privilege
(CAP) for each supportedcommand.
Appendix F, Facility State Transitions contains description of the facility state transition
supported in this product.
.

1830PSS R3.6.50 - TL1 Commands and Messages 25


8DG61100 EAAAQZZA
Issue 1, Dec 2011 INTRODUCTION

26 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ACT-USER


Command Name: ACTIVATE USER

PURPOSE
The ACT-USER command authenticates a session established with the system by logging in an
existing user through a User Identifier and a Password Identifier.
The entered PID (Password Identifier) is not displayed on any screen and is not available to any user in
any file. No in-progress message is output by the system in response to an ACT-USER command.
If the UID (User Identifier) does not exist in the system or if the specified PID (Password Identifier) has
been deactivated or disabled by the system due to user account inactivity, the command is denied.
However, an error message is not generated.
Once the session is established on a given NE, another ACT-USER on the same connection for the
same NE will be denied.
A maximum of 20 TL1 sessions are supported to an NE .
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ACT-USER:[TID]:UID:[CTAG]::PID;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: <Entry Required>


Addressing: None
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

1830PSS R3.6.50 - TL1 Commands and Messages 27


8DG61100 EAAAQZZA
Issue 1, December 2011 ACT-USER

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

PID Value Description


<8-32 VALID PID CHARACTERS,
depending on minlength and maxlength
provisioned values>

Default: <Entry Required>


Addressing: None
Description: Password Identifier, specifies the user's login password.
Valid values for NEWPID are a string of minlength through
maxlength case-sensitive alphanumeric characters, where
minlength is 8 by default and provisionable 8-32. The NEWPID
must contain at least three of the following: at least one lowercase
alphabetic character, at least one uppercase alphabetic character,
at least one numeric character, at least one special character. The
following special characters shall be valid: % (percent sign), +
(plus sign), # (pound sign), _ (under score), ! (exclamation mark),
@ (at sign), $ (dollar sign), “ (double quotation mark), &
(ampersand), ' (apostrophe), ( (left parenthesis), ) (right
parenthesis), * (asterisk), and . (period). The first character of the
NEWPID can be an alphabetic, numeric, or a valid special
character.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"UID:<LASTLOGIN>,<UNSUCCESSATTEMPTS>" cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

28 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ACT-USER Issue 1, December 2011

UID Value Description


<5-12 VALID UID CHARACTERS>

Description: User Identifier, specifies a unique user ID.


Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

LASTLOGIN Value Description


{YY-MM-DD HH:MM:SS}
blank (for the first time a user logs in)

Description: LastLoginTimeStamp. This is the last recorded Login time of a


user. This time will be displayed every time a user logs in. The
format is a quoted string representing <Year>-<Month>-<Day>
<Hour>:<Minute>: <Second>
The LastLoginTimeStamp value used in the response to the
first-ever successful login of a user is blank.

UNSUCCESSATTE Value Description


MPTS
Integer

Description: Unsuccessful Login Attempt Number, identifies the number of


unsuccessful authentication (login) attempts since the last
authenticated session.
Because a user could be inhibited and still attempt to login, no limit
is defined for this parameter.
Upon successful login, the parameter value is reset to zero (0).

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 29


8DG61100 EAAAQZZA
Issue 1, December 2011 ACT-USER
EXAMPLES
The following example illustrates the command and associated output for logging in a user with a UID
of userX.

ACT-USER::user9:::******;

AM1830 08-09-22 15:18:07


M 001 COMPLD
"user9:08-09-22 15-18-07,0";

RELATED COMMANDS
CANC-USER
ENT-USER-SECU

RELATED AUTONOMOUS RESPONSES


REPT^EVT^SESSION
REPT^INFORMATION

30 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ALW-MSG-ALL


Command Name: ALLOW MESSGE ALL

PURPOSE
The ALW-MSG-ALL Command permits or allows an NE to resume transmission of automatic
messages after having been in the INHIBIT-MESSAGE mode. Parameters are provided to selectively
enable messaging. Automatic messages will resume toward any OS designated to receive these
messages. Unreported alarms in existence at the time of restoration should be transmitted to the OS
with the REPORT ALARM message.

INPUT FORMAT

ALW-MSG-ALL:[TID]:[AID]:[CTAG]::[NTFCNCDE];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 31


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-MSG-ALL

NTFCNCDE Value Description


CR
MJ
MN
WR
NA

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

32 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ALW-MSG-ALL Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, the autonomous messages for the entered notification code are allowed:

ALW-MSG-ALL::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 ALLPLD
/* ALW-MSG-ALL::ALL:::MJ [P15119] (1) */
;

RELATED COMMANDS
INH-MSG-ALL

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 33


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-MSG-ALL

34 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ALW-MSG-RR


Command Name: ALLOW MESSAGE

PURPOSE
The ALW-MSG-<rr> command permits or allows an NE to resume transmission of automatic
messages after having been in the INHIBIT-MESSAGE mode. Parameters are provided to selectively
enable messaging. Automatic messages will resume toward any OS designated to receive these
messages. Unreported alarms in existence at the time of restoration should be transmitted to the OS
with the REPORT ALARM message.
1GBE
FE
10GBE
100GBE
CBR2G5
CBRAR
COM
EQPT
FC100
FC200
FC400
FC800
FC1200
OC3
OC12
OC48
OC768
OCH
OTS
OPTSG
ODU0
ODUF
VTS
ODU1
ODU2
OTU1
OTU2
OTU3
OTU4
PLK
STM1
STM4

1830PSS R3.6.50 - TL1 Commands and Messages 35


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-MSG-RR
STM16
STM64
STM256

INPUT FORMAT

ALW-MSG-rr:[TID]:[AID]:[CTAG]::[NTFCNCDE];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA

Default: <All Values>

36 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ALW-MSG-RR Issue 1, December 2011

Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, the autonomous messages for the entered notification code are allowed:

ALW-MSG-CBR2G5::ALL:::MJ;

The output response is shown below.

1830PSS R3.6.50 - TL1 Commands and Messages 37


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-MSG-RR

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* ALW-MSG-CBR2G5::ALL:::MJ [P15119] (1) */
;

In the following example, the autonomous messages for the entered notification code are allowed:

ALW-MSG-COM::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* ALW-MSG-COM::ALL:::MJ [P15119] (1) */
;

In the following example, the autonomous messages for the entered notification code are allowed:

ALW-MSG-1GBE::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* ALW-MSG-1GBE::ALL:::MJ [P15119] (1) */
;

In the following example, the autonomous messages for the entered notification code are allowed:

ALW-MSG-OC3::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* ALW-MSG-OC3::ALL:::MJ [P15119] (1) */
;

In the following example, the autonomous messages for the entered notification code are allowed:

38 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ALW-MSG-RR Issue 1, December 2011

ALW-MSG-OTS::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* ALW-MSG-OTS::ALL:::MJ [P15119] (1) */
;

In the following example, the autonomous messages for the entered notification code are allowed:

ALW-MSG-OTU2::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* ALW-MSG-OTU2::ALL:::MJ [P15119] (1) */
;

RELATED COMMANDS
INH-MSG-rr
INH-MSG-ALL

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 39


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-MSG-RR

40 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ALW-SWTOPROTN-EQPT


Command Name: ALLOW SWITCH TO PROTECTION
(CLEAR SWITCH)

PURPOSE
The ALW-SWTOPROTN-EQPT command clears any existing switch to working (lockout, forced, or
manual), and allows all automatic and user-initiated switching to the protection side.
If there is no existing switch, the command will succeed anyway.
The command will be denied if operation on the relevant circuit pack is not possible, whether due to
pack removed, communication failure, or any other reason.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ALW-SWTOPROTN-EQPT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 41


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-SWTOPROTN-EQPT

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: For Y-cable and OPS: the protection port AID. For E-SNCP: the
client port AID.
Restriction: 4DPA4 OT supports protection only in
FlexMux mode.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

42 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ALW-SWTOPROTN-EQPT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the specified protection group does not exist

IPNV Input, Parameter Not Valid


• for a Y-cable or OPS protection group the input AID does not refer to the protection port

SSRD Status, Switch Request Denied


• operation on the relevant circuit pack is not possible, whether due to pack removed,
communication failure, or any other reason

EXAMPLES
The following command allows switching to the protection side of a Y-cable protection group.

ALW-SWTOPROTN-EQPT:ALU-1830PSS:11STAR1-5-3-C1;

1830PSS R3.6.50 - TL1 Commands and Messages 43


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-SWTOPROTN-EQPT
RELATED COMMANDS
ALW-SWTOWKG-EQPT
INH-SWTOPROTN-EQPT
RTRV-PROTNSW-EQPT
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

44 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ALW-SWTOWKG-EQPT


Command Name: ALLOW SWITCH TO WORKING (CLEAR
SWITCH)

PURPOSE
The ALW-SWTOWKG-EQPT command clears any existing switch to protection (forced or manual),
and allows all automatic and user-initiated switching to the working side.
If there is no existing switch, the command will succeed anyway.
The command will be denied if operation on the relevant circuit pack is not possible, whether due to
pack removed, communication failure, or any other reason.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ALW-SWTOWKG-EQPT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 45


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-SWTOWKG-EQPT

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: For Y-cable and OPS: the working port AID. For E-SNCP: the
client port AID.
Restriction: 4DPA4 OT supports protection only in
FlexMux mode.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

46 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ALW-SWTOWKG-EQPT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the specified protection group does not exist

IPNV Input, Parameter Not Valid


• for a Y-cable or OPS protection group the input AID does not refer to the working port

SSRD Status, Switch Request Denied


• operation on the relevant circuit pack is not possible, whether due to pack removed,
communication failure, or any other reason

EXAMPLES
The following command allows switching to the working side of a Y-cable protection group.

ALW-SWTOWKG-EQPT:ALU-1830PSS:11STAR1-5-2-C1;

1830PSS R3.6.50 - TL1 Commands and Messages 47


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-SWTOWKG-EQPT
RELATED COMMANDS
ALW-SWTOPROTN-EQPT
INH-SWTOPROTN-EQPT
RTRV-PROTNSW-EQPT
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

48 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ALW-USER-SECU


Command Name: ALLOW USER SECURITY

PURPOSE
The ALW-USER-SECU command, supported only by an ADMINISTRATOR user, can be used to
reinstate a User ID that has been temporarily disabled so the user can again establish a session with
the system.

The ALW-USER-SECU command allows reinstatement of users that have been disabled by the
following reasons:

• via a previous INH-USER-SECU command

INPUT FORMAT

ALW-USER-SECU:[TID]::[CTAG]::UID;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: <Entry Required>

1830PSS R3.6.50 - TL1 Commands and Messages 49


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-USER-SECU
Addressing: &-grouping
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• the command is issued by a non-privilege user

PIUI Privilege, Illegal User Identity, invalid UID


• the UID is invalid (ie., illegal UID, UID does not exist)

50 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ALW-USER-SECU Issue 1, December 2011

EXAMPLES
The following example illustrates the reactivation of the user "userX".

ALW-USER-SECU:::::userX;

AM1520 03-07-08 12:32:47


M P2e319 COMPLD
;

RELATED COMMANDS
INH-USER-SECU

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 51


8DG61100 EAAAQZZA
Issue 1, December 2011 ALW-USER-SECU

52 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: CANC-COPY-RFILE


Command Name: CANCEL COPY REMOTE FILE

PURPOSE
Only a software download file transfer with the addressed NE as the source or destination will be
affected by this command; file transfers through this NE will not be canceled. Note that only one
COPY-RFILE command with this NE as the source or destination can be in progress at one time, so no
additional addressing, other than TID, is needed in this command.
When the CANC-COPY-RFILE command completes successfully, the REPT^COPY^RFILE
autonomous message indicates that the file transfer initiated by the COPY-RFILE command was not
completed successfully.

INPUT FORMAT

CANC-COPY-RFILE:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 53


8DG61100 EAAAQZZA
Issue 1, December 2011 CANC-COPY-RFILE
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:

SCSN
/* SWDL is not in-progress. */

• a software download file transfer initiated by a COPY-RFILE command is not currently in


progress

EXAMPLES
In the following example, the CANC-COPY-RFILE is used to cancel a previous COPY-RFILE for
software download:

54 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
CANC-COPY-RFILE Issue 1, December 2011

LASVEGAS 05-07-09 09:08:33


M 2034 COMPLD
;

RELATED COMMANDS
COPY-RFILE

RELATED AUTONOMOUS RESPONSES


REPT^COPY^RFILE

1830PSS R3.6.50 - TL1 Commands and Messages 55


8DG61100 EAAAQZZA
Issue 1, December 2011 CANC-COPY-RFILE

56 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: CANC-USER-SECU


Command Name: CANCEL USER SESSION SECURITY
PRIVILEGE

PURPOSE
The CANC-USER-SECU command is used by a security administrator to log off a user's session,
specified by the UID on the target NE (identified by optional TID parameter).

Only the security administrator can log-off any other user. Other
users, besides the security administrator, cannot log-off another
user. The security administrator cannot log-off himself or herself.
However, the security administrator can log-off other security
administrator. If there are more than 1 sessions with the same UID,
then all sessions will be terminated upon execution of this command.
Access Levels: Admin

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

CANC-USER-SECU:[TID]:UID:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: <Entry Required>


Addressing: None
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as

1830PSS R3.6.50 - TL1 Commands and Messages 57


8DG61100 EAAAQZZA
Issue 1, December 2011 CANC-USER-SECU
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example illustrates the command and associated output for terminating the session
(logging off) of a user with a UID of userX.

58 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
CANC-USER-SECU Issue 1, December 2011

CANC-USER-SECU::userX;

AM1520 03-07-08 12:32:47M P2e319 COMPLD;

RELATED COMMANDS
ACT-USER
CANC-USER

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 59


8DG61100 EAAAQZZA
Issue 1, December 2011 CANC-USER-SECU

60 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: CANC-USER


Command Name: CANCEL USER SESSION

PURPOSE
The CANC-USER command logs off the user's session with the specified NE (identified by optional
TID parameter).
This command is allowed to log-off only the user that issues the command itself, and cannot log-off
any other user. The log-off of another user is reserved for users with security administration privileges,
and it is realized by means of the CANC-USER-SECU command, described later in this document.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

CANC-USER:[TID]:[UID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: The <UID> of the user executing the command


Addressing: None
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 61


8DG61100 EAAAQZZA
Issue 1, December 2011 CANC-USER
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• the user attempts to log off another user session

EXAMPLES
The following example illustrates the command and associated output for terminating the user session
(logging off).

CANC-USER::userX;

62 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
CANC-USER Issue 1, December 2011

AM1520 03-07-08 12:32:47


M P2e319 COMPLD ;

RELATED COMMANDS
ACT-USER

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 63


8DG61100 EAAAQZZA
Issue 1, December 2011 CANC-USER

64 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: CNVT-CCTPR-<ODUK>


Command Name: CONVERT CROSS CONNECT TYPE
PROTECT

PURPOSE
The CNVT-CCTPR-<ODUk> command adds a protection leg to a cross connection.
The command does not support the exchange of the FROMPED / FROMPING role of an existing path
protection cross connection.
The cross connection to be modified will be addressed by the TO parameter. (called original cross
connection)
The CKTID will be taken over from the already existing cross connection if not provided.
When adding a protection leg (FROMPING), the existing source (FROM of the original unprotected
cross connection) shall be required to be the new FROMPED (NEWFROMPED).
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

CNVT-CCTPR-<ODUk>:[TID]:TO:[CTAG]:::NEWFROMPED=,NEWFROMPING=[,RVRTV=
][,RVRTTIM=];

INPUT PARAMETERS

ODUk Value Description


{ODU0, ODU1,ODUF}

Default: Entry Required


Addressing: None
Description:The ODUk indicates the rate on which the command
acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description:Target IDentifier, identifies the network node TID for
the command.

1830PSS R3.6.50 - TL1 Commands and Messages 65


8DG61100 EAAAQZZA
Issue 1, December 2011 CNVT-CCTPR-ODUK

TO Value Description
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the TO (transmit
side to the network, sink of cross-connection) facility of the
cross-connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description:Correlation TAG, associates the input command with
its output responses.

NEWFROMPED= Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None

66 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
CNVT-CCTPR-ODUK Issue 1, December 2011

Description:AID of connection point; Indicates the new


FROMPED (protected receive side from the network, protected
source of cross-connection) facility of the cross-connection.
If the AID is the same as from the FROM facility of the original
cross connection, then this facility gets the role of the new
FROMPED.

NEWFROMPING= Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the new
FROMPING (protecting receive side from the network, protected
source of cross-connection) facility of the cross-connection.

RVRTV= Value Description


{Y,N}

Default: N
Addressing: None
Description:Revertive Mode: Indicates whether or not to make
revert to protected once the protected comes into service and the
traffic is on protecting.
N Do not revert to protected / FROMPED
Y Yes revert to protected / FROMPED

RVRTTIM= Value Description


0-15

Default: 5
Addressing: None
Description:Revert Delay Time (wait to restore time) if RVRTV=Y
in minutes. If RTRTV=N it does not have any effect at the NE
behaviour.

1830PSS R3.6.50 - TL1 Commands and Messages 67


8DG61100 EAAAQZZA
Issue 1, December 2011 CNVT-CCTPR-ODUK
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the original connection is 2WAY and NEWFROMPED is not the FROM or the TO facility of the
original connection

• the converted connection is a 2WAYSNCP and the facility specified by NEWFROMPING has
been a sink of another cross-connection

• the specified AID in TO does not match for the rate

• the specified AID in NEWFROMPED does not match for the rate

• the specified AID in NEWFROMPING does not match for the rate

• the facility specified by NEWFROMPED is not provisioned, i.e. in a UAS secondary state

68 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
CNVT-CCTPR-ODUK Issue 1, December 2011

• the facility specified by NEWFROMPING is not provisioned

• the requested protection connection specifies a NEWFROMPED and/or NEWFROMPING that


already have "FROMPED/FROMPING" roles in other protection connections

• the ODUk of NEWFROMPED, NEWFROMPING and the TO are not located in the same
shelf/slot

• the ODUk of NEWFROMPED, NEWFROMPING are located in the same shelf/slot/line port

EXAMPLES
The following example illustrates the command when following ODU1 cross-connections is converted
to a SNCP cross-connection:
2WAY FROM= 11DPM12-1-2-L1-ODU2ODU0#1 and TO=11DPM12-1-2-C2-ODU0

CNVT-CCTPR-ODU0::11DPM12-1-2-C2-ODU0:Pab124:::NEWFROMPED=11DPM12-1-2
-L1-ODU2ODU0#1,NEWFROMPING=11DPM12 -1-2-L2-ODU2ODU0#1;

RELATED COMMANDS
CNVT-CCTU-<ODUk>
ENT-CRSPROT-<ODUk>
RTRV-CRSPROT-<ODUk>

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 69


8DG61100 EAAAQZZA
Issue 1, December 2011 CNVT-CCTPR-ODUK

70 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: CNVT-CCTU-<ODUK>


Command Name: CONVERT CROSS CONNECT TYPE
UNPROTECT

PURPOSE
The CNVT-CCTU-<ODUk> command removes a protection leg from a cross connection.
It will be supported for unidirectional and bidirectional cross connections as well.
The NEWFROM parameter of the command must be the FROMPED of the original path protection
cross connection.
The cross connection to be modified will be addressed by the TO parameter. (called original cross
connection)
The CKTID will be taken over from the already existing cross connection if not provided.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

CNVT-CCTU-<ODUk>:[TID]:TO:[CTAG]:::NEWFROM=;

INPUT PARAMETERS

ODUk Value Description


{ODU0, ODU1,ODUF}

Default: Entry Required


Addressing: None
Description:The ODUk indicates the rate on which the command
acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description:Target IDentifier, identifies the network node TID for
the command.

1830PSS R3.6.50 - TL1 Commands and Messages 71


8DG61100 EAAAQZZA
Issue 1, December 2011 CNVT-CCTU-ODUK

TO Value Description
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the TO (transmit
side to the network, sink of cross-connection) facility of the
cross-connection.It addresses the cross connection to be
converted.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description:Correlation TAG, associates the input command with
its output responses.

NEWFROM= Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None

72 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
CNVT-CCTU-ODUK Issue 1, December 2011

Description:AID of connection point; Indicates the new FROM


(protected receive side from the network, protected source of
cross-connection) facility of the cross-connection.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the NEWFROM does not address the facility of the FROMPED of the cross connection
addressed by TO

• the used AID in NEWFROM does not match for the rate

• the used AID in TO does not match for the rate

• the NEWFROM is the FROMPING of the original protected connection

1830PSS R3.6.50 - TL1 Commands and Messages 73


8DG61100 EAAAQZZA
Issue 1, December 2011 CNVT-CCTU-ODUK
EXAMPLES
The following example illustrates the command when following ODU1 cross-connections is converted
and the new FROM is the FROMPED of original cross connection:
2WAYSNCP FROMPED= 11DPM12-1-1-L1- ODU2ODU1#1 FROMPING= 11DPM12-1-1-L2-
ODU2ODU1#3 TO= 11DPM12-1-1-C1-OTUODU1

CNVT-CCTU-ODU1:: 11DPM12-1-1-C1-OTUODU1:Pab124:::NEWFROM=11DPM12
-1-1-L1-ODU2ODU1#1;

RELATED COMMANDS
CNVT-CCTPR-<ODUk>
ENT-CRSPROT-<ODUk>
RTRV-CRSPROT-<ODUk>

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

74 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: COMMIT-ISU


Command Name: COMMIT (ACTIVE RELEASE) IN SERVICE
UPGRADE

PURPOSE
The COMMIT-ISU command commits the current active software release to be the
permanent(committed) active software. It effectively prevents simple reversion to a previous release
(via the INIT-SYS-OLD command) once it is determined by the operator that the capability is no longer
required.

After successful completion of the COMMIT-ISU command, all software/database indicators are set to
indicate that the current active software release is now the committed release. The system remains in
service on the currently active release and all system functionality remains operational.

After successful completion of the commit process, the system can no longer be reverted to the old
release software via the INIT-SYS-OLD TL1 command. It is always possible to perform a software
release "upgrade" to an older release, with the forced option in STA-ISU and using a saved database
from that older release.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

COMMIT-ISU:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 75


8DG61100 EAAAQZZA
Issue 1, December 2011 COMMIT-ISU
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SROF Status, Requested Operation Failed
• the currently active software release fails to be committed successfully or if the NE is not able to
remove all the files not associated with the current committed software release in non-volatile
memory

EXAMPLES
The following example illustrates the command.

COMMIT-ISU;
NODE-1 03-07-08 09:04:33
M ctag12345 COMPLD
;

76 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
COMMIT-ISU Issue 1, December 2011

RELATED COMMANDS
INIT-SYS-NEW
INIT-SYS-OLD
RTRV-ISU-STATUS
STA-ISU

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 77


8DG61100 EAAAQZZA
Issue 1, December 2011 COMMIT-ISU

78 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: COPY-RFILE


Command Name: COPY REMOTE FILE

PURPOSE
The COPY-RFILE command copies files or data from a local file system (NE) to a remote file server or
vice versa. Which exact file transfer is requested will be specified by the FROM and TO AIDs provided
with the command. For example: NEDB for FROM and RFSDB for TO would provide a file transfer
request of the NE’s data base to the Remote File Server.

Valid FROM and TO AIDs in the context of this command are:


• NEDB: The Network Element's database. For a COPY-RFILE command which copies from the
NE to a remote file server, first the NE creates a temporary copy of the active database, then
transfers this copy. For a COPY-RFILE command which copies to the NE from a remote file
server, the copy is placed in a temporary location until the transfer is complete, then the NE is
automatically restarted to make this the active database.

• RFSDB: represents a database on a Remote File Server. Multiple instances of "RFSDB" can
exist in different locations on an RFS. A specific instance is always indicated with this AID, and
with the addition of information in the optional LOCATION parameter in the command or set up
beforehand (in a previous COPY-RFILE command that operated on the RFSDB, or with the
ED-TRANSFER-INFO TL1 command). Note that the system will retain RFS location information
for the database backup and restore independently from RFS location information for the software
download.

• STBYSW: represents a software generic that has been downloaded but not yet made active. The
STBYSW becomes the system software after it gets activated.There is a maximum of one
instance of STBYSW in the system.

• RFSSW: represents a software release (which includes application, boot, and upgradeable FPGA
firmware) on a Remote File Server. Multiple instances of RFSSW can exist in different locations
on an RFS. A specific instance is always indicated with this AID, with the addition of information in
the optional LOCATION parameter in the command or set up beforehand (in a previous
COPY-RFILE command that operated on the RFSSW). Note that the system will retain RFS
location information for the database backup and restore independently from RFS location
information for the software download.

Only one COPY-RFILE command can be active on an NE at any given time.


The COPY-RFILE command initiates the file upload/download operation and returns a complete
response once the operation has been verified as possible and initiated. During the subsequent file
transfer, REPT^COPY^RFILE are generated every 30 seconds (+/- 15 seconds) to indicate the
percentage of completion of the file transfer and the final completion status. During the transfer period,
a CANC-COPY-RFILE command can be used to abort the operation.
The command is used for data base transfer operations to and from remote devices (RFS) located in
an IP-based DCN (Data Communication Network) via the ftp File Transfer Protocol.
The COPY-RFILE command can be used to accomplish a remote database backup. After the
COPY-RFILE command automatically creates a local temporary copy of the NE's active database, the
copy is transferred to the RFS.
Remote database restoration:

1830PSS R3.6.50 - TL1 Commands and Messages 79


8DG61100 EAAAQZZA
Issue 1, December 2011 COPY-RFILE
The COPY-RFILE command can be used to transfer a database that was previously saved (backed
up) on a RFS to the Network Element. After transferring the RFS DB to a temporary location on the
NE, the NE automatically restarts to activate the database.
When an RFS DB is copied to the STBYDB, the system makes sure that the directory path indicated in
the LOCATION parameter exists on the RFS. If it doesn’t, the operation fails.
When an RFS DB is copied to the NEDB, the system makes sure that the directory path indicated in
the LOCATION parameter exists on the RFS. If it doesn’t, the operation fails.
A database restore operation with a "nativity check" identifier mismatch (i.e. the database on the RFS
does not appear to be for this Network Element) cannot be performed unless the CMDMDE parameter
is set to FRCD. The "nativity check" uses the serial number of the User Panel.

During the database download operation, CRC checks are performed. If one check fails, the operation
fails.
Software release download:
When a software release is downloaded, the command makes sure that the directory path indicated in
the LOCATION parameter exists on the RFS. If it doesn’t, the command fails.
Before the actual file transfer operation, the system type of the active software is compared to the one
one the RFS. If the compared values do not match, the command is denied.
During the software generic download operation, CRC checks are performed. If one check fails, the
download operation fails as reported by the REPT-COPY-RFILE message.

INPUT FORMAT

COPY-RFILE:[TID]:FROM,TO:[CTAG]:::[LOCATION=][,CMDMDE=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

80 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
COPY-RFILE Issue 1, December 2011

FROM Value Description


NEDB (The active database on the Network
Element)
RFSDB (A database backup on a Remote File
Server)
RFSSW (A software generic on a remote file
server)
NESSLCSR (Unsigned Certificate
by SSL provisioning NE)
RFSSSLCSR (SSL signed (by NMS)
certificate)
NEALMLOG (Alarm Log File)
NESECULOG (Security Log File)

NEOTHLOG (Other Log File)


NEUSERLOG (USER Log File)

NESNMPLOG (SNMP Log)


NEUALLOG (UAL log)

Default: Entry required


Addressing: None
Description: Specifies the entity to be transferred.

TO Value Description
RFSDB (A database backup on a Remote File
Server)
NEDB (The active database on the Network
Element)
STBYSW (The standby software generic on the
NE)
NESSLCSR (SSL signed
Certificate for installation)
RFSSSLCSR (SSL signed (by NMS)
certificate)
RFSALMLOG (Alarm Log File)
RFSSECULOG (Security Log File)
RFSOTHLOG (Other Log File)
RFSUSERLOG (USER Log File)
RFSSNMPLOG (SNMP Log)
RFSUALLOG (UAL Log)

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 81


8DG61100 EAAAQZZA
Issue 1, December 2011 COPY-RFILE
Description: Specifies the entity that gets created as the result of the command
completion:
The following table shows the allowed combinations for the
parameters FROM and TO

Table COPYRFILE-2: Valid AID combinations


FROM TO
NEDB RFSDB
RFSDB NEDB
RFSSW STDBYSW
NESSLCSR RFSSSLCSR
RFSSSLCSR NESSLCSR
NEALMLOG RFSALMLOG
NESECULOG RFSSECULOG
NEOTHLOG RFSOTHLOG
NEUSERLOG RFSUSERLOG
NESNMPLOG RFSSNMPLOG
NEUALLOG RFSUALLOG

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

LOCATION= Value Description


<1-256 VALID INPUT CHARACTERS>

Default: The previous value entered with another software or database file
transfer command to this NE will be used for this software or
database file transfer.
Addressing: None
Description: Location indicates the source/destination of the files on an RFS to
be transferred. The syntax of the url is as follows:

82 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
COPY-RFILE Issue 1, December 2011

"[[protocol]
://[<userid>[:<password>]@][<serverhost>][/<url-path>]
]"
where:

• protocol - The file transfer protocol to use, currently the valid


options are tftp, ftp, or sftp For database operations, ftp, tftp and
sftp are valid, and for software download operations only ftp and
sftp are allowed.

• userid - The user identifier used for the file transfer connection on
the RFS

• password - The user password used for the file transfer


connection on the RFS.

• serverhost - The IP address of the host (the Remote File Server).

• url-path - supplies the details of how the


specified resource (i.e. the directory where the
file(s) reside) can be accessed. It has the following
syntax: [/]<cwd1>/<cwd2>/.../<cwdN>/[filename]
where <cwd1> through <cwdN> are strings that identify
directories and filename is optional and is only valid
for database operations.

If the specified path is a directory (meaning that the


path ends with a slash, such as /backups/), then when
a backup is performed the system creates a backup file
with a filename in the form of
NEname_SWgeneric_yyyy-mm-dd_hh-mm-ss.bak. and writes
it to the specified directory.

If the specified path is a file name (such as


/backups/backupfile.bak) then when a backup is
performed the system writes the backup to the
specified file. This action overwrites the previous
backup file. The path should NOT include a filename if
this is a file transfer of the software release files
from the RFS ot the NE.
For file transfers of software release files from an RFS to the NE,
the url-path is allowed to be relative. In other words, it is allowed
that the preceding / is missing; in this case the absolute path will
be constructed from the SWDLRELEASEROOT value (provisioned
with the ED-TRANSFER-INFO TL1 command) and this url-path
value. For example if
SWDLRELEASEROOT=/networks/1830files/releases and the
url-path = release1-0-0, then the absolute path used for the
software release file transfer from RFS to NE would be
/networks/1830files/releases/release1-0-0

1830PSS R3.6.50 - TL1 Commands and Messages 83


8DG61100 EAAAQZZA
Issue 1, December 2011 COPY-RFILE
SSL Certificate and Log File Transfer:
The following syntax is used for url-path:

[/]<cwd1>/<cwd2>/.../<cwdN>/[filename] where <cwd1>


through <cwdN> are strings that identify directories
and filename.

CMDMDE= Value Description


FRCD
NORM

Default: NORM
Addressing: None
Description: Command Execution Mode. For copying an
RFS DB to the STBYDB on the system. This parameter is
not applicable for SSL certificate transfer between NE
and OMS. Also, it is not applicable for Log File
transfer from NE to RFS.

SUCCESSFUL RESPONSE FORMAT


The format of a successful response is

cr lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT


Unless otherwise specified, the format of an unsuccessful response to the command is

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

84 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
COPY-RFILE Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• a remote database restore or a database backup

• the AIDs entered are invalid with respect to AID combination (Valid Combinations are shown in
Table COPYRFILE-2)

IDNV Input, Data Not Valid


• a remote database backup, if the path provided in the LOCATION parameter, stripped from the
last directory, does not exist

• a SSL Certificate or Log file transfer, if the path provided in the LOCATION parameter, does not
exist

• a Log file transfer, if the FROM AID and TO AID provided in the parameter, does not match
according to COPYRFILE-2

• a remote database backup, if the last directory provided in the LOCATION parameter, does not
exist and cannot be created on the RFS

• a remote database restore, if the path provided in the LOCATION parameter does not exist

SARB Status, All Resources Busy


• another COPY-RFILE command is in progress or if the file transfer initiated by a COPY-RFILE
command is in progress

• an INIT-SYS-NEW is currently in progress on this NE

• an INIT-SYS-OLD is currently in progress on this NE

SCSN Status, invalid command SequeNce


• this COPY-RFILE command is received to copy the software release from a RFS to the NE,
before the STA-ISU command has started the software release upgrade

• the NE receives this command for a database backup or restore, or a software download, or SSL
certificate transfer or log file transfer, and the file transfer protocol requested is set to sftp (secure
file transfer), if the SSHv2 key used in the secure transfer algorithm has never been initialized on
this NE or has since been deleted

SROF Status, Requested Operation Failed


• the request is for a remote database backup and the Network Element's DB is not valid (i.e.,
CRC error)

1830PSS R3.6.50 - TL1 Commands and Messages 85


8DG61100 EAAAQZZA
Issue 1, December 2011 COPY-RFILE
• a remote database restore, if the descriptor file at the LOCATION on RFS is not valid or contains
invalid information (e.g., failed CRC/file size check for the descriptor file, is not readable,does not
exist)

SRQN Status, iNvalid ReQuest


• a remote database restore: if a database restoration is requested and the SID of the instance
specified in the FROM parameter does not match the active one on the NE

• a software download, if the ACTIVE Main Shelf Equipment Controller is not in an IS state

EXAMPLES

In the following example, COPY-RFILE is used to download a database


backup from a Remote File
Server whose IP address is 131.209.34.29; the tftp protocol is used,
and the tftp account used is tftpuser with password tftppwd. The
files on the RFS are located at the path /backup/1830/1_0_0/.

COPY-RFILE::RFSDB,STBYDB::::LOCATION="tftp://tftpuser:tftppwd@131.20
9.34.29//backup/B1830/1_0_0/";

REPT^COPY^RFILE messages are sent every 30 seconds (+/- 15 seconds) to indicate the file transfer
status - see the REPT^COPY^RFILE for further information.
A COMPLD output response would look like this:

DALLAS001 05-05-01 21:05:35


M C0001 COMPLD
;

RELATED COMMANDS
CANC-COPY-RFILE

RELATED AUTONOMOUS RESPONSES


REPT^COPY^RFILE

86 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-100GBE


Command Name: DLT-100GBE

PURPOSE
The DLT-100GBE command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-100GBE command
Executing a DLT-100GBE command causes a state transition for the specified OT client facility from:
• OOS–AUMA to OOS–MA,UAS

• OOS–MA to OOS–MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-100GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 87


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-100GBE
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

88 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-100GBE Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-100GBE


command.
DLT-100GBE:NODE-1:112SCA1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-100GBE
RST-100GBE
ED-100GBE
ENT-100GBE
RMV-100GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 89


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-100GBE

90 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-10GBE


Command Name: DLT-10GBE

PURPOSE
The DLT-10GBE command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-10GBE command
Executing a DLT-10GBE command causes a state transition for the specified OT client facility from:
• OOS–AUMA to OOS–MA,UAS

• OOS–MA to OOS–MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-10GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 91


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-10GBE

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

92 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-10GBE Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a 11DPE12 pack not working under qinq mode

SNVS Status, Not in Valid State


• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-10GBE


command.
DLT-10GBE:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-10GBE
RST-10GBE
ED-10GBE
ENT-10GBE
RMV-10GBE

1830PSS R3.6.50 - TL1 Commands and Messages 93


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-10GBE
RELATED AUTONOMOUS RESPONSES
REPT DBCHG

94 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-1GBE


Command Name: DLT-1GBE

PURPOSE
The DLT-1GBE command deletes (unassigns and deprovisions) a specified client facility. Facility must
have been provisioned with ENT-1GBE command
Executing a DLT-1GBE command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-1GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 95


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-1GBE

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

96 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-1GBE Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-1GBE


command.
DLT-1GBE:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-1GBE
RST-1GBE
ED-1GBE
ENT-1GBE
RMV-1GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 97


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-1GBE

98 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-CBR2G5


Command Name: DLT-CBR2G5

PURPOSE
The DLT-CBR2G5 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-CBR2G5 command
Executing a DLT-CBR2G5 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-CBR2G5:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

1830PSS R3.6.50 - TL1 Commands and Messages 99


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CBR2G5

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

100 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CBR2G5 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-CBR2G5


command.
DLT-CBR2G5:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBR2G5
RST-CBR2G5
ED-CBR2G5
ENT-CBR2G5
RMV-CBR2G5

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 101


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CBR2G5

102 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-CBRAR


Command Name: DLT-CBRAR

PURPOSE
The DLT-CBRAR command deletes (unassigns and deprovisions) a specified CBRAR client facility.
Facility must have been provisioned with ENT-CBRAR command
Executing a DLT-CBRAR command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-CBRAR:[TID]:AID:[CTAG]:::DATATYPE=;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 103


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CBRAR
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DATATYPE= Value Description


{HDSDI, FE,SDSDI,3GSDI}

Default: Entry required


Addressing: None
Description: Specifies the client signal type. Must equal the value previously
assigned by ENT-CBRAR.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

104 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CBRAR Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a DATATYPE value that does not match the provisioned signal type

SNVS Status, Not in Valid State


• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-CBRAR


command.
DLT-CBRAR:NODE-1:4DPA4-1-2-C1:xyz123:::DATATYPE=FE;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBRAR
RST-CBRAR
ED-CBRAR
ENT-CBRAR
RMV-CBRAR

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 105


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CBRAR

106 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-CRS-OCH


Command Name: DELETE EQUIPMENT OPTICAL
CONNECTIONPHOTONIC CROSS
CONNECT (OCH)

PURPOSE
The DLT-CRS-OCH command disconnects (deletes) the specified optical service connection between
two external optical ports. Those ports will be free for new photonic cross connects. If the connection
is bi-directional (BI) both fibers directions can shall be deleted with a single command.
Executing a DLT-CRS-OCH command causes the value of the ConnTo and ConnFr (if bi-directional)
port attributes to be replaced with NotConnected.
It is illegal to delete PXCs that are supporting provisioned PXCs, protection groups or other higher level
structures.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-CRS-OCH:[TID]:<FROM>,<TO>:[CTAG]::[FORCE];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 107


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-OCH

FROM Value Description


AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

108 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRS-OCH Issue 1, December 2011

FROM Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEIN-{9605, (AM2125A LINEIN Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,

1830PSS R3.6.50 - TL1 Commands and Messages 109


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-OCH

FROM Value Description


9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
RA2P-<shelf>-<slot>-LINEIN-{9605, (RA2P Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)

110 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRS-OCH Issue 1, December 2011

FROM Value Description


SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: Entry required


Addressing: None.
Description: Wavelength AID. Identifies the head (receive side from the
network or OT) of a connection.

1830PSS R3.6.50 - TL1 Commands and Messages 111


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-OCH

TO Value Description
AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

112 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRS-OCH Issue 1, December 2011

TO Value Description
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEOUT-{96 (AM2125A LINEOUT Channels)
05, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,

1830PSS R3.6.50 - TL1 Commands and Messages 113


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-OCH

TO Value Description
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}

114 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRS-OCH Issue 1, December 2011

TO Value Description
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: Entry required


Addressing: None
Description: OCH AID. Identifies the tail (transmit side to the network or OT) of
a connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: Entry required.


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

FORCE Value Description


FORCE
FORCE

Default: Not Forced


Addressing: None
Description: Command mode parameter force the deletion even though it
should be denied.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None.

1830PSS R3.6.50 - TL1 Commands and Messages 115


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-OCH
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the DLT-CRS-OCH command is input for an OCH that is not provisioned

SNVS Status, Not in Valid State


• this command is issued while either the FROM or TO port is part of a optical service (PST=IS)

EXAMPLES
In the following example, a two-way optical connection is deleted between ports
ALPHG-3-6-LINE-9550 and 11STAR1-2-4-L1.

DLT-CRS-OCH:LASCALA:ALPHG-3-6-LINE-9550,11STAR1-2-4-L1:12345;

• LASCALA 01-11-07 09:45:23


M 12345 COMPLD
;

RELATED COMMANDS
ED-CRS-OCH
ENT-CRS-OCH
RTRV-CRS-OCH

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

116 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-CRS-<ODUK>


Command Name: DELETE CROSS_CONNECTION

PURPOSE
The DLT-CRS-<ODUk> command deletes one-way or two-way cross connections proviously set up
between the specified facilities.
The DLT-CRS-<ODUk> command deletes one-way or two-way cross connections previously set up
between the specified facilities.

INPUT FORMAT

DLT-CRS-<ODUk>:[TID]:FROM,TO:[CTAG]::[CCT];

INPUT PARAMETERS

ODUk Value Description


{ODU0,ODU1,OPTSG,ODUFFC400,O
DUF3GSDI}

Default: Entity Required


Addressing: None
Description: The ODUk indicates the rate on which the command acts.

TID Value Description


<VALID TID VALUE>

Default:<SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID
for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 117


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-ODUK

FROM Value Description


Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None

Description: AID of connection point; Indicates the FROM (receive side from
the network, source of cross-connection) facility of the
cross-connection.

118 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRS-ODUK Issue 1, December 2011

TO Value Description
Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None

Description: AID of connection point; Indicates the TO (receive side from the
network, source of cross-connection) facility of the
cross-connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CCT Value Description


{1WAY, 2WAY}

Default: 2WAY

1830PSS R3.6.50 - TL1 Commands and Messages 119


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-ODUK
Addressing: None
Description: Cross-connection Type
1WAY One-way cross-connection (unidirectional
cross-connection)
2WAY Two-way cross-connection (bidirectional
cross-connection)

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example illustrates the command when following ODU1


cross connections is created:
DLT-CRS-ODU1:: 11DPM12-1-2-L1- ODU2ODU1#1,
11DPM12-1-2-C1-ODU1:xyz123::1WAY;

120 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRS-ODUK Issue 1, December 2011

RELATED COMMANDS
ENT-CRS-<ODUk>
ED-CRS-<ODUk>

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 121


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-ODUK

122 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-CRS-VTS


Command Name: DLT-CRS-VTS

PURPOSE
The DLT-CRS-VTS command deletes (unassigns and deprovisions) an ethernet connection previously
provisioned in a pack. If the connection is bi-directional (BI), both of the directions shall be deleted
with a single command.
This command applies to 11DPE12 pack.

INPUT FORMAT

DLT-CRS-VTS:[TID]:FROM,TO:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

FROM Value Description


11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the head of a Ethernet connection.
When 11DPE12 working under fullrate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.

1830PSS R3.6.50 - TL1 Commands and Messages 123


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-VTS
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under subrate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

TO Value Description
11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the tail of a Ethernet connection.
When 11DPE12 working under full rate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under sub rate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 4094
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

124 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRS-VTS Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the command is issued with no matched ethernet connection provisioned

IDNV Input, Data Not Valid


• this command is issued with the value in FROM equals to TO

1830PSS R3.6.50 - TL1 Commands and Messages 125


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRS-VTS
• this command is issued with FROM or TO whose virtual time slot is out of range under the
specified working mode

SNVS Status, Not in Valid State

EXAMPLES

In the following example, a two-way ethernet connection is deleted


for a 11DPE12 client port 1, virtual time slot 1 and line port 1,
virtual time slot 1:
DLT-CRS-VTS:NODE-1:11DPE12-1-7-C1-VTS1,11DPE12-1-7-L1-VTS1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CRS-VTS
ED-CRS-VTS
ENT-CRS-VTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

126 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-CRSPROT-<ODUK>


Command Name: DELETE PROTECTED
CROSS-CONNECTION

PURPOSE
The DLT-CRSPROT-<ODUk> command deletes SNCP cross connections previously set up between
the specified rate protected / protecting and to rate facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-CRSPROT-<ODUk>:[TID]:FROMPED,FROMPING,TO:[CTAG]::[CCT];

INPUT PARAMETERS

ODUk Value Description


{ODU0,ODU1,ODUF}

Default: Entity Required


Addressing: None
Description: The ODUk indicates the rate on which the command acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 127


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRSPROT-ODUK

FROMPED Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the FROMPED
(protected receive side from the network, protected source of
cross-connection) facility of the cross-connection.

FROMPING Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the FROMPING
(protecting receive side from the network, protected source of
cross-connection) facility of the cross-connection.

128 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-CRSPROT-ODUK Issue 1, December 2011

TO Value Description
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the TO (transmit
side to the network, sink of cross-connection) facility of the
cross-connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CCT Value Description


{1WAYSNCP, 2WAYSNCP}

Default: 2WAYSNCP
Addressing: None
Description: Cross-connection Type
1WAYSNCP One-way SNCP cross-connection
(unidirectional SNCP cross-connection)
2WAYSNCP Two-way SNCP cross-connection
(bidirectional SNCP cross-connection)

1830PSS R3.6.50 - TL1 Commands and Messages 129


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-CRSPROT-ODUK
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the used AID in FROMPED, FROMPING or TO does not match for the rate

• the ports specified by FROMPED, FROMPING and TO are not all cross connected to each other
in the direction specified

• the specified CCT does not match the CCT of the addressed cross-connection

EXAMPLES
The following example illustrates the command when following ODU1 cross connections is created:

DLT-CRSPROT-ODU1::11DPM12-1-2-L1-ODU2ODU1#1,
11DPM12-1-2-L2-ODU2ODU1#1, 11DPM12-1-2-C2-ODU1: Pab124::;

RELATED COMMANDS
ENT-CRSPROT-<ODUk>

RTRV-CRSPROT-<ODUk>

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

130 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-EQPT


Command Name: DELETE EQUIPMENT

PURPOSE
The DLT-EQPT command deassigns an equipment object entity at the physical location identified by
its Access Identifier (AID) and deprovisions the specified equipment, regardless of whether the
equipment is installed in the system. The command can be applied to the following equipment:
General Equipment
• Shelf (SHELF with type = UNV, SFD, DCM, or ITL)
• First Level Controller (FLC)
• Matrix Zero (MT0C)
• Shelf Equipment Controller (EC)
Active DWDM Circuit Packs
• Line Driver - LD (ALPHG, AHPHG, AHPLG, ALPFGT, A2325A, AM2017B, AM2325B, AM2125A,
AM2125B, AM2318A, RA2P)
• Optical Supervisory Channel (OSCT)
• Wavelength Tracker Optical Channel Monitoring Card (WTOCM)
• Colorless Wavelength Router (CWR8, CWR8-88)
• Wavelength Router (WR8-88A, WR2-88A)
• Mesh Card (MESH4)
• Optical Translator - OT (112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10, 112SX10L,
11STAR1, 11STMM10, 11STGE12, 43STX4, 43STX4P, 43SCX4L, 43SCX4, 43SCA1, 43STA1P,
4DPA4, 4DPA2, 11QPA4, 11DPE12, 11DPE12E, 11DPM12, 11STAR1A )
• Optical Translator - OT
• 112SA1L, 112SCA1, 112SCX10, 112SNA1, 112SNX10, 112SX10L,
• 11DPE12, 11DPE12E, 11DPM12, 11QPA4, 11QPEN4, 11QTA4, 11STAR1,
11STAR1A, 11STGE12, 11STMM10,
• 4DPA2, 4DPA4
• Variable Attenuator Card (SVAC, MVAC)
• Optical Protection Switch (OPS)
• Static Filter DWDM (SFD5/8)
• Static Filter CWDM (SFC2/4/8)
Passive DWDM Modules
• SFD44. The SFD44 is modeled as the fixed "card" in an SFD44 "shelf" with only one "slot". But
physically, the SFD44 card/shelf are not separable. DLT-EQPT is addressed to the SFD44 shelf,
but deletes both shelf and card.
• SFD40. The SFD40 is modeled as the fixed "card" in an SFD40 "shelf" with only one "slot". But
physically, the SFD40 card/shelf are not separable. DLT-EQPT is addressed to the SFD40 shelf,
but deletes both shelf and card.
• SFD44B. The SFD44B is modeled as the fixed "card" in an SFD44B "shelf" with only one "slot".
But physically, the SFD44B card/shelf are not separable. DLT-EQPT is addressed to the SFD44B

1830PSS R3.6.50 - TL1 Commands and Messages 131


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-EQPT
shelf, but deletes both shelf and card. The SFD44B carries the 44 odd channels, which in addition
to the 44 even channels from a SFD44 supports an 88 channel optical line.
• SFD40B. The SFD40B is modeled as the fixed "card" in an SFD40B "shelf" with only one "slot".
But physically, the SFD40B card/shelf are not separable. DLT-EQPT is addressed to the SFD40B
shelf, but deletes both shelf and card. The SFD40B carries the 40 odd channels, which in addition
to the 40 even channels from a SFD44 supports an 80 channel optical line.
• DCM. The DCM is modeled as the fixed "card" in a DCM "shelf" with only one "slot". But
physically, multiple DCM modules of several sizes fit into a single housing. DLT-EQPT is
addressed to the DCM shelf, but deletes both shelf and card.
• ITLB/ITLU. The ITLB/ITLU is modeled as the fixed "card" in an ITLB/ITLU "shelf" with only one
"slot". But physically, multiple ITLB/ITLU and DCM modules of several sizes fit into a single
housing. DLT-EQPT is addressed to the ITLB/ITLU shelf, but deletes both shelf and card.
IO equipment can only be deleted if all supported facilities are deprovisioned first.
Circuit packs must be in admin out-of-service state for DLT-EQPT to execute.
Universal shelves must have their non-mandatory circuit packs deleted for DLT-EQPT to execute
against the shelf.
SFD/DCM/ITL shelves must be must have their circuit packs administatively out-of-service for
DLT-EQPT to execute against the shelf.
Upon successful completion of DLT-EQPT, the system clears all condition types associated with the
specified equipment entity.
If a card is deleted when it is still physically present, it will not be "re-discovered" and auto-provisioned
until it is physically removed and re-inserted, or until the system reboots (whichever comes first).
The successful completion of the command shall cause REPT^DBCHG autonomous messages.

INPUT FORMAT

DLT-EQPT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

132 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-EQPT Issue 1, December 2011

AID Value Description


SHELF-<shelf> (non-main Universal Shelf)
SHELF-<shelf> (Passive Shelf)
FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 133


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-EQPT

AID Value Description


11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)

Default: Entry required


Addressing: None
Description: Equipment Access Identifier, identifies the equipment entity access
identifier

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

134 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-EQPT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
EQWT EQuipage, Wrong Type
• the command is input for an AID which is different from the one provisioned in the corresponding
slot

IENE Input, Entity Not Exists


• the DLT-EQPT command is input for an AID that is not provisioned

SABT Status, ABorTed


• the non-shelf equipment entity is not administratively out-of-service

• the DLT-EQPT command is input for the AID of the main universal shelf

• the equipment entity is a universal shelf with provisioned non-mandatory circuit packs

• the equipment entity is an SFD/DCM shelf whose circuit pack is not administratively
out-of-service

• the specified OT or OPS circuit pack has an existing protection group

EXAMPLES
In the following example, the system deprovisions an OT.

DLT-EQPT::11STAR1-2-5;

RELATED COMMANDS
ED-EQPT

1830PSS R3.6.50 - TL1 Commands and Messages 135


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-EQPT
ENT-EQPT
RMV-EQPT
RST-EQPT
RTRV-EQPT

136 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-FC100


Command Name: DLT-FC100

PURPOSE
The DLT-FC100 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-FC100 command
Executing a DLT-FC100 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-FC100:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 137


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC100
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

138 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FC100 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-FC100


command.
DLT-FC100:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC100
RST-FC100
ED-FC100
ENT-FC100
RMV-FC100

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 139


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC100

140 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-FC1200


Command Name: DLT-FC1200

PURPOSE
The DLT-FC1200 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-FC1200 command
Executing a DLT-FC1200 command causes a state transition for the specified OT client facility from:
• OOS–AUMA to OOS–MA,UAS

• OOS–MA to OOS–MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

If the facility provisioning mode of this NE is automatic, i.e., PROVMODE=AUTOEQ-AUTOFC, then


this command cannot be used to delete facilities. In this mode, facility deletion occurs only when the
supporting equipment or logical resource is deleted (See ED-PRMTR-NE)
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-FC1200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 141


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC1200
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

142 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FC1200 Issue 1, December 2011

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-FC1200


command.
DLT-FC1200:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC1200
RST-FC1200
ED-FC1200
ENT-FC1200
RMV-FC1200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 143


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC1200

144 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-FC200


Command Name: DLT-FC200

PURPOSE
The DLT-FC200 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-FC200 command
Executing a DLT-FC200 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-FC200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 145


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC200
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

146 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FC200 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-FC200


command.
DLT-FC200:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC200
RST-FC200
ED-FC200
ENT-FC200
RMV-FC200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 147


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC200

148 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-FC400


Command Name: DLT-FC400

PURPOSE
The DLT-FC400 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-FC400 command
Executing a DLT-FC400 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-FC400:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 149


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC400
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

150 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FC400 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-FC400


command.
DLT-FC400:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC400
RST-FC400
ED-FC400
ENT-FC400
RMV-FC400

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 151


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC400

152 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-FC800


Command Name: DLT-FC800

PURPOSE
The DLT-FC800 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-FC800 command
Executing a DLT-FC800 command causes a state transition for the specified OT client facility from:
• OOS–AUMA to OOS–MA,UAS

• OOS–MA to OOS–MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

If the facility provisioning mode of this NE is automatic, i.e., PROVMODE=AUTOEQ-AUTOFC, then


this command cannot be used to delete facilities. In this mode, facility deletion occurs only when the
supporting equipment or logical resource is deleted (See ED-PRMTR-NE)
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-FC800:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 153


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC800

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

154 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FC800 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-FC800


command.
DLT-FC800:NODE-1:112SCX10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC800
RST-FC800
ED-FC800
ENT-FC800
RMV-FC800

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 155


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FC800

156 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-FE


Command Name: DLT-FE

PURPOSE
The DLT-FE command deletes (unassigns and deprovisions) a specified client facility. Facility must
have been provisioned with ENT-FE command
Executing a DLT-FE command causes a state transition for the specified OT client facility from:
• IS-NR or IS-ANR to OOS–MA,UAS

• OOS–AU to OOS–MA,UAS

• OOS–AU,AINS to OOS–MA,UAS

· OOS-AUMA to OOS-MA,UAS or
. OOS-AUMA, MT to OOS-MA,UAS

• OOS-AUMA to OOS-MA,UAS

· OOS-MA to OOS-MA,UAS or
. OOS-MA, MT to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-FE:[TID]:AID:[CTAG];

INPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 157


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FE

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

158 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FE Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-FE


command.
DLT-FE:NODE-1:11DPE12E-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FE

1830PSS R3.6.50 - TL1 Commands and Messages 159


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FE
RST-FE
ED-FE
ENT-FE
RMV-FE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

160 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-FFP-EQPT


Command Name: DELETE FACILITY PROTECTION GROUP

PURPOSE
The DLT-FFP-EQPT command deletes a 1+1 facility protection group (Y-cable, OPS, or E-SNCP). It
disables protection switching and disassociates the working and protection ports. Upon deletion of a
Y-cable protection group, both OT client-side lasers are enabled. Upon deletion of an OPS protection
group, the position of the OPS path selector is indeterminate.
The DLT-FFP-EQPT command can only be executed against an existing protection group provisioned
by the ENT-FFP-EQPT command.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-FFP-EQPT:[TID]:WORKING_AID,PROTECTION_AID[,ESNCP_CLIENT_AID]:[CT
AG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 161


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FFP-EQPT

WORKING_AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: The working port AID.
Restriction: 4DPA4 OT supports protection only in
FlexMux mode.

162 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FFP-EQPT Issue 1, December 2011

PROTECTION_AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: The protection port AID.
Restriction: 4DPA4 OT supports protection only in
FlexMux mode.

ESNCP_CLIENT_A Value Description


ID
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}

Default: Entry required


Addressing: None
Description: The E-SNCP Client Port AID.

1830PSS R3.6.50 - TL1 Commands and Messages 163


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FFP-EQPT

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the specified protection group does not exist

SNVS Status, Not in Valid State


• either of the Y-cable or OPS ports is administratively in-service

• the E-SNCP client port is administratively in-service

164 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-FFP-EQPT Issue 1, December 2011

• any existing cross connects depend on the OPS protection group

EXAMPLES
The following command deletes a Y-cable protection group.

DLT-FFP-EQPT:ALU-1830PSS:11STAR1-5-2-C1,11STAR1-5-20-C1;

The following command deletes an E-SNCP protection group.

DLT-FFP-EQPT:ALU-1830PSS:4DPA4-5-2-L1,4DPA4-5-2-L1,4DPA4-5-2-C4;

RELATED COMMANDS
ENT-FFP-EQPT
RTRV-FFP-EQPT

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 165


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-FFP-EQPT

166 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-IPACL-FILTER


Command Name: DELETE IP ACCESS CONTROL LIST
FILTER OR ASSOCIATED PATTERN

PURPOSE
The DLT-IPACL-FILTER command can be used to remove the specified filter.
An ACL Filter is an ordered list of patterns. A filter consists of a sorted list of (index, pattern) pairs,
where the index indicates the relative position in the list and the pattern indicates the pattern identifier.
If the DLT-IPACL-FILTER command is issued, the entire filter will be removed from the system.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-IPACL-FILTER:[TID]::[CTAG]::FILTERID;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

FILTERID Value Description


{100-199}
<1-30 VALID FILTERID
CHARACTERS>

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 167


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-IPACL-FILTER
Description: Identifier for the ACL filter being deleted. Could be either an integer
in the range 100-199 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter , which uniquely identifies the filter being deleted.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• FILTERID corresponds to an undefined filter

SNVS Status, Not in Valid State


• the filter is associated to an interface

EXAMPLES
In the following example, DLT-IPACL-FILTER removes filter #1 from the system:

168 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-IPACL-FILTER Issue 1, December 2011

DLT-IPACL-FILTER:NODE-1::C0001::1;

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* DLT-IPACL-FILTER:NODE-1::::1 [C0001] (5) */
;

RELATED COMMANDS
ED-IPACL-FILTER
ENT-IPACL-FILTER
RTRV-IPACL-FILTER

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 169


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-IPACL-FILTER

170 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-IPACL-PATTERN


Command Name: DELETE EXISTING IP ACCESS CONTROL
LIST PATTERN DESCRIPTION.

PURPOSE
The DLT-IPACL-PATTERN command can be used to delete an ACL Pattern that has been provisioned
on the system.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-IPACL-PATTERN:[TID]::[CTAG]::PATTERNID;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

PATTERNID Value Description


{1-256}
<1-30 VALID PATTERNID
CHARACTERS>

Default: Entry required


Addressing: None
Description: The identifier of the pattern to be deleted. Could be either an
integer in the range 1-256 or a string of up to 30 case-sensitive

1830PSS R3.6.50 - TL1 Commands and Messages 171


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-IPACL-PATTERN
alphanumeric characters, where the first character is always a
letter.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• PATTERNID corresponds to an undefined pattern

SNVS Status, Not in Valid State


• the pattern is associated to an filter

EXAMPLES
In the following example, DLT-IPACL-PATTERN removes pattern BLOCKFTP from the system:

DLT-IPACL-PATTERN:NODE-1::C0001::BLOCKFTP;

A successful response for that command would be:

172 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-IPACL-PATTERN Issue 1, December 2011

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
/* DLT-IPACL-PATTERN:NODE-1::::BLOCKFTP [C0001] (5) */
;

RELATED COMMANDS
ED-IPACL-PATTERN
ENT-IPACL-PATTERN
RTRV-IPACL-PATTERN

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 173


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-IPACL-PATTERN

174 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-NE-IPRT


Command Name: DELETE NETWORK ELEMENT IP ROUTE

PURPOSE
This command allows the administrative operator to delete a static IP route from the IP routing table.
The command requires a uniquely specified entry in the IP routing table. If a match with all the
specified parameters cannot be found, an error message will be returned in response.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-NE-IPRT:[TID]::[CTAG]::DESTADDR,MASK,NEXTHOP;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DESTADDR Value Description


0-0-0-0
{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 175


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-NE-IPRT
Description: Destination Address, IP address of the destination host or network
(in the format nnn-nnn-nnn-nnn). If the MASK parameter is not all
1's when viewed in binary format (i.e., a network route is
specified), the host portion of DESTADDR must be all 0's. The
address 0-0-0-0 is allowed for the removal of the default gateway
route.

MASK Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Default: Entry Required


Addressing: None
Description: Mask, IP subnet mask of the route (in the format
nnn-nnn-nnn-nnn). The mask 0-0-0-0 is used to specify the default
route.

NEXTHOP Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: Entry Required


Addressing: None
Description: Next hop address, IP address of the next interface in the route (in
the format nnn-nnn-nnn-nnn). This is also known as the “gateway
address”. The target NE shall be directly connected to this
interface. The address 0-0-0-0 is not allowed.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

176 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-NE-IPRT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the specified IP route does not exist (i. e., no entry in the IP routing table matches the specified
parameters)

IPMS Input Parameter Missing


• either the DESTADDR, MASK or NEXTHOP parameter is not specified

EXAMPLES
In the following example, DLT-NE-IPRT removes the static IP route to the destination 128.210.54.0
from the IP routing table:

DLT-NE-IPRT:::C0001::128-210-54-0,255-255-255-0,10-1-1-1;

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* DLT-NE-IPRT:::C0001::128-210-54-0,255-255-255-0,10-1-1-1 [C0001]
(5) */
;

RELATED COMMANDS
ENT-NE-IPRT
RTRV-NE-IPRT

1830PSS R3.6.50 - TL1 Commands and Messages 177


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-NE-IPRT
RELATED AUTONOMOUS RESPONSES
REPT^DBCHG

178 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-NTP-ADDR


Command Name: DELETE NTP SERVER ADDRESS

PURPOSE
The DLT-NTP-ADDR command deletes an existing NTP server address.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-NTP-ADDR:[TID]::[CTAG]:::IP{1-3};

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.
IP{1-3}
Default: <entry required>
Addressing: None
Description: Label of the NTP server to be deleted. Label should be IP1, IP2, or
IP3.

1830PSS R3.6.50 - TL1 Commands and Messages 179


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-NTP-ADDR
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the specified IP address does not correspond to an already entered NTP server

SROF Status, Requested Operation Failed


• NTP is enabled and this is the only In Service NTP server

EXAMPLES
The output response is shown below.

cr lf lf
^^^LASVEGAS^01-02-27^08:46:59 cr lf
M^^C0001^COMPLD cr lf
/* DLT-NTP-ADDR:::C0001::IP1[C0001] (5)*/
;

180 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-NTP-ADDR Issue 1, December 2011

RELATED COMMANDS
ENT-NTP-ADDR
RTRV-NTP-ADDR

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 181


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-NTP-ADDR

182 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OC12


Command Name: DLT-OC12

PURPOSE
The DLT-OC12 command deletes (unassigns and deprovisions) a specified client facility. Facility must
have been provisioned with ENT-OC12 command
Executing a DLT-OC12 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OC12:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 183


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC12
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

184 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OC12 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-OC12


command.
DLT-OC12:NODE-1:11STMM10-1-2-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC12
RST-OC12
ED-OC12
ENT-OC12
RMV-OC12

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 185


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC12

186 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OC192


Command Name: DLT-OC192

PURPOSE
The DLT-OC192 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-OC192 command
Executing a DLT-OC192 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OC192:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 187


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC192

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

188 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OC192 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-OC192


command.
DLT-OC192:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC192
RST-OC192
ED-OC192
ENT-OC192
RMV-OC192

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 189


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC192

190 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OC3


Command Name: DLT-OC3

PURPOSE
The DLT-OC3 command deletes (unassigns and deprovisions) a specified client facility. Facility must
have been provisioned with ENT-OC3 command
Executing a DLT-OC3 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OC3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 191


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC3
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

192 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OC3 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-OC3


command.
DLT-OC3:NODE-1:11STMM10-1-2-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC3
RST-OC3
ED-OC3
ENT-OC3
RMV-OC3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 193


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC3

194 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OC48


Command Name: DLT-OC48

PURPOSE
The DLT-OC48 command deletes (unassigns and deprovisions) a specified client facility. Facility must
have been provisioned with ENT-OC48 command
Executing a DLT-OC48 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OC48:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 195


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC48
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

196 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OC48 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-OC48


command.
DLT-OC48:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC48
RST-OC48
ED-OC48
ENT-OC48
RMV-OC48

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 197


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC48

198 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OC768


Command Name: DLT-OC768

PURPOSE
The DLT-OC768 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-OC768 command
Executing a DLT-OC768 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OC768:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

1830PSS R3.6.50 - TL1 Commands and Messages 199


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC768

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

200 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OC768 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-OC768


command.
DLT-OC768:NODE-1:43STA1P-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC768
RST-OC768
ED-OC768
ENT-OC768
RMV-OC768

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 201


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OC768

202 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OCH


Command Name: DELETE-OCH

PURPOSE
The DLT-OCH command deletes (unassigns and deprovisions) a specified OCH facility.
Executing a DLT-OCH command causes a state transition for the specified OCH from IS-NR to
OOS-AUMA,UAS&DSBLD

INPUT FORMAT

DLT-OCH:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)
WR-<shelf>-<slot>-ADDIN{1-8} (WR8-88A ADDIN Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OTS.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 203


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OCH
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SABT Status, Aborted
• any cross-connects are present when this command is run,

SAIS Status, Already in Service


• the port is NOT admin out-of-service (OOS-MA or OOS-AUMA) when this command is run,

EXAMPLES
The following example shows the successful execution of a DLT-OCH command.

204 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OCH Issue 1, December 2011

DLT-OCH:NODE-1:4DPA4-3-5-VA1:789012;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* DLT-OCH:NODE-1:4DPA4-3-5-VA1 */
;

RELATED COMMANDS
ED-OCH
ENT-OCH
RST-OCH
RMV-OCH
RTRV-OCH

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 205


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OCH

206 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OSPF-AREA


Command Name: DELETE OSPF AREA

PURPOSE
The DLT-OSPF-AREA command deletes an OSPF area that the NE is part of. The NE can be part of
up to 3 OSPF areas, in addition to the backbone area (0-0-0-0). The backbone area cannot be deleted.
For deletion, the OSPF area must not be associated with an interface.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OSPF-AREA:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


OSPFAREA-{1-3} (Non-backbone OSPF Areas)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access identifier for an OSPF Area.
The backbone area (OSPFAREA-0) cannot be deleted.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 207


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OSPF-AREA
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the specified OSPF Area does not exist

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

SNVS Status, Not in Valid State


• the specified OSPF Area is being used by an interface

EXAMPLES
In the following example, DLT-OSPF-AREA deletes OSPFAREA-3 from the NE:

DLT-OSPF-AREA::OSPFAREA-3:C0001;

208 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OSPF-AREA Issue 1, December 2011

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* DLT-OSPF-AREA::OSPFAREA-3:C0001 [C0001] (5) */
;

RELATED COMMANDS
ENT-OSPF-AREA
RTRV-OSPF-AREA

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 209


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OSPF-AREA

210 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OTS


Command Name: DELETE-OTS

PURPOSE
The DLT-OTS command deletes (unassigns and deprovisions) a specified OTS facility.
Executing a DLT-OTS command causes a state transition for the specified OTS from IS-NR to
OOS-AUMA,UAS&DSBLD

INPUT FORMAT

DLT-OTS:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)
WR-<shelf>-<slot>-ADDIN{1-8} (WR8-88A ADDIN Ports)
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Default: <entry required>

1830PSS R3.6.50 - TL1 Commands and Messages 211


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTS
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OTS.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already in Service
• the port is NOT admin out-of-service (OOS-MA or OOS-AUMA) when this command is run,

212 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OTS Issue 1, December 2011

EXAMPLES
The following example shows the successful execution of a DLT-OTS command.

DLT-OTS:NODE-1:ALPHG-3-5-OSC:789012;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* DLT-OTS:NODE-1:ALPHG-3-5-OSC */
;

RELATED COMMANDS
ED-OTS
ENT-OTS
RST-OTS
RMV-OTS
RTRV-OTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 213


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTS

214 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OTU1


Command Name: DLT-OTU1

PURPOSE
The DLT-OTU1 command deletes (unassigns and deprovisions) a specified client/facility. Facility must
have been provisioned with ENT-OTU1 command
Executing a DLT-OTU1 command causes a state transition for the specified OT client port from:
• OOS–AUMA to OOS–MA,UAS

• OOS–MA to OOS–MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OTU1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 215


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTU1
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

216 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OTU1 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-OTU1


command.
DLT-OTU1:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU1
RST-OTU1
ED-OTU1
ENT-OTU1
RMV-OTU1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 217


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTU1

218 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OTU2


Command Name: DLT-OTU2

PURPOSE
The DLT-OTU2 command deletes (unassigns and deprovisions) a specified client/facility. Facility must
have been provisioned with ENT-OTU2 command
Executing a DLT-OTU2 command causes a state transition for the specified OT client port from:
• OOS–AUMA to OOS–MA,UAS

• OOS–MA to OOS–MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OTU2:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 219


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTU2

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

220 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OTU2 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-OTU2


command.
DLT-OTU2:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU2
RST-OTU2
ED-OTU2
ENT-OTU2
RMV-OTU2

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 221


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTU2

222 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-OTU3


Command Name: DLT-OTU3

PURPOSE
The DLT-OTU3 command deletes (unassigns and deprovisions) a specified facility.
Executing a DLT-OTU3 command causes a state transition for the specified OT client port from:
• OOS–AUMA to OOS–MA,UAS

• OOS–MA to OOS–MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-OTU3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT line port
AID.

1830PSS R3.6.50 - TL1 Commands and Messages 223


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTU3

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

• the command is issued on a facility that still has electrical connection present

224 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-OTU3 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-OTU3


command.
DLT-OTU3:NODE-1:43STA1P-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU3
RST-OTU3
ED-OTU3
RMV-OTU3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 225


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-OTU3

226 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-RADIUS-SERVER


Command Name: DELETE RADIUS SERVER

PURPOSE
The DLT-RADIUS-SERVER command is used to delete the specific RADIUS server.
Access Level: Admin
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-RADIUS-SERVER:[TID]::[CTAG]::SERVERNUM;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SERVERNUM Value Description


RAD1
RAD2

Default: <Entry Required>


Addressing: None
The following attributes are the valid server number to provision
the server.
RAD1: RAD1 is the first server name.
RAD2: RAD2 is the second server number.

1830PSS R3.6.50 - TL1 Commands and Messages 227


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-RADIUS-SERVER
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• an attempt is made to delete a RADIUS server whose status is "Enable"

• the command is issued with a server that does not exist

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

EXAMPLES
The following example illustrates the command and associated output for deleting a RADIUS server
whose name is RAD1.

DLT-RADIUS-SERVER::RAD1;

228 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-RADIUS-SERVER Issue 1, December 2011

AM1520 03-07-08 10:11:58


M P09056 COMPLD
;

RELATED COMMANDS
ED-RADIUS-SERVER
ENT-RADIUS-SERVER
RTRV-RADIUS-SERVER

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 229


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-RADIUS-SERVER

230 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-SESSION


Command Name: DELETE SESSION

PURPOSE
The DLT-SESSION command deletes a user session on the NE. Every session has a unique session
id assigned to it. RTRV-SESSION command can be used to retrieve the unique id for an user session.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-SESSION:[TID]:SESSIONID:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

SESSIONID Value Description


{1-65535}

Default: Entry Required


Addressing: None
Description: The session id of the session is to be terminated.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 231


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-SESSION
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• an attempt is made to delete a default vendor sessionID

• the command is issued by a non-privilege user

PIUI Privilege, Illegal User Identity, invalid UID


• the SESSIONID is invalid (ie., SESSIONID does not exist)

EXAMPLES
The following example illustrates the command and associated output for deleting a session.

DLT-SESSION::25;

232 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-SESSION Issue 1, December 2011

AM1520 03-07-08 10:11:58


M P09056 COMPLD
;

RELATED COMMANDS
ED-SESSION
RTRV-SESSION

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 233


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-SESSION

234 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-STM16


Command Name: DLT-STM16

PURPOSE
The DLT-STM16 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-STM16 command
Executing a DLT-STM16 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-STM16:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 235


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM16
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

236 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-STM16 Issue 1, December 2011

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-STM16


command.
DLT-STM16:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM16
RST-STM16
ED-STM16
ENT-STM16
RMV-STM16

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 237


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM16

238 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-STM1


Command Name: DLT-STM1

PURPOSE
The DLT-STM1 command deletes (unassigns and deprovisions) a specified client facility. Facility must
have been provisioned with ENT-STM1 command
Executing a DLT-STM1 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-STM1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 239


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM1
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

240 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-STM1 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-STM1


command.
DLT-STM1:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM1
RST-STM1
ED-STM1
ENT-STM1
RMV-STM1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 241


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM1

242 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-STM256


Command Name: DLT-STM256

PURPOSE
The DLT-STM256 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-STM256 command
Executing a DLT-STM256 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-STM256:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

1830PSS R3.6.50 - TL1 Commands and Messages 243


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM256

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

244 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-STM256 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-STM256


command.
DLT-STM256:NODE-1:43STA1P-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM256
RST-STM256
ED-STM256
ENT-STM256
RMV-STM256

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 245


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM256

246 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-STM4


Command Name: DLT-STM4

PURPOSE
The DLT-STM4 command deletes (unassigns and deprovisions) a specified client facility. Facility must
have been provisioned with ENT-STM4 command
Executing a DLT-STM1 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-STM4:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 247


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM4
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

248 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-STM4 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a DLT-STM4


command.
DLT-STM4:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM4
RST-STM4
ED-STM4
ENT-STM4
RMV-STM4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 249


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM4

250 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-STM64


Command Name: DLT-STM64

PURPOSE
The DLT-STM64 command deletes (unassigns and deprovisions) a specified client facility. Facility
must have been provisioned with ENT-STM64 command
Executing a DLT-STM64 command causes a state transition for the specified OT client facility from:
• OOS-AUMA to OOS-MA,UAS

• OOS-MA to OOS-MA,UAS

Upon successful completion of this TL1 command, the following events and/or transitions will take
place:
• All condition types and PM data/registers associated with the specified facility are cleared.

• An autonomous message via REPT^DBCHG (report database change) will be generated.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-STM64:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 251


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM64

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port (client AID).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

252 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-STM64 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is already unassigned

• the command is issued on a facility that is under loopback, i.e. carrying a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a DLT-STM64


command.
DLT-STM64:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM64
RST-STM64
ED-STM64
ENT-STM64
RMV-STM64

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 253


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-STM64

254 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-TOPOLOGY-OCONN


Command Name: DELETE TOPOLOGY OPTICAL
CONNECTION

PURPOSE
The DLT-TOPOLOGY-OCONN command deletes the cable information previously provisioned using
the ENT-TOPOLOGY-OCONN command.
This command allow the operator to delete a unidirectional or bidirectional optical connection.

INPUT FORMAT

DLT-TOPOLOGY-OCONN:[TID]:FROM,TO:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 255


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-TOPOLOGY-OCONN

FROM Value Description


EXTERNAL
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},VA{1- (11DPE12E Ports)
2},C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)

256 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-TOPOLOGY-OCONN Issue 1, December 2011

FROM Value Description


LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-EXP (SFC2/4 Expansion Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 NE Boundary Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, 9180, 9170}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot>-EXP (SFD5/8 Expansion Port)

1830PSS R3.6.50 - TL1 Commands and Messages 257


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-TOPOLOGY-OCONN

FROM Value Description


OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier identifying the FROM connector to be deleted
from cabling. AID can identify only one connector in case of
unidirectional connections or two connectors (IN, OUT) in case of
bidirectional connections.

258 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-TOPOLOGY-OCONN Issue 1, December 2011

TO Value Description
EXTERNAL
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},VA{1- (11DPE12E Ports)
2},C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 259


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-TOPOLOGY-OCONN

TO Value Description
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-EXP (SFC2/4 Expansion Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 NE Boundary Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, 9180, 9170}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFD-<shelf>-<slot>-EXP (SFD5/8 Expansion Port)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)

260 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-TOPOLOGY-OCONN Issue 1, December 2011

TO Value Description
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier identifying the TO connector to be deleted from
cabling. AID can identify only one connector in case of
unidirectional connections or two connectors (IN, OUT) in case of
bidirectional connections.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 261


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-TOPOLOGY-OCONN
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• an invalid combination of parameters are entered,

IENE Input, Entity does Not Exist


• the OCONN is not already provisioned,

SNVS Status, Not in Valid State


• the port is NOT admin out-of-service (OOS-MA or OOS-AUMA) when this command is run,

EXAMPLES
The following example shows the successful execution of a DLT-TOPOLOGY-OCONN command.

DLT-TOPOLOGY-OCONN:NODE-1:ALPHG-3-5-SIG,ALPHG-3-7-SIG:789012;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* DLT-TOPOLOGY-OCONN */
;

RELATED COMMANDS
ENT-TOPOLOGY-OCONN
RTRV-TOPOLOGY-OCONN

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

262 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-USER-SECU


Command Name: DELETE USER SECURITY

PURPOSE
The DLT-USER-SECU command deletes user profiles in the User Security Database for the specified
User Identifier (UID).
Only an administrator can delete a user profile entry in the User Security Database (i.e., execute a
DLT-USER-SECU command).
This command can delete users having unauthenticated and authenticated sessions, i.e. logged off
users and logged on users. The deletion of a logged on user shall have the dual effect of logging off all
sessions associated with the target user ID, and deleting his/her profile from the security DB.
An administrator cannot delete himself or herself. An administrator can delete other security
administrators. Note that the default vendor user profiles cannot be deleted.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

DLT-USER-SECU:[TID]:UID:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: Entry Required


Addressing: None
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

1830PSS R3.6.50 - TL1 Commands and Messages 263


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-USER-SECU

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the UID is the same of the user that is issuing the command (ie. the command is issued against
the user himself)

PICC Privilege, Illegal Command Code


• an attempt is made to delete a default vendor user

264 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-USER-SECU Issue 1, December 2011

• the command is issued by a non-privilege user

PIUI Privilege, Illegal User Identity, invalid UID


• the UID is invalid (ie., illegal UID, UID does not exist)

EXAMPLES
The following example illustrates the command and associated output for deleting the user profile of a
user with a UID of user11.

DLT-USER-SECU::user11;

AM1520 03-07-08 10:11:58


M P09056 COMPLD
;

RELATED COMMANDS
ED-USER-SECU
ENT-USER-SECU
RTRV-USER-SECU

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 265


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-USER-SECU

266 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: DLT-VTS


Command Name: DLT-VTS

PURPOSE
The DLT-VTS command deletes (unassigns and deprovisions) a specified VLAN ID map for the virtual
time slots of a port which have been provisioned.

INPUT FORMAT

DLT-VTS:[TID]:AID:[CTAG]:::DIR:[VTS];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT port only.
11DPE12-<shelf>-<slot>-C{1-12}- (11DPE12 Client Ports) and
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports) only apply
to fullrate mode and subrate mode .

The line port only applies to the pack working under qinq mode

1830PSS R3.6.50 - TL1 Commands and Messages 267


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-VTS

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DIR Value Description


{INGRESS, EGRESS, 2WAY}

Default: INGRESS
Addressing: None
Description: Specifies the direction to the configuration.
This parameter would be 2WAY for the 11DPE12 pack working
under subrate mode.
This parameter could not set as 2WAY for 11DPE12E pack.

VTS Value Description


VTS{1-32}

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot in the
port.
the parameter is only for 11DPE12 subrate mdoe , the client VTS
range is 1-10 , the line port VTS range is 1-32 .
For the 11DEP12 client port, the range of VTS is 1-10
For the 11DEP12 line port, the range of VTS is 1-100
For the 11DPE12E client port, the range of VTS is 1-10
For the 11DPE12E line port, the range of VTS is 1-100

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

268 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
DLT-VTS Issue 1, December 2011

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is input for an 11DPE12 pack that is not working under subrate or qinq mode

• the command is input for an 11DPE12 pack that the VLAN ID is out of the speicified range under
subrate or qinq mode

• the command is input for an 11DPE12 line port AID under subrate working mode

EXAMPLES

In the following example, the vlanid provisioned for a 11DPE12


client port 1, virtual time slot1will be deleted:
DLT-VTS:NODE-1:11DPE12-1-7-C1:xyz123:::VTS1;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-VTS
ED-VTS
ENT-VTS

1830PSS R3.6.50 - TL1 Commands and Messages 269


8DG61100 EAAAQZZA
Issue 1, December 2011 DLT-VTS
RELATED AUTONOMOUS RESPONSES
REPT DBCHG

270 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-100GBE


Command Name: ED-100GBE

PURPOSE
The ED-100GBE command modifies the specified facility parameter values previously provisioned
using the ENT-100GBE command.
Executing an ED-100GBE command causes primary and secondary state transitions for the specified
100GBE facility. Primary and secondary states associated with the 100GBE facility after the command
is executed depend upon values entered for PST, SST and the events detected by the system.

The state transitions are described in the IOM Appendix F.


If no values are entered for PST, SST then 100GBE enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when 100GBE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an 100GBE is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types
are cleared and a MAN condition type is set for the specified 100GBE. The MAN condition type is
cleared when the 100GBE is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the 100GBE
is deleted.
When an 100GBE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 100GE transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
100GBE signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the 100GBE signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-100GBE:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,MODULET
YPE=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 271


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-100GBE

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition out of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{00-96}-{00-59}

Default: <Previously-existing value>


Addressing: None
Description: AINSTMR, Automatic In-Service Timer, specifies how long an
input signal must be present on the facility without a failure
condition before the system transitions the facility into the
In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

272 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-100GBE Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, C113G10C, C113G4C,
C113G4CD}

Default: <Previously existing value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified 100GBE port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type which
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously existing value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

PST Value Description


{IS,OOS}

Default: <Previously-existing value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

1830PSS R3.6.50 - TL1 Commands and Messages 273


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-100GBE

SST Value Description


{AINS,AINS-DEA, MT}

Default: <Previously-existing value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is unassigned

274 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-100GBE Issue 1, December 2011

• this command is issued with PST of IS, SST of either <No Value> or AINS and the facility is under
loopback, i.e. carries a LPBK secondary state,

• this command is issued with secondary state of AINS or AINS-DEA, and current PST/SST is
shown in Table above as a deny scenario,

EXAMPLES

The following example shows the successful execution of a ED-100GBE


command.
ED-100GBE:NODE-1:112SCA1-1-5-C1:123456:::
moduletype=C113G10C:IS,AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-100GBE
RST-100GBE
DLT-100GBE
ENT-100GBE
RMV-100GBE

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 275


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-100GBE

276 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-10GBE


Command Name: ED-10GBE

PURPOSE
The ED-10GBE command modifies the specified facility parameter values previously provisioned
using the ENT-10GBE command.
Executing an ED-10GBE command causes primary and secondary state transitions for the specified
10GBE facility. Primary and secondary states associated with the 10GE facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.

The state transitions are described in the IOM Appendix F.


If no values are entered for PST, SST then 10GBE enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when 10GBE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an 10GBE is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types are
cleared and a MAN condition type is set for the specified 10GBE. The MAN condition type is cleared
when the 10GBE is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the 10GBE is deleted.
When an 10GBE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 10GE transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
10GE signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the 10GBE signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-10GBE:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,CHANNEL=
][,ENCMODE=][,MODULETYPE=][,ERRFRMDROP=][,LOSPROP=][,STPID=]:[PST][,
SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 277


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-10GBE

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition out of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{00-96}-{00-59}

Default: <Previously-existing value>


Addressing: None

278 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-10GBE Issue 1, December 2011

Description: AINSTMR, Automatic In-Service Timer, specifies how long an


input signal must be present on the facility without a failure
condition before the system transitions the facility into the
In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

CHANNEL= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies;)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <Previously-existing value>


Addressing: None
Description: Specifies the channel frequency of the port.
The DWDM frequences only apply to the 11DPE12 and
11DPE12E line AID

1830PSS R3.6.50 - TL1 Commands and Messages 279


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-10GBE

ENCMODE= Value Description


{CBRLAN11.049,CBRLAN11.096,GFP-
F,GFP-P}

Default: <Previously-existing value>


Addressing: None
Description: The parameter encmode describes the encapsulation mode used
to transport the client signal.
CBRLAN11.049 Constant Bit Rate
CBRLAN11.096 Constant Bit Rate
GFP-F Generic Framing Protocol (ITU-T G.7041)
GFP-P Generic Framing Protocol - Proprietary Option - it
preserve client Ethernet frame Preamble.
For the 43STX4 and 43STX4P OT, the only supported values for
ENCMODE are {GFP-F, GFP-P}
For the 43SCX4L OT or 43SCX4OT, the supported values for
ENCMODE are {CBRLAN11.049, CBRLAN11.096, GFP-F,
GFP-P}
For the 11QTA4 OT, the supported values for ENCMODE are
{CBRLAN11.096, GFP-F}
This parameter doesn't apply to 11DPE12 and 11DPE12E line side

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for 11STAR1, 43STX4,
43STX4P, 43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for 112SCX10, 112SNX10,
and 112SX10L OTs.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for the 11QPA4 OT.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for the 11QTA4 OT.
{AUTO, USER, 10GB-SR,10GB-ZR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C, XL-64.2D, XL-64TU} for the
11DPE12 OT.
{AUTO, USER, 10GB-SR ,10GB-ZR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C,XL-64.2D,XL-64TU} for the
11DPE12E OT.

280 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-10GBE Issue 1, December 2011

Default: <Previously existing value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified 10GBE port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type which
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

ERRFRMDROP= Value Description


{ENABLED, DISABLED}

Default: <Previously-existing value>


Addressing: None
Description: Attribute that controls whether inbound error frames are discarded
or passed. This attribute is meaningfull only for GFP transport
modes.
This parameter doesn't apply to 11DPE12 and 11DPE12E line side

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously existing value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: None
Addressing: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously-existing value>

1830PSS R3.6.50 - TL1 Commands and Messages 281


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-10GBE
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


{AINS,AINS-DEA, MT}

Default: <Previously-existing value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

282 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-10GBE Issue 1, December 2011

Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a 11DPE12 pack not working under qinq mode

SNVS Status, Not in Valid State


• the facility specified in the AID field is unassigned

• this command is issued with PST of IS, SST of either <No Value> or AINS and the facility is under
loopback, i.e. carries a LPBK secondary state,

• this command is issued with secondary state of AINS or AINS-DEA, and current PST/SST is
shown in Table above as a deny scenario,

EXAMPLES

The following example shows the successful execution of a ED-10GBE


command.
ED-10GBE:NODE-1:11STAR1-1-5-C1:123456:::encmode=GFP-F,
moduletype=XI-64.1:IS,AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-10GBE
RST-10GBE
DLT-10GBE
ENT-10GBE
RMV-10GBE

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 283


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-10GBE

284 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-1GBE


Command Name: ED-1GBE

PURPOSE
The ED-1GBE command creates (assigns and provisions) a specified GE client signal facility.
Executing an ED-1GBE command causes primary and secondary state transitions for the specified
1GBE facility. Primary and secondary states associated with the 1GBE facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then 1GBE enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility 1GBE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a GE is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an GE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 10GE transmission condition
types or performance monitoring threshold crossing alerts are autonomously reported for the GE
signal, but alarm conditions are monitored and performance monitoring data is collected (if provisioned
for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-1GBE:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,ENCMODE=]
[,ERRFRMDROP=][,AUTONEG=][,LOSPROP=][,TS=][,MODULETYPE=][,CHANNEL=][
,STPID=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 285


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-1GBE

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition out of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: AINSTMR, Automatic In-Service Timer, specifies how long an
input signal must be present on the facility without a failure
condition before the system transitions the facility into the
In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value

286 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-1GBE Issue 1, December 2011

MM indicates the time duration in minutes. The


maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

ENCMODE= Value Description


{GFP-T,GFP-F}

Default: <Previously provisioned value>


Addressing: None
Description: The parameter encmode describes the encapsulation mode used
to transport the client signal.
GFP-F Generic Framing Protocol Framed encapsulation
option (ITU-T G.7041)
GFP-T Generic Framing Protocol - Transparent
encapsulation option.
This parameter does not apply to the 11STGE12 , 11DPE12,
11DPE12E and 4DPA2 OTs.
For the 11STMM10 and 4DPA4 OTs, only GFP-T is supported.

ERRFRMDROP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: Attribute that controls whether inbound error frames are discarded
or passed.
This attribute is meaningful only for GFP transport modes.
This parameter does not apply to the 11STGE12, 11DPE12
,11DPE12E, 4DPA4 and 4DPA2 OTs.
For 11STMM10 OT value ENABLED is not supported.

AUTONEG= Value Description


{ENABLED, DISABLED}

Default: <Previously provisioned value>

1830PSS R3.6.50 - TL1 Commands and Messages 287


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-1GBE
Addressing: None
Description: Attribute that controls status of auto-negotiation.
The AUTONEG parameter applies only to the 11STGE12 OT.
This parameter does not apply to the 11STMM10 OT. It does not
apply to the 4DPA4 and 4DPA2 OT.

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.
Parameter LOSPROP does not apply to 4DPA2.

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13,16,19,22,25,2
8} (11STMM10 timeslots)
{L1,L2}-({1,2}) (4DPA4 timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4 : Timeslot assignment on the specified Line port (L1 or
L2). Timeslot 1 represents the eight odd timeslots of ODU0 #1
within the specified line. (Timeslots 1,3,5,7,9,11,13,15.) Timeslot
2 represents the eight even timeslots of ODU0 #2 within the
specified line. (Timeslots 2,4,6,8,10,12,14,16.)
Parameter TS does not apply to 4DPA2.
This parameter does not apply to the 11STGE12 OT.
This parameter does not apply to the 11DPE12 and 11DPE12E
OTs.

288 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-1GBE Issue 1, December 2011

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 1000B-LX, 1000B-SX,
1000B-T, 1000B-ZX, SL-16.2C,
SL-16.2D, SS-16.1A, SS-16.2C
,GE-BX20D, GE-BX20U, GE-BX40D,
GE-BX40U}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified GBE port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Restrictions: SS-16.2C is not supported on 11STGE12
OT.
1000B-ZX is not supported on
4DPA2 OT.
SL-16.2C, SS-16.2C, and
SL-16.2D are the only types supported on the line port
of 4DPA2 OT.
SL-16.2D is not supported
on the client ports of 4DPA2 , 4DPA4 , 11STMM10 and
11STGE12, 11DPE12, 11DPE12E OTs.
GE-BX20D, GE-BX20U,
GE-BX40D, GE-BX40U are supported only on 4DPA4 and
11DPM12 client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the port.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: None
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 289


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-1GBE
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter only applies to 11DPM12.

CONTAINER= Value Description


{None, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

290 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-1GBE Issue 1, December 2011

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SAIS Statis, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-1GBE


command.
ED-1GBE:NODE-1:11STMM10-1-5-C1:xyz123:::encmode=GFP-T:ODU1-L1-1-25:I
S,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

1830PSS R3.6.50 - TL1 Commands and Messages 291


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-1GBE
RELATED COMMANDS
RTRV-1GBE
RST-1GBE
DLT-1GBE
ENT-1GBE
RMV-1GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

292 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-CBR2G5


Command Name: ED-CBR2G5

PURPOSE
The ED-CBR2G5 command creates (assigns and provisions) a specified CBR2G5 client signal facility.
Executing an ED-CBR2G5 command causes primary and secondary state transitions for the specified
CBR2G5 facility. Primary and secondary states associated with the CBR2G5 facility after the command
is executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then CBR2G5 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when CBR2G5 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a CBR2G5 is provisioned to an OOS-MA state, a MAN condition type is set for the specified
port. When an CBR2G5 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 10CBR2G5
transmission condition types or performance monitoring threshold crossing alerts are autonomously
reported for the CBR2G5 signal, but alarm conditions are monitored and performance monitoring data
is collected (if provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-CBR2G5:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,MAPPING
MODE=][,SDTH=][,SFTH=][,J0_EX=][,J0_FMT=][,TRCCMP=][,LOSPROP=][,TS=]
[,MODULETYPE=][,CHANNEL=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

1830PSS R3.6.50 - TL1 Commands and Messages 293


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CBR2G5

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


{SYSTEM}

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

294 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CBR2G5 Issue 1, December 2011

MAPPINGMODE= Value Description


{BITSYNC,ASYNC}

Default: <previously established value>


Addressing: None
Description: Type of mapping of CBR2G5 into an ODU1 strucutre

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for SD defect decalration.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
decalration.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.

1830PSS R3.6.50 - TL1 Commands and Messages 295


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CBR2G5

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 section trace comparison. This parameter enables and
disables comparison between the incoming J0 section trace value
and the provisioned (i.e., expected) J0 value.
ENABLED Enable compare
DISABLED Disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment on the Line port <ODU1#>-<Time Slot within
ODU1>. The entire string must be enclosed in double-quotes.

MODULETYPE= Value Description


{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SS-16.1A,
SS-16.2C}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified CBR2G5 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.

296 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CBR2G5 Issue 1, December 2011

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 297


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CBR2G5
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-CBR2G5


command.
ED-CBR2G5:NODE-1:11STMM10-1-5-C1:xyz123:::moduletype=user:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

298 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CBR2G5 Issue 1, December 2011

RELATED COMMANDS
RTRV-CBR2G5
RST-CBR2G5
DLT-CBR2G5
ENT-CBR2G5
RMV-CBR2G5

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 299


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CBR2G5

300 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-CBRAR


Command Name: ED-CBRAR

PURPOSE
The ED-CBRAR command modifies an existing CBRAR (SDSDI,HDSDI,3GSDI or FE) client signal
facility.
Executing an ED-CBRAR command causes primary and secondary state transitions for the specified
CBRAR facility. Primary and secondary states associated with the CBRAR facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then CBRAR enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when CBRAR is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a CBRAR is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an CBRAR is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no CBRAR transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
CBRAR signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-CBRAR:[TID]:AID:[CTAG]:::DATATYPE=[,AINSREF=][,AINSTMR=][,DESCR=]
[,LOSPROP=][,MODULETYPE=][,CHANNEL=][,TS=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 301


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CBRAR
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DATATYPE= Value Description


{HDSDI, FE, SDSDI, 3GSDI}

Default: Entry required


Addressing: None
Description: Specifies the client signal type. Must equal the value previously
assigned by ENT-CBRAR. Cannot be modified.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <previously provisioned value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

302 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CBRAR Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <previously provisioned value>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

LOSPROP= Value Description


{LASERON, LASEROFF}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when far end failure gets
signaled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 100BLX10, FE-BX40D,
FE-BX40U} (for DATATYPE = FE)
{AUTO, USER, SL-16.2C, SS-16.1A,
SS-16.2C} (for DATATYPE =
HDSDI)
{AUTO, USER, SL-16.2C, SS-16.1A,
SS-16.2C} (for DATATYPE =
SDSDI)
{AUTO,USER,3GSDI-SH,3GSDI-MH}
(for DATATYPE=3GSDI)

Default: <previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified CBRAR port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.

1830PSS R3.6.50 - TL1 Commands and Messages 303


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CBRAR

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1490, 1530, 1550} (B&W
wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port.
Restriction: 1490 and 1530 B&W wavelengths can be used only for 4DPA4
client ports.

TS= Value Description


{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: <previously provisioned value>


Addressing: None
Description: Timeslot assignment on the specified Line port. The entire string
must be enclosed in double-quotes. Timeslots are numbered 1-16
within the ODU1 on each line. HDSDI requires 10 timeslots. FE
requires 1 timeslot. <ts_list> can include a list of individual
timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None,ODU0, ODU1,ODUF}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
Set to odu1-mapping into ODU1 per G.709.
Set to oduf-mapping into ODUF per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <previously provisioned value>

304 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CBRAR Issue 1, December 2011

Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent

1830PSS R3.6.50 - TL1 Commands and Messages 305


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CBRAR
• this command is issued with a DATATYPE value that does not match the provisioned signal type

• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

• this command is issued with a number of timelots that does not agree with the signal type

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SABT Status, Aborted


• the requested timeslots are not available

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is unassigned

EXAMPLES

The following example shows the successful execution of a ED-CBRAR


command.
ED-CBRAR:NODE-1:4DPA4-2-5-C1:xyz123:::DATATYPE=HDSDI,TS="L2-(1,3,5-8
,13-16)":IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBRAR
RST-CBRAR
DLT-CBRAR
ENT-CBRAR
RMV-CBRAR

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

306 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-CRS-OCH


Command Name: EDIT PHOTONIC CROSS CONNECTION
(PXC)

PURPOSE
The ED-CRS-OCH command provides user access to the parameters of a cross connect object.

INPUT FORMAT

ED-CRS-OCH:[TID]:<FROM>,<TO>:[CTAG]::[FTWK=][,TFWK=]:[PST];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 307


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-OCH

FROM Value Description


AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

308 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-OCH Issue 1, December 2011

FROM Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEIN-{9605, (AM2125A LINEIN Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,

1830PSS R3.6.50 - TL1 Commands and Messages 309


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-OCH

FROM Value Description


9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
RA2P-<shelf>-<slot>-LINEIN-{9605, (RA2P Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)

310 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-OCH Issue 1, December 2011

FROM Value Description


SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: Entry required


Addressing: None
Description: From Access Identifier, identifies the entity access identifier of
either end of a optical connection for BI cross connections. FROM
identifies the entity that is inbound from the network for a UNI
cross connection.

1830PSS R3.6.50 - TL1 Commands and Messages 311


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-OCH

TO Value Description
AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

312 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-OCH Issue 1, December 2011

TO Value Description
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEOUT-{96 (AM2125A LINEOUT Channels)
05, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,

1830PSS R3.6.50 - TL1 Commands and Messages 313


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-OCH

TO Value Description
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}

314 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-OCH Issue 1, December 2011

TO Value Description
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: Entry required


Addressing: None
Description: To Access Identifier, identifies the entity access identifier of either
end of a optical connection for BI cross connections. TO identifies
the entity that is outbound to the network for a UNI cross
connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: Entry required.


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

FTWK= Value Description


{REKEY,"(K1,K2)"}

Default: Current Value


Addressing: None.
Description: Change the Wavelength Tracker keys for the specified cross
connection in the FROM --> TO direction.
REKEY means select new keys using the automatic mechanism
K1,K2 is used for manual keying. K1 and K2 are integers in the
range 0<K<4096
If the current value is UNKEYED, it cannot be changed.

TFWK= Value Description


{REKEY,"(K1,K2)"}

Default: Current Value


Addressing: None.
Description: Change the Wavelength Tracker keys for the specified cross
connection in the TO --> FROM direction.
REKEY means select new keys using the automatic mechanism
K1,K2 is used for manual keying. K1 and K2 are integers in the
range 0<K<4096
If the current value is UNKEYED, it cannot be changed.

1830PSS R3.6.50 - TL1 Commands and Messages 315


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-OCH

PST Value Description


{IS, OOS}

Default: Current Value


Addressing: None.
Description: Primary state of the cross-connect.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
EATN Equipage, Not Valid for Access Type.
• FTWK is specified and the FROM port is not equipped with a wavelength tracker encoder

• TFWK is specified and the TO port is not equipped with a wavelength tracker encoder

IENE Input, Entity does Not Exist

316 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-OCH Issue 1, December 2011

• either of the endpoints specified by FROM or TO is not provisioned

SRQN Status, iNvalid ReQuest


• either FTWK or TFWK parameter change from UNKEYED to REKEY or K1,K2, or from keyed to
unkeyed

EXAMPLES
In the following example, a two-way optical connection is renamed between ports
ALPHG-1-2-LINE-9220 (FROM) and 11STAR1-3-2-L1 (TO)

ED-CRS-OCH:CLAPTON::ALPHG-1-2-LINE-9220,11STAR1-3-2-L1:CMD123::BI:;

CLAPTON 07-01-11 11:11:11


M CMD123 COMPLD
;

RELATED COMMANDS
DLT-CRS-OCH
ED-CRS-OCH
RTRV-CRS-OCH

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 317


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-OCH

318 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-CRS-<ODUK>


Command Name: EDIT CROSS-CONNECTION

PURPOSE
The ED-CRS-<ODUk> command allows for editing the cross-connection attributes that has been
previously set up between the specified facilities..
This command does not allow the change of the CCT (1WAY <-> 2WAY).

INPUT FORMAT

ED-CRS-<ODUk>:[TID]:FROM,TO:[CTAG]::[CCT]:[CKTID=];

INPUT PARAMETERS

ODUk Value Description


{OPTSG,ODU0,ODU1,ODUFFC400,O
DUF3GSDI}

Default: Entity Required


Addressing: None
Description: The ODUk indicates the rate on which the command acts.

TID Value Description


<VALID TID VALUE>

Default:<SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID
for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 319


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-ODUK

FROM Value Description


Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing:None

Description: AID of connection point; Indicates the FROM (receive side from
the network, source of cross-connection) facility of the
cross-connection.

320 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-ODUK Issue 1, December 2011

TO Value Description
Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing:None

Description: AID of connection point; Indicates the TO (transmit side from the
network, sink of cross-connection) facility of the cross-connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CCT Value Description


{1WAY, 2WAY}

Default: 2WAY

1830PSS R3.6.50 - TL1 Commands and Messages 321


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-ODUK
Addressing: None
Description: Cross-connection Type;The CCT is used for addressing the
cross-connection only. It can't be changed.
1WAY One-way cross-connection (unidirectional
cross-connection)
2WAY Two-way cross-connection (bidirectional
cross-connection)

CKTID= Value Description


< 0-45 VALID CKTID CHARACTERS >

Default: NULL string


Addressing: None
Description: Circuit ID assigned to the cross-connection. 0 to 45 ASCII
characters within enclosing double quotes. Semicolon, asterisk,
greater-than, less-than, double quote, and backslash characters
are prohibited. Empty double quotes (i.e. “”) indicate a NULL string.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

322 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-ODUK Issue 1, December 2011

Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Input, Invalid ACcess identifier
• the used AID in FROM does not match for the rate

• the used AID in TO does not match for the rate

• the ports specified by FROM and TO are not cross connected to each other in the direction
specified

• the specified CCT does not match the CCT of the addressed cross-connection

EXAMPLES
The following example illustrates the command when following ODU1 cross connections shall be
edited for CKTID:
1WAY 11DPM12-1-2-L1-ODU2ODU1#1 and 11DPM12-1-2-C1-ODU1 CKTID=CC2

ED-CRS-ODU1::11DPM12-1-2-L1-ODU2ODU1#1,11DPM12-1-2-C1-ODU1:xyz123::1
WAY:CKTID="CC2";

RELATED COMMANDS
ENT-CRS-<ODUk>
RTRV-CRS-<ODUk>
DLT-CRS-<ODUk>

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 323


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-ODUK

324 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-CRS-VTS


Command Name: ED-CRS-VTS

PURPOSE
The ED-CRS-VTS command modifies an ethernet connection setting previously provisioned using the
ENT-CRS-VTS command.
This command applies to 11DPE12 and 11DPE12E pack. The number of virtual time slots and
connection is different with the working mode of 11DPE12 and 11DPE12E.

INPUT FORMAT

ED-CRS-VTS:[TID]:FROM,TO:[CTAG]:::[CIR=][,EIR=][,CBS=][,EBS=]:[PST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

FROM Value Description


11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the head of a Ethernet connection.
When 11DPE12 working under fullrate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.

1830PSS R3.6.50 - TL1 Commands and Messages 325


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-VTS
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under subrate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

TO Value Description
11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the tail of a Ethernet connection.
When 11DPE12 working under fullrate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under subrate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

326 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-VTS Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CIR= Value Description


{ 0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 50 under qinq
working mode for 11DPE12 pack ( the
unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 100 under subrate
working mode for both 11DPE12 and
11DPE12E packs ( the unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
portfor 11DPE12E pack add/drop
service with the step of 5Mbps for the
range of 1Mbps-100Mbps;50Mbps for
the range of 100Mbps-1Gbps under
qinq working mode. (the unit is Mb/S)
{0-10000}for 11DPE12E qinq pass
through service with the step of 5 Mbps
for the range of 10 Mbps-100Mbps;50
Mbps for the range of
100Mbps-1Gbps;500 Mbps for the
range of 1Gbps-10Gbps.(the unit is
Mb/S)

Default: None
Addressing: None
Description: the Committed Information Rate.
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

1830PSS R3.6.50 - TL1 Commands and Messages 327


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-VTS

EIR= Value Description


{ 0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 50 under qinq
working mode for 11DPE12 pack ( the
unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 100 under subrate
working mode for both 11DPE12 and
11DPE12E packs ( the unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
portfor 11DPE12E pack add/drop
service with the step of 5Mbps for the
range of 1Mbps-100Mbps;50Mbps for
the range of 100Mbps-1Gbps under
qinq working mode. (the unit is Mb/S)
{0-10000}for 11DPE12E qinq pass
through service with the step of 5 Mbps
for the range of 10 Mbps-100Mbps;50
Mbps for the range of
100Mbps-1Gbps;500 Mbps for the
range of 1Gbps-10Gbps.(the unit is
Mb/S)

Default: None
Addressing: None
Description: the Excess Information Rate.
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

CBS= Value Description


{16, 32, 64, 128, 256, 512, 1024, 2048,
4096, 8192, 16384} ( the unit is kB )

Default: None
Addressing: None
Description: the Committed Burst Size
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.

328 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-CRS-VTS Issue 1, December 2011

EBS= Value Description


{16, 32, 64, 128, 256, 512, 1024, 2048,
4096, 8192, 16384} ( the unit is kB )

Default: None
Addressing: None
Description: the Excess Burst Size
This parameter only apply to the 11DPE12 working in Subrate
mode.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 329


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-CRS-VTS
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the command is issued with no matched ethernet connection provisioned

IDNV Input, Data Not Valid


• this command is issued with the value in FROM equals to TO

• this command is issued with FROMVTS or TOVTS whose virtual time slot is out of range under
the specified working mode

EXAMPLES

In the following example, a two-way ethernet connection is edited


for a 11DPE12 client port 1, virtual time slot 1 and line port 1,
virtual time slot 1:
ED-CRS-VTS:NODE-1:11DPE12-1-7-C1-VTS1,11DPE12-1-7-L1-VTS1:xyz123::::
CIR=100, CBS=1024;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CRS-VTS
DLT-CRS-VTS
ENT-CRS-VTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

330 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-DAT


Command Name: EDIT NE DATE AND TIME

PURPOSE
The ED-DAT command manually sets the system date and time.
Changing the date or time is not allowed while NTP is enabled
Note: changing the date and time of the system could result in partial or incomplete PM data.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-DAT:[TID]::[CTAG]::DATE,TIME:[TZOFFSET=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

DATE Value Description


{ 05-59}-{ 01-12 }-{ 01-31}

Default: Entry Required


Addressing: None
Description: Date, identifies the new system date in the format of
<YY>-<MM>-<DD>.
Restrictions: Valid combinations of month and day are as follows.

1830PSS R3.6.50 - TL1 Commands and Messages 331


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-DAT

MM DD (during non-leap DD (during leap


years) years)
01 {01-31}
02 {01-28} {01-29}
03 {01-31}
04 {01-30}
05 {01-31}
06 {01-30}
07 {01-31}
08 {01-31}
09 {01-30}
10 {01-31}
11 {01-30}
12 {01-31}

TIME Value Description


{ 00-23 }-{ 00-59 }-{ 00-59 }

Default: Entry Required


Addressing: None
Description: Time, identifies the new system time in the format of
<HH>-<MM>-<SS>. The entered value should be the actual
desired local time to be displayed by the NE, not modified by any
offset.

TZOFFSET= Value Description


UTC{-14 through +12}-{00,15,30,45}
<1-64 CHARACTER TIMEZONE NAME
STRING>

Default: The factory default is +00-00.


Addressing: None
Description: The offset time to apply to NTP server's UTC time. This value will
affect the presentation of time to the user. Either a numeric string
or a name chosen from those available in the timezone catalog
(like America/New_York) can be specified. Fixed offsets must be
in 15 minute increments

332 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-DAT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IPNV Input, Parameter Not Valid
• any invalid combinations of <YY>-<MM>-<DD> appear in the DATE parameter

SNVS Status, Not in Valid State


• NTP is enabled

EXAMPLES
In the following example, the system date and time are set to July 27, 2005 and 10:34:56, respectively.

ED-DAT:::::05-07-27,10-34-56;

The output response is shown below.

1830PSS R3.6.50 - TL1 Commands and Messages 333


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-DAT

AM1520 05-07-27 10:34:56


M P19003 COMPLD
/* ED-DAT:::::05-07-27,10-34-56 [P19003] (5)*/
;

RELATED COMMANDS
RTRV-HDR

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG
REPT^EVT^EQPT

334 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-EQPT-FW


Command Name: EDIT FIRMWARE PROVISIONING
INFORMATION FOR A CARD

PURPOSE
The ED-EQPT-FW command allows a user to specify the firmware profile to be used with a circuit
card. Executing this command changes the provisioned firmware profile for the target card. The card
so provisioned will obtain the newly provisioned firmware images upon the next cold reset. Including
the RELOAD directive immediately causes the card to download and install the new firmware image(s).

INPUT FORMAT

ED-EQPT-FW:[TID]:AID:[CTAG]:::[PROFILE=][,RELOAD=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 335


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT-FW

AID Value Description


EC-<shelf>-<slot> (Firmware Loadable Cards)
FLC-<shelf>-<slot>
MT0C-<shelf>-<slot>
AHPHG-<shelf>-<slot>
AHPLG-<shelf>-<slot>
ALPFGT-<shelf>-<slot>
ALPHG-<shelf>-<slot>
A2325A-<shelf>-<slot>
AM2017B-<shelf>-<slot>
AM2125A-<shelf>-<slot>
AM2125B-<shelf>-<slot>
AM2318A-<shelf>-<slot>
AM2325B-<shelf>-<slot>
RA2P-<shelf>-<slot>
OSCT-<shelf>-<slot>
CWR-<shelf>-<slot>
WR-<shelf>-<slot>
MESH-<shelf>-<slot>
OPS-<shelf>-<slot>
112SA1L-<shelf>-<slot>
112SCA1-<shelf>-<slot>
112SNA1-<shelf>-<slot>
112SX10L-<shelf>-<slot>
112SCX10-<shelf>-<slot>
112SNX10-<shelf>-<slot>
43STA1P-<shelf>-<slot>
43SCA1-<shelf>-<slot>
43SCX4-<shelf>-<slot>
43SCX4E-<shelf>-<slot>
43SCX4L-<shelf>-<slot>
43STX4P-<shelf>-<slot>
43STX4-<shelf>-<slot>
11DPE12-<shelf>-<slot>
11DPE12E-<shelf>-<slot>
11DPM12-<shelf>-<slot>
11STAR1-<shelf>-<slot>
11STMM10-<shelf>-<slot>
11STGE12-<shelf>-<slot>
4DPA4-<shelf>-<slot>
4DPA2-<shelf>-<slot>
11QPA4-<shelf>-<slot>
11QTA4-<shelf>-<slot>
11STAR1A-<shelf>-<slot>
MVAC-<shelf>-<slot>
SVAC-<shelf>-<slot>
WTOCM-<shelf>-<slot>

Default: Entry Required


Addressing: None
Description: The AID of the card to be reprovisioned.

336 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-EQPT-FW Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

PROFILE= Value Description


<string>

Default: Current Value


Addressing: None
Description: This parameter allows the provisioning
of a particular firmware profile for the specified
card. The format is a string consisting of three
positive integer fields separated by the dot character
".". The first field indicates a major version number,
the second a minor version number, and the third
(optional) field is a reserved integer field.
Major versions indicate a change in register map or
function that is often not backward compatible.
Minor versions indicate a software backward compatible
change.
Consult the user documentation and release notes for
more information on software/firmware compatibility.
RELOAD=

RELOAD
Default: No Value
Addressing: None
Description: This flag directs the card to unconditionally reload the provisioned
firmware profile.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 337


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT-FW
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV, Input, Data Not Valid
• the command is entered with an invalid value for a parameter

EXAMPLES
The following example illustrates the command for changing the provisioned firmware for a card.

ED-EQPT-FW:NODE-1:11STGE-2-2:ctag12345:::PROFILE=1.1.1,RELOAD=RELOAD
;
NODE-1 03-07-08 09:04:33
M ctag12345 COMPLD
/*
ED-EQPT-FW:NODE-1:11STGE12-2-2:ctag12345:::PROFILE=1.1.1,RELOAD=RELO
AD [ctag12345] (2) */
;

RELATED COMMANDS
RTRV-EQPT-FW
RTRV-LIB-FW

RELATED AUTONOMOUS RESPONSES


None

338 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-EQPT


Command Name: EDIT EQUIPMENT

PURPOSE
The ED-EQPT command modifies provisioning parameters for the specified equipment. ED-EQPT
modifies the parameters for:
General Equipment
• System
• Shelf (SHELF with type = UNV, SFD, DCM, or ITL)
• First Level Controller (FLC)
• Matrix Zero (MT0C)
• Bus Termination Card (BTC)
• Shelf Equipment Controller (EC)
• Customer Interface Panel (USRPNL)
• Power Supply Filter (PF)
• Fan (FAN)
Active DWDM Circuit Packs
• Line Driver - LD (ALPHG, AHPHG, AHPLG, ALPFGT, A2325A, AM2017B, AM2325B, AM2125A,
AM2125B, AM2318A, RA2P)
• Optical Supervisory Channel (OSCT)
• Wavelength Tracker Optical Channel Monitoring Card (WTOCM)
• Colorless Wavelength Router (CWR8, CWR8-88)
• Wavelength Router (WR8-88A, WR2-88A)
• Mesh Card (MESH4)
• Optical Translator - OT (112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10, 112SX10L
11STAR1, 11STMM10, 11STGE12, 43STX4, 43STX4P, 43SCX4L, 43SCX4, 43SCA1, 43STA1P,
4DPA4, 4DPA2, 11QPA4, 11DPE12, 11DPE12E, 11DPM12, 11STAR1A)
• Optical Translator - OT
• (112SA1L, 112SCA1, 112SCX10, 112SNA1, 112SNX10, 112SX10L,
• 11DPE12, 11DPE12E, 11DPM12, 11QPA4, 11QPEN4, 11QTA4, 11STAR1,
11STAR1A, 11STGE12, 11STMM10,
• 4DPA2, 4DPA4 )
• Variable Attenuator Card (SVAC, MVAC)
• Optical Protection Switch (OPS)
• Static Filter DWDM (SFD5/8)
• Static Filter CWDM (SFC2/4/8)
Passive DWDM Modules
• SFD44. The SFD44 is modeled as the fixed "card" in an SFD44 "shelf" with only one "slot". But
physically, the SFD44 card/shelf are not separable. ED-EQPT modifies SFD44 shelf parameters
if addressed to the shelf, and modifies SFD44 card parameters if addressed to the card.

1830PSS R3.6.50 - TL1 Commands and Messages 339


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT
• SFD40. The SFD40 is modeled as the fixed "card" in an SFD40 "shelf" with only one "slot". But
physically, the SFD40 card/shelf are not separable. ED-EQPT modifies SFD40 shelf parameters
if addressed to the shelf, and modifies SFD40 card parameters if addressed to the card.
• SFD44B. The SFD44B is modeled as the fixed "card" in an SFD44B "shelf" with only one "slot".
But physically, the SFD44B card/shelf are not separable. ED-EQPT modifies SFD44B shelf
parameters if addressed to the shelf, and modifies SFD44B card parameters if addressed to the
card.
• SFD40B. The SFD40B is modeled as the fixed "card" in an SFD40B "shelf" with only one "slot".
But physically, the SFD40B card/shelf are not separable. ED-EQPT modifies SFD40B shelf
parameters if addressed to the shelf, and modifies SFD40B card parameters if addressed to the
card.
• DCM. The DCM is modeled as the fixed "card" in a DCM "shelf" with only one "slot". But
physically, multiple DCM modules of several sizes fit into a single housing. ED-EQPT modifies
DCM shelf parameters if addressed to the shelf, and modifies DCM card parameters if addressed
to the card.
• ITLB/ITLU. The ITLB/ITLU is modeled as the fixed "card" in an ITLB/ITLU "shelf" with only one
"slot". But physically, multiple ITLB/ITLU and DCM modules of several sizes fit into a single
housing. ED-EQPT modifies ITLB/ITLU shelf parameters if addressed to the shelf, and modifies
ITLB/ITLU card parameters if addressed to the card.
Executing an ED-EQPT command causes primary and secondary state transitions for the specified
equipment. Primary and secondary states associated with the equipment after the command is
executed depend upon values entered for PST, SST and the events detected by the system.

The State transitions for equipments are described in Appendix G of IOM.

If the PST is set to IS the command behaves like RST-EQPT.


If the PST is set to OOS and SST is set to MT, the command behaves like RMV-EQPT.
The successful completion of the command shall cause REPT^DBCHG autonomous messages.

INPUT FORMAT

ED-EQPT:[TID]:AID:[CTAG]:::[DESCR=][,HIGHTEMPTH=][,LOWTEMPTH=][,TEMP
TOL=][,EXPECTED_AMPS=][,PROVSERNUM=][,CONNECTIVITY=][,DCMDISTANCE=][
,FIBERTYPE=][,CARDMODE=][,CARDRATE=][,TPID=][,STPID1=][,STPID2=][,ST
PID3=][,STPID4=][,FLOWCM=][,FANSPEED=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

340 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-EQPT Issue 1, December 2011

AID Value Description


SYSTEM (System AID)
SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
BTC-<shelf>-<slot> (BTC Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
USRPNL-1-<slot> (User Panel)
PF-<shelf>-<slot> (Power Filter)
FAN-<shelf>-<slot> (Fan)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 341


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT

AID Value Description


4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)

Default: Entry required


Addressing: None
Description: Equipment Access Identifier, identifies the equipment entity access
identifier

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

DESCR= Value Description


<0-255 CHARACTER ASCII STRING>

Default: <previously existing value>


Addressing: None
Description: User description of the equipment.
Enclose the string in double quotes if it contains non-alphanumeric
characters.

342 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-EQPT Issue 1, December 2011

HIGHTEMPTH= Value Description


{-5-90} (Celsius)
{23-194} (Fahrenheit)

Default: <previously existing value>


Addressing: None
Description: Temperature (in degrees Celsius/Fahrenheit) at which a high
temperature alarm is raised. Applies to EC, FLC, MTX, LD,
MESH, OSC, OPS, OT, PF, VAC, WR, and WTOCM circuit packs.

LOWTEMPTH= Value Description


{-5-90}(Celsius)
{23-194} (Fahrenheit)

Default: <previously existing value>


Addressing: None
Description: Temperature (in degrees Celsius/Fahrenheit) at which a low
temperature alarm is raised. Applies to EC, FLC, MTX, LD,
MESH, OSC, OPS, OT, PF, VAC, WR, and WTOCM circuit packs.

TEMPTOL= Value Description


{0-10} (Celsius)
{0-18} (Fahrenheit)

Default: <previously existing value>


Addressing: None
Description: Number of degrees Celsius/Fahrenheit above the low temperature
threshold or below the high temperature threshold at which a
temperature alarm clears. Applies to EC, FLC, MTX, LD, MESH,
OSC, OPS, OT, PF, VAC, WR, and WTOCM circuit packs.

EXPECTED_AMPS Value Description


=
{AUTO, 20, 30, 35, 50, 60, 70}

Default: <previously existing value>


Addressing: None
Description: Applies only to Universal shelves. The expected current rating of
the shelf power supply modules. (For PSS-36, the value is not
provisionable.) For PSS-32, the valid values are AUTO, 20, 30,
50, 60, 70. For PSS-16, the valid values are AUTO, 20, 35.

1830PSS R3.6.50 - TL1 Commands and Messages 343


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT

PROVSERNUM= Value Description


<0-16 CHARACTER ASCII STRING>

Default: <previously existing value>


Addressing: None
Description: Expected serial number. Applies to SFD44, SFD44B, ITL and
DCM shelves only.

CONNECTIVITY= Value Description


REQUIRED Managed SFD/DCM/ITL shelf
NOTREQUIRED Unmanaged SFD/DCM/ITL shelf

Default: <previously existing value>


Addressing: None
Description: Shelf connectivity indicates whether or not the SFD/DCM/ITL shelf
is expected to be read/managed via the serial electrical inventory
wire. This is needed because the distance limit of the wire is short
enough that some customers will need to locate the SFD/DCM/ITL
beyond the distance limit. When CONNECTIVITY=REQUIRED,
inventory readability indicates presence/absence. When
CONNECTIVITY=NOTREQUIRED, the SFD/DCM/ITL is referred
to as "unmanaged", and is treated as always present, even though
there is no communication.

DCMDISTANCE= Value Description


[10|20|30|40|50|60|70|80|90|100|110|12
0|130|140]

Default: <previously existing value>


Addressing: None
Description: Specifies the Compensation distance for the equipped DCM when
the DCM is unmanaged.

FIBERTYPE= Value Description


SSMF
ELEAF
TWRS

Default: SSMF
Addressing: None
Description: Specifies the Compensation fiber type for the equipped DCM when
the DCM is unmanaged.

344 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-EQPT Issue 1, December 2011

CARDMODE= Value Description


DUALTRAN
FLEXMUX
SONETSDH
OTU3

Default: <previously existing value>


Addressing: None
Description: Specify the working mode of the board. Applies only to 4DPA4 OT.
Changing the cardmode automatically clears any non-default
provisioning of firmware release (package identifier), and
automatically triggers a cold restart of the card to download the
default version of the firmware line corresponding to the new
cardmode.
It applies to 43SCA1 (SONETSDH and OTU3 values)

CARDRATE= Value Description


FULLRATE
SUBRATE
QINQ

Default: QINQ
Addressing: None
Description: Specify the working rate of the board. Applies only to 11DPE12
and 11DPE12E OT.
This parameter only applies to 11DPE12 and 11DPE12E pack.
For R3.5, the only value supported for CARDRATE is QINQ.

TPID= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x88A8
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12 pack working under
QINQ mode.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

1830PSS R3.6.50 - TL1 Commands and Messages 345


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT

STPID1= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x88A8
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

STPID2= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default:0x8100
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

STPID3= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default:0x9100
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.

346 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-EQPT Issue 1, December 2011

This parameter only applies to 11DPE12E pack working under


QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

STPID4= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default:0x9200
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

FLOWCM= Value Description


APS/PCC
CCM

Default:APS/PCC
Addressing: None
Description: Specify flow continuity monitoring attributes when pack is in QinQ
mode.
This parameter only applies to 11DPE12E pack.

FANSPEED= Value Description


NORMAL
MAXIMUM

Default: NORMAL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 347


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT
Description: Fan Speed. This parameter sets the fan speed for maintenance
activities. When FANSPEED=NORMAL, the fan speed is
controlled automatically by the system for normal operation. When
FANSPEED=MAXIMUM, the fan runs at constant full speed for
maintenance operations.
This parameter only applies to the FAN AID.

PST Value Description


IS
OOS

Default: <Previously-existing value>


Addressing: None
Description: Primary State. Does not apply to SYSTEM, SHELF. Cannot be
set on USRPNL, PF, FAN, BTC. Cannot be set to OOS on the
active FLC, MT0C, or EC in a shelf.

SST Value Description


MT Maintenance

Default: <Previously-existing value>


Addressing: None
Description: Secondary State. Does not apply to SYSTEM,
SHELF. Cannot be set on USRPNL, PF, FAN, BTC. Cannot be
set on the active FLC, MT0C, or EC in a shelf.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

348 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-EQPT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
EQWT Card Type Mismatch.
• the command is input for an AID which is different from the one provisioned in the corresponding
slot

IDNC PST/SST Inconsistent


• SST is being set to MT while PST=IS or PST is being set to IS

IDNV Input, Data Not Valid


• the ED-EQPT command is entered with CARDRATE=SUBRATE for a 11DPE12 pack: working
under FULLRATE or QINQ and provisioned with ethernet connection between ports(For example,
by ENT-CRS-VTS or ED-CRS-VTS command)

• the ED-EQPT command is entered with CARDRATE=FULLRATE for a 11DPE12 pack: working
under SUBRATE or QINQ mode and provisioned with ethernet connection between ports(For
example, by ENT-CRS-VTS or ED-CRS-VTS)

• the ED-EQPT command is entered with CARDRATE=QINQ for a 11DPE12 pack: working under
SUBRATE or FULLRATE mode and provisioned with ethernet connection between ports(For
example, by ENT-CRS-VTS or ED-CRS-VTS)

• the ED-EQPT command is entered with CARDRATE=FULLRATE for a 11DPE12 pack: working
under SUBRATE or QINQ mode and provisioned with VLAN ID map for client/line port virtual time
slots(For example, by ENT-VTS or ED-VTS command)

IENE Entity Not Exist.


• the equipment entity is not provisioned

IPNV PST/SST cannot be set for the specified AID.


• PST or SST is being set for SYSTEM, SHELF, BTC, USRPNL, PF, or FAN

1830PSS R3.6.50 - TL1 Commands and Messages 349


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-EQPT
SABT Request Failed - Invalid request for EC or common equipment.
• the ED-EQPT command is entered with PST=OOS or SST=MT for the active FLC, MT0C, or EC
in a shelf

• the ED-EQPT command is entered with PST=OOS for a circuit pack with one or more ports
currently administratively in-service

SAIS Status, Already In Service


• PST=IS and the equipment entity is already in IS or OOS-AU state

SAPR Status, already in protection state.


• the ED-EQPT command is entered to change the CARDRATE mode for a 11DPE12 pack already
provisioned with a ESNCP group

EXAMPLES
The following command performs logical removal for an OT.

ED-EQPT::11STAR1-2-5:::::OOS;

RELATED COMMANDS
DLT-EQPT
ENT-EQPT
RMV-EQPT
RST-EQPT
RTRV-EQPT

350 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-FC100


Command Name: ED-FC100

PURPOSE
The ED-FC100 command creates (assigns and provisions) a specified FC client signal facility.
Executing an ED-FC100 command causes primary and secondary state transitions for the specified
FC100 facility. Primary and secondary states associated with the FC100 facility after the command is
executed depend upon value entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC100 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility FC100 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FC100 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FC100 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC100 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC100 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-FC100:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,FCMODE=]
[,LOSPROP=][,MODULETYPE=][,CHANNEL=][,TS=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 351


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC100
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition our of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

352 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC100 Issue 1, December 2011

FCMODE= Value Description


{FIBRE_CHANNEL, FICON,
ISC3_PEER_MODE}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls FC interface type (Fibre Channel compliant
with INCITS x.320 or FICON).
ISC3_PEER_MODE applies only to 4DPA4.

LOSPROP= Value Description


{LASERON,LASEROFF}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 2FCLC-L, 2FCSN-I,
4FCLC-L, 4FCSN-I, SS-16.1A}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FC100 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Note: 4DPA4 supports only 4FCLC-L and 4FCSN-I.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port.

1830PSS R3.6.50 - TL1 Commands and Messages 353


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC100

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13,16,19,22,25,2
8,31} (11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
FC100 requires 7 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

354 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC100 Issue 1, December 2011

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service

1830PSS R3.6.50 - TL1 Commands and Messages 355


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC100
• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-GFC


command.
ED-FC100:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-1-25:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC100
RST-FC100
DLT-FC100
ENT-FC100
RMV-FC100

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

356 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-FC1200


Command Name: ED-FC1200

PURPOSE
The ED-FC1200 command modifies the specified facility parameter values previously provisioned
using the ENT-FC1200 command.
Executing an ED-FC1200 command causes primary and secondary state transitions for the specified
FC1200 facility. Primary and secondary states associated with the FC1200 facility after the command
is executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC1200 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when FC1200 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an FC1200 is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types are
cleared and a MAN condition type is set for the specified 10GFC. The MAN condition type is cleared
when the FC1200 is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the FC1200 is
deleted.
When an FC1200 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC1200 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC1200 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the FC1200 signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-FC1200:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,CHANNEL
=][,MODULETYPE=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 357


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC1200
Default: Entry Required
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition out of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously-existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum value is 96-00. The minimum value is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

358 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC1200 Issue 1, December 2011

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <Previously-existing value>


Addressing: None
Description: Specifies the channel frequency of the client port.

MODULETYPE= Value Description


{AUTO, USER, 10GB-SR, XI-64.1,
XS-64.2C, XL-64.2C}

Default: <Previously existing value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified FC1200 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

LOSPROP= Value Description


<LASEROFF, LASERON>

Default: <Previously existing value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

PST Value Description


{IS,OOS}

Default: <Previously-existing value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

1830PSS R3.6.50 - TL1 Commands and Messages 359


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC1200

SST Value Description


{AINS,AINS-DEA, MT}

Default: <Previously-existing value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State

360 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC1200 Issue 1, December 2011

• the facility specified in the AID field is unassigned

• this command is issued with PST of IS, SST of either <No Value> or AINS and the facility is under
loopback, i.e. carries a LPBK secondary state,

• this command is issued with secondary state of AINS or AINS-DEA, and current PST/SST is
shown in Table above as a deny scenario,

EXAMPLES

The following example shows the successful execution of a ED-FC1200


command.
ED-FC1200:NODE-1:11STAR1-1-5-C1:123456:::moduletype=XI-641:IS,AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-FC1200
RST-FC1200
DLT-FC1200
ENT-FC1200
RMV-FC1200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 361


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC1200

362 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-FC200


Command Name: ED-FC200

PURPOSE
The ED-FC200 command creates (assigns and provisions) a specified FC client signal facility.
Executing an ED-FC200 command causes primary and secondary state transitions for the specified
FC200 facility.Primary and secondary states associated with the FC200 facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC200 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility FC200 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FC200 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FC200 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC200 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC200 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-FC200:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,FCMODE=]
[,LOSPROP=][,MODULETYPE=][,CHANNEL=][,TS=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 363


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC200
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition out of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

364 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC200 Issue 1, December 2011

FCMODE= Value Description


{FIBRE_CHANNEL, FICON,
ISC3_PEER_MODE}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls FC interface type (Fibre Channel compliant
with INCITS x.320 or FICON).
ISC3_PEER_MODE applies to 4DPA4 and 11DPM12.

LOSPROP= Value Description


{LASERON,LASEROFF}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 2FCLC-L, 2FCSN-I,
4FCLC-L, 4FCSN-I, SS-16.1A}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FC200 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Note: 4DPA4 supports only 4FCLC-L, 4FCSN-I and SS-16.1A.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port.

1830PSS R3.6.50 - TL1 Commands and Messages 365


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC200

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13}
(11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
FC200 requires 14 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None, ODU1}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu1-mapping into ODU1 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

366 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC200 Issue 1, December 2011

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service

1830PSS R3.6.50 - TL1 Commands and Messages 367


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC200
• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-FC200


command.
ED-FC200:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-1-25:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC200
RST-FC200
DLT-FC200
ENT-FC200
RMV-FC200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

368 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-FC400


Command Name: ED-FC400

PURPOSE
The ED-FC400 command creates (assigns and provisions) a specified FC400 client signal facility.
Executing an ED-FC400 command causes primary and secondary state transitions for the specified
FC400 facility. Primary and secondary states associated with the FC400 facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC400 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility FC400 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FC400 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FC400 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC400 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC400 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-FC400:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,FCMODE=]
[,LOSPROP=][,MODULETYPE=][,CHANNEL=][,TS=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 369


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC400
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

370 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC400 Issue 1, December 2011

FCMODE= Value Description


{FIBRE_CHANNEL,FICON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls FC interface type (Fibre Channel compliant
with INCITS x.320 or FICON).

LOSPROP= Value Description


{LASERON,LASEROFF}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 4FCLC-L, 4FCSN-I}

Default: <Previously existing value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FC400 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port.

1830PSS R3.6.50 - TL1 Commands and Messages 371


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC400

TS= Value Description


ODU1-L1-{1-2}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{3}-{1,4,7,10,13,16,19,22,25}
(11STMM10 timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment on the Line port <ODU1#>-<Time Slot within
ODU1>. The entire string must be enclosed in double-quotes.
Restriction : Parameter TS does not apply to 4DPA4 when
cardMode=DualTran.

CONTAINER= Value Description


{None, ODUF}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to oduf-mapping into ODUF with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

372 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC400 Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

1830PSS R3.6.50 - TL1 Commands and Messages 373


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC400
EXAMPLES

The following example shows the successful execution of a ED-FC400


command.
ED-FC400:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-1-25:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC400
RST-FC400
DLT-FC400
ENT-FC400
RMV-FC400

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

374 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-FC800


Command Name: ED-FC800

PURPOSE
The ED-FC800 command modifies the specified facility parameter values previously provisioned using
the ENT-FC800 command.
Executing an ED-FC800 command causes primary and secondary state transitions for the specified
FC800 facility. Primary and secondary states associated with the FC800 facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC800 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when FC800 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an FC800 is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types are
cleared and a MAN condition type is set for the specified FC800. The MAN condition type is cleared
when the FC800 is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the FC800 is deleted.
When an FC800 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC800 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC800 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the FC800 signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-FC800:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,CHANNEL=
][,MODULETYPE=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 375


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC800

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition out of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously-existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum value is 96-00. The minimum value is
00-01.

376 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC800 Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <Previously-existing value>


Addressing: None
Description: Specifies the channel frequency of the client port.

MODULETYPE= Value Description


{AUTO, USER, X8FCLC-L, X8FCSN-I}

Default: <Previously existing value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified FC800 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

LOSPROP= Value Description


<LASEROFF, LASERON>

Default: <Previously existing value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

PST Value Description


{IS,OOS}

1830PSS R3.6.50 - TL1 Commands and Messages 377


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC800
Default: <Previously-existing value>
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


{AINS,AINS-DEA, MT}

Default: <Previously-existing value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

378 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FC800 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is unassigned

• this command is issued with PST of IS, SST of either <No Value> or AINS and the facility is under
loopback, i.e. carries a LPBK secondary state,

• this command is issued with secondary state of AINS or AINS-DEA, and current PST/SST is
shown in Table above as a deny scenario,

EXAMPLES

The following example shows the successful execution of a ED-FC800


command.
ED-FC800:NODE-1:112scx10-1-5-C1:123456:::moduletype=XI-641:IS,AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-FC800
RST-FC800
DLT-FC800
ENT-FC800
RMV-FC800

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 379


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FC800

380 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-FE


Command Name: ED-FE

PURPOSE
The ED-FE command creates (assigns and provisions) a specified FE client signal facility.
Executing an ED-FE command causes primary and secondary state transitions for the specified FE
facility. Primary and secondary states associated with the FE facility after the command is executed
depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FE enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility FE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FE is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 10FE transmission condition
types or performance monitoring threshold crossing alerts are autonomously reported for the FE
signal, but alarm conditions are monitored and performance monitoring data is collected (if provisioned
for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-FE:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,AUTONEG=][,
LOSPROP=][,MODULETYPE=][,SSMTRANS=][,SYNCEOPPMODE=][,CHANNEL=][,STPI
D=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 381


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FE
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer is used for automatic
in-service transition out of AINS.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: AINSTMR, Automatic In-Service Timer, specifies how long an
input signal must be present on the facility without a failure
condition before the system transitions the facility into the
In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

382 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FE Issue 1, December 2011

AUTONEG= Value Description


{ENABLE, DISABLE}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of auto-negotiation. This parameter
applies to electrical FE SFP ,optical FE SFP does not support this .

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.
MODULETYPE=
{AUTO, 100BFX,100BLX10, 1000B-T2}
Default: AUTO
Default: <Previously provisioned value>
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FE port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
Restrictions: 100BFX is only supported on 11DPE12
OT.
100BLX10 and 1000B-T2 are
only supported on 11DPE12E OT.

SSMTRANS= Value Description


IN SDH mode :
{ACT, PRC, SSU_A, SSU_B, SEC,
DNU,NONE}

in SONET mode :
{ACT, PRS,STU, ST2, ST3E, ST3,DUS
,NONE}

Default: ACT
Addressing: None
Description: Attribute that defines the SSM/Quality Level Transmission in the
port

1830PSS R3.6.50 - TL1 Commands and Messages 383


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FE
This parameter shall only apply to the 11DPE12E for
sync-e function.
NOTE:This parameter only takes effect only when pack
SYNCE function is set to enable.

SYNCEOPPMODE Value Description


=
{SYNC,NON-SYNC}

Default: SYNC
Addressing: None
Description: Attribute that defines port Synchronous Ethernet Operation Mode
This parameter shall only apply to the 11DPE12E for SYNC-E
fucntion.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the port. This parameter
applies to optical FE SFP ,electrical FE SFP does not support this .

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: STPID1
Address: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

384 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FE Issue 1, December 2011

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 385


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FE
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SAIS Statis, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-FE


command.
ED-FE:NODE-1:11DPE12E-1-5-C1:xyz123::::IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FE
RST-FE
DLT-FE
ENT-FE
RMV-FE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

386 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-FFP-EQPT


Command Name: EDIT FACILITY PROTECTION GROUP

PURPOSE
The ED-FFP-EQPT command edits a 1+1 facility protection group (Y-cable only). OPS and E-SNCP
protection groups do not have modifiable parameters because they are always unidirectional and
non-revertive.)
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-FFP-EQPT:[TID]:WORKING_AID,PROTECTION_AID:[CTAG]:::[PSDIRN=][,RVR
TV=][,WTR=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

WORKING_AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 387


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FFP-EQPT
Description: The working port AID.

PROTECTION_AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: The protection port AID.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: <System assigned CTAG value>


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

PSDIRN= Value Description


UNI Unidirectional
BI Bidirectional

Default: <previously existing value>


Addressing: None
Description: Protection switching directionality. In unidirectional switching, local
and remote ends switch independently. Y-cable, OPS, and
E-SNCP protection groups support unidirectional operation. In
bidirectional switching, local and remote ends are coordinated by
an end-to-end protocol so that both are on working, or both are on
protection. Only Y-cable protection groups support bidirectional
operation. Both ends of a Y-cable circuit must be provisioned the
same way. A mismatch will cause an alarm.

388 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-FFP-EQPT Issue 1, December 2011

RVRTV= Value Description


N No
Y Yes

Default: <previously existing value>


Addressing: None
Description: Indicates whether or not switching operation is revertive. In
non-revertive switching, protection remains active after working
has recovered from the failure that caused the automatic switch to
protection, or after the user switch-to-protection command is
cleared. Y-cable, OPS, and E-SNCP protection groups support
non-revertive operation. In revertive switching, traffic is
automatically switched back to working when working has
recovered from the failure that caused the automatic switch to
protection, or when the user switch-to-protection command is
cleared. In the failure-recovery case, the switch back is delayed by
the WTR parameter. In the case of clearing a user switch
command, there is no delay. Only bidirectional Y-cable protection
groups support revertive operation. Both ends of a Y-cable circuit
must be provisioned the same way.
Restriction: Parameter value RVRTV=Y does not
apply to 43SCX4, 43SCX4E, 43STA1P, 43STX4,
43STX4P OTs (always non-revertive).

WTR= Value Description


{1-20}

Default: <previously existing value>


Addressing: None
Description: Wait-To-Restore. Affects switching behavior only when
RVRTV=Y. (But the WTR value can be provisioned even if
RTRV=N.) The protection group will wait until working has been
continuously clear for this number of minutes before switching
back to working.
Restriction: Parameter WTR will have no effect for
43SCX4, 43SCX4E, 43STA1P, 43STX4, 43STX4P
OTs (always non-revertive).

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 389


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-FFP-EQPT
OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• unidirectional switching and revertive switching are both specified

IENE Input, Entity does Not Exist


• the specified protection group does not exist

EXAMPLES
The following example edits a Y-cable protection group.

ED-FFP-EQPT:ALU-1830PSS:11STMM10-5-2-C4,11STMM10-5-3-C4:123456:::WTR
=20;

RELATED COMMANDS
DLT-FFP-EQPT
ENT-FFP-EQPT
RTRV-FFP-EQPT

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

390 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-GCC


Command Name: EDIT GCC NETWORK INTERFACE

PURPOSE
The ED-GCC command creates a network interface on a specified GCC channel on an optical port for
data communication purposes. The system will support one GCC channel: GCC0. Only one channel
can be active at any given time per given port. The GCC is identified by means of the OT port AID and
can be enabled or disabled.
A maximum of 32 GCC0 channels can be provisioned on the NE.
The system will also support GCC1, GCC2 channel on some optical port. However only one channel
can be terminated on one port.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-GCC:[TID]:AID:[CTAG]:::[GCCCHNL=][,STATUS=][,OSPF_HELLOINT=][,OSP
F_DEADINT=][,OSPF_METRIC=][,PKTTYPE=][,MTU=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 391


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-GCC

AID Value Description


11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)

Default: <Entry required>


Addressing: None
Description: Access IDentifier, specifies the port of the OT.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

GCCCHNL= Value Description


GCC0
GCC1
GCC2

Default: GCC0
Addressing: None
Description: GCC channel type. The default value is GCC0. This parameter
specifies the GCC type used on the optical port with OTU facility.
Line Ports of 11QPA4,11QTA4, 11DPE12, 11DPE12E, 11DPM12
are required to support all three types of GCC channel.
Other OTs' ports have only supported GCC0.

392 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-GCC Issue 1, December 2011

STATUS= Value Description


ENABLE
DISABLE

Default: <previous value>


Addressing: None
Description: Status of the GCC Channel. The initial default is disabled. This
parameter specifies whether the target GCC is enabled or
disabled. If enabled, the interface will be used for management
traffic, and OSPF will be enabled. The interface can be enabled or
disabled with this command option.

OSPF_HELLOINT= Value Description


{1-65535}

Default: <10>
Addressing: None
Description: HELLO INTERVAL of the OSPF interface, in units of seconds.
This is the time elapsed before the next HELLO PDU is sent.

OSPF_DEADINT= Value Description


{1-65535}

Default: <40>
Addressing: None
Description: DEAD INTERVAL of the OSPF interface, in units of seconds. The
DEAD INTERVAL is a timer used to timeout inactive adjacencies.
The DEAD INTERVAL value must always be greater than the
HELLO INTERVAL value.

OSPF_METRIC= Value Description


{1-65535}

Default: <40> for OTU1 interfaces. Default is <30> for OTU2 interfaces.
Addressing: None
Description: METRIC or cost of the OSPF interface, in units of seconds.

PKTTYPE= Value Description


{nonstd, std}

Default: <nonstd> for the 11DPE12, 11STAR1, 11STMM10, and 4DPA4


OTs. Default is <std> for the 11QPA4, 11QTA4, 11DPE12E and

1830PSS R3.6.50 - TL1 Commands and Messages 393


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-GCC
11DPM12 OTs. Only <std> can be provisioned for 11QPA4 and
11QTA4, 11STAR1A, 11DPE12E, 11DPM12.
Addressing: None
Description: PACKET TYPE. This parameter indicates if the packet is standard
(std) or non-standard (nonstd).
If the PKTTYPE=std, the MTU size parameter can be configured.

If the PKTTYPE=nonstd, the MTU size parameter is always the default value.

MTU= Value Description


{576 - 1500}

Default: <1473> for the 11DPE12, 11STAR1, 11STMM10 and 4DPA4 OTs.
The default is <1500> for the 11QPA4 , 11QTA4, 11STAR1A,
11DPE12E and 11DPM12 OTs.
Addressing: None
Description: MTU, Maximum Transmission Unit, in units of bytes.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

394 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-GCC Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the command is issued with a specified GCC type which can not been supported on the AID port

IENE Input, Entity does Not Exist


• a GCC entry is attempted on a non-existent OT

IIAC Invalid Access Identifier


• the specified AID does not exist or does not conform to the specified format

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

SSRE Status, System Resources Exceeded


• all 32 GCC resources are used

EXAMPLES

RELATED COMMANDS
RTRV-GCC

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 395


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-GCC

396 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-IP-IF


Command Name: EDIT INTERNET PROTOCOL INTERFACE

PURPOSE

The ED-IP-IF command sets the TCP/IP stack parameters for a single
interface (Tunnel, serial interface, LAN etc...), for the system
(Host ID), or for the control plane node (CP node address, CP notify
address).
In addition to enabling the port for service, the user can also set
the specified port to support DHCP Server, and if so, the range of
IP pool to use. The following interfaces can be set using this
command:

• SYSTEM

• OAMP

• VoIP

• E1
• E2
• CIT

• ES1 (this is for the extension shelf, port 1)

• ES2 (this is for the extension shelf, port 2)

An IP address for the SYSTEM must be set prior to connection into the NE via remote methods. Until it
is set, only local access will be allowed. Once the Loopback IP is set, remote TL1, CLI, WEB, and
SNMP commands may be sent to the NE using the provisioned IP interface.
The TL1 port numbers that shall be used to access the NE are the following:
• port 3082 for raw encoding unsecure mode

• port 3083 for telnet encoding unsecure mode

1830PSS R3.6.50 - TL1 Commands and Messages 397


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IP-IF

The configured IP address on System AID is the NE's loopback IP


address, which is shared as interface address by all unnumbered
network interfaces.
The configured IP address on System AID will be also used as OSPF
Router ID.
The configured IP address on control plane node AID is used as GMRE
control plane node address. This address has to be provisioned,
before the GMRE control plane is started on the NE. This address is
used by the control plane for communicating with direct neighbors.
The configured IP address on control plane notify AID is used as
GMRE control plane notify address. This address has to be
provisioned, before the GMRE control plane is started on the NE.
This address is used by the control plane for communicating RSVP-TE
notify messages to LSP head nodes.
The parameters configurable for single network interfaces are:
- IP addresses, netmasks, hostnames, and default gateway addresses
for LAN interfaces
- DHCP server parameters for LAN interfaces
- Proxy ARP configuration for LAN interfaces
This command is supported for the following single network
interfaces:
- LAN-OAMP: the OAMP faceplate LAN connector on the active main
shelf FLC and USRPNL card
- This is intended for connecting the NE to the DCN for central
management
- LAN-CIT: the CIT faceplate LAN connector on one of the main shelf
FLC and EC cards
- This is intended for locally connecting a craft interface terminal
(ZIC).
- The ZIC can always reach the active FLC, even when plugged into
the inactive FLC's frontplate
- LAN-VOIP: the VOIP faceplate LAN connector on the active main
shelf MTX/USRPNL card for VOIP telephne.
- This can be used as a general purpose LAN in this release
- LAN-E1: the E1 faceplate LAN connector on the active main shelf
MTX/USRPNL card
- This can be used as a general purpose LAN in this release for
exteranal equipment (eg; RAMAN Amplifier)
- LAN-E2: the E2 faceplate LAN connector on the active main shelf
MTX/USRPNL card for exteranal equipment (eg; RAMAN Amplifier)
- This can be used as a general purpose LAN in this release

The CIT, E1, E2, and VoIP ports shall support DHCP Server.
The OAMP, VoIP, E1, E2, and CIT ports will also support PROXYARP. This is used, for example,
when all NEs belong within one large subnet. In this scenario, the PROXYARP will allow the
management system to see all of the remote NEs IP addresses. When enabled, the OAMP port of the
GNE will reply back to ARP requests for all RNEs with its own MAC address. Thus, the management
system will see multiple IP addresses, but one MAC. This is analogous to IP overloading on an
interface.
After making the change, verify that the change was made correctly using the RTRV-IP-IF command.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

398 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IP-IF Issue 1, December 2011

INPUT FORMAT

ED-IP-IF:[TID]:AID:[CTAG]:::[STATUS=][,IP=][,MASK=][,NAME=][,PROXYAR
P=][,DHCPSERVER=][,IPRANGE=][,DHCPDFLTGATEWAY=][,SNMPSRC=][,AUTOSTAT
E=][,AUTOSTATEINTERVAL=][,AUTOSTATECNT=][,AUTOSTATEIP=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


SYSTEM (System AID)
EC-1-<slot>-{ ES1, ES2} (Shelf Controller Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (Shelf Controller Ports, non-main
shelves)
MT0C-{1-24}-{11,15}-{ES1,ES2} (ports
on PSS-36 extension shelves Second
Level Controller)

CPN (Local Control Plane Node)


CPNOTIFY (Local Control Plane Notify
Interface)
LAN-{OAMP, CIT, VOIP, E1, E2}
(Customer LAN)

Default: <entry required>


Addressing: None
Description: Addresses a network interface for
which to edit the IP related parameters for MTOC, EC
ethernet interfaces.
When addressing the SYSTEM AID, the loopback address
of the system can be set. The loopback address is used
as interface address by all unnumbered interfaces, and
is also used as OSPF router ID.

When addressing the CPN AID, the control plane node address of
the system can be set. This address is used to communicate
RSVP-TE and OSPF-TE messages to direct control plane

1830PSS R3.6.50 - TL1 Commands and Messages 399


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IP-IF
neighbors.

When addressing the CPNOTIFY AID, the control plane notify


address of the system can be set. This address is used by the
control plane node to communicate RSVP-TE notify messages to
LSP head nodes.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

STATUS= Value Description


ENABLE
DISABLE

Default: <Previously existing value> <system default DISABLE>


Addressing: None
Description: The Status of the port. The initial system default is DISABLE for all
ports except those described herein. For the CIT port, the system
default is ENABLE. For the ES1 and ES2 ports, the system default
is ENABLE on all shelves. After it is set, the value will always
assume this set value until it is modified by another ED-IP-IF
command.

IP= Value Description


0-0-0-0
{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <Previously existing value>


Addressing: None
Description: Internet Protocol address, it is the IP address of the target AID.
The address 0-0-0-0 is allowed along with the "MASK" value
0-0-0-0 within the same TL1 command for the OAMP, VOIP, E1,
and E2 ports port, when it is desired to set the IP address to the
default value of 0-0-0-0. If this value is not set, the target AID shall
retain the old value.
Note: The CIT port will be defaulted with an internal IP addressing
scheme, but it can also be overwritten and assigned an IP
address. The CIT port on the Master Shelf Active EC, VoIP, E1, E2
ports on USRPNL will dole out an IP address to the connected

400 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IP-IF Issue 1, December 2011

laptop/device when DHCP is enabled. The ES1 and ES2 ports on


all ECs of the NE cannot be assigned IP addresses. They can only
be enabled or disabled.

MASK= Value Description


{128-255}-{0-255}-{0-255}-{0-255} (For CIT port only)
{0-255}-{0-255}-{0-255}-{0-255} (For other ports)

Default: <Previously existing value>


Addressing: None
Description: Mask, it is the subnet mask of the provisioned target AID. The
mask, in binary representation, must contain a contiguous string of
1s (the network portion) and a contiguous string of 0s (the host
portion). The MASK 0-0-0-0 is allowed only for the OAMP, VoIP,
E1, and E2 ports and only when the IP value is set to 0-0-0-0
within the same TL1 command. If this is not set, the system shall
retain the old value. This value (IP=0-0-0-0 and mask= 0-0-0-0)
indicates that the port is not configured to a valid IP address.
Note: The Mask parameter does not apply to the ES1/ES2 ports.

NAME= Value Description


<1-15 ASCII CHARACTERS>

Default: <Previously existing value>


Addressing: None
Description: Name, it is the descriptive network name of the specified Ethernet
Interface. This parameter is not applicable to ES1 and ES2 ports.

PROXYARP= Value Description


ENABLE
DISABLE

Default: <Previously existing value> <system default DISABLE>


Addressing: None
Description: This parameter is applicable only when the AID is OAMP, VOIP,
E1, E2, and CIT. By enabling this service, the port shall support
the Proxy ARP function. The port of the local NE shall reply back to
ARP requests from the remote server for all RNEs within the
internal network, using its own MAC address for the response.

DHCPSERVER= Value Description


ENABLE
DISABLE

Default: <Previously existing value>

1830PSS R3.6.50 - TL1 Commands and Messages 401


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IP-IF
Addressing: None
Description: By enabling this service, the port specified by the AID shall support
DHCP Server function. Clients connected to this port shall be able
to send bootp or DHCP request and obtain an IP address.

IPRANGE= Value Description


{1-10}

Default: <Previously existing value> <default = 1>


Addressing: None
Description: This parameter is valid only
when DHCPSERVER is enabled. This is the range of the
IP pool for the DHCP server. For the CIT port, the
default value is 1 when the DHCPSERVER parameter is
enabled. The port can dole out from 1 to up to 10 IP
addresses. The assigned IP address for the client is
one of the available addresses starting from the
network address range (1 to 254) as long as the
assigned IP address does not conflict with broadcast
and the local addresses.
Examples: (IPRANGE = 5 and subnet mask = \24)
1. If the provisioned CIT port IP address is
192.168.5.1/24, the available addresses are
192.168.5.2,3,4,5,6
2. If the provisioned CIT port IP address is
192.168.5.5/24, the available addresses are
192.168.5.1,2,3,4,6
3. If the provisioned CIT port IP address is
192.168.5.96/24, the available addresses are
192.168.5.1,2,3,4,5

4. If the provisioned CIT port IP address is


192.168.5.253/24, the available addresses are
192.168.5.1,2,3,4,5

DHCPDFLTGATE Value Description


WAY=
ENABLE
DISABLE

Default: <Previously existing value> <system default ENABLE>


Addressing: None
Description: Distributes this interface's IP address as the Default
Gateway via DHCP. If not enabled no Default Gateway IP address
will be distributed via DHCP on this interface. This parameter is

402 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IP-IF Issue 1, December 2011

applicable to VOIP, E1, E2, and CIT ports.

SNMPSRC= Value Description


ENABLE
DISABLE

Default: <Previously existing value> <system default DISABLE>


Addressing: None
Description: This parameter is applicable to
“SYSTEM” AID only.

snmp_src set to disable: SNMP requests can be made


using any of the NE’s interface IP addresses or
Loopback IP address. The source IP address in SNMP
trap/reply messages shall be the interface IP address
on which the packet leaves the NE. Hence it is the
SNMP client’s responsibility to be able to associate
an NE with multiple IP addresses.
snmp_src set to enable: SNMP requests can be made
using ONLY the NE’s Loopback IP address. The source
IP address in SNMP trap/reply messages shall be fixed
as the Loopback IP. Hence SNMP clients need only have
a single association to the NE’s Loopback IP address.

AUTOSTATE= Value Description


ENABLE
DISABLE

Default: <Previously existing value> <system default DISABLE>


Addressing: None
Description: This parameter is applicable to
“CIT” AID only. This parameter controls the CIT port
's state (enable/disable) autonomously.

AUTO-STATE set to enable or disable: it shall set CIT


port state either enable or disable autonomously on
different conditions as described below:

1. The CIT port shall be disable if the NE detects the source IP is reachable.
2. The CIT port shall be enable autonomously when the communication can not be reached to the
management system (source IP) within defined period which can be provisioned.
3. When an user manually configures the CIT port Admin State, the AUTOSTATE shall be set to
"disable" by Software.
4. When a user manually disables the AUTOSTATE the Admin STATE shall be “ENABLE”
(default value) by the SW.
5. AUTO state cannot be enabled until the Source IP is configured

1830PSS R3.6.50 - TL1 Commands and Messages 403


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IP-IF

AUTOSTATEINTE Value Description


RVAL=
{10-7200}

Default: <Previously existing value> <30 seconds>


Addressing: None
Description: While monitoring AUTOSTATEIP reachability the
AUTOSTATEINTERVAL value is used as interval. The monitoring
is active only when AUTOSTATE is provisioned as “enable”.

AUTOSTATECNT= Value Description


{5-10000}

Default: <Previously existing value> <10>


Addressing: None
Description: This counter value is to check the number of consecutive counts
that AUTOSTATEIP is not reachable which results in CIT admin
port being enabled if AUTOSTATE is enabled. CIT admin port will
be down as a result of AUTOSTATEIP successfully reachablity on
any given AUTOSTATEINTERVAL attempt if AUTOSTATE is
enabled.

AUTOSTATEIP= Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <Previously existing value>


Addressing: None

404 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IP-IF Issue 1, December 2011

Description: This is the Source IP address and is to


be monitored from NE with the interval configured by
autoStateInterval parameter. If NE can not be reached
the source IP for the count configured by AutoStateCnt
parameter then there is loss communication with
management system and subsequent action is taken
(enabling the the CIT port adminState). This address
may be OMS IP address.
Set the IP address. Enter this keyword followed by an
IP address or enter this keyword without any
parameters to display the current IP address.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the IP parameter and the MASK parameters are not specified together for all AIDs

• the target AID is ES1 or ES2, and any parameter other than STATUS is entered

1830PSS R3.6.50 - TL1 Commands and Messages 405


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IP-IF
• the AID is anything other than the AID for the CIT, VoIP, E1, E2 port, and DHCPSERVER is
enabled

• the IPRANGE parameter is provisioned when the DHCPSERVER parameter is not enabled

• the specified IP address parameter and MASK parameter are 0-0-0-0 within the same TL1
command for any AID other than OAMP, VoIP, E1, E2 ports

• PROXYARP is provisioned for an interface other than OAMP, VOIP, E1, E2, and CIT

• SNMPSRC is provisioned for an interface other than SYSTEM

• the GMRE Node IP and Notify IP addresses are configured as the same or one IP address

• the GMRE Node IP and Notify IP addresses are already configured from default initial value
(0-0-0-0) then it is again configured back to default address (0-0-0-0)

IDRG Invalid Data Range


• at least one among the IP and MASK parameters does not satisfy the previously specified ranges

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

EXAMPLES
In the following example, ED-IP-IF provisions the VoIP, E1, E2 port to have an IP address on a class D
network with a subnet of 2 hosts.

ED-IP-IF::LAN-VOIP:C0001:::STATUS=enable,
IP=192-168-1-1,NAME=VoicePhone, MASK=255-255-255-252;

A successful response for that command would be:

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
/* ED-IP-IF::LAN-VOIP:C0001:::STATUS=enable,
IP=192-168-1-1,NAME=VoicePhone, MASK=255-255-255-252 (5) */
;

In the following example, ED-IP-IF provisions the CIT port to have an IP address on a class D network
with a subnet of 2 hosts. DHCP Server function is enabled, so if a laptop is connected to this CIT port,
it will be doled an IP address belonging to the subnet of this CIT port. Naturally, the laptop's IP address
would be 192.168.1.2

406 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IP-IF Issue 1, December 2011

ED-IP-IF::LAN-CIT:C0001:::STATUS=enable, IP=192-168-1-1,NAME=CIT,
MASK=255-255-255-252, DHCPSERVER=enable, IPRANGE=1;

A successful response for that command would be:

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
/* ED-IP-IF::LAN-CIT:C0001:::STATUS=enable, IP=192-168-1-1,NAME=CIT,
MASK=255-255-255-252, DHCPSERVER=enable, IPRANGE=1 [C0001] (5) */
;

RELATED COMMANDS
RTRV-IP-IF

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 407


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IP-IF

408 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-IPACL-FILTER


Command Name: EDIT IP ACCESS CONTROL LIST FILTER
DESCRIPTION.

PURPOSE
The ED-IPACL-FILTER command can be used either to add additional ACL patterns to an existing
filter or to remove an ACL pattern from an existing filter.
An ACL Filter is an ordered list of patterns. A filter consists of a sorted list of (index, pattern) pairs,
where the index indicates the relative position in the list and the pattern indicates the pattern identifier.
When a packet is tested against a filter, it is tested against each pattern starting with the lowest index
and continuing through each remaining pattern in ascending order until a match occurs.
Up to 100 filters may be defined on the system, and each filter may contain up to 256 (index, pattern)
pairs. Internal memory allocation bounds limit the number of simultaneously defined (index, pattern)
pairs across all filters to 4000.
If the matching pattern specifies an action of “block” or “pass,” the packet is dropped or permitted to
pass, respectively, and the progression through the filter list terminates.
If a packet that normally would have been forwarded to another interface is blocked, and an
ICMP-error “true” behavior was specified for the matching pattern, an ICMP 3/13 error will be
generated for transmission to the host originating the blocked packet.
If all patterns in a filter list are tested without yielding a match, then the packet is blocked or passed
according to the ACL global default setting. There are two global default settings, one for received
packets and the other for transmitted packets. These attributes can be provisioned via the SET-IPACL
command.
IP ACL filters are constructed one filter at a time. When a pattern is added to a filter, an index is
specified that indicates the position of the pattern in this filter’s list (please note that the index is not a
property of the pattern itself, as the pattern may have other indices associated with it in other filters). If
a pattern is added to a filter with an index that is already occupied in that filter, the prior pattern defined
at that index is replaced by the new pattern. In order to re-number entries in the filter list, the pattern
must be deleted from the list and re-added via the ED-IPACL-FILTER command.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-IPACL-FILTER:[TID]::CTAG::FILTERID,PATTERNID,INDEX,[ACTION];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 409


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-FILTER

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

FILTERID Value Description


{100-199}
<1-30 VALID FILTERID
CHARACTERS>

Default: Entry Required


Addressing: None
Description: Identifier for the ACL filter being configured. Could be either an
integer in the range 100-199 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter , which uniquely identifies the filter being configured.

PATTERNID Value Description


{1-256}
<1-30 VALID PATTERNID
CHARACTERS>

Default: Entry required


Addressing: None
Description: The identifier of the ACL pattern to being added to/removed from
the specified filter. Could be either an integer in the range 1-256 or
a string of up to 30 case-sensitive alphanumeric characters, where
the first character is always a letter, which is selected by the user
to uniquely identify the pattern in subsequent provisioning
requests.

INDEX Value Description


{1-256}

Default: Entry required


Addressing: None
Description: Integer, 1 - 256, representing the insertion point for the specified
pattern in the filter list. If there is already a pattern defined at the
specified index, the new pattern entry will replace the previous one.

410 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IPACL-FILTER Issue 1, December 2011

ACTION Value Description


ADD
REMOVE

Default: ADD
Addressing: None
Description: Action to take on the specified filter. The operator could add
(default) or remove a pattern from a specified filter.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• PATTERNID to be deleted is not associated to the specified filter

IENE Input, Entity does Not Exist


• FILTERID corresponds to an undefined filter

1830PSS R3.6.50 - TL1 Commands and Messages 411


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-FILTER
• PATTERNID corresponds to an undefined pattern

SABT Status, Aborted


• PATTERNID to be added is already associated to the filter

SSRE Status, System Resources Exceeded


• maximum number of patterns associated to the filter is reached

EXAMPLES
In this example, the ACL filter #1 is updated, pattern #1 is added to it, with 1 as associated index:

ED-IPACL-FILTER:NODE-1::C0001::1,1,1;

A successful response for that command would be:

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
/* ED-IPACL-FILTER:NODE-1::::1,1,1 [C0001] (5) */
;

RELATED COMMANDS
DLT-IPACL-FILTER
ENT-IPACL-FILTER
RTRV-IPACL-FILTER

RELATED AUTONOMOUS RESPONSES


None.

412 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-IPACL-IF


Command Name: EDIT IP ACCESS CONTROL LIST
INTERFACE DESCRIPTION.

PURPOSE
The ED-IPACL-IF command can be used to associate (or disassociate) filters with particular physical
network interfaces (but not logical sub-interfaces). Two filters may be associated with each interface,
one receive and one transmit. The receive and transmit filters on an interface may be independently
enabled and disabled on that interface without disassociating the specific filter numbers.
Once a filter is associated to an interface, it cannot be associated to other interfaces.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-IPACL-IF:[TID]:AID:[CTAG]::DIRN,[FILTERID],[STATUS];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 413


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-IF

AID Value Description


LAN-{OAMP, VOIP, E1, E2} (Customer
LAN)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)

Default: Entry required


Addressing: None
Description: Access Identifier of the physical interface to which an ACL filter is
applied.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DIRN Value Description


RX
TX

414 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IPACL-IF Issue 1, December 2011

Default: Entry Required


Addressing: None.
Description: Direction on the specified network interface to which the filter will
be associated. Valid values:
RX apply filter to the receive direction only
TX apply filter to the transmit direction only

FILTERID Value Description


{100-199}
<1-30 VALID FILTERID
CHARACTERS>

Default: <null>
Addressing: None
Description: Identifier for the ACL Filter being associated with the specified
interface and direction. Could be either an integer in the range
100-199 or a string of up to 30 case-sensitive alphanumeric
characters, where the first character is always a letter ,
representing an existing ACL Filter that was added via the
ENT-IPACL-FILTER command. If omitted (null), the filter will be
disassociated from the interface.

STATUS Value Description


ENABLED
DISABLED

Default: DISABLED
Addressing: None.
Description: IP Fragmentation. Valid values:
ENABLED enable the filter associated with the specified
interface/direction
DISABLED disable the filter associated with the
specified interface/direction (default)

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 415


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-IF
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IEAE Input, Entity Already Exists
• filter is already associated to the interface identified by the AID in the specified direction

IENE Input, Entity does Not Exist


• FILTERID corresponds to an undefined filter

SAAS Status, Already ASsigned


• filter is already associated to another interface than the one identified by the AID

EXAMPLES
In this example, filter #1 was previously defined to block TCP packets on port 23 originating from
10.17.0.46. This filter is associated to the OAMP interface, on the Rx direction:

ED-IPACL-IF:NODE-1:USRPNL-1-1-OAMP:C0001::RX,1,ENABLED;

A successful response for that command would be:

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
/* ED-IPACL-IF:NODE-1:LAN-OAMP:::RX,1,ENABLED [C0001] (5) */
;

RELATED COMMANDS
RTRV-IPACL-IF

416 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IPACL-IF Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 417


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-IF

418 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-IPACL-PATTERN


Command Name: EDIT EXISTING IP ACCESS CONTROL
LIST PATTERN DESCRIPTION.

PURPOSE
The ED-IPACL-PATTERN command can be used to modify an existing IP ACL Pattern that has been
provisioned on the system.
An ACL Pattern is a set of packet field descriptors that can be tested against a packet. For a pattern to
match, each of its field descriptors must fit the data in the packet. The fields that may be tested are:
• Source IP address (or range)
• Destionation IP address (or range)
• TCP/UDP destination port
• IP protocol
• IP fragmentation
• ICMP type and code
• Whether or not a TCP packet belongs to an “established” connection
Each field test is optional: a pattern may specify only some (or no) fields to test. Each pattern also has
an associated action to take when the pattern matches: block or pass. Regardless of the specific
action, a match count associated with the pattern is incremented whenever a match occurs. If a
pattern specifies a block action, it may also specify an ICMP error reporting behavior, which effects
generation of ICMP 3/13 errors for forwarded packets that are blocked. Combination of filterID and
patternID shall not exceed 4000.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-IPACL-PATTERN:[TID]::[CTAG]::PATTERNID,ACTION,[ICMPERROR],[SRCADD
R],[SRCPREFIX],[SRCPORT],[DESTADDR],[DESTPREFIX],[DESTPORT],[IPPROTO
COL],[IPFRAGMENT],[ICMPTYPE],[ICMPCODE],[TCPESTABLISHED];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 419


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-PATTERN

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

PATTERNID Value Description


{1-256}
<1-30 VALID PATTERNID
CHARACTERS>

Default: Entry required


Addressing: None
Description: The identifier of the pattern to being configured. Could be either an
integer in the range 1-256 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter. , which is selected by the user to uniquely identify the pattern
in subsequent provisioning requests.

ACTION Value Description


PASS
BLOCK

Default: Entry Required


Addressing: None.
Description: Action to take on packets matching the specified ACL Pattern.
Valid values:
PASS allow the packet if it matches all of the pattern
descriptors
BLOCK disallow the packet if it matches all of the pattern
descriptors

ICMPERROR Value Description


TRUE
FALSE

Default: FALSE
Addressing: None
Description: ICMP Error Reporting behavior for blocked packets.
TRUE send ICMP error for blocked packets
FALSE do not send ICMP error for blocked packets

420 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IPACL-PATTERN Issue 1, December 2011

SRCADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <null>
Addressing: None
Description: Source IP Address. String, xxx-xxx-xxx-xxx format. Can be
specified explicitly to match only packets that originate from a
particular address, or can be used along with the SRCPREFIX
parameter to specify a range of supported originating IP
addresses.

SRCPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Default: 0-0-0-0
Addressing: None
Description: Source IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the
reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
SRCADDR is specified and the SRCPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
SRCADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
SRCADDR is also specified. The binary form of the mask must
consist in uniterrupted series of 0 bits. followed by uninterrupted
series of 1 bits.

SRCPORT Value Description


{0-65535}

Default: <null>
Addressing: None
Description: TCP/UDP Source Port. Integer, 0 - 65535. Applicable only when
IP Protocol is TCP or UDP. Some of the commonly used ports are:
20 FTP-Data TCP File Transfer Protocol [Data]
21 FTP TCP File Transfer Protocol [Control]
23 Telnet TCP Telnet
69 TFTP UDP Trivial File Transfer Protocol
123 NTP UDP Network Time Protocol
161 SNMP UDP SNMP
162 SNMPTRAP UDP SNMPTRAP
3082 TL1-Raw TCP TL-1 [Raw]

1830PSS R3.6.50 - TL1 Commands and Messages 421


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-PATTERN
3083 TL1-Telnet TCP TL-1 [User Interface]

DESTADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <null>
Addressing: None
Description: Destination IP Address. String, xxx-xxx-xxx-xxx format. Can be
specified explicitly to match only packets that originate from a
particular address, or can be used along with the DESTPREFIX
parameter to specify a range of supported destination IP
addresses.

DESTPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Default: 0-0-0-0
Addressing: None
Description: Destination IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the
reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
DESTADDR is specified and the DESTPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
DESTADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
DESTADDR is also specified. The binary form of the mask must
consist in uniterrupted series of o bits. followed by uninterrupted
series of 1 bits.

DESTPORT Value Description


{0-65535}

Default: <null>
Addressing: None
Description: TCP/UDP Destination Port. Integer, 0 - 65535. Applicable only
when IP Protocol is TCP or UDP. Some of the commonly used
ports are:
20 FTP-Data TCP File Transfer Protocol [Data]
21 FTP TCP File Transfer Protocol [Control]
23 Telnet TCP Telnet
69 TFTP UDP Trivial File Transfer Protocol
123 NTP UDP Network Time Protocol
161 SNMP UDP SNMP

422 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IPACL-PATTERN Issue 1, December 2011

162 SNMPTRAP UDP SNMPTRAP


3082 TL1-Raw TCP TL-1 [Raw]
3083 TL1-Telnet TCP TL-1 [User Interface]

IPPROTOCOL Value Description


{0-255}
ICMP
IPIP
TCP
UDP
RSVP
GRE
OSPF

Default: <null>
Addressing: None
Description: IP Protocol. Can be specified by explicit protocol number (Integer,
0-255) or by keyword (for common protocol types, listed below).
Valid values:
ICMP - IP protocol is ICMP (1)
IPIP - IP protocol is IPIP (4)
TCP - IP protocol is TCP (6)
UDP - IP protocol is UDP (17)
RSVP - IP protocol is RSVP (46)
GRE - IP protocol is GRE (47)
OSPF - IP protocol is OSPF (89)
<other protocol> -Specify IP protocol number: 0 to 255

IPFRAGMENT Value Description


TRUE
FALSE

Default: FALSE
Addressing: None.
Description: IP Fragmentation. Valid values:
TRUE - pattern is an IP fragment
FALSE - pattern is not an IP fragment

ICMPTYPE Value Description


{0-255}

1830PSS R3.6.50 - TL1 Commands and Messages 423


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-PATTERN
Default: <null>
Addressing: None
Description: ICMP Type identifier. Integer, 0 - 255. Applicable only when
IPPROTOCOL is ICMP (or 1). If specified, the pattern will only
match packets with this exact ICMP type. Some of the most
commonly used ICMP types.
0 Echo Reply [RFC792]
3 Destination Unreachable[RFC792]
5 Redirect[RFC792]
9 Router Advertisement[RFC1256]
42-255 Reserved

ICMPCODE Value Description


{0-255}

Default: <null>
Addressing: None.
Description: ICMP Code field. Integer, 0 - 255.
Applicable only when IP Protocol is ICMP. Used along
with certain ICMP types to further specify the message
type. Must also specify the ICMP type when setting
this parameter. If specified, the pattern will only
match packets with this exact ICMP code value.
For example, there are a few ICMPCODEs associated to
the ICMPTYPE Redirect [RFC792]:
0 Redirect Datagram for the Network (or subnet)
1 Redirect Datagram for the Host
2 Redirect Datagram for the Type of Service and
Network
3 Redirect Datagram for the Type of Service and Host

TCPESTABLISHED Value Description


TRUE
FALSE

Default: <null>
Addressing: None.
Description: TCP Established flag. Matches a packet depending on whether
the TCP flags in the IP header correspond to the “established”
state. Applicable only when IP Protocol is TCP. Valid values:
TRUE - TCP flags correspond to “established” state
FALSE - TCP flags do not correspond to
“established” state

424 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-IPACL-PATTERN Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• SRCPREFIX is specified without the SRCADDR

• DESTPORT is specified and the IPPROTOCOL is different from TCP or UDP

• DESTPREFIX is specified without the DESTADDR

• DESTPORT is specified and the IPPROTOCOL is different from TCP or UDP

• ICMPTYPE is specified and the IPPROTOCOL is different from ICMP

• ICMPCODE is specified without the ICMPTYPE

• TCPESTABLISHED is specified and the IPPROTOCOL is different from TCP

IENE Input, Entity does Not Exist

1830PSS R3.6.50 - TL1 Commands and Messages 425


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-IPACL-PATTERN
• PATTERNID corresponds to an undefined pattern

EXAMPLES
In this example, one pattern is modified to block TCP packets on port 23 originating from 10.17.0.46:

ED-IPACL-PATTERN:::C0001::2,BLOCK,,10.17.0.46,32,,,23,TCP;

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* ED-IPACL-PATTERN:::::2,BLOCK,,10-17-0-46,0-0-0-0,,,23,TCP [C0001]
(5) */
;

RELATED COMMANDS
DLT-IPACL-PATTERN
ENT-IPACL-PATTERN
RTRV-IPACL-PATTERN

RELATED AUTONOMOUS RESPONSES


None.

426 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-LAN


Command Name: EDIT ETHERNET LAN INTERFACE

PURPOSE
The ED-LAN-IF is used to provision the physical properties of the target interface. There are two
parameters that can be provisioned: LINKSPEED and DUPLEX. This command applies to the
following ports:
• OAMP

• VOIP

• E1
• E2
• CIT

After making the change, verify that the change was made correctly using the RTRV-LAN command.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-LAN-IFACE:[TID]:AID:[CTAG]:::[LINKSPEED=][,DUPLEX=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


LAN-{OAMP, CIT, VOIP, E1, E2}
(Customer LAN)

Default: <entry required>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 427


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-LAN
Description: Access Identifier, specifies an access identifier to the USRPNL
Ethernet interfaces, or to the CIT port on the EC/FLC faceplate.
For the CIT port in a Duplex EC/FLC controller system, the
provisioned parameter value is applied to both EC/FLC slots.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

LINKSPEED= Value Description


10
100
1000
AUTO

Default: <Previously existing value> <system default AUTO>


Addressing: None
Description: The Link Speed of the port. The port can be 10Mbps, 100Mbps,
1000Mbps or AUTO, which implies it will participate in
auto-negotiation. The initial system default is AUTO. After it is set,
the value will always assume this set value until it is modified by
another ED-LAN command. If this value is not set, the target AID
shall retain the old value.

DUPLEX= Value Description


HALF
FULL
AUTO

Default: <Previously existing value> <system default AUTO>


Addressing: None
Description: DUPLEX state of the port. The port can be HALF duplex, FULL
duplex, or AUTO, which implies it will participate in
auto-negotiation. The initial system default is AUTO. After it is set,
the value will always assume this set value until it is modified by
another ED-LAN-IFACE command. If this value is not set, the
target AID shall retain the old value.

428 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-LAN Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid Access Identifier
• the target AID is anything other than the OAMP, VOIP, E1, E2 or CIT port

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

EXAMPLES
In the following example, ED-LAN is used to provision the physical characteristics of the VoIP, E1, E2
port:

ED-LAN-IF::LAN-VOIP:C0001:::LINKSPEED=10,DUPLEX=FULL;

A successful response for that command would be:

1830PSS R3.6.50 - TL1 Commands and Messages 429


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-LAN

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
/* ED-LAN::LAN-VOIP:C0001:::LINKSPEED=10,DUPLEX=FULL [C0001] (5) */
;

RELATED COMMANDS
RTRV-LAN

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

430 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-NE-IPRT


Command Name: EDIT NETWORK ELEMENT IP ROUTE

PURPOSE
This command allows the administrative operator to edit a static IP route in the IP routing table.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-NE-IPRT:[TID]::[CTAG]::DESTADDR,MASK,NEXTHOP,[DISTANCE],[ADVERTIS
E];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DESTADDR Value Description


0-0-0-0
{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <Entry Required>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 431


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-NE-IPRT
Description: Destination Address, IP address of the destination host or network
(in the format nnn-nnn-nnn-nnn). The address 0-0-0-0 is used to
specify a default route. If NETMASK is not all 1's when viewed in
binary format (i.e., a network route is specified), the host portion of
the DESTADDR must be all 0's.

MASK Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Default: <Entry Required>


Addressing: None
Description: IP Mask, IP subnet mask of the route (in the format
nnn-nnn-nnn-nnn). The mask 0-0-0-0 is used to specify a default
route.

NEXTHOP Value Description


{1-99, 102-126,128-223} - {0-255} -
{0-255} - {0-255}

Default: <Entry Required>


Addressing: None
Description: Next hop address, IP address of the next interface in the route (in
the format nnn-nnn-nnn-nnn). This is also known as the “gateway
address”. The target NE shall be directly connected to this
interface. The address 0-0-0-0 is not allowed. Neither the network
nor the host portion of the address when viewed in binary format
may be all 0's or all 1's.
The NEXTHOP address must be in the address range of the IP
subnet configured on the appropriate interface, and the route is via
the USI Ethernet interface.

DISTANCE Value Description


[1-255]

Default: <previous value>


Addressing: None
Description: Metric, it is the cost metric of the route.

ADVERTISE Value Description


N
Y

Default: <previous value>


Addressing: None

432 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-NE-IPRT Issue 1, December 2011

Description: Specifies whether the IP route is leaked into the OSPF routing
protocols.
N Route is only known on the local NE
Y Route is leaked into OSPF and distributed over the
network.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^^DENY cr lf
^^^<ERROR^CODE> cr lf
[^^^/*^<Expanded^Error^Code^Description>^*/ cr lf]
[^^^/*^<Informational^Error^Description^Text>^*/ cr lf]
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• the DESTADDR, MASK, and NEXTHOP parameters are not specified

IENE Input, Entry Does not Exist


• the specified DESTADDR, MASK and NEXTHOP do not match an existing entry

IIDE Input, Invalid Data Entry


• the specified DESTADDR, MASK and NEXTHOP are not a static entry (i.e. the route is
dynamically found)

1830PSS R3.6.50 - TL1 Commands and Messages 433


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-NE-IPRT
EXAMPLES
In the following example, ED-NE-IPRT is used to change the ADVERTISE option of an existing static
IP route. The route is specified with the destination 128.210.54.0, which uses the network mask
255.255.255.0. Since there is no change to the next hop nor to the metric, the next and the cost/metric
of the route do not need to be specified.

ED-NE-IPRT:::C0001::128-210-54-0,255-255-255-0,10-1-1-1,,N;

A successful response for that command would be:

^^^LASVEGAS^06-01-13^08:46:59
M^^C0001^COMPLD
/* ED-NE-IPRT:::C0001::128-210-54-0,255-255-255-0,10-1-1-1,,N
[C0001] (5) */
;

RELATED COMMANDS
DLT-NE-IPRT
ENT-NE-IPRT
RTRV-NE-IPRT

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

434 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-NE


Command Name: EDIT NETWORK ELEMENT

PURPOSE
The ED-NE command modifies general system-level equipment parameters for the NE.
The successful completion of the command shall cause REPT^DBCHG autonomous messages.

INPUT FORMAT

ED-NE:[TID]::[CTAG]:::[SYSAINSTMR=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SYSAINSTMR= Value Description


{{00-96}-{00-59}} Hours-Minutes

Default: <Previously-existing value>


Addressing: None
Description: System default AINS timer. The system level timer for an entity to
remain in automatic in-service mode (AINS). Minimum time is 1
minute. Maximum time is 96 hours. This value is used for all ports
which have their AINSREF set to SYSTEM, i.e. ports that do not
have their own port-level AINS timer provisioned.

1830PSS R3.6.50 - TL1 Commands and Messages 435


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-NE
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIFM Invalid Payload block. Invalid Data Format.
• the value entered for SYSAINSTMR is above range

SABT FAILED range validation for AINS Debounce Time. Valid range: 1m to 96h 0m.
• the value entered for SYSAINSTMR is below range

EXAMPLES
The following command sets the system AINS timer to 24 hours.

ED-NE::::::SYSAINSTMR=24-00;

RELATED COMMANDS
RTRV-NE

436 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-NTP


Command Name: EDIT NETWORK TIME PROTOCOL

PURPOSE
The ED-NTP command edits the Network Time Protocol parameters. Changes take place
immediately.
Note: When the NTP protocol is enabled and no NTP server is in service or reachable, then the time of
day clock will keep its current value and synchronize with the NE internal clock frequency.
Note: changing the date and time of the system could result in partial or incomplete PM data.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-NTP:[TID]::[CTAG]:::[NTP=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTP= Value Description


{ ENABLE, DISABLE}

Default: <currently provisioned value>


Default: DISABLE
Addressing: None
Description: Enable or disable time synchronization from the NTP server.

1830PSS R3.6.50 - TL1 Commands and Messages 437


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-NTP
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• an attempt is made to enable NTP while NTP is already enabled

SAOS Status, Already Out of Service


• an attempt is made to disable NTP while NTP is already disabled

SNVS Status, Not in Valid State


• an attempt is made to enable NTP when no NTP servers are provisioned

EXAMPLES
In the following example, the NTP time synchronization is enabled.

ED-NTP::::::NTP=ENABLE;

438 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-NTP Issue 1, December 2011

The output response is shown below.

AM1520 03-07-27 10:34:56


M P19003 COMPLD
/* ED-NTP::::::NTP=ENABLE; [P19003] (5)*/
;

RELATED COMMANDS
ED-DAT
ENT-NTP-ADDR
RTRV-NTP
RTRV-NTP-ADDR

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 439


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-NTP

440 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OC12


Command Name: ED-OC12

PURPOSE
The ED-OC12 command creates (assigns and provisions) a specified OC12 client signal facility.
Executing an ED-OC12 command causes primary and secondary state transitions for the specified
OC12 facility. Primary and secondary states associated with the OC12 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OC12 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC12 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a OC12 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC12 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC12 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC12 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OC12:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,SDTH=][,S
FTH=][,J0_EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,
TS=][,MODULETYPE=][,CHANNEL=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 441


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC12
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

442 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC12 Issue 1, December 2011

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (0-255) if
J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

1830PSS R3.6.50 - TL1 Commands and Messages 443


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC12

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

444 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC12 Issue 1, December 2011

TS= Value Description


ODU1-L1-{1-4}-{1, 13, 25, 37}
(11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
OC12/STM4 requires 4 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SL-4.1,
SL-4.2,SL-16.2C, SS-4.1, SS-16.1A,
SS-16.2C}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified OC12 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.
Restrictions: SL-4.2 and SS-4.1 are supported only on 4DPA4 and 11DPM12
OT.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 445


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC12
Description: Specifies the channel frequency of the client port.

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

446 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC12 Issue 1, December 2011

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-OC12


command.
ED-OC12:NODE-1:11STMM10-1-5-C1:xyz123:::SDTH=10-7:ODU1-L1-2-1:IS,AIN
S;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

1830PSS R3.6.50 - TL1 Commands and Messages 447


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC12
RELATED COMMANDS
RTRV-OC12
RST-OC12
DLT-OC12
ENT-OC12
RMV-OC12

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

448 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OC192


Command Name: ED-OC192

PURPOSE
The ED-OC192 command creates (assigns and provisions) a specified OC192 client signal facility.
Executing an ED-OC192 command causes primary and secondary state transitions for the specified
OC192 facility. Primary and secondary states associated with the OC192 facility after the command is
executed depend upon events detected by the system.
The state transitions are described in the IOM Appendix F.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC192 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
If no values are entered for PST,SST then OC192 enters IS-NR or IS-ANR.
When a OC192 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC192 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC192 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC192 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OC192:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,MAPPINGM
ODE=][,CHANNEL=][,SDTH=][,SFTH=][,J0_EX=][,J0_FMT=][,TRCCMP=][,LOSPR
OP=][,MODULETYPE=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 449


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC192

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


{SYSTEM}

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.

450 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC192 Issue 1, December 2011

00-96-00-59 Time, specifies the duration of an


alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

MAPPINGMODE= Value Description


BITSYNC bit synchronous CBR mapping
ASYNC asynchronous CBR mapping

Default: <Previously-existing value>


Addressing: None.
Description: Type of mapping of OC192/STM64 into an ODU2 structure.
The MAPPINGMODE parameter applies to the 43STX4,
43STX4P, 43SCX4L and 43SCX4 OTs.
The MAPPINGMODE parameter applies to the 112SCX10,
112SNX10, and 112SX10L OTs.
This parameter shall not apply to the 11QPA4 and 11QTA4 OTs.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: previously provisioned value


Addressing: None
Description: Specifies the channel frequency of the client port.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previouslu provisioned value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 451


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC192
Description: Attribute that specifies BER threshold for SD defect decalration.
The SDTH parameter does not apply to the 43STX4 and 43STX4P
OTs.
The SDTH parameter applies to the 43SCX4L OT and 43SCX4
OT.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
decalration.
The SFTH parameter does not apply to the 43STX4 and 43STX4P
OTs.
The SFTH parameter applies to the 43SCX4L OT and 43SCX4
OT.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>

452 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC192 Issue 1, December 2011

Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 section trace value and the
provisioned (i.e., expected) J0 section trace value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signaled.

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11STAR1, 43STX4, 43STX4P and
43SCX4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11STAR1, 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for the
112SCX10, 112SNX10, and 112SX10L
OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QPA4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QTA4 OTs.

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified OC192 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

1830PSS R3.6.50 - TL1 Commands and Messages 453


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC192

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

454 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC192 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-OC192


command.
ED-OC192:NODE-1:11STAR1-1-5-C1:xyz123:::sdth=10-5:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC192
RST-OC192
DLT-OC192
ENT-OC192
RMV-OC192

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 455


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC192

456 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OC3


Command Name: ED-OC3

PURPOSE
The ED-OC3 command creates (assigns and provisions) a specified OC3 client signal facility.
Executing an ED-OC3 command causes primary and secondary state transitions for the specified OC3
facility. Primary and secondary states associated with the OC3 facility after the command is executed
depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OC3 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC3 is free of failures, it
enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a OC3 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC3 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC3 transmission condition
types or performance monitoring threshold crossing alerts are autonomously reported for the OC3
signal, but alarm conditions are monitored and performance monitoring data is collected (if provisioned
for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OC3:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,SDTH=][,SF
TH=][,J0_EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,T
S=][,MODULETYPE=][,CHANNEL=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 457


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC3
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

458 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC3 Issue 1, December 2011

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (0-255) if
J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

1830PSS R3.6.50 - TL1 Commands and Messages 459


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC3

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

460 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC3 Issue 1, December 2011

TS= Value Description


ODU1-L1-{1-4}-{1, 4, 7, 10, 13, 16, 19,
22, 25, 28, 31, 34, 37, 40, 43, 46}
(11STMM10 timeslots)
{L1,L2}-({1-16}) (4DPA4
timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port (L1 or L2).

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SL-1.1 , SL-1.2,
SL-16.2C, SS-1.1, SS-16.1A,
SS-16.2C}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified OC3 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.
Restriction: The module types SS-1.1 , SL-1.2 are supported
only by 4DPA4 Client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port.

1830PSS R3.6.50 - TL1 Commands and Messages 461


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC3

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

462 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC3 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-OC3


command.
ED-OC3:NODE-1:11STMM10-1-5-C1:xyz123:::SDTH=10-7:ODU1-L1-2-1:IS,AINS
;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC3

1830PSS R3.6.50 - TL1 Commands and Messages 463


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC3
RST-OC3
DLT-OC3
ENT-OC3
RMV-OC3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

464 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OC48


Command Name: ED-OC48

PURPOSE
The ED-OC48 command creates (assigns and provisions) a specified OC49 client signal facility.
Executing an ED-OC48 command causes primary and secondary state transitions for the specified
OC48 facility. Primary and secondary states associated with the OC48 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then OC48 enters IS-NR or IS-ANR.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC48 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS

When a OC48 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC48 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 10OC48 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC48 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OC48:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,SDTH=][,S
FTH=][,J0_EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,
MODULETYPE=][,CHANNEL=][,TS=][,CONTAINER=][,MAPPINGMODE=]:[PST][,SST
];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 465


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC48

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum value is 96-00. The miminum value is
00-01.

466 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC48 Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4 and 4DPA2.

SFTH= Value Description


{10-3, 10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4 and 4DPA2.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0. Does not apply to 4DPA4 and 4DAP2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

1830PSS R3.6.50 - TL1 Commands and Messages 467


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC48

J0_TX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4 and 4DAP2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4 and 4DAP2. Only 16-byte
format applies to 4DPA4 .

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4 and 4DPA2 OTs.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4 and 4DAP2.

468 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC48 Issue 1, December 2011

ENABLED enable compare


DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.
Parameter LOSPROP does not apply to 4DPA2 OT.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C,
SL-16.2D,SS-16.1A, SS-16.2C}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified OC48 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Restrictions: SI-16.1 and SL-16.2 are not supported
on 4DPA2 pack.
SL-16.2C, SS-16.2C, and
SL-16.2D are the only types supported on the line port
of 4DPA2 OT.
SL-16.2D is not supported
on the client ports of 4DPA2 , 4DPA4 and 11STMM10
OTs.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 469


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC48
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)
{L1,L2}-(1) (4DPA4 timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4 : Timeslot assignment on the specified Line port (L1 or
L2). Timeslot 1 represents the entire OTU1 capacity (all 16
timeslots).
Parameter TS does not apply to 4DPA2 OT.

CONTAINER= Value Description


{None, ODU1}

Default: None
Addressing: None
Description: Specifies the granularity for client OC48 mapping to ODU2
multiplexing structure.
Set to odu1-mapping into ODU1 per G.709.
This parameter only applies to 11DPM12.

MAPPINGMODE= Value Description


{ASYNC, BITSYNC}

Default: None
Addressing: None
Description: Specifies the mapping mode for constant bit rate client signals into
OPUk.
ASNYC- asynchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation fuction.
BITSYNC-synchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation function.
This parameter only applies to 11DPM12 pack when
CONTAINER=ODU1.

470 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC48 Issue 1, December 2011

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 471


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC48
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-OC48


command.
ED-OC48:NODE-1:11STMM10-1-5-C1:xyz123:::SDTH=10-7:ODU1-L1-2-1:IS,AIN
S;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC48
RST-OC48
DLT-OC48
ENT-OC48
RMV-OC48

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

472 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OC768


Command Name: ED-OC768

PURPOSE
The ED-OC768 command creates (assigns and provisions) a specified OC768 client signal facility.
Executing an ED-OC768 command causes primary and secondary state transitions for the specified
OC768 facility. Primary and secondary states associated with the OC768 facility after the command is
executed depend upon events detected by the system.
The state transitions are described in the IOM Appendix F.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC768 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
If no values are entered for PST,SST then OC768 enters IS-NR or IS-ANR.
When a OC768 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC768 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC768 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC768 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OC768:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,J0_EX=][
,J0_FMT=][,TRCCMP=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

1830PSS R3.6.50 - TL1 Commands and Messages 473


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC768

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


{SYSTEM}

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

474 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC768 Issue 1, December 2011

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 section trace value and the
provisioned (i.e., expected) J0 section trace value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signaled.

1830PSS R3.6.50 - TL1 Commands and Messages 475


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC768

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

476 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OC768 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-OC768


command.
ED-OC768:NODE-1:43STA1P-1-5-C1:xyz123:::LOSPROP=LASERON:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC768
RST-OC768
DLT-OC768
ENT-OC768
RMV-OC768

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 477


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OC768

478 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OCH


Command Name: EDIT-OCH

PURPOSE
The ED-OCH command is used to set the parameters of an optical channel.

INPUT FORMAT

ED-OCH:[TID]:AID:[CTAG]:::[POWER=][,DEVPOWER=][,TOLPOWER=][,DIRN=][,
CHANNEL=][,AINSTMR=][,AINSREF=][,DESCR=][,CMDMDE=][,MODULETYPE=][,EX
POUTPOWER=][,CALCMODE=][,SWTHRESH=][,SWTOL=][,VOAATTEN=]:[PST][,SST]
;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 479


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OCH

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,

480 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OCH Issue 1, December 2011

AID Value Description


9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,

1830PSS R3.6.50 - TL1 Commands and Messages 481


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OCH

AID Value Description


9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}

482 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OCH Issue 1, December 2011

AID Value Description


WR-<shelf>-<slot>-{SIG, THRU}-{9605, (WR8-88A Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 NE Boundary Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, 9180, 9170}
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,

1830PSS R3.6.50 - TL1 Commands and Messages 483


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OCH

AID Value Description


9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OCH.
SFD5A channel I/O ports: 9190, 9200, 9210, 9220, 9230
SFD5B channel I/O ports: 9240, 9250, 9260, 9270, 9280
SFD5C channel I/O ports: 9290, 9300, 9310, 9320, 9330
SFD5D channel I/O ports: 9340, 9350, 9360, 9370, 9380
SFD5E channel I/O ports: 9410, 9420, 9430, 9440, 9450
SFD5F channel I/O ports: 9460, 9470, 9480, 9490, 9500
SFD5G channel I/O ports: 9510, 9520, 9530, 9540, 9550
SFD5H channel I/O ports: 9560, 9570, 9580, 9590, 9600

484 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OCH Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

POWER= Value Description


{-99.00 to +11.00}

Default: <previously existing value>


Addressing: None
Description: POWER, The expected channel power to be measured at the
addressed WaveTracker detector.

DEVPOWER= Value Description


{0.00 to 10.00}

Default: <previously existing value>


Addressing: None
Description: DEVPOWER, The deviation from expected channel power to be
measured at the addressed WaveTracker detector that will trigger
an OPR alarm.

TOLPOWER= Value Description


{0.00 to 5.00}

Default: <previously existing value>


Addressing: None
Description: TOLPOWER, The amount of power change from the OPR alarm
set point needed to clear the OPR alarm.

DIRN= Value Description


TRMT
RCV
ALL

Default: RCV
Addressing: None
Description: DIRN, Describes the direction of the channel. Required when
entering DEVPOWER, POWER, and TOLPOWER.

1830PSS R3.6.50 - TL1 Commands and Messages 485


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OCH
TRMT Report the transmit direction channels
RCV Report the receive direction channels
ALL Report both the transmit and receive direction
channels

CHANNEL= Value Description


{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170, NONE}

Default: <previously existing value>


Addressing: None
Description: CHANNEL, Channel Frequency. Used to provide a channel
frequency parameter when the AID does not contain channel
frequency infomation. Needed for the OPSA, SVAC, or MVAC
circuit packs.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <previously existing value>


Addressing: None
Description: AINSTMR, Transition soak time out of AINS. Format is
HOURS-MINUTES. Maximum time is 96-00.
SYSTEM Use the system level timer

AINSREF= Value Description


SYSTEM

Default: <previously existing value>


Addressing: None
Description: AINSREF, Indicates the reference timer used for automatic
in-service transition.
SYSTEM Use the system level timer

486 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OCH Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <previously existing value>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if it
contains non- alphanumeric characters.

CMDMDE= Value Description


{NORM,FRCD}

Default: <previously existing value>


Addressing: None
Description: CMDMDE, Command mode. Provides the capability to force the
facility OOS. Note: Forcing the facility OOS also forces all cross
connections along this facility to be set to OOS.
NORM Normal Operation
FRCD Force the facility OOS. Note: PST must also be set
to OOS for the Command Mode to be forced.

MODULETYPE= Value Description


AUTO
USER
fVOA
sVOA

Default: <previously existing value>


Addressing: None
Description: MODULETYPE, Specifies the Signal and SFP type for the VA port
on an OT or the G1-G8 port on an MVAC.

EXPOUTPOWER= Value Description


{-20.00 to -5.5} 4DPA4, 11QPA4, and
11DPE12 packs
{-17.00 to +1.7} 112SCX10, 112SX10L,
112SCA1 and 112SA1L packs
{-17.00 to -1.3} 43SCX4 Pack
{-20.00 to +4.00} All Other OT Packs

Default: <previously existing value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 487


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OCH
Description: EXPOUTPOWER, The expected channel output power to be
provisioned at the addressed WaveTracker encoder for OT line
ports, SVAC A/B ports, and MVAC G(1-8) ports.

CALCMODE= Value Description


{AUTO, MANUAL}

Default: AUTO
Addressing: None
Description: CALCMODE, Operating mode for the OPSA switch threshodl
calculations.

SWTHRESH= Value Description


{-30.00 to +5.00}

Default: -30
Addressing: None
Description: SWTHRESH, Switching threshold for the OPSA A and B ports.
Only settable if the CALCMODE is MANUAL. Requires admin or
service user privilege level to change.

SWTOL= Value Description


{0 to 5.00}

Default: 2.00
Addressing: None
Description: SWTOL, Switching threshold tolerance for the OPSA A and B
ports. Only settable if the CALCMODE is MANUAL. Requires
admin or service user privilege level to change.

VOAATTEN= Value Description


{0 to 20.0, -1}

Default: -1
Addressing: None
Description: VOAATTEN, Specifies the attenuation value for the VOA in the
egress direction of the OPSA A and B ports. A value of -1 sets the
VOA to maximum attentuation. Only settable if the optical line is in
manual power managed mode, refer to ED-PWRMGMT-TYPE
command. Requires admin or service user privilege level to
change.

488 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OCH Issue 1, December 2011

PST Value Description


{IS, OOS}

Default: <previously existing value>


Addressing: None
Description: PST, Primary State for the OCH.
IS In Service
OOS Out of Service

SST Value Description


AINS
AINS-DEA
MT

Default: <previously existing value>


Addressing: None
Description: SST, Secondary State for the OCH.
AINS Automatic In Service
AINS-DEA Automatic In Service Deactivated
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 489


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OCH
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IPNV Parameter not Valid
• the user is attempting to provision DEVPOWER or POWER for a channel on an auto-managed
line,

• the user enters a CHANNEL parameter with an AID of a port not on an OPSA, SVAC or MVAC
circuit pack

• the user enters a EXPOUTPOWER value outside the allowed range,

• the user enters a SWTHRESH or SWTOL value and the OPSA port is not in MANUAL mode,

• the user enters a VOAATTEN value and the optical line is not in MANUAL mode,

• the user is attempting to change the eVOA module type from fVOA to sVOA that cross connection
has been established with Auto/Manual WT Key for this channel

SABT Request Failed - Port has enabled cross-connect


• the user attempts to set a port with in-service cross-connects to OOS using the CMDMDE=NORM

SAIS Status, Already In Service


• the user is attempting to provision the OCH to the IS state that is already IS,

SAOS Status, Already Out of Service


• the user is attempting to provision the OCH to the OOS state that is already OOS,

SCSN Status, invalid Command SequeNce


• the user is attempting to provision an OCH to the OOS or IS state that is currently in the OOS-AU,
AINS state,

490 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OCH Issue 1, December 2011

EXAMPLES
The following example shows the successful execution of a ED-OCH command.

ED-OCH:NODE-1:SVAC-2-5-L1:123456::::OOS;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* ED-OCH:NODE-1:SVAC-2-5-L1:123456::::OOS; */
;

RELATED COMMANDS
DLT-OCH
ENT-OCH
RMV-OCH
RST-OCH
RTRV-OCH

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 491


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OCH

492 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-ODU0


Command Name: ED-ODU0

PURPOSE
The ED-ODU0 command is used to edit parameters related to the non-terminated ODU0 tributary for
specified ODU0 facility.
The ODU0 object entity shall be automatically created on the line side by the system when the Line
port has prvsioned by ODU2.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-ODU0:[TID]:AID:[CTAG]::[TRCCMP=][,EXP_SAPI=][,TIMMRESP=][,PST=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the ODU0 entity.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 493


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU0

TRCCMP= Value Description


{ENABLED , DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

EXP_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

PST= Value Description


{IS,OOS}

Default: <Previously-existing value with OOS as factory default>


Addressing: None

494 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU0 Issue 1, December 2011

Description: Admin State, specifies the admin state to


which the facility is set. In Client side, under IS,
LO ODU alarm will report if cross-connect exists and
there is alarm. In Line side, under IS, LO ODU alarm
will report if alarm exist regardless the present of
cross-connect. OOS will suppress the LO ODU alarm
reporting.
IS In Service
OOS Out Of Service
It only applies to 11DPM12 Line port Low Order ODUk.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a ED-ODU0 command on the line of a
11DPM12 OT:
ED-ODU0:NODE-1:11DPM12-1-5-L1-ODU2ODU0#1:123456::: trccmp=ENABLED,
exp_sapi=ABCDEFGHIJKLMNO, timmresp=DISABLED,pst=IS;

RELATED COMMANDS
RTRV-ODU0

1830PSS R3.6.50 - TL1 Commands and Messages 495


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU0
RELATED AUTONOMOUS RESPONSES
REPT^DBCHG

496 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-ODU1


Command Name: ED-ODU1

PURPOSE
The ED-ODU1 command is used to edit parameters related to the ODU1 tributary for specified
client/line facility.
The ENT-ODU1 command is not supported. The ODU1 object entity shall be automatically created on
the client side by the system when the Client OTU1 facility os created. The ODU1 object entity shall be
automatically created on the line side by the system when the OT circuit pack is provisioned.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-ODU1:[TID]:AID:[CTAG]::[ODU0INTERWK=][,TRCCMP=][,TX_SAPI=][,EXP_S
API=][,TIMMRESP=][,PTMMRESP=][,PLDTYPE=][,PST=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 497


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU1

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

ODU0INTERWK= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID (4DPA4 OT Line AID)
Description: ODU0 Interworking. ODU0INTERWK refers to whether standard
ODU0 Interworking is used (ENABLED or DISABLED). When
ODU0INTERWK=DISABLED, ODU1 Payload Type (PT) should be
set to 0x80 and there is proprietary encoding of OPTS OH in the
PSI bytes and LosProp in APS/PCC bytes. The 4DPA4 OT can
then interwork at 2xODU0 only with another 4DPA4 OT. When
ODU0INTERWK=ENABLED, the ODU1 PT should be set to 0x20
(ODU multiplex structure), and there is no proprietary use of PSI or
APS/PCC bytes. The 4DPA4 OT can then interwork with standard
2xODU0 equipment.
ENABLED Enabled
DISABLED Disabled

TRCCMP= Value Description


{ENABLED , DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TX_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system.
Addressing: None

498 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU1 Issue 1, December 2011

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an ODUk information structure or the Path
Monitoring overhead of the ODUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
TX_SAPI is not applicable to 11STMM10 client ports.

EXP_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

PTMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID

1830PSS R3.6.50 - TL1 Commands and Messages 499


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU1
Description: ODU2 Payload Type Mismatch Response. This parameter
determines whether an OT will take a Consequent Action or pass
the received signal.
ENABLED Enabled
DISABLED Disabled
This parameter does not apply to the 11STMM10 client AID.

PLDTYPE= Value Description


<0-255> decimal format

Default: <Previously-existing value> initially set by the system to 128


(0x80).
Addressing: Line AID
Description: Payload Type (PT) field content of a Payload Structure Identifier
(PSI) of the OTUk structure. PLDTYPE defaults to 128 (0x80)
regardless of client signal type. The value 128 (0x80) indicates a
proprietary mixture of sub-ODU1 signals. PLDTYPE should be set
manually to 32 (0x20) when ODU0INTERWK parameter is
enabled. It can be set to other values if desired, assuming the
other end is set to be the same.
This parameter applies only to 4DPA4 line AID. It doesn't apply to
the 11STMM10 client AID.

PST= Value Description


{IS,OOS}

Default: <Previously-existing value with OOS as factory default>


Addressing: None
Description: Admin State, specifies the admin state to
which the facility is set. In Client side, under IS,
LO ODU alarm will report if cross-connect exists and
there is alarm. In Line side, under IS, LO ODU alarm
will report if alarm exist regardless the present of
cross-connect. OOS will suppress the LO ODU alarm
reporting.
IS In Service
OOS Out Of Service
It only applies to 11DPM12 Line port Low Order ODUk.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

500 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU1 Issue 1, December 2011

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is unassigned

EXAMPLES

The following example shows the successful execution of a ED-ODU1


command on the line of a 4DPA4 OT.
ED-ODU1:NODE-1:4DPA4-1-5-L1-1:123456:::tx_sapi=ABCDEFGHIJKLMNO,exp_s
api=ABCDEFGHIJKLMNO,trccmp=ENABLED,timmresp=DISABLED,ptmmresp=DISABL
ED,pldtype=02,ODU0INTERWK=ENABLED;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-ODU1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 501


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU1

502 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-ODU2


Command Name: ED-ODU2

PURPOSE
The ED-ODU2 command is used to edit parameters related to the ODU2 tributary for specified
client/line facility.
The ENT-ODU2 command is not supported. The ODU2 object entity shall be automatically created on
the client side by the system when the Client OTU2 facility os created. The ODU2 object entity shall be
automatically created on the line side by the system when the OT circuit pack is provisioned.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-ODU2:[TID]:AID:[CTAG]:::[MAPPINGMODE=][,TX_SAPI=][,EXP_SAPI=][,TR
CCMP=][,TIMMRESP=][,PTMMRESP=][,PLDTYPE=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 503


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU2

AID Value Description


11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

MAPPINGMODE= Value Description


BITSYNC bit synchronous CBR mapping per
definition in Section 17.1 of ITU-T
G.709 recommendation.
ASYNC mapping mode indicates asynchronous
CBR mapping per definition in Section
17.1 of ITU-T G.709 recommendation

Default: <Previously-existing value> BITSYNC initially set by the system.


Addressing: Line AID
Description: ODUkP to CBRx mapping mode. This parameter indicates the
mapping mode that will be used when the client port signal is

504 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU2 Issue 1, December 2011

provisioned to OC192_STM64, or 10GbE_WAN using the


ENT-OC192 command.
Restriction : The MAPPINGMODE parameter only applies to the
11STAR1 OT. It does not apply to the 11STMM10 OT or the
11STGE12 OT and 43STX4/43STX4P.
Restriction : The MAPPINGMODE parameter does not apply to
the 112SCX10 OT.
Restriction : The MAPPINGMODE parameter does not apply to
the 112SNX10 OT.
Restriction : The MAPPINGMODE parameter does not apply to
the 112SX10L OT.
Restriction : The MAPPINGMODE parameter does not apply to
11DPE12 and 11DPE12E line side.
Restriction: The MAPPINGMODE parameter does not apply to
11DPM12 lind side.
Restriction : The MAPPINGMODE parameter apply to 11QPA4
and 11QTA4 OT line side.

TX_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system.
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an ODUk information structure or the Path
Monitoring overhead of the ODUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The TX_SAPI parameter does not apply to the 112SX10L OT
The TX_SAPI parameter does not apply to the 112SCX10 OT
The TX_SAPI parameter does not apply to the 112SNX10 OT
The TX_SAPI parameter does not apply to the 11QPA4 and
11QTA4 client side

EXP_SAPI= Value Description


<0-15 characters>

1830PSS R3.6.50 - TL1 Commands and Messages 505


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU2
Default: <Previously-existing value> Null character initially set by the
system
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection
The TIMMRESP paramter does not apply for the 112SX10L client
AID.
The TIMMRESP paramter does not apply for the 112SCX10 client
AID.
The TIMMRESP paramter does not apply for the 112SNX10 client
AID.
The TIMMRESP paramter does not apply for the 11QPA4 and
11QTA4 client AID.

506 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU2 Issue 1, December 2011

PTMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID
Description: ODU2 Payload Type Mismatch Response. This parameter
determines whether an OT will take a Consequent Action or pass
the received signal.
ENABLED Enabled
DISABLED Disabled

PLDTYPE= Value Description


<0-255> decimal format

Default: <Previously-existing value> initially set by the system based on the


client signal. If no client signal is provisioned then the NULL
(decimal 253) value is used.
Addressing: Line AID
Description: Payload Type (PT) field content of a Payload Structure Identifier
(PSI) of the OTUk structure. PLDTYPE has a default value and is
based on the encoded client signal.
PLDTYPE only applies when the client signal is not an OTM0.2
signal.
This parameter only applies to the 11STAR1 and 11STGE12 OTs.
This parameter doesn't apply to the 11STMM10 OT and
43STX4/43STX4P OTs.
This parameter doesn't apply to the 112SX10L OT client AID.
This parameter doesn't apply to the 112SCX10 OT client AID.
This parameter doesn't apply to the 112SNX10 OT client AID.
This parameter doesn't apply to the 43SCX4L or 43SCX4 OT client
AID.
This parameter doesn't apply to the 11QPA4 and 11QTA4 OT
client AID.
In order to facilitate interworking with non compliant PT values, it
shall be possible to provision the payload type to a different value
in decimal format. The following table shall be used for the default
values.

1830PSS R3.6.50 - TL1 Commands and Messages 507


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU2

MSB LSB Hex code Decimal Interpretation


1234 5678 Format
1111 1101 FD 253 NULL- No client signal
0000 0010 02 2 Asynchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0011 03 3 Bit synchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0101 05 5 GFP mapping (standard)
10G LAN PHY GFP-F 10.709Gb/s
0001 0100 20 32 ODUk multiplexed structure
1000 xxxx 80-8F 128-143 Reserved codes for proprietary use
" " 80 128 10GbE LAN PHY Proprietary GFP-F with
Preamble transparency 10.709Gb/s
" " 81 129 10G Fibre Channel CBR 11.27Gb/s
" " 82 130 10GbE LAN PHY- 11.049Gb/s Mode CBR
" " 83 131 10GbE LAN PHY- 11.096Gb/s Mode CBR

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

508 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU2 Issue 1, December 2011

Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SABT Status, Aborted
• this command is issued to set PLDTYPE Payload Type (line AID) parameter when the client
signal is an OTU2 (OTM0.2)

SNVS Status, Not in Valid State


• the facility specified in the AID field is unassigned

EXAMPLES

The following example shows the successful execution of a ED-ODU2


command on the line of an 11GxAR.
ED-ODU2:NODE-1:11STAR1-1-5-L1-1:123456:::mappingmode=ASYNC,tx_sapi=A
BCDEFGHIJKLMNO,exp_sapi=ABCDEFGHIJKLMNO,trccmp=ENABLE,tcaprof=USERLA
BEL, ,timmresp=DISABLED,ptmmresp=DISABLED,pldtype=02;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-ODU2
RMV-ODU2

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 509


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU2

510 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-ODU3


Command Name: ED-ODU3

PURPOSE
The ED-ODU3 command is used to edit parameters related to the ODU3 facility.
The ENT-ODU3 command is not supported. The ODU3 object entity shall be automatically created on
the line side by the system when the OT circuit pack is provisioned.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-ODU3:[TID]:AID:[CTAG]:::[MAPPINGMODE=][,TX_SAPI=][,EXP_SAPI=][,TR
CCMP=][,TIMMRESP=][,PTMMRESP=][,PLDTYPE=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 511


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU3
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

MAPPINGMODE= Value Description


BITSYNC bit synchronous CBR mapping per
definition in Section 17.1 of ITU-T
G.709 recommendation.
ASYNC mapping mode indicates asynchronous
CBR mapping per definition in Section
17.1 of ITU-T G.709 recommendation

Default: <Previously-existing value> BITSYNC initially set by the system.

Addressing: Line AID .


Description: ODUkP to CBRx mapping mode. This parameter indicates the
mapping mode that will be used when the client port signal is
provisioned to OC768_STM256, using the ENT-OC768
command.
Restriction : The MAPPINGMODE parameter applies to line AID
for 43STA1P only when client signal is not OTU3.
Restriction : The MAPPINGMODE parameter applies to line AID
for 43SCA1 only when client signal is not OTU3.
Restriction : The MAPPINGMODE parameter does not apply to
the 43SCX4L or 43SCX4 Line AID.

TX_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system.
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an ODUk information structure or the Path
Monitoring overhead of the ODUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
Restriction : TX_SAPI cannot be set on the 43STA1P line port
when the client port signal is OTU3.

512 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU3 Issue 1, December 2011

Restriction : TX_SAPI cannot be set on the 43STA1P line port


when the client port signal is OTU3.
Restriction : TX_SAPI cannot be set on the 43SCA1 line port
when the client port signal is OTU3.
Restriction : TX_SAPI cannot be set on the 43SCX4 line port
when OPRMODE=REGEN

EXP_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

1830PSS R3.6.50 - TL1 Commands and Messages 513


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU3
Restriction : TIMMRESP parameter applies for 43STA1P ODU3
line only when client signal is not OTU3.
Restriction : TIMMRESP parameter applies for 43SCA1 ODU3
line only when client signal is not OTU3.
Restriction : TIMMRESP cannot be set on the 43SCX4 line port
when OPRMODE=REGEN

PTMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID
Description: ODU3 Payload Type Mismatch Response. This parameter
determines whether an OT will take a Consequent Action or pass
the received signal.
ENABLED Enabled
DISABLED Disabled
Restriction : PTMMRESP cannot be set on the 43STA1P line port
when the client port signal is OTU3.
Restriction : PTMMRESP cannot be set on the 43SCA1 line port
when the client port signal is OTU3.
Restriction : PTMMRESP cannot be set on the 43SCX4 line port
when OPRMODE=REGEN

PLDTYPE= Value Description


<0-255> decimal format

Default: <Previously-existing value> initially set by the system based on the


client signal. If no client signal is provisioned then the NULL
(decimal 253) value is used.
Addressing: Line AID
Description: Payload Type (PT) field content of a Payload Structure Identifier
(PSI) of the OTUk structure. PLDTYPE has a default value and is
based on the encoded client signal.
In order to facilitate interworking with non compliant PT values, it
shall be possible to provision the payload type to a different value
in decimal format. The following table shall be used for the default
values.

514 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU3 Issue 1, December 2011

MSB LSB Hex code Decimal Interpretation


1234 5678 Format
1111 1101 FD 253 NULL- No client signal
0000 0010 02 2 Asynchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0011 03 3 Bit synchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0101 05 5 GFP mapping (standard)
10G LAN PHY GFP-F 10.709Gb/s
0001 0100 20 32 ODUk multiplexed structure
1000 xxxx 80-8F 128-143 Reserved codes for proprietary use
" " 80 128 10GbE LAN PHY Proprietary GFP-F with
Preamble transparency 10.709Gb/s
" " 81 129 10G Fibre Channel CBR 11.27Gb/s
" " 82 130 10GbE LAN PHY- 11.049Gb/s Mode CBR
" " 83 131 10GbE LAN PHY- 11.096Gb/s Mode CBR

Restriction : PLDTYPE parameter is not aplicable to 43STA1P


OT.
Restriction : PLDTYPE cannot be set on the 43SCX4 line port
when OPRMODE=REGEN

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 515


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU3
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is unassigned

EXAMPLES

The following example shows the successful execution of a ED-ODU3


command on the line of a 43STX4 OT.
ED-ODU3:NODE-1:43STX4-1-5-L1-1:123456:::tx_sapi=ABCDEFGHIJKLMNO,exp_
sapi=ABCDEFGHIJKLMNO,trccmp=ENABLED,timmresp=DISABLED,ptmmresp=DISAB
LED,pldtype=20;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-ODU3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

516 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-ODU4


Command Name: ED-ODU4

PURPOSE
The ED-ODU4 command is used to edit parameters related to the ODU4 facility.
The ENT-ODU4 command is not supported. The ODU4 object entity shall be automatically created on
the line side by the system when the OT circuit pack is provisioned.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-ODU4:[TID]:AID:[CTAG]:::[,TX_SAPI=][,EXP_SAPI=][,TRCCMP=][,TIMMRE
SP=][,PTMMRESP=][,PLDTYPE=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 517


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU4
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

TX_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system.
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an ODUk information structure or the Path
Monitoring overhead of the ODUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

EXP_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).

518 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU4 Issue 1, December 2011

ENABLED enable compare


DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection
Restriction : TIMMRESP parameter applies for 112SCA1,
112SNA1 or 112SA1L ODU4 line only when client signal is not
OTU4.

PTMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: Line AID
Description: ODU4 Payload Type Mismatch Response. This parameter
determines whether an OT will take a Consequent Action or pass
the received signal.
ENABLED Enabled
DISABLED Disabled
Restriction : PTMMRESP cannot be set on the 112SCA1,
112SNA1, or 112SA1L line port when the client port signal is
OTU4.

PLDTYPE= Value Description


<0-255> decimal format

Default: <Previously-existing value> initially set by the system based on the


client signal. If no client signal is provisioned then the NULL
(decimal 253) value is used.
Addressing: Line AID
Description: Payload Type (PT) field content of a Payload Structure Identifier
(PSI) of the OTUk structure. PLDTYPE has a default value and is
based on the encoded client signal.
In order to facilitate interworking with non compliant PT values, it
shall be possible to provision the payload type to a different value

1830PSS R3.6.50 - TL1 Commands and Messages 519


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU4
in decimal format. The following table shall be used for the default
values.
MSB LSB Hex code Decimal Interpretation
1234 5678 Format
1111 1101 FD 253 NULL- No client signal
0000 0010 02 2 Asynchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0011 03 3 Bit synchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0101 05 5 GFP mapping (standard)
10G LAN PHY GFP-F 10.709Gb/s
0010 0000 20 32 ODUk multiplexed structure
0010 0001 21 33 GMP mapped client
1000 xxxx 80-8F 128-143 Reserved codes for proprietary use
" " 80 128 10GbE LAN PHY Proprietary GFP-F with
Preamble transparency 10.709Gb/s
" " 81 129 10G Fibre Channel CBR 11.27Gb/s
" " 82 130 10GbE LAN PHY- 11.049Gb/s Mode CBR
" " 83 131 10GbE LAN PHY- 11.096Gb/s Mode CBR

Restriction : PLDTYPE parameter is not aplicable to the


112SCA1, 112SNA1, 112SA1L OT client port.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

520 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODU4 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is unassigned

EXAMPLES

The following example shows the successful execution of a ED-ODU4


command on the line of a 112SCX10 OT.
ED-ODU4:NODE-1:112SCX10-1-5-L1-1:123456:::tx_sapi=ABCDEFGHIJKLMNO,ex
p_sapi=ABCDEFGHIJKLMNO,trccmp=ENABLED,timmresp=DISABLED,ptmmresp=DIS
ABLED,pldtype=20;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-ODU4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 521


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODU4

522 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-ODUF


Command Name: ED-ODUF

PURPOSE
The ED-ODUF command is used to edit parameters related to the non-terminated ODUFlex tributary
for specified ODUFlex facility.
The LO-ODUF object entity shall be automatically created on the line side by the system when the Line
port has provisioned LO(low order) ODUk sub-structure on ODU2.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-ODUF:[TID]:AID:[CTAG]::[TRCCMP=][,EXP_SAPI=][,TIMMRESP=][,PST=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the ODUFlex
entity .

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 523


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODUF

TRCCMP= Value Description


{ENABLED , DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

EXP_SAPI= Value Description


<0-15 characters>

Default: <Previously-existing value> Null character initially set by the


system
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

PST= Value Description


{IS,OOS}

Default: <Previously-existing value with OOS as factory default>


Addressing: None

524 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODUF Issue 1, December 2011

Description: Admin State, specifies the admin state to


which the facility is set. In Client side, under IS,
LO ODU alarm will report if cross-connect exists and
there is alarm. In Line side, under IS, LO ODU alarm
will report if alarm exist regardless the present of
cross-connect. OOS will suppress the LO ODU alarm
reporting.
IS In Service
OOS Out Of Service
It only applies to 11DPM12 Line port Low Order ODUk.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a ED-ODUF command on the line of a
11DPM12 OT:
ED-ODUF:NODE-1:11DPM12-1-5-L1-ODU2ODUF#1:123456::: trccmp=ENABLED,
exp_sapi=ABCDEFGHIJKLMNO, timmresp=DISABLED,pst=IS;

RELATED COMMANDS
RTRV-ODUF

1830PSS R3.6.50 - TL1 Commands and Messages 525


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODUF
RELATED AUTONOMOUS RESPONSES
REPT^DBCHG

526 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-ODUPTF


Command Name: EDIT FACILITY ODUPTF TERMINATION
ENTITY

PURPOSE
The ED-ODUPTF command shall be used to edit parameters related to the auto-created ODUPTF
instances.

11DPM12-<shelf>-<slot>-ODU1PTF{1-8} would be auto-created by the


system when the 11DPM12 circuit pack is provisioned.
This command is used to edit parameters related to the logical
ODUPTF facility.

INPUT FORMAT

ED-ODUPTF:[TID]:AID:[CTAG]:::[PLDTYPE=][,TX_STRUCT=][,EXP_STRUCT=][,
PTMMRESP=][,EXP_SAPI=][,TX_SAPI=][,TRCCMP=][,TIMMRESP=][,ODU0INTERWK
=][,PST]::;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 527


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODUPTF
Addressing: None
Description: Access Identifier, specifies an access Identifier of the ODU pool.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

PLDTYPE= Value Description


<0-255> decimal value

Default: 128
Addressing: None.
Description: Payload Type(PT) field content of a Payload Structure Identifier
(PSI) of the OTUk structure.
When it applies to ODU1PTF{1-8} on 11DPM12,ODU1
PLDTYPE could be set to 0x80 (decimal 128) and there
is proprietary encoding of OPTS OH in PSI bytes and
LosProp in APS.
For standard 2xODU0 equipment ODU1 PLDTYPE could be
set to 0x20 (ODU multiplex structure).
When it applies to 11DPM12-<shelf>-<slot>-L{1-2}-ODU2,
0x21 indicate a GMP capable multiplexed ODUk
structure.
0x20 indicate interworking with legacy 4xODU1 to ODU2
equipment.
This parameter does not applied to
11DPM12-<shelf>-<slot>-C{1-12}-ODU0,
11DPM12-<shelf>-<slot>-C{1-12}-ODU1.

TX_STRUCT= Value Description


< 0-400 VALID HOSTRUCT
ALPHANUMERICAL CHARACTERS >

Default: <Previously-existing value>


{Factory default for
ODU2=ODU0#1-1&ODU0#2-2&ODU0#3-3&ODU0#4-4&ODU0#5-
5&ODU0#6-6&ODU0#7-7&ODU0#8-8}
Addressing: None
Description: TX_STRUCT specifies the structure of the transmitting Time-slot
Map.
To create an ODU1PTF sub-structure user must enter a string
containing “ID-tsMap”, while ID specifies the unique ID assigned to

528 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODUPTF Issue 1, December 2011

the sub-structure with the range 1 to 16, and tsMap specifies the
numbers of time slots assigned to the sub-structure. The tsMap
can be a single TS number or TS ranges separated by comma and
enclosed in double quotation. If any TS to be assigned is
associated with another sub-structure which ID is non-zero value,
the creation of the sub-structure should be rejected.
To delete an ODU1PTF sub-structure user must enter the unique
ID within the range 1 to 16. Deleting the sub-structure, system will
create an ID=0 for each time slot. When the sub-structure of
ODUPTF is associated with cross-connect, the deletion should be
rejected.
To create an ODU2 sub-structure users must enter a string
containing “odukType# oduid-tsMap”. When multiple looduk is
needed, users must use “&” to separate them.The valid
ODUkType is ODU0 ,ODU1 and ODUF.Oduid specifies the unique
ID assigned to the LO ODUk which is a single number between 1
to 8.tsMap specifies the number of Time Slots assigned to the LO
ODUk which can be a single TS number or TS ranges separated
by comma and enclosed in double quotation
The ODU2 sub-structure can only be changed when the admin
State of the related LO ODUk is down and no XC present.
It does not applied to
11DPM12-<shelf>-<slot>-C{1-12}-ODU0,
11DPM12-<shelf>-<slot>-C{1-12}-ODU1,11DPM12-<shelf>-<s
lot>-C{1-12}-ODUF.

EXP_STRUCT= Value Description


< 0-400 VALID HOSTRUCT
ALPHANUMERICAL CHARACTERS >

Default: Factory default for


ODU2=ODU0#1-1&ODU0#2-2&ODU0#3-3&ODU0#4-4&ODU0#5-
5&ODU0#6-6&ODU0#7-7&ODU0#8-8
Addressing: None
Description: EXP_STRUCT specifies the structure of the expected Time-slot
Map
To create an expected ODU1PTF sub-structure user must enter a
string containing “clientSignalType#ID-tsMap”. While
clientSignalType specifies the client signal type is to be carried in
the sub-structure. Valid client signal types are:
1GBE,FC100,FC200,FC400, HDSDI, OC3, OC12, OC48, STM1,
STM4, STM16 and SDSDI,3GSDI. ID specifies the unique ID
assigned to the sub-structure within the range 1 to 16. And tsMap
specifies the numbers of time slots assigned to the sub-structure.
The tsMap can be a single TS number or TS ranges separated by
comma and enclosed in double quotation . If any TS to be
assigned is associated with another sub-structure which ID is
non-zero value, the creation of the sub-structure should be
rejected.
To provision expected LO ODUk of HO ODU2, users must enter a
string containing “odukType#oduid-tsMap”. When multiple looduk
is needed, users must use “&” to separate them.

1830PSS R3.6.50 - TL1 Commands and Messages 529


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODUPTF
It does not applied to
11DPM12-<shelf>-<slot>-C{1-12}-ODU0,
11DPM12-<shelf>-<slot>-C{1-12}-ODU1,11DPM12-<shelf>-<s
lot>-C{1-12}-ODUF.

PTMMRESP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: Payload Type Mismatch Response. This
parameter determines whether an OT will take a
Consequent Action or pass the received signal.
ENABLED Enabled
DISABLED Disabled

EXP_SAPI= Value Description


<0-15 characters>

Default: Null character (15 bytes each with hex value 00)
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).

TX_SAPI= Value Description


<0-15 characters>

Default: Null character (15 bytes each with hex value 00)
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI).

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).

530 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODUPTF Issue 1, December 2011

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: Optical Channel Path Trace Identifier
Mismatch Response. This parameter determines whether
an OT will take a Consequent Action (or pass the
received optical channel upon detection of an optical
channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

ODU0INTERWK= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description:ODU0 Interworking. ODU0INTERWK refers to
whether standard ODU0 Interworking is used (ENABLED or
DISABLED). When ODU0INTERWK=DISABLED, ODU1 Payload
Type (PT) should be set to 0x80 and there is
proprietary encoding of OPTS OH in the PSI bytes and
LosProp in APS/PCC bytes. The 11DPM12 OT can then
interwork at 2xODU0 only with another 4DPA4 OT. When
ODU0INTERWK=ENABLED, the ODU1 PT should be set to 0x20
(ODU multiplex structure), and there is no proprietary
use of PSI or APS/PCC bytes. The 11DPM12 OT can then
interwork with standard 2xODU0 equipment.
ENABLED Enabled
DISABLED Disabled
It only applies to AID for
11DPM12-<shelf>-<slot>-ODU1PTF{1-8}.

PST Value Description


{IS,OOS}

Default:
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 531


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODUPTF
Description:Admin State, specifies the admin state to
which the facility is set. OOS will suppress the
ODUPTF alarm reporting.
IS In Service
OOS Out Of Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the sub-structure is associated with XC

• TX_STRUCT or EXP_STRUCT, if any TS to be assigned is associated with another sub-structure


which ID is non-zero value

EXAMPLES
The following example shows the successful execution of a ED-ODUPTF command on 11DPM12
ODU1PTF1:

532 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-ODUPTF Issue 1, December 2011

ED-ODUPTF:NODE-1:11DPM12-1-7-ODU1PTF1:xyz:::pldtype=128,tx_struct=”1
-1,3,5,7,9,11,13,15”,exp_struct=”1gbe#1-1,3,5,7,9,11,13,15”,ptmmresp
=disabled,tx_sapi="AB", exp_sapi="ABC",
trccmp=ENABLED,timmresp=DISABLED,odu0intwk=disabled,pst=IS::;

The following example shows the successful execution of a ED-ODUPTF command on 11DPM12
ODU1PTF1 :

ED-ODUPTF:NODE-1:11DPM12-1-7-ODU1PTF1:xyz:::pldtype=128,tx_struct=”1
-1,3,5,7,9,11,13,15”,exp_struct
=”1gbe#1-1,3,5,7,9,11,13,15”,ptmmresp=disabled, tx_sapi="AB",
exp_sapi="ABC",
trccmp=ENABLED,timmresp=DISABLED,odu0intwk=disabled,pst=IS::;

The following example shows the successful execution of a ED-ODUPTF command on 11DPM12 line
port ODU2:
ED-ODUPTF:NODE-1:11DPM12-1-7-L1-ODU2:123456::: pldtype=33,
tx_struct=”ODU1#2-2,3&ODU0#4-4”, exp_struct=”ODU1#2-2,3&ODU0#4-4”, ptmmresp=disabled,
tx_sapi="AB", exp_sapi="ABC", trccmp=ENABLED,timmresp=DISABLED,pst=IS::;
The following example shows the successful execution of a ED-ODUPTF command on 11DPM12 line
port ODU2ODU1:

ED-ODUPTF:NODE-1:11DPM12-1-7-L1-ODU2ODU1#1:123456::: ,,,
ptmmresp=disabled, tx_sapi="AB", exp_sapi="ABC",
trccmp=ENABLED,timmresp=DISABLED,pst=IS::;

RELATED COMMANDS
RTRV-ODUPTF

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 533


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-ODUPTF

534 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OSPF-AREA


Command Name: ENTER OSPF AREA

PURPOSE
The ED-OSPF-AREA command creates an OSPF area in the NE. The NE can be part of up to 3
OSPF areas, in addition to the default backbone area (0-0-0-0). After an OSPF Area is created, it can
then be assigned to a OAMP, VOIP, E1, E2, OSC or GCC interface.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OSPF-AREA:[TID]:AID:[CTAG]:::[,AREATYPE=][,OPQLSADNS=][,OPQLSAWAV
KEY=][,NSSATRANSLATE=][,STUBDFTMTC=][,VIRTUALLINK=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


OSPFAREA-{0-3} ( OSPF Areas)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access identifier for an OSPF Area.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 535


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF-AREA

AREATYPE= Value Description


NORMAL
STUB
TOTALLY-STUB
NSSA
NSSA-TOTALLY-STUB

Default: NORMAL
Addressing: None
Description: Specifies an OSPF area type:

normal areas are defined as areas that can accept


intra-area, inter-area and external routes.
Default: normal

stub areas do not accept routes belonging to external autonomous


systems (AS); however, these areas have inter-area and intra-area
routes. This reduces the size of the routing databases for the
area's internal routers. Routers in the stub area also contain a
default route which is advertised to the area by the Area Border
Router (ABR).
nssa (Not So Stub Areas) can import AS external routes from
within the area and send them to other areas, but cannot receive
AS external routes from other areas. Inter-area and intra-area
routes are allowed along with a default route which is advertised to
the area by the ABR..
totally_stub areas do not allow routes other than intra-area and
the default route to be propagated within the area. This further
reduces the size of the routing databases for the area's internal
routers. The ABR advertises a default route into the area and all
the routers belonging to this area use the default route to send any
traffic outside the area.

nssa_totally_stub areas are similar to nssa with the added


restriction that inter-area routes are not allowed.
OPQLSADNS=

{Y, N}
Default: Y
Addressing: None

536 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OSPF-AREA Issue 1, December 2011

Description: Opaque LSA status for the DNS


application. Determines, whether opaque
LSAs for the DNS application shall be distributed into
this OSPF area, and received from this area. DNS
opaque LSAs can only be enabled in one OSPF Area.

Y DNS opaque LSAs are distributed to the area, and


received from the area
N DNS opaque LSAs are not distributed to the
area, and not received from the area

OPQLSAWAVKEY=

{Y, N}
Default: Y
Addressing: None
Description: Opaque LSA status for the Wave KEY
application. Determines, whether opaque
LSAs for the Wave KEY application shall be
distributed into this OSPF area, and received from
this area.
Wave Key opaque LSAs can only be enabled in one OSPF
Area.
Y Wave KEY opaque LSAs are distributed to the
area, and received from the area
N Wave KEY opaque LSAs are not distributed to the
area, and not received from the area

NSSATRANSLATE Value Description


=
CANDIDATE
ALWAYS
NEVER
Default: CANDIDATE

Addressing: None
Description: Applicable only if area type is nssa or
nsssa_totally_stub. Determines behavior of NSSA ABR
router translation of internal area type 7 LSAs to
type 5 LSAs which get propagated into other areas.
• candidate OSPF ospf elects one of candidate routers to be a translator for this area.
•always router will be always used as translator for this area
•never router will never be used as translator for this area
Default: candidate

1830PSS R3.6.50 - TL1 Commands and Messages 537


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF-AREA

STUBDFTMTC= Value Description


{0-16777215}
Default: 10

Addressing: None
Description: Applicable only for stub, nssa type areas. Specifies the cost for
the default route originated by stub, nssa area ABR.

VIRTUALLINK= Value Description


Specify the Loopback interface IP
Address of the NE to terminate the
virtual link
Default: 0.0.0.0 (no vitual link)

Addressing: None
Description: Applicable only for normal Areas. Allows
for the creation of a virtual link for this area..
OSPF requires that all areas attach directly to Area
0.0.0.0, but the attachment need not be physical. One
can take any physical arrangement of areas and attach
them logically through OSPF virtual links. Specify
the Loopback interface IP Address of the NE to
terminate the virtual link. This NE should have an
interface that is connected to Area 0.0.0.0 and a non
0.0.0.0 Area.
Note: A virtual link must be configured on both NEs.
Virtual links can not be established through Area
0.0.0.0, stub, nssa type areas.
Note: When a virtual link is created across an OSC or GCC path,
the MTU size must be set to 1500 bytes for the OSC/GCC in
terfaces on that path.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

538 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OSPF-AREA Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the STUBDFTMTC is configured for area type NORMAL

• the NSSATRANSLATE is configured for area type NORMAL or STUB

• the VIRTULINK parameter is configured for area type STUB or NSSA

• the OPQLSADNS parameter is enabled in more than one area

• the OPQLSAWAVKEY parameter is enabled in more than one area

IEAE Input, Entity Already Exists


• the specified OSPFAREA already exists

IPNC Input, Parameter Not Consistent


• the specified AREAID is already being used by another OSPFAREA

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

EXAMPLES
In the following example, ED-OSPF-AREA provisions an OSPFAREA on a NE:

ED-OSPF-AREA::OSPFAREA-1:C0001:::AREAID=192-1-1-1,AREATYPE=STUB,OPAQ
UE-LSADNS=Y,NSSATRANSLATE=CANDIDATE,STUBDFTMTC=10,VIRTUAL-LINK=0.0.0
.0,SHORTCUT=DISABLE;

1830PSS R3.6.50 - TL1 Commands and Messages 539


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF-AREA
A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* ED-OSPF-AREA::OSPFAREA-1:C0001:::AREAID=192-1-1-1,AREATYPE=STUB
[C0001] (5) */
;

RELATED COMMANDS
DLT-OSPF-AREA
RTRV-OSPF-AREA

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

540 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OSPF-IF


Command Name: EDIT OSPF PROTOCOL INTERFACE

PURPOSE
The ED-OSPF-IF command sets the OSPF parameters on the specified interface. The following
interfaces can be set using this command:
• OAMP

• VOIP

• E1
• E2
• CIT

• SYSTEM

This command is supported for the following single network


interfaces:
- LAN-OAMP: the OAMP faceplate LAN connector on the active main
shelf FLC and USRPNL card
- This is intended for connecting the NE to the DCN for central
management
- LAN-CIT: the CIT faceplate LAN connector on one of the main shelf
FLC and EC cards
- This is intended for locally connecting a craft interface terminal
(ZIC).
- The ZIC can always reach the active FLC, even when plugged into
the inactive FLC's frontplate
- LAN-VOIP: the VOIP faceplate LAN connector on the active main
shelf MTX/USRPNL card
- This can be used for connecting VOIP telephone.
- LAN-E1: the E1 faceplate LAN connector on the active main shelf
MTX/USRPNL card for exteranal equipment (eg; RAMAN Amplifier)
- This can be used as a general purpose LAN in this release
- LAN-E2: the E2 faceplate LAN connector on the active main shelf
MTX/USRPNL card for exteranal equipment (eg; RAMAN Amplifier)
- This can be used as a general purpose LAN in this release

Each one of the above interfaces can be configured independently. OAMP, E1, E2, and VoIP can be
configured and considered valid only if they have been provisioned with an IP address using ED-IP-IF.
The CIT port only supports status = REDISTRIBUTE or DISABLE; OSPF cannot be enabled on the
CIT port. The "SYSTEM" shall configure only the Area ID for all OSC/GCC interfaces.
After making the change, verify that the change was made correctly using the RTRV-OSPF-IF
command.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

1830PSS R3.6.50 - TL1 Commands and Messages 541


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF-IF
INPUT FORMAT

ED-OSPF-IFACE:[TID]:AID:[CTAG]:::[STATUS=][,AREAID=][,HELLOINT=][,DE
ADINT=][,METRIC=][,RTPRIORITY=][,MD5KEY=][,MD5KEYID=][,MD5ENABLE=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


SYSTEM (ALL GCC/OSC interfaces)
LAN-{OAMP, CIT, VOIP, E1, E2}
(Customer LAN)

11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)

Default: <entry required>


Addressing: None

542 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OSPF-IF Issue 1, December 2011

Description: Access Identifier, specifies an access identifier to the USRPNL


Ethernet interfaces. The AID "SYSTEM" is used to configure the
OSPF Area of all OSC/GCC interfaces.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

STATUS= Value Description


ENABLE
DISABLE
REDISTRIBUTE

Default: <Previously existing value>


Addressing: None
Description: The OSPF Status of the port. The initial default for the OAMP, E1,
E2 and VOIP ports shall be DISABLE. When enabled, the interface
will participate in OSPF LSA exchanges. When set to
REDISTRIBUTE, the interface does not run OSPF protocol, but it
does advertise. The CIT port only supports DISABLE and
REDISTRIBUTE.
The status of the GCC and OSC ports cannot be modified. The
status is always set to ENABLE for these ports.
REDISTRIBUTE is only applicable to LAN AID.

AREAID= Value Description


{0-3}

Default: <Previously existing value> <system default 0>


Addressing: None
Description: Area ID of the OSPF Interface. By default, all interfaces reside in
the same area 0-0-0-0, i.e. the core. But each interface can be
separated into different OSPF areas, if desired. The specified area
must be previously provisioned with ENT-OSPF-AREA.

HELLOINT= Value Description


{1-65535}

Default: <Previously existing value> <system default 10>

1830PSS R3.6.50 - TL1 Commands and Messages 543


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF-IF
Addressing: None
Description: HELLO INTERVAL of the OSPF Interface. By default, the interface
shall be set to 10 seconds. This is the time elapsed before the next
HELLO PDU is sent.
This parameter is not supported for the CIT port.

DEADINT= Value Description


{1-65535}

Default: <Previously existing value> <system default 40>


Addressing: None
Description: DEAD INTERVAL of the OSPF Interface. By default, the interface
shall be set to four times the value of the HELLOINT, so the
default is 40 seconds. This is the time elapsed between not
hearing a router's Hello PDU before the neighbors will declare it
down. The dead interval is a timer used to timeout inactive
adjacencies. The dead interval value must always be greater than
the hello interval value.
This parameter is not supported for the CIT port.

METRIC= Value Description


{1-65535}

Default: <Previously existing value> <system default 10>


Addressing: None
Description: METRIC or Cost of the OSPF Interface. By default, the interface
shall be set to 10. The lower the cost, the better.
This parameter is not supported for the CIT port.

RTPRIORITY= Value Description


{0-255}

Default: <Previously existing value> <system default 1>


Addressing: None
Description: Router Priority of the OSPF Interface. By default, the interface
shall be set to 1. This parameter is used on the LAN to determine
which router will become the designated router.
This parameter is not supported for the CIT port.

MD5KEY= Value Description


{<1-16 CHARACTERS>}

Default: <entry required><system default= NUL>


Addressing: None

544 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OSPF-IF Issue 1, December 2011

Description: Key used for MD5 128 bit hash value key calculation. This
parameter is mandatory if KEYID is entered. The string shall be 1
to 16 uppercase, lowercase alphanumeric characters including
NUL character. The system default value is NUL.
This parameter is not supported for the CIT port and SYSTEM
AID.

MD5KEYID= Value Description


{1-255}

Default: <entry required>


Addressing: None
Description: MD5Key ID used for MD5 128bit hash value key calculation. This
parameter is mandatory if MD5KEY is entered.
This parameter is not supported for the CIT port and SYSTEM
AID.

MD5ENABLE= Value Description


Y
N

Default: N
Addressing: None
Description: Specifies if the authentication is activated (Y) or un-activated on
the OSPF area. This parameter can be used only if a MD5KEY
and MD5KEYID have been set
This parameter is not supported for the CIT port and SYSTEM
AID.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 545


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF-IF
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the specified AREAID was not previously provisioned on the NE

• the AID is anything other than the AIDs for the GCC, OSC, OAMP, E1, E2 and VOIP ports, and
HELLOINT, DEADINT, METRIC, RTRPRIORITY, MD5KEY, MD5KEYID or MD5ENABLE is set

• the AID is anything other than the AIDs for the OAMP, VOIP, E1, E2, and CIT ports, and STATUS
is set

• the specified DEADINT value is less than the HELLOINT value for the specified AID

IIEV Input, Invalid Entry Value


• the specified AID (for OAMP, E1, E2, CIT ports) is not yet assigned an IP address

IPNC Input, Parameter Not Consistent


• only one of the MD5KEY and MD5KEYID parameters is used

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

SCSN Status, invalid Command SequeNce


• MD5ENABLE parameter is entered and no authentication key is set for this interface

EXAMPLES
In the following example, ED-OSPF-IF provisions the OAMP port to have Status disabled. This means
that the OAMP port will no longer participate in OSPF exchanges.

546 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OSPF-IF Issue 1, December 2011

ED-OSPF-IF::LAN-OAMP:C0001:::STATUS=disable;

A successful response for that command would be:

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
/* ED-OSPF-IF::LAN-OAMP:C0001:::STATUS=disable [C0001] (5) */
;

RELATED COMMANDS
RTRV-OSPF-IF

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 547


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF-IF

548 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OSPF


Command Name: EDIT OSPF (OPEN SHORTEST PATH
FIRST) PARAMETERS

PURPOSE
The ED-OSPF command modifies the global OSPF parameters
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OSPF:[TID]::[CTAG]:::[STATRTEXTMETRIC=][,STATRTEXTMTCTYPE=][,DEFR
TEXTMETRIC=][,DEFRTEXTMTCTYPE=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.
STATRTEXTMETRIC=

{0-16777214}
Default: <previously existing value, factory default is 20>

Addressing: None
Description: Static Route External Metric. Determines the cost metric value to
be set in all AS-External LSAs (Type 5 LSAs), which result from
ADVERTISED non default routes, which are configured via
ENT-NE-IPRT.

1830PSS R3.6.50 - TL1 Commands and Messages 549


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF

STATRTEXTMTCT Value Description


YPE=
{INT,EXT}

Default: <previously existing value, factory default is EXT>


Addressing: None
Description: Static Route External Metric Type.
Determines the metric type to be set in all
AS-External LSAs (Type 5 LSAs), which result from
ADVERTISED non default routes, which are configured
via ENT-NE-IPRT.

INT Internal metric type (metric type 1). The metric


value is assumed comparable to intra-AS metric values.

EXT External metric type (metric type 2). The metric


value is assumed higher than the path cost of any
intra-AS
DEFRTEXTMETRIC=

{0-16777214}
Default: <previously existing value, factory default is 10>
Addressing: None
Description: Default Route External Metric. Determines the cost metric value to
be set in all AS-External LSAs (Type5 LSAs), which result from
ADVERTISED default routes, which are configured via
ENT-NE-IPRT.

DEFRTEXTMTCTY Value Description


PE=
{INT, EXT}

Default: <previously existing value, factory default is EXT>

Addressing: None

550 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OSPF Issue 1, December 2011

Description: Default Route External Metric Type.


Determines the metric type to be set in all
AS-External LSAs (Type 5 LSAs), which result from
ADVERTISED default routes, which are configured via
ENT-NE-IPRT.

INT Internal metric type (metric type 1). The metric


value is assumed comparable to intra-AS metric values.

EXT External metric type (metric type 2). The metric


value is assumed higher than the path cost of any
intra-AS path.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^^DENY cr lf
^^^<ERROR^CODE> cr lf
[^^^/*^<Expanded^Error^Code^Description>^*/ cr lf]
[^^^/*^<Informational^Error^Description^Text>^*/ cr lf]
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the OSPF router id was not previously provisioned via the IP parameter of the ED-IP-IF command
(withAID=SYSTEM)

1830PSS R3.6.50 - TL1 Commands and Messages 551


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OSPF
EXAMPLES

In the following example, ED-OSPF modifies the Start Route External


Metric .
ED-OSPF:::C0001:::STARTEXTMETRIC=50;
A successful response would be:
^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* ED-OSPF:::C0001::: STARTEXTMETRIC=50 [C0001] (5) */
;

RELATED COMMANDS
RTRV-OSPF

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

552 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OTS


Command Name: EDIT-OTS

PURPOSE
The ED-OTS command is used to set the parameters of an optical line.

INPUT FORMAT

ED-OTS:[TID]:AID:[CTAG]:::[GAIN=][,MAXGAIN=][,MINGAIN=][,TYPE=][,MOD
ULETYPE=][,AINSTMR=][,AINSREF=][,DESCR=][,CMDMDE=][,DELTAGMAX=][,DEV
IATIONIN=][,DEVIATIONOUT=][,DROPTARGETPWR=][,GAINBACKOFF=][,TARGETPO
WER=][,TILT=][,LOSTHRESHOLD=][,LOSTOLERANCE=][,LOSOUTTHRESHOLD=][,LO
SOUTTOLERANCE=][,ADDCHANNELCNT=][,ADDDEGREECNT=][,ADDEGRESSPWR=][,MA
XFLATGAIN=][,TILTCALDCM=][,CONNADDRESS=][,CONNLOSS=][,OPPDIRECTION=]
[,INTOOUTGAIN=][,TILTTARGET=][,RAMFIBERTYPE=][,VOASETTING=]:[PST][,S
ST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 553


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTS

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Ports)
LINE, OSC}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Ports)
DCM, OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Ports)
DCM, OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-<slot>-EXP (SFD5/8 Expansion Port)
SFC-<shelf>-<slot>-EXP (SFC2/4 Expansion Port)
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Default: <entry required>


Addressing: None

554 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTS Issue 1, December 2011

Description: Access Identifier, specifies an access Identifier to the OTS.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

GAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)
{7.0-24.0} (MESH4)
{0-25.0} (RA2P)

Default: <previously existing value>


Addressing: None
Description: GAIN, Specifies the desired gain in dB.

MAXGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)
{7.0-24.0} (MESH4)
{0-20.0} (RA2P)

Default: <previously existing value>


Addressing: None
Description: MAXGAIN, Specifies the desired maximum gain in dB.

1830PSS R3.6.50 - TL1 Commands and Messages 555


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTS

MINGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)
{7.0-24.0} (MESH4)
{0-20.0} (RA2P)

Default: <previously existing value>


Addressing: None
Description: MINGAIN, Specifies the desired maximum gain in dB.

TYPE= Value Description


OC3
100BASEFX

Default: <previously existing value>


Addressing: None
Description: TYPE, Specifies the Signal type for the OSCT.

MODULETYPE= Value Description


SS-16.2O
SL-16.2O
SUL-1.2O
SEU-1.2O

Default: <previously existing value>


Addressing: None
Description: MODULETYPE, Specifies the Signal and SFP type for the OSC.
SS-16.2O OC3 Short Haul
SL-16.2O OC3 Long Haul
SUL-1.2O OC3 Ultra-Long Haul
SEU-1.2O OC3 Enhanced Ultra-Long Haul

556 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTS Issue 1, December 2011

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <previously existing value>


Addressing: None
Description: AINSTMR, Transition soak time out of AINS. Format is
HOURS-MINUTES. Maximum time is 96-00.
SYSTEM Use the system level timer

AINSREF= Value Description


SYSTEM

Default: <previously existing value>


Addressing: None
Description: AINSREF, Indicates the reference timer used for automatic
in-service transition.
SYSTEM Use the system level timer

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <previously existing value>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if it
contains non- alphanumeric characters.

CMDMDE= Value Description


{NORM,FRCD}

Default: <previously existing value>


Addressing: None
Description: CMDMDE, Command mode. Provides the capability to force the
facility OOS. Note: Forcing the facility OOS also forces all cross
connections along this facility to be set to OOS.
NORM Normal Operation
FRCD Force the facility OOS. Note: PST must also be set
to OOS for the Command Mode to be forced.

DELTAGMAX= Value Description


{0-99.99}

Default: <previously existing value>

1830PSS R3.6.50 - TL1 Commands and Messages 557


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTS
Addressing: None
Description: DELTAGMAX, Indicates the maximum allowed difference between
the provisioned gain and the measured gain before an alarm is
raised. Can only be provisioned on a manually managed line, use
ED-PWRMGMT-INGRESS/EGRESS for auto managed lines.

DEVIATIONIN= Value Description


{0-10.0}

Default: <previously existing value>


Addressing: None
Description: DEVIATIONIN, Indicates the Deviation-in values used for the
adjustment. Can only be provisioned on a manually managed line,
use ED-PWRMGMT-INGRESS/EGRESS for auto managed lines.

DEVIATIONOUT= Value Description


{0-10.0}

Default: <previously existing value>


Addressing: None
Description: DEVIATIONOUT, Indicates the Deviation-out values used for the
adjustment. Can only be provisioned on a manually managed line,
use ED-PWRMGMT-INGRESS/EGRESS for auto managed lines.

DROPTARGETPW Value Description


R=
{-26.5 to -4.0}

Default: <previously existing value>


Addressing: None
Description: DROPTARGETPWR, This indicates the per channel default
common power out of a CLS port. Can only be provisioned on a
manually managed line, use ED-PWRMGMT-INGRESS for auto
managed lines.

GAINBACKOFF= Value Description


{0-10.0}

Default: <previously existing value>


Addressing: None
Description: GAINBACKOFF, This indicates maximum allowed change in
amplifier gain. Can only be provisioned on a manually managed
line, use ED-PWRMGMT-INGRESS for auto managed lines.

558 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTS Issue 1, December 2011

TARGETPOWER= Value Description


{-30.0 to +11.0}

Default: <previously existing value>


Addressing: None
Description: TARGETPOWER, This indicates the per channel default common
power. Can only be provisioned on a manually managed line, use
ED-PWRMGMT-INGRESS/EGRESS for auto managed lines.

TILT= Value Description


{-3.0 to 0}

Default: <previously existing value>


Addressing: None
Description: TILT, Amplifier tilt. Can only be provisioned on a manually
managed line, use ED-PWRMGMT-INGRESS/EGRESS for auto
managed lines.

LOSTHRESHOLD= Value Description


{-32.0 to +20.0} for SFD5
{-32.0 to +17.0} for SFD8
{-26.0 to +9.8} for SFC2, SFC4, SFC8

Default: -32 for SFD, -26 for SFC


Addressing: None
Description: LOSTHRESHOLD, specifies the LOS threshold for the OMD port.

LOSTOLERANCE= Value Description


{0.5 to 6.0}

Default: 2.0
Addressing: None
Description: LOSTOLERANCE, difference between the set and clear points for
the OMD port LOS.

LOSOUTTHRESH Value Description


OLD=
{-32.0 to +20.0} for SFD5
{-32.0 to +17.0} for SFD8

Default: -32 for SFD


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 559


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTS
Description: LOSOUTTHRESHOLD, specifies the LOS threshold for the OMD
port output.

LOSOUTTOLERAN Value Description


CE=
{0.5 to 6.0}

Default: 2.0
Addressing: None
Description: LOSOUTTOLERANCE, difference between the set and clear
points for the OMD OUT port LOS.

ADDCHANNELCNT Value Description


=
{8-88}

Default: <previously existing value>


Addressing: None
Description: ADDCHANNELCNT, add path channel count, Indicates the
maximum number of channels supported on the add path using
this egress port.

ADDDEGREECNT= Value Description


{1-8}

Default: <previously existing value>


Addressing: None
Description: ADDDEGREECNT, add path degree count, Indicates the reserved
degree feed to this add path that using this egress port.

ADDEGRESSPWR Value Description


=
{-35.0 to 11.0}

Default: <previously existing value>


Addressing: None
Description: ADDEGRESSPWR, add path egress power, The desired output
power for each add channel as the channel comes out the CWR
SIG-OUT port. Only available on manually power managed lines.

MAXFLATGAIN= Value Description


{-5.0 to 5.0}

560 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTS Issue 1, December 2011

Default: <previously existing value>


Addressing: None
Description: MAXFLATGAIN, Provides a correction in dB to the assumed max
flat gain value.

TILTCALDCM= Value Description


{0.0 to 100.0}

Default: <previously existing value>


Addressing: None
Description: TILTCALDCM, Provides the coefficient, as a percentage, for the
SRSTilt equation for the DCM.

CONNADDRESS= Value Description


{SHELF/SLOT/PORT, DELETE}

Default: <previously existing value>


Addressing: None
Description: CONNADDRESS, Specifies the assigned port being monitored by
the wtocm input port.
SHELF/SLOT/PORT Address of monitored port
DELETE Clear the current address value

CONNLOSS= Value Description


{0.0 to 15.0}

Default: <previously existing value>


Addressing: None
Description: CONNLOSS, Specifies the installed loss between the port being
monitored and the wtocm input port.

OPPDIRECTION= Value Description


<valid port aid>

Default: <previously existing value>


Addressing: None
Description: OPPDIRECTION, Specifies the other uni-directional port, that with
this addressed port, creates a bi-directional connection point.

1830PSS R3.6.50 - TL1 Commands and Messages 561


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTS

INTOOUTGAIN= Value Description


{15.00-31.00} (AM2125A)
{15.0-31.0} (AM2125B)
{7.00-24.00} (AM2318A)

Default: <previously existing value>


Addressing: None
Description: INTOOUTGAIN, Specifies the gain from card input port to card
output port.

TILTTARGET= Value Description


{-3.00 to 0.00} non-Raman
{-3.00 to 3.00} RA2P

Default: <previously existing value>


Addressing: None
Description: TILTTARGET, Specifies the target tilt value.

RAMFIBERTYPE= Value Description


{SSMF, TWRS, ELEAF}

Default: <previously existing value>


Addressing: None
Description: RAMFIBERTYPE, Specifies the type of fiber connected to the
Raman amplifier.

VOASETTING= Value Description


{0 to 18.00}

Default: <previously existing value>


Addressing: None
Description: VOASETTING, Specifies the setting for the VOA after the
VGOAM.

PST Value Description


{IS,OOS}

Default: <previously existing value>


Addressing: None
Description: PST, Primary state.
IS In Service

562 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTS Issue 1, December 2011

OOS Out Of Service

SST Value Description


AINS
AINS-DEA
MT

Default: <previously existing value>


Addressing: None
Description: SST, Secondary state.
AINS Automatic In Service
AINS-DEA Automatic In Service Deactivated
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SABT Status, Aborted

1830PSS R3.6.50 - TL1 Commands and Messages 563


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTS
• the user attempts to provision DELTAGMAX, DEVIATIONIN, DEVIATIONOUT, TILT or
TARGETPOWER on a auto power managed line,

EXAMPLES
The following example shows the successful execution of a ED-OTS command.

ED-OTS:NODE-1:ALPHG-3-9-LINE:789012:::DESCR=WESTSIDE;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* ED-OTS */
;

RELATED COMMANDS
DLT-OTS
ENT-OTS
RMV-OTS
RST-OTS
RTRV-OTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

564 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OTU1


Command Name: ED-OTU1

PURPOSE
The ED-OTU1 command modifies the specified facility parameter values previously provisioned using
the ENT-OTU1 command. The ED-OTU1 command shall also be used to edit parameters related to
the OTU1 (line side).
The ENT-OTU1 on the line side is not supported on the 4DPA4 OT. The OTU1 object entity shall be
automatically created on the line side by the system when the OT circuit pack is inserted and
provisioned.
Executing an ED-OTU1 command causes primary and secondary state transitions for the specified
OTM0.1 facility.Primary and secondary states associated with the OTM0.1 facility after the command
is executed depend upon values entered for PST,SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OTM0.1 facility is free
of failures, OTU1 enters IS-NR or IS-ANR instead of OOS-AU,AINS.
If no values are entered for PST, SST no state change occurs .
When an OTU1 is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types are
cleared and a MAN condition type is set for the specified OTU1. The MAN condition type is cleared
when the OTU1 is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the OTU1 is deleted.
When an OTU1 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OTU1 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OTU1 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the OTU1 signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OTU1:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,OPRMODE=]
[,FECTYPE=][,TX_SAPI=][,EXP_SAPI=][,TRCCMP=][,TIMMRESP=][,LOSPROP=][
,MODULETYPE=][,CHANNEL=][,TS=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 565


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU1

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None.
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously-existing value>


Addressing: None.
Description: AINSTMR, indicates the transition soak time out of AINS.
The format of AINSTMR is HOURS-MINUTES. The maximum
time is 96-00. The minimum time is 00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.

566 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU1 Issue 1, December 2011

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

OPRMODE= Value Description


ADD_DROP
CROSSREGEN

Default: <Previously-existing value>


Addressing: None
Description: 4DPA4 line port operational mode. In ADD_DROP, client port
signals are added to and dropped from the line port. In
CROSSREGEN mode, line-to-line regeneration is performed and
no client ports are used. This parameter applies to 4DPA4 only ,
when cardMode=FlexMux.
Operational mode is directly provisionable only on
port L1. The value on port L2 is read-only, and is
always equal to the L1 value.
Operational mode is not provisionable when ports are
unassigned.

FECTYPE= Value Description


{NOFEC, RSFEC}

Default:
<Previously-existing value> For the 4DPA4 OT line AID, RSFEC is initially set by
the system.
<Previously-existing value> For the 11STMM10 client port AID, RSFEC is initially
set.
Addressing: None
Description: Forward Error Correction mode (FEC Mode). This parameter
indicates the type of Forward Error Correction on a DWDM line
and client side port.
NOFEC NO FEC (applies only to the 11STAR1 client AID)
RSFEC Reed-Solomon FEC (applies only to the 11STAR1
OT line AID and to the client AID)
The only values supported by the FECTYPE parameter on the
43STX4 and 43STX4P OTs are {NOFEC, RSFEC}.
FECTYPE applies to a client port AID when the signal type is
OTM0_1.

TX_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID

1830PSS R3.6.50 - TL1 Commands and Messages 567


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU1
<Previously-existing value> for client AID
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

EXP_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID
<Previously-existing value> for client AID
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare

568 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU1 Issue 1, December 2011

DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default:
<Previously-existing value> DISABLED initially set by the system for line AID
<Previously-existing value> for client AID
Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

LOSPROP= Value Description


{LASEROFF, LASERON}

Default:
<Previously existing value>
Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.
The LOSPROP parameter in the ED-OTU1 command only applies
to the 11STMM10 OT client AID. This parameter does not apply to
the 4DPA4 line AID.

MODULETYPE= Value Description


{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SS-16.1A,
SS-16.2C} (applicable to the
11STMM10 OT)
{AUTO, USER, SL-16.1, SL-16.2C,
SS-16.1A, SS-16.2C, SL-16.2D
,4FC-OC ,4FC-OD} (applicable to the
4DPA4 OT)

Default:
<Previously existing value>
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on the specified OTU1 port. If AUTO value
is chosen NE shall accept the pluggable module type inserted in

1830PSS R3.6.50 - TL1 Commands and Messages 569


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU1
the socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type which is not on the ALU
qualified list, without getting an alarm, this attribute shall be set to
USER.
Restriction: 4FC-OC, 4FC-OD module types are supported
by 4DPA4 line ports only when CardMode=DualTran.

CHANNELTX= Value Description


NONE (not yet assigned)
{9600, 9590, 9580, 9570, 9560, 9550,
9540, 9530, 9520, 9510, 9500, 9490,
9480, 9470, 9460, 9450, 9440, 9430,
9420, 9410, 9400, 9390, 9380, 9370,
9360, 9350, 9340, 9330, 9320, 9310,
9300, 9290, 9280, 9270, 9260, 9250,
9240, 9230, 9220, 9210, 9200, 9190,
9180, 9170} (DWDM frequencies;
applies to 4DPA4 OT Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs, and 4DPA4 Line
AIDs)
{850, 1310, 1550} (B&W wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs and 4DPA4 Line
AIDs)

Default:
<Previously-existing value> initially set by the system to NONE
Addressing: None
Description: Attribute defines transmit frequency of the transponder optical
interface. This parameter applies to the line port of the 4DPA4 OT
or the client port of the 11STMM10/11DPM12 OT.

570 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU1 Issue 1, December 2011

CHANNELRX= Value Description


NONE (not yet assigned)
{9600, 9590, 9580, 9570, 9560, 9550,
9540, 9530, 9520, 9510, 9500, 9490,
9480, 9470, 9460, 9450, 9440, 9430,
9420, 9410, 9400, 9390, 9380, 9370,
9360, 9350, 9340, 9330, 9320, 9310,
9300, 9290, 9280, 9270, 9260, 9250,
9240, 9230, 9220, 9210, 9200, 9190,
9180, 9170} (DWDM frequencies;
applies to 4DPA4 OT Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs, and 4DPA4 Line
AIDs)
{850, 1310, 1550} (B&W wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs and 4DPA4 Line
AIDs)

Default:
<Previously-existing value> initially set by the system to NONE
Addressing: None
Description: Attribute defines the receive frequency of the transponder optical
interface. This parameter applies to the line port of the 4DPA4 OT
or the client port of the 11STMM10/11DPM12 OT.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment on the Line port <ODU1#>-<Time Slot within
ODU1>. The entire string must be enclosed in double-quotes.
This parameter only applies to the 11STMM10 client port. It does
not apply to the 4DPA4 OT.

PST Value Description


{IS,OOS}

Default:
<Previously-existing value> IS initially set by the system for line AID
<Previously-existing value> for client AID
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 571


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU1
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


{AINS,AINS-DEA,MT}

Default:
<Previously-existing value> <Null> initially set by the system for line AID
<Previously-existing value> for client AID
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
This parameter applies to client side only.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

572 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU1 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• a command is issued to set the FECTYPE on the client AID, when the client signal is not an
OTU1 (OTM0.1) client (ENT-OTU1)

SNVS Status, Not in Valid State


• the facility specified in the AID field is unassigned

• this command is issued with PST of IS, SST of either <No Value> or AINS and the facility is under
loopback, i.e. carries a LPBK secondary state,

• this command is issued with secondary state of AINS or AINS-DEA, and current PST/SST is
shown in Table above as a deny scenario,

EXAMPLES

The following example shows the successful execution of a ED-OTU1


command on an 11STMM10 line port.
ED-OTU1:NODE-1:11STMM10-1-5-C1:123456:::fectype=RSFEC,tx_sapi=ABCDEF
GHIJKLMNO,exp_sapi=ABCDEFGHIJKLMNO,trccmp=ENABLED,timmresp=DISABLED:
IS,AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-OTU1
RST-OTU1
DLT-OTU1
ENT-OTU1
RMV-OTU1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 573


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU1

574 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OTU2


Command Name: ED-OTU2

PURPOSE
The ED-OTU2 command modifies the specified facility parameter values previously provisioned using
the ENT-OTU2 command. The ED-OTU2 command shall also be used to edit parameters related to
the OTU2 (line side).
The ED-OTU2 on the line side is not supported on the 11STAR1 OT. The OTU2 object entity shall be
automatically created on the line side by the system when the OT circuit pack is inserted and
provisioned.
Executing an ED-OTU2 command causes primary and secondary state transition for the specified
OTM0.2 facility. Primary and secondary states associated with the OTM0.2 facility after the command
is executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OTU2 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OTU2 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an OTU2 is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types are
cleared and a MAN condition type is set for the specified OTU2. The MAN condition type is cleared
when the OTU2 is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the OTU2 is deleted.
When an OTU2 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OTU2 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OTU2 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the OTU2 signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OTU2:[TID]:AID:[CTAG]:::[,AINSREF=][,AINSTMR=][,DESCR=][,OPRMODE=
][,CROSSREGPARTNER=][,MULTICASTFROM=][,OTURATE=][,FECTYPE=][,TX_SAPI
=][,EXP_SAPI=][,TRCCMP=][,TIMMRESP=][,LOSPROP=][,MODULETYPE=][,CHANN
ELTX=][,CHANNELRX=][,STPID=]:[PST],[SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 575


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2

AID Value Description


11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None.
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

576 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU2 Issue 1, December 2011

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously-existing value>


Addressing: None.
Description: AINSTMR, indicates the transition soak time out of AINS.
The format of AINSTMR is HOURS-MINUTES. The maximum
time is 96-00. The minimum time is 00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

OPRMODE= Value Description


{ADD_DROP, CROSSREGEN,
ADDONLY, DROPCONTINUE }

Default: <Previously-existing value> ADD_DROP by the system


Addressing: Line AID only
Description: The Operational Mode. This parameter configures the operational
mode of the line port only of an OT.
ADD_DROP bidirectional mode with a bidirectional signal
added and dropped
CROSSREGEN In this mode, the Line port input signal is looped towards another line port on the
same pack. This mode only applies to 11QPA4 pack.

ADDONLY in this mode, pack is processing signal in ingress


direction (from client side towards the line side). This mode only
applies to 11QPA4 pack.
DROP_CONTINUE In this mode, pack is processing the signal in
egress direction and looping the signal from the line side input
towards the line side output. This mode only applies to 11QPA4
pack.
This parameter does not apply to the 11STMM10 OT.
This parameter does not apply to the 43STX4, 43STX4P,
43SCX4L and 43SCX4 OT.
This parameter does not apply to the 112SCX10 OT.
This parameter does not apply to the 112SNX10 OT.
This parameter does not apply to the 112SX10L OT.

1830PSS R3.6.50 - TL1 Commands and Messages 577


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2

CROSSREGPART Value Description


NER=
L{1-4}

Default: NONE
Addressing: None
Description: The destination line port for the loopback. Only
applied to 11QPA4 line ports L{1-4}and OPRMODE is
CROSSREGEN. The value shall not be same as its port number

MULTICASTFROM Value Description


=
C{1-4}

Default: NONE
Addressing: None
Description: the destination MulticastFrom client port for this line port. Only
applied to 11QPA4 line ports L1-4 and OPRMODE is ADDONLY.

OTURATE= Value Description


{10.709, 11.049, 11.096}
{10.709, 11.049, 11.096, 11.27}

Default: 10.709
Note : for 11STGE12 OT the default value is 11.096.
Addressing: None
Description: OTU2 rate. Specifies the OTU2 rate (standard 10.709,
overclocked 11.049Gb/s, overclocked 11.096Gb/s)
OTURATE can be set on the client side only when the 11STAR1
client signal is OTM0.2 (see ENT-OTU2).
OTURATE can be set with values {10.709, 11.049, 11.096} for the
43SCX4L OT and 43SCX4 OT.
OTURATE can be set on the client side only when the 112SCX10
client signal is OTM0.2 (see ENT-OTU2). OTURATE values
supported on this pack are {10.709, 11.049, 11.096} The default
shall be 10.709.
OTURATE can be set on the client side only when the 112SNX10
client signal is OTM0.2 (see ENT-OTU2). OTURATE values
supported on this pack are {10.709, 11.049, 11.096} The default
shall be 10.709.
OTURATE can be set with values 11.049 Gb/s or 11.096 Gb/s for
11STGE12 OT.
OTURATE can be set with values 11.049 Gb/s or 11.096 Gb/s for
11DPE12 OT.

578 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU2 Issue 1, December 2011

OTURATE can be set with values 11.049 Gb/s or 11.096 Gb/s for
11DPE12E OT.
OTURATE can be set on the client side only when the 11QPA4
and 11QTA4 client signal is OTM0.2 (see ENT-OTU2). OTURATE
values supported on 11QPA4 are {10.709, 11.049, 11.096}.
OTURATE values supported on 11QTA4 are {10.709, 11.096}
The default shall be 10.709.
OTURATE can be set with values among {10.709, 11.049, 11.096}
for 11QPA4 line side working under CROSSREGEN mode.
OTURATE cannot be set in 11QTA4 line sides.
This parameter does not apply to 11QPA4 and 11QTA4 line side
under ADD_DROP mode.
The 10G FC rate of 11.27Gb/s (OTM11.27) is not supported in
REGEN mode due to the added propagation delay which will
cause login failure on the Fibre Channel.

The OTURATE parameter is not supported on the 43STX4 and


43STX4P OT.

FECTYPE= Value Description


{NOFEC,EFEC,RSFEC,EFEC2}
{NOFEC,EFEC,RSFEC,EFEC2}

Default:
<Previously-existing value> For the 11STAR1 OT line AID, EFEC is initially set by
the system.
<Previously-existing value> For the 11STAR1 OT client AID, RSFEC is initially
set.
<Previously-existing value> For the 43STX4, 43STX4P, 43SCX4L or 43SCX4
OT client AID, RSFEC is initially set.
<Previously-existing value> For the 11STMM10 or 11STGE12 or 11DPM12 OT
line AID, EFEC2 is initially set.
<Previously-existing value> For the 112SCX10/112SNX10 OT client AID, RSFEC
is initially set.
<Previously-existing value> For the 112SX10L OT client AID, RSFEC is initially
set.
Addressing: None
Description: Forward Error Correction mode (FEC Mode). This parameter
indicates the type of Forward Error Correction on a DWDM line
and client side port.
NOFEC NO FEC (applies only to the 11STAR1 client AID ,
43SCX4, 43SCX4L, 43STX4 and 43STX4P client
AID, 112SCX10, 112SX10L and 112SNX10 client
AID, 11QPA4 client AID, 11QTA4 client
AID,11STAR1A client AID)
EFEC Enhanced FEC (applies to the 11STAR1 and
11QPA4, 11QTA4, 11DPM12 line AID, 11STAR1A
line AID. Also applies to the 112SCX10/112SNX10

1830PSS R3.6.50 - TL1 Commands and Messages 579


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2
client AIDs and 112SX10L client AIDs, and
43SCX4/43SCX4L client AIDs.)
RSFEC Reed-Solomon FEC (applies to the 11STAR1 OT
line AID and client AID, the 112SCX10/112SNX10
and 112SX10L client AID, the 43SCX4 client AID,
the 43SCX4L client AID, 11STMM10 line AID, the
11STGE12 line AID, 11QPA4 client and line
side,11QTA4 client and line side, 11DPE12 line
side, 11DPE12E line side,11DPM12 line side,
11STAR1A OT client and line AID)
EFEC2 ALU FEC (applies to the 11STMM10 line AID,
11STGE12 OT line AID, 11QPA4 line AID, 11QTA4
line AID, 11DPE12 line AID, 11DPE12E line
AID,11DPM12 line AID, 11STAR1A line AID. Also
applies to the 112SCX10/112SNX10 client AIDs and
112SX10L client AIDs, and 43SCX4 client AIDs and
43SCX4L client AIDs.)
The only values supported by the FECTYPE parameter on the
43STX4 and 43STX4P client port are {NOFEC, RSFEC}.
The only values supported by the FECTYPE parameter on the
112SCX10 client port are {RSFEC, NOFEC, EFEC, EFEC2}.
The only values supported by the FECTYPE parameter on the
112SNX10 client port are {RSFEC, NOFEC, EFEC, EFEC2}.
The only values supported by the FECTYPE parameter on the
112SX10L client port are {RSFEC and NOFEC}.
The only values supported by the FECTYPE parameter on the
112SX10L client port are {RSFEC, NOFEC, EFEC, EFEC2}.
The values supported by the FECTYPE parameter on the
43SCX4L or 43SCX4 client port are {RSFEC, NOFEC, EFEC2,
EFEC}.
FECTYPE applies to a client port AID when the signal type is
OTU2 (OTM0_2).

TX_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID
<Previously-existing value> for client AID
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g., whose hex
representation is 0x00).

580 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU2 Issue 1, December 2011

15 ASCII characters, enclosed in quotation marks. The coded


representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

EXP_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID
<Previously-existing value> for client AID
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default:
<Previously-existing value> DISABLED initially set by the system for line AID
<Previously-existing value> for client AID

1830PSS R3.6.50 - TL1 Commands and Messages 581


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2
Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

LOSPROP= Value Description


{LASEROFF, LASERON}

Default:
<Previously existing value>
Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

582 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU2 Issue 1, December 2011

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for the
11STAR1, 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2B, XS-64.2C} for the
112SCX10 OT
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2B, XS-64.2C} for the
112SNX10 OT
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2B, XS-64.2C} for the
112SX10L OT
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
11QPA4 client side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
11QTA4 client side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the 11DPE12
line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the
11DPE12E line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C} for the 11QPA4
line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the 11DPM12
line side

Default:
<Previously existing value>
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 583


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on the specified OTU2 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type which
is not on the ALU qualified list, without getting an
alarm, this attribute shall be set to USER. This
parameter applies to the 11STAR1 OT , 43STX4 OT,
43STX4P OT, 43SCX4L OT, 43SCX4 OT, the
112SCX10/112SNX10 OT, the 112SX10L OT, 11QPA4, 11QTA4
client port, 11DPE12, 11STAR1A and 11DPE12E.
This parameter shall not apply to the 11QTA4 OT line port.

CHANNELTX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies; applies to Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)
{850, 1310, 1550} (B&W wavelengths;
applies to client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)

Default:
<Previously-existing value> initially set by the system to NONE
Addressing: None
Description: Attribute defines the transmit frequency of the transponder optical
interface. This parameter applies to the line port or client port of
the 11STAR1 OT, the line port of the 11STMM10 OT and the line
port of the 11STGE12 OT.
This parameter applies to a client port of the 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs.

584 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU2 Issue 1, December 2011

This parameter applies to the 11QPA4 and 11QTA4,


11DPE12,11DPE12E,11DPM12 OT.

CHANNELRX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies; applies to Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)
{850, 1310, 1550} (B&W wavelengths;
applies to client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)

Default:
<Previously-existing value> initially set by the system to NONE
Addressing: None
Description: Attribute defines the receive frequency of the transponder optical
interface.
This parameter does not apply to a client port of the 43STX4,
43STX4P, 43SCX4L and 43SCX4 OTs.
This parameter applies to the 11QPA4 and 11QTA4,
11DPE12,11DPE12E,11DPM12 OT.
This parameter applies to the client port of the 11STAR1 OT.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: STPID1
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 585


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

PST Value Description


{IS,OOS}

Default:
<Previously-existing value> IS initially set by the system for line AID
<Previously-existing value> for client AID
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


{AINS,AINS-DEA,MT}

Default:
<Previously-existing value> <with <Null> as the factory default>
<Previously-existing value> for client AID
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
This parameter applies to client side only.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

586 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU2 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• a command is issued to set the FECTYPE on the client AID, when the client signal is not an
OTU2 (OTM0.2) client (ENT-OTU2),

• a command is issued with CROSSREGPARTNER parameter, when the OPRMODE of 11QPA4


and 11QTA4 pack is not provisioned as CROSSREGEN

• a command is issued with no CROSSREGPARTNER parameter, when the OPRMODE of


11QPA4 and 11QTA4 pack is provisioned as CROSSREGEN

• a command is issued with CROSSREGPARTNER value equals to it's own line port , when the
OPRMODE of 11QPA4 and 11QTA4 pack is provisioned as CROSSREGEN

IDNV Input, Data Not Valid


• a command is issued to set FECTYPE to NOFEC on a line port entity

• a command is issued with MULTICASTFROM parameter, when the OPRMODE of 11QPA4 and
11QTA4 pack is not provisioned as ADDONLY

• a command is issued with no MULTICASTFROM parameter on 11QPA4 and 11QTA4 line port,
when the command is not issued with MULTICASTFROM parameter on the base multicast line
port first

SABT Status, Aborted


• a command is issued to set OPRMODE value of 11QPA4 and 11QTA4 as ADDONLY on a line
port, when the client port AID is not provisioned as 10GBE

• a command is issued to set OPRMODE value of 11QPA4 and 11QTA4 as DROPCONTINUE on a


line port, when the client port AID is not provisioned as 10GBE

1830PSS R3.6.50 - TL1 Commands and Messages 587


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2
• a command is issued to set MULTICASTFROM parameter on a line port of 11QPA4 and 11QTA4
, when the client port AID is not provisioned as 10GBE

• a command is issued with MULTICASTFROM parameter on a line port (not a base multicast line
port)of 11QPA4 and 11QTA4 , when the facility specified in the AID field of the client port
corresponding to this line port is assigned

• a command is issued with CROSSREGEN value of 11QPA4 and 11QTA4 for OPRMODE
parameter on a line port, when the client port loopback is active

• a command is issued with ADDONLY or DROPCONTINUE value for OPRMODE parameter on a


line port of 11QPA4 and 11QTA4 , when the client port loopback or line port loopback is active

• a command is issued with a new OPRMODE value on a line port of 11QPA4 and 11QTA4 , when
this line port belongs to one E-SNCP group

• a command is issued with ADDONLY or DROPCONTINUE or CORSSREGEN value for


OPRMODE parameter on a line port of 11QPA4 and 11QTA4 , when the client port loopback or
line port TCMMODE is Non intrusive monitoring (NIM) or Terminated

• a command is issued to change OPRMODE value to ADDONLY, when the current OPRMODE is
Cross Regen on a line port of 11QPA4 or 11QTA4

• a command is issued to change OPRMODE value to DROPCONTINUE, when the current


OPRMODE is CrossRegen on a line port of 11QPA4 or 11QTA4

SNVS Status, Not in Valid State


• the facility specified in the AID field is unassigned

• this command is issued with PST of IS, SST of either <No Value> or AINS and the facility is under
loopback, i.e. carries a LPBK secondary state,

• this command is issued with secondary state of AINS or AINS-DEA, and current PST/SST is
shown in Table above as a deny scenario,

• a command is issued to set the OTURATE on the client AID, when the client signal is not an
OTU2 (OTM0.2) client

588 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU2 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a ED-OTU2


command on an 11STAR1 line port.
ED-OTU2:NODE-1:11STAR1-1-5-L1:123456:::fectype=EFEC,tx_sapi=ABCDEFGH
IJKLMNO,exp_sapi=ABCDEFGHIJKLMNO,trccmp=ENABLED,timmresp=DISABLED:IS
,AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-OTU2
RST-OTU2
DLT-OTU2
ENT-OTU2
RMV-OTU2

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 589


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU2

590 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OTU3


Command Name: ED-OTU3

PURPOSE
The ED-OTU3 command shall be used to edit parameters related to the OTU3 (line side).
The ENT-OTU3 on the line side is not supported on the 43STX4/43STX4P and 43STA1P OTs. The
OTU3 object entity shall be automatically created on the line side by the system when the OT circuit
pack is inserted and provisioned.
The ENT-OTU3 on the line side is not supported on the 43STX4, 43STX4P, 43STA1P and 43SCA1
OTs. The OTU3 object entity shall be automatically created on the line side by the system when the OT
circuit pack is inserted and provisioned.
Executing an ED-OTU3 command causes primary and secondary state transitions for the specified
OTU3 facility. Primary and secondary states associated with the OTU3 facility after the command is
executed depend upon values enetered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OTU3 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OTU3 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an OTU3 is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types are
cleared and a MAN condition type is set for the specified OTU3. The MAN condition type is cleared
when the OTU3 is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the OTU3 is deleted.
When an OTU3 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OTU3 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OTU3 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the OTU2 signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OTU3:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,OPRMODE=]
[,FECTYPE=][,TX_SAPI=][,EXP_SAPI=][,TRCCMP=][,TIMMRESP=][,CHANNEL=][
,CHANNELTX=][,CHANNELRX=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 591


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU3

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None.
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously-existing value>


Addressing: None.
Description: AINSTMR, indicates the transition soak time out of AINS.
The format of AINSTMR is HOURS-MINUTES. The maximum
time is 96-00. The minimum time is 00-01.
Restriction : AINSTMR parameter can't be used for 43STA1P
OTU3 line.

592 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU3 Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

OPRMODE= Value Description


ADD_DROP
{ADD_DROP, REGEN}

Default: <Previously-existing value> ADD_DROP by the system


Addressing: Line AID only
Description: The Operational Mode. This parameter configures the operational
mode of the line port of the OT.
ADD_DROP bidirectional mode with a bidirectional signal
added and dropped
REGEN unidirectional transmission mode where the client
interface is not used.
Restriction : OPRMODE parameter can't be used for 43STA1P
OTU3 client.
The OPRMODE parameter shall apply to the 43SCA1 OT line
AIDs. The parameter does not apply to the 43SCA1 OT client
AIDs.

FECTYPE= Value Description


{AFEC, UFEC}
EFEC is used for 43STX4/43STX4P
OTs.
UFEC is used for 43STA1P line OT.
AFEC is used for 43STX4/43STX4P
OTs.
UFEC is used for 43STA1P line OT.
AFEC is used for the 43SCX4L OT and
the 43SCX4 OT
AFEC is used for the 43SCA1 OT

Default:

1830PSS R3.6.50 - TL1 Commands and Messages 593


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU3
<Previously-existing value> For the 43STX4 and 43STX4P
OTs line AID, EFEC is initially set by the system.

For the 43STA1P OT line AID, UFEC is initially set by


the system.

<Previously-existing value> For the 43STX4 and 43STX4P


OTs line AID, AFEC is initially set by the system.
For the 43STA1P OT line AID, UFEC is initially set by
the system.

<Previously-existing value> For the 43SCX4L or 43SCX4


line AID, AFEC is initially set by the system.

<Previously-existing value> For the 43SCA1 line AID,


AFEC is initially set by the system.

Restriction : FECTYPE parameter can not be used for 43STA1P


OTU3 client signals .
Restriction : FECTYPE parameter can not be used for 43SCA1
OTU3 client signals .
Addressing: None
Description: Forward Error Correction mode (FEC Mode). This parameter
indicates the type of Forward Error Correction on a DWDM line
and client side port.
EFEC Enhanced FEC (applies to the 43STX4 and
43STX4P OTs line AID)
The only value supported by the FECTYPE parameter on the
43STX4 and 43STX4P OTs is EFEC.
The only value supported by the FECTYPE parameter on the
43STX4 and 43STX4P OTs is AFEC.
The only value supported by the FECTYPE parameter on the
43SCX4L OT or 43SCX4 OT is AFEC.

TX_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,

594 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU3 Issue 1, December 2011

Clause 15.2. A TX_SAPI of less than 15 characters is padded out


to the right to 15 unprintable characters (e.g., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
Restriction : TX_SAPI parameter can't be used for 43STA1P
OTU3 client.
Restriction : TX_SAPI parameter can't be used for 43SCA1 OTU3
client.

EXP_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
Restriction : EXP_SAPI parameter can't be used for 43STA1P
OTU3 client signals.
Restriction : EXP_SAPI parameter can't be used for 43SCA1
OTU3 client signals.

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare

1830PSS R3.6.50 - TL1 Commands and Messages 595


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU3
DISABLED disable compare
Note : TRCCMP parameter can't be used for 43STA1P OTU3
client.
Note : TRCCMP parameter can't be used for 43SCA1 OTU3
client.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default:
<Previously-existing value> DISABLED initially set by the
system.
<Previously-existing value> for client AID
Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its input.

ENABLED enable TIMM defect detection

DISABLED disable TIMM defect detection


Restriction : TIMMRESP parameter can't be used for 43STA1P
OTU3 client.
Restriction : TIMMRESP parameter can't be used for 43SCA1
OTU3 client.

596 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU3 Issue 1, December 2011

CHANNEL= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170}
(DWDM frequencies; applies to Line
AIDs)
Restriction : for 43STX4 only even
DWDM channels are applicable.
Restriction : This parameter does not
apply to the 43SCX4 OT Line AID.

Default:
<Previously-existing value> initially set by the system to NONE
Addressing: None
Description: Attribute defines the frequency of the transponder optical interface.
This parameter applies to the line port of the 43STX4/43STX4P
and 43STA1P OTs.
Note : CHANNEL can't be used for 43STA1P OTU3 client
signals.

1830PSS R3.6.50 - TL1 Commands and Messages 597


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU3

CHANNELTX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170, 9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to
43SCX4 and 43SCA1Line AIDs)
{9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to
43SCX4L Line AID)
Restriction : This parameter only applies
to the 43SCX4L, 43SCX4, 43SCA1 Line
AID.
Restriction : This parameter does not
apply to the 43STA1, 43STX4, and
43STX4P Line AIDs.

Default:

598 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU3 Issue 1, December 2011

<Previously-existing value> initially set by the system to NONE


Addressing: None
Description: Attribute defines the transmit frequency of the transponder optical
interface. This parameter only applies to the line port of the
43SCX4L, 43SCX4, 43SCA1 OT.

1830PSS R3.6.50 - TL1 Commands and Messages 599


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU3

CHANNELRX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170, 9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to
43SCX4 and 43SCA1Line AIDs)
{9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to
43SCX4L Line AID)
Restriction : This parameter only applies
to the 43SCX4L, 43SCX4, 43SCA1 Line
AID.
Restriction : This parameter does not
apply to the 43STA1, 43STX4 and
43STX4P Line AIDs.

Default:

600 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU3 Issue 1, December 2011

<Previously-existing value> initially set by the system to NONE


Addressing: None
Description: Attribute defines the receive frequency of the transponder optical
interface. This parameter only applies to the line port of the
43SCX4 OT.
Description: Attribute defines the receive frequency of the transponder optical
interface. This parameter only applies to the line port of the
43SCX4L, 43SCX4, 43SCA1 OT.

LOSPROP= Value Description


{LASERON , LASEROFF}

Default:
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when a far end failure gets
signalled

Attribute applies to client ports only.

PST Value Description


{IS,OOS}

Default:
<Previously-existing value> IS initially set by the system for line AID
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


{AINS,AINS-DEA,MT}

Default:
<Previously-existing value> <Null> initially set by the system for line AID
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
This parameter applies to client side only.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

1830PSS R3.6.50 - TL1 Commands and Messages 601


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU3
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is unassigned

EXAMPLES

The following example shows the successful execution of a ED-OTU3


command on an 43STX4 OT line port.
ED-OTU3:NODE-1:43STX4-1-3-L1:123456:::fectype=AFEC,tx_sapi=ABCDEFGHI
JKLMNO,exp_sapi=ABCDEFGHIJKLMNO,trccmp=ENABLED,timmresp=DISABLED:IS,
AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

602 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU3 Issue 1, December 2011

RELATED COMMANDS
RTRV-OTU3
RST-OTU3
DLT-OTU3
RMV-OTU3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 603


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU3

604 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-OTU4


Command Name: ED-OTU4

PURPOSE
The ED-OTU4 command shall be used to edit parameters related to the OTU4 line interface on the
112SCA1 OT, the 112SNA1 OT, 112SCX10 OT, 112SNX10 OT, 112SA1L OT or the 112SX10L OT.
The ENT-OTU4 on the line side is not supported on the 112SCA1 OT, 112SNA1 OT, 112SCX10 OT,
112SNX10 OT, 112SA1L OT or the 112SX10L OT. The OTU4 object entity shall be automatically
created on the line side by the system when the OT circuit pack is inserted and provisioned.
Executing an ED-OTU4 command causes primary and secondary state transitions for the specified
OTU4 facility. Primary and secondary states associated with the OTU4 facility after the command is
executed depend upon values enetered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OTU3 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OTU4 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an OTU4 is edited to an OOS-MA or OOS-AUMA state, any facility specific condition types are
cleared and a MAN condition type is set for the specified OTU4. The MAN condition type is cleared
when the OTU4 is provisioned to an OOS-AU, IS-NR or IS-ANR state or when the OTU4 is deleted.
When an OTU4 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OTU4 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OTU4 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the OTU2 signal (112SCX10 OT and 112SX10L OT packs only).
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-OTU4:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,OPRMODE=]
[,FECTYPE=][,TX_SAPI=][,EXP_SAPI=][,TRCCMP=][,TIMMRESP=][,CHANNELTX=
][,CHANNELRX][,LOSPROP=][,MODULETYPE=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 605


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU4

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously-existing value>


Addressing: None.
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously-existing value>


Addressing: None.
Description: AINSTMR, indicates the transition soak time out of AINS.
The format of AINSTMR is HOURS-MINUTES. The maximum
time is 96-00. The minimum time is 00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

606 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU4 Issue 1, December 2011

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

OPRMODE= Value Description


{ADD_DROP, REGEN}

Default: <Previously-existing value> ADD_DROP by the system


Addressing: Line AIDs only
Description: The Operational Mode. This parameter configures the operational
mode of the line port of the OT.
ADD_DROP bidirectional mode with a bidirectional signal
added and dropped
REGEN unidirectional transmission mode where the client
interface is not used.
The OPRMODE parameter shall apply to the 112SCX10 OT, the
112SNX10 OT, and the 112SX10L OT line AID.
The OPRMODE parameter shall apply to the 112SCA1 OT,
112SNA1 OT, and 112SA1L OT line AIDs. The parameter does
not apply to the 112SCA1 OT, 112SNA1 OT and 112SA1L OT
client AIDs.

FECTYPE= Value Description


{AFEC}
The value AFEC is the only value
supported on the 112SCA1 OT line AID,
112SNA1 OT line AID, 112SA1L line
AID, 112SCX10 OT line AID,
112SNX10 OT line AID and 112SX10L
line AID.

Default:
<Previously-existing value> For the 112SCA1, 112SNA1, 112SCX10, 112SNX10,
112SA1L and 112SX10L OTline AIDs, AFEC is initially set by the
system.

Addressing: None
Description: Forward Error Correction mode (FEC Mode). This parameter
indicates the type of Forward Error Correction on a DWDM line
and client side port.
AFEC Advanced FEC (applies to the 112SCA1,
112SCX10, 112SA1L and 112SX10L line AIDs)

1830PSS R3.6.50 - TL1 Commands and Messages 607


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU4

TX_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

EXP_SAPI= Value Description


<0-15 characters>

Default:
<Previously-existing value> Null character (15 bytes each with hex value 00)
initially set by the system for line AID
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: <Previously-existing value> DISABLED initially set by the system.


Addressing: None

608 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU4 Issue 1, December 2011

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default:
<Previously-existing value> DISABLED initially set by the
system.
<Previously-existing value> for client AID
Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its input.

ENABLED enable TIMM defect detection

DISABLED disable TIMM defect detection

1830PSS R3.6.50 - TL1 Commands and Messages 609


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU4

CHANNELTX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170,9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to Line
AIDs on the 112SCA1, 112SNA1,
112SNX10 and 112SCX10 OTs)
{9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to Line
AIDs on the 112SA1L and 112SX10L
OTs)

Default:
<Previously-existing value> initially set by the system to NONE
Addressing: None
Description: Attribute defines the transmit frequency of the transponder line
side optical interface. This parameter applies to the line port of the

610 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU4 Issue 1, December 2011

112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10 and


112SX10L OTs.

CHANNELRX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170,9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to Line
AIDs on the 112SCA1, 112SNA1,
112SNX10 and 112SCX10 OTs)
{9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to Line
AIDs on the 112SA1L and 112SX10L
OTs)

Default:
<Previously-existing value> initially set by the system to NONE

1830PSS R3.6.50 - TL1 Commands and Messages 611


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU4
Addressing: None
Description: Attribute defines the receive frequency of the transponder line side
optical interface. This parameter applies to the line port of the
112SCA1, 112SA1L, 112SCX10, and 112SX10L OTs.

LOSPROP= Value Description


{LASERON , LASEROFF}

Default:
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when a far end failure gets
signalled

Attribute applies to client ports only.

MODULETYPE= Value Description


{AUTO, USER, C113G10C,
C113G4CD}

Default:
Addressing: None
Description: Attribute defines the CFP pluggable module type to be used to
provide the physical layer function on the specified client port. If
the value AUTO is chosen, the NE shall accept the pluggable
module type inserted if the previous pluggable module value was
<null>, and the pluggable module type matches one of the
qualified list of modules.

The MODULETYPE parameter in this command applies to the client port of the
112SCA1 OT or the 112SA1L OT.

PST Value Description


{IS,OOS}

Default:
<Previously-existing value> IS initially set by the system for line AID
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

612 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-OTU4 Issue 1, December 2011

SST Value Description


{AINS,AINS-DEA,MT}

Default:
<Previously-existing value> <Null> initially set by the system for line AID
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
This parameter applies to client side only.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility specified in the AID field is unassigned

1830PSS R3.6.50 - TL1 Commands and Messages 613


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-OTU4
EXAMPLES

The following example shows the successful execution of a ED-OTU4


command on an 112SCX10 OT line port.
ED-OTU4:NODE-1:112SCX10-1-3-L1:123456:::fectype=AFEC,tx_sapi=ABCDEFG
HIJKLMNO,exp_sapi=ABCDEFGHIJKLMNO,trccmp=ENABLED,timmresp=DISABLED:I
S,AINS;
IP 123456
<
^^^NODE-1 2002-08-17,09:30:49
M^^123456^COMPLD
;

RELATED COMMANDS
RTRV-OTU4
RST-OTU4
DLT-OTU4
RMV-OTU4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

614 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-PID


Command Name: EDIT PASSWORD IDENTIFIER

PURPOSE
The ED-PID command is used by a logged in user to change his/her current login password to a new
login password.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-PID:[TID]:UID:[CTAG]::OLDPID,NEWPID;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: Entry Required


Addressing: None
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 615


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PID

OLDPID Value Description


<8-32 VALID PID CHARACTERS,
depending on minlength and maxlength
provisioned values>

Default: <OLDPID parameter is required>


Addressing: None
Description: Old Password Identifier, specifies the user's old login password.

NEWPID Value Description


<8-32 VALID PID CHARACTERS,
depending on minlength and maxlength
provisioned values >

Default: <Entry Required>


Addressing: None
Description: New Password Identifier, specifies the user's new login password.
Valid values for NEWPID are a string of minlength through
maxlength case-sensitive alphanumeric characters, where
minlength is 8 by default and provisionable 8-32. The NEWPID
must contain at least three of the following: at least one lowercase
alphabetic character, at least one uppercase alphabetic character,
at least one numeric character, at least one special character. The
following special characters shall be valid: % (percent sign), +
(plus sign), # (pound sign), _ (under score), ! (exclamation mark),
@ (at sign), $ (dollar sign), “ (double quotation mark), &
(ampersand), ' (apostrophe), ( (left parenthesis), ) (right
parenthesis), * (asterisk), , (comma), and . (period). The first
character of the NEWPID can be an alphabetic, numeric, or a valid
special character.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

616 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PID Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• any user attempts to change the password of another user

• the new password is the same as the UID

• the new password is the same as the old password

• the new password is invalid because the new password is illegal (ie, syntax, format)

• the OLDPID is the wrong current password

• the UID is invalid because the UID is illegal (ie, syntax, format)

• the UID is invalid because the UID does not exist

IPMS Input, Parameter MiSsing


• An OLDPID value is not entered

EXAMPLES
The following example illustrates the command and associated output for changing the current
password of PIDUSER03 to the new password of MY_USER03 for the user with a UID of USER03.

ED-PID::USER03:::*********,*********;
AM1520 03-07-08 10:17:21
M P2c062 COMPLD
;

1830PSS R3.6.50 - TL1 Commands and Messages 617


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PID
RELATED COMMANDS
ENT-USER-SECU
ED-USER-SECU

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

618 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-PWRMGMT-EGRESS


Command Name: ED-PWRMGMT-EGRESS

PURPOSE
The ED-PWRMGMT-EGRESS command modifies the values of some parameters specified for
egress-power management. Note that this command only applies to the LD that is associated with auto
power managed line port.

INPUT FORMAT

ED-PWRMGMT-EGRESS:[TID]:AID:[CTAG]:::[ADDCHANNELCNT=][,ADDDEGREECNT=
][,ADDTARGETPWR=][,DELTAGMAX=][,LAUNCHATT=][,LOSSTOSPAN=][,MAXFLATGA
IN=][,MAXGAIN=][,MINGAIN=][,TARGETPOWER=][,TILT=][,TILTCAL=][,TILTCA
LDCM=][,TILTMULT=][,TILTPRECOMP=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)

Default: <entry required>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 619


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-EGRESS
Description: Access Identifier, specifies an access Identifier to the LD involved
in the egress adjustment.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

ADDCHANNELCNT Value Description


=
{8-88}

Default: <previously existing value>


Addressing: None
Description: ADDCHANNELCNT, add path channel count, Indicates the
maximum number of channels supported on the add path using
this egress port.

ADDDEGREECNT= Value Description


{1-8}

Default: <previously existing value>


Addressing: None
Description: ADDDEGREECNT, add path degree count, Indicates the reserved
degree feed to this add path that using this egress port.

ADDTARGETPWR Value Description


=
{-10.0 to 10.0}

Default: <previously existing value>


Addressing: None
Description: ADDTARGETPWR, Add Path Target Power; The desired power at
the output of the add path FGOAM.

DELTAGMAX= Value Description


{0-05.00}

Default: <previously existing value>


Addressing: None

620 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PWRMGMT-EGRESS Issue 1, December 2011

Description: DELTAGMAX, Indicates the maximum allowed difference between


the provisioned gain and the measured gain before an alarm is
raised.

LAUNCHATT= Value Description


{0.00 to 10.00}

Default: <previously existing value>


Addressing: None
Description: LAUNCHATT, Added to the nominal attenuation lookup by WSS
containing pack. Only applies to connectivity block in directionless
architecture.

LOSSTOSPAN= Value Description


{0.00 to 10.00}

Default: <previously existing value>


Addressing: None
Description: LOSSTOSPAN, Configurable loss from the egress Line Out to the
fiber span input.

MAXFLATGAIN= Value Description


{-5.0 to 5.0}

Default: <previously existing value>


Addressing: None
Description: MAXFLATGAIN, Provides a correction in dB to the assumed max
flat gain value.

MAXGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)

Default: <previously existing value>


Addressing: None
Description: MAXGAIN, Specifies the desired maximum gain in dB.

1830PSS R3.6.50 - TL1 Commands and Messages 621


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-EGRESS

MINGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)

Default: <previously existing value>


Addressing: None
Description: MINGAIN, Specifies the desired maximum gain in dB.

TARGETPOWER= Value Description


{-30.0 to +11.0}

Default: <previously existing value>


Addressing: None
Description: TARGETPOWER; Target power, This indicates the per channel
default common egress power.

TILT= Value Description


{-3.0 to 0}

Default: <previously existing value>


Addressing: None
Description: TILT, Amplifier tilt.

TILTCAL= Value Description


{0.0 to 100.0}

Default: <previously existing value>


Addressing: None
Description: TILTCAL, Provides the coefficient, as a percentage, for the
SRSTilt equation.

TILTCALDCM= Value Description


{0.0 to 100.0}

622 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PWRMGMT-EGRESS Issue 1, December 2011

Default: <previously existing value>


Addressing: None
Description: TILTCALDCM, Provides the coefficient, as a percentage, for the
SRSTilt equation for the DCM.

TILTMULT= Value Description


{0.0 to 3.0}

Default: <previously existing value>


Addressing: None
Description: TILTMULT, Used to modify the calculated SRS tilt of the span

TILTPRECOMP= Value Description


{0.0 to 3.0}

Default: <previously existing value>


Addressing: None
Description: TILTPRECOMP, Used to modify the fraction of following span
SRS tilt pre compensated.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 623


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-EGRESS
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
ICNV Input, Command Not Valid
• this command is issued on an LD that is associated with manual-power-managed line port

IDNV Input, Data Not Valid


• this command is issued with ADDCHANNELCNT specified out of 8 to 44 range

• this command is issued with ADDDEGREECNT specified out of 1 to 8 range

• this command is issued with ADDTARGETPWR specified out of -10 to 10 range

• this command is issued with TARGETPOWER specified out of -30 to 11 range

IENE Input, Entity does Not Exists


• this command is issued with ADDCHANNELCNT , but the associated CWR card is not installed
yet

• this command is issued with ADDDEGREECNT , but the associated CWR card is not installed yet

• this command is issued with ADDTARGETPWR , but the associated CWR card is not installed
yet

EXAMPLES
The following example shows the successful execution of an ED-PWRMGMT-EGRESS command.

ED-PWRMGMT-EGRESS:NODE-1:ALPHG-2-5:123456::: ADDCHANNELCNT=15;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* ED-PWRMGMT-EGRESS */
;

RELATED COMMANDS
ED-PWRMGMT-INGRESS
ED-PWRMGMT-TYPE
RTRV-PWRMGMT-INGRESS
RTRV-PWRMGMT-EGRESS
RTRV-PWRMGMT-TYPE
OPR-PWRMGMT
RTRV-PWRMGMT

624 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PWRMGMT-EGRESS Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 625


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-EGRESS

626 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-PWRMGMT-INGRESS


Command Name: ED-PWRMGMT-INGRESS

PURPOSE
The ED-PWRMGMT-INGRESS command modifies the values of some parameters specified for
ingress-power management. Note that this command only applies to the LD that is associated with
auto power managed line port.

INPUT FORMAT

ED-PWRMGMT-INGRESS:[TID]:AID:[CTAG]:::[DELTAGMAX=][,DEVIATIONIN=][,D
EVIATIONOUT=][,DROPTARGETPWR=][,GAINADJOFF=][,GAINBACKOFF=][,HEADROO
M=][,MAXFLATGAIN=][,MAXGAIN=][,MINGAIN=][,TARGETPOWER=][,TILT=][,TIL
TCALDCM=][,TILTPOSTCOMP=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)
WR-<shelf>-<slot>-ADDIN{1-8} (WR8-88A ADDIN Ports)

Default: <entry required>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 627


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-INGRESS
Description: Access Identifier, specifies an access Identifier to the LD.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DELTAGMAX= Value Description


{0-05.00}

Default: <previously existing value>


Addressing: None
Description: DELTAGMAX, Indicates the maximum allowed difference between
the provisioned gain and the measured gain before an alarm is
raised.

DEVIATIONIN= Value Description


{0-10.0}

Default: <previously existing value>


Addressing: None
Description: DEVIATIONIN, Indicates the Deviation-in values used for the
adjustment. Applies to the LINE port input direction.

DEVIATIONOUT= Value Description


{0-10.0}

Default: <previously existing value>


Addressing: None
Description: DEVIATIONOUT, Indicates the Deviation-out values used for the
adjustment. Applies to the SIG port output direction.

DROPTARGETPW Value Description


R=
{-26.5 to -4.0}

Default: <previously existing value>


Addressing: None

628 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PWRMGMT-INGRESS Issue 1, December 2011

Description: DROPTARGETPWR, This indicates the per channel default


common power out of a CLS port.

GAINADJOFF= Value Description


{-3.00 to 3.00}

Default: <previously existing value>


Addressing: None
Description: GAINADJOFF, Value in dB added to result of gain adjustment
calculation.

GAINBACKOFF= Value Description


{0-10.0}

Default: <previously existing value>


Addressing: None
Description: GAINBACKOFF, This indicates maximum allowed change in
amplifier gain.

HEADROOM= Value Description


{0-10.0}

Default: <previously existing value>


Addressing: None
Description: HEADROOM, provide the ripple allowance allocated to the WSS
that following this LD.

MAXFLATGAIN= Value Description


{-5.0 to 5.0}

Default: <previously existing value>


Addressing: None
Description: MAXFLATGAIN, Provides a correction in dB to the assumed max
flat gain value.

1830PSS R3.6.50 - TL1 Commands and Messages 629


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-INGRESS

MAXGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)

Default: <previously existing value>


Addressing: None
Description: MAXGAIN, Specifies the desired maximum gain in dB.

MINGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)

Default: <previously existing value>


Addressing: None
Description: MINGAIN, Specifies the desired maximum gain in dB.

TARGETPOWER= Value Description


{-30.0 to +11.0}

Default: <previously existing value>


Addressing: None
Description: TARGETPOWER, This indicates the per channel default common
egress power.

TILT= Value Description


{-3.0 to 0}

Default: <previously existing value>


Addressing: None

630 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PWRMGMT-INGRESS Issue 1, December 2011

Description: TILT, Amplifier tilt.

TILTCALDCM= Value Description


{0.0 to 100.0}

Default: <previously existing value>


Addressing: None
Description: TILTCALDCM, Provides the coefficient, as a percentage, for the
SRSTilt equation for the DCM.

TILTPOSTCOMP= Value Description


{0.0 to 3.0}

Default: <previously existing value>


Addressing: None
Description: TILTPOSTCOMP, Used to modify the fraction of upstream span
SRS tilt post compensated as a percentage.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 631


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-INGRESS
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
ICNV Input, Command Not Valid
• this command is issued on an LD that is associated with manual-power-managed line port

IDNV Input, Data Not Valid


• this command is issued with DEVIATIONIN specified out of 0 to 10 range

• this command is issued with DEVIATIONOUT specified out of 0 to 10 range

• this command is issued with HEADROOM specified out of 0 to 10 range

• this command is issued with TARGETPOWER specified out of -30 to 11 range

EXAMPLES
The following example shows the successful execution of an ED-PWRMGMT-INGRESS command.

ED-PWRMGMT-INGRESS:NODE-1:ALPHG-2-5:123456::: DEVIATIONIN=9;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* ED-PWRMGMT-INGRESS */
;

RELATED COMMANDS
ED-PWRMGMT-EGRESS
ED-PWRMGMT-TYPE
RTRV-PWRMGMT-INGRESS
RTRV-PWRMGMT-EGRESS
RTRV-PWRMGMT-TYPE
OPR-PWRMGMT
RTRV-PWRMGMT

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

632 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-PWRMGMT-TYPE


Command Name: ED-PWRMGMT-TYPE

PURPOSE
The ED-PWRMGMT-TYPE command modifies the power management type and commission status
for an external port.

INPUT FORMAT

ED-PWRMGMT-TYPE:[TID]:AID:[CTAG]:::[CONTROLTYPE=][,COMMISSIONSTATUS=
][,GAINADJSCH=][,GAINADJTMLEN=][,GAINADJTMPER=][,GAINADJTYPE=][,TILT
ADJTYPE=][,WTDUSAGE=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALPHG-<shelf>-<slot>-LINE (ALPHG LINE Port)
AHPHG-<shelf>-<slot>-LINE (AHPHG LINE Port)
AHPLG-<shelf>-<slot>-LINE (AHPLG LINE Port)
ALPFGT-<shelf>-<slot>-LINE (ALPFGT LINE Port)
A2325A-<shelf>-<slot>-LINE (A2325A LINE Port)
AM2017B-<shelf>-<slot>-LINE (AM2017B LINE Port)
AM2325B-<shelf>-<slot>-LINE (AM2325B LINE Port)
AM2125A-<shelf>-<slot>-LINEIN (AM2125A LINEIN Port)
AM2125B-<shelf>-<slot>-LINEIN (AM2125B LINEIN Port)
AM2318A-<shelf>-<slot>-LINEIN (AM2318A LINEIN Port)
RA2P-<shelf>-<slot>-LINEIN (RA2P LINEIN Port)
OSCT-<shelf>-<slot>-LINE (OSCT LINE Port)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the eternal port.

1830PSS R3.6.50 - TL1 Commands and Messages 633


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-TYPE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CONTROLTYPE= Value Description


{AUTO; MANUAL}

Default: <previously existing value>


Addressing: None
Description: CONTROL TYPE, Indicates the mode of power management on
this port.

COMMISSIONSTA Value Description


TUS=
{TRUE, FALSE}

Default: <previously existing value>


Addressing: None
Description: COMMSSION STATUS, Each external port has a Power
Management Commissioned Flag. When commissioning is
completed successfully the flag is set to TRUE.

GAINADJSCH= Value Description


{-1, 35999}

Default: <previously existing value>


Addressing: None
Description: GAINADJSCH, Used to enter the base period in hundreds of ms
past the hour for scheduled ingress adjustments.

GAINADJTMLEN= Value Description


{-1, 359.99}

Default: <previously existing value>


Addressing: None
Description: GAINADJTMLEN, Used to enter the length of enablement time for
the OMS section.

634 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PWRMGMT-TYPE Issue 1, December 2011

GAINADJTMPER= Value Description


{-1, 359.99}

Default: <previously existing value>


Addressing: None
Description: GAINADJTMPER, Used to enter the timer length between
enablements for the OMS section.

GAINADJTYPE= Value Description


{OFF, ON}

Default: <previously existing value>


Addressing: None
Description: GAINADJTYPE, Used to configure line behaviour. Off = no auto
adjusts, On = will enable adjustments, or do auto adjustments.

TILTADJTYPE= Value Description


{OFF, ON}

Default: <previously existing value>


Addressing: None
Description: TILTADJTYPE, If this value is on and line is OADM, controls
updates of the channel set information used for SRS Adjustment.
Value automatically updates at lines that pull the channel
information from upstream.

WTDUSAGE= Value Description


{WTDONON, WTOCM}

Default: <previously existing value>


Addressing: None
Description: WTDUSAGE, this parameter sets the hardware that measures the
channel power and wavetracker key information.
WTDONON Use the internal wavetracker decoders in
the LD and CWR cards for channel power and key
measurements.
WTOCM Provision the line to use the WTOCM for channel
power and key measurements.

1830PSS R3.6.50 - TL1 Commands and Messages 635


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-TYPE
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIFM Invalid Payload block. Invalid Data Format.
• this command is issued with CONTROLTYPE specified other than manual or auto

SRQN Status, iNvalid ReQuest


• Unkeyed connections exist on the target port

EXAMPLES
The following example shows the successful execution of an ED-PWRMGMT-TYPE command.

ED-PWRMGMT-TYPE:NODE-1:ALPHG-2-5-LINE:123456:::CONTROLTYPE=AUTO;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* ED-PWRMGMT-TYPE */ ;

636 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-PWRMGMT-TYPE Issue 1, December 2011

RELATED COMMANDS
ED-PWRMGMT-INGRESS
ED-PWRMGMT-EGRESS
RTRV-PWRMGMT-INGRESS
RTRV-PWRMGMT-EGRESS
RTRV-PWRMGMT-TYPE
OPR-PWRMGMT
RTRV-PWRMGMT

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 637


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-PWRMGMT-TYPE

638 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-RADIUS-SERVER


Command Name: ENTER RADIUS SERVER

PURPOSE

The ED-RADIUS-SERVER command is used to change/modify the RADIUS


server attributes which are provisioned through ENT-RADIUS-SERVER
command.
Access Level: admin

A server attributes consists of:


• the RADIUS server identifier,

• the RADIUS server's status,

• the RADIUS server's IP address,

• the RADIUS server's specific port number,

• shared secret key between the NE and the RADIUS server.


The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-RADIUS-SERVER:[TID]::[CTAG]::SERVERNUM,[STATUS]:[IPADDR=][,PORT=]
[,SECRET=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 639


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-RADIUS-SERVER
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SERVERNUM Value Description


RAD1
RAD2

Default: <Entry Required>


Addressing: None
Description: The following attributes are the valid server number to provision the
server:
RAD1: RAD1 is first server name.
RAD2: RAD2 is the second server name.

STATUS Value Description


ENABLE
DISABLE

Default: <Previously existing value>


Addressing: None
Description: This parameter is RADIUS server status. The valid values are the
following:
ENABLE The RADIUS server is on-line. This is the default value.
DISABLE The RADIUS server is off-line

IPADDR= Value Description


{1-99,
101-126,128-223}-{0-255}-{0-255}-{1-25
4}

Default: <Previously existing value>

Addressing: None
Description: This parameter is the IP address of the specified RADIUS server.

PORT= Value Description


{1-65000}

Default: 1812
Addressing: None
Description: This parameter is the authentication port of the RADIUS server.
The valid value is from 1 to 65000. The default port value is 1812.

640 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-RADIUS-SERVER Issue 1, December 2011

SECRET= Value Description


<5-32 VALID PID CHARACTERS>

Default: <Previously existing value>


Addressing: None
Description: This is the shared secret key between the NE and the target
RADIUS server. This key shall be an ascii string between 5 to 32
characters. The secret key must be encrypted on the NE using
AES or 3DES.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input Data Not Valid
• the command is issued with duplicate IP address (same address for both RAD1 and RAD2),
editing a server that does not exist

PICC Privilege, Illegal Command Code

1830PSS R3.6.50 - TL1 Commands and Messages 641


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-RADIUS-SERVER
• the command is issued by a non-privilege user

SNVS Not in Valid State


• the command is issued to change the parameters (except the status) and the server is not in
"disable" status

SRCN Requested Condition Already Exists


• the command is issued to change the status and the server is currently in the requested status

EXAMPLES
The following example illustrates the command and associated output formodifying the secret key
attribute of a RADIUS server (RAD1).

ED-RADIUS-SERVER::RAD1:,,,nbvcxz;

AM1520 03-07-08 10:22:51


M P08006 COMPLD
;

RELATED COMMANDS
DLT-RADIUS-SERVER
RTRV-RADIUS-SERVER

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

642 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-SESSION


Command Name: EDIT SESSION

PURPOSE
The ED-SESSION command is used by a user with administrator privileges to edit the existing session
timeout values, identified by the Session Identifier (SESSIONID), in the User Security Database.
All of the changes to the provisioned values shall be allowed and take effect immediately.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-SESSION:[TID]::[CTAG]::IDLETIME;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

IDLETIME Value Description


{0-99}

Default: Entry Required


Addressing: None
Description: Set the maximum length of time in minutes the session is allowed
to be idle before being cancelled. A value of zero (0) indicates that
the session never be cancelled.

1830PSS R3.6.50 - TL1 Commands and Messages 643


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-SESSION
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• the command is issued by a non-privilege user

PIUI Privilege Illegal User Identity


• the SESSIONID is invalid (ie., SESSION ID does not exist in the range)

EXAMPLES
The following example illustrates the command and associated output for editing the user security
database entry for user13 to change his password, and grant him access to “admin” privilege level.

ED-SESSION::151;

644 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-SESSION Issue 1, December 2011

AM1520 03-07-08 10:18:49


M P0a057 COMPLD
;

RELATED COMMANDS
DLT-SESSION
RTRV-SESSION

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 645


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-SESSION

646 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-STM16


Command Name: ED-STM16

PURPOSE
The ED-STM16 command creates (assigns and provisions) a specified STM16 client signal facility.
Executing an ED-STM16 command causes primary and secondary state transitions for the specified
STM16 facility. Primary and secondary states associated with the STM16 facility after the command is
executed depend upon values entered for PST,SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then STM16 enters IS-NR or IS-ANR.
If entered values for PST, SST are IS,AINS and AINSCNTDWN=00-00 when STM16 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a STM16 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM16 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM16 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM16 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-STM16:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,SDTH=][,
SFTH=][,J0_EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][
,MODULETYPE=][,CHANNEL=][,TS=][,CONTAINER=][,MAPPINGMODE=]:[PST][,SS
T];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 647


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM16

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM Use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum value is 96-00. The minimum time is
00-01.

648 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM16 Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4 and 4DPA2.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4 and 4DPA2.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0. Does not apply to 4DPA4 and 4DPA2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

1830PSS R3.6.50 - TL1 Commands and Messages 649


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM16

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4 and 4DPA2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4 and 4DPA2. Only 16-byte
format applies to 4DPA4 .

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4 and 4DPA2.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4 and 4DPA2.

650 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM16 Issue 1, December 2011

ENABLED enable compare


DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.
Restriction: Parameter LOSPROP does not apply to
4DPA2 OT.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C,
SL-16.2D,SS-16.1A, SS-16.2C}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on the specified STM16 port. If AUTO value
is chosen NE shall accept the pluggable module type inserted in
the socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Restrictions: SI-16.1 and SL-16.2 are not supported
on 4DPA2 OT.
SL-16.2C, SS-16.2C, and
SL-16.2D are the only types supported on the line port
of 4DPA2 OT.
SL-16.2D is not supported
on the client ports of 4DPA2 , 4DPA4 and 11STMM10
OTs.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>

1830PSS R3.6.50 - TL1 Commands and Messages 651


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM16
Addressing: None
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)
{L1,L2}-(1) (4DPA4 timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port (L1 or L2).
Timeslot 1 represents the entire OTU1 capacity (all 16 timeslots).
Parameter TS does not apply to 4DPA2 OT.

CONTAINER= Value Description


{None, ODU1}

Default: None
Addressing: None
Description: Specifies the granularity for client OC48 mapping to ODU2
multiplexing structure.
Set to odu1-mapping into ODU1 per G.709.
This parameter only applies to 11DPM12.

MAPPINGMODE= Value Description


{ASYNC, BITSYNC}

Default: None
Addressing: None
Description: Specifies the mapping mode for constant bit rate client signals into
OPUk.
ASNYC- asynchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation fuction.
BITSYNC-synchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation function.
This parameter only applies to 11DPM12 pack when
CONTAINER=ODU1.

652 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM16 Issue 1, December 2011

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 653


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM16
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

• this command is issued with a TCA profile that does not exists,

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-STM16


command.
ED-STM16:NODE-1:11STMM10-1-5-C1:xyz123:::SDTH=10-7:ODU1-L1-2-1:IS,AI
NS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM16
RST-STM16
DLT-STM16
ENT-STM16
RMV-STM16

654 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM16 Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 655


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM16

656 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-STM1


Command Name: ED-STM1

PURPOSE
The ED-STM1 command creates (assigns and provisions) a specified STM1 client signal facility.
Executing an ED-STM1 command causes primary and secondary state transitions for the specified
STM1 facility. Primary and secondary states associated with the STM1 facility after the command is
executed depend upon values entered for PST, SST and events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST them STM1 enters IS-NR or IS-ANR.
When a STM1 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM1 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM1 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM1 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-STM1:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,SDTH=][,S
FTH=][,J0_EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,
TS=][,MODULETYPE=][,CHANNEL=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 657


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM1
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


SYSTEM

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously exisiting value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum value is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

658 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM1 Issue 1, December 2011

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

1830PSS R3.6.50 - TL1 Commands and Messages 659


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM1

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

660 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM1 Issue 1, December 2011

TS= Value Description


ODU1-L1-{1-4}-{1, 4, 7, 10, 13, 16, 19,
22, 25, 28, 31, 34, 37, 40, 43, 46}
(11STMM10 timeslots)
{L1,L2}-({1-16}) (4DPA4
timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port (L1 or L2).

MODULETYPE= Value Description


{AUTO, USER, SL-1.1, SL-1.2,
SL-16.2C, SS-1.1, SS-16.1A, SS-16.2C
,FE-BX40D, FE-BX40U }

Default: <Previously existing value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on the specified STM1 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.
Restriction: The module types SS-1.1 , SL-1.2 , FE-BX40D,
FE-BX40U are supported only by 4DPA4 client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1490, 1530 ,1550 } (B&W
wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port or line port.
Restriction: 1490 and 1530 B&W wavelengths can be
used only for 4DPA4 client ports.

1830PSS R3.6.50 - TL1 Commands and Messages 661


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM1

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

662 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM1 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

• this command is issued with a TCA profile that does not exists,

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

1830PSS R3.6.50 - TL1 Commands and Messages 663


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM1
EXAMPLES

The following example shows the successful execution of a ED-STM1


command.
ED-STM1:NODE-1:11STMM10-1-5-C1:xyz123:::SDTH=10-7:ODU1-L1-2-1:IS,AIN
S;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM1
RST-STM1
DLT-STM1
ENT-STM1
RMV-STM1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

664 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-STM256


Command Name: ED-STM256

PURPOSE
The ED-STM256 command creates (assigns and provisions) a specified STM256 client signal facility.
Executing an ED-STM256 command causes primary and secondary state transitions for the specified
STM256 facility. Primary and secondary states associated with the STM256 facility after the command
is executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then STM256 enters IS-NR or IS-ANR.
When a STM256 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM256 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM256 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM256 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-STM256:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,J0_EX=]
[,J0_FMT=][,TRCCMP=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

1830PSS R3.6.50 - TL1 Commands and Messages 665


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM256

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


{SYSTEM}

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

666 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM256 Issue 1, December 2011

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 section trace value and the
provisioned (i.e., expected) J0 section trace value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signaled.

1830PSS R3.6.50 - TL1 Commands and Messages 667


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM256

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

668 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM256 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-STM256


command.
ED-STM256:NODE-1:43STA1P-1-5-C1:xyz123:::losprop=LASERON:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM256
RST-STM256
DLT-STM256
ENT-STM256
RMV-STM256

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 669


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM256

670 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-STM4


Command Name: ED-STM4

PURPOSE
The ED-STM4 command creates (assigns and provisions) a specified STM4 client signal facility.
Executing an ED-STM4 command causes primary and secondary state transitions for the specified
STM4 facility. Primary and secondary states associated with the STM4 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then STM4 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when STM4 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a STM4 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM4 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM4 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM4 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-STM4:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,SDTH=][,S
FTH=][,J0_EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,
TS=][,MODULETYPE=][,CHANNEL=][,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 671


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM4
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


{SYSTEM}

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.
00-96-00-59 Time, specifies the duration of an
alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum value is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

672 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM4 Issue 1, December 2011

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

1830PSS R3.6.50 - TL1 Commands and Messages 673


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM4

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: <Previously existing value>


Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

674 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM4 Issue 1, December 2011

TS= Value Description


ODU1-L1-{1-4}-{1, 13, 25, 37}
(11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: <Previously provisioned value>


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
OC12/STM4 requires 4 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

MODULETYPE= Value Description


{AUTO, USER, SL-4.1, SL-16.2C,
SS-4.1, SS-16.1A, SS-16.2C
,GE-BX20D, GE-BX20U, GE-BX40D,
GE-BX40U }

Default: <previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on the specified STM4 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.
Note:
GE-BX20D, GE-BX20U, GE-BX40D, GE-BX40U are
supported only on 4DPA4 client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)
{850, 1310, 1490, 1530, 1550} (B&W
wavelengths)

1830PSS R3.6.50 - TL1 Commands and Messages 675


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM4
Default: <previously provisioned value>
Addressing: None
Description: Specifies the channel frequency of the client port.
Restriction: 1490 and 1530 B&W wavelengths can be used only for 4DPA4
client ports.

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

676 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM4 Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

• this command is issued with a TCA profile that does not exists,

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 677


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM4
• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-STM4


command.
ED-STM4:NODE-1:11STM10-1-5-C1:xyz123:::SDTH=10-7:ODU1-L1-2-1:IS,AINS
;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM4
RST-STM4
DLT-STM4
ENT-STM4
RMV-STM4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

678 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-STM64


Command Name: ED-STM64

PURPOSE
The ED-STM64 command creates (assigns and provisions) a specified STM64 client signal facility.
Executing an ED-STM64 command causes primary and secondary state transitions for the specified
STM64 facility. Primary and secondary states associated with the STM64 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then STM64 enters IS-NR or IS-ANR.
When a STM64 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM64 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM64 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM64 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-STM64:[TID]:AID:[CTAG]:::[AINSREF=][,AINSTMR=][,DESCR=][,MAPPINGM
ODE=][,CHANNEL=][,SDTH=][,SFTH=][,J0_EX=][,J0_FMT=][,TRCCMP=][,LOSPR
OP=][,MODULETYPE=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 679


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM64

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSREF= Value Description


{SYSTEM}

Default: <Previously existing value>


Addressing: None
Description: AINSREF, indicates the reference timer used for automatic
in-service transition.
SYSTEM use the system level timer.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <Previously existing value>


Addressing: None
Description: Automatic In-Service Timer, specifies how long an input signal
must be present on the facility without a failure condition before the
system transitions the facility into the In-Service state.

680 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM64 Issue 1, December 2011

00-96-00-59 Time, specifies the duration of an


alarm-free signal, in HH-MM format, where value
HH indicates the time duration in hours and value
MM indicates the time duration in minutes. The
maximum time is 96-00. The minimum time is
00-01.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <Previously-existing value>


Addressing: None.
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

MAPPINGMODE= Value Description


BITSYNC bit synchronous CBR mapping
ASYNC asynchronous CBR mapping

Default: <Previously-existing value>


Addressing: None.
Description: Type of mapping of OC192/STM64 into an ODU2 structure.
The MAPPINGMODE parameter applies to the 43STX4 and
43STX4P OTs.
The MAPPINGMODE parameter applies to the 43STX4 and
43STX4P OTs.
The MAPPINGMODE parameter is supported on the 43SCX4L
and 43SCX4 OT.
This parameter shall not apply to the 11QPA4 and 11QTA4 OT.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: <previously provisioned value>


Addressing: None
Description: Specifies the channel frequency of the client port.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: <previouslu provisioned value>

1830PSS R3.6.50 - TL1 Commands and Messages 681


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM64
Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
The SDTH parameter is not supported on the 43STX4 and
43STX4P OTs.
The SDTH parameter is supported on the 43SCX4L OT and
43SCX4 OT.

SFTH= Value Description


{10-3,10-4, 10-5}

Default: <previously provisioned value>


Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration.
The SFTH parameter is not supported on the 43STX4 and
43STX4P OTs.
The SFTH parameter is supported on the 43SCX4L OT and
43SCX4 OT.

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <Previously existing value>


Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: <Previously existing value>


Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

682 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM64 Issue 1, December 2011

Default: <Previously existing value>


Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 section trace value and the
provisioned (i.e., expected) J0 section trace value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: <Previously provisioned value>


Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signaled.

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11STAR1, 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for the
112SCX10, 112SNX10 and 112SX10L
OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QPA4 OT.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QTA4 OT.

Default: <Previously provisioned value>


Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified STM64 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.
Note: The 10GB-SR is not supported on the 43STX4 and
43STX4P OTs.

1830PSS R3.6.50 - TL1 Commands and Messages 683


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM64

PST Value Description


{IS,OOS}

Default: <Previously provisioned value>


Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


{AINS, AINS-DEA, MT}

Default: <Previously provisioned value>


Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance mode

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

684 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-STM64 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SAIS Status, Already In Service


• this command is issued with PST=IS and SST=AINS, and the facility already has AINS as the
secondary state

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ED-STM64


command.
ED-STM64:NODE-1:11STAR1-1-5-C1:xyz123:::sdth=10-5,losprop=LASERON:IS
,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM64
RST-STM64
DLT-STM64
ENT-STM64
RMV-STM64

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 685


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-STM64

686 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-TRANSFER-INFO


Command Name: EDIT FILE TRANSFER INFORMATION

PURPOSE

The ED-TRANSFER-INFO command allows a user to edit the IP address,


protocol, User ID, password, and RFS Directory path information used
in:
1) Database backup and restore commands, and
2) software download commands.
3) Log Transfer commands to transfer log files to RFS
4) SSL certificate upload/download to/from NMS

The file transfer information can ALSO optionally be entered and changed with the COPY-RFILE TL1
command, which is the command that implements the database backup and restore and software
download operations.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-TRANSFER-INFO:[TID]::[CTAG]:::[SWDLIPADDRESS=][,SWDLPROTOCOL=][,S
WDLUSERID=][,SWDLPASSWORD=][,SWDLRELEASEROOT=][,DBBKRSTIPADDRESS=][,
DBBKRSTPROTOCOL=][,DBBKRSTUSERID=][,DBBKRSTPASSWORD=][,DBBKRSTPATH=]
[,SSLCERTIPADDRESS=][,SSLCERTPROTOCOL=][,SSLCERTUSERID=][,SSLCERTPAS
SWORD=][,SSLCERTPATH=][,LOGTRANIPADDRESS=][,LOGTRANPROTOCOL=][,LOGTR
ANUSERID=][,LOGTRANPASSWORD=][,LOGTRANPATH=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 687


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-TRANSFER-INFO
Description: Correlation TAG, associates input command with its output
responses.

SWDLIPADDRESS Value Description


=
<swipaddress>
<1-99, 102-126,
128-223>.<0-255>.<0-255>.<0-255>

Default: 0.0.0.0
Addressing: None
Description: The IP address of the Remote File Server used for the file transfer
of software.

SWDLPROTOCOL Value Description


=
<swprotocol>
FTP
SFTP

Default: FTP
Addressing: None
Description: The protocol to use in the file transfer of software from the NE to
the Remote File Server.

SWDLUSERID= Value Description


<swuserid>
<1-25 VALID USERID CHARACTERS>

Default: None
Addressing: None
Description: This is the RFS User Identifier used for the file transfer of software
from the NE to the Remote File Server.

SWDLPASSWORD Value Description


=
<swpassword>
<1-25 VALID PASSWORD
CHARACTERS>

Default: None
Addressing: None

688 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-TRANSFER-INFO Issue 1, December 2011

Description: This is the password that goes with the RFS User Identifier defined
above. Used for the file transfer of software from the NE to the
Remote File Server.

SWDLRELEASER Value Description


OOT=
<swroot>
<0-255 characters, directory names
separated by forward slash characters>

Default: None
Addressing: None
Description: The path to the directory containing software releases, relative to
the TFTP Server root directory. A forward slash will be prepended
if it does not start with one.

DBBKRSTIPADDR Value Description


ESS=
<dbipaddress>
<1-99, 102-126,
128-223>.<0-255>.<0-255>.<0-255>

Default: 0.0.0.0
Addressing: None
Description: The IP address of the Remote File Server used for the file transfer
of database (backup or restore)

DBBKRSTPROTO Value Description


COL=
<dbprotocol>
TFTP
FTP
SFTP

Default: TFTP
Addressing: None
Description: The protocol to use in the file transfer of database between the NE
and the Remote File Server.

DBBKRSTUSERID Value Description


=
<dbuserid>
<1-25 VALID USERID CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 689


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-TRANSFER-INFO
Default: None
Addressing: None
Description: This is the RFS User Identifier used for the file transfer of
database between the NE and the Remote File Server.

DBBKRSTPASSW Value Description


ORD=
<dbpassword>
<1-25 VALID PASSWORD
CHARACTERS>

Default: None
Addressing: None
Description: This is the password that goes with the RFS User Identifier defined
above. Used for the file transfer of database between the NE and
the Remote File Server.

DBBKRSTPATH= Value Description


<dbpath>
<0-255 characters, directory names
separated by forward slash characters>

Default: None
Addressing: None
Description: The path to the RFS directory
containing database, relative to the File Transfer
Server (TFTP) root directory. A forward slash will be
prepended if it does not start with one.
If the specified path is a directory (meaning that the
path ends with a slash, such as /backups/), then when
a backup is performed the system creates a backup file
with a filename in the form of
NEname_SWgeneric_yyyy-mm-dd_hh-mm-ss.bak. and writes
it to the specified directory. A restore operation
will take the database file(s) with the latest date in
the RFS directory when no filename is specified.

If the specified path is a file name (such as


/backups/backupfile.bak) then when a backup is
performed the system writes the backup to the
specified file. This action overwrites the previous
backup file.

690 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-TRANSFER-INFO Issue 1, December 2011

SSLCERTIPADDR Value Description


ESS=
<omsipaddress>
<1-99, 102-126,
128-223>.<0-255>.<0-255>.<0-255>

Default: 0.0.0.0
Addressing: None
Description: The IP address of the OMS used for the file transfer of SSL
certificate.

SSLCERTPROTOC Value Description


OL=
<sslcertprotocol>
FTP
SFTP

Default: FTP
Addressing: None
Description: The protocol to use in the file transfer of SSL Certificate between
the NE and the OMS.

SSLCERTUSERID= Value Description


<omsuserid>
<1-25 VALID USERID CHARACTERS>

Default: None
Addressing: None
Description: This is the RFS User Identifier used for the SSL certificate transfer
between the NE and the Remote File Server (OMS).

SSLCERTPASSWO Value Description


RD=
<omspassword>
<1-25 VALID PASSWORD
CHARACTERS>

Default: None
Addressing: None
Description: This is the password that goes with the RFS User Identifier defined
above. Used for the file transfer of SSL certificate between the
NE and the Remote File Server (OMS).

1830PSS R3.6.50 - TL1 Commands and Messages 691


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-TRANSFER-INFO

SSLCERTPATH= Value Description


<sslcertpath>
<0-255 characters, directory names
separated by forward slash characters>

Default: None
Addressing: None
Description: The path to the RFS directory
containing SSL certificate, relative to the File
Transfer Server (OMS) root directory. A forward
slash will be prepended if it does not start with one.
The specified path is a file name (such as
/SSLCERT/filename).

LOGTRANIPADDR Value Description


ESS=
<logtranipaddress>
<1-99, 102-126,
128-223>.<0-255>.<0-255>.<0-255>

Default: 0.0.0.0
Addressing: None
Description: The IP address of the RFS used for the log file transfer.

LOGTRANPROTO Value Description


COL=
<logtranprotocol>
FTP
SFTP

Default: FTP
Addressing: None
Description: The protocol to use in the file transfer of logfiles from the NE to
the RFS.

LOGTRANUSERID Value Description


=
<logtranuserid>
<1-25 VALID USERID CHARACTERS>

Default: None
Addressing: None
Description: This is the RFS User Identifier used for the log file transfer from
the NE to the Remote File Server.

692 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-TRANSFER-INFO Issue 1, December 2011

LOGTRANPASSW Value Description


ORD=
<logtranpassword>
<1-25 VALID PASSWORD
CHARACTERS>

Default: None
Addressing: None
Description: This is the password that goes with the RFS User Identifier defined
above. Used for the log file transfer from the NE to the Remote
File Server.

LOGTRANPATH= Value Description


<logtranpath>
<0-255 characters, directory names
separated by forward slash characters>

Default: None
Addressing: None
Description: The path to the RFS directory containing log files. The specified
path is a file name (such as /LOGFILE/filename).

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 693


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-TRANSFER-INFO
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV, Input, Data Not Valid
• the command is entered with an invalid value for a parameter

EXAMPLES
The following example illustrates the command for editing the software download userID and
password.

ED-TRANSFER-INFO:NODE-1::ctag12:::SWDLUSERID=Jack,SWDLPASSWORD=*****
***;
NODE-1 03-07-08 09:04:33
M ctag12 COMPLD
;

RELATED COMMANDS
COPY-RFILE
RTRV-TRANSFER-INFO

RELATED AUTONOMOUS RESPONSES


None

694 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-USER-SECU


Command Name: EDIT USER SECURITY PRIVILEGES

PURPOSE
The ED-USER-SECU command is used by a user with administrator privileges to edit the existing user
profile entry, identified by the User Identifier (UID), in the User Security Database.
The following can be edited:
• the user's password identification (PID),

• the user's command authorization privilege (UAP),

• the user's session link timeout during idle (TMOUT)

All of the changes to the provisioned values shall be allowed and take effect immediately, if the input
UID's user is currently not logged on. Changes are not supported for UIDs whose user is logged on.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ED-USER-SECU:[TID]:UID:[CTAG]::,[NEWPID],,[UAP]:[TMOUT=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: Entry Required


Addressing: None
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

1830PSS R3.6.50 - TL1 Commands and Messages 695


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-USER-SECU

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NEWPID Value Description


<8-32 VALID PID CHARACTERS,
depedning on minlength and maxlength
provisioned values>

Default: <not applicable>


Addressing: None
Description: New Password Identifier, specifies the user's new login password.
Valid values for NEWPID are a string of minlength through
maxlength case-sensitive alphanumeric characters, where
minlength is 8 by default and provisionable 8-32. The NEWPID
must contain at least one lowercase alphabetic character, at least
one uppercase alphabetic character, at least one numeric
character, and at least one special character. The following special
characters are accepted as valid characters and can be part of the
NEWPID: % (percent sign), + (plus sign), # (pound sign), _ (under
score), ! (exclamation mark), @ (at sign), $ (dollar sign), “ (double
quotation mark), & (ampersand), ' (apostrophe), ( (left
parenthesis), ) (right parenthesis), * (asterisk), and . (period). The
first character of the NEWPID can be an alphabetic, numeric, or a
valid special character.

UAP Value Description


ADMINISTRATOR
PROVISIONER
OBSERVER

Default: <Previously existing value>


Addressing: None
Description: User access privilege(s) granted to this user. Values are:
ADMINISTRATOR: This is the administrator for the NE. In
addition to the “provisioner” privileges, this user can create, delete
and modify user accounts, and access all security aspects of the
system including SW DNLD, File transfer, etc.)
PROVISIONER (Provisioner. This is a normal read/write
user. In addition to the “observer” privilege, this user
may perform provisioning of IO cards, ports,
circuits, and interfaces, and initiates test procedures

696 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-USER-SECU Issue 1, December 2011

which are not generally service affecting (e.g. no


COLD boot which would affect management traffic),
and retrieves information about the system.)
OBSERVER (Read-only. User may retrieve most, but not
all, information about the system)

TMOUT= Value Description


{0-999}

Default: <Previously existing value>


Addressing: None
Description: User Session Activity Link Time-Out, specifies the amount of time
(in minutes) that the User Session link is inactive with regards to
user TL1 input before a user session link time-out occurs. After the
timeout value is reached, the user will be automatically logged off.
0 Disabled, no user session link time-out will occur.
1-999 Time in minutes, indicates the TMOUT time interval.
A user session link time-out occurs if the user
session link is inactive with regards to user TL1
input for the time, in minutes, indicated.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 697


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-USER-SECU
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• an attempt is made to change default users' ("admin" and "service") parameters

IDNV Input, Data Not Valid


• the new password is the same as the UID

• the new password is invalid because the new password is illegal (ie, syntax, format)

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

PIUI Privilege Illegal User Identity


• the UID is invalid (ie., illegal UID, UID does not exist)

• the user identified by the entered UID user is currently logged-in

EXAMPLES
The following example illustrates the command and associated output for editing the user security
database entry for user13 to change his password, and grant him access to “admin” privilege level.

ED-USER-SECU::user13::,********,,admin;

AM1520 03-07-08 10:18:49


M P0a057 COMPLD
;

RELATED COMMANDS
DLT-USER-SECU
ENT-USER-SECU
RTRV-USER-SECU

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

698 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ED-VTS


Command Name: ED-VTS

PURPOSE
The ED-VTS command modifies the VLAN ID map setting previously provisioned using the ENT-VTS
command.

INPUT FORMAT

ED-VTS:[TID]:AID:[CTAG]:::[DIR]:[VTS]:[CMODE=][,MAPID=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT port only.
11DPE12-<shelf>-<slot>-C{1-12}- (11DPE12 Client Ports) only apply to subrate
modeand 11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
only apply to fullrate mode and subrate mode .

The port VTS AID only applies to the pack working under qinq
mode

1830PSS R3.6.50 - TL1 Commands and Messages 699


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-VTS

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DIR Value Description


{INGRESS, EGRESS, 2WAY}

Default: 2WAY
Addressing: None
Description: Specifies the direction to the configuration.
For 11DPE12 pack in subrate mode this parameter is
optional and should be 2WAY only;
in qinq mode the
parameter is mandatory and can be ingress, egress.
For 11DPE12E pack in qinq mode this parameter is mandatory
and can be ingress or egress.

VTS Value Description


VTS{1-32}

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot in the
port.
this prameter is only for 11DPE12 subrate mdoe , the client VTS
range is 1-10 , the line port VTS range is 1-32 .

CMODE= Value Description


{CEVLANTag, SVLANTag,UNTagged ,
Port}

Default: Null
Addressing: None
Description: The parameter is used to differ classification mode in qinq mode.
This parameter only apply to 11DPE12E.

700 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-VTS Issue 1, December 2011

When the CMODE is set to PORT, it means that all the


packets coming to the port will be treated as a VTS
and MAPID must be ALL;
When the CMODE is set to SVLAN tagged, SVLAN ID can be
set.
When the CMODE is set to CEVLAN tagged, CEVLAN ID can
be provisioned.
When the CMODE is set to UNTagged , CEVLAN ID ca nbe
provisioned .
For 11DPE12E line port VTS,only SVLANTag could be provioned.
CEVLANTag and Port can not be set to 11DPE12E's line port
VTS.
For 11DPE12E line port VTS,CEVLANTag , SVLANTag ,
Untagged could be provioned. Port can not be set to 11DPE12E's
line port VTS.

MAPID= Value Description


A number or a range number among
1-4095, ALL, Null

Default: Null string


Addressing: None
Description: The value is set for VTS/VLANID mapping for 11DPE12 and VTS
entity for 11DPE12/11DPE12E.
CEVLANID is used for client and line VTS entity .
for CEVLANTagged the value can be a separate numbers
or a contiguous range of 1-4095.
The value of VLANID must be enclosed with
double-quotes if it contains a comma (,) character.
otherwise enclosing with double-quotes is not
necessary."
for UNTagged the value can be a separate numbers in
range of 1-4094.
SVLANID is used for client or line VTS/SVLANID
mapping.
The value must be a specific number in the range of
1-4095 for 11DPE12.
The value must be a specific number in the range of
2-4094 for 11DPE12E.
when the FlowCM is set to CCM in 11DPE12E pack and the ingres
VTS cmode and egress VTS cmode are SVLAN TAGGED , The
ingress VTS SVLAN ID and egress VTS SVLAN ID should be
same .
ALL means all the tagged, priorty tagged and un-tagged packets
are mapped into the line VTS.
Null is used to indicate that no traffic flow is mapped into the VTS.

1830PSS R3.6.50 - TL1 Commands and Messages 701


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-VTS
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• the command is input for an 11DPE12 pack that isworking under fullrate

• the command is input for an 11DPE12 pack that the VLAN ID is out of the speicified range under
subrate or qinq mode

• the command is input for an 11DPE12 line port AID under subrate working mode

• the command is input with CMODE parameter for 11DPE12 pack

• the command is input with CMODE=PORT for any VTS of 11DPE12E client port which has
provision PVID other than Null

• the command is input with CMODE other than SVLANTag for any VTS of 11DPE12E line port

702 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ED-VTS Issue 1, December 2011

• the command is input with CMODE parameter “port” for 11DPE12E when there is a VTS
configured with CMODE VALUE

• the command is input with CMODE parameter for 11DPE12E when there is a VTS configured with
cmode “port”

• the command is input with CMODE “untagged” for 11DPE12E when there is a VTS configured
with cmode “untagged”

• the command is input with the ingres(egress) VTS SVLNA ID which is not same as the existing
egress(ingress)VTS SVLNA ID for 11DPE12E when the FlowCM is set to CCM

EXAMPLES

In the following example, the vlanid 300-400,500 is assigned for a


11DPE12 client port 1, virtual time slot1:
ED-VTS:NODE-1:11DPE12-1-7-C1:xyz123:::VTS1 :MAPID="300-400,500";
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

In the following example, the cmdoe svlantagged with svlanid 4095 is


assigned for a 11DPE12E qinq mode line port 1, virtual time slot100:
ED-VTS:NODE-1:11DPE12E-1-8-L1:xyz123:::VTS100:CMODE=SVLANTag,MAPID=4
095;

RELATED COMMANDS
RTRV-VTS
ENT-VTS
RMV-VTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 703


8DG61100 EAAAQZZA
Issue 1, December 2011 ED-VTS

704 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-100GBE


Command Name: ENT-100GBE

PURPOSE
The ENT-100GBE command creates (assigns and provisions) a specified 100GBE LAN PHY client
signal facility.
Executing an ENT-100GBE command causes primary and secondary state transitions for the specified
100GE facility. Primary and secondary states associated with the 100GBE facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then 10GBE enters OOS-MA or OOS-AUMA.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when 100GBE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a 100GBE is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an 100GBE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 100GBE transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
100GBE signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-100GBE:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,MODULETYPE=][,LOS
PROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

1830PSS R3.6.50 - TL1 Commands and Messages 705


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-100GBE
Default: Entry Required
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, C113G10C, C113G4C,
C113G4CD}

Default: AUTO
Addressing: None

706 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-100GBE Issue 1, December 2011

Description: Attribute defines CFP pluggable module


type to be used in providing physical layer function
on specified 100GBE port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type which
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
AINS-DEA Automatic In-Service Deactivate
MT Maintenance

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 707


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-100GBE
OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-100GBE


command.
ENT-100GBE:NODE-1:112SCA1-1-5-C1:xyz123:::moduletype=C1113G10C:IS,AI
NS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

708 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-100GBE Issue 1, December 2011

RELATED COMMANDS
RTRV-100GBE
RST-100GBE
DLT-100GBE
ED-100GBE
RMV-100GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 709


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-100GBE

710 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-10GBE


Command Name: ENT-10GBE

PURPOSE
The ENT-10GBE command creates (assigns and provisions) a specified 10GBE LAN PHY client
signal facility.
Executing an ENT-10GBE command causes primary and secondary state transitions for the specified
10GE facility. Primary and secondary states associated with the 10GBE facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then 10GBE enters OOS-MA or OOS-AUMA.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when 10GBE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a 10GBE is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an 10GBE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 10GBE transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
10GBE signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-10GBE:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,CHANNEL=][,ENCMODE
=][,MODULETYPE=][,LOSPROP=][,ERRFRMDROP=][,STPID=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 711


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-10GBE

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

712 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-10GBE Issue 1, December 2011

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

CHANNEL= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies;)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the port.
The DWDM frequences only apply to the 11DPE12 and
11DPE12E line AID

ENCMODE= Value Description


{CBRLAN11.049,CBRLAN11.096,GFP-
F,GFP-P}

Default: 11.096 for the 112SCX10 OT, 112SNX10 OT and the 112SX10L.
Addressing: None
Description: The parameter encmode describes the encapsulation mode used
to transport the client signal.
CBRLAN11.049 Constant Bit Rate
CBRLAN11.096 Constant Bit Rate
GFP-F Generic Framing Protocol (ITU-T G.7041)
GFP-P Generic Framing Protocol - Proprietary Option - it
preserve client Ethernet frame Preamble.

1830PSS R3.6.50 - TL1 Commands and Messages 713


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-10GBE
For the 43STX4 and 43STX4P OT, the only supported values for
ENCMODE are {GFP-F, GFP-P}
For the 43SCX4L OT or 43SCX4OT, the supported values for
ENCMODE are {CBRLAN11.049, CBRLAN11.096, GFP-F,
GFP-P}
For the 11QTA4 OT, the only supported values for ENCMODE are
{CBRLAN11.096, GFP-F}
This parameter doesn't apply to 11DPE12 and 11DPE12E line side

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for 11STAR1, 43STX4,
43STX4P, 43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for the 112SCX10,
112SNX10, and 112SX10L OTs.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for the 11QPA4 OT.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for the 11QTA4 OT.
{AUTO, USER, 10GB-SR,10GB-ZR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C, XL-64.2D, XL-64TU} for the
11DPE12 OT.
{AUTO, USER, 10GB-SR,10GB-ZR,
XI-64.1, XL-64.2C, XL-64.2D,
XS-64.2B, XS-64.2C, XL-64TU} for the
11DPE12E OT.

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified 10GBE port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type which
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON

714 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-10GBE Issue 1, December 2011

Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

ERRFRMDROP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: Attribute that controls whether inbound error frames are discarded
or passed. This attribute is meaningful only for GFP transport
modes.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: None
Addressing: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

1830PSS R3.6.50 - TL1 Commands and Messages 715


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-10GBE
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

• this command is issued with a 11DPE12 pack not working under qinq mode

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

716 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-10GBE Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a ENT-10GBE


command.
ENT-10GBE:NODE-1:11STAR1-1-5-C1:xyz123:::encmode=GFP-F,
moduletype=XI-64.1:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-10GBE
RST-10GBE
DLT-10GBE
ED-10GBE
RMV-10GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 717


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-10GBE

718 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-1GBE


Command Name: ENT-1GBE

PURPOSE
The ENT-1GBE command creates (assigns and provisions) a specified GE client signal facility.
Executing an ENT-1GBE command causes the primary and secondary state transitions for the
specified 1GBE facility. Primary and secondary states associated with the 1GBE facility after the
command is executed depend upon values entered for PST , SST and the events detected by the
system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then 1GBE enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility 1GBE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a 1GBE is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an 1GBE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no 1GBE transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
1GBE signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-1GBE:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,ENCMODE=][,ERRFRMDR
OP=][,AUTONEG=][,LOSPROP=][,MODULETYPE=][,CHANNEL=],TS=[,STPID=][,CO
NTAINER=]:[,PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 719


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-1GBE

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in 4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None

720 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-1GBE Issue 1, December 2011

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

ENCMODE= Value Description


{GFP-T,GFP-F}

Default: GFP-T
Addressing: None
Description: The parameter encmode describes the encapsulation mode used
to transport the client signal.
GFP-F Generic Framing Protocol Framed encapsulation
option (ITU-T G.7041)
GFP-T Generic Framing Protocol - Transparent
encapsulation option.
This parameter doesn't apply to the 11STGE12 and 4DPA2 OT.
This parameter doesn't apply to the 11DPE12 and 11DPE12E OT.
For the 11STMM10 OT, only GFP-T is supported.
For the 4DPA4 , only GFP-T is supported.

ERRFRMDROP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: Attribute that controls whether inbound error frames are discarded
or passed.
This attribute is meaningful only for GFP transport modes.
The ERRFRMDROP parameter does not apply to the 11STGE12 ,
11DPE12, 11DPE12E , 4DPA4 and 4DAP2 OTs .
For 11STMM10 OT value ENABLED is not supported.

AUTONEG= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: Attribute that controls status of auto-negotiation.
The AUTONEG parameter only applies to the 11STGE12 and
11DPE12,11DPE12E OT. It does not apply to the 11STMM10 OT.
It does not apply to the 4DPA4 and 4DPA2 OT.

1830PSS R3.6.50 - TL1 Commands and Messages 721


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-1GBE

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.
The LOSPROP parameter does not apply to the 4DPA2.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 1000B-LX, 1000B-SX,
1000B-T, 1000B-ZX, SL-16.2C,
SS-16.1A, SS-16.2C, GE-BX20D,
GE-BX20U, GE-BX40D, GE-BX40U}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified GBE port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Note: SS-16.2C is not supported on 11STGE12.
1000B-ZX is not supported on 4DPA2 .
GE-BX20D, GE-BX20U, GE-BX40D, GE-BX40U
are supported only on 4DPA4 and 11DPM12 client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

722 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-1GBE Issue 1, December 2011

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13,16,19,22,25,2
8} (11STMM10 timeslots)
{L1,L2}-({1,2}) (4DPA4 timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4 : Timeslot assignment on the specified Line port (L1 or
L2). Timeslot 1 represents the eight odd timeslots of ODU0 #1
within the specified line. (Timeslots 1,3,5,7,9,11,13,15.) Timeslot
2 represents the eight even timeslots of ODU0 #2 within the
specified line. (Timeslots 2,4,6,8,10,12,14,16.)
The user shall not be able to provision the TS parameter and
provision PST=IS at the same time.
The TS parameter does not apply to the 11STGE12 OT.
The parameter does not apply to the 11DPE12 and 11DPE12E
OT.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: None
Addressing: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter only applies to 11DPM12.

CONTAINER= Value Description


{None, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
This parameter only applies to 11DPM12.

1830PSS R3.6.50 - TL1 Commands and Messages 723


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-1GBE

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

724 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-1GBE Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-1GBE


command.
ENT-1GBE:NODE-1:11STMM10-1-5-C1:xyz123:::encmode=GFP-T:ODU1-L1-1-25:
IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-1GBE
RST-1GBE
DLT-1GBE
ED-1GBE
RMV-1GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 725


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-1GBE

726 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-CBR2G5


Command Name: ENT-CBR2G5

PURPOSE
The ENT-CBR2G5 command creates (assigns and provisions) a specified CBR2G5 client signal
facility.
Executing an ENT-CBR2G5 command causes primary and secondary state transitions for the
specified CBR2G5 facility.Primary and secondary states associated with the CBR2G5 facility after the
command is executed depend upon values entered for PST, SST and the events detected by the
system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then CBR2G5 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when CBR2G5 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a CBR2G5 is provisioned to an OOS-MA state, a MAN condition type is set for the specified
port. When an CBR2G5 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no CBR2G5
transmission condition types or performance monitoring threshold crossing alerts are autonomously
reported for the CBR2G5 signal, but alarm conditions are monitored and performance monitoring data
is collected (if provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-CBR2G5:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,MAPPINGMODE=][,SD
TH=][,SFTH=][,J0_EX=][,J0_FMT=][,TRCCMP=][,LOSPROP=][,MODULETYPE=][,
CHANNEL=],TS=:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 727


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CBR2G5
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

MAPPINGMODE= Value Description


{BITSYNC,ASYNC}

Default: BITSYNC
Addressing: None
Description: Type of mapping of CBR2G5 into an ODU1 strucutre

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6

728 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CBR2G5 Issue 1, December 2011

Addressing: None
Description: Attribute that specifies BER threshold for SD defect decalration.

SFTH= Value Description


{10-3,10-4,10-5}

Default: 10-3
Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
decalration.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 section trace comparison. This parameter enables and
disables comparison between the incoming J0 section trace value
and the provisioned (i.e., expected) J0 value.
ENABLED Enable compare
DISABLED Disable compare

1830PSS R3.6.50 - TL1 Commands and Messages 729


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CBR2G5

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SS-16.1A,
SS-16.2C}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified CBR2G5 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment on the Line port <ODU1#>-<Time Slot within
ODU1>. The entire string must be enclosed in double-quotes.

730 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CBR2G5 Issue 1, December 2011

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 731


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CBR2G5
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-CBR2G5


command.
ENT-CBR2G5:NODE-1:11STMM10-1-5-C1:xyz123:::moduletype=user:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBR2G5
RST-CBR2G5
DLT-OC48
ED-CBR2G5
RMV-CBR2G5

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

732 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-CBRAR


Command Name: ENT-CBRAR

PURPOSE
The ENT-CBRAR command creates (assigns and provisions) a specified CBRAR
(SDSDI,HDSDI,3GSDI or FE) client signal facility.
Executing an ENT-CBRAR command causes primary and secondary state transitions for the
specified CBRAR facility. Primary and secondary states associated with the CBRAR facility after the
command is executed depend upon values entered for PST , SST and the events detected by the
system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then CBRAR enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when CBRAR is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a CBRAR is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an CBRAR is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no CBRAR transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
CBRAR signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-CBRAR:[TID]:AID:[CTAG]:::DATATYPE=[,AINSTMR=][,DESCR=][,LOSPROP=
][,MODULETYPE=][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 733


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CBRAR
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DATATYPE= Value Description


{HDSDI, FE, SDSDI,3GSDI}

Default: Entry required


Addressing: None
Description: Specifies the client signal type.
FE,HDSDI,SDSDI,3GSDI are applicable to 11DPM12.

AINSTMR= Value Description


{00-96}-{00-59}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

734 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CBRAR Issue 1, December 2011

LOSPROP= Value Description


{LASERON, LASEROFF}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when far end failure gets
signaled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 100BLX10 , FE-BX40D,
FE-BX40U} (for DATATYPE = FE)
{AUTO, USER, SL-16.2C, SS-16.1A,
SS-16.2C} (for DATATYPE =
HDSDI)
{AUTO, USER, SL-16.2C, SS-16.1A,
SS-16.2C} (for DATATYPE
=SDSDI)
{AUTO,USER,3GSDI-SH,3GSDI-MH}
(for DATATYPE=3GSDI)

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified CBRAR port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1490, 1530, 1550} (B&W
wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.
Restriction: 1490 and 1530 B&W wavelengths can be used only for 4DPA4
client ports.

1830PSS R3.6.50 - TL1 Commands and Messages 735


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CBRAR

TS= Value Description


{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment on the specified Line port. The entire string
must be enclosed in double-quotes. Timeslots are numbered 1-16
within the ODU1 on each line. HDSDI requires 10 timeslots. FE
requires 1 timeslot. <ts_list> can include a list of individual
timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None,ODU0, ODU1,ODUF}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
Set to odu1-mapping into ODU1 per G.709.
Set to oduf-mapping into ODUF per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

736 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CBRAR Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

• this command is issued with a number of timelots that does not agree with the signal type

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SABT Status, Aborted


• the requested timeslots are not available

SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 737


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CBRAR
• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-CBRAR


command.
ENT-CBRAR:NODE-1:4DPA4-2-5-C1:xyz123:::DATATYPE=HDSDI,TS="L2-(1,3,5-
8,13-16)":IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBRAR
RST-CBRAR
DLT-CBRAR
ED-CBRAR
RMV-CBRAR

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

738 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-CRS-OCH


Command Name: ENTER EQUIPMENT OPTICALPHOTONIC
CROSS CONNECTION (OCH)

PURPOSE
The ENT-CRS-OCH command creates an optical service connection and establishes a UNI or BI
connection on an optical connection trail between two external optical ports.
If DIR of UNI is specified, a one-way optical connection is established FROM the transmit side of an
external optical port TO the receive side of another external optical port.
A UNI optical connection can not be established FROM the transmit side TO the receive side of the
same optical port (FROM and TO can not be identical thereby establishing a loopback through the
system's optical connection matrix).
If DIR of BI is specified, a two-way optical connection is established between the FROM and TO ports.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-CRS-OCH:[TID]:<FROM>,<TO>:[CTAG]::[DIR]:OCHTRAILNAME=[,PROTMODE=
][,FTWK=][,TFWK=]:[PST];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 739


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-OCH

FROM Value Description


AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

740 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-OCH Issue 1, December 2011

FROM Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEIN-{9605, (AM2125A LINEIN Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,

1830PSS R3.6.50 - TL1 Commands and Messages 741


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-OCH

FROM Value Description


9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
RA2P-<shelf>-<slot>-LINEIN-{9605, (RA2P Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)

742 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-OCH Issue 1, December 2011

FROM Value Description


SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: Entry required


Addressing: None
Description: From Access Identifier, identifies the entity access identifier of
either end of a optical connection for BI cross connections. FROM
identifies the entity that is inbound from the network for a UNI
cross connection.

1830PSS R3.6.50 - TL1 Commands and Messages 743


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-OCH

TO Value Description
AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

744 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-OCH Issue 1, December 2011

TO Value Description
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEOUT-{96 (AM2125A LINEOUT Channels)
05, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,

1830PSS R3.6.50 - TL1 Commands and Messages 745


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-OCH

TO Value Description
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}

746 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-OCH Issue 1, December 2011

TO Value Description
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: Entry required


Addressing: None
Description: To Access Identifier, identifies the entity access identifier of either
end of a optical connection for BI cross connections. TO identifies
the entity that is outbound to the network for a UNI cross
connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: Entry required.


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

DIR Value Description


1WAY
2WAY

Default: 2WAY
Addressing: None
Description: Optical connection Type, identifies the type of optical connection.
1WAY One-Way, identifies an unidirectional optical
connection between the selected FROM and TO
facility ports.
2WAY Two-Way, identifies a bi-directional optical
connection between the selected FROM and TO
facility ports.

OCHTRAILNAME= Value Description


< 1-60 VALID CHARACTERS >

Default: string entry required.


Addressing: None.
Description: FROM and TO Optical Channel Trail Name. 1 to 60 ASCII
characters within enclosing double quotes. Semicolon, asterisk,
greater-than, less-than, double quote, and backslash characters
are prohibited.

1830PSS R3.6.50 - TL1 Commands and Messages 747


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-OCH

PROTMODE= Value Description


{UNPROTECTED,PROTECTION,WOR
KING}

Default: UNPROTECTED
Addressing: None
Description: PROTection MODE. Designate this connection as
UNPROTECTED, or as a connection in the WORKING leg, or as a
connection in the PROTECTION leg of a protected trail.

FTWK= Value Description


{AUTOKEY,"(K1,K2)",UNKEYED}

Default: AUTOKEY
Addressing: None.
Description: Change the Wavelength Tracker keys for the specified cross
connection in the FROM --> TO direction. AUTOKEY means
assign the Wavelength Tracker keys automatically.
K1,K2 is used for manual keying. K1 and K2 are integers in the
range 0<K<4096
UNKEYED supportsunmanaged optical channel trails.

TFWK= Value Description


{AUTOKEY,"(K1,K2)",UNKEYED}

Default: AUTOKEY
Addressing: None.
Description: Change the Wavelength Tracker keys for the specified cross
connection in the TO --> FROM direction. AUTOKEY means
assign the Wavelength Tracker keys automatically.
K1,K2 is used for manual keying. K1 and K2 are integers in the
range 0<K<4096
UNKEYED supportsunmanaged optical channel trails.

PST Value Description


IS
OOS

Default: OOS
Addressing: None.
Description: Primary state for the cross connect.

748 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-OCH Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the circuit pack specified by FROM or TO is not provisioned

• either FROM or TO is an auto-power-managed port

• a sVOA port has been involved into either FROM or TO port

SRQN Status, iNvalid ReQuest


• the ports specified by FROM or TO are already connected

• the connection specified by the FROM and TO arguments is not supported by the provisioned
topology

• the connection specified by the FROM and TO arguments will exceed the channel count limit
placed upon the span by the Engineering Planning Tool (EPT)

1830PSS R3.6.50 - TL1 Commands and Messages 749


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-OCH
• an UNKEYED connection specified by the parameters FROM and TO passes through an OPS
card

• an UNKEYED connection specified by the parameters FROM and TO passes through a CWR
card

EXAMPLES
In the following example, a two-way optical connection is established between ports
ALPHG-1-2-LINE-9220 (FROM) and 11STAR1-3-2-L1 (TO)

ENT-CRS-OCH:
CLAPTON:ALPHGALPHG-1-2-LINE-9220,11STAR1-3-2-L1:CMD123::2WAY::OCHTRA
ILNAME=”Ripley Surrey England to New York City
USA”,PROTMODE=UNPROTECTED:IS;

CLAPTON 07-01-11 11:11:11


M CMD123 COMPLD
;

RELATED COMMANDS
DLT-CRS-OCH
ED-CRS-OCH
RTRV-CRS-OCH

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

750 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-CRS-<ODUK>


Command Name: ENTER CROSS-CONNECTION

PURPOSE
The ENT-CRS-<ODUk> command creates a cross-connection entity and establishes a one-way
(unidirectional), two -way (bidirectional) cross connection between the specified facilities.
If CCT of 1WAY is specified, a one-way cross-connection is established between the receive side
(from the network, source of cross connection) of the FROM facility and the transmit side (to the
network, sink of the cross connection) of the TO facility.
If CCT of 2WAY is specified, a two-way cross-connection is established between the FROM and TO
facilities.

INPUT FORMAT

ENT-CRS-<ODUk>:[TID]:FROM,TO:[CTAG]::[CCT]:[CKTID=];

INPUT PARAMETERS

ODUk Value Description


{OPTSG,ODU0,ODU1,ODUFFC400,O
DUF3GSDI}

Default: Entity Required


Addressing: None
Description: The ODUk indicates the rate on which the command acts.

TID Value Description


<VALID TID VALUE>

Default:<SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID
for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 751


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-ODUK

FROM Value Description


Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None

Description: AID of connection point; Indicates the FROM (receive side from
the network, source of cross-connection) facility of the
cross-connection.

752 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-ODUK Issue 1, December 2011

TO Value Description
Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None

Description: AID of connection point; Indicates the TO (receive side from the
network, source of cross-connection) facility of the
cross-connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CCT Value Description


{1WAY, 2WAY}

Default: 2WAY

1830PSS R3.6.50 - TL1 Commands and Messages 753


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-ODUK
Addressing: None
Description: Cross-connection Type
1WAY One-way cross-connection (unidirectional
cross-connection)
2WAY Two-way cross-connection (bidirectional
cross-connection)

CKTID= Value Description


< 0-45 VALID CKTID CHARACTERS >

Default: NULL string


Addressing: None
Description: Circuit ID assigned to the cross-connection. 0 to 45 ASCII
characters within enclosing double quotes. Semicolon, asterisk,
greater-than, less-than, double quote, and backslash characters
are prohibited. Empty double quotes (i.e. “”) indicate a NULL string.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:

754 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-ODUK Issue 1, December 2011

IIAC Input,Invalid ACcess identifier


• the user AID in FROM or TO does not match for the rate

• the user AIDs in FROM and TO are both client LO-ODUks

• the user AIDs in FROM and TO are ODU1PTFOPSTG from two line ports

EXAMPLES
The following example illustrates the command when following ODU1 cross connections shall be
created:
1WAY 11DPM12-1-2-L1-ODU2ODU1#1 and 11DPM12-1-2-C1-ODU1 CKTID=CC1

ENT-CRS-ODU1::11DPM12-1-2-L1-ODU2ODU1#1,11DPM12-1-2-C1-ODU1:xyz123::
1WAY:CKTID="CC1";

RELATED COMMANDS
ED-CRS-<ODUk>
RTRV-CRS-<ODUk>
DLT-CRS-<ODUk>

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 755


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-ODUK

756 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-CRS-VTS


Command Name: ENT-CRS-VTS

PURPOSE
The ENT-CRS-VTS command creates (assigns and provisions) an ethernet connection and
establishes a UNI or BI connection between all or some virtual time slots of two ports in a pack.
This command applies to 11DPE12 and 11DPE12E pack. The number of virtual time slots and
connection is different with the working mode of 11DPE12 or 11DPE12E.
When 11DPE12 or 11DPE12E working on fullrate mode, an ethernet connection can be set between a
client port and one virtual time slot of a line port. Also a enthernet connection can be set between the
virtual time slots belong to two line ports.
When 11DPE12 or 11DPE12E working on subrate or qinq mode, an ethernet connection can be set
between one virtual time slot of a client port and one virtual time slot of a line port. Also a enthernet
connection can be set between the virtual time slots belong to two line ports.
When 11DPE12 or 11DPE12E working on fullrate or qinq mode, the ethernet connection can be set as
UNI or BI direction.
When 11DPE12 working on subrate mode, the ethernet connection is default as BI direction and can't
be modified.

INPUT FORMAT

ENT-CRS-VTS:[TID]:FROM,TO:[CTAG]:::[CIR=][,EIR=][,CBS=][,EBS=]:[DIR]
:[PST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 757


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-VTS

FROM Value Description


11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the head of a Ethernet connection.
When 11DPE12 working under fullrate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under subrate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.
When 11DPE12E working under qinq mode: client port contain 10
virtual time slots, so 11DPE12E-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

758 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-VTS Issue 1, December 2011

TO Value Description
11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot in the
port. Identifies the virtual time slot number of the tail of a Ethernet
connection.
When 11DPE12 working under fullrate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under subrate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.
When 11DPE12E working under qinq mode: client port contain 10
virtual time slots, so 11DPE12E-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 759


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-VTS

CIR= Value Description


{ 0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 50 under qinq
working mode for 11DPE12 pack ( the
unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 100 under subrate
working mode for both 11DPE12 and
11DPE12E packs ( the unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
portfor 11DPE12E pack add/drop
service with the step of 5Mbps for the
range of 1Mbps-100Mbps;50Mbps for
the range of 100Mbps-1Gbps under
qinq working mode. (the unit is Mb/S)
{0-10000}for 11DPE12E qinq pass
through service with the step of 5 Mbps
for the range of 10 Mbps-100Mbps;50
Mbps for the range of
100Mbps-1Gbps;500 Mbps for the
range of 1Gbps-10Gbps.(the unit is
Mb/S)

Default: None
Addressing: None
Description: the Committed Information Rate.
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

760 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-VTS Issue 1, December 2011

EIR= Value Description


{ 0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 50 under qinq
working mode for 11DPE12 pack ( the
unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 100 under subrate
working mode for both 11DPE12 and
11DPE12E packs ( the unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
portfor 11DPE12E pack add/drop
service with the step of 5Mbps for the
range of 1Mbps-100Mbps;50Mbps for
the range of 100Mbps-1Gbps under
qinq working mode. (the unit is Mb/S)
{0-10000}for 11DPE12E qinq pass
through service with the step of 5 Mbps
for the range of 10 Mbps-100Mbps;50
Mbps for the range of
100Mbps-1Gbps;500 Mbps for the
range of 1Gbps-10Gbps.(the unit is
Mb/S)

Default: None
Addressing: None
Description: the Excess Information Rate.
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

CBS= Value Description


{16, 32, 64, 128, 256, 512, 1024, 2048,
4096, 8192, 16384} ( the unit is kB )

Default: None
Addressing: None
Description: the Committed Burst Size
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

1830PSS R3.6.50 - TL1 Commands and Messages 761


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-VTS

EBS= Value Description


{16, 32, 64, 128, 256, 512, 1024, 2048,
4096, 8192, 16384} ( the unit is kB )

Default: None
Addressing: None
Description: the Excess Burst Size
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

DIR Value Description


{1WAY, 2WAY}

Default: 2WAY
Addressing: None
Description: Specifies the type of the connection. 1WAY One-Way, an
unidirectional connection between the selected FROM and TO
parameter. 2WAY Two-Way, identifies a bi-directional connection
between the selected FROM and TO parameter..
This parameter only apply to the 11DPE12 working in Fullrate and
qinq mode. The ethernet connection type for subrate mode shall
alway be 2WAY.
This parameter only apply to the 11DPE12E working in fullrate and
qinq mode.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

762 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRS-VTS Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SRQN Status, iNvalid ReQuest
• this command is issued with the ethernet connection between FROM and TO are already
provisioned

• this command is issued with the ethernet connection on any VTS without provisioned
VTS/CE-VLANID or VTS/SVLANID mapping in QinQ mode

• this command is issued with the ethernet pass through connection between two line VTS which
have different SVLAN ID for 11DPE12 pack qinq mode

IDNV Input, Data Not Valid


• this command is issued with the value that FROM and TO is not belong to the same 11DPE12
pack or they are not adjacent slot

• this command is issued with the value in FROM totally equals to TO

1830PSS R3.6.50 - TL1 Commands and Messages 763


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRS-VTS
• this command is issued with the port in both of FROM and TO belongs to client side of 11DPE12
pack

• this command is issued with FROM or TO whose virtual time slot is out of range under the
specified working mode

• this command is issued with the ethernet connection between from and to which the from port
available bandwidth or to port available bandwidth is less than the CIR parameter

• this command is issued with the ethernet pass through connection between two line VTS which
have different SVLAN ID for 11DPE12 pack qinq mode or add/drop connection between one
client VTS and one line VTS which have different SVLAN ID for 11DPE12E qinq mode

• this command is issued with the ethernet connection between client VTS and line VTS which the
line VTS CMODE parameter is not SVLANTag for 11DPE12E

• this command is issued with the ethernet connection between line VTS and line VTS which
neither of the VTS CMODE parameter is not SVLANTag for 11DPE12E

• this command is issued with the adjacent pack's flowCM are not same, (e.g one pack is APS/PCC
mode and other is CCM mode) or the adjacent pack's flowCM mode are both CCM mode but the
MDs are not same when 11DPE12E is in QINQ mode adjacent pack application,

• the command is issue with more than 200 VTS cross connections between adjacent packs trying
to be created when 11DPE12E is in QINQ mode adjacent pack application

EXAMPLES

In the following example, a two-way ethernet connection is created


for a 11DPE12 client port 1, virtual time slot 1 and line port 1,
virtual time slot 1:
ENT-CRS-VTS:NODE-1:11DPE12-1-7-C1-VTS1,11DPE12-1-7-L1-VTS1:xyz123:::
CIR=100, EIR=1000,CBS=1024,EBS=2048:Twoway:IS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CRS-VTS
DLT-CRS-VTS
ED-CRS-VTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

764 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-CRSPROT-<ODUK>


Command Name: ENTER PROTECTED
CROSS-CONNECTION

PURPOSE
The ENT-CRSPROT-<ODUk> command establishes a SNCP cross connection between the specified
rate facilities.
If CCT of 2WAYSNCP is specified, a two-way SNCP cross-connection is established between the
unprotected FROMPED facility, the protecting FROMPING facility and the TO facility. In the FROMPED
/ FROMPING -> TO direction the protection switch will select one of the FROMPED and FROMPING
facilities as the active one, while in the TO -> FROMPED / FROMPING direction the cross-connection
works as a bridge.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-CRSPROT-<ODUk>:[TID]:FROMPED,FROMPING,TO:[CTAG]::[CCT]:[RVRTV=][
,RVRTTIM=];

INPUT PARAMETERS

ODUk Value Description


{ODU0, ODU1,ODUF}

Default: Entry Required


Addressing: None
Description:The ODUk indicates the rate on which the command
acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description:Target IDentifier, identifies the network node TID for
the command.

1830PSS R3.6.50 - TL1 Commands and Messages 765


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRSPROT-ODUK

FROMPED Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the FROMPED
(protected receive side from the network, protected source of
cross-connection) facility of the cross-connection.

FROMPING Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the FROMPING
(protecting receive side from the network, protected source of
cross-connection) facility of the cross-connection.

766 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRSPROT-ODUK Issue 1, December 2011

TO Value Description
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the TO (transmit
side to the network, sink of cross-connection) facility of the
cross-connection.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description:Correlation TAG, associates the input command with
its output responses.

CCT Value Description


{ 1WAYSNCP, 2WAYSNCP}

Default: 2WAYSNCP
Addressing: None
Description:Cross-connection Type
1WAYSNCP One-way SNCP cross-connection
(unidirectional SNCP cross-connection)
2WAYSNCP Two-way SNCP cross-connection
(bidirectional SNCP cross-connection)

RVRTV= Value Description


{Y,N}

1830PSS R3.6.50 - TL1 Commands and Messages 767


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRSPROT-ODUK
Default: N
Addressing: None
Description:Revertive Mode: Indicates whether or not to make
revert to protected once the protected comes into service and the
traffic is on protecting.
N Do not revert to protected / FROMPED
Y Yes revert to protected / FROMPED

RVRTTIM= Value Description


0-15

Default: 5
Addressing: None
Description:Revert Delay Time (wait to restore time) if RVRTV=Y
in minutes. If RTRTV=N it does not have any effect at the NE
behaviour.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

768 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-CRSPROT-ODUK Issue 1, December 2011

Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the specified AID in FROMPED or PROMPING or TO does not match for the rate

• the specified TO AID is already a sink (TO) of an other cross-connection

• the specified FROMPED or FROMPING AID is the FROM of an unprotected connection or the TO
of an unprotected 2WAY connection

• the ODUk of FROMPED, FROMPING and the TO are not located in the same shelf/slot

• the ODUk of FROMPED, FROMPING are located in the same shelf/slot/line port

EXAMPLES
The following example illustrates the command when following ODU1 cross connections shall be
created:

ENT-CRSPROT-ODU1:: 11DPM12-1-1-L1- ODU2ODU1#5, 11DPM12-1-1-L2-


ODU2ODU1 #6, 11DPM12-1-1-C2 -ODU1:Pab124::2WAYSNCP:;

RELATED COMMANDS
RTRV-CRSPROT-<ODUk>
DLT-CRSPROT-<ODUk>

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 769


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-CRSPROT-ODUK

770 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-EQPT


Command Name: ENTER EQUIPMENT

PURPOSE
The ENT-EQPT command provisions the specified equipment entity regardless of whether the
equipment is plugged in the slot or not. The command can be applied to an equipment entity to be
provisioned as one of the following:
General Equipment
• Shelf (SHELF with type = UNV, SFD, DCM, or ITL)
• First Level Controller (FLC)
• Matrix Zero (MT0C)
• Shelf Equipment Controller (EC)
Active DWDM Circuit Packs
• Line Driver - LD (ALPHG, AHPHG, AHPLG, ALPFGT, A2325A, AM2017B, AM2325B, AM2125A,
AM2125B, AM2318A, RA2P)
• Optical Supervisory Channel (OSCT)
• Wavelength Tracker Optical Channel Monitoring Card (WTOCM)
• Colorless Wavelength Router (CWR8, CWR8-88)
• Wavelength Router (WR8-88A, WR2-88A)
• Mesh Card (MESH4)
• Optical Translator - OT (112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10, 112SX10L
11STAR1, 11STMM10, 11STGE12, 43STX4, 43STX4P, 43SCX4L, 43SCX4, 43SCA1, 43STA1P,
4DPA4, 4DPA2, 11QPA4, 11DPE12, 11DPE12E, 11DPM12, 11STAR1A)
• Optical Translator - OT
• (112SA1L, 112SCA1, 112SCX10, 112SNA1, 112SNX10, 112SX10L,
• 11DPE12, 11DPE12E, 11DPM12, 11QPA4, 11QPEN4, 11QTA4, 11STAR1,
11STAR1A, 11STGE12, 11STMM10,
• 4DPA2, 4DPA4 )
• Variable Attenuator Card (SVAC, MVAC)
• Optical Protection Switch (OPS)
• Optical Supervisory Channel (OSCT)
• Static Filter DWDM (SFD5/8)
• Static Filter CWDM (SFC2/4/8)
Passive DWDM Modules
The "passive" DWDM modules are: SFD44, SFD44B, SFD40, SFD40B, DCM, ITLB, ITLU.
Each of these modules is modeled as the fixed "card" in a "shelf" with only one "slot". But physically,
the shelf/card are not separable. ENT-EQPT is addressed to shelf, but creates both shelf and card.
ITL modules, together with DCM modules of several sizes, fit into single physical housing. However
this housing is not modeled by the system.
Then delete the following bullets:

1830PSS R3.6.50 - TL1 Commands and Messages 771


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-EQPT
• SFD44. The SFD44 is modeled as the fixed "card" in an SFD44 "shelf" with only one "slot". But
physically, the SFD44 card/shelf are not separable. ENT-EQPT is addressed to the SFD44 shelf,
but creates both shelf and card.
• SFD40. The SFD40 is modeled as the fixed "card" in an SFD40 "shelf" with only one "slot". But
physically, the SFD40 card/shelf are not separable. ENT-EQPT is addressed to the SFD40 shelf,
but creates both shelf and card.
• SFD44B. The SFD44B is modeled as the fixed "card" in an SFD44B "shelf" with only one "slot".
But physically, the SFD44B card/shelf are not separable. ENT-EQPT is addressed to the SFD44B
shelf, but creates both shelf and card. The SFD44B carries the 44 odd channels, which in addition
to the 44 even channels from a SFD44 supports an 88 channel optical line.
• SFD40B. The SFD40B is modeled as the fixed "card" in an SFD40B "shelf" with only one "slot".
But physically, the SFD40B card/shelf are not separable. ENT-EQPT is addressed to the SFD40B
shelf, but creates both shelf and card. The SFD40B carries the 40 odd channels, which in addition
to the 40 even channels from a SFD40 supports an 80 channel optical line.
• DCM. The DCM is modeled as the fixed "card" in a DCM "shelf" with only one "slot". But
physically, multiple DCM modules of several sizes fit into a single housing. ENT-EQPT is
addressed to the DCM shelf, but creates both shelf and card.
• ITLB/ITLU. The ITLB/ITLU is modeled as the fixed "card" in an ITLB/ITLU "shelf" with only one
"slot". But physically, multiple ITLB/ITLU and DCM modules of several sizes fit into a single
housing. ENT-EQPT is addressed to the ITLB/ITLU shelf, but creates both shelf and card.
Executing an ENT-EQPT command causes primary and secondary state transitions for the specified
equipment. Primary and secondary states associated with the equipment after the command is
executed depend upon values entered for PST, SST and the events detected by the system.

The State transitions for equipments are described in Appendix G of IOM.


The successful completion of the command shall cause REPT^DBCHG autonomous messages.

INPUT FORMAT

ENT-EQPT:[TID]:AID:[CTAG]::[TYPEID]:[DESCR=][,HIGHTEMPTH=][,LOWTEMPT
H=][,TEMPTOL=][,EXPECTED_AMPS=][,PROVSERNUM=][,CONNECTIVITY=][,CARDM
ODE=][,SHELFAINS=][,CARDRATE=][,TPID=][,STPID1=][,STPID2=][,STPID3=]
[,STPID4=][,FLOWCM=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

772 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-EQPT Issue 1, December 2011

AID Value Description


SHELF-<shelf> (non-main Universal Shelf)
SHELF-<shelf> (Passive Shelf)
FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 773


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-EQPT

AID Value Description


11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)

Default: Entry required


Addressing: None
Description: Equipment Access Identifier, identifies the equipment entity access
identifier.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

774 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-EQPT Issue 1, December 2011

TYPEID Value Description


UNV_SHELF_36 PSS36 Universal shelf
UNV_SHELF PSS32 Universal shelf
CWR8 CWR8 circuit pack
CWR8-88 CWR8-88 circuit pack
WR8-88A WR8-88A circuit pack
WR2-88A WR2-88A circuit pack
SFD44_SHELF SFD44 shelf
SFD40_SHELF SFD40 shelf
SFD44B_SHELF SFD44B shelf
SFD40B_SHELF SFD40 shelf
DCM_SHELF DCM shelf
ITLB_SHELF ITLB shelf
ITLU_SHELF ITLU shelf
SFD5A SFD5A circuit pack
SFD5B SFD5B circuit pack
SFD5C SFD5C circuit pack
SFD5D SFD5D circuit pack
SFD5E SFD5E circuit pack
SFD5F SFD5F circuit pack
SFD5G SFD5G circuit pack
SFD5H SFD5H circuit pack
SFD8A SFD8A circuit pack
SFD8B SFD8B circuit pack
SFD8C SFD8C circuit pack
SFD8D SFD8D circuit pack
SFC2A SFC2A circuit pack
SFC2B SFC2B circuit pack
SFC2C SFC2C circuit pack
SFC2D SFC2D circuit pack
SFC4A SFC4A circuit pack
SFC4B SFC4B circuit pack
SFC8 SFC8 circuit pack

Default: None
Addressing: None
Description: Provisioned type of equipment. Required to specify SHELF type.
Required to specify type of SFD circuit pack in a Universal shelf
when AID prefix = SFD. Required to specify type of SFC circuit
pack in a Universal shelf when AID prefix = SFC. Required to
specify type of CWR/WR circuit pack in a Universal shelf when
AID prefix = CWR/WR. (For other AIDs, TYPEID is not
provisioned, but is set automatically based on the AID.)

1830PSS R3.6.50 - TL1 Commands and Messages 775


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-EQPT

DESCR= Value Description


<0-255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: User description of the equipment.
Enclose the string in double quotes if it contains non-alphanumeric
characters.

HIGHTEMPTH= Value Description


{-5-90}(Celsius)
{23-194} (Fahrenheit)

Default: 90 (Celsius)
194 (Fahrenheit)

Addressing: None
Description: Temperature (in degrees Celsius/Fahrenheit) at which a high
temperature alarm is raised. Applies to EC, FLC, MTX, LD,
MESH, OSC, OPS, OT, VAC, WR, and WTOCM circuit packs.

LOWTEMPTH= Value Description


{-5-90}(Celsius)
{23-194} (Fahrenheit)

Default: -5 (Celsius)
23 (Fahrenheit)
Addressing: None
Description: Temperature (in degrees Celsius/Fahrenheit) at which a low
temperature alarm is raised. Applies to EC, FLC, MTX, LD,
MESH, OSC, OPS, OT, VAC, WR, and WTOCM circuit packs.

TEMPTOL= Value Description


{0-10} (Celsius)
{0-18} (Fahrenheit)

Default: 3 (Celsius)
5 (Fahrenheit)

Addressing: None
Description: Number of degrees Celsius/Fahrenheit above the low temperature
threshold or below the high temperature threshold at which a

776 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-EQPT Issue 1, December 2011

temperature alarm clears. Applies to EC, FLC, MTX, LD, MESH,


OSC, OPS, OT, VAC, WR, and WTOCM circuit packs.

EXPECTED_AMPS Value Description


=
{AUTO, 20, 30, 35, 50, 60, 70}

Default: AUTO
Addressing: None
Description: Applies only to Universal shelves. The expected
current rating of the shelf power supply modules. (For PSS-36, the
value is not provisionable.) For PSS-32, the valid values are:
AUTO, 20, 30, 50, 60, 70. For PSS-16, the valid values are AUTO,
20, 35.

PROVSERNUM= Value Description


<0-16 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: Expected serial number. Applies to SFD, ITL and DCM shelves
only. The provisioned shelf serial number, which (if set to a value
other than NULL) must match the serial number of the shelf itself.
For pre-provisioned shelves, PROVSERNUM can either be
assigned a value or not. If assigned, it will be used as part of the
check for a match during shelf discovery. If not assigned, it will be
automatically assigned the actual serial number upon shelf
discovery. For auto-provisioned shelves, PROVSERNUM is
always assigned the actual serial number.

CONNECTIVITY= Value Description


REQUIRED Managed SFD/DCM/ITL shelf
NOTREQUIRED Unmanaged SFD/DCM/ITL shelf

Default: REQUIRED
Addressing: None
Description: Shelf connectivity indicates whether or not the SFD/DCM/ITL shelf
is expected to be read/managed via the serial electrical inventory
wire. This is needed because the distance limit of the wire is short
enough that some customers will need to locate the SFD/DCM/ITL
beyond the distance limit. When CONNECTIVITY=REQUIRED,
inventory readability indicates presence/absence. When
CONNECTIVITY=NOTREQUIRED, the SFD/DCM/ITL is referred
to as "unmanaged", and is treated as always present, even though
there is no communication.

1830PSS R3.6.50 - TL1 Commands and Messages 777


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-EQPT

CARDMODE= Value Description


DUALTRAN
FLEXMUX
SONETSDH
OTU3

Default: for 4DPA4 the default value is FLEXMUX;


Default: for 43SCA1 the default value is SONETSDH.
Addressing: None
Description: Specify the working mode of the board.

SHELFAINS= Value Description


YES
NO

Default: YES
Addressing: None
Description: Shelf AINS Mode can be set to YES to prevent immediate loss of
communication alarming against a newly pre-provisioned shelf.
Applies to all shelf types.

CARDRATE= Value Description


FULLRATE
SUBRATE
QINQ

Default: QINQ
Addressing: None
Description: Specify the working card rate of the 11DPE12 and 11DPE12E
board.
This parameter only applies to 11DPE12 and 11DPE12E board. In
R3.5, the only value for CARDRATE that is supported is QINQ.

TPID= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x88A8
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.

778 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-EQPT Issue 1, December 2011

This parameter only applies to 11DPE12 pack working under


QINQ mode.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

STPID1= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x88A8
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

STPID2= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x8100
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

1830PSS R3.6.50 - TL1 Commands and Messages 779


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-EQPT

STPID3= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x9100
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

STPID4= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x9200
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode. There are four global TPID values for SVLAN TAG
can be provisioned per pack.Then the STPID provision on each
port of 11DPE12E can be selected among these four STPID
values.
To avoid the ambiguity in processing the Ethernet frame, the type
of the known public protocol is not suggest to be set in the tpid
field, such as 0x0806 (ARP), 0x0200 (PUP), 0x8035(RARP),
0x0800(IP), 0x86DD(IPv6), etc.

FLOWCM= Value Description


APS/PCC
CCM

Default:APS/PCC
Addressing: None
Description: Specify flow continuity monitoring attributes when pack is in QinQ
mode.

780 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-EQPT Issue 1, December 2011

This parameter only applies to 11DPE12E pack.

PST Value Description


IS
OOS

Default: OOS
Addressing: None
Description: Primary State. Does not apply to SHELF.

SST Value Description


AINS Automatic In-Service

Default: None
Addressing: None
Description: Secondary State. Does not apply to SHELF.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 781


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-EQPT
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Input, Invalid ACcess identifier
• the ENT-EQPT command is input for the AID of the main universal shelf

• a module is entered and at least one of its slots is invalid

• the command would result in more than 40 passive shelves

IPNV Input, Parameter Not Valid


• the command is for a Universal Shelf AID, and the parameter PROVSERNUM is set

• PST or SST is being set for SHELF

• TYPEID is not compatible with the specified AID

SAAS Status, Already ASsigned


• the equipment entity is already provisioned

• a module is entered and at least one of its slots is already provisioned

SABT Status, ABorTed


• the command would result in double-provisioning on the bottom slot of a full-height card

• the command would result in double-provisioning on the right-hand slot of a double-width card

EXAMPLES
The following command provisions an OT, out-of-service.

ENT-EQPT::11STAR1-2-5::::OOS;

RELATED COMMANDS
DLT-EQPT
ED-EQPT
RMV-EQPT
RST-EQPT
RTRV-EQPT

782 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-FC100


Command Name: ENT-FC100

PURPOSE
The ENT-FC100 command creates (assigns and provisions) a specified 1G Fibre Channel client
signal facility.
Executing an ENT-FC100 command causes primary and secondary state transitions for the specified
FC100 facility. Primary and secondary states associated with the FC100 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then FC100 enters OOS-MA or OOS-AUMA.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when FC100 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FC100 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FC100 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC100 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC100 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-FC100:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,FCMODE=][,LOSPROP=
][,MODULETYPE=][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0

1830PSS R3.6.50 - TL1 Commands and Messages 783


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC100
Default: Entry Required
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

FCMODE= Value Description


{FIBRE_CHANNEL, FICON,
ISC3_PEER_MODE}

Default: FIBRE_CHANNEL
Addressing: None

784 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC100 Issue 1, December 2011

Description: Attribute that controls FC interface type (Fibre Channel compliant


with INCITS X.320 or FICON)
ISC3_PEER_MODE applies only to 4DPA4.

LOSPROP= Value Description


{LASERON, LASEROFF}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when far end failure gets
signaled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 2FCLC-L, 2FCSN-I,
4FCLC-L, 4FCSN-I, SS-16.1A}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FC100 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Note: 4DPA4 supports only 4FCLC-L and 4FCSN-I.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

1830PSS R3.6.50 - TL1 Commands and Messages 785


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC100

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13,16,19,22,25,2
8,31} (11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
FC100 requires 7 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>

786 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC100 Issue 1, December 2011

Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

1830PSS R3.6.50 - TL1 Commands and Messages 787


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC100
EXAMPLES

The following example shows the successful execution of a ENT-FC100


command.
ENT-FC100:NODE-1:11STM10-1-5-C1:xyz123::::ODU1-L1-1-25:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC100
RST-FC100
DLT-FC100
ED-FC100
RMV-FC100

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

788 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-FC1200


Command Name: ENT-FC1200

PURPOSE
The ENT-FC1200 command creates (assigns and provisions) a specified FC1200 client signal facility.
Executing an ENT-FC1200 command causes primary and secondary state transitions for the specified
FC1200 facility. Primary and secondary states associated with the FC1200 facility after the command
is executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC1200 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when FC1200 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a FC1200 is provisioned to an OOS-MA state, a MAN condition


type is set for the specified port.
When an FC1200 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no
FC1200 transmission condition types or performance monitoring
threshold crossing alerts are autonomously reported for the FC1200
signal, but alarm conditions are monitored and performance
monitoring data is collected (if provisioned for PM collection) for
the signal.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-FC1200:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,CHANNEL=][,MODULE
TYPE=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 789


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC1200

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

790 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC1200 Issue 1, December 2011

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 10GB-SR, XI-64.1,
XS-64.2C, XL-64.2C}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified 10GFC port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type which
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls the status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

1830PSS R3.6.50 - TL1 Commands and Messages 791


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC1200

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

792 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC1200 Issue 1, December 2011

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-FC1200


command.
ENT-FC1200:NODE-1:11STAR1-1-5-C1:xyz123:::moduletype=XI-641:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC1200
RST-FC1200
DLT-FC1200
ED-FC1200
RMV-FC1200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 793


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC1200

794 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-FC200


Command Name: ENT-FC200

PURPOSE
The ENT-FC200 command creates (assigns and provisions) a specified FC client signal facility.
Executing an ENT-FC200 command causes primary and secondary state transitions for the specified
FC200 facility. Primary and secondary states associated with the FC200 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC200 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when FC200 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FC200 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FC200 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC200 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC200 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-FC200:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,FCMODE=][,LOSPROP=
][,MODULETYPE=][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 795


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC200

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 clietn ports)
0
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

796 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC200 Issue 1, December 2011

FCMODE= Value Description


{FIBRE_CHANNEL, FICON,
ISC3_PEER_MODE}

Default: FIBRE_CHANNEL
Addressing: None
Description: Attribute that controls FC interface type (Fibre Channel compliant
with INCITS X.320 or FICON)
ISC3_PEER_MODE applies to 4DPA4 and 11DPM12.

LOSPROP= Value Description


{LASERON, LASEROFF}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when far end failure gets
signaled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 2FCLC-L, 2FCSN-I,
4FCLC-L, 4FCSN-I, SS-16.1A}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FC200 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Note: 4DPA4 supports only 4FCLC-L and 4FCSN-I.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

1830PSS R3.6.50 - TL1 Commands and Messages 797


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC200

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13}
(11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
FC200 requires 14 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None, ODU1}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to odu1-mapping into ODU1 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

798 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC200 Issue 1, December 2011

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

1830PSS R3.6.50 - TL1 Commands and Messages 799


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC200
EXAMPLES

The following example shows the successful execution of a ENT-FC200


command.
ENT-FC200:NODE-1:11STM10-1-5-C1:xyz123::::ODU1-L1-1-25:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC200
RST-FC200
DLT-FC200
ED-FC200
RMV-FC200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

800 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-FC400


Command Name: ENT-FC400

PURPOSE
The ENT-FC400 command creates (assigns and provisions) a specified FC400 client signal facility.
Executing an ENT-FC400 command causes primary and secondary state transitions for the specified
FC400 facility. Primary and secondary states associated with the FC400 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC400 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility FC400 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FC400 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FC400 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FC400 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
FC400 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-FC400:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,FCMODE=][,LOSPROP=
][,MODULETYPE=][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 801


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC400
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

FCMODE= Value Description


{FIBRE_CHANNEL,FICON}

Default: FIBRE_CHANNEL
Addressing: None
Description: Attribute that controls FC interface type (Fibre Channel compliant
with INCITS X.320 or FICON)

802 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC400 Issue 1, December 2011

LOSPROP= Value Description


{LASERON, LASEROFF}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when far end failure gets
signaled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, 4FCLC-L, 4FCSN-I}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FC400 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-2}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{3}-{1,4,7,10,13,16,19,22,25}
(11STMM10 timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment on the Line port <ODU1#>-<Time Slot within
ODU1>. The entire string must be enclosed in double-quotes.

1830PSS R3.6.50 - TL1 Commands and Messages 803


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC400
Parameter TS does not apply to 4DPA4 when
cardMode=DualTran.

CONTAINER= Value Description


{None, ODUF}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to oduf-mapping into ODUF with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

804 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC400 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-FC400


command.
ENT-FC400:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-1-25:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC400
RST-FC400
DLT-FC400
ED-FC400
RMV-FC400

1830PSS R3.6.50 - TL1 Commands and Messages 805


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC400
RELATED AUTONOMOUS RESPONSES
REPT DBCHG

806 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-FC800


Command Name: ENT-FC800

PURPOSE
The ENT-FC800 command creates (assigns and provisions) a specified FC800 client signal facility.
Executing an ENT-FC800 command causes primary and secondary state transitions for the specified
FC800 facility. Primary and secondary states associated with the FC800 facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FC800 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when FC800 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a FC800 is provisioned to an OOS-MA state, a MAN condition type


is set for the specified port.
When an FC800 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no
FC800 transmission condition types or performance monitoring
threshold crossing alerts are autonomously reported for the FC800
signal, but alarm conditions are monitored and performance
monitoring data is collected (if provisioned for PM collection) for
the signal.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-FC800:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,CHANNEL=][,MODULET
YPE=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 807


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC800

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

808 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC800 Issue 1, December 2011

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, X8FCLC-L, X8FCSN-I}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified FC800 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type which
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls the status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

1830PSS R3.6.50 - TL1 Commands and Messages 809


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC800

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid

810 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FC800 Issue 1, December 2011

• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-FC800


command.
ENT-FC800:NODE-1:112SCX10-1-5-C1:xyz123:::moduletype=XI-641:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC800
RST-FC800
DLT-FC1800
ED-FC800
RMV-FC800

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 811


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FC800

812 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-FE


Command Name: ENT-FE

PURPOSE
The ENT-FE command creates (assigns and provisions) a specified FE client signal facility.
Executing an ENT-FE command causes the primary and secondary state transitions for the specified
FE facility. Primary and secondary states associated with the FE facility after the command is executed
depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then FE enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when facility FE is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a FE is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an FE is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no FE transmission condition
types or performance monitoring threshold crossing alerts are autonomously reported for the FE
signal, but alarm conditions are monitored and performance monitoring data is collected (if provisioned
for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-FE:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,AUTONEG=][,LOSPROP=][
,MODULETYPE=][,SSMTRANS=][,SYNCEOPPMODE=][,CHANNEL=][,STPID=][,PST][
,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: TarFEt IDentifier, identifies the network node TID for the
command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 813


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FE
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

AUTONEG= Value Description


{ENABLE, DISABLE}

Default: DISABLE
Addressing: None
Description: Attribute that controls status of auto-negotiation. This parameter
applies to electrical FE SFP ,optical FE SFP does not support this .

LOSPROP= Value Description


{LASEROFF, LASERON}

814 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FE Issue 1, December 2011

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, 100BFX,100BLX10, 1000B-T2}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FE port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
Restrictions: 100BFX is only supported on 11DPE12
OT.
100BLX10 and 1000B-T2 are
only supported on 11DPE12E OT.

SSMTRANS= Value Description


IN SDH mode :
{ACT, PRC, SSU_A, SSU_B, SEC,
DNU,NONE}

in SONET mode :
{ACT, PRS,STU, ST2, ST3E,
ST3,DUS,NONE}

Default: ACT
Addressing: None
Description: Attribute that defines the SSM/Quality Level Transmission in the
port
This parameter shall only apply to the 11DPE12E for
sync-e function.
NOTE:This parameter only takes effect only when pack
SYNCE function is set to enable.

SYNCEOPPMODE Value Description


=
{SYNC,NON-SYNC}

Default: SYNC
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 815


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FE
Description: Attribute that defines port Synchronous Ethernet Operation Mode
This parameter shall only apply to the 11DPE12E for SYNC-E
fucntion.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port. This parameter
applies to optical FE SFP ,electrical FE SFP does not support this .

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: STPID1
Address: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
MT Maintenance

816 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FE Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 817


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FE
• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-FE


command.
ENT-FE:NODE-1:11DPE12E-1-5-C1:xyz123::AUTONEG=enable: :IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FE
RST-FE
DLT-FE
ED-FE
RMV-FE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

818 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-FFP-EQPT


Command Name: ENTER FACILITY PROTECTION GROUP

PURPOSE
The ENT-FFP-EQPT command creates a new 1+1 facility protection group (Y-cable, OPS, or
E-SNCP).
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-FFP-EQPT:[TID]:WORKING_AID,PROTECTION_AID[,ESNCP_CLIENT_AID]:[CT
AG]:::[PSDIRN=][,RVRTV=][,WTR=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 819


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FFP-EQPT

WORKING_AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: The working port AID.
Restriction: 4DPA4 OT supports protection only in
FlexMux mode.
Restriction: 11DPE12 and 11DPE12E OT supports
protection only in fullrate and qinq mode.

820 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FFP-EQPT Issue 1, December 2011

PROTECTION_AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: The protection port AID.

ESNCP_CLIENT_A Value Description


ID
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}

1830PSS R3.6.50 - TL1 Commands and Messages 821


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FFP-EQPT
Default: Entry required
Addressing: None
Description: The E-SNCP Client Port AID.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: <System assigned CTAG value>


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

PSDIRN= Value Description


UNI Unidirectional
BI Bidirectional

Default: UNI
Addressing: None
Description: Protection switching directionality. In unidirectional switching, local
and remote ends switch independently. Y-cable, OPS, and
E-SNCP protection groups support unidirectional operation. In
bidirectional switching, local and remote ends are coordinated by
an end-to-end protocol so that both are on working, or both are on
protection. Only Y-cable protection groups support bidirectional
operation. Both ends of a Y-cable circuit must be provisioned the
same way. A mismatch will cause an alarm.

RVRTV= Value Description


N No
Y Yes

Default: N
Addressing: None
Description: Indicates whether or not switching operation is revertive. In
non-revertive switching, protection remains active after working
has recovered from the failure that caused the automatic switch to
protection, or after the user switch-to-protection command is
cleared. Y-cable, OPS, and E-SNCP protection groups support
non-revertive operation. In revertive switching, traffic is
automatically switched back to working when working has
recovered from the failure that caused the automatic switch to
protection, or when the user switch-to-protection command is
cleared. In the failure-recovery case, the switch back is delayed by
the WTR parameter. In the case of clearing a user switch
command, there is no delay. Only bidirectional Y-cable protection

822 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FFP-EQPT Issue 1, December 2011

groups support revertive operation. Both ends of a Y-cable circuit


must be provisioned the same way.
Restriction: Parameter value RVRTV=Y does not
apply to 43SCX4, 43SCX4E, 43STA1P, 43STX4,
43STX4P OTs (always non-revertive).

WTR= Value Description


{1-20}

Default: 5
Addressing: None
Description: Wait-To-Restore. Affects switching behavior only when
RVRTV=Y. (But the WTR value can be provisioned for any APS
group.) The protection group will wait until working has been
continuously clear for this number of minutes before switching
back to working.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:

1830PSS R3.6.50 - TL1 Commands and Messages 823


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FFP-EQPT
IDNC Input, Data Not Consistent
• the specified local circuit packs are not all of the same type

• the specified local Y-cable working and protection port names do not match

IDNV Input, Data Not Valid


• the specified local circuit packs are full-height OTs which are not horizontally adjacent

• the specified 11DPE12 or 11DPE12E circuit packs are are working in the subrate mode

• the specified 11DPE12 or 11DPE12E VTS numder is out of the range under the fullrate and qinq
mode

• the specified 11DPE12 line port(working line port or protection line port ) involved into the ESNCP
group is not configured as the OTU2 signal type under the fullrate and qinq mode

• the specified working virtual time slot and protection virtual time slot involved into the ESNCP
group belong to the same 11DPE12 line port

• the VLAN map configured for the specified working virtual time slot and protection virtual time
slot is different for 11DPE12 or 11DPE12E line ports under qinq mode

• the ethernet cross connection is not configured ( by ENT-CRS-VTS or ED-CRS-VTS) to the


working path for 11DPE12 or 11DPE12E line port under qinq mode

• the specified working and protection client ports for 11DPE12 Y cable protection have different
VTS XC and VTS parameters

• all the VTSs on the specified working and protection client port for 11DPE12 Y cable protection
have been connected to different line ports

• the line port has assigned as 10GBE LAN signal type for 11DPE12 Y cable protection

• the line port VTS number is out of range of 1-32 for 11DPE12 Y cable protection

• there is passing through VTSXC or adjacent pack VTSXC on 11DPE12 pack for Y cable
protection

• the specified local circuit packs are half-height OTs which are not vertically adjacent

• the specified local working or protection OT has existing Y-cable connections to a third OT

• the specified local Y-cable working and protection port types are not the same

• the two specified OPS ports are not on the same OPS circuit pack

• the specified E-SNCP protection port has existing timeslot assignments

824 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-FFP-EQPT Issue 1, December 2011

• the specified E-SNCP protection port is already defined as the working port (or vice versa) in
another protection group on the same card

• the specified local working OT contains Y-cable protection ports or the protection OT contains
working ports

• bidirectional switching is specified for an OPS or E-SNCP protection group

• unidirectional switching and revertive switching are both specified

IEAE Input, Entity Already Exists


• the specified protection group already exists

IENE Input, Entity does Not Exist


• the specified OT or OPS circuit pack does not exist (at least pre-provisioned even if not physically
present)

SNVS Status, Not in Valid State


• any of the specified ports is administratively unassigned

• either of the Y-cable or OPS ports is administratively in-service

EXAMPLES
The following command creates a bidirectional revertive Y-cable protection group.

ENT-FFP-EQPT:ALU-1830PSS:11STMM10-5-2-C4,11STMM10-5-3-C4:123456:::PS
DIRN=BI,RVRTV=Y,WTR=10;

The following command creates a unidirectional non-revertive OPS protection group.

ENT-FFP-EQPT:ALU-1830PSS:OPS-5-8-A,OPS-5-8-B;

The following command creates a unidirectional non-revertive E-SNCP protection group.

ENT-FFP-EQPT:ALU-1830PSS:4DPA4-5-8-L2,4DPA4-5-8-L1,4DPA4-5-8-C2;

RELATED COMMANDS
DLT-FFP-EQPT
ED-FFP-EQPT
RTRV-FFP-EQPT

1830PSS R3.6.50 - TL1 Commands and Messages 825


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-FFP-EQPT
RELATED AUTONOMOUS RESPONSES
REPT^DBCHG

826 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-IPACL-FILTER


Command Name: ENTER IP ACCESS CONTROL LIST
FILTER DESCRIPTION.

PURPOSE
The ENT-IPACL-FILTER command can be used to define a new filter on the system to be used for IP
Access Control.
An ACL Filter is an ordered list of patterns. A filter consists of a sorted list of (index, pattern) pairs,
where the index indicates the relative position in the list and the pattern indicates the pattern identifier.
When a packet is tested against a filter, it is tested against each pattern starting with the lowest index
and continuing through each remaining pattern in ascending order until a match occurs.
Up to 100 filters may be defined on the system, and each filter may contain up to 256 (index, pattern)
pairs. Internal memory allocation bounds limit the number of simultaneously defined (index, pattern)
pairs across all filters to 4000.
If the matching pattern specifies an action of “block” or “pass,” the packet is dropped or permitted to
pass, respectively, and the progression through the filter list terminates.
If a packet that normally would have been forwarded to another interface is blocked, and an
ICMP-error “true” behavior was specified for the matching pattern, an ICMP 3/13 error will be
generated for transmission to the host originating the blocked packet.
If all patterns in a filter list are tested without yielding a match, then the packet is blocked or passed
according to the ACL global default setting. There are two global default settings, one for received
packets and the other for transmitted packets. These attributes can be provisioned via the SET-IPACL
command.
IP ACL filters are constructed one filter at a time. When a pattern is added to a filter, an index is
specified that indicates the position of the pattern in this filter’s list (please note that the index is not a
property of the pattern itself, as the pattern may have other indices associated with it in other filters). If
a pattern is added to a filter with an index that is already occupied in that filter, the prior pattern defined
at that index is replaced by the new pattern. In order to re-number entries in the filter list, the pattern
must be deleted from the list and re-added via the ED-IPACL-FILTER command.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-IPACL-FILTER:[TID]::CTAG::FILTERID;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 827


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-IPACL-FILTER

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

FILTERID Value Description


{100-199}
<1-30 VALID FILTERID
CHARACTERS>

Default: Entry Required


Addressing: None
Description: Identifier for the ACL filter being defined. Could be either an integer
in the range 100-199 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter , which uniquely identifies the filter being defined.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

828 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-IPACL-FILTER Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SABT Status, Aborted
• another filter with the same identifier is already defined

SSRE Status, System Resources Exceeded


• maximum number of defined filters is reached

EXAMPLES
In this example, one filter called TestExtACL is defined:

ENT-IPACL-FILTER:NODE-1::C0001::TestExtACL;

A successful response for that command would be:

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
/* ENT-IPACL-FILTER:NODE-1::::TestExtACL [C0001] (5) */
;

RELATED COMMANDS
DLT-IPACL-FILTER
ED-IPACL-FILTER
RTRV-IPACL-FILTER

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 829


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-IPACL-FILTER

830 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-IPACL-PATTERN


Command Name: ENTER IP ACCESS CONTROL LIST
PATTERN DESCRIPTION.

PURPOSE
The ENT-IPACL-PATTERN command can be used to define a new pattern on the system to be used
for IP Access Control.
An ACL Pattern is a set of packet field descriptors that can be tested against a packet. For a pattern to
match, each of its field descriptors must fit the data in the packet. The fields that may be tested are:
• Source IP address (or range)
• Destionation IP address (or range)
• TCP/UDP destination port
• IP protocol
• IP fragmentation
• ICMP type and code
• Whether or not a TCP packet belongs to an “established” connection
Each field test is optional: a pattern may specify only some (or no) fields to test. Each pattern also has
an associated action to take when the pattern matches: block or pass. Regardless of the specified
action, a match count associated with the pattern is incremented whenever a match occurs. If a
pattern specifies a block action, it may also specify an ICMP error reporting behavior, which affects
generation of ICMP 3/13 errors for forwarded packets that are blocked. Combination of filterID and
patternID shall not exceed 4000.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-IPACL-PATTERN:[TID]::[CTAG]::PATTERNID,ACTION,[ICMPERROR],[SRCAD
DR],[SRCPREFIX],[SRCPORT],[DESTADDR],[DESTPREFIX],[DESTPORT],[IPPROT
OCOL],[IPFRAGMENT],[ICMPTYPE],[ICMPCODE],[TCPESTABLISHED];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 831


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-IPACL-PATTERN

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

PATTERNID Value Description


{1-256}
<1-30 VALID PATTERNID
CHARACTERS>

Default: Entry required


Addressing: None
Description: The identifier of the ACL pattern to be created. Could be either an
integer in the range 1-256 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter, which is selected by the user to uniquely identify the pattern
in subsequent provisioning requests.

ACTION Value Description


PASS
BLOCK

Default: Entry Required


Addressing: None.
Description: Action to take on packets matching the specified ACL Pattern.
Valid values:
PASS allow the packet if it matches all of the pattern
descriptors
BLOCK disallow the packet if it matches all of the pattern
descriptors

ICMPERROR Value Description


TRUE
FALSE

Default: FALSE
Addressing: None
Description: ICMP Error Reporting behavior for blocked packets. System-wide
default behavior is provisioned by the SET-IPACL command. Valid
values:
TRUE send ICMP error for blocked packets

832 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-IPACL-PATTERN Issue 1, December 2011

FALSE do not send ICMP error for blocked packets

SRCADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <null>
Addressing: None
Description: Source IP Address. String, xxx-xxx-xxx-xxx format. Can be
specified explicitly to match only packets that originate from a
particular address, or can be used along with the SRCPREFIX
parameter to specify a range of supported originating IP
addresses.

SRCPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Default: 0-0-0-0
Addressing: None
Description: Source IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the
reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
SRCADDR is specified and the SRCPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
SRCADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
SRCADDR is also specified. The binary form of the mask must
consist in uniterrupted series of 0 bits. followed by uninterrupted
series of 1 bits.

SRCTPORT Value Description


{0-65535}

Default: <null>
Addressing: None
Description: TCP/UDP Source Port. Integer, 0 - 65535. Applicable only when
IP Protocol is TCP or UDP. Some of the commonly used ports are:
20 FTP-Data TCP File Transfer Protocol [Data]
21 FTP TCP File Transfer Protocol [Control]
23 Telnet TCP Telnet
69 TFTP UDP Trivial File Transfer Protocol
123 NTP UDP Network Time Protocol
161 SNMP UDP SNMP
162 SNMPTRAP UDP SNMPTRAP

1830PSS R3.6.50 - TL1 Commands and Messages 833


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-IPACL-PATTERN
3082 TL1-Raw TCP TL-1 [Raw]
3083 TL1-Telnet TCP TL-1 [User Interface]

DESTADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <null>
Addressing: None
Description: Destination IP Address. String, xxx-xxx-xxx-xxx format. Can be
specified explicitly to match only packets that originate from a
particular address, or can be used along with the DESTPREFIX
parameter to specify a range of supported destination IP
addresses.

DESTPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Default: 0-0-0-0
Addressing: None
Description: Destination IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the
reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
DESTADDR is specified and the DESTPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
DESTADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
DESTADDR is also specified. The binary form of the mask must
consist in uniterrupted series of 0 bits. followed by uninterrupted
series of 1 bits.

DESTPORT Value Description


{0-65535}

Default: <null>
Addressing: None
Description: TCP/UDP Destination Port. Integer, 0 - 65535. Applicable only
when IP Protocol is TCP or UDP. Some of the commonly used
ports are:
20 FTP-Data TCP File Transfer Protocol [Data]
21 FTP TCP File Transfer Protocol [Control]
23 Telnet TCP Telnet
69 TFTP UDP Trivial File Transfer Protocol
123 NTP UDP Network Time Protocol

834 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-IPACL-PATTERN Issue 1, December 2011

161 SNMP UDP SNMP


162 SNMPTRAP UDP SNMPTRAP
3082 TL1-Raw TCP TL-1 [Raw]
3083 TL1-Telnet TCP TL-1 [User Interface]

IPPROTOCOL Value Description


{0-255}
ICMP
IPIP
TCP
UDP
RSVP
GRE
OSPF

Default: <null>
Addressing: None
Description: IP Protocol. Can be specified by explicit protocol number (Integer,
0-255) or by keyword (for common protocol types, listed below).
Valid values:
ICMP - IP protocol is ICMP (1)
IPIP - IP protocol is IPIP (4)
TCP - IP protocol is TCP (6)
UDP - IP protocol is UDP (17)
RSVP - IP protocol is RSVP (46)
GRE - IP protocol is GRE (47)
OSPF - IP protocol is OSPF (89)
<other protocol> -Specify IP protocol number: 0 to 255

IPFRAGMENT Value Description


TRUE
FALSE

Default: FALSE
Addressing: None.
Description: IP Fragmentation. Valid values:
TRUE - pattern is an IP fragment
FALSE - pattern is not an IP fragment

ICMPTYPE Value Description


{0-255}

1830PSS R3.6.50 - TL1 Commands and Messages 835


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-IPACL-PATTERN
Default: <null>
Addressing: None
Description: ICMP Type identifier. Integer, 0 - 255. Applicable only when
IPPROTOCOL is ICMP. If specified, the pattern will only match
packets with this exact ICMP type. Some of the most commonly
used ICMP types.
0 Echo Reply [RFC792]
3 Destination Unreachable[RFC792]
5 Redirect[RFC792]
9 Router Advertisement[RFC1256]
42-255 Reserved

ICMPCODE Value Description


{0-255}

Default: <null>
Addressing: None.
Description: ICMP Code field. Integer, 0 - 255.
Applicable only when IP Protocol is ICMP. Used along
with certain ICMP types to further specify the message
type. Must also specify the ICMP type when setting
this parameter. If specified, the pattern will only
match packets with this exact ICMP code value.
For example, there are a few ICMPCODEs associated to
the ICMPTYPE Redirect [RFC792]:
0 Redirect Datagram for the Network (or subnet)
1 Redirect Datagram for the Host
2 Redirect Datagram for the Type of Service and
Network
3 Redirect Datagram for the Type of Service and Host

TCPESTABLISHED Value Description


TRUE
FALSE

Default: <null>
Addressing: None.
Description: TCP Established flag. Matches a packet depending on whether
the TCP flags in the IP header correspond to the “established”
state. Applicable only when IP Protocol is TCP. Valid values:
TRUE - TCP flags correspond to “established” state
FALSE - TCP flags do not correspond to
“established” state

836 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-IPACL-PATTERN Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• SRCPREFIX is specified without the SRCADDR

• DESTPORT is specified and the IPPROTOCOL is different from TCP or UDP

• DESTPREFIX is specified without the DESTADDR

• DESTPORT is specified and the IPPROTOCOL is different from TCP or UDP

• ICMPTYPE is specified and the IPPROTOCOL is different from ICMP

• ICMPCODE is specified without the ICMPTYPE

• TCPESTABLISHED is specified and the IPPROTOCOL is different from TCP

IEAE Input, Entity Already Exists

1830PSS R3.6.50 - TL1 Commands and Messages 837


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-IPACL-PATTERN
• another pattern with the same identifier is already defined

SABT Status, ABorted


• maximum number of defined patterns is reached

EXAMPLES
In this example, one pattern is defined to match all received TCP traffic on port 23 (i.e. incoming CLI
requests). This pattern has no action associated with it, since we are using it only to count incoming
CLI request packets for demonstrative purposes:

ENT-IPACL-PATTERN:::C0001::1,PASS,,10-17-0-46,0-0-0-0,,,,23,TCP;

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* ENT-IPACL-PATTERN:::::1,PASS,,10-17-0-46,0-0-0-0,,,,23,TCP
[C0001] (5) */
;

RELATED COMMANDS
DLT-IPACL-PATTERN
ED-IPACL-PATTERN
RTRV-IPACL-PATTERN

RELATED AUTONOMOUS RESPONSES


None.

838 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-NE-IPRT


Command Name: ENTER NETWORK ELEMENT IP ROUTE

PURPOSE
This command allows the administrative operator to add a new static IP route into the IP routing table.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-NE-IPRT:[TID]::[CTAG]::DESTADDR,MASK,NEXTHOP,[DISTANCE],[ADVERTI
SE];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DESTADDR Value Description


0-0-0-0
{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <Entry Required>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 839


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-NE-IPRT
Description: Destination Address, IP address of the destination host or network
(in the format nnn-nnn-nnn-nnn). The address 0-0-0-0 is used to
specify a default route. If MASK is not all 1's when viewed in
binary format (i.e., a network route is specified), the host portion of
the DESTADDR must be all 0's.

MASK Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Default: <Entry Required>


Addressing: None
Description: IP Mask, IP subnet mask of the route (in the format
nnn-nnn-nnn-nnn). The mask 0-0-0-0 is used to specify a default
route.

NEXTHOP Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <Entry Required>


Addressing: None
Description: Next hop address, IP address of the next interface in the route (in
the format nnn-nnn-nnn-nnn). This is also known as the “gateway
address”. The target NE shall be directly connected to this
interface. The address 0-0-0-0 is not allowed.

DISTANCE Value Description


[1..255]

Default: 1
Addressing: None
Description: The distance value is used to determine
which route to be entered in the NE routing table when
there are multiple identical routes discovered via
different routing protocols.
Lower values have higher precedence. The OSPF routing
protocol has a fixed distance value of 110. As a
result if a static route is entered with a distance
value of 1 and the same route with a different next
hop is discovered via OSPF, the static route will be
installed in the NE routing table.

840 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-NE-IPRT Issue 1, December 2011

ADVERTISE Value Description


N
Y

Default: Y
Addressing: None
Description: Specifies whether the IP route is leaked into the OSPF routing
protocols.
N Route is only known on the local NE
Y Route is leaked into OSPF and distributed over the
network.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 841


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-NE-IPRT
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input Parameter Missing
• the DESTADDR, MASK, or NEXTHOP parameter is not specified

• there are no active/enabled Ethernet interfaces on the NE

• the MASK parameter specifies a network route (MASK is not all 1's), and the DESTADDR
parameter does not specify a matching network address (the host part of the address is not all
0's)

IEAE Input, Entity Already Exists


• the IP routing table comprises an entry whose DESTADDR, MASK, and NEXTHOP parameters
match exactly the with one that is already on the NE

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

EXAMPLES
In the following example, ENT-NE-IPRT sets up a static IP route to the destination 128.210.54.0, which
uses the network mask 255.255.255.0. The next hop in the route is reachable via the OAMP interface,
and has IP address 10.1.1.2 in the subnet 10.1.1.0, the route is advertised, and the cost/distance of the
route is 3.

ENT-NE-IPRT:::C0001::128-210-54-0,255-255-255-0,10-1-1-1,3,Y;

A successful response for that command would be:

^^^LASVEGAS^06-01-13^08:46:59
M^^C0001^COMPLD
/* ENT-NE-IPRT:::C0001::128-210-54-0,255-255-255-0,10-1-1-1,3,Y
[C0001] (5) */
;

RELATED COMMANDS
DLT-NE-IPRT
ED-NE-IPRT
RTRV-NE-IPRT

842 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-NE-IPRT Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 843


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-NE-IPRT

844 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-NTP-ADDR


Command Name: ENTER NTP SERVER IP ADDRESS

PURPOSE
The ENT-NTP-ADDR command enters the IP address of trusted Network Time Protocol (NTP). NTP
servers are used for time of day synchronization when the NTP protocol is enabled (via the ED-NTP
command).
The user can enter up to 3 NTP trusted servers.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-NTP-ADDR:[TID]::[CTAG]:::IP{1-3}=<IPv4_Address>;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

IP1-3= Value Description


{1-99,102-126,128-223}-{0-255}-{0-255}
-{0-255}

Default: <entry required>


Addressing: None
Description: IPv4 Network address of an NTP server

1830PSS R3.6.50 - TL1 Commands and Messages 845


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-NTP-ADDR
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the IP address is already entered as an NTP server

• the entered IP address is any IP address of this NE

IPNV Input, Parameter Not Valid


• the entered IP address is 0-0-0-0, or any other invalid IP address

EXAMPLES
In the following example, ENT-NTP-ADDR provisions an NTP server with IP address 128.251.31.36.

ENT-NTP-ADDR:::C0001:::IP1=128-251-31-36;

The output response is shown below.

846 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-NTP-ADDR Issue 1, December 2011

cr lf lf
^^^LASVEGAS^01-02-27^08:46:59 cr lf
M^^C0001^COMPLD cr lf
/* ENT-NTP-ADDR:::C0001:::IP1=128-251-31-36[C0001] (5)*/
;

RELATED COMMANDS
DLT-NTP-ADDR
ED-NTP
RTRV-NTP
RTRV-NTP-ADDR

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 847


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-NTP-ADDR

848 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OC12


Command Name: ENT-OC12

PURPOSE
The ENT-OC12 command creates (assigns and provisions) a specified OC12 client signal facility.
Executing an ENT-OC12 command causes primary and secondary state transitions for the specified
OC12 facility. Primary and secondary states associated with the OC12 facility after the command is
executed depend upon values entered for PST,SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OC12 enters IS-NR or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC12 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a OC12 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC12 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC12 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC12 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OC12:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,SDTH=][,SFTH=][,J0_
EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,MODULETYPE
=][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 849


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC12
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

850 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC12 Issue 1, December 2011

SFTH= Value Description


{10-3,10-4,10-5}

Default: 10-3
Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (0-255) if
J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if J0_FMT is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

1830PSS R3.6.50 - TL1 Commands and Messages 851


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC12

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SL-4.1, SL-4.2,
SL-16.2C, SS-4.1, SS-16.1A,
SS-16.2C}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified OC12 port. If AUTO value is

852 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC12 Issue 1, December 2011

chosen NE shall accept the pluggable module type inserted in the


socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Restrictions: the module types SS-4.1 and SL-4.2 are supported only on
4DPA4 and 11DPM12 client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-4}-{1, 13, 25, 37}
(11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
OC12/STM4 requires 4 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.

1830PSS R3.6.50 - TL1 Commands and Messages 853


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC12
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

854 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC12 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-OC12


command.
ENT-OC12:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-3-1:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC12
RST-OC12
DLT-OC12
ED-OC12
RMV-OC12

1830PSS R3.6.50 - TL1 Commands and Messages 855


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC12
RELATED AUTONOMOUS RESPONSES
REPT DBCHG

856 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OC192


Command Name: ENT-OC192

PURPOSE
The ENT-OC192 command creates (assigns and provisions) a specified OC192 client signal facility.
Executing an ENT-OC192 command causes primary and secondary state transitions for the specified
OC192 facility. Primary and secondary states associated with the OC192 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then OC-192 enters OOS-MA or OOS-AUMA.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC192 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a OC192 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC192 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC192 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC192 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OC192:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,MAPPINGMODE=][,CHA
NNEL=][,SDTH=][,SFTH=][,J0_EX=][,J0_FMT=][,TRCCMP=][,LOSPROP=][,MODU
LETYPE=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 857


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC192

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None

858 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC192 Issue 1, December 2011

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

MAPPINGMODE= Value Description


BITSYNC bit synchronous CBR mapping
ASYNC asynchronous CBR mapping

Default: BITSYNC
Addressing: None.
Description: Type of mapping of OC192/STM64 into an ODU2 structure.
The MAPPINGMODE parameter applies to the 43STX4,
43STX4P, 43SCX4L and 43SCX4 OTs.
The MAPPINGMODE parameter shall apply to the 112SCX10,
112SNX10, and 112SX10L OTs.
This parameter shall not apply to the 11QPA4 and 11QTA4 OTs.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect decalration.
The SDTH parameter does not apply to the 43STX4 and 43STX4P
OTs.
The SDTH parameter applies to the 43SCX4L OT and 43SCX4
OT.

SFTH= Value Description


{10-3,10-4,10-5}

Default: 10-3
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 859


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC192
Description: Attribute that specifies BER threshold for Excessive BER defect
decalration.
The SFTH parameter does not apply to the 43STX4 and 43STX4P
OTs.
The SFTH parameter applies to the43SCX4L OT and 43SCX4 OT.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None

860 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC192 Issue 1, December 2011

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11STAR1, 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
112SCX10, 112SNX10, and 112SX10L
OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QPA4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QTA4 OTs.

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified OC192 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

1830PSS R3.6.50 - TL1 Commands and Messages 861


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC192
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

862 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC192 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a ENT-OC192


command.
ENT-OC192:NODE-1:11STAR1-1-5-C1:xyz123::::IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC192
RST-OC192
DLT-OC192
ED-OC192
RMV-OC192

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 863


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC192

864 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OC3


Command Name: ENT-OC3

PURPOSE
The ENT-OC3 command creates (assigns and provisions) a specified OC3 client signal facility.
Executing an ENT-OC3 command causes primary and secondary state transitions for the specified
OC3 facility. Primary and secondary states associated with the OC3 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OC3 enters OOS-MA or IS-ANR.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC3 is free of failures, it
enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a OC3 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC3 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC3 transmission condition
types or performance monitoring threshold crossing alerts are autonomously reported for the OC3
signal, but alarm conditions are monitored and performance monitoring data is collected (if provisioned
for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OC3:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,SDTH=][,SFTH=][,J0_E
X=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,MODULETYPE=
][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 865


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC3
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

866 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC3 Issue 1, December 2011

SFTH= Value Description


{10-3,10-4,10-5}

Default: 10-3
Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

1830PSS R3.6.50 - TL1 Commands and Messages 867


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC3

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 values. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SL-1.1, SL-1.2,
SL-16.2C, SS-1.1, SS-16.1A,
SS-16.2C}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified OC3 port. If AUTO value is

868 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC3 Issue 1, December 2011

chosen NE shall accept the pluggable module type inserted in the


socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Restriction: The module types SS-1.1 , SL-1.2 are supported
only by 4DPA4 Client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-4}-{1, 4, 7, 10, 13, 16, 19,
22, 25, 28, 31, 34, 37, 40, 43, 46}
(11STMM10 timeslots)
{L1,L2}-({1-16}) (4DPA4
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port (L1 or L2).

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

1830PSS R3.6.50 - TL1 Commands and Messages 869


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC3

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

870 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC3 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-OC3


command.
ENT-OC3:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-3-1:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC3
RST-OC3
DLT-OC3
ED-OC3
RMV-OC3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 871


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC3

872 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OC48


Command Name: ENT-OC48

PURPOSE
The ENT-OC48 command creates (assigns and provisions) a specified OC48 client signal facility.
Executing an ENT-OC48 command causes primary and secondary state transitions for the specified
OC48 facility. Primary and secondary states associated with the OC48 facility after the command is
executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then OC48 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC48 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When a OC48 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC48 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC48 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC48 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OC48:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,SDTH=][,SFTH=][,J0_
EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,MODULETYPE
=][,CHANNEL=],TS=[,CONTAINER=][,MAPPINGMODE=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 873


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC48
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4 and 4DPA2.

874 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC48 Issue 1, December 2011

SFTH= Value Description


{10-3,10-4,10-5}

Default: 10-3
Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4 and 4DAP2 .

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in Hex format if J0_FMT is
1_byte>

Default: <null>
Addressing: None
Description: Expected J0. Does not apply to 4DPA4 and 4DPA2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0 to 255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4 and 4DPA2 .
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4 and 4DAP2. Only 16-byte
format applies to 4DPA4 and 4DAP2.

1830PSS R3.6.50 - TL1 Commands and Messages 875


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC48

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4 and 4DPA2.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(ie., expected) J0 value. Does not apply to 4DPA4 and 4DPA2.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SS-16.1A,
SS-16.2C}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified OC48 port. If AUTO value is

876 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC48 Issue 1, December 2011

chosen NE shall accept the pluggable module type inserted in the


socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Note: SI-16.1 and SL-16.2 are not supported on 4DPA2
OT.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)
{L1,L2}-(1) (4DPA4 timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4 and 4DAP2 : Timeslot assignment on the specified Line
port (L1 or L2). Timeslot 1 represents the entire OTU1 capacity
(all 16 timeslots).

CONTAINER= Value Description


{None, ODU1}

Default: None
Addressing: None
Description: Specifies the granularity for client OC48 mapping to ODU2
multiplexing structure.
Set to odu1-mapping into ODU1 per G.709.
This parameter only applies to 11DPM12.

1830PSS R3.6.50 - TL1 Commands and Messages 877


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC48

MAPPINGMODE= Value Description


{ASYNC, BITSYNC}

Default: None
Addressing: None
Description: Specifies the mapping mode for constant bit rate client signals into
OPUk.
ASNYC- asynchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation fuction.
BITSYNC-synchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation function.
This parameter only applies to 11DPM12 pack when
CONTAINER=ODU1.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

878 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC48 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-OC48


command.
ENT-OC48:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-3-1:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC48
RST-OC48
DLT-OC48
ED-OC48
RMV-OC48

1830PSS R3.6.50 - TL1 Commands and Messages 879


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC48
RELATED AUTONOMOUS RESPONSES
REPT DBCHG

880 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OC768


Command Name: ENT-OC768

PURPOSE
The ENT-OC768 command creates (assigns and provisions) a specified OC768 client signal facility.
Executing an ENT-OC768 command causes primary and secondary state transitions for the specified
OC768 facility. Primary and secondary states associated with the OC768 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then OC768 enters OOS-MA or OOS-AUMA.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OC768 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a OC768 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an OC768 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OC768 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OC768 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OC768:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,J0_EX=][,J0_FMT=][
,TRCCMP=][,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 881


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC768
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the

882 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC768 Issue 1, December 2011

ITU-T Recommendation T.50 (09/92) International Reference


Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>

1830PSS R3.6.50 - TL1 Commands and Messages 883


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC768
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

884 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OC768 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a ENT-OC768


command.
ENT-OC768:NODE-1:43STA1P-1-5-C1:xyz123::::IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC768
RST-OC768
DLT-OC768
ED-OC768
RMV-OC768

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 885


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OC768

886 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OCH


Command Name: ENTER-OCH

PURPOSE
The ENT-OCH command is used to set the parameters of an optical channel.

INPUT FORMAT

ENT-OCH:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,MODULETYPE=]:[PST][,
SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OCH.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 887


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OCH

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: <previously existing value>


Addressing: None
Description: AINSTMR, Transition soak time out of AINS. Format is
HOURS-MINUTES. Maximum time is 96-00.
SYSTEM Use the system level timer

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <previously existing value>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if it
contains non- alphanumeric characters.
<USERLABEL> 1-40 alphanumeric or dash "-" characters
assigned as a userlabel for this profile

MODULETYPE= Value Description


AUTO
USER
fVOA
sVOA

Default: AUTO
Addressing: None
Description: MODULETYPE, Specifies the Signal and SFP type for the VA port.
AUTO Auto detect SFP type
USER User defined SFP
fVOA Fast VOA
sVOA Slow VOA
The sVOA Module type only appies to 11QPA4 and
11DPE12,11DPE12E, 11DPM12 VA ports
The USER Module type does not appies to 11QPA4,
11DPE12,11DPE12E,11DPM12 and 4DPA4 VA ports
<specific-type>

PST Value Description


{IS, OOS}

888 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OCH Issue 1, December 2011

Default: OOS
Addressing: None
Description: PST, Primary State for the OCH.
IS In Service
OOS Out of Service

SST Value Description


AINS

Default: AINS
Addressing: None
Description: SST, Secondary State for the OCH.
AINS Automatic In Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a ENT-OCH command.

1830PSS R3.6.50 - TL1 Commands and Messages 889


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OCH

ENT-OCH:NODE-1:4DPA4-2-5-VA1:123456:::MODULETYPE=AUTO;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* ENT-OCH:NODE-1:4DPA4-2-5-VA1:123456:::MODULETYPE=AUTO; */
;

The following example configures the CWR8 CLS1 port for single channel operation.

ENT-OCH:NODE-1:CWR-2-5-CLS1:123456:;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* ENT-OCH */
;

RELATED COMMANDS
DLT-OCH
ED-OCH
RMV-OCH
RST-OCH
RTRV-OCH

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

890 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OSPF-AREA


Command Name: ENTER OSPF AREA

PURPOSE
The ENT-OSPF-AREA command creates an OSPF area in the NE. The NE can be part of up to 3
OSPF areas, in addition to the default backbone area (0-0-0-0). After an OSPF Area is created, it can
then be assigned to a OAMP, VOIP, E1, E2, OSC or GCC interface.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OSPF-AREA:[TID]:AID:[CTAG]:::AREAID=[,AREATYPE=][,OPQLSADNS=][,O
PQLSAWAVKEY=][,NSSATRANSLATE=][,STUBDFTMTC=][,VIRTUALLINK=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


OSPFAREA-{1-3} (Non-backbone OSPF Areas)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access identifier for an OSPF Area.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 891


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OSPF-AREA

AREAID= Value Description


{0-255}-{0-255}-{0-255}-{1-254}

Default: <entry required>


Addressing: None
Description: Area ID of the OSPF Area. This ID has the format of an IP
Address. The ID 0-0-0-0 is not allowed since the backbone area
always exists and is automatically enabled or disabled. AreaID is
like IP address but is not an IP address and hence does not have
any restrictions.

AREATYPE= Value Description


NORMAL
STUB
TOTALLY-STUB
NSSA
NSSA-TOTALLY-STUB

Default: NORMAL
Addressing: None
Description: Specifies an OSPF area type:
normal areas are defined as areas that can accept
intra-area, inter-area and external routes.
Default: normal

stub areas do not accept routes belonging to external autonomous


systems (AS); however, these areas have inter-area and intra-area
routes. This reduces the size of the routing databases for the
area's internal routers. Routers in the stub area also contain a
default route which is advertised to the area by the Area Border
Router (ABR).
nssa (Not So Stub Areas) can import AS external routes from
within the area and send them to other areas, but cannot receive
AS external routes from other areas. Inter-area and intra-area
routes are allowed along with a default route which is advertised to
the area by the ABR..
totally_stub areas do not allow routes other than intra-area and
the default route to be propagated within the area. This further
reduces the size of the routing databases for the area's internal
routers. The ABR advertises a default route into the area and all
the routers belonging to this area use the default route to send any
traffic outside the area.

nssa_totally_stub areas are similar to nssa with the added


restriction that inter-area routes are not allowed.

892 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OSPF-AREA Issue 1, December 2011

OPQLSADNS=

{Y, N}
Default: Y
Addressing: None
Description: Opaque LSA status for the DNS
application. Determines, whether opaque
LSAs for the DNS application shall be distributed into
this OSPF area, and received from this area. DNS
opaque LSAs can only be enabled in one OSPF Area.

Y DNS opaque LSAs are distributed to the area, and


received from the area
N DNS opaque LSAs are not distributed to the
area, and not received from the area

OPQLSAWAVKEY=

{Y, N}
Default: Y
Addressing: None
Description: Opaque LSA status for the Wave KEY
application. Determines, whether opaque
LSAs for the Wave KEY application shall be
distributed into this OSPF area, and received from
this area. Wave Key opaque LSAs can only be enabled in
one OSPF Area.
Y Wave KEY opaque LSAs are distributed to the
area, and received from the area
N Wave KEY opaque LSAs are not distributed to the
area, and not received from the area

NSSATRANSLATE=
CANDIDATE
ALWAYS
NEVER
Default: CANDIDATE
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 893


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OSPF-AREA
Description: Applicable only if area type is nssa or
nsssa_totally_stub. Determines behavior of NSSA ABR
router translation of internal area type 7 LSAs to
type 5 LSAs which get propagated into other areas.
- candidate OSPF ospf elects one of candidate routers
to be a translator for this area.
- always router will be always used as translator for
this area
- never router will never be used as translator for
this area
Default: candidate

STUBDFTMTC= Value Description


{0-16777215}

Default: 10
Addressing: None
Description: Applicable only for stub, nssa type areas. Specifies the cost for
the default route originated by stub, nssa area ABR.

VIRTUALLINK= Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: 0.0.0.0 (no vitual link)


Addressing: None
Description: Applicable only for normal Areas. Allows
for the creation of a virtual link for this area..
OSPF requires that all areas attach directly to Area
0.0.0.0, but the attachment need not be physical. One
can take any physical arrangement of areas and attach
them logically through OSPF virtual links. Specify
the Loopback interface IP Address of the NE to
terminate the virtual link. This NE should have an
interface that is connected to Area 0.0.0.0 and a non
0.0.0.0 Area.
If this NE is not attached to the area 0-0-0-0, the
specified virtual link address is the one of an ABR,
which is attached to area 0-0-0-0.
If this NE is attached to area 0-0-0-0, the specified
virtual link address is the one of NE, which has set
up the corresponding reverse virtual link.
Note: A virtual link must be configured on both NEs.
Virtual links can not be established through Area
0.0.0.0, stub, nssa type areas.
Note: When a virtual link is created across an OSC or GCC path,
the MTU size must be set to 1500 bytes for the OSC/GCC in
terfaces on that path.

894 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OSPF-AREA Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the STUBDFTMTC is configured for area type NORMAL

• the NSSATRANSLATE is configured for area type NORMAL or STUB

• the VIRTULINK parameter is configured for area type STUB or NSSA

• the OPQLSADNS parameter is enabled in more than one area

• the OPQLSAWAVKEY parameter is enabled in more than one area

IEAE Input, Entity Already Exists


• the specified OSPFAREA already exists

IPNC Input, Parameter Not Consistent


• the specified AREAID is already being used by another OSPFAREA

1830PSS R3.6.50 - TL1 Commands and Messages 895


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OSPF-AREA
PICC Privilege, Illegal Command Code
• the command is issued by a non-privilege user

EXAMPLES
In the following example, ENT-OSPF-AREA provisions an OSPFAREA on a NE:

ENT-OSPF-AREA::OSPFAREA-1:C0001:::AREAID=192-1-1-1,AREATYPE=STUB,OPA
QUE-LSADNS=Y,NSSATRANSLATE=CANDIDATE,STUBDFTMTC=10,VIRTUAL-LINK=0.0.
0.0,SHORTCUT=DISABLE;

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
/* ENT-OSPF-AREA::OSPFAREA-1:C0001:::AREAID=192-1-1-1,AREATYPE=STUB
[C0001] (5) */
;

RELATED COMMANDS
DLT-OSPF-AREA
RTRV-OSPF-AREA

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

896 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OTS


Command Name: ENTER FACILITY - OTS

PURPOSE
The ENT-OTS command is used to set the parameters of an optical line. This includes the current
operating parameters and characteristics of connected fiber type.

INPUT FORMAT

ENT-OTS:[TID]:AID:[CTAG]:::[TYPE=][,MODULETYPE=][,AINSTMR=][,DESCR=]
:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)
WR-<shelf>-<slot>-ADDIN{1-8} (WR8-88A ADDIN Ports)
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Default: <entry required>

1830PSS R3.6.50 - TL1 Commands and Messages 897


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTS
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OTS.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

TYPE= Value Description


OC3
100BASEFX

Default: OC3
Addressing: None
Description: TYPE, Specifies the Signal type for the OSCT.

MODULETYPE= Value Description


SS-16.2O
SL-16.2O
SUL-1.2O
SEU-1.2O

Default: SL-16.2O
Addressing: None
Description: MODULETYPE, Specifies the Signal and SFP type for the OSC.
SS-16.2O OC3 Short Haul
SL-16.2O OC3 Long Haul
SUL-1.2O OC3 Ultra-Long Haul
SEU-1.2O OC3 Enhanced Ultra-Long Haul

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: 08-00
Addressing: None
Description: AINSTMR, Transition soak time out of AINS. Format is
HOURS-MINUTES. Maximum time is 96-00.
SYSTEM Use the system level timer

898 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTS Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: none
Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if it
contains non- alphanumeric characters.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: PST, Primary state.
IS In Service
OOS Out Of Service

SST Value Description


AINS

Default: AINS
Addressing: None
Description: SST, Secondary state.
AINS Automatic In Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 899


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTS
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a ENT-OTS command.

ENT-OTS:NODE-1:ALPHG-3-9-OSC:789012::::OOS;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* ENT-OTS:NODE-1:ALPHG-3-9-OSC:789012::::OOS; */
;

The following example configures the CWR8 CLS1 port for multiple channel operation.

ENT-OTS:NODE-1:CWR-2-5-CLS1:123456:;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* ENT-OTS */
;

RELATED COMMANDS
DLT-OTS
ED-OTS
RMV-OTS
RST-OTS
RTRV-OTS

900 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTS Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 901


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTS

902 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OTU1


Command Name: ENT-OTU1 (CLIENT AID FOR 11STMM10
OT AND 11DPM12 OT, AND LINE AID
FOR 4DPA4 OT)

PURPOSE
The ENT-OTU1 command creates (assigns and provisions) a specified OTM0.1 port.
The ENT-OTU1 on the line side is not supported for tuneable OTs.
The ENT-OTU1 command applies to the client side ports on the 11STMM10 OT or 11DPM12 OT, and
to the line side ports on the 4DPA4 OT.
Executing an ENT-OTU1 command causes primary and secondary state transitions for the specified
OTM0.1 facility. Primary and secondary states associated with the OTM0.1 facility after the command
is executed depend upon values entered for PST, SST and events detected by the system.
The state transitions are described in the IOM Appendix F.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OTM0.1 facility is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
If no values are entered for PST,SST then OTU1 enters OOS-MA or OOS-AUMA.
When an OTU1 port is provisioned to an OOS-MA state, a MAN condition type is set for the specified
port. When an OTU1 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OTU1 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OTM0.1 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OTU1:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,OPRMODE=][,FECTYPE=
][,EXP_SAPI=][,TX_SAPI=][,TRCCMP=][,TIMMRESP=][,LOSPROP=][,MODULETYP
E=][,CHANNELTX=][,CHANNELRX=],TS=:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 903


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU1

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Default: Entry Required


Addressing: None

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

OPRMODE= Value Description


ADD_DROP
CROSSREGEN

Default: ADD_DROP
Addressing: None

904 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU1 Issue 1, December 2011

Description: 4DPA4 line port operational mode. In ADD_DROP, client port


signals are added to and dropped from the line port. In
CROSSREGEN mode, line-to-line regeneration is performed and
no client ports are used. This parameter applies to 4DPA4 only,
when cardMode=FlexMux.
Operational mode is directly provisionable only on
port L1. The value on port L2 is read-only, and is
always equal to the L1 value.
Operational mode is not provisionable when ports are
unassigned.

FECTYPE= Value Description


{NOFEC,RSFEC} (these values apply
to the OTU1 client facility on the
11STMM10 OT and on the OTU1 line
facility on the 4DPA4 OT)

Default: RSFEC
Addressing: None
Description: Forward Error Correction mode (FEC Mode). This parameter
indicates the type of Forward Error Correction on a DWDM port.
NOFEC NO FEC (FEC correction disabled)
RSFEC Reed-Solomon FEC

EXP_SAPI= Value Description


<0-15 characters>

Default: Null character (15 bytes each with hex value 00)
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

TX_SAPI= Value Description


<0-15 characters>

Default: Null character (15 bytes each with hex value 00)
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 905


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU1
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g., whose hex
representation is 0x00).

15 ASCII characters, enclosed in quotation marks. The coded


representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

LOSPROP= Value Description


{LASEROFF, LASERON}

906 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU1 Issue 1, December 2011

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when a far end failure gets
signalled

MODULETYPE= Value Description


{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SL-16.2D,
SS-16.1A, SS-16.2C , 4FC-OC,
4FC-OD}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on the specified OTU1 port. If AUTO value
is chosen NE shall accept the pluggable module type inserted in
the socket if previous MODULETYPE value was <null> and
module type matches one on qualified list of modules.
Restrictions: SL-16.2 is not supported on 4DPA4 line
port.
SL-16.2D is not supported on
11STMM10.
4FC-OC, 4FC-OD are supported
by 4DPA4 line ports only when CardMode=DualTran.
If user wants to use pluggable module type not on ALU qualified
module list without generating alarms this attribute shall be set to
USER.

CHANNELTX= Value Description


NONE (not yet assigned)
{9600, 9590, 9580, 9570, 9560, 9550,
9540, 9530, 9520, 9510, 9500, 9490,
9480, 9470, 9460, 9450, 9440, 9430,
9420, 9410, 9400, 9390, 9380, 9370,
9360, 9350, 9340, 9330, 9320, 9310,
9300, 9290, 9280, 9270, 9260, 9250,
9240, 9230, 9220, 9210, 9200, 9190,
9180, 9170} (DWDM frequencies;
applies to 4DPA4 Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs, and 4DPA4 Line
AIDs)
{850, 1310, 1550} (B&W wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs and 4DPA4 Line
AIDs)

1830PSS R3.6.50 - TL1 Commands and Messages 907


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU1
Default: NONE
Addressing: None
Description: Attribute that defines the transmit frequency of the transponder
optical interface. This applies to the 11STMM10 client port, the
11DPM12 client port, and to the 4DPA4 line port.

CHANNELRX= Value Description


NONE (not yet assigned)
{9600, 9590, 9580, 9570, 9560, 9550,
9540, 9530, 9520, 9510, 9500, 9490,
9480, 9470, 9460, 9450, 9440, 9430,
9420, 9410, 9400, 9390, 9380, 9370,
9360, 9350, 9340, 9330, 9320, 9310,
9300, 9290, 9280, 9270, 9260, 9250,
9240, 9230, 9220, 9210, 9200, 9190,
9180, 9170} (DWDM frequencies;
applies to 4DPA4 Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs, and 4DPA4 Line
AIDs)
{850, 1310, 1550} (B&W wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs and 4DPA4 Line
AIDs)

Default: NONE
Addressing: None
Description: Attribute that defines the receive frequency of the transponder
optical interface. This applies to the 11STMM10 client port, the
11DPM12 client port, and to the 4DPA4 line port.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment on the Line port <ODU1#>-<Time Slot within
ODU1>. The entire string must be enclosed in double-quotes.
This parameter only applies to the 11STMM10 OT. It does not
apply to the 4DPA4 OT.

PST Value Description


{IS,OOS}

908 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU1 Issue 1, December 2011

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:

1830PSS R3.6.50 - TL1 Commands and Messages 909


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU1
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS,

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-OTU1


command for a client port on a 11STMM10 OT.
ENT-OTU1:NODE-1:11STMM10-1-5-C1:xyz123:::fectype=RSFEC,tx_sapi="ABCD
EFGHIJKLMNO",exp_sapi="ABCDEFGHIJKLMNO",trccmp=ENABLED,timmresp=DISA
BLED:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU1
RST-OTU1
DLT-OTU1
ED-OTU1
RMV-OTU1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

910 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OTU2


Command Name: ENT-OTU2 (CLIENT AID FOR 11STAR1
AND CLIENT AID FOR 43STX4, 43STX4P,
43SCX4L AND 43SCX4, 112SCX10,
112SNX10, AND 11QPA4, 11STAR1A,
LINE PORT FOR 11QPA4 AND 11DPE12,
11DPE12E, 11DPM12)

PURPOSE
The ENT-OTU2 command creates (assigns and provisions) a specified OTM0.2 port.
The ENT-OTU2 on the line side is not supported for most tuneable OTs. The OTU2 object entity shall
be automatically created on the line side by the system when the 11STAR1, 11STMM10, 11STGE12 is
inserted and provisioned.
The ENT-OTU2 command applies to the client side ports on the 11STAR1, 43STX4, 43STX4P,
43SCX4L, 43SCX4, 112SCX10 and 112SNX10 OT.
The ENT-OTU2 command applies to the client side ports on the 112SX10L OT.
The ENT-OTU2 command applies to the client side ports on 11QPA4 , 11QTA4 OT.
Executing an ENT-OTU2 command causes primary and secondary state transitions for the specified
OTM0.2 facility. Primary and secondary states associated with the OTM0.2 facility after the command
is executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OTM0.2 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
If no values are entered for PST,SST OTU2 enters IS-NR or IS-ANR.
When an OTU2 port is provisioned to an OOS-MA state, a MAN condition type is set for the specified
port. When an OTU2 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OTU2 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OTM0.2 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OTU2:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,OTURATE=][,FECTYPE=
][,EXP_SAPI=][,TX_SAPI=][,TRCCMP=][,TIMMRESP=][,LOSPROP=][,MODULETYP
E=][,CHANNELTX=][,CHANNELRX=][,STPID=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

1830PSS R3.6.50 - TL1 Commands and Messages 911


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU2
Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

11DPM12-<shelf>-<slot>-L1-2-OTU (OTU2 on 11DPM12


line ports)
Default: Entry Required
Addressing: None
Description: Access Identifier, specifies an access Identifier of an OT port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter

912 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU2 Issue 1, December 2011

pecifies how long an input signal must be present on the facility


without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

OTURATE= Value Description


{10.709, 11.049, 11.096}

Default: 10.709
Addressing: None
Description: OTU2 rate. Specifies the client OTM0.2 rate (standard 10.709,
overclocked 11.049Gb/s, overclocked 11.096Gb/s).
This parameter does not apply to the 43STX4 and 43STX4P AID.
OTURATE can be set with values 11.049 Gb/s or 11.096 Gb/s for
11DPE12 and 11DPE12E, 11DPM12 OT.
OTURATE can be set on the client side only when the 11QPA4
and 11QTA4 client signal is OTM0.2 (see ENT-OTU2). OTURATE
values supported on 11QPA4 are {10.709, 11.049, 11.096}.
OTURATE values supported on 11QTA4 are {10.709, 11.096}
The default shall be 10.709.
OTURATE can be set with values among {10.709, 11.049, 11.096}
for 11QPA4 line side working under CROSSREGEN mode.
OTURATE cannot be set in 11QTA4 line side.
This parameter does not apply to 11QPA4 and 11QTA4 line side
under ADD_DROP mode.
For the 43SCX4L or 43SCX4 OT, the following values are
supported for OTURATE: {10.709, 11.049, 11.096}

FECTYPE= Value Description


{NOFEC,RSFEC,EFEC,EFEC2}
{NOFEC,RSFEC,EFEC,EFEC2}

Default: RSFEC
Addressing: None
Description: Forward Error Correction mode (FEC Mode). This parameter
indicates the type of Forward Error Correction on a DWDM line
and client side port.

1830PSS R3.6.50 - TL1 Commands and Messages 913


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU2
NOFEC NO FEC (applies only to the 11STAR1 client AID ,
43SCX4, 43SCX4L, 43STX4 and 43STX4P client
AID, 112SCX10/112SX10L/112SNX10 client AID,
and 11QPA4 client AID, 11QTA4 client AID,
11STAR1A client AID)
EFEC Enhanced FEC (applies to the 11STAR1 and
11QPA4, 11QTA4, 11DPM12 line AID. EFEC also
applies to the 112SCX10/112SX10L/112SNX10
and 43SCX4/43SCX4L client AIDs.)
RSFEC Reed-Solomon FEC (applies only to the 11STAR1
client AID , 43STX4, 43STX4P, 43SCX4L and
43SCX4 client AID, 112SCX10, 112SX10L and
112SNX10 client AID, 11QPA4 client/line AID,
11QTA4 client/line AID,
11DPE12,11DPE12E,11DPM12 line side)
EFEC2 Enhanced FEC2 (applies to the 11QPA4 line AID,
11QTA4, 11DPE12, 11DPE12E, 11DPM12 line
AID.)
EFEC2 ALU Enhanced FEC (applies to the 112SCX10,
112SX10L, 43SCX4L and 43SCX4 client AID)

EXP_SAPI= Value Description


<0-15 characters>

Default: Null character (15 bytes each with hex value 00)
Addressing: None
Description: Optical channel expected Incoming TTI, Expected incoming
Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

TX_SAPI= Value Description


<0-15 characters>

Default: Null character (15 bytes each with hex value 00)
Addressing: None
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out

914 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU2 Issue 1, December 2011

to the right to 15 unprintable characters (e.g., whose hex


representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: Optical Channel Trace Comparison. This parameter enables and
disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: Optical Channel Path Trace Identifier Mismatch Response. This
parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when a far end failure gets
signalled

1830PSS R3.6.50 - TL1 Commands and Messages 915


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU2

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for the
11STAR1, 43STX4, 43SCX4L and
43SCX4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
112SCX10/112SNX10 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
112SX10L OT.
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
11QPA4 client ports
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C} for the 11QPA4
line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
11QTA4 client ports
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the 11DPE12
line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the
11DPE12E line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the 11DPM12
line side

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on the specified OTU2 port. If AUTO value
is chosen NE shall accept the pluggable module type inserted in
the socket if previous MODULETYPE value was <null> and
module type matches one on qualified list of modules.

916 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU2 Issue 1, December 2011

CHANNELTX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies; applies to certain Line
AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths,
applies to client AIDs. Also applies to
line AIDs on the 11QPA4 and 11QTA4.)
{850, 1310, 1550} (B&W wavelengths,
applies to client AIDs. Also applies to
line AIDs on the 11QPA4 and 11QTA4)

Default: NONE
Addressing: None
Description: Attribute that defines the transmit frequency of the transponder
optical interface.
This parameter shall also apply to the 11STAR1client port (CWDM
and B&W wavelengths only)
This parameter shall also apply to the 43STX4, 43STX4P,
43SCX4L and 43SCX4 OT client ports (CWDM and B&W
wavelengths only).
This parameter shall also apply to the 112SCX10/112SNX10 OT
client ports (CWDM and B&W wavelengths only)
This parameter shall also apply to the 112SX10L OT client ports
(CWDM and B&W wavelengths only).
This parameter shall also apply to the 11DPE12,11DPE12E client
ports (CWDM and B&W wavelengths only).
This parameter shall also apply to the 11QPA4 and 11QTA4
line/client ports.

1830PSS R3.6.50 - TL1 Commands and Messages 917


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU2

CHANNELRX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies; applies to certain Line
AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths,
applies to client AIDs. Also applies to
line AIDs on the 11QPA4 and 11QTA4.)
and 11QTA4{850, 1310, 1550} (B&W
wavelengths, applies to client AIDs.
Also applies to line AIDs on the
11QPA4)

Default: NONE
Addressing: None
Description: Attribute that defines the receive frequency of the transponder
optical interface.
This parameter shall apply to the 11STAR1client port when the
client port is an OTU2 (CWDM and B&W wavelengths only).
This parameter shall not apply to the 43STX4, 43STX4P,
43SCX4L and 43SCX4 OT client ports.
This parameter shall not apply to the 112SCX10/112SNX10 OT
client ports.
This parameter shall not apply to the 112SX10L OT client ports.
This parameter shall not apply to the 11DPE12,11DPE12E client
ports.
This parameter shall apply to the 11QPA4 line ports. It shall also
apply to the 11QPA4 client ports for OTU2 clients.
This parameter shall apply to the 11QTA4 line ports. It shall also
apply to the 11QTA4 client ports for OTU2 clients.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

918 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU2 Issue 1, December 2011

Default: STPID1
Addressing: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 919


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU2
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS,

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-OTU2


command for a client port on a 11STAR1 OT.
ENT-OTU2:NODE-1:11STAR1-5-C1:xyz123:::oturate=OTM10.709,fectype=RSFE
C,tx_sapi="ABCDEFGHIJKLMNO",exp_sapi="ABCDEFGHIJKLMNO",trccmp=ENABLE
D,timmresp=DISABLED:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU2
RST-OTU2
DLT-OTU2
ED-OTU2

920 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU2 Issue 1, December 2011

RMV-OTU2

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 921


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU2

922 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-OTU3


Command Name: ENT-OTU3 (CLIENT AID FOR 43STA1P)

PURPOSE
The ENT-OTU3 command creates (assigns and provisions) a specified OTM0.3 port.
The ENT-OTU3 command applies to the client side port on the 43STA1P OT .
The ENT-OTU3 command applies to the client side port on the 43STA1P, 43SCA1 OT .
Executing an ENT-OTU3 command causes primary and secondary state transitions for the specified
OTM0.3 facility. Primary and secondary states associated with the OTM0.3 facility after the command
is executed depend upon values entered for PST, SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when OTM0.3 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
If no values are entered for PST,SST OTU3 enters IS-NR or IS-ANR.
When an OTU3 port is provisioned to an OOS-MA state, a MAN condition type is set for the specified
port. When an OTU3 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no OTU3 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
OTM0.3 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-OTU3:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,LOSPROP=]:[PST][,SS
T];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 923


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU3
Description: Access Identifier, specifies an access Identifier of an OT port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when a far end failure gets
signalled

PST Value Description


{IS,OOS}

924 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-OTU3 Issue 1, December 2011

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:

1830PSS R3.6.50 - TL1 Commands and Messages 925


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-OTU3
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS,

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-OTU3


command for a client port on a 43STA1P OT.
ENT-OTU3:NODE-1:43STA1P-5-C1:xyz123:::timmresp=DISABLED:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU3
RST-OTU3
DLT-OTU3
ED-OTU3
RMV-OTU3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

926 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-RADIUS-SERVER


Command Name: ENTER RADIUS SERVER

PURPOSE

The ENT-RADIUS-SERVER command is used to configure the RADIUS server


attributes so that the client can communicate with a server for
authentication.
Access Level: admin

A server profile consists of:


• the RADIUS server identifier,

• the RADIUS server's status,

• the RADIUS server's IP address,

• the RADIUS server's specific port number,

• shared secret key between the NE and the RADIUS server.


The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-RADIUS-SERVER:[TID]::[CTAG]::SERVERNUM,STATUS:IPADDR=,[PORT=],SE
CRET=;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 927


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-RADIUS-SERVER
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SERVERNUM Value Description


RAD1
RAD2

Default: <Entry Required>


Addressing: None
Description: The following attributes are the valid server number to provision the
server:
RAD1: RAD1 is first server name.
RAD2: RAD2 is the second server name.

STATUS Value Description


ENABLE
DISABLE

Default: ENABLE
Addressing: None
Description: This parameter is RADIUS server status. The valid values are the
following:
ENABLE The RADIUS server is on-line. This is the default value.
DISABLE The RADIUS server is off-line

IPADDR= Value Description


{1-99,
101-126,128-223}-{0-255}-{0-255}-{1-25
4}

Default: <Entry Required>

Addressing: None
Description: This parameter is the IP address of the specified RADIUS server
(RAD1 or RAD2).

PORT= Value Description


{1-65000}

Default: 1812
Addressing: None

928 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-RADIUS-SERVER Issue 1, December 2011

Description: This parameter is the authentication port of the RADIUS server.


The valid value is from 1 to 65000. The default port value is 1812.

SECRET= Value Description


<5-32 VALID PID CHARACTERS>

Default: <Entry Required>


Addressing: None
Description: This is the shared secret key between the NE and the target
RADIUS server. This key shall be an ascii string between 5 to 32
characters. The secret key must be encrypted on the NE using
AES or 3DES.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input Data Not Valid

1830PSS R3.6.50 - TL1 Commands and Messages 929


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-RADIUS-SERVER
• the command is issued with duplicate IP address (same address for both RAD1 and RAD2)
creating a server that already exists and entering invalid serverID number

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

EXAMPLES
The following example illustrates the command and associated output for provisioning the attributes of
a RADIUS server number, IP address, secret key (zxcvbn).

ENT-RADIUS-SERVER::RAD1:132-117-112-192,,zxcvbn;

AM1520 03-07-08 10:22:51


M P08006 COMPLD
;

RELATED COMMANDS
DLT-RADIUS-SERVER
ED-RADIUS-SERVER
RTRV-RADIUS-SERVER

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

930 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-STM16


Command Name: ENT-STM16

PURPOSE
The ENT-STM16 command creates (assigns and provisions) a specified STM16 client signal facility.
Executing an ENT-STM16 command causes primary and secondary state transitions for the specified
STM16 facility. Primary and secondary states associated with the STM16 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then STM16 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when STM16 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an STM16 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM16 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM16 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM16 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-STM16:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,SDTH=][,SFTH=][,J0
_EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,MODULETYP
E=][,CHANNEL=],TS=[,CONTAINER=][,MAPPINGMODE=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16

1830PSS R3.6.50 - TL1 Commands and Messages 931


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM16
Default: Entry Required
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in 4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4 and 4DPA2.

932 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM16 Issue 1, December 2011

SFTH= Value Description


{10-3, 10-4, 10-5}

Default: 10-3
Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4 and 4DPA2.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0. Does not apply to 4DPA4 and 4DPA2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4 and 4DPA2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.

1830PSS R3.6.50 - TL1 Commands and Messages 933


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM16
Not currently provisionable on 4DPA4 and 4DPA2. Only 16-byte
format applies to 4DPA4 and 4DPA2.

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4 and 4DPA2.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4 and 4DPA2.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SS-16.1A,
SS-16.2C}

Default: AUTO
Addressing: None

934 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM16 Issue 1, December 2011

Description: Attribute defines pluggable module type to be used in providing


physical layer function on specified STM16 port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type that is not on the
ALU-qualified list, without generating an alarm, this attribute shall
be set to USER.
Note: SI-16.1 and SL-16.2 are not supported on 4DPA2
OT.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)
{L1,L2}-(1) (4DPA4 timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4 : Timeslot assignment on the specified Line port (L1 or
L2). Timeslot 1 represents the entire OTU1 capacity (all 16
timeslots).

CONTAINER= Value Description


{None, ODU1}

Default: None
Addressing: None
Description: Specifies the granularity for client OC48 mapping to ODU2
multiplexing structure.
Set to odu1-mapping into ODU1 per G.709.
This parameter only applies to 11DPM12.

1830PSS R3.6.50 - TL1 Commands and Messages 935


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM16

MAPPINGMODE= Value Description


{ASYNC, BITSYNC}

Default: None
Addressing: None
Description: Specifies the mapping mode for constant bit rate client signals into
OPUk.
ASNYC- asynchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation fuction.
BITSYNC-synchronous mapping CBR into ODUk information
structure by the ODUkP/CBRx adaptation function.
This parameter only applies to 11DPM12 pack when
CONTAINER=ODU1.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

936 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM16 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

• this command is issued with a TCA profile that does not exists,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-STM16


command.
ENT-STM16:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-3-1:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM16

1830PSS R3.6.50 - TL1 Commands and Messages 937


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM16
RST-STM16
DLT-STM16
ED-STM16
RMV-STM16

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

938 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-STM1


Command Name: ENT-STM1

PURPOSE
The ENT-STM1 command creates (assigns and provisions) a specified STM1 client signal facility.
Executing an ENT-STM1 command causes primary and secondary state transitions for the specified
STM1 facility. Primary and secondary states associated with the STM1 facility after the command is
executed depend upon values entered for PST , SST and events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then STM1 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when STM1 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an STM1 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM1 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM1 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM1 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-STM1:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,SDTH=][,SFTH=][,J0_
EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,MODULETYPE
=][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 939


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM1
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

940 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM1 Issue 1, December 2011

SFTH= Value Description


{10-3,10-4,10-5}

Default: 10-3
Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

1830PSS R3.6.50 - TL1 Commands and Messages 941


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM1

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisoned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SS-1.1, SL-1.1, SL-1.2,
SL-16.2C, SS-16.1A, SS-16.2C,
FE-BX40D, FE-BX40U}

Default: AUTO
Addressing: None

942 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM1 Issue 1, December 2011

Description: Attribute defines pluggable module


type to be used in providing physical layer function
on specified STM1 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.
Restriction: The module types SS-1.1 , SL-1.2 , FE-BX40D,
FE-BX40U are supported only by 4DPA4 Client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1490, 1530 ,1550} (B&W
wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.
Restriction: 1490 and 1530 B&W wavelengths can be used only for 4DPA4
client ports.

TS= Value Description


ODU1-L1-{1-4}-{1, 4, 7, 10, 13, 16, 19,
22, 25, 28, 31, 34, 37, 40, 43, 46}
(11STMM10 timeslots)
{L1,L2}-({1-16}) (4DPA4
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port (L1 or L2).

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 943


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM1
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

944 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM1 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

• this command is issued with a TCA profile that does not exists,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-STM1


command.
ENT-STM1:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-3-1:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM1

1830PSS R3.6.50 - TL1 Commands and Messages 945


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM1
RST-STM1
DLT-STM1
ED-STM1
RMV-STM1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

946 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-STM256


Command Name: ENT-STM256

PURPOSE
The ENT-STM256 command creates (assigns and provisions) a specified STM256 client signal
facility.
Executing an ENT-STM256 command causes primary and secondary state transitions for the specified
STM256 facility. Primary and secondary states associated with the STM256 facility after the command
is executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then STM256 enters OOS-MA or OOS-AUMA.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when STM256 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a STM256 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM256 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM256 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM256 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-STM256:[TID]:AID:[CTAG]:::[,DESCR=][,J0_EX=][,J0_FMT=][,TRCCMP=]
[,LOSPROP=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 947


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM256
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.

948 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM256 Issue 1, December 2011

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

1830PSS R3.6.50 - TL1 Commands and Messages 949


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM256
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

950 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM256 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a ENT-STM256


command.
ENT-STM256:NODE-1:43STA1P-1-5-C1:xyz123:::losprop=LASEROFF:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM256
RST-STM256
DLT-STM256
ED-STM256
RMV-STM256

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 951


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM256

952 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-STM4


Command Name: ENT-STM4

PURPOSE
The ENT-STM4 command creates (assigns and provisions) a specified STM4 client signal facility.
Executing an ENT-STM4 command causes primary and secondary state transitions for the specified
STM4 facility. Primary and secondary states associated with the STM4 facility after the command is
executed depend upon values entered for PST , SST and events detected by the system.
The state transitions are described in the IOM Appendix F.
If no values are entered for PST, SST then STM4 enters OOS-MA or OOS-AUMA.
If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when STM4 is free of failures,
it enters IS-NR or IS-ANR instead of OOS-AU,AINS.
When an STM4 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM4 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM4 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM4 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-STM4:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,SDTH=][,SFTH=][,J0_
EX=][,J0_TX=][,J0_FMT=][,TIMMRESP=][,TRCCMP=][,LOSPROP=][,MODULETYPE
=][,CHANNEL=],TS=[,CONTAINER=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 953


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM4
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.
Restriction: The facility can not be provisioned in
4DPA4 client port when the
CARDMODE=DUALTRAN.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None
Description: DESCR, Description string. Enclose the string in double quotes if
it contains non-alphanumeric characters.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect declaration.
Does not apply to 4DPA4.

954 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM4 Issue 1, December 2011

SFTH= Value Description


{10-3,10-4,10-5}

Default: 10-3
Addressing: None
Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Default: <null>
Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

1830PSS R3.6.50 - TL1 Commands and Messages 955


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM4

TIMMRESP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Identifier Mismatch Response. This parameter
determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON
Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SL-4.1, SL-4.2,
SL-16.2C, SS-4.1, SS-16.1A,
SS-16.2C, GE-BX20D, GE-BX20U,
GE-BX40D, GE-BX40U}

Default: AUTO
Addressing: None

956 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM4 Issue 1, December 2011

Description: Attribute defines pluggable module


type to be used in providing physical layer function
on specified STM1 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.
Restrictions: SL-4.2 is supported only on 4DPA4 OT.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1490,1530 ,1550 } (B&W
wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.
Restriction: 1490 and 1530 B&W wavelengths can be used only for 4DPA4
client ports.

TS= Value Description


ODU1-L1-{1-4}-{1, 13, 25, 37}
(11STMM10 timeslots)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)

Default: Entry required


Addressing: None
Description: Timeslot assignment. The entire string must be enclosed in
double-quotes.
11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
OC12/STM4 requires 4 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

CONTAINER= Value Description


{None, OPTSG, ODU0}

Default: None

1830PSS R3.6.50 - TL1 Commands and Messages 957


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM4
Addressing: None
Description: Specifies the granularity for client mapping to ODU2 multiplexing
structure.
Set to OPTSG-proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

958 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM4 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

• this command is issued with a TCA profile that does not exists,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

EXAMPLES

The following example shows the successful execution of a ENT-STM4


command.
ENT-STM4:NODE-1:11STMM10-1-5-C1:xyz123::::ODU1-L1-3-1:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM4

1830PSS R3.6.50 - TL1 Commands and Messages 959


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM4
RST-STM4
DLT-STM4
ED-STM4
RMV-STM4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

960 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-STM64


Command Name: ENT-STM64

PURPOSE
The ENT-STM64 command creates (assigns and provisions) a specified STM64 client signal facility.
Executing an ENT-STM64 command causes primary and secondary state transitions for the specified
STM64 facility. Primary and secondary states associated with the STM64 facility after the command is
executed depend upon values entered for PST , SST and the events detected by the system.
The state transitions are described in the IOM Appendix F.

If no values are entered for PST, SST then STM64 enters OOS-MA or OOS-AUMA.

If entered values for PST,SST are IS,AINS and AINSCNTDWN=00-00 when STM64 is free of
failures, it enters IS-NR or IS-ANR instead of OOS-AU,AINS.

When a STM64 is provisioned to an OOS-MA state, a MAN condition type is set for the specified port.
When an STM64 is in an OOS-MA, OOS-AUMA, or OOS-AU,AINS state, no STM64 transmission
condition types or performance monitoring threshold crossing alerts are autonomously reported for the
STM64 signal, but alarm conditions are monitored and performance monitoring data is collected (if
provisioned for PM collection) for the signal.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-STM64:[TID]:AID:[CTAG]:::[AINSTMR=][,DESCR=][,MAPPINGMODE=][,CHA
NNEL=][,SDTH=][,SFTH=][,J0_EX=][,J0_FMT=][,TRCCMP=][,LOSPROP=][,MODU
LETYPE=]:[PST][,SST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 961


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM64

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client
port only.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

AINSTMR= Value Description


{{00-96}-{00-59}}

Default: None
Addressing: None
Description: AINSTMR. Transition soak time out of AINS. Format is
HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01. Automatic In-Service Timer. This parameter
pecifies how long an input signal must be present on the facility
without a failure condition before the system transitions the facility
into the In-Service state. If not specified, the SYSTEM AINS Timer
is used.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Default: <NULL string>


Addressing: None

962 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM64 Issue 1, December 2011

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

MAPPINGMODE= Value Description


BITSYNC bit synchronous CBR mapping
ASYNC asynchronous CBR mapping

Default: BITSYNC
Addressing: None.
Description: Type of mapping of OC192/STM64 into an ODU2 structure.
The MAPPINGMODE parameter applies to the 43STX4,
43STX4P, 43SCX4L and 43SCX4 OTs.
The MAPPINGMODE parameter applies to the 112SCX10,
112SNX10, and 112SX10L OTs.
This parameter shall not apply to the 11QPA4 and 11QTA4 OTs.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Default: NONE
Addressing: None
Description: Specifies the channel frequency of the client port.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Default: 10-6
Addressing: None
Description: Attribute that specifies BER threshold for SD defect decalration.
The SDTH parameter is not supported on the 43STX4 and
43STX4P OTs.
The SDTH parameter is supported on the 43SCX4L OT and
43SCX4 OT.

SFTH= Value Description


{10-3, 10-4, 10-5}

Default: 10-3
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 963


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM64
Description: Attribute that specifies BER threshold for Excessive BER defect
decalration.
The SFTH parameter is not supported on the 43STX4 and
43STX4P OT.
The SFTH parameter is supported on the 43SCX4 OT.
43SCX4L-<shelf>-<slot>-C1-4 (43SCX4L Client Ports)

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Default: <null>
Addressing: None
Description: Expected J0.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Default: 16
Addressing: None
Description: J0 format.

TRCCMP= Value Description


{ENABLED,DISABLED}

Default: DISABLED
Addressing: None
Description: J0 Trace Compare. This parameter enables and disables the
comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Default: LASERON

964 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM64 Issue 1, December 2011

Addressing: None
Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11STAR1, 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
112SCX10, 112SNX10 and 112SX10L
OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QPA4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QTA4 OTs.

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module
type to be used in providing physical layer function
on specified STM64 port. If AUTO value is chosen NE
shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
If the user wants to use a pluggable module type that
is not on the ALU-qualified list, without generating
an alarm, this attribute shall be set to USER.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.

SST Value Description


AINS

Default: <Null>
Addressing: None
Description: Secondary State, specifies the secondary state to which the facility
is set.

1830PSS R3.6.50 - TL1 Commands and Messages 965


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM64
AINS Automatic In-Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with PST of OOS, SST of AINS

• this command is issued with a supporting pluggable module type not compatible with provisioned
service

IDNV Input, Data Not Valid


• this command is issued with AINSTMR specified with HH as 96 and MM is anything other than 00

SNVS Status, Not in Valid State


• the facility specified in the AID field is not in unassigned state, i.e. does not carry UAS secondary
state

966 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-STM64 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a ENT-STM64


command.
ENT-STM64:NODE-1:11STAR1-1-5-C1:xyz123:::losprop=LASEROFF:IS,AINS;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM64
RST-STM64
DLT-STM64
ED-STM64
RMV-STM64

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 967


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-STM64

968 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-TOPOLOGY-OCONN


Command Name: ENTER TOPOLOGY OPTICAL
CONNECTION

PURPOSE
The ENT-TOPOLOGY-OCONN command provisions the optical cable connections with the network
element.
This command allow the operator to enter a unidirectional or bidirectional optical connection.
Port Numbers

Because of how the internal data is stored, when remote ports are entered into the
REMOTEADDRESS parameter they must use the SNMP port number not port name. The following
tables define the internal port numbers for the cards in the system.
Port Number to Port Name Conversions for PSS-32 Shelf OT Cards
Port 11DP 11DP 11QP 11ST 11ST 4DPA 43ST 43ST 112S 112S 4DPA 11ST
Num GE12 E12, A4 GE12 MM1 4 A1P X4, CA1 CX10 2 AR1
ber 11DP 0 43ST 112S , 11ST
E12E X4P, A1L, 112S AR1A
, 43SC 112S X10L
11DP X4, NA1 ,
M12 43SC 112S
X4E, NX10
43SC
X4L
1 L1 L1 L1 L1 L1 L1 L1 L1 L1 L1 L1 L1
2 L2 L2 L2 C1 C1 L2 C1 C1 C1 C1 L2 C1
3 C1 C1 L3 C2 C2 C1 C2 C2 C2 C1
4 C2 C2 L4 C3 C3 C2 C3 C3 C3 C2
5 C3 C3 C1 C4 C4 C3 C4 C4 C4
6 C4 C4 C2 C5 C5 C4 C5
7 C5 C5 C3 C6 C6 VA1 C6
8 C6 C6 C4 C7 C7 VA2 C7
9 C7 C7 VA1 C8 C8 C8
10 C8 C8 VA2 C9 C9 C9
11 C9 C9 VA3 C10 C10 C10
12 C10 C10 VA4 C11
13 C11 C11 C12
14 C12 C12
15 VA1
16 VA2

Port Number to Port Name Conversions for non-OT Cards

1830PSS R3.6.50 - TL1 Commands and Messages 969


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-TOPOLOGY-OCONN

Port CWR8 CWR8- AHPLG, A2325A OSCT, OPSA ITLB SVAC DCM
Number 88 ALPHG, , ALPFG
AHPHG AM2325 T
, B
AM2017
B
1 SIG SIG SIG SIG SIG SIG SIG L1 DCM
2 THRU THRU INV INV INV A E C1
3 OMD OMD DCM DCM OSC B O
4 CLS1 CLS1 LINE LINE LINE
5 CLS2 CLS2 OSC OSC OSCSF
P
6 CLS3 CLS3
7 CLS4 CLS4
8 CLS5 CLS5
9 CLS6 CLS6
10 CLS7 CLS7
11 CLS8 CLS8
12 TEST TEST
13 INV INV

970 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-TOPOLOGY-OCONN Issue 1, December 2011

Port WR2-88 WR8-88 AM2125 AM2318 MESH4 RA2P ITLU MVAC


Number A A
AM2125
B
1 SIG SIG LINEIN LINEIN SIGIN LINEIN SIGIN G1
2 THRU THRU INV INV SIGOUT LINEOU EOUT G2
1 T
3 OMD DROPO DCM OSC SIGOUT OOUT G3
UT 2
4 INV ADDIN1 LINEOU LINEOU SIGOUT G4
T T 3
5 ADDIN2 OSCSFP OSCSFP SIGOUT G5
4
6 ADDIN3 DET DET G6
7 ADDIN4 OSC G7
8 ADDIN5 G8
9 ADDIN6
10 ADDIN7
11 ADDIN8
12 TEST
13 INV
14 MESHO
UT1
15 MESHO
UT2
16 MESHO
UT3

1830PSS R3.6.50 - TL1 Commands and Messages 971


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-TOPOLOGY-OCONN

Port SFD44 SFD44B SFD40 SFD40B SFD8A SFD8B SFD8C SFD8D


Number
1 9170 9175 9210 9215 OMD OMD OMD OMD
2 9180 9185 9220 9225 EXP EXP EXP EXP
3 9190 9195 9230 9235 9200 9300 9420 9520
4 9200 9205 9240 9245 9210 9310 9430 9530
5 9210 9215 9250 9255 9220 9320 9440 9540
6 9220 9225 9260 9265 9230 9330 9450 9550
7 9230 9235 9270 9275 9250 9350 9470 9570
8 9240 9245 9280 9285 9260 9360 9480 9580
9 9250 9255 9290 9295 9270 9370 9490 9590
10 9260 9265 9300 9305 9280 9380 9500 9600
11 9270 9275 9310 9315
12 9280 9285 9320 9325
13 9290 9295 9330 9335
14 9300 9305 9340 9345
15 9310 9315 9350 9355
16 9320 9325 9360 9365
17 9330 9335 9370 9375
18 9340 9345 9380 9385
19 9350 9355 9390 9395
20 9360 9365 9400 9405
21 9370 9375 9410 9415
22 9380 9385 9420 9425
23 9390 9395 9430 9435
24 9400 9405 9440 9445
25 9410 9415 9450 9455
26 9420 9425 9460 9465
27 9430 9435 9470 9475
28 9440 9445 9480 9485
29 9450 9455 9490 9495
30 9460 9465 9500 9505
31 9470 9475 9510 9515
32 9480 9485 9520 9525
33 9490 9495 9530 9535
34 9500 9505 9540 9545
35 9510 9515 9550 9555
36 9520 9525 9560 9565
37 9530 9535 9570 9575
38 9540 9545 9580 9585
39 9550 9555 9590 9595

972 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-TOPOLOGY-OCONN Issue 1, December 2011

Port SFD44 SFD44B SFD40 SFD40B SFD8A SFD8B SFD8C SFD8D


Number
40 9560 9565 9600 9605
41 9570 9575 OMD OMD
42 9580 9585
43 9590 9595
44 9600 9605
45 OMD OMD

Port SFD5A SFD5B SFD5C SFD5D SFD5E SFD5F SFD5G SFD5H


Number
1 OMD OMD OMD OMD OMD OMD OMD OMD
2 EXP EXP EXP EXP EXP EXP EXP EXP
3 9190 9240 9290 9340 9410 9460 9510 9560
4 9200 9250 9300 9350 9420 9470 9520 9570
5 9210 9260 9310 9360 9430 9480 9530 9580
6 9220 9270 9320 9370 9440 9490 9540 9590
7 9230 9280 9330 9380 9450 9500 9550 9600

Port SFC8 SFC4A SFC4B SFC2A SFC2B SFC2C SFC2D


Number
1 OMD OMD OMD OMD OMD OMD OMD
2 1471 EXP EXP EXP EXP EXP EXP
3 1491 1471 1551 1471 1511 1551 1591
4 1511 1491 1571 1491 1531 1571 1611
5 1531 1511 1591
6 1551 1531 1611
7 1571
8 1591
9 1611

Port SFC1A SFC1B SFC1C SFC1D SFC1E SFC1F SFC1G SFC1H


Number
1 OMD OMD OMD OMD OMD OMD OMD OMD
2 EXP EXP EXP EXP EXP EXP EXP EXP
3 1471 1491 1511 1531 1551 1571 1591 1611

1830PSS R3.6.50 - TL1 Commands and Messages 973


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-TOPOLOGY-OCONN
INPUT FORMAT

ENT-TOPOLOGY-OCONN:[TID]:FROM,TO:[CTAG]::[CCT]:[REMOTEADDRESS=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

974 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-TOPOLOGY-OCONN Issue 1, December 2011

FROM Value Description


EXTERNAL
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},VA{1- (11DPE12E Ports)
2},C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 975


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-TOPOLOGY-OCONN

FROM Value Description


LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-EXP (SFC2/4 Expansion Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 NE Boundary Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, 9180, 9170}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFD-<shelf>-<slot>-EXP (SFD5/8 Expansion Port)

976 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-TOPOLOGY-OCONN Issue 1, December 2011

FROM Value Description


OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier identifying the FROM connector to be defined.
AID can identify only one connector in case of unidirectional
connections or two connectors (IN, OUT) in case of bidirectional
connections.

1830PSS R3.6.50 - TL1 Commands and Messages 977


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-TOPOLOGY-OCONN

TO Value Description
EXTERNAL
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},VA{1- (11DPE12E Ports)
2},C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)

978 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-TOPOLOGY-OCONN Issue 1, December 2011

TO Value Description
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-EXP (SFC2/4 Expansion Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 NE Boundary Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, 9180, 9170}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFD-<shelf>-<slot>-EXP (SFD5/8 Expansion Port)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)

1830PSS R3.6.50 - TL1 Commands and Messages 979


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-TOPOLOGY-OCONN

TO Value Description
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier identifying the TO connector to be defined. AID
can identify only one connector in case of unidirectional
connections or two connectors (IN, OUT) in case of bidirectional
connections.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CCT Value Description


1WAY
2WAY

Default: 1WAY
Addressing: None
Description: Optical connection type.
1WAY Unidirectional optical connection
2WAY Bidirectional optical connection

REMOTEADDRES Value Description


S=
<64 character string> enclosed in
double quotes

Default: None
Addressing: None
Description: Remote network element address. The address of the adjacent
network element. The user must enter the IPaddress and
shelf/slot/portNumber of the far end connection. Can only be
entered when the TO or FROM value is EXTERNAL. See the Port
Number information at the beginning of this command and the
example at the end of the command. The entered string must be
enclosed in double quotes to include the space character. See the

980 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-TOPOLOGY-OCONN Issue 1, December 2011

example. Note - TL1 will not validate the format of the value of
REMOTEADDRESS (i.e. ipaddress followed by
shelf/slot/portNumber).

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• an invalid combination of parameters are entered,

IEAE Input, Entity Already Exists


• the addressed OCONN is already provisioned,

IENE Input, Entity does Not Exist


• the addressed equipment is not provisioned,

EXAMPLES
The following example shows the successful execution of an ENT-TOPOLOGY-OCONN command for
an internal connection.

1830PSS R3.6.50 - TL1 Commands and Messages 981


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-TOPOLOGY-OCONN

ENT-TOPOLOGY-OCONN:NODE-1:ALPHG-3-5-SIG,ALPHG-3-7-SIG:789012::2WAY;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* ENT-TOPOLOGY-OCONN */
;

The following example shows the successful execution of an ENT-TOPOLOGY-OCONN command for
an external connection to an LD card.

ENT-TOPOLOGY-OCONN:NODE-1:ALPHG-3-5-LINE,EXTERNAL:789012::2WAY:
REMOTEADDRESS="192.192.192.192 2/7/4";
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* ENT-TOPOLOGY-OCONN */
;

The following example shows the successful execution of an ENT-TOPOLOGY-OCONN command for
an external connection to an OT card.

ENT-TOPOLOGY-OCONN:NODE-1:11STAR1-1-11-C1,EXTERNAL:789012::2WAY:
REMOTEADDRESS="43.43.43.43 1/29/2";
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* ENT-TOPOLOGY-OCONN */
;

RELATED COMMANDS
DLT-TOPOLOGY-OCONN
RTRV-TOPOLOGY-OCONN

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

982 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-USER-SECU


Command Name: ENTER USER SECURITY

PURPOSE
The ENT-USER-SECU command is used to create a new user profile in the User Security Database.
A user profile consists of:
• the user identifier (UID),

• the user's password identification (PID),

• the user's command authorization privilege (UAP),

• the user's session link timeout during idle (TMOUT),

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

ENT-USER-SECU:[TID]:UID:[CTAG]::PID,,[UAP]:[TMOUT=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: Entry Required


Addressing: None
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

1830PSS R3.6.50 - TL1 Commands and Messages 983


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-USER-SECU

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

PID Value Description


<8-32 VALID PID CHARACTERS,
depending on minlength and maxlength
provisioned values>

Default: <Entry Required>


Addressing: None
Description: Password Identifier, specifies the user's login password.
Valid values for PID are a string of minlength through maxlength
case-sensitive alphanumeric characters, where minlength is 8 by
default and provisionable 8-32. The PID must contain at least
three of the following: at least one lowercase alphabetic character,
at least one uppercase alphabetic character, at least one numeric
character, at least one special character. The following special
characters shall be valid: % (percent sign), + (plus sign), # (pound
sign), _ (under score), ! (exclamation mark), @ (at sign), $ (dollar
sign), “ (double quotation mark), & (ampersand), ' (apostrophe), (
(left parenthesis), ) (right parenthesis), * (asterisk), and .
(period).The first character of the PID can be an alphabetic,
numeric, or a valid special character.

UAP Value Description


ADMINISTRATOR
PROVISIONER
OBSERVER

Default: OBSERVER
Addressing: None
Description: User access privilege(s) granted to this user. Values are:
ADMIN (Administrator): This is the administrator for the NE.
In addition to the “provisioner” privileges, this user
can create, delete and modify user accounts, and
access all security aspects of the system including
SW DNLD, File transfer, etc.)
PROVISIONER (Provisioner. This is a normal read/write
user. In addition to the “observer” privilege, this user
may perform provisioning of IO cards, ports,
circuits, and interfaces, and initiates test procedures

984 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-USER-SECU Issue 1, December 2011

which are not generally service affecting (e.g. no


COLD boot which would affect management traffic),
and retrieves information about the system.)
OBSERVER (Read-only. User may retrieve most, but not
all, information about the system)

TMOUT= Value Description


{0-999}

Default: 0
Addressing: None
Description: User Session Activity Link TimeOut, specifies the amount of time
(in minutes) that the User Session link is inactive with regards to
user TL1 input before a user session link time-out occurs. After the
timeout value is reached, the user will be automatically logged off.
0 System-level timeout value is used for this user.
See SET-ATTR-SECUDFLT.
1-999 Time in minutes, indicates the TMOUT time interval.
A user session link time-out occurs if the user
session link is inactive with regards to user TL1
input for the time, in minutes, indicated.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 985


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-USER-SECU
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• the command is issued by a non-privilege user

PIUI Privilege, Illegal User Identity, invalid UID


• the UID is invalid (ie., illegal UID, UID already exists)

• the specified password identifier (PID value) is the same as the specified user identifier (UID
value)

• the specified password is invalid because it is illegal (ie, syntax, format)

RRNG Resource: Requested Changes Exceeds Range


• the User Security Database already contains 255 UIDs

EXAMPLES
The following example illustrates the command and associated output for creating a new user profile in
the user security database with a PID of user_8Pw, UID of user8, and a UAP of PROVISIONER.

ENT-USER-SECU::user8:::********,,PROVISIONER;

AM1520 03-07-08 10:22:51


M P08006 COMPLD
;

RELATED COMMANDS
DLT-USER-SECU
ED-USER-SECU
RTRV-USER-SECU

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

986 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: ENT-VTS


Command Name: ENT-VTS

PURPOSE
The ENT-VTS command creates (assigns and provisions) the vlan ID map for a virtual time slot in
Ethernet port.

INPUT FORMAT

ENT-VTS:[TID]:AID:[CTAG]:::[DIR]:[VTS]:[CMODE=][,MAPID=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT port only.
The port VTS AID only applies to the pack working under qinq
mode
11DPE12-<shelf>-<slot>-C{1-12}- (11DPE12 Client Ports) only apply to subrate
mode and 11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 987


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-VTS
only apply to fullrate mode and subrate mode .

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

DIR Value Description


{INGRESS, EGRESS, 2WAY}

Default: 2WAY
Addressing: None
Description: Specifies the direction to the configuration.
For 11DPE12 pack in subrate mode this parameter is optional and
should be 2WAY only; in qinq mode the parameter is mandatory
and can be ingress, egress.
For 11DPE12E pack in qinq mode this parameter is mandatory
and can be ingress or egress.

VTS Value Description


VTS{1-32}

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot in the
port.
this parameter is only for 11DPE12 fullrate modea and subrate
mdoe , the client VTS range is 1-10 , the line port VTS range is
1-32 .

CMODE= Value Description


{CEVLANTag, SVLANTag,Untagged,
Port}

Default: Null
Addressing: None
Description: The parameter is mandatory parameter used to differ classification
mode in qinq mode for 11DPE12E pack.
This parameter only apply to 11DPE12E under QinQ mode.

988 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-VTS Issue 1, December 2011

When the CMODE is set to PORT, it means that all the


packets coming to the port will be treated as a VTS
and MAPID must be provisioned as ALL;
When the CMODE is set to SVLAN tagged, SVLAN ID can be
set.
When the CMODE is set to CEVLAN tagged, CEVLAN ID can
be provisioned.
When the CMODE is set to untagged , CEVLAN ID can be
provisioned.
For 11DPE12E line port VTS,only SVLANTag could be provioned.
CEVLANTag and Port can not be set to 11DPE12E's line port
VTS.
For 11DPE12E line port VTS,CEVLANTag , SVLANTag ,
Untagged could be provioned. Port can not be set to 11DPE12E's
line port VTS.

MAPID= Value Description


A number or a range number among
1-4095, ALL, Null

Default: <NULL string>


Addressing: None
Description: The value is set for VTS/VLANID mapping for 11DPE12 and VTS
entity for 11DPE12/11DPE12E.
ALL means all the tagged, priorty tagged and un-tagged packets
are mapped into the line VTS.
Null is used to indicate that no traffic flow is mapped into the VTS.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 989


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-VTS
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• the command is input for an 11DPE12 pack that is working under fullrate

• the command is input for an 11DPE12 pack that the VLAN ID is out of the speicified range under
subrate or qinq mode

• the command is input for an 11DPE12 line port AID under subrate working mode

• the command is input with CMODE parameter for 11DPE12 pack in subrate mode

• the command is input with CMODE=PORT for any VTS of 11DPE12E client port which has
provision PVID other than Null

• the command is input with CMODE other than SVLANTag for any VTS of 11DPE12E line port

• the command is input with CMODE=PORT for 11DPE12E line port

• the command is input with CMODE parameter “port” for 11DPE12E when there is a VTS
configured with CMODE VALUE

• the command is input with the ingres(egress) VTS SVLAN ID which is not same as the existing
egress(ingress)VTS SVLNA ID for 11DPE12E when the FlowCM is set to CCM

SABT Status, Aborted


• the command is input with cmode parameter for 11DPE12E when there is a VTS configured with
cmode “port”

• the the command is input with cmode “untagged” for 11dpe12e when there is a VTS configured
with cmode “untagged”

990 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
ENT-VTS Issue 1, December 2011

EXAMPLES

In the following example, the vlanid 300-400,500 is assigned for a


11DPE12 client port 1, virtual time slot1:
ENT-VTS:NODE-1:11DPE12-1-7-C1:xyz123:::VTS1 :MAPID="300-400,500";
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

In the following example, the cmdoe svlantagged with svlanid 4095 is


assigned for a 11DPE12E qinq mode line port 1, virtual time slot100:
ENT-VTS:NODE-1:11DPE12E-1-8-L1:xyz123:::VTS100:CMODE=SVLANTag,MAPID=
4095;

RELATED COMMANDS
RTRV-VTS
DLT-VTS
ED-VTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 991


8DG61100 EAAAQZZA
Issue 1, December 2011 ENT-VTS

992 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INH-MSG-ALL


Command Name: INHIBIT MESSAGE ALL

PURPOSE

INPUT FORMAT

INH-MSG-ALL:[TID]:[AID]:[CTAG]::[NTFCNCDE];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 993


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-MSG-ALL

NTFCNCDE Value Description


CR
MJ
MN
WR
NA

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Minor alarm
NA Not Alarmed

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

994 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INH-MSG-ALL Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, the autonomous messages for the entered notification code are allowed:

INH-MSG-ALL::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 ALLPLD
/* INH-MSG-ALL::ALL:::MJ [P15119] (1) */
;

RELATED COMMANDS
ALW-MSG-ALL

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 995


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-MSG-ALL

996 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INH-MSG-RR


Command Name: INHIBIT MESSAGE

PURPOSE
OPTSG
ODU0
ODUF
ODU1
ODU2

INPUT FORMAT

INH-MSG-rr:[TID]:[AID]:[CTAG]::[NTFCNCDE];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 997


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-MSG-RR

NTFCNCDE Value Description


CR
MJ
MN
WR
NA

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

998 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INH-MSG-RR Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, the autonomous messages for the entered notification code are allowed:

INH-MSG-CBR2G5::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* INH-MSG-CBR2G5::ALL:::MJ [P15119] (1) */
;

INH-MSG-EQPT::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* INH-MSG-EQPT::ALL:::MJ [P15119] (1) */
;

In the following example, the autonomous messages for the entered notification code are allowed:

INH-MSG-OCH::ALL:::MJ;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
/* INH-MSG-OCH::ALL:::MJ [P15119] (1) */
;

RELATED COMMANDS
ALW-MSG-rr
ALW-MSG-ALL

1830PSS R3.6.50 - TL1 Commands and Messages 999


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-MSG-RR
RELATED AUTONOMOUS RESPONSES
None.

1000 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INH-SWTOPROTN-EQPT


Command Name: INHIBIT SWITCH TO PROTECTION
(LOCKOUT OF PROTECTION)

PURPOSE
The INH-SWTOPROTN-EQPT command performs a switch to working, and inhibits all automatic and
user-initiated switching to the protection side. This is referred to as lockout of protection. Use the
ALW-SWTOPROTN-EQPT command to release the lockout.
The command will be denied if operation on the relevant circuit pack is not possible, whether due to
pack removed, communication failure, or any other reason.
The command will be denied if a lockout of protection already exists.
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

INH-SWTOPROTN-EQPT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1001


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-SWTOPROTN-EQPT

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: Entry required


Addressing: None
Description: For Y-cable and OPS: the protection port AID. For E-SNCP: the
client port.
Restriction: 4DPA4 OT supports protection only in FlexMux mode.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

1002 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INH-SWTOPROTN-EQPT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IENE Input, Entity does Not Exist
• the specified protection group does not exist

IPNV Input, Parameter Not Valid


• for a Y-cable or OPS protection group the input AID does not refer to the protection port

SSRD Status, Switch Request Denied


• a lockout of protection already exists

• operation on the relevant circuit pack is not possible, whether due to pack removed,
communication failure, or any other reason

EXAMPLES
The following command performs a lockout of protection on a Y-cable protection group.

1830PSS R3.6.50 - TL1 Commands and Messages 1003


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-SWTOPROTN-EQPT

INH-SWTOPROTN-EQPT:ALU-1830PSS:11STAR1-5-3-C1;

RELATED COMMANDS
ALW-SWTOPROTN-EQPT
ALW-SWTOWKG-EQPT
RTRV-PROTNSW-EQPT
SW-TOPROTN-EQPT
SW-TOWKG-EQPT

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1004 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INH-USER-SECU


Command Name: INHIBIT USER SECURITY

PURPOSE
The INH-USER-SECU command is used by a user with security administrator privileges to inhibit (i.e.,
disable) an existing target user (without deleting the user account), so the user will no longer be
authenticated to establish a session with the system (i.e., the inhibited users cannot log on). A disabled
user can be re-instated via the ALW-USER-SECU command.
When the INH-USER-SECU command is issued against a logged on user, it shall log off the target
user and inhibit him/her, unless the logged on user is a security administrator(UID=admin): in that case
the command shall be denied. If there are multiple logins using the same UID of the target user (and
the target user is not admin), then all sessions will be immediately terminated.
The INH-USER-SECU command shall be denied when issued against the user that is issuing the
command itself, that is, no auto inhibition is allowed. This also prevents the inhibition of the last
remaining administrative user.

INPUT FORMAT

INH-USER-SECU:[TID]::[CTAG]::UID;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

UID Value Description


<5-12 VALID UID CHARACTERS>

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 1005


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-USER-SECU
Addressing: &-grouping
Description: User Identifier, specifies a unique user ID.
Valid values for UID are 5 to 12, case-sensitive alphanumeric
characters where the first character must always be an alphabetic
character. The following special characters are also accepted as
valid characters and will be part of the UID: % (percent sign), +
(plus sign), # (pound sign), and _ (under score).

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• the command is issued by a non-privilege user

PIUI Privilege, Illegal User Identity, invalid UID


• the UID is invalid (ie., illegal UID, UID does not exist)

1006 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INH-USER-SECU Issue 1, December 2011

• the User is the administrator user issuing the command, or if the target UID is admin

EXAMPLES
The following example illustrates the inhibition of the user "userX".

INH-USER-SECU:::::userX;

AM1520 03-07-08 12:32:47


M CTAG COMPLD
;

RELATED COMMANDS
ALW-USER-SECU

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 1007


8DG61100 EAAAQZZA
Issue 1, December 2011 INH-USER-SECU

1008 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-100GBE


Command Name: INITIALIZE REGISTER 100GBE

PURPOSE
The INIT-REG-100GBE command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified 100GBE port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-100GBE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN]
,[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1009


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-100GBE
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1010 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-100GBE Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-100GBE)

EXAMPLES

INIT-REG-100GBE::112SCA1-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1011


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-100GBE
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1012 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-10GBE


Command Name: INITIALIZE REGISTER 10GBE

PURPOSE
The INIT-REG-GBE10 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified 10GBE port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-10GBE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
ALL

1830PSS R3.6.50 - TL1 Commands and Messages 1013


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-10GBE
Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None

1014 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-10GBE Issue 1, December 2011

Description: Direction, specifies the direction of the signal being monitored.


The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 1015


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-10GBE
• the facility is not provisioned (using ENT-10GBE)

EXAMPLES

INIT-REG-10GBE::11STAR1-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1016 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-1GBE


Command Name: INITIALIZE REGISTER GBE

PURPOSE
The INIT-REG-GBE command initializes the current 15-Minute or current 1-Day (specified by TMPER)
digital PM collection registers for the near-end side pertaining to the specified 1GBE port to the value
zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-1GBE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1017


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-1GBE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1018 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-1GBE Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-1GBE)

1830PSS R3.6.50 - TL1 Commands and Messages 1019


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-1GBE
EXAMPLES
In the following example, the near-end 1-day registers for 1GBE port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-1GBE::11STMM10-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1020 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-CBR2G5


Command Name: INITIALIZE REGISTER CBR2G5

PURPOSE
The INIT-REG-CBR2G5 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified CBR2G5 port
to the value zero.
Note that CBR2G5 refers to transparent transport and non-intrusive monitoring of OC48/STM16
strucutres. In that respect this comand will behave in the same way as INIT-REG-OC48 when system
standard parameter is set to SONET and INIT-REG-STM16 when system standard parameter set to
SDH.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-CBR2G5:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN]
,[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1021


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-CBR2G5
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1022 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-CBR2G5 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-CBR2G5)

1830PSS R3.6.50 - TL1 Commands and Messages 1023


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-CBR2G5
EXAMPLES
In the following example, the near-end 1-day registers for CBR2G5 port 11STMM10-1-6-C1 are
initialized to 0 and analog parameters set to baselined or last measured.

INIT-REG-CBR2G5::11STMM10-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS
RTRV-PM-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1024 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-CBRAR


Command Name: INITIALIZE REGISTER CBRAR

PURPOSE
The INIT-REG-CBRAR command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified CBRAR port
(i.e., port with DATATYPE=FE or DATATYPE=HDSDI or DATATYPE=SDSDI or DATATYPE=3GSDI)
to the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-CBRAR:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER]:DATATYPE;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1025


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-CBRAR
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN

1026 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-CBRAR Issue 1, December 2011

Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

DATATYPE Value Description


{FE, HDSDI,SDSDI,3GSDI}

Default: Mandatory parameter


Addressing: None
Description: Client Data type, identifies the client data type as either Fast
Ethernet (FE) or HDSDI, and whose PM data register is being
initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 1027


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-CBRAR
• the facility is not provisioned (using ENT-CBRAR)

EXAMPLES
In the following example, the near-end 1-day registers for the CBRAR port (DATATYPE=FE)
4DPA4-1-6-C1 are initialized to 0 and analog parameters set to baselined or last measured.

INIT-REG-CBRAR::4DPA4-1-6-C1::FE,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1028 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-EQPT


Command Name: INITIALIZE REGISTER EQUIPMENT

PURPOSE
The INIT-REG-EQPT command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified card.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-EQPT:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


EC-<shelf>-<slot> (Shelf Controller)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1029


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-EQPT

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


NA

Default: NA
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit).

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

1030 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-EQPT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the user enters an invalid MONVAL

• the user enters an invalid time period

SNVS Status, Not in Valid State


• the equipment is not provisioned

EXAMPLES
In the following example, the near-end 1-day registers for EC-1-1 are initialized to 0.

INIT-REG-EQPT::EC-1-1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1031


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-EQPT
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1032 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-FC100


Command Name: INITIALIZE REGISTER FC100

PURPOSE
The INIT-REG-FC100 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified FC100 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-FC100:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1033


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC100
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1034 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-FC100 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-FC100)

EXAMPLES
In the following example, the near-end 1-day registers for FC100 port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-FC100::11STMM10-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1035


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC100
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1036 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-FC1200


Command Name: INITIALIZE REGISTER FC1200

PURPOSE
The INIT-REG-FC1200 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified FC1200 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-FC1200:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN]
,[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1037


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC1200
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1038 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-FC1200 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-FC1200)

1830PSS R3.6.50 - TL1 Commands and Messages 1039


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC1200
EXAMPLES
In the following example, the near-end 1-day registers for FC1200 port 11STAR1-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-FC1200::11STAR1-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1040 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-FC200


Command Name: INITIALIZE REGISTER FC200

PURPOSE
The INIT-REG-FC200 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified FC200 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-FC200:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1041


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC200
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1042 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-FC200 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-FC200)

EXAMPLES
In the following example, the near-end 1-day registers for FC200 port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-FC200::11STMM10-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1043


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC200
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1044 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-FC400


Command Name: INITIALIZE REGISTER FC400

PURPOSE
The INIT-REG-FC400 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified FC400 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-FC400:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1045


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC400
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1046 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-FC400 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-FC400)

EXAMPLES
In the following example, the near-end 1-day registers for FC400 port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-FC400::11STMM10-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1047


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC400
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1048 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-FC800


Command Name: INITIALIZE REGISTER FC800

PURPOSE
The INIT-REG-FC800 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified FC800 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-FC800:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1049


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC800

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1050 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-FC800 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-FC800)

1830PSS R3.6.50 - TL1 Commands and Messages 1051


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FC800
EXAMPLES
In the following example, the near-end 1-day registers for FC800 port 112SCX10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-FC800::112SCX10-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1052 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-FE


Command Name: INITIALIZE REGISTER FE

PURPOSE
The INIT-REG-FE command initializes the current 15-Minute or current 1-Day (specified by TMPER)
digital PM collection registers for the near-end side pertaining to the specified FE port to the value zero.

For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this
command will reset their values to last measured value.
NOTE : for the electrical SFP, the OPR and OPT PM parameters are not
supported.

The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-FE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[TM
PER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
ALL

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1053


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FE
Description: Access Identifier, identifies the
entity access identifier.
NOTE:for the 11DPE12,only optical FE SFP is supported
(but the OPR/OPT is not supported as the SFP
limitation).
for the 11DPE12E, the optical FE SFP and electrical FE
SFP are supported ,and for the electrical FE , the
OPR/OPT is not supported .

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

1054 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-FE Issue 1, December 2011

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1055


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-FE
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-FE)

EXAMPLES
In the following example, the near-end 1-day registers for FE port 11DPE12E-1-6-C1 are initialized to 0
and analog parameters set to baselined or last measured.

INIT-REG-FE::11DPE12-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1056 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OC12


Command Name: INITIALIZE REGISTER OC12

PURPOSE
The INIT-REG-OC12 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OC12 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OC12:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1057


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC12
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1058 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OC12 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OC12)

EXAMPLES
In the following example, the near-end 1-day registers for OC12 port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-OC12::11STMM10-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1059


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC12
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1060 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OC192


Command Name: INITIALIZE REGISTER OC192

PURPOSE
The INIT-REG-OC192 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OC192 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OC192:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
ALL

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1061


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC192
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1062 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OC192 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OC192)

1830PSS R3.6.50 - TL1 Commands and Messages 1063


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC192
EXAMPLES
In the following example, the near-end 1-day registers for OC192 port 11STAR1-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-OC192::11STAR1-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1064 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OC3


Command Name: INITIALIZE REGISTER OC3

PURPOSE
The INIT-REG-OC3 command initializes the current 15-Minute or current 1-Day (specified by TMPER)
digital PM collection registers for the near-end side pertaining to the specified OC3 port to the value
zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OC3:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[T
MPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1065


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC3
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1066 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OC3 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OC3)

EXAMPLES
In the following example, the near-end 1-day registers for OC3 port 11STMM10-1-6-C are initialized to
0 and analog parameters set to baselined or last measured.

INIT-REG-OC3::11STMM10-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1067


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC3
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1068 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OC48


Command Name: INITIALIZE REGISTER OC48

PURPOSE
The INIT-REG-OC48 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OC48 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OC48:[TID]:AID:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[TM
PER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: Entry required


Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1069


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC48

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1070 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OC48 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OC48)

1830PSS R3.6.50 - TL1 Commands and Messages 1071


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC48
EXAMPLES
In the following example, the near-end 1-day registers for OC48 port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-OC48::11STMM10-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1072 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OC768


Command Name: INITIALIZE REGISTER OC768

PURPOSE
The INIT-REG-OC768 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OC768 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OC768:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1073


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC768
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN

1074 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OC768 Issue 1, December 2011

Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OC768)

EXAMPLES
In the following example, the near-end 1-day registers for OC768 port 11STAR1-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-OC768::43STA1P-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1075


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OC768
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1076 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OCH


Command Name: INITIALIZE REGISTER OPTICAL
CHANNEL

PURPOSE
For supported analog parameters (OPOCHIN-L, OPOCHIN-H, OPOCHIN-AVG, OPOCHOUT-L,
OPOCHOUT-H, OPOCHOUT-AVG, OPR-L, OPR-H, OPR-AVG, OPT-L, OPT-H and OPT-AVG) this
command will reset their values to the last measured value.
For SVAC module only OPR monitored types apply to client port while only OPT monitored types apply
to line port.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OCH:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[T
MPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1077


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OCH

AID Value Description


AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

1078 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OCH Issue 1, December 2011

AID Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2325B-<shelf>-<slot>-LINE-{9605, (AM2325B LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot>-LINE-{9605, (AM2017B LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,

1830PSS R3.6.50 - TL1 Commands and Messages 1079


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OCH

AID Value Description


9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1080 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OCH Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1830PSS R3.6.50 - TL1 Commands and Messages 1081


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OCH

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the
15-minute or 1-day (24 hour) PM collection register
or both 15-minute/1-day PM collection registers are
to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (Photonic crossconnect on that OCH hasn't been provisioned)

1082 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OCH Issue 1, December 2011

EXAMPLES
In the following example, the near-end 1-day registers for OCH port ALPHG-5-6-9580 are initialized to
their baselined values.

INIT-REG-OCH:: ALPGH-5-6-LINE-9580:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 1083


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OCH

1084 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-ODU1


Command Name: INITIALIZE REGISTER ODU1

PURPOSE
The INIT-REG-ODU1 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified ODU1 port to
the value zero.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-ODU1:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1085


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU1
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{RCV }

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive)

TMPER Value Description


15-MIN
1-DAY
BOTH

1086 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-ODU1 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register is to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (ENT-OTU1 implicitly creates an ODU1 entity)

EXAMPLES
In the following example, the near-end 1-day registers for ODU1 port 4DPA4-1-6-L1 are initialized to 0.

INIT-REG-ODU1::4DPA4-1-6-L1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1087


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU1
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1088 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-ODU2


Command Name: INITIALIZE REGISTER ODU2

PURPOSE
The INIT-REG-ODU2 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified ODU2 port to
the value zero.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-ODU2:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1089


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU2

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

1090 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-ODU2 Issue 1, December 2011

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{RCV }

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive)

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

1830PSS R3.6.50 - TL1 Commands and Messages 1091


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU2
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (ENT-OTU2 implicitly creates an ODU2 entity)

EXAMPLES
In the following example, the near-end 1-day registers for ODU2 port 11STAR1-1-6-L1 are initialized to
0.

INIT-REG-ODU2::11STAR1-1-6-L1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1092 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-ODU3


Command Name: INITIALIZE REGISTER ODU3

PURPOSE
The INIT-REG-ODU3 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified ODU3 port to
the value zero.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-ODU3:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1093


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU3

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{RCV }

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive)

1094 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-ODU3 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
1-DAY

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (ENT-OTU3 implicitly creates an ODU3 entity)

1830PSS R3.6.50 - TL1 Commands and Messages 1095


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU3
EXAMPLES
In the following example, the near-end 1-day registers for the ODU3 port 43STX4-1-6-L1 are initialized
to 0.

INIT-REG-ODU3::43STX4-1-6-L1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1096 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-ODU4


Command Name: INITIALIZE REGISTER ODU4

PURPOSE
The INIT-REG-ODU4 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified ODU4 port to
the value zero.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-ODU4:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1097


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU4
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{RCV }

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive)

1098 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-ODU4 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
1-DAY

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (ENT-OTU4 implicitly creates an ODU4 entity)

1830PSS R3.6.50 - TL1 Commands and Messages 1099


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-ODU4
EXAMPLES
In the following example, the near-end 1-day registers for the ODU4 port 112SCX10-1-6-L1 are
initialized to 0.

INIT-REG-ODU4::112SCX10-1-6-L1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1100 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OSC


Command Name: INITIALIZE REGISTER OPTICAL
SUPERVISORY CHANNEL

PURPOSE
The INIT-REG-OSC command initializes the current 15-Minute or current 1-Day (specified by TMPER)
digital PM collection registers for the near-end side pertaining to the specified OSC port to the value
zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.

INPUT FORMAT

INIT-REG-OSC:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[T
MPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
ALL

Default: ALL

1830PSS R3.6.50 - TL1 Commands and Messages 1101


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OSC
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None

1102 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OSC Issue 1, December 2011

Description: Direction, specifies the direction of the signal being monitored.


The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 1103


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OSC
• the facility is not provisioned (using ENT-OTS OSC entity gets implicitly provisioned)

EXAMPLES
In the following example, the near-end 1-day registers for OSC port AHPHG-5-5-OSC are initialized to
0 and analog parameters set to baselined or last measured.

INIT-REG-OSC:: ALPHG-5-5-OSC:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1104 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OTS


Command Name: INITIALIZE REGISTER OPTICAL
TRANSPORT SECTION

PURPOSE
For supported analog parameters (OPINL, OPINH, OPOUTL & OPOUTH) this command will reset
their values to last measured value.

INPUT FORMAT

INIT-REG-OTS:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[T
MPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


AHPHG-<shelf>-<slot>-LINE (AHPHG LINE Port)
ALPHG-<shelf>-<slot>-LINE (ALPHG LINE Port)
AHPLG-<shelf>-<slot>-LINE (AHPLG LINE Port)
ALPFGT-<shelf>-<slot>-LINE (ALPFGT LINE Port)
OSCT-<shelf>-<slot>-LINE (OSCT LINE Port)
A2325A-<shelf>-<slot>-LINE (A2325A LINE Port)
AM2325B-<shelf>-<slot>-LINE (AM2325B LINE Port)
AM2017B-<shelf>-<slot>-LINE (AM2017B LINE Port)
AM2125A-<shelf>-<slot>-LINEIN (AM2125A LINEIN Port)
AM2125B-<shelf>-<slot>-LINEIN (AM2125B LINEIN Port)
AM2318A-<shelf>-<slot>-LINEIN (AM2318A LINEIN Port)
RA2P-<shelf>-<slot>-LINEIN (RA2P LINEIN Port)
ALL

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1105


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTS
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None

1106 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OTS Issue 1, December 2011

Description: Direction, specifies the direction of the signal being monitored.


The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 1107


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTS
• the facility is not provisioned (using ENT-OTS)

EXAMPLES
In the following example, the near-end 1-day registers for OTS port AHPHG-5-5-LINE are initialized to
their baselined values.

INIT-REG-OTS:: AHPHG-5-5-LINE:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1108 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OTU1


Command Name: INITIALIZE REGISTER OTU1

PURPOSE
The INIT-REG-OTU1 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OTU1 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OTU1:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1109


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU1
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1110 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OTU1 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OTU1)

1830PSS R3.6.50 - TL1 Commands and Messages 1111


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU1
EXAMPLES
In the following example, the near-end 1-day registers for OTU1 port 4DPA4-1-6-L1 are initialized to 0
and analog parameters set to baselined or last measured value,

INIT-REG-OTU1::4DPA4-1-6-L1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1112 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OTU2


Command Name: INITIALIZE REGISTER OTU2

PURPOSE
The INIT-REG-OTU2 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OTU2 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OTU2:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1113


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU2

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

1114 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OTU2 Issue 1, December 2011

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

1830PSS R3.6.50 - TL1 Commands and Messages 1115


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU2
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OTU2)

EXAMPLES
In the following example, the near-end 1-day registers for OTU2 port 11STAR1-1-6-L1 are initialized to
0 and analog parameters set to baselined or last measured value,

INIT-REG-OTU2::11STAR1-1-6-L1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1116 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OTU3


Command Name: INITIALIZE REGISTER OTU3

PURPOSE
The INIT-REG-OTU3 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OTU3 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OTU3:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
ALL
43STX4-{1-16}-{2-17}-C{1-4} (43STX4 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1117


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU3

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{RCV,TRMT,ALL}
{ALL}

Default: ALL
Addressing: None

1118 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OTU3 Issue 1, December 2011

Description: Direction, specifies the direction of the signal being monitored.


The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State

1830PSS R3.6.50 - TL1 Commands and Messages 1119


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU3
• the facility is not provisioned (using ENT-OTU3)

EXAMPLES
In the following example, the near-end 1-day registers for OTU3 port 43STX4-1-6-L1 are initialized to 0
and analog parameters set to baselined or last measured value,

INIT-REG-OTU3::43STX4-1-6-L1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1120 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-OTU4


Command Name: INITIALIZE REGISTER OTU4

PURPOSE
The INIT-REG-OTU4 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified OTU4 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-OTU4:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1121


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU4

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.
Only all near-end and/or far-end parameters of the current 15
minutes or 1 day register can be initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1122 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-OTU4 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-OTU4)

1830PSS R3.6.50 - TL1 Commands and Messages 1123


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-OTU4
EXAMPLES
In the following example, the near-end 1-day registers for OTU4 port 112SCX10-1-6-L1 are initialized
to 0 and analog parameters set to baselined or last measured value,

INIT-REG-OTU4::112SCX10-1-6-L1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1124 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-STM16


Command Name: INITIALIZE REGISTER STM16

PURPOSE
The INIT-REG-STM16 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified STM16 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-STM16:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1125


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM16

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1126 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-STM16 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-STM16)

1830PSS R3.6.50 - TL1 Commands and Messages 1127


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM16
EXAMPLES
In the following example, the near-end 1-day registers for STM16 port 11STMM10-1-6-C1are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-STM16::11STMM10-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1128 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-STM1


Command Name: INITIALIZE REGISTER STM1

PURPOSE
The INIT-REG-STM1 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified STM1 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-STM1:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1129


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM1
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1130 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-STM1 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-STM1)

EXAMPLES
In the following example, the near-end 1-day registers for STM1 port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-STM1::11STMM10-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1131


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM1
RELATED COMMANDS
RTRV-PM-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1132 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-STM256


Command Name: INITIALIZE REGISTER STM256

PURPOSE
The INIT-REG-STM256 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified STM256 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-STM256:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN]
,[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1133


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM256
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default : none
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN

1134 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-STM256 Issue 1, December 2011

Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Input, Invalid ACcess identifier
• the user enters an invalid AID

SNVS Status, Not in Valid State


• the facility is not provisioned (using ENT-STM256)

EXAMPLES
In the following example, the near-end 1-day registers for STM256 port 43STA1P-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

1830PSS R3.6.50 - TL1 Commands and Messages 1135


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM256

INIT-REG-STM256::43STA1P-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1136 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-STM4


Command Name: INITIALIZE REGISTER STM4

PURPOSE
The INIT-REG-STM4 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified STM4 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-STM4:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],[
TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1137


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM4
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

TMPER Value Description


15-MIN
1-DAY
BOTH

1138 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-STM4 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-STM4)

EXAMPLES
In the following example, the near-end 1-day registers for STM4 port 11STMM10-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-STM4::11STMM10-1-6-C1:::,,NEND,,1-DAY;

1830PSS R3.6.50 - TL1 Commands and Messages 1139


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM4
RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1140 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-REG-STM64


Command Name: INITIALIZE REGISTER STM64

PURPOSE
The INIT-REG-STM64 command initializes the current 15-Minute or current 1-Day (specified by
TMPER) digital PM collection registers for the near-end side pertaining to the specified STM64 port to
the value zero.
For supported analog parameters (OPRL, OPRH, OPTL & OPTH) this command will reset their values
to last measured value.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

INIT-REG-STM64:[TID]:[AID]:[CTAG]::[MONTYPE],[MONVAL],[LOCN],[DIRN],
[TMPER];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
ALL

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1141


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM64
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


{ALL} (All monitored types)

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the parameter whose PM data
register is being initialized.

MONVAL Value Description


{0}

Default: 0
Addressing: None
Description: Monitor Value, specifies the value to be set in the register specified
by LOCN and TMPER.
Only the value 0 is supported.

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies the PM registers location to be initialized.

DIRN Value Description


{ALL}

Default: none
Addressing: None
Description: Direction, specifies the direction of the signal being monitored.
The value ALL means that the signal is being monitored in both the
transmit and receive directions.

1142 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-REG-STM64 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY
BOTH

Default: 15-MIN
Addressing: None
Description: Time Period, specifies whether the 15-minute or 1-day (24 hour)
PM collection register or both 15-minute/1-day PM collection
registers are to be initialized.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
No command specific output parameter.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Input, Invalid ACcess identifier
• the user enters an invalid AID

1830PSS R3.6.50 - TL1 Commands and Messages 1143


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-REG-STM64
SNVS Status, Not in Valid State
• the facility is not provisioned (using ENT-STM64)

EXAMPLES
In the following example, the near-end 1-day registers for STM64 port 11STAR1-1-6-C1 are initialized
to 0 and analog parameters set to baselined or last measured.

INIT-REG-STM64::11STAR1-1-6-C1:::,,NEND,,1-DAY;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1144 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-SSH-KEY


Command Name: INITIALIZE SECURE SHELL
PUBLIC/PRIVATE KEY GENERATION

PURPOSE
The INIT-SSH-KEY command can be initiated only by a user with administrative privilege to generate
the public/private key pair for the NE. When issued, the system will generate DSA key-pair for SSHv2.
It should be noted that regeneration of the SSH KEY will render all previous trusted entities using the
old key to flag the NE as untrusted because of the key change.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

INIT-SSH-KEY:[TID]::[CTAG]::[KEYTYPE=][,MODULUS=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

KEYTYPE= Value Description


DSA
RSA

Default: <DSA>
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1145


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSH-KEY
Description: There are two Key types. DSA key type is supported currently. The
RSA key will be supported in future.
Default is DSA

MODULUS= Value Description


0

Default: <0>
Addressing: None
Description: Modulus 0 is only supported by DSA.
Default is 0.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There shall be no command specific output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the command is entered with wrong keytype

1146 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SSH-KEY Issue 1, December 2011

• the modulus is out of range

PICC Privilege, Illegal Command Code


• the command is issued by a non-privilege user

EXAMPLES
The following example illustrates the command and associated output for setting the SSH KEY.

INIT-SSH-KEY::::::KEYTYPE=DSA,MODULUS=0;
AM1520 03-07-08 10:17:21
M P2c062 COMPLD
;

RELATED COMMANDS
RTRV-SSH-KEY

RELATED AUTONOMOUS RESPONSES

REPT^DBCHG
REPT^EVT^SECU

1830PSS R3.6.50 - TL1 Commands and Messages 1147


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSH-KEY

1148 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-SSL-CERT


Command Name: INIT (COPY) SSL CERTIFICATE (FROM
REMOTE FILE; EG; NMS)

PURPOSE

The INIT-SSL-CERT command will trigger to perform consistency check


on the certificate file to be installed. After successful validation
the certificate is installed on the NE and NE will go through an
application reset (warmboot).
Access Levels: Administrator

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

INIT-SSL-CERT:[TID]::[CTAG]:::;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1149


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSL-CERT
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Invalid User Access Privilege
• the command is issued by a non-privilege user

EXAMPLES
The following example illustrates the command and associated output for installing the SSL certificate
in the NE.

INIT-SSL-CERT::;

AM1520 03-07-08 10:11:58


M P09056 COMPLD
;

1150 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SSL-CERT Issue 1, December 2011

RELATED COMMANDS
INIT-SSL-CSR

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1151


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSL-CERT

1152 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-SSL-CSR


Command Name: INITIALIZE SECURE SOCKET LAYER
CERTIFICATE GENERATION

PURPOSE
The INIT-SSL-CSR command can be initiated only by a user with administrative privilege to generate a
certificate by provisioning the parameters so that it could be sent to NMS for signature using
COPY-RFILE command. This command will include the public key in the CSR before it sends to NMS
for signing request.

INPUT FORMAT

INIT-SSL-CSR:[TID]::[CTAG]::[COUNTRY=]:[STATE=]:[LOC=]:[ORG=]:[ORGUN
I=]:[CN=]:[EMAIL=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

COUNTRY= Value Description


<2 VALID CHARACTERS>

Default : <NO DEFAULT>


Addressing: None
Description: Country name.

1830PSS R3.6.50 - TL1 Commands and Messages 1153


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSL-CSR

STATE= Value Description


<1-128 VALID CHARACTERS>

Default: <NO DEFAULT>

Addressing: None

Description: State name.

LOC= Value Description


<1-128 VALID CHARACTERS>

Default: <NO DEFAULT>


Addressing: None
Description: City Name

ORG= Value Description


<1-64 VALID CHARACTERS>

Default: <NO DEFAULT>


Addressing: None

Description: Company Name or organization name.

ORGUNI= Value Description


<1-64 VALID CHARACTERS>

Default: <NO DEFAULT>


Addressing: None

Description: The division of Organization

CN= Value Description


<1-64 VALID CHARACTERS>

Default: <NO DEFAULT>


Addressing: None

Description: Server's host Name or common name or NE IP Address.

1154 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SSL-CSR Issue 1, December 2011

EMAIL= Value Description


<1-255 VALID CHARACTERS>

Default: <NO DEFAULT>

Addressing: None

Description: An email address used to contact the organization.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There shall be no command specific output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• the command is issued by a non-privilege user

EXAMPLES
The following example illustrates the command and associated output for setting the SSL certificate.

1830PSS R3.6.50 - TL1 Commands and Messages 1155


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSL-CSR

INIT-SSL-CSR::::::;
AM1520 03-07-08 10:17:21
M P2c062 COMPLD
;

RELATED COMMANDS
RTRV-SSL-CSR

RELATED AUTONOMOUS RESPONSES

REPT^DBCHG
REPT^EVT^SECU

1156 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-SSL-KEY


Command Name: INITIALIZE SECURE SOCKET LAYER
KEY GENERATION

PURPOSE

The INIT-SSL-KEY command can be initiated only by a user with


administrative privilege to generate the public/private key pair for
the NE. When issued, the system will generate RSA key-pair for
SSLv3. It should be noted that regeneration of the SSL KEY will
render all previous trusted entities using the old key to flag the
NE as untrusted because of the key change.
The command is valid for both Encrypted and Normal mode.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

INIT-SSL-KEY:[TID]::[CTAG]:::[KEYTYPE=][,KEYLEN=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1157


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSL-KEY

KEYTYPE= Value Description


DSA
RSA

Default: <RSA>
Addressing: None
Description: There are two Key types. RSA key type is supported currently. The
DSA key will be supported in future.
Default is RSA

KEYLEN= Value Description


{512-2048}

Default: <1024>
Addressing: None
Description: This is the key length.
Default is 1024.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There shall be no command specific output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1158 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SSL-KEY Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the command is entered with wrong keytype (currently only supported key is RSA)

• the key length is out of range

EXAMPLES
The following example illustrates the command and associated output for setting the SSH KEY.

INIT-SSL-KEY::::::KEYTYPE=RSA,KEYLEN=2048;
AM1520 03-07-08 10:17:21
M P2c062 COMPLD
;

RELATED COMMANDS
RTRV-SSL-KEY

RELATED AUTONOMOUS RESPONSES

REPT^DBCHG
REPT^EVT^SECU

1830PSS R3.6.50 - TL1 Commands and Messages 1159


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SSL-KEY

1160 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-SYS-NEW


Command Name: INITIALIZE SYSTEM WITH NEW
RELEASE

PURPOSE
The INIT-SYS-NEW starts the background activity on the NE to perform the actual switch over from
the current release to the new release .It converts the current release databases into the new release
databases if required. The Network Element will be warm restarted as part of this activity. If the
Network Element has duplex Equipment Controllers (EC), then after this operation completes
successfully, the ACTIVE EC on the MAIN Shelf will be the one which was STDBY before the
operation.

The INIT-SYS-NEW command is supported only when the SWFTDWN, NE Software Upgrade In
Progress, standing condition is active on the NE. To review the steps needed for the software release
upgrade, please refer to the OAMP Guide.

This command will issue a TL1 response before the background activities complete. REPT^ISU
notifications will be issued at the beginning of the background activity and upon completion of the
background activity.

Pack firmware will NOT be upgraded automatically during the INIT-SYS-NEW command.
A copy of the database is saved, and then the active database is converted to the format required by
the new release. A backout of the INIT-SYS-NEW operation is supported via the INIT-SYS-OLD
command, which will return the previously active database and re-load the previous software release.
During the switch over process the system will perform an EC switch. At this point all TL1 sessions are
terminated.
If the activation of the new release fails,a user initiated backout to the old release and old database, via
the INIT-SYS-OLD TL1 command or a software release downgrade, may be used to recover.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

INIT-SYS-NEW:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1161


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SYS-NEW

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SARB Status, All Resources Busy
• the COPY-RFILE command is in progress

SCSN Status, invalid Command SequeNce


• the INIT-SYS-NEW command is issued and the SWFTDWN standing condition is not currently
active or the previous STA-ISU or COPY-RFILE command was denied or failed

1162 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SYS-NEW Issue 1, December 2011

• the INIT-SYS-NEW command is issued and no release has previously been downloaded to this
NE, using the COPY-RFILE TL1 command, or if the previous download has denied or failed

SROF Status, Requested Operation Failed


• standby EC contains a failure which would prevent a duplex controller switch

• the checks that the system runs at the beginning of the activate operation fail

EXAMPLES
The following example illustrates the command for performing the actual switch over to the upgraded
software and databases.
INIT-SYS-NEW;

RELATED COMMANDS
INIT-SYS-OLD
RTRV-ISU-STATUS
STA-ISU

RELATED AUTONOMOUS RESPONSES


REPT^ISU

1830PSS R3.6.50 - TL1 Commands and Messages 1163


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SYS-NEW

1164 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-SYS-OLD


Command Name: INITIALIZE SYSTEM WITH OLD RELEASE
AND DATABASE

PURPOSE
The INIT-SYS-OLD returns the NE back from the current release and database to previous release
and database. The previous release and database are those which were active on the NE before the
software release upgrade was started (STA-ISU). If the software release upgrade had progressed to
the point that the INIT-SYS-NEW command was successfully completed, then a INIT-SYS-OLD will
cause the Network Element to be warm restarted as part of this activity. If the Network Element has
duplex Equipment Controllers (EC), then after this operation completes successfully, the ACTIVE EC
on the MAIN Shelf will be the one which was STDBY before the operation.

The INIT-SYS-OLD command is supported after an STA-ISU command and before the software
release has been committed with the COMMIT-ISU command.

This command will issue a TL1 response before any background activities complete. REPT^ISU
notifications will be issued at the beginning of the background activity and upon completion of the
background activity.

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

INIT-SYS-OLD:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1165


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SYS-OLD
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SARB Status, All Resources Busy
• the COPY-RFILE command is in progress

SCSN Status, invalid Command SequeNce


• the INIT-SYS-OLD command is issued outside of the context of a software release upgrade, or
before an STA-ISU or after a COMMIT-ISU command

EXAMPLES
The following example illustrates the command for instructing the system to revert back to the previous
release software and database that was active on the Network Element prior to the latest upgrade
process. The executable and database are downloaded, if needed, for all processor-based circuit
packs that are provisioned and installed in the system (i.e., a warm start of the system is performed).

INIT-SYS-OLD;

1166 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SYS-OLD Issue 1, December 2011

RELATED COMMANDS
INIT-SYS-NEW
RTRV-ISU-STATUS
STA-ISU

RELATED AUTONOMOUS RESPONSES


REPT^ISU

1830PSS R3.6.50 - TL1 Commands and Messages 1167


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SYS-OLD

1168 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: INIT-SYS


Command Name: INITIALIZE SYSTEM

PURPOSE
The INIT-SYS command resets the specified equipment entity. The command can be applied to the
following provisioned and equipped modules.
General Equipment
• First Level Controller (FLC)
• Matrix Zero (MT0C)
• Shelf Equipment Controller (EC)
Active DWDM Circuit Packs
• Line Driver - LD (ALPHG, AHPHG, AHPLG, ALPFGT,A2325A, AM2017B, AM2325B, AM2125A,
AM2125B, AM2318A, RA2P)
• Optical Supervisory Channel (OSCT)
• Wavelength Tracker Optical Channel Monitoring Card (WTOCM)
• Colorless Wavelength Router (CWR8, CWR8-88)
• Wavelength Router (WR8-88A, WR2-88A)
• Mesh Card (MESH4)
• Optical Translator - OT (112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10, 112SX10L,
11STAR1, 11STMM10, 11STGE12, 43SCX4L, 43SCX4, 43SCA1, 43STX4, 43STX4P, 43STA1P,
4DPA4, 4DPA2, 11QPA4, 11DPE12, 11DPE12E, 11DPM12, 11STAR1A)
• Optical Translator - OT
• (112SA1L, 112SCA1, 112SCX10, 112SNA1, 112SNX10, 112SX10L,
• 11DPE12, 11DPE12E, 11DPM12, 11QPA4, 11QPEN4, 11QTA4, 11STAR1,
11STAR1A, 11STGE12, 11STMM10,
• 4DPA2, 4DPA4 )
• Variable Attenuator Card (SVAC, MVAC)
• Optical Protection Switch (OPS)
In addition a restart of the entire NE can be performed by specifying AID=SYSTEM.
Two levels of restart are supported for processor-based modules.
• "Warm Restart". Equivalent terms are soft reset and software reboot. Previous hardware state
must be retained. Transmission must not be affected.
• "Cold Restart". Equivalent terms are hard reset, power cycle, and power-up. Hardware state is
completely re-initialized from scratch without reference to previous state. Transmission may be
affected.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

INIT-SYS:[TID]:AID:[CTAG]::PH:[CMDMDE=];

1830PSS R3.6.50 - TL1 Commands and Messages 1169


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SYS
INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1170 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SYS Issue 1, December 2011

AID Value Description


FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STAR1A-<shelf>-<slot> (11STAR1A Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 1171


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SYS

AID Value Description


11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SYSTEM (System AID)

Default: < Entry required>


Addressing: None
Description: Access identifier of equipment entity. AID=SYSTEM is used to
restart the entire NE, i.e. restart all equipped processor-based
cards in the NE.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

PH Value Description
0 Warm Restart
1 Cold Restart
4 Clears the USRPNL serial number
for PSS-32 master shelf.

6 Initializes a new database for


PSS-32, PSS-16, and PSS-36 master
shelf. TID and IP information stored in
the USRPNL or BT36 SEEPROM is
retained unchanged.

8 Initializes a new database and


clear TID and IP information from the
USRPNL
or BT36 SEEPROM for PSS-32,
PSS-16, and PSS-36 master shelf.

Default: Entry required.


Addressing: None
Description: Phase, identifies the type of restart. All cards (except an EC) must
be in admin maintenance state or admin out-of-service state for a
cold restart to be allowed.

1172 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
INIT-SYS Issue 1, December 2011

The PH value of 4, 6, and 8 (PH=4, 6, 8) is applicable only to


AID=SYSTEM

CMDMDE= Value Description


NORM
FRCD

Default: NORM
Addressing: None
Description: Command Mode, identifies the Command Execution Mode.
A cold restart (PH=1) with AID=SYSTEM is allowed only if the
CMDMDE=FRCD. For any other AID, this parameter is ignored.
The PH value of 4, 6, and 8 (PH=4, 6, 8) with AID=SYSTEM is
allowed only if the CMDMDE=FRCD.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:

1830PSS R3.6.50 - TL1 Commands and Messages 1173


8DG61100 EAAAQZZA
Issue 1, December 2011 INIT-SYS
ENEQ Entity Not Equipped
• the equipment entity is not physically equipped and an AID different from SYSTEM is used

IPNC Input Parameter Not Consistent


• the equipment entity is not provisioned and an AID different from SYSTEM is used

• the command is input for an AID which is different from the one provisioned in the corresponding
slot

SARB Status, All Resources Busy


• the command is entered with AID=SYSTEM and PH=1 (cold restart) and MODE=NORM

SROF Status Request Operation Failed


• the command is entered with PH=1 (cold restart) against a card which is not in admin
maintenance state or admin out-of-service state (except for an FLC, MT0C, or EC)

• the command is entered with AID=SYSTEM and PH=1 (cold restart) and MODE=NORM

• the command is entered with AID=SYSTEM and PH=1 (cold restart) and MODE=NORM

EXAMPLES
The following command performs a cold restart on an OT card.

INIT-SYS::11STAR1-2-5:::1:;

RELATED COMMANDS
RTRV-COND-ALL

1174 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: OPR-ACO-ALL


Command Name: OPERATE ALARM CUTOFF ALL

PURPOSE
This command cuts off the office audible alarm indications without changing the local alarm reporting.
The currently active audible alarm indications will be silenced. The visual alarm indications are not
affected. Future alarm reporting is not be affected and new audible alarm indications will be provided
for any new alarms.
The ACO LED shall be turned on when the OPR-ACO-ALL is issued. When the ACO LED is turned on
and a new alarm arrives, it shall be presented to the audible closures. The ACO LED will be turned off
only when all the alarms silenced by OPR-ACO-ALL are cleared. Alarms silenced by OPR-ACO-ALL
shall not be presented to the Audible closures even if they are still present (only new alarms).
Category: Fault (General)
Security: Admin, Provisioner
Successful completion of this command generates a REPT^DBCHG (report database change)
autonomous response message.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

OPR-ACO-ALL:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1175


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-ACO-ALL
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^/* <Command_Code> */ cr lf
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following command cuts off the audible alarm.

OPR-ACO-ALL ;

AM1587 04-09-09 14:07:34


M 0 COMPLD
/* OPR-ACO-ALL */
;

1176 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
OPR-ACO-ALL Issue 1, December 2011

AM1587 04-09-09 14:07:34


M 0 COMPLD
/* OPR-ACO-COM [P00099] (65537) */
;

ALCATEL-1677SL 04-09-09 14:07:34


A 315 REPT DBCHG
"TIME=14-07-34,DATE=04-09-09,SOURCE=0,USERID=THORGAN,
DBCHGSEQ=63:OPR-ACO-ALL::"
;

RELATED COMMANDS
None
ALW-MSG-ALL
ALW-MSG-rr
INH-MSG-ALL
INH-MSG-rr
RTRV-ALM-rr
RTRV-ALM-ALL
RTRV-COND-rr
RTRV-COND-ALL

RELATED AUTONOMOUS RESPONSES


None
REPT^ALM^COM
REPT^COND^COM
REPT^DBCHG
REPT^EVT^COM

1830PSS R3.6.50 - TL1 Commands and Messages 1177


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-ACO-ALL

1178 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: OPR-LPBK-EQPT


Command Name: OPERATE LOOPBACK EQPT

PURPOSE
The OPR-LPBK-EQPT command establishes a near-end facility or terminal loopback on the specified
port. This command is also used to provision test signal generation/detection at the specified client
interface on the 112SCA1 OT or 112SNA1 OT, or the 112SA1L OT.
To execute an OPR-LPBK-EQPT, the specified EQPT facility must have a PST of OOS-AUMA,MT or
OOS-MA,MT and not have an SST of LPBK (i.e. it is not in a loopback).
Executing OPR-LPBK-EQPT sets an LPBKLINE (for Facility loopback) or LPBKTERM (for Terminal
loopback) condition type on the specified port. The OPR-LPBK-EQPT command can also be used to
turn on the test signal source on the client port (C1) of the 112SCA1 OT or 112SNA1 OT or 112SA1L
OT.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

OPR-LPBK-EQPT:[TID]:AID:[CTAG]::,,,LPBKTYPE;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1179


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-LPBK-EQPT

AID Value Description


112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STAR1A-<shelf>-<slot>-{L1, C1} (11STAR1A Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, C{1-4}} (4DPA4 Line/Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Line/Client Ports)
C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},C{1-1 (11DPE12E Lines/Clients Ports)
2}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Line/Client Ports)
C{1-12}}

Default: Entry required


Addressing: None
Description: OT Client/Line port Access Identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1180 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
OPR-LPBK-EQPT Issue 1, December 2011

LPBKTYPE Value Description


FACILITY
TERMINAL
TESTSIGNAL

Default: entry required


Addressing: None
Description: Loopback Type, specifies the type of loopback.
FACILITY Specifies a loopback at the receive side (from the
client equipment or a DWDM line) to the transmit
side (toward the client equipment or DWDM line) of
the specified facility.
TERMINAL Specifies a loopback where the signal that
is about to be transmitted toward the client is
transmitted back toward a DWDM domain.
TESTSIGNAL Enables a test signal to be sent out the
client transmit port on a 112SCA1 OT or a
112SNA1 OT or a 112SA1L OT.
The value TESTSIGNAL only applies to the 112SCA1 client port
AID, or the 112SNA1 client port AID or the 112SA1L client port
AID.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 1181


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-LPBK-EQPT
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SNOS Status, Not currently Out of Service
• the facility does not have a PST of OOS-AUMA,MT or OOS-MA,MT

SNVS Status, Not in Valid State


• the facility to be looped back is not provisioned

EXAMPLES
In the following example, a facility loopback is established for facility 11STAR1-1-10-C1.

OPR-LPBK-EQPT::11STAR1-1-10-C1:::,,,FACILITY;

In the following example, a test signal is established for facility 112SCA1-1-10-C1.

OPR-LPBK-EQPT::112SCA1-1-10-C1:::,,,TESTSIGNAL;

RELATED COMMANDS
RLS-LPBK-EQPT
RTRV-LPBK-EQPT

RELATED AUTONOMOUS RESPONSES


REPT^EVT^EQPT

1182 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: OPR-PROTNSW-<ODUK>


Command Name: OPERATE PROTECTION SWITCH

PURPOSE
The OPR-PROTNSW-<ODUk> will be used for initiating of switch commands for SNCP.
The OPR-PROTNSW-<ODUk> command initiates external switch requests for path protected
cross-connections.The command requests the system to switch the path selector to the protected or
protecting path of the SNCP. User switch requests initiated with this command remain active until they
are released via the RLS-PROTNSW-<ODUk> command or overridden by a higher priority protection
switch request.
The SWTCHCMD parameter of the OPR-PROTNSW-<ODUk> command provides the user with three
priority options, LOCKOUT, FRCD, and MAN. When the command executes, the path selector
switches to the specified destination facility (WKG - FROMPED or PROTN - FROMPING).
If the new external request is higher priority than the current request for the group and in the event that
the switch/selector is already at the destination position, then no switch actually occurs, but the switch
state and conditions are updated to match the new current request.

Table OPRPROTNSW-2: Priority of Path Switching Requests


Priority Switch request
1 (highest) clear
2 LOCKOUT
3 FORCED switch
4 Signal Fail (SF)
5 Signal Degrade (SD)
6 MANUAL switch
7 Wait To Restore
8 Do Not Revert
9 (lowest) No Request

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

OPR-PROTNSW-<ODUk>:[TID]:TO:[CTAG]::[SWTCHCMD]::DESTINATION=;

INPUT PARAMETERS

ODUk Value Description


{ODU0, ODU1,ODUF}

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 1183


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-PROTNSW-ODUK
Addressing: None
Description:The ODUk indicates the rate on which the command
acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description:Target IDentifier, identifies the network node TID for
the command.

TO Value Description
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the TO (transmit
side to the network, sink of cross-connection) facility of the
cross-connection.It addresses the cross connection to be
converted.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description:Correlation TAG, associates the input command with
its output responses.

1184 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
OPR-PROTNSW-ODUK Issue 1, December 2011

SWTCHCMD Value Description


{FRCD, LOCKOUT, MAN}

Default: Entry Required


Addressing: None
Description: Switch command to be performed
FRCD Forced Switch, either of protected (FROMPED) to
protecting (FROMPING) or of protecting to
protected. If the DESTINATION identifies the
protecting facility, a Forced Switch of protected
facility (to protecting facility) occurs.
LOCKOUT Lockout of Protecting. A lockout of protecting
prevents the channel from switching to the
protecting facility. If the channel is already on the
protecting facility, it is switched back to its protected
facility.
MAN Manual Switch, either of protected to protecting or
of protecting to protected. If the DESTINATION
identifies the protecting facility, a Manual Switch of
protected facility (to protecting facility) occurs.

DESTINATION= Value Description


{WKG, PROTN}

Default: Entry Required


Addressing: None
Description: Destination of the switch action addressed by the command.
WKG Execute the requested switch action such that
service ends up on the protected facility.
PROTN Execute the requested switch action such that
service ends up on the protecting facility.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 1185


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-PROTNSW-ODUK
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• LOCKOUT is specified and the DESTINATION is PROTN

IDNV Input, Data Not Valid


• the used AID in TO does not match for the rate

SSRD Status, Switch Request Denied


• the TO AID specified is not a valid sink facility of a path protected cross connection

• an equal or higher priority protection switch state currently exists

EXAMPLES
The following command does a forced switch to the working side of a ESNCPprotection group :

OPR-PROTNSW-ODU1::
11DPM12-1-1-C2-ODU1:Pab124::FRCD::DESTINATION=WKG;

RELATED COMMANDS
RLS-PROTNSW-<ODUk>
RTRV-CRSPROT-<ODUk>
CNVT-CCTPR-<ODUk>
CNVT-CCTU-<ODUk>

1186 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
OPR-PROTNSW-ODUK Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1187


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-PROTNSW-ODUK

1188 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: OPR-PWRMGMT


Command Name: OPERATE-POWER CONTROL

PURPOSE
The OPR-PWRMGMT command enables the adjustment of either ingress or egress power. Note that
this command only applies to the LD that is associated with auto power managed line port.

INPUT FORMAT

OPR-PWRMGMT:[TID]:AID:[CTAG]::COMMANDS=:[LOCATION=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the LD

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1189


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-PWRMGMT
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

COMMANDS= Value Description


{ADJUST, ADJUSTABORT}

Default: <previously existing value>


Addressing: None
Description: Power Management Command. Specifies which action to take.
ADJUST Adjust starts either an ingress or
egress-power-adjustment of an LD.
ADJUSTABORT Abort only applies to
egress-power-adjustment. When an
egress-power-adjustment is aborted the power
adjustment completes the current iteration and
leaves the power levels at their current values.

LOCATION= Value Description


{INGRESS, EGRESS}

Default: EGRESS
Addressing: None
Description: LOCATION, Indicates the ingress or egress direction.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1190 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
OPR-PWRMGMT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
ICNV Input, Command Not Valid
• this command is issued on an LD that is associated with manual-power-managed line port

IPNC Input, Parameter Not Consistent


• this command is issued with a COMMANDS= ADJUSTABORT for an ingress LD

EXAMPLES
The following example shows the successful execution of an OPR-PWRMGMT command.

OPR-PWR:NODE-1:ALPHG-2-9-LINE:123456::ADJUST;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* OPR-PWR:NODE-1:ALPHG-2-9-LINE:123456::ADJUST:LOCATION=EGRESS;
*/
;

RELATED COMMANDS
ED-PWRMGMT-INGRESS
ED-PWRMGMT-EGRESS
ED-PWRMGMT-TYPE
RTRV-PWRMGMT-INGRESS
RTRV-PWRMGMT-EGRESS
RTRV-PWRMGMT-TYPE
RTRV-PWRMGMT

1830PSS R3.6.50 - TL1 Commands and Messages 1191


8DG61100 EAAAQZZA
Issue 1, December 2011 OPR-PWRMGMT
RELATED AUTONOMOUS RESPONSES
NONE

1192 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RLS-EXT-CONT


Command Name: RELEASE EXTERNAL CONTROL

PURPOSE
RLS-EXT-CONT instructs an NE to release an external control, such as a relay deactivation. The
control is released continuously, and can be operated by using the OPR-EXT-CONT command.

INPUT FORMAT

RLS-EXT-CONT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

AID Value Description


PF-1-44-HOUSEKEEPINGOUT{1-4} (PSS-36 External Control Points)
USRPNL-1-<slot>-HOUSEKEEPINGOU (User Panel External Control Points)
T{1-4}
USRPNL-1-<slot>-HOUSEKEEPINGOU (PSS-16 User Panel External Control
T{1-4} Points)

Default: Entry required.


Addressing: None
Description: Access IDentifier of the external control output point.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System Assigned CTAG Value>


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1193


8DG61100 EAAAQZZA
Issue 1, December 2011 RLS-EXT-CONT
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SARL Status, Already ReLeased
• the House Keeping Output (HOUSEKEEPING{i}) is not in the OPER state

EXAMPLES
In the following example, RLS-EXT-CONT activates an external control on
USRPNL-1-40-HOUSEKEEPINGOUT3:

RLS-EXT-CONT:LASVEGAS:USRPNL-1-40-HOUSEKEEPINGOUT3;

A successful response for that command would be:

1194 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RLS-EXT-CONT Issue 1, December 2011

cr lf lf
^^^LASVEGAS^01-02-27^08:46:59 cr lf
M ^77^COMPLD cr lf
^^^/* RLS-EXT-CONT:LASVEGAS:USRPNL-1-40-HOUSEKEEPINGOUT3 */ cr lf
;

RELATED COMMANDS
OPR-EXT-CONT
RTRV-EXT-CONT

RELATED AUTONOMOUS RESPONSES


REPT^DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1195


8DG61100 EAAAQZZA
Issue 1, December 2011 RLS-EXT-CONT

1196 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RLS-LPBK-EQPT


Command Name: RELEASE LOOPBACK EQPT

PURPOSE
The RLS-LPBK-EQPT command releases a line loopback (at the receive-side of the facility) or terminal
loopback (at the transmit-side of the facility), previously established by an OPR-LPBK-EQPT
command, on the specified port.
The RLS-LPBK-EQPT command is used to release (i.e., disable) a TESTSIGNAL at the transmit side
of a client facility on the 112SCA1 OT or the 112SA1L OT, that was previously established by the
OPR-LPBK-EQPT command.
To execute a RLS-LPBK-EQPT, the specified EQPT must have a PST,SST of OOS-AUMA,MT&LPBK
or OOS-MA,MT&LPBK.
Executing RLS-LPBK-EQPT clears the LPBK condition type on the specified EQPT facility.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RLS-LPBK-EQPT:[TID]:AID:[CTAG]::,,,[LPBKTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1197


8DG61100 EAAAQZZA
Issue 1, December 2011 RLS-LPBK-EQPT

AID Value Description


112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, C{1-4}} (4DPA4 Line/Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Line/Client Ports)
C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},C{1-1 (11DPE12E Lines/Clients Ports)
2}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Line/Client Ports)
C{1-12}}

Default: Entry required


Addressing: None
Description: OT Client/Line port Access Identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1198 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RLS-LPBK-EQPT Issue 1, December 2011

LPBKTYPE Value Description


FACILITY
TERMINAL
TESTSIGNAL
The value TESTSIGNAL only applies to
the client port (C1) AID of the 112SCA1
OT or 112SNA1 OT or the 112SA1L
OT.

Default: <Any type of loopback or test signal>


Addressing: None
Description: Loopback Type, specifies the type of loopback or test signal.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
None

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid

1830PSS R3.6.50 - TL1 Commands and Messages 1199


8DG61100 EAAAQZZA
Issue 1, December 2011 RLS-LPBK-EQPT
• the command is entered with a LPBKTYPE that does not match the type of loopback currently on
the facility

SARL Status, Already ReLeased


• the facility is not looped back

• the facility is not looped back

EXAMPLES
In the following example, the RLS-LPBK-EQPT releases the loopback on facility 11STAR1-1-10-C1.

RLS-LPBK-EQPT::11STAR1-1-10-C1:::,,,FACILITY;

In the following example, the RLS-LPBK-EQPT releases the test signal on facility 112SA1L-1-2-C1.

RLS-LPBK-EQPT::112SA1L-1-2-C1:::,,,TESTSIGNAL;

RELATED COMMANDS
OPR-LPBK-EQPT
RTRV-LPBK-EQPT

RELATED AUTONOMOUS RESPONSES


REPT^EVT^EQPT

1200 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RLS-PROTNSW-<ODUK>


Command Name: RELEASE PROTECTION SWITCH

PURPOSE
RLS-PROTNSW-<ODUk> instructs the system to release or clear an external switch request for an
rate path protection group.
When the command executes, the external switch command previously entered via
OPR-PROTNSW-<ODUk> is cleared and the path is automatically selected according to the Path
Switching Hierarchy of defects (see table in the OPR-PROTNSW-<ODUk> command). The
RLS-PROTNSW-<ODUk> will not necessarily cause a protection switch, if the best path is currently
selected.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RLS-PROTNSW-<ODUk>:[TID]:TO:[CTAG];

INPUT PARAMETERS

ODUk Value Description


{ODU0, ODU1,ODUF}

Default: Entry Required


Addressing: None
Description:The ODUk indicates the rate on which the command
acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description:Target IDentifier, identifies the network node TID for
the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1201


8DG61100 EAAAQZZA
Issue 1, December 2011 RLS-PROTNSW-ODUK

TO Value Description
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Default: Entry Required


Addressing: None
Description:AID of connection point; Indicates the TO (transmit
side to the network, sink of cross-connection) facility of the
cross-connection.It addresses the cross connection to be
converted.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description:Correlation TAG, associates the input command with
its output responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]

OUTPUT PARAMETERS
There are no output parameters for this command.

1202 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RLS-PROTNSW-ODUK Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the used AID in TO does not match for the rate

SSRD Status, Switch Request Denied


• the TO aid specified is not a valid sink facility of a path protected cross connection

EXAMPLES
The following command clears any existing switch to protection (forced or manual):

RLS-PROTNSW-ODU1:: 11DPM12-1-1-C2-ODU1:Pab124;

RELATED COMMANDS
CNVT-CCTPR-<ODUk>
CNVT-CCTU-<ODUk>

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 1203


8DG61100 EAAAQZZA
Issue 1, December 2011 RLS-PROTNSW-ODUK

1204 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-100GBE


Command Name: RMV-100GBE

PURPOSE
The RMV-100GBE command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-100GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1205


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-100GBE
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1206 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-100GBE Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-100GBE


command.
RMV-100GBE:NODE-1:112SCA1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-100GBE
RST-100GBE
ED-100GBE
ENT-100GBE
DLT-100GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1207


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-100GBE

1208 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-10GBE


Command Name: RMV-10GBE

PURPOSE
The RMV-10GBE command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-10GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 1209


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-10GBE
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a 11DPE12 pack not working under qinq mode

SAOS Status, Already Out of Service

1210 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-10GBE Issue 1, December 2011

• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

EXAMPLES

The following example shows the successful execution of a RMV-10GBE


command.
RMV-10GBE:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-10GBE
RST-10GBE
ED-10GBE
ENT-GBE10
DLT-10GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1211


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-10GBE

1212 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-1GBE


Command Name: RMV-1GBE

PURPOSE
The RMV-1GBE command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-1GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1213


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-1GBE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1214 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-1GBE Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-1GBE


command.
RMV-1GBE:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-1GBE
RST-1GBE
ED-1GBE
ENT-1GBE
DLT-1GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1215


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-1GBE

1216 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-CBR2G5


Command Name: RMV-CBR2G5

PURPOSE
The RMV-CBR2G5 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-CBR2G5:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1217


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-CBR2G5
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

1218 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-CBR2G5 Issue 1, December 2011

• this command is issued on a facility that is in OOS-AU, AINS state

EXAMPLES

The following example shows the successful execution of a RMV-CBR2G5


command.
RMV-CBR2G5:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBR2G5
RST-CBR2G5
ED-CBR2G5
ENT-CBR2G5
DLT-CBR2G5

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1219


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-CBR2G5

1220 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-CBRAR


Command Name: RMV-CBRAR

PURPOSE
The RMV-CBRAR command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-CBRAR:[TID]:AID:[CTAG]:::DATATYPE=;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1221


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-CBRAR
Description: Correlation TAG, associates the input command with its output
responses.

DATATYPE= Value Description


{HDSDI, FE, SDSDI, 3GSDI}

Default: Entry required


Addressing: None
Description: Specifies the client signal type. Must equal the value previously
assigned by ENT-CBRAR.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a DATATYPE value that does not match the provisioned signal type

SAOS Status, Already Out of Service

1222 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-CBRAR Issue 1, December 2011

• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

EXAMPLES

The following example shows the successful execution of a RMV-CBRAR


command.
RMV-CBRAR:NODE-1:4DPA4-1-2-C1:xyz123:::DATATYPE=FE;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBRAR
RST-CBRAR
ED-CBRAR
ENT-CBRAR
DLT-CBRAR

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1223


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-CBRAR

1224 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-EQPT


Command Name: REMOVE EQUIPMENT

PURPOSE
The RMV-EQPT command causes the specified equipment to be placed in the administrative
maintenance state. The command can be applied to the following equipment entities.
General Equipment
• First Level Controller (FLC)
• Matrix Zero (MT0C)
Active DWDM Circuit Packs
• Line Driver - LD (ALPHG, AHPHG, AHPLG, ALPFGT, A2325A, AM2017B, AM2325B, AM2125A,
AM2125B, AM2318A, RA2P)
• Optical Supervisory Channel (OSCT)
• Wavelength Tracker Optical Channel Monitoring Card (WTOCM)
• Colorless Wavelength Router (CWR8, CWR8-88)
• Wavelength Router (WR8-88A, WR2-88A)
• Mesh Card (MESH4)
• Optical Translator - OT (112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10, 112SX10L,
11STAR1, 11STMM10, 11STGE12, 43STX4, 43STX4P, 43SCX4L, 43SCX4, 43SCA1, 43STA1P,
4DPA4, 4DPA2, 11QPA4, 11DPE12, 11DPE12E, 11DPM12, 11STAR1A)
• Optical Translator - OT
• (112SA1L, 112SCA1, 112SCX10, 112SNA1, 112SNX10, 112SX10L,
• 11DPE12, 11DPE12E, 11DPM12, 11QPA4, 11QPEN4, 11QTA4, 11STAR1,
11STAR1A, 11STGE12, 11STMM10,
• 4DPA2, 4DPA4 )
• Variable Attenuator Card (SVAC, MVAC)
• Optical Protection Switch (OPS)
• Static Filter DWDM (SFD5/8)
• Static Filter CWDM (SFC2/4/8)
Passive DWDM Modules
• SFD44. The SFD44 is modeled as the fixed "card" in an SFD "shelf" with only one "slot". But
physically, the SFD44 card/shelf are not separable. The RMV-EQPT command is addressed to
the SFD44 "card".
• SFD44B. The SFD44B is modeled as the fixed "card" in an SFD44B "shelf" with only one "slot".
But physically, the SFD44B card/shelf are not separable. The RMV-EQPT command is addressed
to the SFD44B "card". The SFD44B carries the 44 odd channels, which in addition to the 44 even
channels from a SFD44 supports an 88 channel optical line.
• SFD40. The SFD40 is modeled as the fixed "card" in an SFD "shelf" with only one "slot". But
physically, the SFD40 card/shelf are not separable. The RMV-EQPT command is addressed to
the SFD40 "card".
• SFD40B. The SFD40B is modeled as the fixed "card" in an SFD40B "shelf" with only one "slot".
But physically, the SFD40B card/shelf are not separable. The RMV-EQPT command is addressed

1830PSS R3.6.50 - TL1 Commands and Messages 1225


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-EQPT
to the SFD40B "card". The SFD40B carries the 40 odd channels, which in addition to the 40 even
channels from a SFD40 supports an 80 channel optical line.
• DCM. The DCM is modeled as the fixed "card" in a DCM "shelf" with only one "slot". But
physically, multiple DCM modules of several sizes fit into a single housing. The RMV-EQPT
command is addressed to the DCM "card".
• ITLB/ITLU. The ITLB/ITLU is modeled as the fixed "card" in an ITLB/ITLU "shelf" with only one
"slot". But physically, multiple ITLB/ITLU and DCM modules of several sizes fit into a single
housing. The RMV-EQPT command is addressed to the ITLB/ITLU "card".
Executing a RMV-EQPT command causes a state transition to OOS-[AU]MA, MT (admin maintenance
state). Additional secondary states depend upon events detected by the system.
This command causes a clear message to be sent for any condition that has already been
autonomously reported. It prevents any subsequent conditions declared against the equipment from
being autonomously reported but the conditions are still retrievable.
The successful completion of the command shall cause REPT^DBCHG autonomous messages.

INPUT FORMAT

RMV-EQPT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1226 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-EQPT Issue 1, December 2011

AID Value Description


FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 1227


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-EQPT

AID Value Description


MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)

Default: Entry required


Addressing: None
Description: Equipment Access Identifier, identifies the equipment entity access
identifier

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^/* <Command_Code> */ cr lf
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1228 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-EQPT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
EQWT EQuipage, Wrong Type
• the command is input for an AID which is different from the one provisioned in the corresponding
slot

IENE Input, Entity Not Exists


• the equipment entity is not provisioned

SABT Status, ABorTed


• the RMV-EQPT command is entered for the active FLC, MT0C, or EC in a shelf

• the RMV-EQPT command is entered for a circuit pack with one or more ports currently in-service

EXAMPLES
In the following example, an OT is placed into administrative maintenance state.

RMV-EQPT::11STAR1-2-5;

RELATED COMMANDS
DLT-EQPT
ED-EQPT
ENT-EQPT
RST-EQPT
RTRV-EQPT

1830PSS R3.6.50 - TL1 Commands and Messages 1229


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-EQPT

1230 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-FC100


Command Name: RMV-FC100

PURPOSE
The RMV-FC100 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-FC100:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1231


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC100
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1232 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-FC100 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-FC100


command.
RMV-FC100:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC100
RST-FC100
ED-FC100
ENT-FC100
DLT-FC100

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1233


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC100

1234 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-FC1200


Command Name: RMV-FC1200

PURPOSE
The RMV-FC1200 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-FC1200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1235


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC1200
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1236 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-FC1200 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-FC1200


command.
RMV-FC1200:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC1200
RST-FC1200
ED-FC1200
ENT-FC1200
DLT-FC1200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1237


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC1200

1238 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-FC200


Command Name: RMV-FC200

PURPOSE
The RMV-FC200 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-FC200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1239


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC200
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1240 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-FC200 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-FC200


command.
RMV-FC200:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC200
RST-FC200
ED-FC200
ENT-FC200
DLT-FC200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1241


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC200

1242 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-FC400


Command Name: RMV-FC400

PURPOSE
The RMV-FC400 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-FC400:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1243


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC400
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1244 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-FC400 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-FC400


command.
RMV-FC400:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC400
RST-FC400
ED-FC400
ENT-FC400
DLT-FC400

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1245


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC400

1246 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-FC800


Command Name: RMV-FC800

PURPOSE
The RMV-FC800 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-FC800:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1247


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC800
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1248 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-FC800 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-FC800


command.
RMV-FC800:NODE-1:112SCX10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC800
RST-FC800
ED-FC800
ENT-FC800
DLT-FC800

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1249


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FC800

1250 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-FE


Command Name: RMV-FE

PURPOSE
The RMV-FE command causes the specified facility client/line to be placed in an out-of-service
(OOS-MA,MT or OOS-AUMA,MT) state for maintenance purposes.
Executing a RMV-FE command causes a state transition for the specified FE port from:
IS-NR or IS-ANR to OOS-MA,MT
OOS-AU to OOS-AUMA,MT
When an FE port is in an OOS-MA or OOS-AUMA state, all transmission condition types are cleared
and a MAN condition type is set for the specified port.
When an FE port is in an OOS-MA or OOS-AUMA state, no transmission condition types or
performance monitoring threshold crossing alerts are autonomously reported for the port, but alarm
conditions are monitored and performance monitoring data is collected (if provisioned for PM
collection) for the port.
The RMV-FE command places the specified facility in the administrative maintenance state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
All transmission conditions are cleared and a MAN condition is set for the port. When a port is in
maintenance state, autonomous reporting is disabled for transmission conditions and performance
monitoring threshold crossing alerts. However, conditions are monitored and can be retrieved. PM
data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-FE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Default: Entry Required

1830PSS R3.6.50 - TL1 Commands and Messages 1251


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FE
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1252 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-FE Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

EXAMPLES

The following example shows the successful execution of a RMV-FE


command.
RMV-FE:NODE-1:11DPE12E-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FE
RST-FE
ED-FE
ENT-FE
DLT-FE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1253


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-FE

1254 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OC12


Command Name: RMV-OC12

PURPOSE
The RMV-OC12 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OC12:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1255


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC12
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1256 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OC12 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-OC12


command.
RMV-OC12:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC12
RST-OC12
ED-OC12
ENT-OC12
DLT-OC12

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1257


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC12

1258 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OC192


Command Name: RMV-OC192

PURPOSE
The RMV-OC192 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OC192:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1259


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC192
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State

1260 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OC192 Issue 1, December 2011

• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

EXAMPLES

The following example shows the successful execution of a RMV-OC192


command.
RMV-OC192:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC192
RST-OC192
ED-OC192
ENT-OC192
DLT-OC192

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1261


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC192

1262 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OC3


Command Name: RMV-OC3

PURPOSE
The RMV-OC3 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OC3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1263


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC3
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1264 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OC3 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-OC3


command.
RMV-OC3:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC3
RST-OC3
ED-OC3
ENT-OC3
DLT-OC3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1265


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC3

1266 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OC48


Command Name: RMV-OC48

PURPOSE
The RMV-OC48 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OC48:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1267


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC48
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1268 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OC48 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-OC48


command.
RMV-OC48:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC48
RST-OC48
ED-OC48
ENT-OC48
DLT-OC48

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1269


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC48

1270 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OC768


Command Name: RMV-OC768

PURPOSE
The RMV-OC768 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OC768:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1271


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC768
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1272 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OC768 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-OC768


command.
RMV-OC768:NODE-1:43STA1P-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC768
RST-OC768
ED-OC768
ENT-OC768
DLT-OC768

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1273


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OC768

1274 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OCH


Command Name: REMOVE - OCH

PURPOSE
The RMV-OCH command causes the specified facility to be placed in an out-of-service (OOS-MA or
OOS-AUMA) state for maintenance purposes - i.e. detected conditions are set but autonomous alarm
reports are not generated. This could be called a monitoring but non-reporting mode of operation.
Executing a RMV-OCH command causes a state transition for the specified OCH port from:
• IS-NR to OOS-MA

• OOS-AU to OOS-AUMA

When an OCH port is in an OOS-MA or OOS-AUMA state,


• all OCH port transmission condition types are cleared and a MAN condition type is set for the
specified OCH port.

• no OCH port transmission condition types or performance monitoring threshold crossing alerts are
autonomously reported for the OCH port, but OCH port alarm conditions are monitored and
performance monitoring data is collected (if provisioned for PM collection) for the OCH port

When an OTSOCH port is placed OOS the alarm and TCA reporting for both directions of
transmisssion are suppressed.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OCH:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1275


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OCH

AID Value Description


OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)
WR-<shelf>-<slot>-ADDIN{1-8} (WR8-88A ADDIN Ports)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OCH.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1276 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OCH Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• the user is attempting to provision the OCH to the OOS state that is already OOS,

EXAMPLES
The following example shows the successful execution of a RMV-OCH command.

RMV-OCH:NODE-1:OPS-1-2-SIG:123456;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* RMV-OCH */
;

RELATED COMMANDS
DLT-OCH
ED-OCH
ENT-OCH
RST-OCH
RTRV-OCH

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1277


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OCH

1278 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OTS


Command Name: REMOVE - OTS

PURPOSE
The RMV-OTS command causes the specified facility to be placed in an out-of-service (OOS-MT or
OOS-AUMA) state for maintenance purposes - i.e. detected conditions are set but autonomous alarm
reports are not generated. This could be called a monitoring but non-reporting mode of operation.
Executing a RMV-OTS command causes a state transition for the specified OTS port from:
• IS-NR to OOS-MA

• OOS-AU to OOS-AUMA

When an OTS port is in an OOS-MA or OOS-AUMA state,


• all OTS port transmission condition types are cleared and a MAN condition type is set for the
specified OTS port.

• no OTS port transmission condition types or performance monitoring threshold crossing alerts are
autonomously reported for the OTS port, but OTS port alarm conditions are monitored and
performance monitoring data is collected (if provisioned for PM collection) for the OTS port

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OTS:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1279


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTS

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Ports)
LINE, OSC}
OSCT-<shelf>-<slot>-{SIG, LINE, (OSCT Managed Ports)
OSCSFP}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Optical Ports)
LINEOUT}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OTS.

1280 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OTS Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• the user is attempting to provision the OTS port to the OOS state that is already OOS

EXAMPLES
The following example shows the successful execution of a RMV-OTS command.

1830PSS R3.6.50 - TL1 Commands and Messages 1281


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTS

RMV-OTS:NODE-1:ALPHG-1-2-LINE:789012;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* RMV-OTS:NODE-1:ALPHG-1-2-LINE:789012; */
;

RELATED COMMANDS
DLT-OTS
ED-OTS
ENT-OTS
RST-OTS
RTRV-OTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1282 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OTU1


Command Name: RMV-OTU1

PURPOSE
The RMV-OTU1 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OTU1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1283


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU1
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1284 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OTU1 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-OTU1


command.
RMV-OTU1:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU1
RST-OTU1
ED-OTU1
ENT-OTU1
DLT-OTU1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1285


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU1

1286 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OTU2


Command Name: RMV-OTU2

PURPOSE
The RMV-OTU2 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OTU2:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1287


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU2

AID Value Description


11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1288 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OTU2 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

EXAMPLES

The following example shows the successful execution of a RMV-OTU2


command.
RMV-OTU2:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU2
RST-OTU2
ED-OTU2
ENT-OTU2
DLT-OTU2

1830PSS R3.6.50 - TL1 Commands and Messages 1289


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU2
RELATED AUTONOMOUS RESPONSES
REPT DBCHG

1290 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OTU3


Command Name: RMV-OTU3

PURPOSE
The RMV-OTU3 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OTU3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1291


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU3

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1292 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OTU3 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-OTU3


command.
RMV-OTU3:NODE-1:43STX4-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU3
RST-OTU3
ED-OTU3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1293


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU3

1294 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-OTU4


Command Name: RMV-OTU4

PURPOSE
The RMV-OTU4 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-OTU4:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1295


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU4

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1296 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-OTU4 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-OTU4


command.
RMV-OTU4:NODE-1:112SCA1-1-5-L1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU4
RST-OTU4
ED-OTU4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1297


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-OTU4

1298 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-STM16


Command Name: RMV-STM16

PURPOSE
The RMV-STM16 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-STM16:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1299


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM16
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1300 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-STM16 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-STM16


command.
RMV-STM16:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM16
RST-STM16
ED-STM16
ENT-STM16
DLT-STM16

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1301


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM16

1302 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-STM1


Command Name: RMV-STM1

PURPOSE
The RMV-STM1 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-STM1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1303


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM1
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1304 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-STM1 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-STM1


command.
RMV-STM1:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM1
RST-STM1
ED-STM1
ENT-STM1
DLT-STM1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1305


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM1

1306 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-STM256


Command Name: RMV-STM256

PURPOSE
The RMV-STM256 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-STM256:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1307


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM256
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1308 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-STM256 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-STM256


command.
RMV-STM256:NODE-1:43STA1P-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM256
RST-STM256
ED-STM256
ENT-STM256
DLT-STM256

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1309


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM256

1310 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-STM4


Command Name: RMV-STM4

PURPOSE
The RMV-STM4 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-STM4:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1311


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM4
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

1312 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-STM4 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RMV-STM4


command.
RMV-STM4:NODE-1:11STM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM4
RST-STM4
ED-STM4
ENT-STM4
DLT-STM4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1313


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM4

1314 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RMV-STM64


Command Name: RMV-STM64

PURPOSE
The RMV-STM64 command places the specified facility in the administrative maintenance state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. All transmission conditions are cleared and a MAN condition is set for the port.
When a port is in maintenance state, autonomous reporting is disabled for transmission conditions and
performance monitoring threshold crossing alerts. However, conditions are monitored and can be
retrieved. PM data is collected (if provisioned for collection) and can be retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RMV-STM64:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1315


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM64
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAOS Status, Already Out of Service
• this command is issued on a facility that is in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State

1316 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RMV-STM64 Issue 1, December 2011

• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is in OOS-AU, AINS state

EXAMPLES

The following example shows the successful execution of a RMV-STM64


command.
RMV-STM64:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM64
RST-STM64
ED-STM64
ENT-STM64
DLT-STM64

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1317


8DG61100 EAAAQZZA
Issue 1, December 2011 RMV-STM64

1318 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-100GBE


Command Name: RST-100GBE

PURPOSE
The RST-100GBE command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-100GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1319


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-100GBE
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1320 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-100GBE Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-100GBE


command.
RST-100GBE:NODE-1:112SCA1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-100GBE
RMV-100GBE
ED-100GBE
ENT-100GBE
DLT-100GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1321


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-100GBE

1322 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-10GBE


Command Name: RST-10GBE

PURPOSE
The RST-10GBE command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-10GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: Entry Required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1323


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-10GBE
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a 11DPE12 pack not working under qinq mode

SAIS Status, Already In Service

1324 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-10GBE Issue 1, December 2011

• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a RST-10GBE


command.
RST-10GBE:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-10GBE
RMV-10GBE
ED-10GBE
ENT-10GBE
DLT-10GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1325


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-10GBE

1326 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-1GBE


Command Name: RST-1GBE

PURPOSE
The RST-1GBE command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-1GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1327


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-1GBE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1328 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-1GBE Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-1GBE


command.
RST-1GBE:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-1GBE
RMV-1GBE
ED-1GBE
ENT-1GBE
DLT-1GBE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1329


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-1GBE

1330 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-CBR2G5


Command Name: RST-CBR2G5

PURPOSE
The RST-CBR2G5 command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-CBR2G5:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1331


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-CBR2G5
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1332 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-CBR2G5 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-CBR2G5


command.
RST-CBR2G5:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBR2G5
RMV-CBR2G5
ED-CBR2G5
ENT-CBR2G5
DLT-CBR2G5

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1333


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-CBR2G5

1334 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-CBRAR


Command Name: RST-CBRAR

PURPOSE
The RST-CBRAR command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-CBRAR:[TID]:AID:[CTAG]:::DATATYPE=;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1335


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-CBRAR

DATATYPE= Value Description


{HDSDI, FE, SDSDI, 3GSDI}

Default: Entry required


Addressing: None
Description: Specifies the client signal type. Must equal the value previously
assigned by ENT-CBRAR.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a DATATYPE value that does not match the provisioned signal type

SAIS Status, Already In Service


• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State

1336 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-CBRAR Issue 1, December 2011

• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a RST-CBRAR


command.
RST-CBRAR:NODE-1:4DPA4-1-2-C1:xyz123:::DATATYPE=FE;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-CBRAR
RMV-CBRAR
ED-CBRAR
ENT-CBRAR
DLT-CBRAR

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1337


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-CBRAR

1338 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-EQPT


Command Name: RESTORE EQUIPMENT

PURPOSE
The RST-EQPT command causes the specified equipment to be placed in the in-service management
service state. The command can be applied to an equipment entity that is provisioned as one of the
following.
General Equipment
• First Level Controller (FLC)
• Matrix Zero (MT0C)
Active DWDM Circuit Packs
• Line Driver - LD (ALPHG, AHPHG, AHPLG, ALPFGT, A2325A, AM2017B, AM2325B, AM2125A,
AM2125B, AM2318A, RA2P)
• Optical Supervisory Channel (OSCT)
• Wavelength Tracker Optical Channel Monitoring Card (WTOCM)
• Colorless Wavelength Router (CWR8, CWR8-88)
• Wavelength Router (WR8-88A, WR2-88A)
• Mesh Card (MESH4)
• Optical Translator - OT (112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10, 112SX10L,
11STAR1, 11STMM10, 11STGE12, 43STX4, 43STX4P, 43SCX4L, 43SCX4, 43SCA1, 43STA1P,
4DPA4, 4DPA2, 11QPA4, 11DPE12,11DPE12E, 11DPM12, 11STAR1A)
• Optical Translator - OT
• (112SA1L, 112SCA1, 112SCX10, 112SNA1, 112SNX10, 112SX10L,
• 11DPE12, 11DPE12E, 11DPM12, 11QPA4, 11QPEN4, 11QTA4, 11STAR1,
11STAR1A, 11STGE12, 11STMM10,
• 4DPA2, 4DPA4 )
• Variable Attenuator Card (SVAC, MVAC)
• Optical Protection Switch (OPS)
• Static Filter DWDM (SFD5/8)
• Static Filter CWDM (SFC2/4/8)
Passive DWDM Modules
The "passive" DWDM modules are: SFD44, SFD44B, SFD40, SFD40B, DCM, ITLB, ITLU.
Each of these modules is modeled as the fixed "card" in a "shelf" with only one "slot". But physically,
the shelf/card are not separable. ENT-EQPT is addressed to shelf, but creates both shelf and card.
ITL modules, together with DCM modules of several sizes, fit into single housing. However this
housing is not modeled by the system.
• SFD44. The SFD44 is modeled as the fixed "card" in an SFD "shelf" with only one "slot". But
physically, the SFD44 card/shelf are not separable. The RST-EQPT command is addressed to
the SFD44 "card".
• SFD44B. The SFD44B is modeled as the fixed "card" in an SFD44B "shelf" with only one "slot".
But physically, the SFD44B card/shelf are not separable. The RST-EQPT command is addressed
to the SFD44B "card". The SFD44B carries the 44 odd channels, which in addition to the 44 even
channels from a SFD44 supports an 88 channel optical line.

1830PSS R3.6.50 - TL1 Commands and Messages 1339


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-EQPT
• SFD40. The SFD40 is modeled as the fixed "card" in an SFD "shelf" with only one "slot". But
physically, the SFD40 card/shelf are not separable. The RST-EQPT command is addressed to
the SFD40 "card".
• SFD40B. The SFD40B is modeled as the fixed "card" in an SFD40B "shelf" with only one "slot".
But physically, the SFD40B card/shelf are not separable. The RST-EQPT command is addressed
to the SFD40B "card". The SFD40B carries the 40 odd channels, which in addition to the 40 even
channels from a SFD40 supports an 80 channel optical line.
• DCM. The DCM is modeled as the fixed "card" in a DCM "shelf" with only one "slot". But
physically, multiple DCM modules of several sizes fit into a single housing. The RST-EQPT
command is addressed to the DCM "card".
• ITLB/ITLU. The ITLB/ITLU is modeled as the fixed "card" in an ITLB/ITLU "shelf" with only one
"slot". But physically, multiple ITLB/ITLU and DCM modules of several sizes fit into a single
housing. The RST-EQPT command is addressed to the DCM "card".
The RST-EQPT command causes the specified equipment to be placed in the administrative in-service
state. Secondary states depend upon events detected by the system.
This command allows any active condition declared against the equipment to be autonomously
reported.
The successful completion of the command shall cause REPT^DBCHG autonomous messages.

INPUT FORMAT

RST-EQPT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1340 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-EQPT Issue 1, December 2011

AID Value Description


FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 1341


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-EQPT

AID Value Description


MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)

Default: Entry required


Addressing: None
Description: Equipment Access Identifier, identifies the equipment entity access
identifier

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1342 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-EQPT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
EQWT EQuipage, Wrong Type
• the command is input for an AID which is different from the one provisioned in the corresponding
slot

IENE Input, Entity Not Exists


• the equipment entity is not provisioned

SAIS Status, Already In Service


• the RST-EQPT command is entered for a module whose service state is IS or OOS-AU

EXAMPLES
In the following example, an OT is restored to administrative in-service state.

RST-EQPT::11STAR1-2-5;

RELATED COMMANDS
DLT-EQPT
ED-EQPT
ENT-EQPT
RMV-EQPT
RTRV-EQPT

1830PSS R3.6.50 - TL1 Commands and Messages 1343


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-EQPT

1344 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-FC100


Command Name: RST-FC100

PURPOSE
The RST-FC100 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-FC100:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1345


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC100
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1346 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-FC100 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-FC100


command.
RST-FC100:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC100
RMV-FC100
ED-FC-100
ENT-FC100
DLT-FC100

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1347


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC100

1348 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-FC1200


Command Name: RST-FC1200

PURPOSE
The RST-FC1200 command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-FC1200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1349


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC1200
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1350 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-FC1200 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-FC1200


command.
RST-FC1200:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC1200
RMV-FC1200
ED-FC1200
ENT-FC1200
DLT-FC1200

RELATED AUTONOMOUS RESPONSES


None
REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1351


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC1200

1352 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-FC200


Command Name: RST-FC200

PURPOSE
The RST-FC200 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-FC200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1353


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC200
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1354 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-FC200 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-FC200


command.
RST-FC200:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC200
RMV-FC200
ED-FC200
ENT-FC200
DLT-FC200

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1355


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC200

1356 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-FC400


Command Name: RST-FC400

PURPOSE
The RST-FC400 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-FC400:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 clietn ports)
0

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1357


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC400
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1358 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-FC400 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-FC400


command.
RST-FC400:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC400
RMV-FC400
ED-FC400
ENT-FC400
DLT-FC400

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1359


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC400

1360 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-FC800


Command Name: RST-FC800

PURPOSE
The RST-FC800 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-FC800:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1361


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC800
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1362 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-FC800 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-FC800


command.
RST-FC800:NODE-1:112SCX10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FC800
RMV-FC800
ED-FC800
ENT-FC800
DLT-FC800

RELATED AUTONOMOUS RESPONSES


None
REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1363


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FC800

1364 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-FE


Command Name: RST-FE

PURPOSE
The RST-FE command command causes the specified facility client/line to be placed in an IS-NR,
IS-ANR or OOS-AU state.
Executing a RST-FE command causes a state transition for the specified port from:
OOS-MA to IS-NR or IS-ANR
OOS-AUMA to OOS-AU
When an FE port is in an OOS-MA or OOS-AUMA state, all transmission condition types are cleared
and a MAN condition type is set for the specified FE port.
When an FE port transits from the OOS-MA or OOS-AUMA to an IS-NR, IS-ANR or OOS-AU state, the
MAN condition type is cleared, any existing FE port condition types are set.
The RST-FE command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-FE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1365


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1366 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-FE Issue 1, December 2011

Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a RST-FE


command.
RST-FE:NODE-1:11DPE12E-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-FE
RMV-FE
ED-FE
ENT-FE
DLT-FE

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1367


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-FE

1368 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OC12


Command Name: RST-OC12

PURPOSE
The RST-OC12 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OC12:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1369


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC12
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1370 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OC12 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-OC12


command.
RST-OC12:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC12
RMV-OC12
ED-OC12
ENT-OC12
DLT-OC12

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1371


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC12

1372 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OC192


Command Name: RST-OC192

PURPOSE
The RST-OC192 command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OC192:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1373


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC192

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

1374 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OC192 Issue 1, December 2011

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a RST-OC192


command.
RST-OC192:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC192
RMV-OC192
ED-OC192
ENT-OC192
DLT-OC192

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1375


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC192

1376 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OC3


Command Name: RST-OC3

PURPOSE
The RST-OC3 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OC3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1377


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC3
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1378 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OC3 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-OC3


command.
RST-OC3:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC3
RMV-OC3
ED-OC3
ENT-OC3
DLT-OC3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1379


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC3

1380 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OC48


Command Name: RST-OC48

PURPOSE
The RST-OC48 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OC48:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1381


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC48
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1382 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OC48 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-OC48


command.
RST-OC48:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC48
RMV-OC48
ED-OC48
ENT-OC48
DLT-OC48

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1383


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC48

1384 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OC768


Command Name: RST-OC768

PURPOSE
The RST-OC768 command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OC768:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1385


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC768
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

1386 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OC768 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-OC768


command.
RST-OC768:NODE-1:43STA1P-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OC768
RMV-OC768
ED-OC768
ENT-OC768
DLT-OC768

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1387


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OC768

1388 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OCH


Command Name: RESTORE - OCH

PURPOSE
The RST-OCH command causes the specified facility to be placed in an IS-NR or OOS-AU state.
Executing a RST-OCHcommand causes a state transition for the specified OCH port from:
• OOS-MA to IS-NR

• OOS-AUMA to OOS-AU

When an OCH port transits from the OOS-MA or OOS-AUMA to an IS-NR or OOS-AU state, the MAN
condition type is cleared, any existing OCH port condition types are set.
When an OCH port transits from the OOS-MA or OOS-AUMA to an IS-NR or OOS-AU state,
performance monitoring threshold crossing alerts are enabled (if provisioned for PM collection) for the
specified OCH port.
When the OCH port was placed OOS the alarm and TCA reporting for both directions of transmisssion
were suppressed.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OCH:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1389


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OCH

AID Value Description


OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 Colorless Ports)
WR-<shelf>-<slot>-ADDIN{1-8} (WR8-88A ADDIN Ports)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OCH.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1390 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OCH Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• the user is attempting to provision the OCH to the IS state that is already IS,

EXAMPLES
The following example shows the successful execution of a RST-OCH command.

RST-OCH:NODE-1:OPS-1-2-SIG:123456;
<
NODE-1 06-06-30 08:00:00
M 123456 COMPLD
/* RST-OCH */
;

RELATED COMMANDS
DLT-OCH
ED-OCH
ENT-OCH
RMV-OCH
RTRV-OCH

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1391


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OCH

1392 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OTS


Command Name: RESTORE - OTS

PURPOSE
The RST-OTS command causes the specified facility to be placed in an IS-NR or OOS-AU state.
Executing a RST-OTS command causes a state transition for the specified OTS port from:
• OOS-MA to IS-NR

• OOS-AUMA to OOS-AU

When an OTS port transits from the OOS-MA or OOS-AUMA to an IS-NR or OOS-AU state, the MAN
condition type is cleared, any existing OTS port condition types are set.
When an OTS port transits from the OOS-MA or OOS-AUMA to an IS-NR or OOS-AU state,
performance monitoring threshold crossing alerts are enabled (if provisioned for PM collection by the
SET-PMMODE-OTS command) for the specified OTS port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OTS:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1393


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTS

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Ports)
LINE, OSC}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Optical Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, (OSCT Managed Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OTS.

1394 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OTS Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• the user is attempting to provision the OTSPORT to the IS state that is already IS,

EXAMPLES
The following example shows the successful execution of a RST-OTS command.

1830PSS R3.6.50 - TL1 Commands and Messages 1395


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTS

RST-OTS:NODE-1:ALPHG-1-2-LINE:789012;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
/* RST-OTS:NODE-1:ALPHG-1-2-LINE:789012; */
;

RELATED COMMANDS
DLT-OTS
ED-OTS
ENT-OTS
RMV-OTS
RTRV-OTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1396 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OTU1


Command Name: RST-OTU1

PURPOSE
The RST-OTU1 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OTU1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1397


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU1
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1398 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OTU1 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-OTU1


command.
RST-OTU1:NODE-1:11STMM10-1-5-L1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU1
RMV-OTU1
ED-OTU1
ENT-OTU1
DLT-OTU1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1399


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU1

1400 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OTU2


Command Name: RST-OTU2

PURPOSE
The RST-OTU2 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OTU2:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1401


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU2

AID Value Description


11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

1402 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OTU2 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a RST-OTU2


command.
RST-OTU2:NODE-1:11STAR1-1-5-L1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU2
RMV-OTU2
ED-OTU2
ENT-OTU2
DLT-OTU2

1830PSS R3.6.50 - TL1 Commands and Messages 1403


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU2
RELATED AUTONOMOUS RESPONSES
REPT DBCHG

1404 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OTU3


Command Name: RST-OTU3

PURPOSE
The RST-OTU3 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OTU3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1405


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU3

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1406 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OTU3 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-OTU3


command.
RST-OTU3:NODE-1:43STX4-1-5-L1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU3
RMV-OTU3
ED-OTU3

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1407


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU3

1408 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-OTU4


Command Name: RST-OTU4

PURPOSE
The RST-OTU4 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-OTU4:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1409


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU4
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1410 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-OTU4 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-OTU4


command.
RST-OTU4:NODE-1:112SCX10-1-5-L1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-OTU4
RMV-OTU4
ED-OTU4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1411


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-OTU4

1412 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-STM16


Command Name: RST-STM16

PURPOSE
The RST-STM16 command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-STM16:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1413


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM16
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1414 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-STM16 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-STM16


command.
RST-STM16:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM16
RMV-STM16
ED-STM16
ENT-STM16
DLT-STM16

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1415


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM16

1416 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-STM1


Command Name: RST-STM1

PURPOSE
The RST-STM1 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-STM1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1417


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM1
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1418 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-STM1 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-STM1


command.
RST-STM1:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM1
RMV-STM1
ED-STM1
ENT-STM1
DLT-STM1

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1419


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM1

1420 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-STM256


Command Name: RST-STM256

PURPOSE
The RST-STM256 command command causes the specified facility client/line to be placed in an
IS-NR, IS-ANR or OOS-AU state.
Executing a RST-STM256 command causes a state transition for the specified port from:
OOS-MA to IS-NR or IS-ANR
OOS-AUMA to OOS-AU
When an STM256 port is in an OOS-MA or OOS-AUMA state, all transmission condition types are
cleared and a MAN condition type is set for the specified STM256 port.
When an STM256 port transits from the OOS-MA or OOS-AUMA to an IS-NR, IS-ANR or OOS-AU
state, the MAN condition type is cleared, any existing STM256 port condition types are set.
The RST-STM256 command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-STM256:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1421


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM256

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1422 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-STM256 Issue 1, December 2011

Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

EXAMPLES

The following example shows the successful execution of a RST-STM256


command.
RST-STM256:NODE-1:1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

The following example shows the successful execution of a RST-STM256


command.
RST-STM256:NODE-1:43STA1P-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM256
RMV-STM256
ED-STM256
ENT-STM256
DLT-STM256

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1423


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM256

1424 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-STM4


Command Name: RST-STM4

PURPOSE
The RST-STM4 command places the specified facility in the administrative in-service state. Executing
this command causes a state transition, with specific PST/SST values determined by dynamic events.
Any MAN is cleared. Autonomous reporting is enabled for transmission conditions and performance
monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-STM4:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1425


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM4
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

1426 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-STM4 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RST-STM4


command.
RST-STM4:NODE-1:11STMM10-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM4
RMV-STM4
ED-STM4
ENT-STM4
DLT-STM4

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1427


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM4

1428 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RST-STM64


Command Name: RST-STM64

PURPOSE
The RST-STM64 command places the specified facility in the administrative in-service state.
Executing this command causes a state transition, with specific PST/SST values determined by
dynamic events. Any MAN is cleared. Autonomous reporting is enabled for transmission conditions
and performance monitoring threshold crossing alerts.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RST-STM64:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 1429


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM64

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS
There are no output parameters for this command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
SAIS Status, Already In Service
• this command is issued on a facility that is not in OOS-MA or OOS-AUMA state,

SNVS Status, Not in Valid State


• the facility specified in the AID field is not provisioned

1430 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RST-STM64 Issue 1, December 2011

• this command is issued on a facility that is under loopback, i.e. carries a LPBK secondary state,

EXAMPLES

The following example shows the successful execution of a RST-STM64


command.
RST-STM64:NODE-1:11STAR1-1-5-C1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
RTRV-STM64
RMV-STM64
ED-STM64
ENT-STM64
DLT-STM64

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1431


8DG61100 EAAAQZZA
Issue 1, December 2011 RST-STM64

1432 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-100GBE


Command Name: RTRV-100GBE

PURPOSE
The RTRV-100GBE command shall be used to retrieve all parameters related to the 100GBE client
port. The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-100GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1433


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-100GBE
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,
MODULETYPE=<value>][,LOSPROP=<value>][,DESCR=<value>][,RXPOWER=<valu
e>][,TXPOWER=<value>]:<PST> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSCNTDWN (AINS Count Down), this is the time remaining to


transition out of AINS. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: Automatic In-Service Timer Count Down value, specifies how


much time is currently remaining on the AINS timer before the
facility is placed in service.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

1434 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-100GBE Issue 1, December 2011

Description: AINSTMR, transition soak time out of AINS. Format is


HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01.
Setting a value for AINSTMR will cause the value of AINSREF to
be set to OVRD.

MODULETYPE= Value Description


{AUTO, USER, C113G10C, C113G4C,
C113G4CD}

Description: Attribute that defines the pluggable


module type used in providing the physical layer
function on the specified GBE100 port. If the value
AUTO is chosen, the NE shall accept the pluggable
module type inserted in the socket if the previous
MODULETYPE value was <null>.
If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set
to USER.

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

1830PSS R3.6.50 - TL1 Commands and Messages 1435


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-100GBE

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1436 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-100GBE Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a


RTRV-100GBE command.
RTRV-100GBE:NODE-1:112SCA1-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"112SCA1-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,MODUL
ETYPE=C113G10C,LOSPROP=LASERON,DESCR=\"\",RXPOWER=-5.5,TXPOWER=-2.44
:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-100GBE
RTRV-100GBE
RST-100GBE
DLT-100GBE
ED-100GBE
RMV-100GBE

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 1437


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-100GBE

1438 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-10GBE


Command Name: RTRV-10GBE

PURPOSE
The RTRV-10GBE command shall be used to retrieve all parameters related to the 10GBE client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-10GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1439


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-10GBE
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,CHANNEL=<value>][, ENCMODE=<value>][,MULTICASTTO=<value>][,
MODULETYPE=<value>][,ERRFRMDROP=<value>][,LOSPROP=<value>][,STPID=<v
alue>][[,DESCR=<value>][,RXPOWER=<value>][,TXPOWER=<value>]:<PST>
[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

1440 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-10GBE Issue 1, December 2011

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSCNTDWN (AINS Count Down), this is the time remaining to


transition out of AINS. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: Automatic In-Service Timer Count Down value, specifies how


much time is currently remaining on the AINS timer before the
facility is placed in service.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, transition soak time out of AINS. Format is


HOURS-MINUTES. The maximum time is 96-00. The minimum
time is 00-01.
Setting a value for AINSTMR will cause the value of AINSREF to
be set to OVRD.

1830PSS R3.6.50 - TL1 Commands and Messages 1441


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-10GBE

CHANNEL= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies;)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the port.


The DWDM frequences only apply to the 11DPE12 and
11DPE12E line AID

ENCMODE= Value Description


{CBRLAN11.049,CBRLAN11.096,GFP-
F,GFP-P}

Description: The parameter encmode describes the encapsulation mode used


to transport the client signal.
CBRLAN11.049 Constant Bit Rate
CBRLAN11.096 Constant Bit Rate
GFP-F Generic Framing Protocol (ITU-T G.7041)
GFP-P Generic Framing Protocol - Proprietary Option - it
preserve client Ethernet frame Preamble.
For the 43STX4 and 43STX4P OTs, the only supported values for
ENCMODE are {GFP-F, GFP-P}
For the 43SCX4L OT or 43SCX4OT, the supported values for
ENCMODE are {CBRLAN11.049, CBRLAN11.096, GFP-F,
GFP-P}
For the 11QTA4 OT, the supported values for ENCMODE are
{CBRLAN11.096, GFP-F}
This parameter doesn't apply to 11DPE12 and 11DPE12E line side

1442 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-10GBE Issue 1, December 2011

MULTICASTTO= Value Description


{Any combination of L1, L2, L3, and L4
separated by space, None}

Default: NONE
Description: the destination MulticastTo line ports for this client port. Only
applied to 11QPA4 client ports C1-4.

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for 11STAR1, 43STX4,
43STX4P, 43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for 112SCX10, 112SNX10,
and 112SX10L OTs.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for the 11QPA4 OT.
{AUTO, USER, 10GB-ZR, 10GB-SR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C} for the 11QTA4 OT.
{AUTO, USER, 10GB-SR,10GB-ZR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C, XL-64.2D, XL-64TU} for the
11DPE12 OT.
{AUTO, USER, 10GB-SR ,10GB-ZR,
XI-64.1, XS-64.2B, XS-64.2C,
XL-64.2C, XL-64.2D, XL-64TU} for the
11DPE12E OT.

Description: Attribute that defines the pluggable


module type used in providing the physical layer
function on the specified GBE10 port. If the value
AUTO is chosen, the NE shall accept the pluggable
module type inserted in the socket if the previous
MODULETYPE value was <null>.
If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set
to USER.

ERRFRMDROP= Value Description


{ENABLED, DISABLED}

Description: Attribute that controls whether inbound error frames are discarded
or passed. This attribute is meaningfull only for GFP transport
modes.

1830PSS R3.6.50 - TL1 Commands and Messages 1443


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-10GBE

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: STPID1
Address: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal

1444 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-10GBE Issue 1, December 2011

OOS-AU Out Of Service - AUtonomous


OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• this command is issued with a 11DPE12 pack not working under qinq mode

1830PSS R3.6.50 - TL1 Commands and Messages 1445


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-10GBE
EXAMPLES

The following example shows the successful execution of a RTRV-10GBE


command.
RTRV-10GBE:NODE-1:11STAR1-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STAR1-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,ENCMO
DE=GFP_F,MODULETYPE=XI-64.1,,ERRFRMDROP=DISABLE,LOSPROP=LASERON,DESC
R=\"\",RXPOWER=-5.5,TXPOWER=-2.44:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-10GBE
RTRV-10GBE
RST-10GBE
DLT-10GBE
ED-10GBE
RMV-10GBE

RELATED AUTONOMOUS RESPONSES


none

1446 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-1GBE


Command Name: RTRV-1GBE

PURPOSE
The RTRV-1GBE command shall be used to retrieve all parameters related to the GE client port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-1GBE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1447


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-1GBE
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,ENCMODE=<value>][,ERRFRMDROP=<value>][,AUTONEG=<value>][,LOSPROP=<v
alue>][,MODULETYPE=<value>][,CHANNEL=<value>][,STPID=<value>][,DESCR
=<value>][,TS=\"<value>\"][,RXPOWER=<value>][,TXPOWER=<value>][,CONT
AINER=<value>]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition out of AINS.

1448 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-1GBE Issue 1, December 2011

SYSTEM use the system level timer.


OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR will cause the value of AINSREF to
be set to OVRD.

ENCMODE= Value Description


{GFP-F,GFP-T}

Description: The parameter encmode describes the encapsulation mode used


to transport the client signal.
GFP-F Generic Framing Protocol (ITU-T G.7041)
GFP-T Generic Framing Protocol - Transparent
encapsulation.
Only GFP-T is supported by the 11STMM10 OT.
Only GFP-T is supported by the 4DPA4 OT.
This parameter is not supported on the 11STGE12 and 4DPA2
OTs.
This parameter is not supported on the 11DPE12 and 11DPE12E
OTs.

ERRFRMDROP= Value Description


{ENABLED, DISABLED}

Description: Attribute that controls whether inbound error frames are discarded
or passed.
This attribute is meaningful only for GFP transport modes.
This parameter does not apply to the 11STGE12 OT. It does not
apply to the 4DPA4 and 4DPA2 OT.
This parameter does not apply to the 11DPE12 and 11DPE12E
OTs.

AUTONEG= Value Description


{ENABLED, DISABLED}

Description: Attribute that controls status of auto-negotiation.

1830PSS R3.6.50 - TL1 Commands and Messages 1449


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-1GBE
The AUTONEG parameter only applies to the 11STGE12 OT. It
does not apply to the 11STMM10 OT. It does not apply to the
4DPA4 and 4DAP2 OT.

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.
Parameter LOSPROP does not apply to 4DPA2 OT.

MODULETYPE= Value Description


{AUTO, USER, 1000B-LX, 1000B-SX,
1000B-T, 1000B-ZX, SL-16.2C,
SL-16.2D, SS-16.1A, SS-16.2C,
GE-BX20D, GE-BX20U, GE-BX40D,
GE-BX40U}

Description: Attribute that defines the pluggable module type used in providing
the physical layer function on the specified GBE port. If the value
AUTO is chosen, the NE shall accept the pluggable module type
inserted in the socket if the previous MODULETYPE value was
<null>. If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set to USER.
Note: SS-16.2C is not supported on 11STGE12 OT.
1000B-ZX is not supported on 4DPA2 OT.
SL-16.2C, SS-16.2C, and SL-16.2D are the
only types supported on the line port of 4DPA2 OT.
SL-16.2D is not supported on the client
ports of 4DPA2 , 4DPA4 , 11STMM10 and 11STGE12 OTs.
GE-BX20D, GE-BX20U, GE-BX40D, GE-BX40U are
supported only by 4DPA4 OT client ports.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: STPID1
Address: None

1450 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-1GBE Issue 1, December 2011

Description: The STPID (SVLAN Tag Protocol Identifier) can be selected


between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13,16,19,22,25,2
8} (11STMM10 timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)
{L1,L2}-({1,2}) (4DPA4 timeslots)
0-0 (unassigned 4DPA4 timeslot)

Description: Timeslot assignment.


11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4 : Timeslot assignment on the specified Line port (L1 or
L2). Timeslot 1 represents the eight odd timeslots of ODU0 #1
within the specified line. (Timeslots 1,3,5,7,9,11,13,15.) Timeslot
2 represents the eight even timeslots of ODU0 #2 within the
specified line. (Timeslots 2,4,6,8,10,12,14,16.)
The TS parameter is not supported on the 11STGE12 and 4DPA2
OTs.
This parameter does not apply to the 11DPE12 and 11DPE12E
OTs.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

1830PSS R3.6.50 - TL1 Commands and Messages 1451


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-1GBE
Description: TXPOWER, Transmit Power. Measured optical transmit power
(dBm).

CONTAINER= Value Description


{None, ODU0}

Description: Specifies the granularity for client GbE mapping to ODU2


multiplexing structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

1452 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-1GBE Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-1GBE


command.
RTRV-1GBE:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD

"11STMM10-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,ENCM
ODE=GFP_T,,ERRFRMDROP=DISABLE,AUTONEG=DISABLE,LOSPROP=LASERON,MODULE
TYPE=AUTO,CHANNEL=1471,DESCR=\"\",TS="ODU1-L1-2-22",RXPOWER=-5.5,TXP
OWER=-2.44:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-1GBE
RTRV-1GBE
RST-1GBE
DLT-1GBE
ED-1GBE
RMV-1GBE

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 1453


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-1GBE

1454 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ALM-ALL


Command Name: RETRIEVE ALARM ALL

PURPOSE
The RTRV-ALM-ALL command retrieves the current status of any existing, reported alarm conditions
in the system, or any alarm conditions matching a specified combination of position-defined input
parameters.
The RTRV-ALM-ALL command excludes customer environmental alarms, that are in the scope of the
RTRV-ALM-ENV command.
The alarm conditions to be retrieved can be specified by using the input parameters NTFCNCDE
and/or CONDTYPE as the filter, i.e., existing conditions satisfying all the specified input parameters will
be reported in the message response.
The successful response for a RTRV-ALM-ALL command contains one line of parsable output data for
each alarm condition being reported. If multiple alarm conditions exist, a line of output is provided for
each alarm.
Each equipment entity with alarms is grouped by equipment type and displayed in ascending order of
each of the AID fields (excluding the equipment type field) left to right, and in ascending order by date
and time of occurrence.
Each common (no specific entity) alarm is displayed in ascending order by date and time of
occurrence.
Each facility entity with alarms grouped by facility type displayed in ascending order of the
bay-shelf-slot-facility fields and in ascending order by date and time of occurrence.
Each facility entity with alarms grouped by facility type is displayed in ascending order of each of the
AID fields (excluding the facility type field, if any) left to right, and in ascending order by date and time
of occurrence.
If there are no alarms to report, the system outputs a COMPLD response.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ALM-ALL:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],[SRVEFF],[LOC
N],[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1455


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

AID Value Description


ALL (ALL AID)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm

CONDTYPE Value Description


<a valid condition type for the AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1456 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

SRVEFF Value Description


NSA
SA

Default: <All Values>


Addressing: &-grouping
Description: Service Effect, identifies the effect on service caused by the event.
NSA Nonservice-affecting
SA Service-affecting

LOCN Value Description


NEND
FEND

Default: <All Applicable Locations>


Addressing: &-grouping
Description: Location, identifies the location where the condition type is
monitored.
NEND Near End
FEND Far End

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: &-grouping
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT


Format for the successful response with a single alarm

1830PSS R3.6.50 - TL1 Commands and Messages 1457


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],[<OCR
TM>],[<LOCN>],[<DIRN>],
:[\"<CONDDESCR>\"],[<AIDDET>]:[DATATYPE=<value>]" cr lf]*
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1458 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

AID Value Description


SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Equipment Controller)
EC-1-<slot>-{CIT, ES1, ES2} (EC Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (EC Ports, non-main shelves)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
SLOT-<shelf>-1 (Generic Slot AID in Passive Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Ports)
LINE, OSC}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Ports)
LINE, OSC}

1830PSS R3.6.50 - TL1 Commands and Messages 1459


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

AID Value Description


AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Optical Ports)
OSC, OSCSFP}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)
LINE, OSC}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,

1460 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

AID Value Description


9190, 9185, 9180, 9175, 9170}
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,

1830PSS R3.6.50 - TL1 Commands and Messages 1461


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

AID Value Description


9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Ports)
LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,

1462 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

AID Value Description


9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
DCM-<shelf>-1 (DCM Module)
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1 (ITLB/ITLU Module)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Ports)
THRU, OMD}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Channels)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}-{9605, 9600, 9595,
9590, 9585, 9580, 9575, 9570, 9565,
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,

1830PSS R3.6.50 - TL1 Commands and Messages 1463


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

AID Value Description


9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
SFD-<shelf>-<slot> (SFD5/8 Module)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, OMD, EXP}
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B
9590, 9585, 9580, 9575, 9570, 9565, Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170, OMD}
SFC-<shelf>-<slot> (SFC2/4/8 Module)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 Ports)
1531, 1551, 1571, 1591, 1611, OMD,

1464 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

AID Value Description


EXP}
OPS-<shelf>-<slot> (OPSA Circuit Pack)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STAR1-<shelf>-<slot>-C1-GCC0 (General Communication Channel 0 on
11STAR1 Client Port)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STMM10-<shelf>-<slot>-C{1-10}-GC (General Communication Channel 0 on
C0 11STMM10 Client Ports)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SNA1-<shelf>-<slot>
112SNA1-<shelf>-<slot>-{L1, C1}
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNX10-<shelf>-<slot>
112SNX10-<shelf>-<slot>-{L1, C{1-10}}
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA4-<shelf>-<slot>-L{1-2}-GCC0 (General Communication Channel 0 on

1830PSS R3.6.50 - TL1 Commands and Messages 1465


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

AID Value Description


4DPA4 Line Ports)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1

1466 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

AID Value Description


11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
SYSTEM (System AID)
USRPNL-1-<slot> (User Panel)
USRPNL-1-<slot>-{OAMP, VOIP, E1, (User Panel Ports)
E2, HOUSEKEEPINGIN{1-8},
HOUSEKEEPINGOUT{1-4}}
PF-<shelf>-<slot> (Power Filter)
ACTSW (The active software generic on the NE)
STBYSW (The standby software generic on the
NE)

Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1467


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

AIDTYPE Value Description


1GBE
FE
10GBE
100GBE
COM
CBR2G5
CBRAR
EQPT
FC100
FC200
FC400
FC800
FC1200
OC12
OC3
OC48
OC192
OC768
OCH
ODU1
OPTSG
ODU0
ODU2
ODUF
VTS
ODU3
ODU4
OTS
OTU1
OTU2
OTU3
PLK
STM1
STM4
STM16
STM64
STM256

Description: Identifies the type of AID for the notification being retrieved.

1468 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

NTFCNCDE Value Description


CR
MJ
MN
WR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm

CONDTYPE Value Description


<a valid condition type for the AID>

Description: Condition Type, specifies the reported condition type.


For a list of condition types by AID refer to the "Condition types
Appendix".

SRVEFF Value Description


NSA
SA

Description: Service Effect, identifies the effect on service caused by the event.
NSA Nonservice-affecting
SA Service-affecting

OCRDAT Value Description


{01-12}-{01-31}

Description: Occurrence Date, identifies the date when the event occurred.
<MONTH_OF_YEAR>-<DAY_OF_MONTH>

OCRTM Value Description


{00-23}-{00-59}-{00-59}

Description: Occurrence Time, identifies the time when the event occurred.
<HOUR_OF_DAY>-<MINUTE_OF_HOUR>-<SECOND_OF_MIN
UTE>

1830PSS R3.6.50 - TL1 Commands and Messages 1469


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

LOCN Value Description


NEND
FEND

Description: Location, identifies the location where the condition type is


monitored.
NEND Near End
FEND Far End

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

CONDDESCR Value Description


<1-10 lines of up to 64 characters per
line>

Description: Condition description, The detailed text description of the trouble.

AIDDET Value Description


<0-64 character message associated
with this alarm>

Description: Supplementary equipment identification used to identify the


location of the reported trouble. Reserved for future use.

DATATYPE= Value Description


FE
HDSDI

Description: Client port signal type when modifier is CBRAR.

1470 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ALL Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID
• the AID is invalid

IIFM Invalid Payload block. Invalid Data Format.


• the CONDTYPE is invalid

• any input parameter other than AID, CONDTYPE or NTFCNCDE is invalid

IPNV Invalid NTFCNCDE


• the NTFCNCDE is invalid

EXAMPLES
In the following example, all alarms in the system are retrieved.

RTRV-ALM-ALL::;

The output response is shown below.

1830PSS R3.6.50 - TL1 Commands and Messages 1471


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ALL

G02U> rtrv-alm-all;IP 0
<
G02U 08-10-01 21:53:56
M 0 COMPLD
"EC-1-1,EQPT:MJ,DATAFLT,NSA,09-30,10-58-41,NEND,NA,:\"Card
provisioning failure\",,,:,"
"COM,COM:MN,SWFTDWN,NSA,09-30,10-58-41,NEND,NA,:\"Software
upgrade in progress\",,,:,"
"COM,COM:MN,DBFT,NSA,09-30,10-58-41,NEND,NA,:\"DB Failure
Transport - file transport failure\",,,:,"
"EC-3-1,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-49,NEND,NA,:\"Card
missing\",,,:,"
"PF-3-19,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-51,NEND,NA,:\"Card
missing\",,,:,"
"PF-3-36,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-53,NEND,NA,:\"Card
missing\",,,:,"
"FAN-3-37,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-53,NEND,NA,:\"Card
missing\",,,:,"
"EC-6-1,EQPT:MJ,DATAFLT,NSA,10-01,20-10-15,NEND,NA,:\"Card
provisioning failure\",,,:,"
"PF-6-36,EQPT:CR,REPLUNITMISS,SA,10-01,20-10-21,NEND,NA,:\"Card
missing\",,,:,"
"ALPHG-6-3,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,:\"Card
failure - communication\",,,:,"
"PF-6-19,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,:\"Card
failure - communication\",,,:,"
"FAN-6-37,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,:\"Card
failure - communication\",,,:,"
"EC-6-1,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,:\"Card failure
- communication\",,,:,"
"ALPHG-6-2,EQPT:CR,CONTCOM,SA,10-01,21-02-14,NEND,NA,:\"Card
failure - communication\",,,:,"
"EC-7-1,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-39,NEND,NA,:\"Card
missing\",,,:,"
"PF-7-19,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-42,NEND,NA,:\"Card
missing\",,,:,"
"PF-7-36,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-44,NEND,NA,:\"Card
missing\",,,:,"
"FAN-7-37,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-44,NEND,NA,:\"Card
missing\",,,:,"
/* RTRV-ALM-ALL */
;

RELATED COMMANDS
RTRV-COND-ALL

1472 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ALM-ENV


Command Name: RETRIEVE ALARM ENVIRONMENT

PURPOSE
The RTRV-ALM-ENV command retrieves the current state of any existing environmental alarm
condition on one external input point or on all external input points.
The successful response for a RTRV-ALM-ENV command contains one line of parsable output data
for each environmental alarm condition being reported. If multiple alarm conditions exist, a line of
output is provided for each environmental alarm, in ascending order by time of occurrence (the newest
posted alarms will be displayed last).
If there are no alarms to report, the system outputs a COMPLD response.

INPUT FORMAT

RTRV-ALM-ENV:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

AID Value Description


PF-1-44-HOUSEKEEPINGIN{1-8} (PSS-36 External Input Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-32 User Panel External Input
1-8} Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-16 User Panel External Input
1-6} Points)
ALL

Default: ALL
Addressing: None
Description: Access IDentifier

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1473


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ENV
Default: <System Assigned CTAG Value>
Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<NTFCNCDE>,<OCRDAT>,<OCRTM>,\"<ALMMSG>\"" cr lf]*
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


PF-1-44-HOUSEKEEPINGIN{1-8} (PSS-36 External Input Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-32 User Panel External Input
1-8} Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-16 User Panel External Input
1-6} Points)

Description: Access IDentifier.

NTFCNCDE Value Description


CR
MJ
MN

Description: The notification code of the alarm. Values are:


CR critical alarm
MJ major alarm
MN minor alarm

OCRDAT Value Description


{01-12} - {01-31}

Description: Occurrence Date, identifies the date when the condition occurred.
The format of OCRDAT is <MONTH_OF_YEAR> -
<DAY_OF_MONTH >.

1474 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-ENV Issue 1, December 2011

OCRTM Value Description


{00-23} - {00-59} - {00-59}

Description: Occurrence Time, identifies the time when the condition occurred.
The format of OCRTM is < HOUR_OF_DAY> -
<MINUTE_OF_HOUR> -< SECOND_OF_MINUTE>.

ALMMSG Value Description


<0-56 characters>

Description: Alarm Message. Alarm message is the text message associated


with the environmental alarm as provisioned by SET-ATTR-ENV.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
^^^/* <EXPANDED ERROR CODE DESCRIPTION> */ cr lf
[^^^/* <OPTIONAL FREE FORMAT TEXT> */ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following command would be used to retrieve the environmental alarms on
USRPNL-1-40-HOUSEKEEPINGIN1

RTRV-ALM-ENV:SHERLOCK:USRPNL-1-40-HOUSEKEEPINGIN1;

1830PSS R3.6.50 - TL1 Commands and Messages 1475


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-ENV

cr lf lf
^^^SHERLOCK^ 01-03-16^ 03:14:32 cr lf
M^^C0236^COMPLD cr lf
^^^"USRPNL-1-40-HOUSEKEEPINGIN1:MN,03-15,21-34-54,\"Water
Detected\"" cr lf
^^^/* RTRV-ALM-ENV:SHERLOCK:USRPNL-1-40-HOUSEKEEPINGIN1*/ cr lf
;

RELATED COMMANDS
SET-ATTR-ENV
RTRV-ATTR-ENV
RTRV-COND-ENV

RELATED AUTONOMOUS RESPONSES


REPT^ALM^ENV

1476 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ALM-RR


Command Name: RETRIEVE ALARM

PURPOSE
The RTRV-ALM-<rr> command retrieves the current status of any existing alarm condition in the
system for the given <rr> MODIFIER, or any existing common alarm conditions matching a specified
combination of position-defined input parameters.
The successful response for a RTRV-ALM-rr command contains one line of parsable output data for
each alarm condition being reported. If multiple alarm conditions exist, a line of output is provided for
each alarm in ascending order by date and time of occurrence.
If there are no alarms to report, the system outputs a COMPLD response.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ALM-rr:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],[SRVEFF],[LOCN
],[DIRN]:[DATATYPE=];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1477


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Equipment Controller)
EC-1-<slot>-{CIT, ES1, ES2} (EC Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (EC Ports, non-main shelves)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Ports)
LINE, OSC}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)
LINE, OSC}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)

1478 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Optical Ports)
OSC, OSCSFP}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}

1830PSS R3.6.50 - TL1 Commands and Messages 1479


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


OSCT-<shelf>-<slot> (OSCT Circuit Pack)
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,

1480 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Ports)
LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,

1830PSS R3.6.50 - TL1 Commands and Messages 1481


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
DCM-<shelf>-1 (DCM Module)
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1 (ITLB/ITLU Module)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Ports)
THRU, OMD}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Channels)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}-{9605, 9600, 9595,
9590, 9585, 9580, 9575, 9570, 9565,
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,

1482 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


9200, 9195, 9190, 9185, 9180, 9175,
9170}
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B
9590, 9585, 9580, 9575, 9570, 9565, Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170, OMD}
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}

1830PSS R3.6.50 - TL1 Commands and Messages 1483


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


OSCT-<shelf>-<slot>-LINE-{9605, (OSCT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot>
112SA1L-<shelf>-<slot>-{L1,
C1}
112SX10L-<shelf>-<slot>
112SX10L-<shelf>-<slot>-{L1,
C{1-10}}
112SCA1-<shelf>-<slot>
112SCA1-<shelf>-<slot>-{L1, C1}
112SNA1-<shelf>-<slot>
112SNA1-<shelf>-<slot>-{L1,
C1}

1484 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


112SCX10-<shelf>-<slot>
112SCX10-<shelf>-<slot>-{L1, C{1-10}}
112SNX10-<shelf>-<slot>
112SNX10-<shelf>-<slot>-{L1,
C{1-10}}
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client

1830PSS R3.6.50 - TL1 Commands and Messages 1485


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
SYSTEM (System AID)
USRPNL-1-<slot> (User Panel)
USRPNL-1-<slot>-{OAMP, VOIP, E1, (User Panel Ports)
E2, HOUSEKEEPINGIN{1-8},
HOUSEKEEPINGOUT{1-4}}
PF-<shelf>-<slot> (Power Filter)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1486 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm

CONDTYPE Value Description


<a valid system condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.

SRVEFF Value Description


NSA
SA

Default: <All Values>


Addressing: None
Description: Service Effect, identifies the effect on service caused by the event.
NSA Nonservice-affecting
SA Service-affecting

1830PSS R3.6.50 - TL1 Commands and Messages 1487


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

LOCN Value Description


NEND

Default: <All Applicable Locations>


Addressing: None
Description: Location, identifies the location where the condition type is
monitored.
NEND Near End

DIRN Value Description


NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
NA Not Applicable

DATATYPE= Value Description


FE
HDSDI
3GSDI
SDSDI

Default: <All Values>


Addressing: None
Description: Client port signal type required when modifier is CBRAR.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],[<OCR
TM>],[<LOCN>],[<DIRN>], :[\"<CONDDESCR>\"]:[:DATATYPE=<value>]" cr
lf]*
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1488 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Equipment Controller)
EC-1-<slot>-{CIT, ES1, ES2} (EC Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (EC Ports, non-main shelves)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
SLOT-<shelf>-1 (Generic Slot AID in Passive Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Ports)
LINE, OSC}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Ports)
LINE, OSC}

1830PSS R3.6.50 - TL1 Commands and Messages 1489


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Ports)
OSC, OSCSFP}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)
LINE, OSC}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,

1490 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


9190, 9185, 9180, 9175, 9170}
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,

1830PSS R3.6.50 - TL1 Commands and Messages 1491


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Ports)
LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,

1492 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
DCM-<shelf>-1 (DCM Module)
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1 (ITLB/ITLU Module)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Ports)
THRU, OMD}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Channels)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}-{9605, 9600, 9595,
9590, 9585, 9580, 9575, 9570, 9565,
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,

1830PSS R3.6.50 - TL1 Commands and Messages 1493


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
SFD-<shelf>-<slot> (SFD5/8 Module)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, OMD, EXP}
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B
9590, 9585, 9580, 9575, 9570, 9565, Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170, OMD}
SFC-<shelf>-<slot> (SFC2/4/8 Module)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 Ports)
1531, 1551, 1571, 1591, 1611, OMD,

1494 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


EXP}
OPS-<shelf>-<slot> (OPSA Circuit Pack)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STAR1-<shelf>-<slot>-C1-GCC0 (General Communication Channel 0 on
11STAR1 Client Port)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
112SA1L-<shelf>-<slot>
112SA1L-<shelf>-<slot>-{L1,
C1}
112SX10L-<shelf>-<slot>
112SX10L-<shelf>-<slot>-{L1,
C{1-10}}
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SNA1-<shelf>-<slot>
112SNA1-<shelf>-<slot>-{L1,
C1}
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNX10-<shelf>-<slot>
112SNX10-<shelf>-<slot>-{L1,
C{1-10}}

1830PSS R3.6.50 - TL1 Commands and Messages 1495


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)

1496 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AID Value Description


11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
SYSTEM (System AID)
USRPNL-1-<slot> (User Panel)
USRPNL-1-<slot>-{OAMP, VOIP, E1, (User Panel Ports)
E2, HOUSEKEEPINGIN{1-8},

1830PSS R3.6.50 - TL1 Commands and Messages 1497


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

AID Value Description


HOUSEKEEPINGOUT{1-4}}
PF-<shelf>-<slot> (Power Filter)
ACTSW (The active software generic on the NE)
STBYSW (The standby software generic on the
NE)

Description: Access Identifier, identifies the entity access identifier.

1498 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

AIDTYPE Value Description


1GBE
FE
10GBE
100GBE
CBR2G5
CBRAR
COM
EQPT
FC100
FC200
FC400
FC800
FC1200
OC3
OC12
OC48
OC192
OC768
OCH
OTS
OPTSG
ODU0
VTS
ODUF
ODU1
ODU2
ODU3
ODU4
OTU1
OTU2
OTU3
OTU4
PLK
STM1
STM4
STM16
STM64
STM256

Description: Access Identifier Type, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1499


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR

NTFCNCDE Value Description


CR
MJ
MN
WR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm

CONDTYPE Value Description


<a valid system condition type for the
AID>

Description: Condition Type, specifies the reported condition type.

SRVEFF Value Description


NSA
SA

Description: Service Effect, identifies the effect on service caused by the event.
NSA Nonservice-affecting
SA Service-affecting

OCRDAT Value Description


{01-12}-{01-31}

Description: Occurrence Date, identifies the date when the event occurred.
<MONTH_OF_YEAR>-<DAY_OF_MONTH>

OCRTM Value Description


{00-23}-{00-59}-{00-59}

Description: Occurrence Time, identifies the time when the event occurred.
<HOUR_OF_DAY>-<MINUTE_OF_HOUR>-<SECOND_OF_MIN
UTE>

1500 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALM-RR Issue 1, December 2011

LOCN Value Description


NEND

Description: Location, identifies the location where the condition type is


monitored.
NEND Near End

DIRN Value Description


NA
TRMT Transmit direction
RCV Receive direction

Description: Direction, indicates the direction of the condition relative to the


specified AID.
NA Not Applicable
TRMT Transmit direction
RCV Receive direction

CONDDESCR Value Description


<1-10 lines of up to 64 characters per
line>

Description: Condition description, The detailed text description of the trouble.

DATATYPE= Value Description


FE
HDSDI
SDSDI
3GSDI

Description: Client port signal type when modifier is CBRAR.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 1501


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALM-RR
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIFM Invalid Payload block. Invalid Data Format.
• the command is entered with parameter values that are inconsistent with the Condition Types
specified in the CONDTYPES Table (/Core Transport Requirements/TL1 Database/CondTypes)

EXAMPLES
In the following example, all common alarms in the system are retrieved.

RTRV-ALM-COM::COM;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P10981 COMPLD
"COM:MN,DBF,NSA,08-11,01-00-07,NEND"
/* RTRV-ALM-COM::COM [P10981] (5) */;

RELATED COMMANDS
RTRV-ATTR-rr
RTRV-COND-ALL
SET-ATTR-rr

RELATED AUTONOMOUS RESPONSES


REPT^ALM

1502 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ALMPRFL-RR


Command Name: RETRIEVE ALARM PROFILE

PURPOSE
The RTRV-ALMPRFL-rr command retrieves the current notification codes associated with the
specified conditions on equipment that supports facilities matching the entered MODIFIER. The input
parameters provide a search-key filter for retrieving condition type attributes satisfying the specified
input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID. If both service
effect attributes are requested, a separate line of output data is provided for any non-service affecting
attributes followed by a line for any service affecting attributes for each condition type being retrieved.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ALMPRFL-rr:[TID]::[CTAG]::,[CONDTYPE],,[DIRN],;

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1503


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALMPRFL-RR

CONDTYPE Value Description


<a valid system condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AIDTYPE>:<NTFCNCDEDFLT>,[<NTFCNCDEOVR>],<CONDTYPE>[,<DIRN>]"]
cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1504 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALMPRFL-RR Issue 1, December 2011

AIDTYPE Value Description


1GBE
FE
10GBE
100GBE
CBR2G5
CBRAR
COM
EQPT
FC100
FC200
FC400
FC800
FC1200
OC3
OC12
OC48
OC192
OC768
OCH
OPTSG
ODU0
ODUF
VTS
ODU1
ODU2
ODU3
ODU4
OTS
OTU1
OTU2
OTU3
OTU4
PLK
STM1
STM4
STM16
STM64
STM256

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1505


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALMPRFL-RR

NTFCNCDEDFLT Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification code default, identifies the default notification code.


CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

NTFCNCDEOVR Value Description


CR
MJ
MN
WR
NA
NR
DFLT

Description: Notification Code Override, identifies the overriding notification


code.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported
DFLT No override

CONDTYPE Value Description


<a valid system condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.

1506 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALMPRFL-RR Issue 1, December 2011

For a list of condition types by AID refer to the "Condition types


Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• the command is entered with an invalid combination of parameters

EXAMPLES
In the following example, the attributes for the CBR2G5 port are retrieved:

RTRV-ALMPRFL-CBR2G5:::12345::,,,,;

The output response is shown below.

1830PSS R3.6.50 - TL1 Commands and Messages 1507


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALMPRFL-RR

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"CBR2G5:CR,DFLT,ANERR,RCV"
"CBR2G5:NA,DFLT,FELANRFI,RCV"
"CBR2G5:MJ,DFLT,HIBER,RCV"
"CBR2G5:CR,DFLT,LFD,RCV"
"CBR2G5:CR,DFLT,LOS,RCV"
"CBR2G5:CR,DFLT,LSS,RCV"
"CBR2G5:NA,DFLT,MAN,RCV"
"CBR2G5:NA,DFLT,USALS,RCV"
"CBR2G5:CR,DFLT,VCGLOA,RCV"
"CBR2G5:CR,DFLT,VCGSSF,RCV"
"CBR2G5:CR,DFLT,UPM,RCV"
/* RTRV-ALMPRFL-CBR2G5:::12345::,,,, [P15119] (12345) */
;

In the following example, the attributes for COM are retrieved:

RTRV-ALMPRFL-COM:::12345::,,,,;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"COM:CR,DFLT,ANERR,RCV"
"COM:NA,DFLT,FELANRFI,RCV"
"COM:MJ,DFLT,HIBER,RCV"
"COM:CR,DFLT,LFD,RCV"
"COM:CR,DFLT,LOS,RCV"
"COM:CR,DFLT,LSS,RCV"
"COM:NA,DFLT,MAN,RCV"
"COM:NA,DFLT,USALS,RCV"
"COM:CR,DFLT,VCGLOA,RCV"
"COM:CR,DFLT,VCGSSF,RCV"
"COM:CR,DFLT,UPM,RCV"
/* RTRV-ALMPRFL-COM:::12345::,,,, [P15119] (12345) */
;

In the following example, the attributes for the 10GBE port are retrieved:

RTRV-ALMPRFL-10GBE:::12345::,,,,;

The output response is shown below.

1508 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALMPRFL-RR Issue 1, December 2011

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"10GBE:CR,DFLT,ANERR,RCV"
"10GBE:NA,DFLT,FELANRFI,RCV"
"10GBE:MJ,DFLT,HIBER,RCV"
"10GBE:CR,DFLT,LFD,RCV"
"10GBE:CR,DFLT,LOS,RCV"
"10GBE:CR,DFLT,LSS,RCV"
"10GBE:NA,DFLT,MAN,RCV"
"10GBE:NA,DFLT,USALS,RCV"
"10GBE:CR,DFLT,VCGLOA,RCV"
"10GBE:CR,DFLT,VCGSSF,RCV"
"10GBE:CR,DFLT,UPM,RCV"
/* RTRV-ALMPRFL-10GBE:::12345::,,,, [P15119] (12345) */
;

In the following example, the attributes for the OC48 port are retrieved:

RTRV-ALMPRFL-OC48:::12345::,,,,;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"OC48:CR,DFLT,ANERR,RCV"
"OC48:NA,DFLT,FELANRFI,RCV"
"OC48:MJ,DFLT,HIBER,RCV"
"OC48:CR,DFLT,LFD,RCV"
"OC48:CR,DFLT,LOS,RCV"
"OC48:CR,DFLT,LSS,RCV"
"OC48:NA,DFLT,MAN,RCV"
"OC48:NA,DFLT,USALS,RCV"
"OC48:CR,DFLT,VCGLOA,RCV"
"OC48:CR,DFLT,VCGSSF,RCV"
"OC48:CR,DFLT,UPM,RCV"
/* RTRV-ALMPRFL-OC48:::12345::,,,, [P15119] (12345) */
;

In the following example, the attributes for the GE port are retrieved:

RTRV-ALMPRFL-ODU2:::12345::,,,,;

The output response is shown below.

1830PSS R3.6.50 - TL1 Commands and Messages 1509


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALMPRFL-RR

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"ODU2:CR,DFLT,ANERR,RCV"
"ODU2:NA,DFLT,FELANRFI,RCV"
"ODU2:MJ,DFLT,HIBER,RCV"
"ODU2:CR,DFLT,LFD,RCV"
"ODU2:CR,DFLT,LOS,RCV"
"ODU2:CR,DFLT,LSS,RCV"
"ODU2:NA,DFLT,MAN,RCV"
"ODU2:NA,DFLT,USALS,RCV"
"ODU2:CR,DFLT,VCGLOA,RCV"
"ODU2:CR,DFLT,VCGSSF,RCV"
"ODU2:CR,DFLT,UPM,RCV"
/* RTRV-ALMPRFL-ODU2:::12345::,,,, [P15119] (12345) */
;

In the following example, the attributes for the OTS port are retrieved:

RTRV-ALMPRFL-OTS:::12345::,,,,;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"OTS:CR,DFLT,ANERR,RCV"
"OTS:NA,DFLT,FELANRFI,RCV"
"OTS:MJ,DFLT,HIBER,RCV"
"OTS:CR,DFLT,LFD,RCV"
"OTS:CR,DFLT,LOS,RCV"
"OTS:CR,DFLT,LSS,RCV"
"OTS:NA,DFLT,MAN,RCV"
"OTS:NA,DFLT,USALS,RCV"
"OTS:CR,DFLT,VCGLOA,RCV"
"OTS:CR,DFLT,VCGSSF,RCV"
"OTS:CR,DFLT,UPM,RCV"
/* RTRV-ALMPRFL-OTS:::12345::,,,, [P15119] (12345) */
;

In the following example, the attributes for the STM16 port are retrieved:

RTRV-ALMPRFL-STM16:::12345::,,,,;

The output response is shown below.

1510 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ALMPRFL-RR Issue 1, December 2011

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"STM16:CR,DFLT,ANERR,RCV"
"STM16:NA,DFLT,FELANRFI,RCV"
"STM16:MJ,DFLT,HIBER,RCV"
"STM16:CR,DFLT,LFD,RCV"
"STM16:CR,DFLT,LOS,RCV"
"STM16:CR,DFLT,LSS,RCV"
"STM16:NA,DFLT,MAN,RCV"
"STM16:NA,DFLT,USALS,RCV"
"STM16:CR,DFLT,VCGLOA,RCV"
"STM16:CR,DFLT,VCGSSF,RCV"
"STM16:CR,DFLT,UPM,RCV"
/* RTRV-ALMPRFL-STM16:::12345::,,,, [P15119] (12345) */
;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-rr
RTRV-COND-ALL
RTRV-COND-rr
SET-ALMPRFL-rr

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 1511


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ALMPRFL-RR

1512 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-100GBE


Command Name: RETRIEVE ATTRIBUTE 100GBE

PURPOSE
The RTRV-ATTR-100GBE command retrieves the provisioned condition type attributes for the
specified 100 GBE port. The input parameters provide a search-key filter for retrieving condition type
attributes satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the 100 GBE port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-100GBE:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1
(112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1513


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-100GBE
Description: 10 GBE Access Identifier, specifies the 10 GBE facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid 100GBE condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1514 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-100GBE Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1
(112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


100GBE

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1515


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-100GBE

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid 100GBE condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

1516 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-100GBE Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for 100 GBE port
11SCA1-1-3-C1 are retrieved:

RTRV-ATTR-100GBE::112SCA1-1-3-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"112SCA1-1-3-C1,10GBE:MJ,LANLOS,,RCV"
/* RTRV-ATTR-100GBE::112SCA1-1-3-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-100GBE

1830PSS R3.6.50 - TL1 Commands and Messages 1517


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-100GBE
RTRV-COND-ALL
RTRV-COND-100GBE
SET-ATTR-100GBE

RELATED AUTONOMOUS RESPONSES

1518 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-10GBE


Command Name: RETRIEVE ATTRIBUTE 10GBE

PURPOSE
The RTRV-ATTR-GBE10 command retrieves the provisioned condition type attributes for the specified
10 GBE port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the 10 GBE port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-10GBE:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1519


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-10GBE

AID Value Description


ALL (ALL AID)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10}
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: Entry required


Addressing: None
Description: 10 GBE Access Identifier, specifies the 10 GBE facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm

1520 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-10GBE Issue 1, December 2011

MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid 10GBE condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1521


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-10GBE

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-
10}
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


10GBE

Description: Identifies the type of AID for the notification being retrieved.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

1522 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-10GBE Issue 1, December 2011

CONDTYPE Value Description


<a valid 10GBE condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )

1830PSS R3.6.50 - TL1 Commands and Messages 1523


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-10GBE
• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for 10 GBE port
11STAR1-1-3-C1 are retrieved:

RTRV-ATTR-10GBE::11STAR1-1-3-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,10GBE:MJ,LANLOS,,RCV"
/* RTRV-ATTR-10GBE::11STAR1-1-3-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-GBE10
RTRV-COND-ALL
RTRV-COND-GBE10
SET-ATTR-GBE10

RELATED AUTONOMOUS RESPONSES

1524 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-1GBE


Command Name: RETRIEVE ATTRIBUTE 1GBE

PURPOSE
The RTRV-ATTR-GBE command retrieves the provisioned condition type attributes for the specified
GBE port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the GBE port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-1GBE:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1525


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-1GBE

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Default: Entry required


Addressing: None
Description: GBE Access Identifier, specifies the GBE facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

1526 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-1GBE Issue 1, December 2011

CONDTYPE Value Description


<a valid 1GBE condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1527


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-1GBE

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


1GBE

Description: Identifies the type of AID for the notification being retrieved.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid 1GBE condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

1528 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-1GBE Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for 1GBE port
11STMM10-1-2-C1 are retrieved:

RTRV-ATTR-1GBE::11STMM10-1-2-C1:::,LANLOS;

1830PSS R3.6.50 - TL1 Commands and Messages 1529


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-1GBE
The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,1GBE:MJ,LANLOS,,RCV"
"11STMM10-1-2-C1,1GBE:NA,LANLOS,,RCV"
/* RTRV-ATTR-1GBE::11STMM10-1-2-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-GBE
RTRV-COND-ALL
RTRV-COND-GBE
SET-ATTR-GBE

RELATED AUTONOMOUS RESPONSES

1530 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-CBR2G5


Command Name: RETRIEVE ATTRIBUTE CBR2G5

PURPOSE
The RTRV-ATTR-CBR2G5 command retrieves the provisioned condition type attributes for the
specified CBR2G5 port. The input parameters provide a search-key filter for retrieving condition type
attributes satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the CBR2G5 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-CBR2G5:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: Entry required


Addressing: None
Description: CBR2G5 Access Identifier, specifies the CBR2G5 facility.

1830PSS R3.6.50 - TL1 Commands and Messages 1531


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CBR2G5

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid CBR2G5 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1532 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-CBR2G5 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


CBR2G5

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1533


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CBR2G5

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid CBR2G5 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction Only
TRMT Transmit Direction Only
NA Not Applicable

1534 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-CBR2G5 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for CBR2G5 port 11STMM10-1-2-C1
are retrieved:

RTRV-ATTR-CBR2G5::11STMM10-1-11-C4:100::,LOS;

The output response is shown below.

G01U 09-02-23 05:13:56


M 100 COMPLD
"11STMM10-1-11-C4,CBR2G5:CR,LOS,,RCV"
/* RTRV-ATTR-CBR2G5 */
;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-CBR2G5

1830PSS R3.6.50 - TL1 Commands and Messages 1535


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CBR2G5
RTRV-COND-ALL
RTRV-COND-CBR2G5
SET-ATTR-CBR2G5

RELATED AUTONOMOUS RESPONSES

1536 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-CBRAR


Command Name: RETRIEVE ATTRIBUTE CBRAR

PURPOSE
The RTRV-ATTR-CBRAR command retrieves the provisioned condition type attributes for the specified
CBRAR port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the CBRAR port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-CBRAR:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN]:DA
TATYPE=;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1537


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CBRAR
Description: CBR2G5 Access Identifier, specifies the CBR2G5 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid CBRAR condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1538 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-CBRAR Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

DATATYPE= Value Description


{FE,SDSDI, HDSDI,3GSDI}

Default: Entry required


Addressing: None
Description: Specifies the client signal type

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>,DATATYPE=<value>"
] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


CBRAR

1830PSS R3.6.50 - TL1 Commands and Messages 1539


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CBRAR
Description: Identifies the type of AID for the notification being retrieved.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid CBRAR condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction Only
TRMT Transmit Direction Only
NA Not Applicable

DATATYPE= Value Description


{FE, HDSDI,3GSDI,SDSDI}

1540 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-CBRAR Issue 1, December 2011

Description: Specifies the client signal type

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for 4DPA4-1-11-C2 are
retrieved:

RTRV-ATTR-CBRAR::4DPA4-1-11-C2:100::,LANLOS:DATATYPE=FE;

The output response is shown below.

G01U 09-02-23 05:13:56


M 100 COMPLD
"4DPA4-1-11-C2,CBRAR:MN,LANLOS,,RCV,DATATYPE=FE"
/* RTRV-ATTR-CBRAR */
;

1830PSS R3.6.50 - TL1 Commands and Messages 1541


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CBRAR
RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-CBRAR
RTRV-COND-ALL
RTRV-COND-CBRAR
SET-ATTR-CBRAR

RELATED AUTONOMOUS RESPONSES

1542 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-COM


Command Name: RETRIEVE ATTRIBUTE COMMON

PURPOSE
The RTRV-ATTR-COM command retrieves the provisioned condition type attributes for the COMMON
AID (no specific entity). The input parameters provide a search-key filter for retrieving condition type
attributes satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
The successful response contains one line of parsable output data, sorted alphabetically by
CONDTYPE, for each condition type retrieved.
If there are no condition type attributes matching the specified combination of condition type,
notification code, and service effect, then the command is completed with no line of parsable output
data provided.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-COM:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


SYSTEM (System AID)
ALL (ALL AID)

Default: SYSTEM
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1543


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-COM
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid condition type for the AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


TRMT
RCV
NA

Default: NA
Addressing: None
Description: Service Effect, identifies the effect on service caused by the event.
TRMT Transmit

1544 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-COM Issue 1, December 2011

RCV Receive
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


SYSTEM (System AID)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


COM (Common AID)

Description: Access Identifier, identifies the entity access identifier.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

1830PSS R3.6.50 - TL1 Commands and Messages 1545


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-COM

CONDTYPE Value Description


<a valid condition type for the AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction Only
TRMT Transmit Direction Only
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

1546 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-COM Issue 1, December 2011

EXAMPLES
In the following example, all attributes for non-alarmed COM notifications are retrieved.

rtrv-attr-com:G01U:system;

The output response is shown below.

G01U 09-02-23 05:47:09


M 0 COMPLD
"SYSTEM,COM:MN,PRCDRERR-TOPO,,NA"
"SYSTEM,COM:NA,NTPOOSYNC,,NA"
"SYSTEM,COM:MN,PRCDRERR,,NA"
"SYSTEM,COM:MN,SWFTDWN,,NA"
"SYSTEM,COM:MN,SWUPGFAIL,,NA"
"SYSTEM,COM:MN,DBFT,,NA"
"SYSTEM,COM:MJ,DBINVALID,,NA"
"SYSTEM,COM:MN,DBFL,,NA"
"SYSTEM,COM:MN,SWUPGCOMMIT,,NA"
/* RTRV-ATTR-COM */
;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-COM
RTRV-COND-ALL
RTRV-COND-COM
SET-ATTR-COM

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 1547


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-COM

1548 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-CONT


Command Name: RETRIEVE ATTRIBUTES CONTROL

PURPOSE
The RTRV-ATTR-CONT instructs an NE to retrieve the attributes of an external control. The command
can be used to audit the result of a SET-ATTR-CONT command.

INPUT FORMAT

RTRV-ATTR-CONT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

AID Value Description


PF-1-44-HOUSEKEEPINGOUT{1-4} (PSS-36 External Control Points)
USRPNL-1-<slot>-HOUSEKEEPINGOU (User Panel External Control Points)
T{1-4}
USRPNL-1-<slot>-HOUSEKEEPINGOU (PSS-16 User Panel External Control
T{1-4} Points)

Default: Entry required.


Addressing: None
Description: Access IDentifier of the external control output point

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System Assigned CTAG Value>


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1549


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CONT
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<CONTTYPE>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


PF-1-44-HOUSEKEEPINGOUT{1-4} (PSS-36 External Control Points)
USRPNL-1-<slot>-HOUSEKEEPINGOU (User Panel External Control Points)
T{1-4}
USRPNL-1-<slot>-HOUSEKEEPINGOU (PSS-16 User Panel External Control
T{1-4} Points)

Description: Access IDentifier of the external control output point.

CONTTYPE Value Description


<0-56 characters>

Description: Control Type. Value as set by the SET-ATTR-CONT command.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
^^^/* <EXPANDED ERROR CODE DESCRIPTION> */ cr lf
[^^^/* <OPTIONAL FREE FORMAT TEXT> */ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1550 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-CONT Issue 1, December 2011

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In this example, the user retrieves the control state of USRPNL-1-40-HOUSKEEPINOUT1:

RTRV-ATTR-CONT:SHERLOCK:USRPNL-1-40-HOUSKEEPINGOUT1;

A successful response for this command would be:

cr lf lf
^^^SHERLOCK^ 01-03-16^ 03:14:32 cr lf
M^^C0236^COMPLD cr lf
^^^"USRPNL-1-40-HOUSKEEPINGOUT1:RACKLAMP" cr lf
^^^/* RTRV-ATTR-CONT:SHERLOCK:USRPNL-1-40-HOUSKEEPINGOUT1 */ cr lf
;

RELATED COMMANDS
OPR-EXT-CONT
RLS-EXT-CONT
SET-ATTR-CONT

RELATED AUTONOMOUS RESPONSES


Not Applicable

1830PSS R3.6.50 - TL1 Commands and Messages 1551


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-CONT

1552 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-ENV


Command Name: RETRIEVE ATTRIBUTES ENVIRONMENT

PURPOSE
The RTRV-ATTR-ENV command retrieves the attributes associated with an environmental alarm.
These attributes are included when an environmental alarm is reported or retrieved.
The successful response for a RTRV-ATTR-ENV command contains one line of parsable output data,
in alphabetical order, for each alarm type being reported per specified AID.
Housekeeping input characteristics
POLARITY Environment Condition Detected Physical signal
ALOW yes 0
AHIGH yes 1
ALOW no 1
AHIGH no 0

INPUT FORMAT

RTRV-ATTR-ENV:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

AID Value Description


PF-1-44-HOUSEKEEPINGIN{1-8} (PSS-36 External Input Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-32 User Panel External Input
1-8} Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-16 User Panel External Input
1-6} Points)

Default: Entry required.


Addressing: None
Description: Access IDentifier of the external input point

1830PSS R3.6.50 - TL1 Commands and Messages 1553


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ENV

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System Assigned CTAG Value>


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<NTFCNCDE>,\"<ALMMSG>\",<POLARITY>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


PF-1-44-HOUSEKEEPINGIN{1-8} (PSS-36 External Input Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-32 User Panel External Input
1-8} Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-16 User Panel External Input
1-6} Points)

Description: Access IDentifier.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR
DFLT

Description: NoTiFiCatioNCoDE. Determines the severity of the alarm type.

ALMMSG Value Description


<0-56 characters>

1554 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ENV Issue 1, December 2011

Description: Alarm Message. Alarm message is the text message associated


with the environmental alarm as set by the SET-ATTR-ENV
command.

POLARITY Value Description


AHIGH
ALOW

Description: Polarity. Determine when the external control is active. Values are:
AHIGH Active high
ALOW Active low

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In this example, the user wants to retrieve the alarm attributes for the
USRPNL-1-40-HOUSKEEPINGIN4:

RTRV-ATTR-ENV:SHERLOCK:USRPNL-1-40-HOUSEKEEPINGIN4;

A successful response for this command would be:

cr lf lf
^^^SHERLOCK^ 01-03-16^ 03:14:32 cr lf
M^^C0236^COMPLD cr lf
^^^"USRPNL-1-40-HOUSEKEEPINGIN4:MN,\"Water Detected\",ALOW" cr lf
^^^/* RTRV-ATTR-ENV:SHERLOCK:USRPNL-1-40-HOUSEKEEPINGIN4:C0236 */ cr
lf
;

1830PSS R3.6.50 - TL1 Commands and Messages 1555


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ENV
RELATED COMMANDS
SET-ATTR-ENV
RTRV-ALM-ENV

RELATED AUTONOMOUS RESPONSES


REPT^ALM^ENV
REPT^EVT^ENV

1556 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-EQPT


Command Name: RETRIEVE ATTRIBUTE EQUIPMENT

PURPOSE
The RTRV-ATTR-EQPT command retrieves the provisioned condition type attributes for the specified
equipment AID. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT).
The command is completed regardless of whether the equipment entity is provisioned.
The equipment AIDs can only be accessed on a "type" basis. AIDs for a specific unit cannot be
specified by this command.
The successful response contains one line of parsable output data for each condition type retrieved per
specified AID.
If multiple responses are retrieved or an AID of ALL is entered, a line of output data is provided, sorted
alphabetically by AID into AID groups, for each condition type applicable to each AID sorted
alphabetically by CONDTYPE within the AID groups.
If multiple responses are retrieved, a line of output data is provided, sorted alphabetically by AID into
AID groups, for each condition type applicable to each AID sorted alphabetically by CONDTYPE within
the AID groups.
RTRV-ATTR-EQPT only reports on standing condition types.
The response to the command always shows output data regardless of whether any modules of the
specified type are provisioned.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-EQPT:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1557


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-EQPT

AID Value Description


ALL (ALL AID)
SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Equipment Controller)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot>

1558 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-EQPT Issue 1, December 2011

AID Value Description


112SNX10-<shelf>-<slot>
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
PF-<shelf>-<slot> (Power Filter)
USRPNL-1-<slot> (User Panel)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1}
(112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}}
(112SCX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}

1830PSS R3.6.50 - TL1 Commands and Messages 1559


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-EQPT

AID Value Description


AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Ports)
OSC, OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)
LINE, OSC}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Default: Entry required


Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1560 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-EQPT Issue 1, December 2011

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid EQPT condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


TRMT
RCV
NA

Default: NA
Addressing: None
Description: Direction.
TRMT Transmit
RCV Receive
NA Not Applicable

1830PSS R3.6.50 - TL1 Commands and Messages 1561


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-EQPT
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1562 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-EQPT Issue 1, December 2011

AID Value Description


SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Equipment Controller)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNA1-<shelf>-<slot>
112SNX10-<shelf>-<slot>
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 1563


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-EQPT

AID Value Description


4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
PF-<shelf>-<slot> (Power Filter)
USRPNL-1-<slot> (User Panel)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1}
(112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}}
(112SCX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)
LINE, OSC}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}

1564 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-EQPT Issue 1, December 2011

AID Value Description


AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Ports)
OSC, OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


EQPT

Description: Identifies the type of AID for the notification being retrieved.
EQPT The AID specified is for an Equipment entity

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm

1830PSS R3.6.50 - TL1 Commands and Messages 1565


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-EQPT
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid EQPT condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction Only
TRMT Transmit Direction Only
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.

1566 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-EQPT Issue 1, December 2011

• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, attributes for the 11STAR1-1-5 equipment IMPROPRMVL condition type are
retrieved:

RTRV-ATTR-EQPT::11STAR1-1-5:::,REPLUNITMISS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P11113 COMPLD
"11STAR1-1-5,EQPT:CR,REPLUNITMISS,NEND"
"11STAR1-1-7,EQPT:MN,REPLUNITMISS,NEND"
/* RTRV-ATTR-EQPT::11STAR1-1-5:::,REPLUNITMISS[P11113] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-EQPT
RTRV-COND-ALL
RTRV-COND-EQPT
SET-ATTR-EQPT

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 1567


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-EQPT

1568 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-FC100


Command Name: RETRIEVE ATTRIBUTE FC100

PURPOSE
The RTRV-ATTR-FC100 command retrieves the provisioned condition type attributes for the specified
FC100 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the FC100 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-FC100:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1569


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC100
Description: FC100 Access Identifier, specifies the FC100 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC100 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1570 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC100 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC100

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1571


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC100

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC100 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

1572 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC100 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for FC100 port
11STMM10-1-2-C1 are retrieved:

RTRV-ATTR-FC100::11STMM10-1-2-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,FC100:MJ,LANLOS,,RCV"
/* RTRV-ATTR-FC100::11STMM10-1-2-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-FC100

1830PSS R3.6.50 - TL1 Commands and Messages 1573


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC100
RTRV-COND-ALL
RTRV-COND-FC100
SET-ATTR-FC100

RELATED AUTONOMOUS RESPONSES

1574 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-FC1200


Command Name: RETRIEVE ATTRIBUTE FC1200

PURPOSE
The RTRV-ATTR-FC1200 command retrieves the provisioned condition type attributes for the
specified FC1200 port. The input parameters provide a search-key filter for retrieving condition type
attributes satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the FC1200 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-FC1200:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Default: Entry required


Addressing: None
Description: 10 GFC Access Identifier, specifies the 10 GFC facility.

1830PSS R3.6.50 - TL1 Commands and Messages 1575


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC1200

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC1200 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1576 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC1200 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC1200

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1577


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC1200

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC1200 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

1578 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC1200 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for FC1200 port
11STAR1-1-3-C1 are retrieved:

RTRV-ATTR-FC1200::11STAR1-1-3-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,FC1200:MJ,LANLOS,,RCV"
/* RTRV-ATTR-FC1200::11STAR1-1-3-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-FC1200

1830PSS R3.6.50 - TL1 Commands and Messages 1579


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC1200
RTRV-COND-ALL
RTRV-COND-FC1200
SET-ATTR-FC1200

RELATED AUTONOMOUS RESPONSES

1580 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-FC200


Command Name: RETRIEVE ATTRIBUTE FC200

PURPOSE
The RTRV-ATTR-FC200 command retrieves the provisioned condition type attributes for the specified
FC200 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the FC200 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-FC200:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1581


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC200
Description: FC200 Access Identifier, specifies the FC200 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC200 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1582 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC200 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC200

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1583


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC200

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC200 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

1584 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC200 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for FC200 port
11STMM10-1-2-C1 are retrieved:

RTRV-ATTR-FC200::11STMM10-1-2-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,FC200:MJ,LANLOS,,RCV"
/* RTRV-ATTR-FC200::11STMM10-1-2-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-FC200

1830PSS R3.6.50 - TL1 Commands and Messages 1585


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC200
RTRV-COND-ALL
RTRV-COND-FC200
SET-ATTR-FC200

RELATED AUTONOMOUS RESPONSES

1586 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-FC400


Command Name: RETRIEVE ATTRIBUTE FC400

PURPOSE
The RTRV-ATTR-FC400 command retrieves the provisioned condition type attributes for the specified
FC400 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the FC400 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-FC400:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1587


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC400
Description: FC400 Access Identifier, specifies the FC400 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC400 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1588 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC400 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC400

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1589


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC400

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC400 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

1590 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC400 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for FC400 port
11STMM10-1-2-C1 are retrieved:

RTRV-ATTR-FC400::11STMM10-1-2-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,FC400:MJ,LANLOS,,RCV"
/* RTRV-ATTR-FC400::11STMM10-1-2-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-FC400

1830PSS R3.6.50 - TL1 Commands and Messages 1591


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC400
RTRV-COND-ALL
RTRV-COND-FC400
SET-ATTR-FC400

RELATED AUTONOMOUS RESPONSES

1592 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-FC800


Command Name: RETRIEVE ATTRIBUTE FC800

PURPOSE
The RTRV-ATTR-FC800 command retrieves the provisioned condition type attributes for the specified
FC800 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the FC800 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-FC800:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1593


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC800
Addressing: None
Description: FC800 Access Identifier, specifies the FC400 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC800 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1594 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC800 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC800

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1595


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC800

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FC800 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

1596 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FC800 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for FC800 port
112SCX10-1-2-C1 are retrieved:

RTRV-ATTR-FC800::112SCX10-1-2-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"112SCX10-1-2-C1,FC400:MJ,LANLOS,,RCV"
/* RTRV-ATTR-FC400::112SCX10-1-2-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-FC800

1830PSS R3.6.50 - TL1 Commands and Messages 1597


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FC800
RTRV-COND-ALL
RTRV-COND-FC800
SET-ATTR-FC800

RELATED AUTONOMOUS RESPONSES

1598 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-FE


Command Name: RETRIEVE ATTRIBUTE FE

PURPOSE
The RTRV-ATTR-FE command retrieves the provisioned condition type attributes for the specified FE
port. The input parameters provide a search-key filter for retrieving condition type attributes satisfying
the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the FE port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-FE:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Default: Entry required


Addressing: None
Description: FE Access Identifier, specifies the FE facility.

1830PSS R3.6.50 - TL1 Commands and Messages 1599


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FE condition type for the AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1600 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FE Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FE

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1601


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FE

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid FE condition type for the AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction Only
NA Not Applicable

1602 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-FE Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LANLOS condition type for FE port 11DPE12-1-2-C1 are
retrieved:

RTRV-ATTR-FE::11DPE12-1-2-C1:::,LANLOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11DPE12-1-2-C1,FE:MJ,LANLOS,,RCV"
"11DPE12-1-2-C1,FE:NA,LANLOS,,RCV"
/* RTRV-ATTR-FE::11DPE12-1-2-C1:::,LANLOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-FE

1830PSS R3.6.50 - TL1 Commands and Messages 1603


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-FE
RTRV-COND-ALL
RTRV-COND-FE
SET-ATTR-FE

RELATED AUTONOMOUS RESPONSES

1604 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OC12


Command Name: RETRIEVE ATTRIBUTE OC-12

PURPOSE
The RTRV-ATTR-OC12 command retrieves the provisioned condition type attributes for the specified
OC-12 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OC12 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OC12:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1605


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC12
Description: OC-12 Access Identifier, specifies the OC-12 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC12 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1606 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC12 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC12

Description: Identifies the type of AID for the notification being retrieved.
OC12 The AID specified is for an OC12 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1607


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC12

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC12 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1608 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC12 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OC12 port 11STMM10-1-2-C1
are retrieved:

RTRV-ATTR-OC12::11STMM10-1-2-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,OC12:MJ,LOS,,RCV"
/* RTRV-ATTR-OC12::11STMM10-1-2-C1:::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OC12

1830PSS R3.6.50 - TL1 Commands and Messages 1609


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC12
RTRV-COND-ALL
RTRV-COND-OC12
SET-ATTR-OC12

RELATED AUTONOMOUS RESPONSES

1610 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OC192


Command Name: RETRIEVE ATTRIBUTE OC-192

PURPOSE
The RTRV-ATTR-OC192 command retrieves the provisioned condition type attributes for the specified
OC-192 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OC192 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OC192:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1611


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC192

AID Value Description


ALL (ALL AID)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10}
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry required


Addressing: None
Description: OC-192 Access Identifier, specifies the OC-192 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm

1612 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC192 Issue 1, December 2011

NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC192 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1613


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC192

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-
10}
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC192

Description: Identifies the type of AID for the notification being retrieved.
OC192 The AID specified is for an OC192 facility

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC192 condition type for the
AID>

1614 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC192 Issue 1, December 2011

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OC192 port 11STAR1-1-3-C1 are
retrieved:

1830PSS R3.6.50 - TL1 Commands and Messages 1615


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC192

RTRV-ATTR-OC192::11STAR1-1-3-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,OC192:MJ,LOS,,RCV"
/* RTRV-ATTR-OC192::11STAR1-1-3-C1:::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OC192
RTRV-COND-ALL
RTRV-COND-OC192
SET-ATTR-OC192

RELATED AUTONOMOUS RESPONSES

1616 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OC3


Command Name: RETRIEVE ATTRIBUTE OC-3

PURPOSE
The RTRV-ATTR-OC3 command retrieves the provisioned condition type attributes for the specified
OC-3 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OC3 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OC3:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1617


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC3
Addressing: None
Description: OC-3 Access Identifier, specifies the OC-3 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC3 condition type for the AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1618 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC3 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC3

Description: Identifies the type of AID for the notification being retrieved.
OC3 The AID specified is for an OC3 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1619


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC3

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC3 condition type for the AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1620 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC3 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OC3 port 11STMM10-1-2-C1 are
retrieved:

RTRV-ATTR-OC3::11STMM10-1-2-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,OC3:MJ,LOS,,RCV"
/* RTRV-ATTR-OC3::11STMM10-1-2-C1:::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OC3

1830PSS R3.6.50 - TL1 Commands and Messages 1621


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC3
RTRV-COND-ALL
RTRV-COND-OC3
SET-ATTR-OC3

RELATED AUTONOMOUS RESPONSES

1622 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OC48


Command Name: RETRIEVE ATTRIBUTE OC-48

PURPOSE
The RTRV-ATTR-OC48 command retrieves the provisioned condition type attributes for the specified
OC-48 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OC48 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OC48:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

1830PSS R3.6.50 - TL1 Commands and Messages 1623


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC48
Default: Entry required
Addressing: None
Description: OC-48 Access Identifier, specifies the OC-48 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC48 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1624 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC48 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC48

Description: Identifies the type of AID for the notification being retrieved.
OC48 The AID specified is for an OC48 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1625


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC48

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC48 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1626 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC48 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OC48 port 11STMM10-1-2-C1
are retrieved:

RTRV-ATTR-OC48::11STMM10-1-2-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,OC48:MJ,LOS,,RCV"
/* RTRV-ATTR-OC48::11STMM10-1-2-C1:::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OC48

1830PSS R3.6.50 - TL1 Commands and Messages 1627


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC48
RTRV-COND-ALL
RTRV-COND-OC48
SET-ATTR-OC48

RELATED AUTONOMOUS RESPONSES

1628 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OC768


Command Name: RETRIEVE ATTRIBUTE OC-768

PURPOSE
The RTRV-ATTR-OC768 command retrieves the provisioned condition type attributes for the specified
OC-768 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OC768 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OC768:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1629


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC768
Description: OC768 Access Identifier, specifies the OC768 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC768 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1630 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC768 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC768

Description: Identifies the type of AID for the notification being retrieved.
OC768 The AID specified is for an OC768 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1631


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC768

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OC768 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1632 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OC768 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OC768 port 43STA1P-1-5-C1 are
retrieved:

RTRV-ATTR-OC768::43STA1P-1-5-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"43STA1P-1-5-C1,OC768:MJ,LOS,,RCV"
/* RTRV-ATTR-OC768::43STA1P-1-5-C1:::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OC768

1830PSS R3.6.50 - TL1 Commands and Messages 1633


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OC768
RTRV-COND-ALL
RTRV-COND-OC768
SET-ATTR-OC768

RELATED AUTONOMOUS RESPONSES

1634 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OCH


Command Name: RETRIEVE ATTRIBUTE OCH

PURPOSE
The RTRV-ATTR-OCH command retrieves the provisioned condition type attributes for the specified
OCH port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
For optical channel alarms on optical line ports a single severity setting applies for all channels on the
port.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OCH port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OCH:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1635


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OCH

AID Value Description


ALL (ALL AID)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A LINE Ports)
LINEOUT}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B LINE Ports)
LINEOUT}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A LINE Ports)
LINEOUT}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-SIG (WR8-88A SIG Port)
WR-<shelf>-<slot>-THRU (WR8-88A THRU Port)
MESH-<shelf>-<slot>-SIGIN (MESH4 SIGIN Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1
(112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1
(112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1
112SNX10-<shelf>-<slot>-L1
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)

1636 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OCH Issue 1, December 2011

AID Value Description


11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Default: Entry required


Addressing: None
Description: OCH Access Identifier, specifies the OCH facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OCH condition type for the
AID>

Default: <All Applicable Values>

1830PSS R3.6.50 - TL1 Commands and Messages 1637


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OCH
Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1638 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OCH Issue 1, December 2011

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

1830PSS R3.6.50 - TL1 Commands and Messages 1639


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OCH

AID Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-{SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,

1640 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OCH Issue 1, December 2011

AID Value Description


9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
RA2P-<shelf>-<slot>-LINEIN-{9605, (RA2P Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,

1830PSS R3.6.50 - TL1 Commands and Messages 1641


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OCH

AID Value Description


9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Channels)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}-{9605, 9600, 9595,
9590, 9585, 9580, 9575, 9570, 9565,
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,

1642 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OCH Issue 1, December 2011

AID Value Description


9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1
(112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1
(112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1
112SNX10-<shelf>-<slot>-L1
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 1643


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OCH

AID Value Description


11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OCH

Description: Identifies the type of AID for the notification being retrieved.
OCH The AID specified is for an OCH facility

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OCH condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

1644 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OCH Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OCH port OPS-1-3-A are
retrieved:

RTRV-ATTR-OCH::OPS-1-3-A:::,LOS;

1830PSS R3.6.50 - TL1 Commands and Messages 1645


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OCH
The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"OPS-1-3-A,OCH:MJ,LOS,,RCV"
/* RTRV-ATTR-OCH::OPS-1-3-A::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OCH
RTRV-COND-ALL
RTRV-COND-OCH
SET-ATTR-OCH

RELATED AUTONOMOUS RESPONSES

1646 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-ODU0


Command Name: RETRIEVE ATTRIBUTE ODU0

PURPOSE
The RTRV-ATTR-ODU0 command retrieves the provisioned condition type attributes for the specified
ODU0 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the ODU0 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-ODU0:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1647


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU0
Addressing: None
Description: ODU0 Access Identifier, specifies the ODU0 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid ODU0 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1648 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU0 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU0

Description: Identifies the type of AID for the notification being retrieved.
ODU0 The AID specified is for an ODU0 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1649


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU0

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid ODU1 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1650 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU0 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for ODU0 port
11DPM12-1-3-C1-ODU0 are retrieved:

RTRV-ATTR-ODU0::11DPM12-1-3-C1-ODU0:::,OCI;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11DPM12-1-3-C1-ODU0,ODU0:CR,OCI,,RCV"
/* RTRV-ATTR-ODU0::11DPM12-1-3-C1-ODU0::,OCI [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-ODU0

1830PSS R3.6.50 - TL1 Commands and Messages 1651


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU0
RTRV-COND-ALL
RTRV-COND-ODU0
SET-ATTR-ODU0

RELATED AUTONOMOUS RESPONSES

1652 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-ODU1


Command Name: RETRIEVE ATTRIBUTE ODU1

PURPOSE
The RTRV-ATTR-ODU1 command retrieves the provisioned condition type attributes for the specified
ODU1 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the ODU1 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-ODU1:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1653


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU1

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)

Default: Entry required


Addressing: None
Description: ODU1 Access Identifier, specifies the ODU1 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

1654 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU1 Issue 1, December 2011

CONDTYPE Value Description


<a valid ODU1 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1655


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU1

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU1

Description: Identifies the type of AID for the notification being retrieved.
ODU1 The AID specified is for an ODU1 facility

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid ODU1 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

1656 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU1 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for ODU1 port 11STMM10-1-3-C1
are retrieved:

RTRV-ATTR-ODU1::11STMM10-1-3-C1:::,LOS;

1830PSS R3.6.50 - TL1 Commands and Messages 1657


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU1
The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-3-C1,ODU1:CR,LOS,,RCV"
/* RTRV-ATTR-ODU1::11STMM10-1-3-C1::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-ODU1
RTRV-COND-ALL
RTRV-COND-ODU1
SET-ATTR-ODU1

RELATED AUTONOMOUS RESPONSES

1658 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-ODU2


Command Name: RETRIEVE ATTRIBUTE ODU2

PURPOSE
The RTRV-ATTR-ODU2 command retrieves the provisioned condition type attributes for the specified
ODU2 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the ODU2 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-ODU2:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1659


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU2

AID Value Description


ALL (ALL AID)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)

Default: Entry required


Addressing: None
Description: ODU2 Access Identifier, specifies the ODU2 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None

1660 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU2 Issue 1, December 2011

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid ODU2 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1661


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU2

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10}
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU2

Description: Identifies the type of AID for the notification being retrieved.
ODU2 The AID specified is for an ODU2 facility

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

1662 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU2 Issue 1, December 2011

CONDTYPE Value Description


<a valid ODU2 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )

1830PSS R3.6.50 - TL1 Commands and Messages 1663


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU2
• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LCK condition type for ODU2 port 11STAR1-1-3-C1 are
retrieved:

RTRV-ATTR-ODU2::11STAR1-1-3-C1:::,LCK;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,ODU2:CR,LCK,,RCV"
/* RTRV-ATTR-ODU2::11STAR1-1-3-C1::,LCK [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-ODU2
RTRV-COND-ALL
RTRV-COND-ODU2
SET-ATTR-ODU2

RELATED AUTONOMOUS RESPONSES

1664 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-ODU3


Command Name: RETRIEVE ATTRIBUTE ODU3

PURPOSE
The RTRV-ATTR-ODU3 command retrieves the provisioned condition type attributes for the specified
ODU3 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the ODU3 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-ODU3:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1665


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU3

AID Value Description


ALL (ALL AID)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)

Default: Entry required


Addressing: None
Description: ODU3 Access Identifier, specifies the ODU3 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

1666 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU3 Issue 1, December 2011

CONDTYPE Value Description


<a valid ODU3 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)

1830PSS R3.6.50 - TL1 Commands and Messages 1667


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU3
Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU3

Description: Identifies the type of AID for the notification being retrieved.
ODU3 The AID specified is for an ODU3 facility

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid ODU3 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1668 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU3 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for ODU3 port 11STAR1-1-3-C1 are
retrieved:

RTRV-ATTR-ODU3::43STX4-1-3-L1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"43STX4-1-3-L1,ODU3:CR,LOS,,RCV"
/* RTRV-ATTR-ODU3::43STX4-1-3-L1::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-ODU3

1830PSS R3.6.50 - TL1 Commands and Messages 1669


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU3
RTRV-COND-ALL
RTRV-COND-ODU3
SET-ATTR-ODU3

RELATED AUTONOMOUS RESPONSES

1670 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-ODU4


Command Name: RETRIEVE ATTRIBUTE ODU4

PURPOSE
The RTRV-ATTR-ODU4 command retrieves the provisioned condition type attributes for the specified
ODU4 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the ODU4 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-ODU4:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1671


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU4

AID Value Description


ALL (ALL AID)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1
(112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Default: Entry required


Addressing: None
Description: ODU4 Access Identifier, specifies the ODU3 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

1672 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU4 Issue 1, December 2011

CONDTYPE Value Description


<a valid ODU4 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1673


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU4

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1
(112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU4

Description: Identifies the type of AID for the notification being retrieved.
ODU4 The AID specified is for an ODU4 facility

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid ODU4 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

1674 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODU4 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for ODU4 port 112SCX10-1-3-L1 are
retrieved:

RTRV-ATTR-ODU4::112SCX10-1-3-L1:::,LOS;

1830PSS R3.6.50 - TL1 Commands and Messages 1675


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODU4
The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"112SCX10-1-3-L1,ODU4:CR,LOS,,RCV"
/* RTRV-ATTR-ODU4::112SCX10-1-3-L1::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-ODU4
RTRV-COND-ALL
RTRV-COND-ODU4
SET-ATTR-ODU4

RELATED AUTONOMOUS RESPONSES

1676 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-ODUF


Command Name: RETRIEVE ATTRIBUTE ODUF

PURPOSE
The RTRV-ATTR-ODUF command retrieves the provisioned condition type attributes for the specified
ODUF port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the ODUF port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-ODUF:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1677


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODUF
Addressing: None
Description: ODUF Access Identifier, specifies the ODUF facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OPTSG condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1678 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODUF Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODUF

Description: Identifies the type of AID for the notification being retrieved.
ODUF The AID specified is for an ODUF facility

1830PSS R3.6.50 - TL1 Commands and Messages 1679


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODUF

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OPTSG condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1680 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-ODUF Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for ODUF port
11DPM12-1-3-L1-ODU2ODUF#1 are retrieved:

RTRV-ATTR-ODUF::11DPM12-1-3-L1-ODU2ODUF#1:::,OCI;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11DPM12-1-3-C1-ODUF,ODUF:CR,OCI,,RCV"
/* RTRV-ATTR-ODUF::11DPM12-1-3-L1-ODU2ODUF#1::,OCI [P15119] (1)
*/;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-ODUF

1830PSS R3.6.50 - TL1 Commands and Messages 1681


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-ODUF
RTRV-COND-ALL
RTRV-COND-ODUF
SET-ATTR-ODUF

RELATED AUTONOMOUS RESPONSES

1682 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OPTSG


Command Name: RETRIEVE ATTRIBUTE OPTSG

PURPOSE
The RTRV-ATTR-OPTSG command retrieves the provisioned condition type attributes for the
specified OPTSG port. The input parameters provide a search-key filter for retrieving condition type
attributes satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OPTSG port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OPTSG:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)

Default: Entry required


Addressing: None
Description: OPTSG Access Identifier, specifies the OPTSG facility.

1830PSS R3.6.50 - TL1 Commands and Messages 1683


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OPTSG

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OPTSG condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

1684 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OPTSG Issue 1, December 2011

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OPTSG

Description: Identifies the type of AID for the notification being retrieved.
OPTSG The AID specified is for an OPTSG facility

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm

1830PSS R3.6.50 - TL1 Commands and Messages 1685


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OPTSG
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OPTSG condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

1686 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OPTSG Issue 1, December 2011

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OPTSG port
11DPM12-1-3-C1-OPTSG are retrieved:

RTRV-ATTR-OPTSG::11DPM12-1-3-C1-OPTSG:::,OCI;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11DPM12-1-3-C1-OPTSG,OPTSG:CR,OCI,,RCV"
/* RTRV-ATTR-OPTSG::11DPM12-1-3-C1-OPTSG::,OCI [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OPTSG
RTRV-COND-ALL
RTRV-COND-OPTSG
SET-ATTR-OPTSG

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 1687


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OPTSG

1688 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OTS


Command Name: RETRIEVE ATTRIBUTE OTS

PURPOSE
The RTRV-ATTR-OTS command retrieves the provisioned condition type attributes for the specified
OTS port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OTS port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OTS:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1689


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTS

AID Value Description


ALL (ALL AID)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Ports)
LINE, OSC}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Ports)
DCM, OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Ports)
DCM, OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, (OSCT Managed Ports)
OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Ports)
LINEOUT, OSC, OSCSFP}
CWR-<shelf>-<slot>-SIG (CWR8/CWR8-88 SIG Port)
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)

Default: Entry required


Addressing: None
Description: OTS Access Identifier, specifies the OTS facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1690 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTS Issue 1, December 2011

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTS condition type for the AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1691


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTS
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1692 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTS Issue 1, December 2011

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Ports)
LINE, OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Ports)
DCM, OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Ports)
DCM, OSC}
OSCT-<shelf>-<slot>-{SIG, LINE, (OSCT Managed Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTS

Description: Identifies the type of AID for the notification being retrieved.
OTS The AID specified is for an OTS facility

1830PSS R3.6.50 - TL1 Commands and Messages 1693


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTS

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTS condition type for the AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1694 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTS Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for OTS port ALPHG-1-3-LINE are
retrieved:

RTRV-ATTR-OTS::ALPHG-1-3-LINE:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"ALPHG-1-3-LINE,OTS:MJ,LOS,,RCV"
/* RTRV-ATTR-OTS::ALPHG-1-3-LINE::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OTS

1830PSS R3.6.50 - TL1 Commands and Messages 1695


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTS
RTRV-COND-ALL
RTRV-COND-OTS
SET-ATTR-OTS

RELATED AUTONOMOUS RESPONSES

1696 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OTU1


Command Name: RETRIEVE ATTRIBUTE OTU1

PURPOSE
The RTRV-ATTR-OTU1 command retrieves the provisioned condition type attributes for the specified
OTU1 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OTU1 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OTU1:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1697


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU1
Addressing: None
Description: OTU1 Access Identifier, specifies the OTU1 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
WR
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTU1 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1698 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU1 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU1

Description: Identifies the type of AID for the notification being retrieved.
OTU1 The AID specified is for an OTU1 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1699


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU1

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTU1 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1700 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU1 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOM condition type for OTU1 port 11STMM10-1-3-L1
are retrieved:

RTRV-ATTR-OTU1::11STMM10-1-3-C1:::,LOM;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-3-C1,OTU1:MJ,LOM,,RCV"
/* RTRV-ATTR-OTU1::11STMM10-1-3-C1::,LOM [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OTU1

1830PSS R3.6.50 - TL1 Commands and Messages 1701


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU1
RTRV-COND-ALL
RTRV-COND-OTU1
SET-ATTR-OTU1

RELATED AUTONOMOUS RESPONSES

1702 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OTU2


Command Name: RETRIEVE ATTRIBUTE OTU2

PURPOSE
The RTRV-ATTR-OTU2 command retrieves the provisioned condition type attributes for the specified
OTU2 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OTU2 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OTU2:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1703


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU2

AID Value Description


ALL (ALL AID)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10}
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Default: Entry required


Addressing: None
Description: OTU2 Access Identifier, specifies the OTU2 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None

1704 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU2 Issue 1, December 2011

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTU2 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 1705


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU2
OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10}
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU2

Description: Identifies the type of AID for the notification being retrieved.
OTU2 The AID specified is for an OTU2 facility

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm

1706 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU2 Issue 1, December 2011

MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTU2 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

1830PSS R3.6.50 - TL1 Commands and Messages 1707


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU2
IIFM Invalid Payload block. Invalid Data Format.
• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOM condition type for OTU2 port 11STAR1-1-3-C1 are
retrieved:

RTRV-ATTR-OTU2::11STAR1-1-3-C1:::,LOM;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,OTU2:MJ,LOM,,RCV"
/* RTRV-ATTR-OTU2::11STAR1-1-3-C1::,LOM [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OTU2
RTRV-COND-ALL
RTRV-COND-OTU2
SET-ATTR-OTU2

RELATED AUTONOMOUS RESPONSES

1708 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OTU3


Command Name: RETRIEVE ATTRIBUTE OTU3

PURPOSE
The RTRV-ATTR-OTU3 command retrieves the provisioned condition type attributes for the specified
OTU3 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OTU3 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OTU3:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1709


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU3

AID Value Description


ALL (ALL AID)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)

Default: Entry required


Addressing: None
Description: OTU3 Access Identifier, specifies the OTU3 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

1710 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU3 Issue 1, December 2011

CONDTYPE Value Description


<a valid OTU3 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 1711


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU3
Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU3

Description: Identifies the type of AID for the notification being retrieved.
OTU3 The AID specified is for an OTU3 facility

NTFCNCDE Value Description


CR
MJ
WR
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTU3 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction

1712 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU3 Issue 1, December 2011

TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOM condition type for OTU3 port 43STX4-1-3-L1 are
retrieved:

RTRV-ATTR-OTU3::43STX4-1-3-L1:::,LOM;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"43STX4-1-3-L1,OTU3:MJ,LOM,,RCV"
/* RTRV-ATTR-OTU3::43STX4-1-3-L1::,LOM [P15119] (1) */;

1830PSS R3.6.50 - TL1 Commands and Messages 1713


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU3
RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OTU3
RTRV-COND-ALL
RTRV-COND-OTU3
SET-ATTR-OTU3

RELATED AUTONOMOUS RESPONSES

1714 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-OTU4


Command Name: RETRIEVE ATTRIBUTE OTU4

PURPOSE
The RTRV-ATTR-OTU4 command retrieves the provisioned condition type attributes for the specified
OTU4 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the OTU4 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-OTU4:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1715


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU4

AID Value Description


ALL (ALL AID)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCA1-<shelf>-<slot>-{L1, C1}
(112SCA1 Ports)
112SCX10-<shelf>-<slot>-L1
(112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1
112SNX10-<shelf>-<slot>-L1

Default: Entry required


Addressing: None
Description: OTU4 Access Identifier, specifies the OTU4 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed

1716 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU4 Issue 1, December 2011

NR Not Reported

CONDTYPE Value Description


<a valid OTU4 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1717


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU4

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1
(112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1
112SNX10-<shelf>-<slot>-L1

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU4

Description: Identifies the type of AID for the notification being retrieved.
OTU4 The AID specified is for an OTU4 facility

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OTU4 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

1718 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-OTU4 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOM condition type for OTU4 port 112SCX10-1-3-L1 are
retrieved:

RTRV-ATTR-OTU4::112SCX10-1-3-L1:::,LOM;

1830PSS R3.6.50 - TL1 Commands and Messages 1719


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-OTU4
The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"112SCX10-1-3-L1,OTU4:MJ,LOM,,RCV"
/* RTRV-ATTR-OTU4::112SCX10-1-3-L1::,LOM [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-OTU4
RTRV-COND-ALL
RTRV-COND-OTU4
SET-ATTR-OTU4

RELATED AUTONOMOUS RESPONSES

1720 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-PLK


Command Name: RETRIEVE ATTRIBUTE PHYSICAL LINK

PURPOSE
The RTRV-ATTR-PLK command retrieves the provisioned condition type attributes for the specified
physical link port. The input parameters provide a search-key filter for retrieving condition type
attributes satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the PLK port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-PLK:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
EC-1-<slot>-{ES1, ES2} (EC Communications Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (EC Ports, non-main shelves)
USRPNL-1-<slot>-OAMP (User Panel OAMP port)
USRPNL-1-<slot>-VOIP (User Panel VOIP port)

1830PSS R3.6.50 - TL1 Commands and Messages 1721


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-PLK
Default: Entry required
Addressing: None
Description: PLK Access Identifier, specifies the PLK facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid PLK condition type for the AID>

Default: none
Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1722 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-PLK Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


EC-1-<slot>-{ES1, ES2} (EC Communications Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (EC Ports, non-main shelves)
USRPNL-1-<slot>-OAMP (User Panel OAMP port)
USRPNL-1-<slot>-VOIP (User Panel VOIP port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


PLK

Description: Identifies the type of AID for the notification being retrieved.
PLK The AID specified is for a PLK facility

1830PSS R3.6.50 - TL1 Commands and Messages 1723


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-PLK

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid PLK condition type for the AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1724 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-PLK Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the NET condition type are retrieved:

RTRV-ATTR-PLK::ALL:::,NET;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"EC-1-18-ES1,PLK:MN,NET"
/* RTRV-ATTR-PLK::ALL:::,NET [P15119] */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-PLK
RTRV-COND-ALL

1830PSS R3.6.50 - TL1 Commands and Messages 1725


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-PLK
RTRV-COND-PLK
SET-ATTR-PLK

RELATED AUTONOMOUS RESPONSES

1726 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-STM16


Command Name: RETRIEVE ATTRIBUTE STM16

PURPOSE
The RTRV-ATTR-STM16 command retrieves the provisioned condition type attributes for the specified
STM16 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the STM16 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-STM16:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16

1830PSS R3.6.50 - TL1 Commands and Messages 1727


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM16
Default: Entry required
Addressing: None
Description: STM16 Access Identifier, specifies the STM16 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM16 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1728 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM16 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


STM16

Description: Identifies the type of AID for the notification being retrieved.
STM16 The AID specified is for an STM16 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1729


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM16

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM16 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1730 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM16 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for STM16 port 11STMM10-1-2-C1
are retrieved:

RTRV-ATTR-STM16::11STMM10-1-2-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,STM16:MJ,LOS,,RCV"
/* RTRV-ATTR-STM16::11STMM10-1-2-C1::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-STM16

1830PSS R3.6.50 - TL1 Commands and Messages 1731


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM16
RTRV-COND-ALL
RTRV-COND-STM16
SET-ATTR-STM16

RELATED AUTONOMOUS RESPONSES

1732 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-STM1


Command Name: RETRIEVE ATTRIBUTE STM1

PURPOSE
The RTRV-ATTR-STM1 command retrieves the provisioned condition type attributes for the specified
STM1 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the STM1 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-STM1:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1733


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM1
Addressing: None
Description: STM1 Access Identifier, specifies the STM1 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM1 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1734 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM1 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


STM1

Description: Identifies the type of AID for the notification being retrieved.
STM1 The AID specified is for an STM1 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1735


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM1

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM1 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1736 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM1 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for STM1 port 11STMM10-1-2-C1
are retrieved:

RTRV-ATTR-STM1::11STMM10-1-2-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,STM1:MJ,LOS,,RCV"
/* RTRV-ATTR-STM1::11STMM10-1-2-C1::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-STM1

1830PSS R3.6.50 - TL1 Commands and Messages 1737


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM1
RTRV-COND-ALL
RTRV-COND-STM1
SET-ATTR-STM1

RELATED AUTONOMOUS RESPONSES

1738 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-STM256


Command Name: RETRIEVE ATTRIBUTE STM256

PURPOSE
The RTRV-ATTR-STM256 command retrieves the provisioned condition type attributes for the
specified STM256 port. The input parameters provide a search-key filter for retrieving condition type
attributes satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the STM256 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-STM256:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: Entry required


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1739


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM256
Description: STM256 Access Identifier, specifies the STM256 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM256 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1740 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM256 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


STM256

Description: Identifies the type of AID for the notification being retrieved.
STM256 The AID specified is for an STM256 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1741


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM256

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM256 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1742 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM256 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for STM256 port 43STA1P-1-5-C1
are retrieved:

RTRV-ATTR-STM256::43STA1P-1-5-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"43STA1P-1-5-C1,STM256:CR,LOS,,RCV"
/* RTRV-ATTR-STM256::43STA1-1-5-C1::,MAN [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-STM256

1830PSS R3.6.50 - TL1 Commands and Messages 1743


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM256
RTRV-COND-ALL
RTRV-COND-STM256
SET-ATTR-STM256

RELATED AUTONOMOUS RESPONSES

1744 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-STM4


Command Name: RETRIEVE ATTRIBUTE STM4

PURPOSE
The RTRV-ATTR-STM4 command retrieves the provisioned condition type attributes for the specified
STM4 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the STM4 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-STM4:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1745


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM4
Addressing: None
Description: STM4 Access Identifier, specifies the STM4 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM4 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1746 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM4 Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


STM4

Description: Identifies the type of AID for the notification being retrieved.
STM4 The AID specified is for an STM4 facility

1830PSS R3.6.50 - TL1 Commands and Messages 1747


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM4

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM4 condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1748 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM4 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for STM4 port 11STMM10-1-2-C1
are retrieved:

RTRV-ATTR-STM4::11STMM10-1-2-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-2-C1,STM4:MJ,LOS,,RCV"
/* RTRV-ATTR-STM4::11STMM10-1-2-C1::,LOS [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-STM4

1830PSS R3.6.50 - TL1 Commands and Messages 1749


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM4
RTRV-COND-ALL
RTRV-COND-STM4
SET-ATTR-STM4

RELATED AUTONOMOUS RESPONSES

1750 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-STM64


Command Name: RETRIEVE ATTRIBUTE STM64

PURPOSE
The RTRV-ATTR-STM64 command retrieves the provisioned condition type attributes for the specified
STM64 port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the STM64 port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-STM64:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1751


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM64

AID Value Description


ALL (ALL AID)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10}
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: Entry required


Addressing: None
Description: STM64 Access Identifier, specifies the STM64 facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
WR
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm

1752 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM64 Issue 1, December 2011

WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM64 condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1753


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM64

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10}
(112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10}
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


STM64

Description: Identifies the type of AID for the notification being retrieved.
STM64 The AID specified is for an STM64 facility

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid STM64 condition type for the
AID>

1754 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-STM64 Issue 1, December 2011

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the LOS condition type for STM64 port 11STAR1-1-3-C1 are
retrieved:

1830PSS R3.6.50 - TL1 Commands and Messages 1755


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-STM64

RTRV-ATTR-STM64::11STAR1-1-3-C1:::,LOS;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,STM64:CR,LOS,,RCV"
/* RTRV-ATTR-STM64::11STAR1-1-3-C1::,MAN [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-STM64
RTRV-COND-ALL
RTRV-COND-STM64
SET-ATTR-STM64

RELATED AUTONOMOUS RESPONSES

1756 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTR-VTS


Command Name: RETRIEVE ATTRIBUTE VTS

PURPOSE
The RTRV-ATTR-VTS command retrieves the provisioned condition type attributes for the specified
VTS port. The input parameters provide a search-key filter for retrieving condition type attributes
satisfying the specified input parameters.
This command only retrieves attributes for standing condition types.
For those events reported automatically, these attributes also determine if the event notification is
alarmed (reported via REPT^ALM) or not alarmed (reported via REPT^EVT). The command is
completed regardless of whether the VTS port is provisioned.
For multiple CONDTYPEs, the successful response contains one line of parsable output data, sorted
alphabetically by CONDTYPE, for each condition type retrieved per specified AID.
If there are no condition types attributes matching the specified (valid) combination of AID and input
parameters, then the command is completed with no line of parsable output data provided in the
response message.
The command only reports on standing condition types.
No output is displayed for unprovisioned facilities.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTR-VTS:[TID]:[AID]:[CTAG]::[NTFCNCDE],[CONDTYPE],,[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}

Default: Entry required

1830PSS R3.6.50 - TL1 Commands and Messages 1757


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-VTS
Addressing: None
Description: VTS Access Identifier, specifies the VTS facility.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Default: <All Values>


Addressing: None
Description: Notification Code, identifies the type of alarm generated by the
system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OPTSG condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

1758 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-VTS Issue 1, December 2011

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:<NTFCNCDE>,<CONDTYPE>,,<DIRN>"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


VTS

Description: Identifies the type of AID for the notification being retrieved.
VTS The AID specified is for an VTS facility

1830PSS R3.6.50 - TL1 Commands and Messages 1759


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-VTS

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid OPTSG condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit
NA Not Applicable

1760 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTR-VTS Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID block. Invalid AID.
• the command is executed with an invalid AID,

IIFM Invalid Payload block. Invalid Data Format.


• the command is executed with invalid syntax,

IITA Input Invalid Target ID (sent by T-TD 'local TID' )


• the command is executed with an invalid TID,

EXAMPLES
In the following example, the attributes for the OCI condition type for VTS port 11DPE12-1-3-L1-VTS1
are retrieved:

RTRV-ATTR-VTS::11DPE12-1-3-L1-VTS1:::,OCI;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11DPE12-1-3-L1-VTS,VTS:CR,OCI,,RCV"
/* RTRV-ATTR-VTS::11DPE12-1-3-L1-VTS1::,OCI [P15119] (1) */;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-VTS

1830PSS R3.6.50 - TL1 Commands and Messages 1761


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTR-VTS
RTRV-COND-ALL
RTRV-COND-VTS
SET-ATTR-VTS

RELATED AUTONOMOUS RESPONSES

1762 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTRSUP-CBRAR


Command Name: RETRIEVE ATTRIBUTE SUPPLEMENTAL
CBRAR

PURPOSE
The RTRV-ATTRSUP-CBRAR command retrieves the current notification codes associated with the
specified conditions on CBRAR facilities. The notification codes given are on a per CONDTYPE per
AID basis.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTRSUP-CBRAR:[TID]:[AID]:[CTAG]::,[CONDTYPE][,,DIRN]:[DATATYPE
=];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1763


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-CBRAR
Description: Correlation TAG, associates input command with its output
responses.

CONDTYPE Value Description


<a valid system condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction

DATATYPE= Value Description


FE
HDSDI
SDSDI
3GSDI

Default: <All Values>


Addressing: None
Description: Client port signal type required when modifier is CBRAR.

1764 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-CBRAR Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,CBRAR:[<NTFCNCDEAID>],[<NTFCNCDEOVR>],<NTFCNCDEDFLT>,<CON
DTYPE>,,<DIRN>[:DATATYPE=<value>]"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Description: Access Identifier, identifies the entity access identifier. See "AID
Usage by Modifier Value" to identify the available AIDs for each
AIDTYPE value.

CBRAR Value Description


CBRAR

Description: Indicates that the attributes retrieved are in connection with


CBRAR.

NTFCNCDEAID Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification code. Identifies the notification code generated by the


system when the condition type occurred. It is set when
SET-ATTR-CBRAR has been set.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed

1830PSS R3.6.50 - TL1 Commands and Messages 1765


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-CBRAR
NR Not Reported

NTFCNCDEOVR Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification code. Identifies the notification code generated by the


system when the condition type occurred. It is set when
SET-ALMPRFL-CBRAR has been set.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

NTFCNCDEDFLT Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification code. Identifies the notification code generated by the


system when the condition type occurred. This is the system level
default value.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid system condition type for the
AID>

1766 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-CBRAR Issue 1, December 2011

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

DATATYPE= Value Description


FE
HDSDI
SDSDI
3GSDI

Description: Client port signal type required when modifier is CBRAR.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent

1830PSS R3.6.50 - TL1 Commands and Messages 1767


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-CBRAR
• the command is entered with an invalid combination of parameters

EXAMPLES
In the following example, the attributes for the MAN condition type for CBRAR port 4DPA4-1-3-C2 are
retrieved:

RTRV-ATTRSUP-CBRAR::4DPA4-1-3-C2:::,MAN;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"4DPA4-1-3-C2,CBRAR:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-CBRAR::4DPA4-1-3-C2:::,MAN [P15119] (1) */
;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-CBRAR
RTRV-COND-ALL

RELATED AUTONOMOUS RESPONSES


None.

1768 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ATTRSUP-RR


Command Name: RETRIEVE ATTRIBUTE SUPPLEMENTAL

PURPOSE
The RTRV-ATTRSUP-rr command retrieves the current notification codes associated with the
specified conditions on facilities specified by the rr modifier. The notification codes given are on a per
CONDTYPE per AID basis.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ATTRSUP-rr:[TID]:[AID]:[CTAG]::,[CONDTYPE][,,DIRN];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1769


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AID Value Description


ALL (ALL AID)
SYSTEM (System AID)
SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Controller)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)

1770 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

AID Value Description


112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
PF-<shelf>-<slot> (Power Filter)
USRPNL-1-<slot> (User Panel)
EC-<shelf>-<slot>-{ES1, ES2} (Shelf Controller Ports, non-main
shelves)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}

1830PSS R3.6.50 - TL1 Commands and Messages 1771


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12E-<shelf>-<slot>-{L{1-2},VA{1- (11DPE12E Ports)
2},C{1-12}}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-{L{1-2},VA{1-2 (11DPM12 Ports)
},C{1-12}}
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12

1772 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

AID Value Description


8} connection plane)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Ports)
LINE, OSC}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)
LINE, OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Ports)
OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Ports)
OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
OSCT-<shelf>-<slot>-{SIG, LINE, (OSCT Managed Ports)
OSCSFP}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)

1830PSS R3.6.50 - TL1 Commands and Messages 1773


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AID Value Description


SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier. See "AID
Usage by Modifier Value" to identify the available AIDs for each
MODIFIER value.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

CONDTYPE Value Description


<a valid system condition type for the
AID>

Default: <All Applicable Values>


Addressing: None
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction

1774 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^["<AID>,<AIDTYPE>:[<NTFCNCDEAID>],[<NTFCNCDEOVR>],<NTFCNCDEDFLT>,
<CONDTYPE>[,,<DIRN>]"] cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1775


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AID Value Description


SYSTEM (System AID)
SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Controller)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)

1776 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

AID Value Description


112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
PF-<shelf>-<slot> (Power Filter)
USRPNL-1-<slot> (User Panel)
EC-<shelf>-<slot>-{ES1, ES2} (Shelf Controller Ports, non-main
shelves)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}

1830PSS R3.6.50 - TL1 Commands and Messages 1777


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AID Value Description


11DPE12E-<shelf>-<slot>-{L{1-2},VA{1- (11DPE12E Ports)
2},C{1-12}}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-{L{1-2},VA{1-2 (11DPM12 Ports)
},C{1-12}}
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Ports)
LINE, OSC}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)

1778 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

AID Value Description


LINE, OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Ports)
OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Ports)
OSC}
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
OSCT-<shelf>-<slot>-{SIG, LINE, (OSCT Managed Ports)
OSCSFP}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)

Description: Access Identifier, identifies the entity access identifier. See "AID
Usage by Modifier Value" to identify the available AIDs for each
AIDTYPE value.

1830PSS R3.6.50 - TL1 Commands and Messages 1779


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AIDTYPE Value Description


1GBE
FE
VTS
10GBE
100GBE
CBR2G5
COM
EQPT
FC100
FC200
FC400
FC800
FC1200
OC3
OC12
OC48
OC192
OC768
OCH
OPTSG
ODU0
ODU1
ODU2
ODU3
ODU4
OTS
OTU1
OTU2
OTU3
OTU4
PLK
STM1
STM4
STM16
STM64
STM256

Description: Identifies the type of AID for the notification being retrieved.

1780 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

NTFCNCDEAID Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification code. Identifies the notification code generated by the


system when the condition type occurred. It is set when
SET-ATTR-rr has been set. When the modifier is COM the
NTFCNCDEAID and NTFCNCDEOVR will have the same value.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

NTFCNCDEOVR Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification code. Identifies the notification code generated by the


system when the condition type occurred. It is set when
SET-ALMPRFL-rr has been set. When the modifier is COM the
NTFCNCDEAID and NTFCNCDEOVR will have the same value.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

1830PSS R3.6.50 - TL1 Commands and Messages 1781


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

NTFCNCDEDFLT Value Description


CR
MJ
MN
WR
NA
NR

Description: Notification code. Identifies the notification code generated by the


system when the condition type occurred. This is the system level
default value.
CR Critical alarm
MJ Major alarm
MN Minor alarm
WR Warning alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid system condition type for the
AID>

Description: Condition Type, specifies the condition type to be retrieved.


For a list of condition types by AID refer to the "Condition types
Appendix".

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>


Addressing: None
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

1782 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• the command is entered with an invalid combination of parameters

EXAMPLES
In the following example, all attributes for non-alarmed COM notifications are retrieved.

RTRV-ATTRSUP-COM::SYSTEM:::NA;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P16102 COMPLD
"COM:NA,MANSWTOINT,NEND,,,NSA"
/* RTRV-ATTRSUP-COM::COM:::NA [P16102] (1) */
;

In the following example, the attributes for the MAN condition type for CBR2G5 port
11STMM10-1-3-C5 are retrieved:

RTRV-ATTRSUP-CBR2G5::11STMM10-1-3-C5:::,MAN;

The output response is shown below.

1830PSS R3.6.50 - TL1 Commands and Messages 1783


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-3-C5,CBR2G5:MJ,MAN,NEND,RCV,,SA"
"11STMM10-1-3-C5,CBR2G5:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-CBR2G5::11STMM10-1-3-C5:::,MAN [P15119] (1) */
;

In the following example, attributes for the P8S16 equipment IMPROPRMVL condition type are
retrieved:

RTRV-ATTRSUP-EQPT::P8S16:::,IMPROPRMVL;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P11113 COMPLD
"P8S16,EQPT:CR,IMPROPRMVL,NEND,,,SA"
"P8S16,EQPT:MN,IMPROPRMVL,NEND,,,NSA"
/* RTRV-ATTRSUP-EQPT::P8S16:::,IMPROPRMVL [P11113] (1) */
;

In the following example, the attributes for the MAN condition type for 1GBE port 11STMM10-1-3-C5
are retrieved:

RTRV-ATTRSUP-1GBE::11STMM10-1-3-C5:::,MAN;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-3-C5,1GBE:MJ,MAN,NEND,RCV,,SA"
"11STMM10-1-3-C5,1GBE:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-1GBE::11STMM10-1-3-C5:::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for 10GBE port 11STAR1-1-3-2-1
are retrieved:

RTRV-ATTRSUP-10GBE::11STAR1-1-3-2-1:::,MAN;

The output response is shown below.

1784 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-2-1,10GBE:MJ,MAN,NEND,RCV,,SA"
"11STAR1-1-3-2-1,10GBE:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-10GBE::11STAR1-1-3-2-1:::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for FC100 port 11STMM10-1-3-C5
are retrieved:

RTRV-ATTRSUP-FC100::11STMM10-1-3-C5:::,MAN;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-3-C5,FC100:MJ,MAN,NEND,RCV,,SA"
"11STMM10-1-3-C5,FC100:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-FC100::11STMM10-1-3-C5:::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for FC1200 port 11STAR1-1-3-2-1
are retrieved:

RTRV-ATTRSUP-FC1200::11STAR1-1-3-2-1:::,MAN;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-2-1,FC1200:MJ,MAN,NEND,RCV,,SA"
"11STAR1-1-3-2-1,FC1200:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-FC1200::11STAR1-1-3-2-1:::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for OC12 port 11STMM10-1-3-2-1
are retrieved:

RTRV-ATTRSUP-OC12::11STMM10-1-3-2-1:::,MAN;

The output response is shown below.

1830PSS R3.6.50 - TL1 Commands and Messages 1785


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STMM10-1-3-2-1,OC12:MJ,MAN,NEND,RCV,,SA"
"11STMM10-1-3-2-1,OC12:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-OC12::11STMM10-1-3-2-1:::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for OC192 port 11STAR1-3-2-C1
are retrieved:

RTRV-ATTRSUP-OC192::11STAR1-3-2-C1:::,MAN;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-3-2-C1,OC192:MJ,MAN,NEND,RCV,,SA"
"11STAR1-3-2-C1,OC192:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-OC192::11STAR1-3-2-C1:::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for OCH port 11STAR1-1-3-C1 are
retrieved:

RTRV-ATTRSUP-OCH::11STAR1-1-3-C1:::,MAN;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,OCH:MJ,MAN,NEND,RCV,,SA"
"11STAR1-1-3-C1,OCH:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-OCH::11STAR1-1-3-C1::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for ODU2 port 11STAR1-1-3-C1 are
retrieved:

RTRV-ATTRSUP-ODU2::11STAR1-1-3-C1:::,MAN;

The output response is shown below.

1786 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ATTRSUP-RR Issue 1, December 2011

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"11STAR1-1-3-C1,ODU2:MJ,MAN,NEND,RCV,,SA"
"11STAR1-1-3-C1,ODU2:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-ODU2::11STAR1-1-3-C1::,MAN [P15119] (1) */
;

In the following example, the attributes for the MAN condition type for OTS port ALPHG-1-3-LINE are
retrieved:

RTRV-ATTRSUP-OTS::ALPHG-1-3-LINE:::,MAN;

The output response is shown below.

AM1587 03-08-12 09:08:33


M P15119 COMPLD
"ALPHG-1-3-LINE,OTS:MJ,MAN,NEND,RCV,,SA"
"ALPHG-1-3-LINE,OTS:NA,MAN,NEND,RCV,,NSA"
/* RTRV-ATTRSUP-OTS::ALPHG-1-3-LINE::,MAN [P15119] (1) */
;

RELATED COMMANDS
RTRV-ALM-ALL
RTRV-ALM-rr
RTRV-COND-ALL

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 1787


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ATTRSUP-RR

1788 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-AUDIT-SECULOG


Command Name: RETRIEVE SECURITY LOG PRIVILEGE

PURPOSE
The RTRV-AUDIT-SECULOG command selectively retrieves the security log entries, stored in the
system's disk output buffer, that were generated by the system between the specified FRDATM (From
Date and Time) and TODATM (To Date and Time) values.
The RTRV-AUDIT-SECULOG command is allowed to be used only by a user with administrator
privileges.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-AUDIT-SECULOG:[TID]::[CTAG]::[FRDATM],[TODATM];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

FRDATM Value Description


{2003-2037}-{01-12}-{ 01-31 } { 00-23 }:{
00-59 }:{ 00-59 }

Default: <Oldest Date & Time in the Disk Output Buffer>


Addressing: None
Description: From Date and Time, specifies the beginning date and time used
to filter the response messages from the disk output buffer in the

1830PSS R3.6.50 - TL1 Commands and Messages 1789


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-AUDIT-SECULOG
format of a quoted string <Year>-<Month>-<Day>
<Hour>:<Minute>:<Second>.
NOTE: Double quotes are needed to make the parser correctly
manage the colons (:) separators between hour, minutes and
seconds.

TODATM Value Description


{2003-2037}-{01-12}-{ 01-31 } { 00-23 }:{
00-59 }:{ 00-59 }

Default: <Current Date & Time in the Disk Output Buffer>


Addressing: None
Description: To Date and Time, specifies the ending date and time used to filter
the response messages from the disk output buffer in the format of
a quoted string <Year>-<Month>-<Day>
<Hour>:<Minute>:<Second>.
NOTE: Double quotes are needed to make the parser correctly
manage the colons (:) separators between hour, minutes and
seconds.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<TimeStamp>,<SourceAddress>,<Command>" cr lf]
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

TimeStamp Value Description


{2003-2037}-{01-12}-{ 01-31 } { 00-23 }:{
00-59 }:{ 00-59 }

Description: It specifies the date and time the logged event occurred

SourceAddress Value Description


{0-255}.{0-255}.{0-255}.{0-255}.{0-6553
5}
Local

Description: SourceAddress is the IP addr of the user, or "Local" if local craft.


This parameter is required ONLY for login attempts.

1790 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-AUDIT-SECULOG Issue 1, December 2011

Command Value Description


<Any TL1 Command>
<INTRUSION informational text>

Description: This parameter specifies command and events that are logged.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• the value for TODATM is older than the value for FRDATM

EXAMPLES
The following example illustrates the command and associated output for retrieving all response
messages from the disk output buffer that were generated by the system, without specifying any
starting, ending date&time and userID.

ACT-USER::SYSTEM:1::********; NE1850 06-04-20 19:23:30A 0 REPT


EVT SESSION "SYSTEM:NO," /* WARNING Contents are proprietary for
use by authorized users only. System may be monitored.
Misuse may be prosecuted. */; NE1850 06-04-20 19:23:30M 1
COMPLD "SYSTEM:LASTLOGIN=\"2006-03-24
22:26:16\",UNSUCCESSATTEMPTS=0";ENT-USER-SECU::ciccio2:1::********,,
READ; NE1850 06-04-20 19:24:33M 1 COMPLD;RTRV-AUDIT-SECULOG;
NE1850 06-04-20 19:25:41M GOA001 COMPLD "2006-04-20
19:23:30,TL1,SYSTEM,NETADMIN&SEC&DEBUG&NOTMOUT,4,127.0.0.1.58246,308
3,EIUA,COMPLD,act-user::SYSTEM:1::********" "2006-04-20
19:24:33,TL1,SYSTEM,NETADMIN&SEC&DEBUG&NOTMOUT,4,,EUSP,COMPLD,ent-us
er-secu::ciccio2:1::********,,READ" /* Number of Retrieved Log
Entries = 2 */ cr lf ;

1830PSS R3.6.50 - TL1 Commands and Messages 1791


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-AUDIT-SECULOG

ON ANOTHER CONNECTION a failed login

ACT-USER::ciccio2:1::***********; NE1850 06-04-20 19:26:18M 1


DENY;ON THE INITIAL CONNECTION (SYSTEM)RTRV-AUDIT-SECULOG; NE1850
06-04-20 19:26:22M GOA002 COMPLD "2006-04-20
19:23:30,TL1,SYSTEM,NETADMIN&SEC&DEBUG&NOTMOUT,4,127.0.0.1.58246,308
3,EIUA,COMPLD,act-user::SYSTEM:1::********" "2006-04-20
19:24:33,TL1,SYSTEM,NETADMIN&SEC&DEBUG&NOTMOUT,4,,EUSP,COMPLD,ent-us
er-secu::ciccio2:1::********,,READ" "2006-04-20
19:26:18,TL1,NULL,NULL,50,127.0.0.1.15239,3083,EIUA,DENY,act-user::c
iccio2:1::***********" /* Number of Retrieved Log Entries = 3 */
cr lf /* RTRV-AUDIT-SECULOG [P1f200] (4) */;

AFTER MORE ATTEMPTS OF FAILED LOGINS

RTRV-AUDIT-SECULOG; NE1850 06-04-20 19:28:24M GOA003 COMPLD


"2006-04-20
19:23:30,TL1,SYSTEM,NETADMIN&SEC&DEBUG&NOTMOUT,4,127.0.0.1.58246,308
3,EIUA,COMPLD,act-user::SYSTEM:1::********" "2006-04-20
19:24:33,TL1,SYSTEM,NETADMIN&SEC&DEBUG&NOTMOUT,4,,EUSP,COMPLD,ent-us
er-secu::ciccio2:1::********,,READ" "2006-04-20
19:26:18,TL1,NULL,NULL,50,127.0.0.1.15239,3083,EIUA,DENY,act-user::c
iccio2:1::***********" "2006-04-20
19:28:07,TL1,NULL,NULL,50,127.0.0.1.15239,3083,EIUA,DENY,act-user::c
iccio2:1::***********" "2006-04-20
19:28:08,TL1,NULL,NULL,50,127.0.0.1.15239,3083,EIUA,DENY,act-user::c
iccio2:1::***********" "2006-04-20
19:28:09,TL1,NULL,NULL,50,127.0.0.1.15239,3083,EIUA,DENY,act-user::c
iccio2:1::***********" "2006-04-20
19:28:11,TL1,NULL,NULL,127.0.0.1.15239,3083,EIUA,DENY,act-user::cicc
io2:1::***********" "2006-04-20
19:28:11,TL1,ciccio2,READ,50,127.0.0.1.15239,3083,EIUA,OTHER,INTRUSI
ON ON USER ciccio2 FROM 127.0.0.1.15239. USER IN OOS" /* Number of
Retrieved Log Entries = 8 */ cr lf ;

RELATED COMMANDS
None

RELATED AUTONOMOUS RESPONSES


None

1792 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-10GBE


Command Name: RETRIEVE BASELINED VALUES FOR
10GBE FACILITY

PURPOSE
The RTRV-BASELINE-10GBE command retrieves the baselined values of analog parameters for the
specified 10GBE facility.
The successful response for a RTRV-BASELINE-10GBE command contains one line of parsable
output data for each PM parameter being reported, for each 10GBE AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-10GBE:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Default: ALL

1830PSS R3.6.50 - TL1 Commands and Messages 1793


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-10GBE
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1794 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-10GBE Issue 1, December 2011

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


{OPR, OPT}
OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:

1830PSS R3.6.50 - TL1 Commands and Messages 1795


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-10GBE
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for 10GBE port 11STAR1-1-6-C1 are retrieved.

RTRV-BASELINE-10GBE:: 11STAR1-1-6-C1:12345::;

1796 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-10GBE Issue 1, December 2011

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STAR1-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STAR1-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-10GBE:: 11STAR1-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-10GBE

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 1797


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-10GBE

1798 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-CBR2G5


Command Name: RETRIEVE BASELINED VALUES FOR
CBR2G5 FACILITY

PURPOSE
The RTRV-BASELINE-CBR2G5 command retrieves the baselined values of analog parameters for the
specified CBR2G5 facility.
The successful response for a RTRV-BASELINE-CBR2G5 command contains one line of parsable
output data for each PM parameter being reported, for each CBR2G5 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-CBR2G5:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1799


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-CBR2G5

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

1800 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-CBR2G5 Issue 1, December 2011

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for CBR2G5 port 11STMM10-1-6-C1 are retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1801


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-CBR2G5

RTRV-BASELINE-CBR2G5:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-CBR2G5:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-CBR2G5

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1802 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-CBRAR


Command Name: RETRIEVE BASELINED VALUES FOR
CBRAR FACILITY

PURPOSE
The RTRV-BASELINE-CBRAR command retrieves the baselined values of analog parameters for the
specified CBRAR facility (DATATYPE=FE or DATATYPE=HDSDI or SDSDI or 3GSDI ).
The successful response for a RTRV-BASELINE-CBRAR command contains one line of parsable
output data for each PM parameter being reported, for each CBRAR AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-CBRAR:[TID]:[AID]:[CTAG]::[MONTYPE]:[DATATYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1803


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-CBRAR
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

DATATYPE Value Description


{FE, HDSDI,SDSDI,3GSDI}

Default: FE
Addressing: None
Description: DATATYPE specifies the client data type (FE or HDSDI or SDSDI
or 3GSDI) whose baselined value will be reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>,<DATATYPE>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

1804 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-CBRAR Issue 1, December 2011

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

DATATYPE Value Description


{FE, HDSDI,SDSDI,3GSDI}

Description: DATATYPE indicates the client data type whose baselined value is
retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1805


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-CBRAR
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values are retrieved for 4DPA4-1-6-C1 with CBRAR port
(DATATYPE=FE).

RTRV-BASELINE-CBRAR:: 4DPA4-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 4DPA4-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3,FE"
" 4DPA4-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7,FE"
/* RTRV-BASELINE-CBRAR:: 4DPA4-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-CBRAR

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1806 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-FC100


Command Name: RETRIEVE BASELINED VALUES FOR
FC100 FACILITY

PURPOSE
The RTRV-BASELINE-FC100 command retrieves the baselined values of analog parameters for the
specified GFC facility.
The successful response for a RTRV-BASELINE-FC100 command contains one line of parsable
output data for each PM parameter being reported, for each FC100 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-FC100:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1807


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC100
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1808 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-FC100 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1809


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC100
EXAMPLES
In the following example, baselined values for FC100 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-FC100:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-FC100:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-FC100

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1810 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-FC1200


Command Name: RETRIEVE BASELINED VALUES FOR
FC1200 FACILITY

PURPOSE
The RTRV-BASELINE-FC1200 command retrieves the baselined values of analog parameters for the
specified GFC10 facility.
The successful response for a RTRV-BASELINE-FC1200 command contains one line of parsable
output data for each PM parameter being reported, for each FC1200 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-FC1200:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1811


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC1200

MONTYPE Value Description


{OPR, OPT, ALL}
OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


{OPR, OPT}
OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1812 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-FC1200 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type


(covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1813


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC1200
EXAMPLES
In the following example, baselined values for FC1200 port 11STAR1-1-6-C1 are retrieved.

RTRV-BASELINE-FC1200:: 11STAR1-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STAR1-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STAR1-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-FC1200:: 11STAR1-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1814 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-FC200


Command Name: RETRIEVE BASELINED VALUES FOR
FC200 FACILITY

PURPOSE
The RTRV-BASELINE-FC200 command retrieves the baselined values of analog parameters for the
specified FC200 facility.
The successful response for a RTRV-BASELINE-FC200 command contains one line of parsable
output data for each PM parameter being reported, for each FC200 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-FC200:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1815


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC200
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1816 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-FC200 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1817


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC200
EXAMPLES
In the following example, baselined values for FC200 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-FC200:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-FC200:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-FC200

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1818 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-FC400


Command Name: RETRIEVE BASELINED VALUES FOR
FC400 FACILITY

PURPOSE
The RTRV-BASELINE-FC400 command retrieves the baselined values of analog parameters for the
specified FC400 facility.
The successful response for a RTRV-BASELINE-FC400 command contains one line of parsable
output data for each PM parameter being reported, for each FC400 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-FC400:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1819


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC400
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1820 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-FC400 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1821


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC400
EXAMPLES
In the following example, baselined values for FC400 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-FC400: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-FC400:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-FC400

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1822 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-FC800


Command Name: RETRIEVE BASELINED VALUES FOR
FC800 FACILITY

PURPOSE
The RTRV-BASELINE-FC800 command retrieves the baselined values of analog parameters for the
specified FC800 facility.
The successful response for a RTRV-BASELINE-FC800 command contains one line of parsable
output data for each PM parameter being reported, for each FC800 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-FC800:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1823


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC800

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

1824 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-FC800 Issue 1, December 2011

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

1830PSS R3.6.50 - TL1 Commands and Messages 1825


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FC800
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for FC800 port 112SCX10-1-6-C1 are retrieved.

RTRV-BASELINE-FC800: 112SCX10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 112SCX10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 112SCX10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-FC800:: 112SCX10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-FC800

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1826 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-FE


Command Name: RETRIEVE BASELINED VALUES FOR FE
FACILITY

PURPOSE
The RTRV-BASELINE-FE command retrieves the baselined values of analog parameters for the
specified FE facility.
The successful response for a RTRV-BASELINE-FE command contains one line of parsable output
data for each PM parameter being reported, for each FE AID specified. A line of parsable output data
is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-FE:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1827


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FE

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

1828 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-FE Issue 1, December 2011

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for FE port 11DPE12E-1-6-C1 are retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1829


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-FE

RTRV-BASELINE-FE:: 11DPE12E-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11DPE12E-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11DPE12E-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-FE:: 11DPE12E-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-FE

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-GBE


Command Name: RETRIEVE BASELINED VALUES FOR
1GBE FACILITY

PURPOSE
The RTRV-BASELINE-GBE command retrieves the baselined values of analog parameters for the
specified 1GBE facility.
The successful response for a RTRV-BASELINE-GBE command contains one line of parsable output
data for each PM parameter being reported, for each 1GBE AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-GBE:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1831


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-GBE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Description: Access Identifier, identifies the entity access identifier.

1832 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-GBE Issue 1, December 2011

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

1830PSS R3.6.50 - TL1 Commands and Messages 1833


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-GBE
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for 1GBE port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-GBE:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-GBE:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-1GBE

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1834 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OC12


Command Name: RETRIEVE BASELINED VALUES FOR
OC12 FACILITY

PURPOSE
The RTRV-BASELINE-OC12 command retrieves the baselined values of analog parameters for the
specified OC12 facility.
The successful response for a RTRV-BASELINE-OC12 command contains one line of parsable output
data for each PM parameter being reported, for each OC12 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OC12:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1835


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC12
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1836 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OC12 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1837


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC12
EXAMPLES
In the following example, baselined values for OC12 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-OC12:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OC12:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OC12

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1838 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OC192


Command Name: RETRIEVE BASELINED VALUES FOR
OC192 FACILITY

PURPOSE
The RTRV-BASELINE-OC192 command retrieves the baselined values of analog parameters for the
specified OC192 facility.
The successful response for a RTRV-BASELINE-OC192 command contains one line of parsable
output data for each PM parameter being reported, for each OC192 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OC192:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
ALL

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1839


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC192
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1840 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OC192 Issue 1, December 2011

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system

1830PSS R3.6.50 - TL1 Commands and Messages 1841


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC192
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for OC192 port 11STAR1-1-6-C1 are retrieved.

RTRV-BASELINE-OC192:: 11STAR1-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STAR1-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STAR1-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OC192:: 11STAR1-1-6-C1:12345:: [12345] (1) */
;

1842 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OC192 Issue 1, December 2011

RELATED COMMANDS
SET-BASELINE-OC192

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 1843


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC192

1844 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OC3


Command Name: RETRIEVE BASELINED VALUES FOR
OC3 FACILITY

PURPOSE
The RTRV-BASELINE-OC3 command retrieves the baselined values of analog parameters for the
specified OC3 facility.
The successful response for a RTRV-BASELINE-OC3 command contains one line of parsable output
data for each PM parameter being reported, for each OC3 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OC3:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1845


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC3
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1846 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OC3 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1847


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC3
EXAMPLES
In the following example, baselined values for OC3 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-OC3:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OC3:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OC3

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1848 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OC48


Command Name: RETRIEVE BASELINED VALUES FOR
OC48 FACILITY

PURPOSE
The RTRV-BASELINE-OC48 command retrieves the baselined values of analog parameters for the
specified OC48 facility.
The successful response for a RTRV-BASELINE-OC48 command contains one line of parsable output
data for each PM parameter being reported, for each OC48 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OC48:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1849


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC48
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

1850 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OC48 Issue 1, December 2011

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 1851


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC48
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for OC48 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-OC48:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OC48:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OC48

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1852 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OC768


Command Name: RETRIEVE BASELINED VALUES FOR
OC768 FACILITY

PURPOSE
The RTRV-BASELINE-OC768 command retrieves the baselined values of analog parameters for the
specified OC768 facility.
The successful response for a RTRV-BASELINE-OC768 command contains one line of parsable
output data for each PM parameter being reported, for each OC768 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OC768:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1853


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC768
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1854 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OC768 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1855


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OC768
EXAMPLES
In the following example, baselined values for OC768 port 43STA1P-1-6-C1 are retrieved.

RTRV-BASELINE-OC768:: 43STA1P-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 43STA1P-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 43STA1P-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OC768:: 43STA1P-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OC768

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1856 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OCH


Command Name: RETRIEVE BASELINED VALUES FOR
OPTICAL CHANNEL

PURPOSE
The RTRV-BASELINE-OCH command retrieves the baselined values of analog parameters for the
specified OCH facility.
The successful response for a RTRV-BASELINE-OCH command contains one line of parsable output
data for each PM parameter being reported, for each OCH AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OCH:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1857


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OCH

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)

Description: Access Identifier, identifies the entity access identifier.

1858 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OCH Issue 1, December 2011

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type. NA


indicates that for specified monitored type baselined value hasn't
been established.

1830PSS R3.6.50 - TL1 Commands and Messages 1859


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OCH
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for OCH port 4DPA4-1-6-VA1 are retrieved.

RTRV-BASELINE-OCH::4DPA4-1-6-VA1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"4DPA4-1-6-VA1:OPR,03-12-10-25,LOS_CLRD,-18.3"
"4DPA4-1-6-VA1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OCH::4DPA4-1-6-VA1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OCH

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1860 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OSC


Command Name: RETRIEVE BASELINED VALUES FOR
OPTICAL SUPERVISORY CHANNEL

PURPOSE
The RTRV-BASELINE-OSC command retrieves the baselined values of analog parameters for the
specified OSC facility.
The successful response for a RTRV-BASELINE-OSC command contains one line of parsable output
data for each PM parameter being reported, for each OSC AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OSC:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
ALL

1830PSS R3.6.50 - TL1 Commands and Messages 1861


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OSC
Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1862 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OSC Issue 1, December 2011

AID Value Description


AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)

Description: Access Identifier, identifies the entity access identifier.


LDRXA[B]PORT-xx-xx-xx-OSCLINEIN is used for OSC port
ingress direction monitoring while
LDTXA[B]PORT-xx-xx-xx-OSCIN in (U)ROADM and
LDRXA[B]PORT-xx-xx-xx-OSC_IN in (U)ILA is used for OSC port
egress direction monitoring.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, NEW_SYSTEM,
OT_REPLACED, 0, 1, 2, 3, 4, 5, 6, 7, 8,
9}

Description: This parameter defines the reason for baselining. Values are:

1830PSS R3.6.50 - TL1 Commands and Messages 1863


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OSC
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.

NEW_SYSTEM Indicates that the reason for baselining is


installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type


(covering range of -51.0 dBm to +51.0 dBm). NA indicates that for
specified monitored type baselined value hasn't been established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for OSC port ALPHG-1-9-OSC are retrieved.

RTRV-BASELINE-OSC:: ALPHG-1-9-OSC:12345::;

1864 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OSC Issue 1, December 2011

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" ALPHG-1-9-OSC:OPR,03-12-10-25,LOS_CLRD,-18.3"
/* RTRV-BASELINE-OSC:: ALPHG-1-9-OSC:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OSC

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 1865


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OSC

1866 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OTU1


Command Name: RETRIEVE BASELINED VALUES FOR
OTU1 FACILITY

PURPOSE
The RTRV-BASELINE-OTU1 command retrieves the baselined values of analog parameters for the
specified OTU1 facility.
The successful response for a RTRV-BASELINE-OTU1 command contains one line of parsable output
data for each PM parameter being reported, for each OTU1 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OTU1:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1867


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU1
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1868 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OTU1 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1869


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU1
EXAMPLES
In the following example, baselined values for OTU1 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-OTU1:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"
" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OTU1:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OTU1

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1870 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OTU2


Command Name: RETRIEVE BASELINED VALUES FOR
OTU2 FACILITY

PURPOSE
The RTRV-BASELINE-OTU2 command retrieves the baselined values of analog parameters for the
specified OTU2 facility.
The successful response for a RTRV-BASELINE-OTU2 command contains one line of parsable output
data for each PM parameter being reported, for each OTU2 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OTU2:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1871


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU2

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

1872 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OTU2 Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11STGE12-{1}-{7}-{L1,L2} (11DPGE12 Line Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1830PSS R3.6.50 - TL1 Commands and Messages 1873


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU2
Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1874 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OTU2 Issue 1, December 2011

EXAMPLES
In the following example, baselined values for OTU2 port 11STAR1-1-6-C1 are retrieved.

RTRV-BASELINE-OTU2:: 11STAR1-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STAR1-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STAR1-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OTU2:: 11STAR1-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OTU2

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 1875


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU2

1876 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OTU3


Command Name: RETRIEVE BASELINED VALUES FOR
OTU3 FACILITY

PURPOSE
The RTRV-BASELINE-OTU3 command retrieves the baselined values of analog parameters for the
specified OTU3 facility.
The successful response for a RTRV-BASELINE-OTU3 command contains one line of parsable output
data for each PM parameter being reported, for each OTU3 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OTU3:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1877


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU3
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

1878 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OTU3 Issue 1, December 2011

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

1830PSS R3.6.50 - TL1 Commands and Messages 1879


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU3
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for OTU3 port 43STX4-1-6-L1 are retrieved.

RTRV-BASELINE-OTU3:: 43STX4-1-6-L1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 43STX4-1-6-L1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 43STX4-1-6-L1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OTU3:: 43STX4-1-6-L1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OTU3

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1880 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-OTU4


Command Name: RETRIEVE BASELINED VALUES FOR
OTU4 FACILITY

PURPOSE
The RTRV-BASELINE-OTU4 command retrieves the baselined values of analog parameters for the
specified OTU4 facility.
The successful response for a RTRV-BASELINE-OTU4 command contains one line of parsable output
data for each PM parameter being reported, for each OTU4 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-OTU4:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 1881


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU4
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

1882 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-OTU4 Issue 1, December 2011

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

1830PSS R3.6.50 - TL1 Commands and Messages 1883


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-OTU4
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for OTU4 port 112SCX10-1-6-L1 are retrieved.

RTRV-BASELINE-OTU4:: 112SCX10-1-6-L1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 112SCX10-1-6-L1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 112SCX10-1-6-L1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-OTU4:: 112SCX10-1-6-L1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-OTU4

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1884 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-STM16


Command Name: RETRIEVE BASELINED VALUES FOR
STM16 FACILITY

PURPOSE
The RTRV-BASELINE-STM16 command retrieves the baselined values of analog parameters for the
specified STM16 facility.
The successful response for a RTRV-BASELINE-STM16 command contains one line of parsable
output data for each PM parameter being reported, for each STM16 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-STM16:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 1885


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM16
Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

1886 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-STM16 Issue 1, December 2011

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 1887


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM16
ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for STM16 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-STM16:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-STM16:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-STM16

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1888 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-STM1


Command Name: RETRIEVE BASELINED VALUES FOR
STM1 FACILITY

PURPOSE
The RTRV-BASELINE-STM1 command retrieves the baselined values of analog parameters for the
specified STM1 facility.
The successful response for a RTRV-BASELINE-STM1 command contains one line of parsable output
data for each PM parameter being reported, for each STM1 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-STM1:[TID]:AID:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1889


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM1
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1890 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-STM1 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1891


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM1
EXAMPLES
In the following example, baselined values for STM1 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-STM1:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-STM1:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-STM1

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1892 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-STM256


Command Name: RETRIEVE BASELINED VALUES FOR
STM256 FACILITY

PURPOSE
The RTRV-BASELINE-STM256 command retrieves the baselined values of analog parameters for the
specified STM256 facility.
The successful response for a RTRV-BASELINE-STM256 command contains one line of parsable
output data for each PM parameter being reported, for each STM256 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-STM256:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1893


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM256

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

1894 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-STM256 Issue 1, December 2011

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for the STM256 port 11STAR1-1-6-C1 are retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1895


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM256

RTRV-BASELINE-STM256:: 43STA1P-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 43STA1P-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 43STA1P-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-STM256:: 43STA1P-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-STM256

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1896 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-STM4


Command Name: RETRIEVE BASELINED VALUES FOR
STM4 FACILITY

PURPOSE
The RTRV-BASELINE-STM4 command retrieves the baselined values of analog parameters for the
specified STM4 facility.
The successful response for a RTRV-BASELINE-STM4 command contains one line of parsable output
data for each PM parameter being reported, for each STM4 AID specified. A line of parsable output
data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-STM4:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 1897


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM4
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

1898 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-STM4 Issue 1, December 2011

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility

Note: LOS_CLRD is not applicable when <MONTYPE> is


OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1899


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM4
EXAMPLES
In the following example, baselined values for STM4 port 11STMM10-1-6-C1 are retrieved.

RTRV-BASELINE-STM4:: 11STMM10-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STMM10-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STMM10-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-STM4:: 11STMM10-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-STM4

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1900 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-BASELINE-STM64


Command Name: RETRIEVE BASELINED VALUES FOR
STM64 FACILITY

PURPOSE
The RTRV-BASELINE-STM64 command retrieves the baselined values of analog parameters for the
specified STM64 facility.
The successful response for a RTRV-BASELINE-STM64 command contains one line of parsable
output data for each PM parameter being reported, for each STM64 AID specified. A line of parsable
output data is only displayed if the specified AID is provisioned.

INPUT FORMAT

RTRV-BASELINE-STM64:[TID]:[AID]:[CTAG]::[MONTYPE];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1901


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM64

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined
ALL All Supported Parameters Baselined

Default: ALL
Addressing: None
Description: Montype specifies monitored type which baselined value will be
reported.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<MONTYPE>,<TIME>,<REASON>,<BASEVAL>" cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

1902 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-BASELINE-STM64 Issue 1, December 2011

MONTYPE Value Description


OPR Optical Power Received Baselined
OPT Optical Power Transmitted Baselined

Description: Montype indicates analog monitored type which baselined value is


retrieved.

TIME Value Description


{ MONTH - DAY - HOUR - MINUTE :
{01-12} - {01-31} - {00-23} - {00-59}}

Description: Time indicates the time stamp of the latest baselining. If the
baselined value is NA then MONTH-DAY-HOUR-MINUTE shall
have the value of 00-00-00-00.

REASON Value Description


{LOS_CLRD, LASER_ON,
NEW_SYSTEM, OT_REPLACED, 0, 1,
2, 3, 4, 5, 6, 7, 8, 9}

Description: This parameter defines the reason for baselining. Values are:
LOS_CLRD Loss of signal has been cleared on the
facility
Note: LOS_CLRD is not applicable when <MONTYPE> is
OPT.
LASER_ON Laser has been turned on (applies to OPT
parameter baselining)
NEW_SYSTEM Indicates that the reason for baselining is
installation of a new system
OT_REPLACED OT Pack is being replaced
0-9 User configurable code for baselining reason.

BASEVAL Value Description


[-51.0 - +51.0]
NA

Description: Baseval indicates the value of the specified monitored type (


covering the range of -51.0 dBm to +51.0 dBm). NA indicates that
for specified monitored type baselined value hasn't been
established.

1830PSS R3.6.50 - TL1 Commands and Messages 1903


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-BASELINE-STM64
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, baselined values for the STM64 port 11STAR1-1-6-C1 are retrieved.

RTRV-BASELINE-STM64:: 11STAR1-1-6-C1:12345::;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" 11STAR1-1-6-C1:OPR,03-12-10-25,LOS_CLRD,-18.3"

" 11STAR1-1-6-C1:OPT,01-10-08-11,OT_REPLACED,-2.7"
/* RTRV-BASELINE-STM64:: 11STAR1-1-6-C1:12345:: [12345] (1) */
;

RELATED COMMANDS
SET-BASELINE-STM64

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1904 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-CBR2G5


Command Name: RTRV-CBR2G5

PURPOSE
The RTRV-CBR2G5 command shall be used to retrieve all parameters related to the CBR2G5 client
port. The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-CBR2G5:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1905


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CBR2G5
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,MAPPINGMODE=<value>][,SDTH=<value>][,SFTH=<value>][,J0_EX=<value>][
,J0_FMT=<value>][,TRCCMP=<value>][,J0_STAT=<value>][,LOSPROP=<value>
][,MODULETYPE=<value>][,CHANNEL=<value>][,DESCR=<value>][,TS=\"<valu
e>\"][,RXPOWER=<value>][,TXPOWER=<value>]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{{00-96}-{00-59}} (Time, in HH-MM format)

Description: Automatic In-Service Timer value, specifies how much time is


currently remaining on the AINS timer before the facility is placed
in service.
The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, transition soak time out of AINS.

1906 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CBR2G5 Issue 1, December 2011

Format is HOURS-MINUTES. The maximum time is 96-00. The


minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

MAPPINGMODE= Value Description


{BITSYNC,ASYNC}

Description: Type of mapping of CBR2G5 into an ODU1 strucutre

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Description: Attribute that specifies BER threshold for SD defect decalration.

SFTH= Value Description


{10-3,10-4, 10-5}

Description: Attribute that specifies BER threshold for Excessive BER defect
decalration.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Expected J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Description: J0 format.

TRCCMP= Value Description


{ENABLED, DISABLED}

1830PSS R3.6.50 - TL1 Commands and Messages 1907


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CBR2G5
Description: J0 section trace comparison. This parameter enables and
disables comparison between the incoming J0 section trace value
and the provisioned (i.e., expected) J0 value.

J0_STAT= Value Description


{UNAVAILABLE,NORMAL,MISMATCH,
UNSPECIFIED}

Description: J0 Incoming Status. This is the status of the incoming section


trace.
• UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) .
The received value in this case may be omitted or a
"?" may be used.
• NORMAL This indicates that the incoming and the
expected trace contains a valid match. The received value in this
case is shown.

• MISMATCH This indicates that the incoming and the


expected trace do not match. The received value in this case is
shown.

• UNSPECIFIED This indicates that the comparison parameter is


set to disabled. The received value in this case may be left blank
"".

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SS-16.1A,
SS-16.2C}

Description: Attribute that defines the pluggable module type used in providing
the physical layer function on the specified CBR2G5 port. If the
value AUTO is chosen, the NE shall accept the pluggable module
type inserted in the socket if the previous MODULETYPE value
was <null>. If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set to USER.

1908 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CBR2G5 Issue 1, December 2011

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)

Description: Attribute that shows the starting time slot in the line port ODU1
structure.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal

1830PSS R3.6.50 - TL1 Commands and Messages 1909


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CBR2G5
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1910 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CBR2G5 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a


RTRV-CBR2G5 command.
RTRV-CBR2G5:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STMM10-1-5-C1::AINSCNTDWN=00-05,AINSREF=SYSTEM,AINSTMR=08-00,MAPP
INGMODE=BITSYNC,,SDTH=10-6, SFTH=10-3, J0_EX="TRAILTRACE",
TRCCMP=ENABLED,
J0_STAT=NORMAL,LOSPROP=LASERON,MODULETYPE=AUTO,CHANNEL=1491,DESCR=\"
\",TS="ODU1-L1-2-1",RXPOWER=-3.62,TXPOWER=-1.06:IS-NR,"
;

RELATED COMMANDS
ENT-CBR2G5
RTRV-CBR2G5
RST-CBR2G5
DLT-CBR2G5
ED-CBR2G5
RMV-CBR2G5

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 1911


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CBR2G5

1912 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-CBRAR


Command Name: RTRV-CBRAR

PURPOSE
The RTRV-CBRAR command shall be used to retrieve all parameters related to the CBRAR client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-CBRAR:[TID]:AID:[CTAG]:::DATATYPE=;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1913


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CBRAR

DATATYPE= Value Description


{HDSDI, FE, SDSDI, 3GSDI}

Default: Entry required


Addressing: None
Description: Specifies the client signal type. Must equal the value previously
assigned by ENT-CBRAR.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::DATATYPE=<value>[,AINSCNTDWN=<value>][,AINSREF=<value>][,
AINSTMR=<value>][,LOSPROP=<value>][,MODULETYPE=<value>][,CHANNEL=<va
lue>][,DESCR=<value>][,TS=\"<value>\"][,RXPOWER=<value>][,TXPOWER=<v
alue>][,CONTAINER=<value>]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

DATATYPE= Value Description


{HDSDI, FE, SDSDI, 3GSDI}

Description: Specifies the client signal type. Must equal the value previously
assigned by ENT-CBRAR.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service. The maximum time is 96-00.

1914 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CBRAR Issue 1, December 2011

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, 100BLX10, FE-BX40D,
FE-BX40U} (for
DATATYPE = FE)
{AUTO, USER, SL-16.2C, SS-16.1A,
SS-16.2C} (for DATATYPE =
HDSDI)
{AUTO, USER, SL-16.2C, SS-16.1A,
SS-16.2C} (for DATATYPE =
SDSDI)
{AUTO,USER,3GSDI-SH,3GSDI-MH}
(for DATATYPE=3GSDI)

Description: Attribute that defines the pluggable module type used in providing
the physical layer function on the specified GFC port. If the value
AUTO is chosen, the NE shall accept the pluggable module type
inserted in the socket if the previous MODULETYPE value was
<null>. If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set to USER.

1830PSS R3.6.50 - TL1 Commands and Messages 1915


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CBRAR

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1490, 1530, 1550} (B&W
wavelengths)

Description: Specifies the channel frequency of the client port.


Note: 1490 and 1530 B&W wavelengths are used only for 4DPA4 client
ports.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


{L1,L2}-(<ts_list>) (4DPA4
timeslots)
0-0 (unassigned 4DPA4 timeslot)

Description: Timeslot assignment on the specified Line port. Timeslots are


numbered 1-16 within the ODU1 on each line. HDSDI requires 10
timeslots. FE requires 1 timeslot. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, it
indicates a contiguous range of timeslots starting at that value.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

1916 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CBRAR Issue 1, December 2011

CONTAINER= Value Description


{None,ODU0, ODU1, ODUf}

Description: Specifies the granularity for client signal mapping to ODU2


multiplexing structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
Set to odu1- mapping into ODU1 per G.709.
Set to oduf - mapping into ODUF per G.709
This parameter only applies to 11DPM12.
ODU0 can be provisioned when Datatype=SDSDI or FE.
ODU1 can be provisioned when Datatype=HDSDI.
ODUf can be provisioned when Datatype=3GSDI.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

1830PSS R3.6.50 - TL1 Commands and Messages 1917


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CBRAR
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-CBRAR


command.
RTRV-CBRAR:NODE-1:4DPA4-1-5-C1:123456:::DATATYPE=HDSDI;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"4DPA4-1-5-C1::DATATYPE=HDSDI, AINSCNTDWN=00-00, AINSREF=SYSTEM,
AINSTMR=08-00,LOSPROP=LASERON,MODULETYPE=AUTO,DESCR=\"\",TS="L2-(1,3
,5-8,13-16)",RXPOWER=-3.62,TXPOWER=-1.06:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-CBRAR
RTRV-CBRAR
RST-CBRAR
DLT-CBRAR
ED-CBRAR
RMV-CBRAR

RELATED AUTONOMOUS RESPONSES


none

1918 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-COND-ALL


Command Name: RETRIEVE CONDITION ALL

PURPOSE
The RTRV-COND-ALL command retrieves the current status of any reported existing standing
conditions in the system (alarmed and not alarmed for Equipment, Facility, and Common AIDs) or any
standing conditions matching the specified combination of position-defined input parameters.
The RTRV-COND-ALL command excludes customer environmental conditions.
The successful response for a RTRV-COND-ALL command contains one line of parsable output data
for each condition being retrieved. If multiple conditions exist, a line of output is provided for each.
Output is given for:
Each equipment entity with standing conditions grouped by equipment type displayed in ascending
order of the bay-shelf-slot fields with the additional fourth port field included for LNPT AIDs and in
ascending order by date and time of occurrence.
Each equipment entity with standing conditions grouped by equipment type displayed in ascending
order of each of the AID fields (excluding the equipment type field) left to right, and in ascending order
by date and time of occurrence.
All common (no specific entity) standing conditions in ascending order by date and time of occurrence.
Each facility entity with standing conditions grouped by facility type displayed in ascending order of the
bay-shelf-slot-facility fields and in ascending order by date and time of occurrence.
Each facility entity with standing conditions grouped by facility type displayed in ascending order of
each of the AID fields (excluding the facility type field, if any) left to right, and in ascending order by
date and time of occurrence.
If there are no conditions to report, the system outputs a COMPLD response
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-COND-ALL:[TID]:[AID]:[CTAG]::[CONDTYPE],[LOCN],[DIRN];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1919


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

AID Value Description


ALL (ALL AID)

Default: ALL
Addressing: none
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

CONDTYPE Value Description


<a valid condition type for the AID>

Default: <All Applicable Values>


Addressing: &-grouping
Description: Condition Type, specifies the condition type to be retrieved.
For a list of condition types by AID refer to the "Condition types
Appendix".

LOCN Value Description


NEND
FEND

Default: <All Applicable Locations>


Addressing: &-grouping
Description: Location, identifies the location where the condition type is
monitored.
NEND Near End
FEND Far End

DIRN Value Description


RCV
TRMT
NA

Default: <All Values>

1920 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

Addressing: &-grouping
Description: Direction, indicates the direction of the condition relative to the
specified AID.
RCV Receive Direction
TRMT Transmit Direction
TRMT Transmit
NA Not Applicable

SUCCESSFUL RESPONSE FORMAT


Format for the successful response with a single condition

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,[<AIDTYPE>]:[<NTFCNCDE>],<CONDTYPE>,[<SRVEFF>],[<OCRDAT>]
,[<OCRTM>],[<LOCN>],[<DIRN>],,[\"<CONDDESCR>\"]:[DATATYPE=<value>]"
cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1921


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

AID Value Description


SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
EC-<shelf>-<slot> (Shelf Equipment Controller)
EC-1-<slot>-{CIT, ES1, ES2} (EC Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (EC Ports, non-main shelves)
FAN-<shelf>-<slot> (Fan)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
SLOT-<shelf>-1 (Generic Slot AID in Passive Shelf)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Ports)
LINE, OSC}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Ports)
LINE, OSC}

1922 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

AID Value Description


AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Ports)
OSC, OSCSFP}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Ports)
LINE, OSC}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,

1830PSS R3.6.50 - TL1 Commands and Messages 1923


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

AID Value Description


9190, 9185, 9180, 9175, 9170}
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,

1924 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

AID Value Description


9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Optical Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Ports)
LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,

1830PSS R3.6.50 - TL1 Commands and Messages 1925


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

AID Value Description


9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)
DCM-<shelf>-1-DCM (DCM Optical Port)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Ports)
THRU, OMD}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A Optical Channels)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}-{9605, 9600, 9595,
9590, 9585, 9580, 9575, 9570, 9565,
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,

1926 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

AID Value Description


9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
SFD-<shelf>-<slot> (SFD5/8 Module)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, OMD, EXP}
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B
9590, 9585, 9580, 9575, 9570, 9565, Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170, OMD}
SFC-<shelf>-<slot> (SFC2/4/8 Module)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 Ports)
1531, 1551, 1571, 1591, 1611, OMD,

1830PSS R3.6.50 - TL1 Commands and Messages 1927


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

AID Value Description


EXP}
OPS-<shelf>-<slot> (OPSA Circuit Pack)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STAR1-<shelf>-<slot>-C1-GCC0 (General Communication Channel 0 on
11STAR1 Client Port)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STMM10-<shelf>-<slot>-C{1-10}-GC (General Communication Channel 0 on
C0 11STMM10 Client Ports)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA4-<shelf>-<slot>-L{1-2}-GCC0 (General Communication Channel 0 on

1928 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

AID Value Description


4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM1 on 11DPM12 client ports)
1
11DPM12-<shelf>-<slot>-C{1-12}-STM (STM4 on 11DPM12 client ports)
4

1830PSS R3.6.50 - TL1 Commands and Messages 1929


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

AID Value Description


11DPM12-<shelf>-<slot>-C{1-12}-STM (STM16 on 11DPM12 client ports)
16
11DPM12-<shelf>-<slot>-C{1-12}-1GbE (1GbE on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-C{1-12}-CBR (CBRAR on 11DPM12 client ports)
AR
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 client ports)
0
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
SYSTEM (System AID)
USRPNL-1-<slot> (User Panel)
USRPNL-1-<slot>-{OAMP, VOIP, E1, (User Panel Ports)
E2, HOUSEKEEPINGIN{1-8},
HOUSEKEEPINGOUT{1-4}}
PF-<shelf>-<slot> (Power Filter)
ACTSW (The active software generic on the NE)
STBYSW (The standby software generic on the
NE)

Description: Access Identifier, identifies the entity access identifier.

1930 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

AIDTYPE Value Description


1GBE
FE
10GBE
100GBE
CBR2G5
CBRAR
COM
EQPT
FC100
FC200
FC400
FC800
FC1200
OC12
OC3
OC48
OC192
OC768
OCH
ODU1
OPTSG
ODU0
ODUF
VTS
ODU2
ODU3
ODU4
OTS
OTU1
OTU2
OTU3
OTU4
PLK
STM1
STM4
STM16
STM64
STM256

Description: Identifies the type of AID for the notification being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 1931


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

CONDTYPE Value Description


<a valid condition type for the AID>

Description: Condition Type, specifies the reported condition type.


For a list of condition types by AID refer to the "Condition types
Appendix".

SRVEFF Value Description


NSA
SA

Description: Service Effect, identifies the effect on service caused by the event.
NSA Nonservice-affecting
SA Service-affecting

OCRDAT Value Description


{01-12}-{01-31}

Description: Occurrence Date, identifies the date when the event occurred.
<MONTH_OF_YEAR>-<DAY_OF_MONTH>

OCRTM Value Description


{00-23}-{00-59}-{00-59}

Description: Occurrence Time, identifies the time when the event occurred.

1932 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

<HOUR_OF_DAY>-<MINUTE_OF_HOUR>-<SECOND_OF_MIN
UTE>

LOCN Value Description


NEND
FEND

Description: Location, identifies the location where the condition type is


monitored.
NEND Near End
FEND Far End

DIRN Value Description


RCV
TRMT
NA

Description: Direction, indicates the direction of the condition relative to the


specified AID.
RCV Receive Direction
TRMT Transmit Direction
NA Not Applicable

CONDDESCR Value Description


<1-10 lines of up to 64 characters per
line>

Description: Condition description, The detailed text description of the trouble.

DATATYPE= Value Description


FE
HDSDI
3GSDI
SDSDI

Description: Client port signal type when modifier is CBRAR.

1830PSS R3.6.50 - TL1 Commands and Messages 1933


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid AID
• the AID is invalid

IIFM Invalid Payload Block. Invalid Data Format


• any input parameter other than AID or CONDTYPE is invalid

IPNV Invalid CONDTYPE


• the CONDTYPE is invalid

EXAMPLES
In the following example, all condition in the system are retrieved.
RTRV-COND-ALL;
The output response is shown below.

1934 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ALL Issue 1, December 2011

G02U> rtrv-cond-all;
G02U 08-10-01 21:53:39
M 0 COMPLD
"EC-1-1,EQPT:MJ,DATAFLT,NSA,09-30,10-58-41,NEND,NA,,\"Card
provisioning failure\""
"COM,COM:MN,SWFTDWN,NSA,09-30,10-58-41,NEND,NA,,\"Software
upgrade in progress\""
"COM,COM:MN,DBFT,NSA,09-30,10-58-41,NEND,NA,,\"DB Failure
Transport - file transport failure\""
"EC-3-1,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-49,NEND,NA,,\"Card
missing\""
"PF-3-19,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-51,NEND,NA,,\"Card
missing\""
"PF-3-36,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-53,NEND,NA,,\"Card
missing\""
"FAN-3-37,EQPT:CR,REPLUNITMISS,SA,09-30,19-48-53,NEND,NA,,\"Card
missing\""

"11STAR1-1-5,EQPT:NR,REPLUNITMISS,NSA,09-30,20-58-46,NEND,NA,,\"Card
missing\""
"EC-6-1,EQPT:MJ,DATAFLT,NSA,10-01,20-10-15,NEND,NA,,\"Card
provisioning failure\""
"PF-6-36,EQPT:CR,REPLUNITMISS,SA,10-01,20-10-21,NEND,NA,,\"Card
missing\""
"ALPHG-6-3,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,,\"Card
failure - communication\""
"PF-6-19,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,,\"Card
failure - communication\""
"FAN-6-37,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,,\"Card
failure - communication\""
"EC-6-1,EQPT:CR,CONTCOM,SA,10-01,21-02-13,NEND,NA,,\"Card failure
- communication\""
"ALPHG-6-2,EQPT:CR,CONTCOM,SA,10-01,21-02-14,NEND,NA,,\"Card
failure - communication\""
"DCM-35-1,EQPT:NR,REPLUNITMISS,NSA,10-01,21-06-49,NEND,NA,,\"Card
missing\""
"EC-7-1,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-39,NEND,NA,,\"Card
missing\""
"PF-7-19,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-42,NEND,NA,,\"Card
missing\""
"PF-7-36,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-44,NEND,NA,,\"Card
missing\""
"FAN-7-37,EQPT:CR,REPLUNITMISS,SA,10-01,21-50-44,NEND,NA,,\"Card
missing\""
/* RTRV-COND-ALL */
;

RELATED COMMANDS
RTRV-ALM-ALL

1830PSS R3.6.50 - TL1 Commands and Messages 1935


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ALL

1936 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-COND-ENV


Command Name: RETRIEVE CONDITION
ENVIRONMENTAL

PURPOSE
The RTRV-COND-ENV command retrieves the current status of any existing, standing, housekeeping
conditions in the system (alarmed, not alarmed, or not reported).
The successful response for a RTRV-COND-ENV command contains one line of parsable output data
for each condition being reported. If multiple conditions exist, a line of output is provided for each
condition in ascending order by date and time of occurrence (the newest posted alarms will be
displayed last).
If there are no conditions to report, the system outputs a COMPLD response.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-COND-ENV:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


PF-1-44-HOUSEKEEPINGIN{1-8} (PSS-36 External Input Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-32 User Panel External Input
1-8} Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-16 User Panel External Input
1-6} Points)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 1937


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ENV

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<NTFCNCDE>,<OCRDAT>,<OCRTM>,\"<ALMMSG>\"" cr lf]*
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


PF-1-44-HOUSEKEEPINGIN{1-8} (PSS-36 External Input Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-32 User Panel External Input
1-8} Points)
USRPNL-1-<slot>-HOUSEKEEPINGIN{ (PSS-16 User Panel External Input
1-6} Points)

Description: Access Identifier, identifies the entity access identifier.

NTFCNCDE Value Description


CR
MJ
MN
NA
NR

Description: Notification Code, identifies the type of alarm generated by the


system upon occurrence of the event identified by the
CONDTYPE.
CR Critical alarm
MJ Major alarm
MN Minor alarm
NA Not Alarmed
NR Not Reported

1938 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-COND-ENV Issue 1, December 2011

OCRDAT Value Description


{01-12}-{01-31}

Description: Occurrence Date, identifies the date when the event occurred.
<MONTH_OF_YEAR>-<DAY_OF_MONTH>

OCRTM Value Description


{00-23}-{00-59}-{00-59}

Description: Occurrence Time, identifies the time when the event occurred.
<HOUR_OF_DAY>-<MINUTE_OF_HOUR>-<SECOND_OF_MIN
UTE>

ALMMSG Value Description


<0-56 characters>

Description: Alarm Message. Alarm message is the text message associated


with the environmental alarm as provisioned by SET-ATTR-ENV.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1939


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-COND-ENV
EXAMPLES
The following command would be used to retrieve the environmental alarms on USRPNL-1-40

RTRV-COND-ENV:SHERLOCK:ALL;

A successful response message for this command would be:

cr lf lf
^^^SHERLOCK^ 01-03-16^ 03:14:32 cr lf
M^^C0236^COMPLD cr lf
^^^"USRPNL-1-40-HOUSEKEEPINGIN3:MN,05-03-15,21-34-54,\"Water
Detected\"" cr lf
^^^"USRPNL-1-40-HOUSEKEEPINGIN6:NA,05-03-15,21-34-54,\"Cabinet Door
Open\"" cr lf
^^^/* RTRV-COND-ENV:SHERLOCK:ALL */ cr lf
;

RELATED COMMANDS
RTRV-ALM-ENV
SET-ATTR-ENV
RTRV-ATTR-ENV

RELATED AUTONOMOUS RESPONSES


REPT^ALM^ENV
REPT^EVT^ENV

1940 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-CRS-OCH


Command Name: RETRIEVE EQUIPMENT OPTICAL
CONNECTION (OCH)

PURPOSE
The RTRV-CRS-OCH command retrieves the physical optical connection path, connection type, and
connection label for a one-way, and two-way fiber connections identified by the AID of the ports to
which they are attached from the system database. The command is executed regardless of the
provisioning of the specified port or the state of the optical connection.
The successful response for a RTRV-CRS-OCH contains one line of parsable output data, in
ascending order (from lowest FROM AID to largest FROM AID), for each physcial optical connection
associated with the specified AID. Any time FROM to TO AIDs matches TO to FROM AIDs (except in
UNI cross connect), the one that comes later after sorting is not displayed.

INPUT FORMAT

RTRV-CRS-OCH:[TID]:[<FROM>,<TO>]:[CTAG]::[DETAIL][,TRACE]:[PST];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1941


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH

FROM Value Description


ALL
AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,

1942 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

FROM Value Description


9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEIN-{9605, (AM2125A LINEIN Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,

1830PSS R3.6.50 - TL1 Commands and Messages 1943


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH

FROM Value Description


9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
RA2P-<shelf>-<slot>-LINEIN-{9605, (RA2P Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}

1944 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

FROM Value Description


SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}

Default: ALL
Addressing: None.
Description: wavelength Access Identifier, specifies the selected wavelength
facility to which the command is directed.

1830PSS R3.6.50 - TL1 Commands and Messages 1945


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH

TO Value Description
AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

1946 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

TO Value Description
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-LINEOUT-{96 (AM2125A LINEOUT Channels)
05, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,

1830PSS R3.6.50 - TL1 Commands and Messages 1947


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH

TO Value Description
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}

1948 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

TO Value Description
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: ALL
Addressing: None.
Description: wavelength Access Identifier, specifies the selected wavelength
facility to which the command is directed.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: Entry required.


Addressing: None.
Description: Correlation TAG, associates input command with its output
responses.

DETAIL Value Description


DETAIL

Default: Brief listing


Addressing: None.
Description: Show all details of connection.

TRACE Value Description


TRACE

Default: Brief listing


Addressing: None.
Description: Display the ports used by this cross-connection, along with the
state and power information for each port.

PST Value Description


IS
OOS

ALL
Default: ALL
Addressing: None.
Description: Primary state to filter.

1830PSS R3.6.50 - TL1 Commands and Messages 1949


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<FROM>,<TO>:<DIR>:[OCHTRAILNAME=<value>][,PROTMODE=<value>]:<PST
>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

DETAIL response:

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"A-End Interface^:^<FROM>" cr lf
^^^"Z-End Interface^:^,<TO>" cr lf
^^^"Connection type^:^<DIR>" cr lf
cr lf
^^^"Trail Name^:^<OCHTRAILNAME>" cr lf
^^^"Primary State^:^<PST>" cr lf
^^^"Secondary State^:^<SST>" cr lf
^^^"Protection mode^:^<PROTMODE>" cr lf
cr lf
^^^Monitor Point^Min^Meas^Max
^^^<APort>^<AMin>^<AMeas>^<AMax> cr lf
^^^<ZPort>^<ZMin>^<ZMeas>^<ZMax> cr lf
^^^"Fr-To wavekeys^:^(K1, K2)" cr lf
^^^"To-Fr wavekeys^:^(K1, K2)" cr lf
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

TRACE response:

1950 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<FROM>^<TO>^<OCHTRAILNAME>^<PST>^<SST>" cr lf
^^^"From^AMin^AMeas^AMax^^To^BMin^BMeas^BMax^" cr lf
^^^"<APORT>^<MIN>^<MEAS>^<MAX>^^<BPORT>^<MIN>^<MEAS>^<MAX>" cr lf
^^^"<BPORT>^<MIN>^<MEAS>^<MAX>^^<CPORT>^<MIN>^<MEAS>^<MAX>" cr lf
...
^^^"<YPORT>^<MIN>^<MEAS>^<MAX>^^<ZPORT>^<MIN>^<MEAS>^<MAX>" cr lf
cr lf
^^^"<TO>^<FROM>^<OCHTRAILNAME>^<PST>^<SST>" cr lf
^^^"From^ZMin^ZMeas^ZMax^^To^YMin^YMeas^YMax^" cr lf
^^^"<ZPORT>^<MIN>^<MEAS>^<MAX>^^<YPORT>^<MIN>^<MEAS>^<MAX>" cr lf
^^^"<YPORT>^<MIN>^<MEAS>^<MAX>^^<XPORT>^<MIN>^<MEAS>^<MAX>" cr lf
...
^^^"<BPORT>^<MIN>^<MEAS>^<MAX>^^<APORT>^<MIN>^<MEAS>^<MAX>" cr lf
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AZMAX Value Description


{numerical value}

Description: Specified maximum optical power (dBm) in the A->Z direction at


this point.

AZMEAS Value Description


{numerical value}

Description: Specified measured optical power (dBm) in the A->Z direction at


this point.

AZMIN Value Description


{numerical value}

Description: Specified minimum optical power (dBm) in the A->Z direction at


this point.
FROM
APORT
BPORT
AHPHG-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,

1830PSS R3.6.50 - TL1 Commands and Messages 1951


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(AHPHG LINE Port Optical Channels)
AHPLG-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(AHPLG LINE Port Optical Channels)
ALPHG-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(ALPHG LINE Port Optical Channels)
ALPFGT-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(ALPFGT LINE Port Optical Channels)
AM2125A-<shelf>-<slot>-LINEIN-{9605, 9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175,
9170} (AM2125A LINEIN Channels)
RA2P-<shelf>-<slot>-LINEIN-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(RA2P Optical Channels)

1952 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

OSCT-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,


9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(OSCT LINE Port Optical Channels)
CWR-<shelf>-<slot>-CLS1-8 (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L1-2 (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L1-2 (4DPA2 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, 1531, 1551, 1571, 1591, 1611}
(SFC2/4/8 NE Boundary Ports)
SFC-<shelf>-<slot>-OMD-{1471, 1491, 1511, 1531, 1551, 1571, 1591, 1611}
(SFC2/4/8 Mux/Demux Opitcal Channels)
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
A2325A-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(A2325A LINE Port Optical Channels)
11QPA4-<shelf>-<slot>-L1-4 (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L1-4 (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L1-2 (11DPE12 Line Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 1953


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH
11DPE12E-<shelf>-<slot>-L1-2 (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L1-2 (11DPM12 Line Ports)
SFD-<shelf>-1-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520, 9515, 9510,
9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370, 9365, 9360,
9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220, 9215, 9210,
9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(SFD44/SFD44B/SFD40/SFD40B NE Boundary Ports)
Description: wavelength AID; indicates the FROM (receive side from the
network) port of the optical connection.

TO
YPORT
ZPORT

AHPHG-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,


9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(AHPHG LINE Port Optical Channels)
AHPLG-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(AHPLG LINE Port Optical Channels)
ALPHG-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(ALPHG LINE Port Optical Channels)
ALPFGT-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,

1954 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(ALPFGT LINE Port Optical Channels)
AM2125A-<shelf>-<slot>-LINEOUT-{9605, 9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175,
9170} (AM2125A LINEOUT Channels)
OSCT-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(OSCT LINE Port Optical Channels)
CWR-<shelf>-<slot>-CLS1-8 (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L1-2 (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L1-2 (4DPA2 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, 1531, 1551, 1571, 1591, 1611}
(SFC2/4/8 NE Boundary Ports)
SFC-<shelf>-<slot>-OMD-{1471, 1491, 1511, 1531, 1551, 1571, 1591, 1611}
(SFC2/4/8 Mux/Demux Opitcal Channels)
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

1830PSS R3.6.50 - TL1 Commands and Messages 1955


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH
A2325A-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(A2325A LINE Port Optical Channels)
11QPA4-<shelf>-<slot>-L1-4 (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L1-4 (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L1-2 (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L1-2 (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L1-2 (11DPM12 Line Ports)
SFD-<shelf>-1-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520, 9515, 9510,
9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370, 9365, 9360,
9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220, 9215, 9210,
9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(SFD44/SFD44B/SFD40/SFD40B NE Boundary Ports)
Description: wavelength AID; indicates the FROM (receive side from the
network) port of the optical connection.

DIR Value Description


1WAY
2WAY

Description: Optical connection Type.


1WAY One-way optical connection
2WAY Two-way optical connection

OCHTRAILNAME= Value Description


< 1-60 VALID CKTID CHARACTERS >

Description: FROM-TO circuit ID previously assigned to optical connection.

FTWK= Value Description


{"(K1,K2)",UNKEYED}

Default: Current Value

1956 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

Addressing: None.
Description: Change the Wavelength Tracker keys for the specified cross
connection in the FROM --> TO direction.
REKEY means select new keys using the automatic mechanism
K1,K2 is used for manual keying. K1 and K2 are integers in the
range 0<K<4096
UNKEYED supportsunmanaged optical channel trails.

PROTMODE= Value Description


{UNPROTECTED,PROTECTION,WOR
KING}

Description: PROTection MODE. Designate this connection as


UNPROTECTED, or as a connection in the WORKING leg, or as a
connection in the PROTECTION leg of a protected trail.

TFWK= Value Description


("(K1,K2)",UNKEYED}

Default: Current Value


Addressing: None.
Description: Change the Wavelength Tracker keys for the specified cross
connection in the TO --> FROM direction.
REKEY means select new keys using the automatic mechanism
K1,K2 is used for manual keying. K1 and K2 are integers in the
range 0<K<4096
UNKEYED supportsunmanaged optical channel trails.

ZAMAX Value Description


{numerical value}

Description: Specified maximum optical power (dBm) in the Z->A direction at


this point.

ZAMEAS Value Description


{numerical value}

Description: Specified measured optical power (dBm) in the Z->A direction at


this point.

ZAMIN Value Description


{numerical value}

1830PSS R3.6.50 - TL1 Commands and Messages 1957


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH
Description: Specified minimum optical power (dBm) in the Z->A direction at
this point.

PST Value Description


IS-NR In Service NoRmal
IS-ANR In Service AbNoRmal
OOS-AU Out Of Service AUtonomous
OOS-MA Out Of Serivce MAnagement
OOSAUMA Out Of Service AUtonomous and
MAnagement
OOS-MAANR Out Of Service Management and
AbNoRmal

Description: Primary State and qualifier.

SST Value Description


AINS Automatic IN Service
FAF Facility Failure
FLT FauLT
LPBK LooPBacK
MT MainTenance
MEA MismAtch
SGEO SupportinG Entity Outage
UAS UnASsigned
UEQ UnEQuipped

Description: Secondary State associated with this entity. Multiple SST vaules
may be displayed in the format {<value>[&<value>]}

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

1958 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-OCH Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example illustrates the command and associated output for port ALPHG-1-1-LINE-9360
two-way connected to port 11STAR1-1-2-L1
.

RTRV-CRS-OCH:G02U::100::::;

G02U 70-01-01 19:45:56


M 100 COMPLD
"11STAR1-1-35-L1,ALPHG-1-2-LINE-
9190:2WAY:OCHTRAILNAME=\"33.33.33.33/1/35/1-31.31.31.31/1/35/1\",PRO
TMODE=UNPROTECTED:IS-NR,"
/* RTRV-CRS-OCH */
;

RELATED COMMANDS
DLT-CRS-OCH
ED-CRS-OCH
ENT-CRS-OCH
RTRV-CRS-OCH

1830PSS R3.6.50 - TL1 Commands and Messages 1959


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-OCH

1960 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-CRS-<ODUK>


Command Name: RETRIEVE CROSS-CONNECT

PURPOSE
The RTRV-CRS-<ODUk> command retrieves the connection path, connection type and Circuit ID for
the cross-connection identified by AID from the system database. The command is executed
regardless of the provisioning of the specified port or the state of the cross-connection.
The command retrieves all cross-connections in which the input AID is involved independent if the AID
is used in FROM or TO role. Each cross connection is reported once and not several times in case it
would match several times.
The successful response for a RTRV-CRS-<ODUk> contains one line of parsable output data, in
ascending order (from lowest FROM AID to largest FROM AID), for each cross-connection associated
with the specified AID. A line of parsable output data is only displayed if the specified AID is
provisioned and cross-connected.

INPUT FORMAT

RTRV-CRS-<ODUk>:[TID]:AID:[CTAG];

INPUT PARAMETERS

ODUk Value Description


{OPTSG,ODU0,ODU1,ODUFFC400,O
DUF3GSDI}

Default: Entity Required


Addressing: None
Description: The ODUk indicates the rate on which the command acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1961


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-ODUK

AID Value Description


Values valid for: each rate
Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing:None

Description: AID of connection point; specifies the selected facility(ies) to which


the command is directed. AID of ALL retrieves all the cross
connects in the system.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1962 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-ODUK Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<FROM>,<TO>:<CCT>:[CKTID=<value>]" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

FROM Value Description


Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Description: AID of connection point; Indicates the FROM (receive side from
the network, source of cross-connection) facility of the
cross-connection.

1830PSS R3.6.50 - TL1 Commands and Messages 1963


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-ODUK

TO Value Description
Values valid for: 155M Time Slot rate
11DPM12-<shelf>-<slot>-C{1-12}-OPT (OPTSG on 11DPM12 client ports)
SG
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual OPTSG entity for 11DPM12
8}-OPTSG{1-16} connetcion plane)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Description: AID of connection point; Indicates the TO (transmit side from the
network, sink of cross-connection) facility of the cross-connection.

CCT Value Description


{1WAY, 2WAY}

Default: 2WAY
Addressing: None
Description: Cross-connection Type;The CCT is used for addressing the
cross-connection only. It can't be changed.
1WAY One-way cross-connection (unidirectional
cross-connection)
2WAY Two-way cross-connection (bidirectional
cross-connection)

CKTID= Value Description


< 0-45 VALID CKTID CHARACTERS >
Default: NULL string

1964 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-ODUK Issue 1, December 2011

Addressing: None
Description: Circuit ID assigned to the cross-connection. 0 to 45 ASCII
characters within enclosing double quotes. Semicolon, asterisk,
greater-than, less-than, double quote, and backslash characters
are prohibited. Empty double quotes (i.e. “”) indicate a NULL string.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Input, Invalid ACcess identifier
• the used AID in the AID parameter does not match for the rate

EXAMPLES
The following examples illustrates the responses when following cross connections are created:

1WAY ODU2ODU1-1-7-L1-2 and ODU1-1-7-C1 CKTID=CC1


1WAY ODU1-1-7-C1 and ODU2ODU1-1-7-L1-2 CKTID=CC2
2WAY ODU1PTF-1-7-4 and ODU2ODU1-1-7-L1-2 CKTID=CC3

RTRV-CRS-ODU1::ODU2ODU1-1-7-L1-2;

^^^<SID>^<YY-MM-DD>^<HH:MM:SS>
M^^Pab124^COMPLD
^^^"ODU2ODU1-1-7-L1-2,ODU1-1-1-7-C1:1WAY:CKTID=\"CC1\":IS-NR"
^^^"ODU1-1-7-C1,ODU2ODU1-1-1-7-L1-2:1WAY:CKTID=\"CC2\":IS-NR"
^^^"ODU1PTF-1-7-4,ODU2ODU1-1-7-L1-2:2WAY:CKTID=\"CC3\":IS-NR"
^^^/*RTRV-CRS-ODU1::
ODU2ODU1-1-1-7-L1-2^Pab124^(<Session_Number>)^*/

1830PSS R3.6.50 - TL1 Commands and Messages 1965


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-ODUK
RELATED COMMANDS
ENT-CRS-<ODUk>
ED-CRS-<ODUk>
DLT-CRS-<ODUk>

RELATED AUTONOMOUS RESPONSES


none

1966 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-CRS-VTS


Command Name: RTRV-CRS-VTS

PURPOSE
The RTRV-CRS-VTS shall be used to retrieve the ethernet connection previously provisioned in a
pack. The successful response for a RTRV-CRS-VTS contains lines of parsable output data for the
matched Ethernet connection associated with the specified AID.
This command applies to 11DPE12 and 11DPE12E pack.

INPUT FORMAT

RTRV-CRS-VTS:[TID]:[FROM,TO]:[CTAG]::[CardRate]:[PST];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

FROM Value Description


11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the head of a Ethernet connection.
When 11DPE12 working under fullrate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.

1830PSS R3.6.50 - TL1 Commands and Messages 1967


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-VTS
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under subrate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

TO Value Description
11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Default: None
Addressing: None
Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the tail of a Ethernet connection.
When 11DPE12 working under full rate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under sub rate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

1968 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-VTS Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

CardRate Value Description


{FullRate, SubRate, Qinq}

Default: Qinq

Addressing: None
Description: Specify the working rate of the board. Applies only to 11DPE12
and 11DPE12E OT. In 11DPE12E oT, the value only can be qinq.

PST Value Description


{IS,OOS}

Default: OOS
Addressing: None
Description: Primary State, specifies the primary state to which the facility is
set.
IS In Service
OOS Out Of Service

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<FROM>,<TO>:<DIR>:[CIR=<value>][,EIR=<value>][,CBS=<value>][,EBS
=<value>]:<PST>" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1969


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-VTS

FROM Value Description


11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the head of a Ethernet connection.
When 11DPE12 working under fullrate mode: client ports don't
contain any virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.
While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under subrate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

TO Value Description
11DPE12-<shelf>-<slot>-C{1-12}-ALL
11DPE12-<shelf>-<slot>-C{1-12}-VTS{
1-10 }
11DPE12-<shelf>-<slot>-L{1-2}-VTS{
1-100 }
11DPE12E-<shelf>-<slot>-C{1-12}-ALL
11DPE12E-<shelf>-<slot>-C{1-12}-VTS
{ 1-10 }
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{
1-100 }

Description: VTS Virtual time slot number. Identifies the virtual time slot number
of the tail of a Ethernet connection.
When 11DPE12 working under full rate mode: client ports don't
contain any virtual time slots, so

1970 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-VTS Issue 1, December 2011

11DPE12-<shelf>-<slot>-C{1-12}-ALL shall be used for client port.


While each line port contain 10 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-10} shall be used for line
port.
When 11DPE12 working under sub rate mode: client port contain
10 virtual time slots, so
11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10} shall be used for
client port. While each line port contain 32 virtual time slots, so
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-32} shall be used for line
port.
When 11DPE12 working under qinq mode: client port contain 10
virtual time slots, so 11DPE12-<shelf>-<slot>-C{1-12}-VTS{1-10}
shall be used for client port. While each line port contain 100
virtual time slots, so 11DPE12-<shelf>-<slot>-L{1-2}-VTS{1-100}
shall be used for line port.

DIR Value Description


{1WAY, 2WAY}

Description: Specifies the type of the connection. 1WAY One-Way, an


unidirectional connection between the selected FROMVTS and
TOVTS. 2WAY Two-Way, identifies a bi-directional connection
between the selected FROMVTS and TOVTS.
The ethernet connection tpye for the subrate mode shall alway be
2WAY.

1830PSS R3.6.50 - TL1 Commands and Messages 1971


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-VTS

CIR= Value Description


{ 0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 50 under qinq
working mode for 11DPE12 pack ( the
unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 100 under subrate
working mode for both 11DPE12 and
11DPE12E packs ( the unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
portfor 11DPE12E pack add/drop
service with the step of 5Mbps for the
range of 1Mbps-100Mbps;50Mbps for
the range of 100Mbps-1Gbps under
qinq working mode. (the unit is Mb/S)
{0-10000}for 11DPE12E qinq pass
through service with the step of 5 Mbps
for the range of 10 Mbps-100Mbps;50
Mbps for the range of
100Mbps-1Gbps;500 Mbps for the
range of 1Gbps-10Gbps.(the unit is
Mb/S)

Description: the Committed Information Rate.


This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

1972 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-VTS Issue 1, December 2011

EIR= Value Description


{ 0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 50 under qinq
working mode for 11DPE12 pack ( the
unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
port with the step of 100 under subrate
working mode for both 11DPE12 and
11DPE12E packs ( the unit is Mb/S )
{0-100Mbps} when one VTSXC related
port is FE port or {0-1000Mbps} when
none of the VTSXC related port is FE
portfor 11DPE12E pack add/drop
service with the step of 5Mbps for the
range of 1Mbps-100Mbps;50Mbps for
the range of 100Mbps-1Gbps under
qinq working mode. (the unit is Mb/S)
{0-10000}for 11DPE12E qinq pass
through service with the step of 5 Mbps
for the range of 10 Mbps-100Mbps;50
Mbps for the range of
100Mbps-1Gbps;500 Mbps for the
range of 1Gbps-10Gbps.(the unit is
Mb/S)

Description: the Excess Information Rate.


This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.
This parameter only apply to the 11DPE12E working in Subrate
and qinq mode.

CBS= Value Description


{16, 32, 64, 128, 256, 512, 1024, 2048,
4096, 8192, 16384} ( the unit is kB )

Description: the Committed Burst Size


This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.

EBS= Value Description


{16, 32, 64, 128, 256, 512, 1024, 2048,
4096, 8192, 16384} ( the unit is kB )

Description: the Excess Burst Size

1830PSS R3.6.50 - TL1 Commands and Messages 1973


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-VTS
This parameter only apply to the 11DPE12 working in Subrate and
qinq mode.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• this command is issued with the value in FROM equals to TO

• this command is issued with both of FROM/TO and cardrate are not provided

• this command is issued with FROM or TO whose virtual time slot is out of range under the
specified working mode

• this command is issued with FROM,TO and CardRate which are not the same as realtime
cardRate

1974 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRS-VTS Issue 1, December 2011

EXAMPLES

In the following example, a two-way ethernet connection is retrieved


for a 11DPE12 client port 1, virtual time slot 1 and line port 1,
virtual time slot 1:
RTRV-CRS-VTS:NODE-1:11DPE12-1-7-C1-VTS1,11DPE12-1-7-L1-VTS1:xyz123;
IP xyz123
<
^^^NODE-1 2002-08-17,09:30:49
M^^xyz123^COMPLD
;

RELATED COMMANDS
DLT-CRS-VTS
ED-CRS-VTS
ENT-CRS-VTS

RELATED AUTONOMOUS RESPONSES


REPT DBCHG

1830PSS R3.6.50 - TL1 Commands and Messages 1975


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRS-VTS

1976 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-CRSPROT-<ODUK>


Command Name: RETRIEVE PROTECTED
CROSS-CONNECTION

PURPOSE
The RTRV-CRSPROT-<ODUk> command retrieves the connection path, connection type, the SNCP
parameters and state for the cross-connection identified by AID from the system database.
The command retrieves only the SNCP path protected cross connections. (For unprotected cross
connections an other command (RTRV-CRS, RTRV-CRS-<ODUk>) is available.)
The command retrieves all cross-connections in which the input AID is involved independent if the AID
is used in FROMPED, FROMPING or TO role. Each cross connection is reported once in case it would
match several times.
The successful response for a RTRV-CRSPROT-<ODUk> contains one line of parsable output data, in
ascending order (from lowest FROMPED AID to largest FROMPPED AID), for each cross-connection
associated with the specified AID. A line of parsable output data is only displayed if the specified AID is
provisioned and cross-connected.

INPUT FORMAT

RTRV-CRSPROT-<ODUk>:[TID]:AID:[CTAG];

INPUT PARAMETERS

ODUk Value Description


{ODU0,ODU1,ODUF}

Default: Entry required


Addressing: None
Description:The ODUk indicates the rate on which the retrieve
crossconnection command acts.

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing:None
Description:Target IDentifier, identifies the network node TID for
the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1977


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRSPROT-ODUK

AID Value Description


Values valid for: all rate:
ALL (ALL AID)
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Default: Entry Required


Addressing:none
Description:Access Identifier; specifies the selected facility(ies) to
which the command is directed. AID of ALL retrieves all the cross
connects in the system.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description:Correlation TAG, associates the input command with
its output responses.

1978 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRSPROT-ODUK Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<FROMPED>,<FROMPING>,<TO>:<CCT>: [,CURREQ=][,ACTIVE=<value>]
[,RVRTTIM=<value>] [,RVRTV=<value>]" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

FROMPED Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Description:AID of connection point; Indicates the FROMPED


(protected receive side from the network, protected source of
cross-connection) facility of the cross-connection.

FROMPING Value Description


Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
Values valid for: ODUflex rate
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Description:AID of connection point; Indicates the FROMPING


(protecting receive side from the network, protected source of
cross-connection) facility of the cross-connection.

1830PSS R3.6.50 - TL1 Commands and Messages 1979


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRSPROT-ODUK

TO Value Description
Values valid for: ODU0 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
Values valid for: ODU1 rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)
Values valid for: ODUf rate
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)

Description:AID of connection point; Indicates the TO (transmit


side to the network, sink of cross-connection) facility of the
cross-connection.

CCT Value Description


{1WAYSNCP, 2WAYSNCP}

Description:Cross-connection Type
1WAYSNCP One-way SNCP cross-connection
(unidirectional SNCP cross-connection)
2WAYSNCP Two-way SNCP cross-connection
(bidirectional SNCP cross-connection)

CURREQ= Value Description


{LOCKOUT, FRCD, SF, SD, MAN,
WTR, DNR, NR}

Description: Currently active switch request for a SNCP connection


LOCKOUT Lockout of Protection
FRCD Forced switch
SF Signal Fail
SD Signal Degrade
MAN Manual Switch
WTR Wait to Restore
DNR Do Not Revert
NR No Request

1980 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-CRSPROT-ODUK Issue 1, December 2011

ACTIVE= Value Description


{PROTECTING, PROTECTED}

Description: Currently active side of a SNCP connection


PROTECTING FROMPING (protecting) side
PROTECTED FROMPED (protected) side

RVRTTIM= Value Description


0-15

Description: Revert Delay Time (wait to restore time) if RVRTV=Y in minutes. If


RTRTV=N it does not have any effect at the NE behaviour.

RVRTV= Value Description


{Y,N}

Description: Revertive Mode: Indicates whether or not to make revert to


protected once the protected comes into service and the traffic is
on protecting.
N Do not revert to protected / FROMPED
Y Yes revert to protected / FROMPED

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNV Input, Data Not Valid
• the used AID in the AID parameter does not match for the rate

1830PSS R3.6.50 - TL1 Commands and Messages 1981


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-CRSPROT-ODUK
EXAMPLES
The following examples illustrates the responses when following cross connections are created:

RTRV-CRSPROT-ODU1::11DPM12-1-1-C2-ODU1:123456;

"11DPM12-1-1-L1-ODU2ODU1#1,11DPM12-1-1-L2-ODU2ODU1#1,11DPM12-1-1-C2-ODU1:2WAYS
NCP:CURREQ=NR,ACTIVE=Protected,RVRTTIM=5,RVRTV=N"

RELATED COMMANDS
ENT-CRSPROT-<ODUk>
CNVT-CCTPR-<ODUk>
CNVT-CCTU-<ODUk>

RELATED AUTONOMOUS RESPONSES


none

1982 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-DB-STATUS


Command Name: RETRIEVE DATABASE STATUS

PURPOSE

The RTRV-DB-STATUS command retrieves the following database


attributes:
1. Date and time of the last database backup to RFS
2. Last database backup filename on RFS
3. Last database operation executed
4. Status of the last database operation executed
5.Percent of the last database operation executed that completed

INPUT FORMAT

RTRV-DB-STATUS:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1983


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-DB-STATUS
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"::DATE=<value>,TIME=<value>,BACKUPFILE=\"<value>\",LASTOPERATION
=<value>,LASTOPRSTATUS=<value>,PERCENTCOMPLD=<value>,CRC=<value>" cr
lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

DATE= Value Description


{ 05-99 }-{ 01-12 }-{ 01-31 }

Description: Backup Date. Identifies the date when the last backup was
created. The date is in the format of <YY>-<MM>-<DD>.

TIME= Value Description


{ 00-23 }-{ 00-59 }-{ 00-59 }

Description: Backup Time. Identifies the time then the last backup was created.
The time is in the format of <HH>-<MM>-<SS>.

BACKUPFILE= Value Description


<0-255 characters, including path>

Description: Indicates the filename for the last backup performed on the node.
If none exists, this attribute will return an empty string. If a
database backup operation is in progress, this attribute will return
an empty string. This output value is enclosed in escaped double
quotes, see output format.

LASTOPERATION Value Description


=
BACKUPTOREMOTE
RESTOREFROMREMOTE
NOCOMMAND

Description: The last database operation executed


LASTOPRSTATUS=

1984 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-DB-STATUS Issue 1, December 2011

COMPLETE
IP
FAILED
Description: The status of the last database operation executed

PERCENTCOMPL Value Description


D=
<0-100%>

Description: The percentage completed of the last database operation that


executed.

CRC= Value Description


<32-bit CRC>

Description: The 32-bit Cyclic Redundancy Code calculated over the last
backed-up database.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
;

The unsuccessful response format for a unreadable media or a invalid Label Stream is

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf ]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf ]
[^^^/*^<AID>:^<Unreadable Database>^*/ cr lf ]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1985


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-DB-STATUS
EXAMPLES
In the following example, the database status is retrieved.
RTRV-DB-STATUS;
The output response is shown below.

AM1520 05-07-03 09:08:33


M P02018 COMPLD
"STDBYDB:1850 TSR02.00.00,DALLAS001,05-04-01,14-08-33"
"::DATE=08-06-28,TIME=15:06:43,BACKUPFILE=/backup/backupfile,LASTOPE
RATION=backupToRemote,LASTOPRSTATUS=COMPLETE,PERCENTCOMPLD=100%,CRC=
8df3
;

RELATED COMMANDS
COPY-RFILE
RTRV-ISU-STATUS

RELATED AUTONOMOUS RESPONSES


None

1986 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-DFLT-SECU


Command Name: RETRIEVE DEFAULT SECURITY
PRIVILEGE

PURPOSE
The RTRV-DFLT-SECU command retrieves the provisioned values for the system-wide user security
parameters, as provisioned by the SET-ATTR-SECUDFLT command.
[DRV]

INPUT FORMAT

RTRV-DFLT-SECU:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 1987


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-DFLT-SECU
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^":\"DEFAULTS \":MINPIDLEN=<value>
,MININTVL=<value>,MXINV=<value>,TMOUT=<value>,SECACC=<value>,PCNN=<v
alue>,PCND=<value>,PAGE=<value>,UOUT=<value>,POINT=<value>" cr lf
[^^^/*^<Informational_Description_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

DEFAULTS Value Description


DEFAULTS

Description: String "DEFAULTS" indicates that the following informations are


SECU default values.

MINPIDLEN= Value Description


{8-32}

Description: This is minimum password length required of all user profiles. For
example, if the value is set to 10, then all passwords for all defined
users on the system must be at least 10 characters long.

MININTVL= Value Description


0-60

Description: Min Interval between consecutive invalid attempts, indicates the


minimum interval, in seconds, between invalid login attempts
before an NE shall logout a user and lockout the user channel.
Default value is 15 seconds.
0 Zero, Min Interval between consecutive invalid
attempts on user accounts is disabled. No minimum
interval between consecutive invalid login attempts.
1-60 Min Interval between consecutive invalid attempts.

MXINV= Value Description


0-15

Description: Max Invalid Attempts, indicates the maximum number of


consecutive invalid login attempts (regardless of time interval or

1988 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-DFLT-SECU Issue 1, December 2011

number of sessions), before an NE shall logout a user and lockout


the user channel. Default value is 3.
0 Zero, Max Invalid Attempts on user accounts is
disabled. No limit to the invalid login attempts.
1-15 Max Invalid Attempts.

TMOUT= Value Description


0-999

Description: User Session Activity Link TimeOut, specifies the amount of time
(in minutes) that the User Session link is inactive with regards to
user TL1 input before a user session link time-out occurs. Default
value is 15.
0 Disabled, no user session link time-out will occur.
1-999 Time in minutes, indicates the TMOUT time interval.
A user session link time-out occurs if the user
session link is inactive with regards to user TL1
input for the time, in minutes, indicated.

SECACC= Value Description


ENCRYPTED
NORMAL

Description: Secure Access for the NE. If access is in Encrypted mode, then
the system will support only SSH to port 22, SNMPv3, and SFTP. If
Normal mode, then the system will also support TL1 connections
to port 3082, 3083; telnet; HTTP, and FTP.

PCNN= Value Description


{0-999}

Description: This is the number of times that a user


can log in after PAGE limit was reached and before
which the user has to change his password. Default
value 3. Range is between 0 to 999 times. Values are:
0 (Grace extra log-in after password expiration are
disabled.)
{1-999} (Number of times left for the user to log in
to replace the existing expired
password.)

PCND= Value Description


{0-999}

1830PSS R3.6.50 - TL1 Commands and Messages 1989


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-DFLT-SECU
Description: Early warning on imminent password aging.
This is the duration in number of days after the PAGE,
which is allowed for the user to change his password.
The unit of PCND is in days. Default value is 7. Range
is between 0 to 999 days. Values are:
0 (Grace period after password expiration is
disabled.)
{1-999} (Number of days left for the user to replace
the existing expired
password.)
PAGE=

{0-999}
Description: This is the expiry duration for the
password. When a user logs in after the PAGE period,
he/she will be notified with the details of the PCNN
and PCND. The user has to change the password before
the PCND or the PCNN period. The password aging time
is in days. Default value is 30. Range is between 0 to
999 days. Values are:
0 (Password aging is disabled.)
{1-999} (Number of days left for the user to replace
the existing password.)

UOUT= Value Description


{0-999}

Description:User ID Aging Interval. This parameter


specifies the aging or expiry interval of a particular
User Id. At the end of this interval, the UID is
disabled if during this interval it has never been
used to set up a session. Default value is 60. Range
is between 0 to 999 days. Values are:
0 (UID aging is disabled.)
{1-999} (Number of days left for the user to log in,
before UID expiration.)

POINT= Value Description


{0-999}

1990 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-DFLT-SECU Issue 1, December 2011

Description: Password Obsolescence Interval. This is


the minimum time interval that is required if the User
wishes to use a password that was already used. Unit
of POINT is in days. Default value is 180. Range is
between 0 to 999 days. Values are:
0 (Reuse of old passwords is disabled.)
{1-999} (Number of days for the user to reuse an old
password.)

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PICC Privilege, Illegal Command Code
• the command is issued by a non-privilege user

EXAMPLES
The following example illustrates the command and associated output for retrieving the current
provisioned values of the system-wide user security parameters.
RTRV-DFLT-SECU;

AM1520 03-07-08 14:50:15M P42011 COMPLD ":"DEFAULT


":MINPIDLEN=10,MINTVL=15,MXINV=5,TMOUT=15,SECACC=NORMAL";

RELATED COMMANDS
SET-ATTR-SECUDFLT

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 1991


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-DFLT-SECU

1992 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-EQPT-FW


Command Name: RETRIEVE FIRMWARE PROVISIONING
INFORMATION FOR A CARD

PURPOSE
The RTRV-EQPT-FW command allows a user to display the firmware profile currently in use with a
circuit card.

INPUT FORMAT

RTRV-EQPT-FW:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 1993


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT-FW

AID Value Description


EC-<shelf>-<slot> (Firmware Loadable Cards)
FLC-<shelf>-<slot>
MT0C-<shelf>-<slot>
AHPHG-<shelf>-<slot>
AHPLG-<shelf>-<slot>
ALPFGT-<shelf>-<slot>
ALPHG-<shelf>-<slot>
A2325A-<shelf>-<slot>
AM2017B-<shelf>-<slot>
AM2125A-<shelf>-<slot>
AM2125B-<shelf>-<slot>
AM2318A-<shelf>-<slot>
AM2325B-<shelf>-<slot>
RA2P-<shelf>-<slot>
OSCT-<shelf>-<slot>
CWR-<shelf>-<slot>
WR-<shelf>-<slot>
MESH-<shelf>-<slot>
OPS-<shelf>-<slot>
112SA1L-<shelf>-<slot>
112SCA1-<shelf>-<slot>
112SNA1-<shelf>-<slot>
112SX10L-<shelf>-<slot>
112SCX10-<shelf>-<slot>
112SNX10-<shelf>-<slot>
43STA1P-<shelf>-<slot>
43SCA1-<shelf>-<slot>
43SCX4-<shelf>-<slot>
43SCX4E-<shelf>-<slot>
43SCX4L-<shelf>-<slot>
43STX4P-<shelf>-<slot>
43STX4-<shelf>-<slot>
11DPE12-<shelf>-<slot>
11DPE12E-<shelf>-<slot>
11DPM12-<shelf>-<slot>
11STAR1-<shelf>-<slot>
11STMM10-<shelf>-<slot>
11STGE12-<shelf>-<slot>
4DPA4-<shelf>-<slot>
4DPA2-<shelf>-<slot>
11QPA4-<shelf>-<slot>
11QTA4-<shelf>-<slot>
11STAR1A-<shelf>-<slot>
MVAC-<shelf>-<slot>
SVAC-<shelf>-<slot>
WTOCM-<shelf>-<slot>

Default: Entry Required


Addressing: None
Description: The AID of the card to be reprovisioned.

1994 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT-FW Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::PROFILE=<value>,PST=<value>"cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 1995


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT-FW

AID Value Description


EC-<shelf>-<slot> (Firmware Loadable Cards)
FLC-<shelf>-<slot>
MT0C-<shelf>-<slot>
AHPHG-<shelf>-<slot>
AHPLG-<shelf>-<slot>
ALPFGT-<shelf>-<slot>
ALPHG-<shelf>-<slot>
A2325A-<shelf>-<slot>
AM2017B-<shelf>-<slot>
AM2125A-<shelf>-<slot>
AM2125B-<shelf>-<slot>
AM2318A-<shelf>-<slot>
AM2325B-<shelf>-<slot>
RA2P-<shelf>-<slot>
OSCT-<shelf>-<slot>
CWR-<shelf>-<slot>
WR-<shelf>-<slot>
MESH-<shelf>-<slot>
OPS-<shelf>-<slot>
112SA1L-<shelf>-<slot>
112SCA1-<shelf>-<slot>
112SNA1-<shelf>-<slot>
112SX10L-<shelf>-<slot>
112SCX10-<shelf>-<slot>
112SNX10-<shelf>-<slot>
43STA1P-<shelf>-<slot>
43SCA1-<shelf>-<slot>
43SCX4-<shelf>-<slot>
43SCX4E-<shelf>-<slot>
43SCX4L-<shelf>-<slot>
43STX4P-<shelf>-<slot>
43STX4-<shelf>-<slot>
11DPE12-<shelf>-<slot>
11DPE12E-<shelf>-<slot>
11DPM12-<shelf>-<slot>
11STAR1-<shelf>-<slot>
11STMM10-<shelf>-<slot>
11STGE12-<shelf>-<slot>
4DPA4-<shelf>-<slot>
4DPA2-<shelf>-<slot>
11QPA4-<shelf>-<slot>
11QTA4-<shelf>-<slot>
11STAR1A-<shelf>-<slot>
MVAC-<shelf>-<slot>
SVAC-<shelf>-<slot>
WTOCM-<shelf>-<slot>

Default: Entry Required


Addressing: None
Description: The AID of the card to be reprovisioned.

1996 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT-FW Issue 1, December 2011

PROFILE= Value Description


<string>

Description: This parameter allows the provisioning


of a particular firmware profile for the specified
card. The format is a string consisting of three
positive integer fields separated by the dot character
".". The first field indicates a major version number,
the second a minor version number, and the third
(optional) field is a reserved integer field.
Major versions indicate a change in register map or
function that is often not backward compatible.
Minor versions indicate a software backward compatible
change.
Consult the user documentation and release notes for
more information on software/firmware compatibility.

PST= Value Description


{FPGAINIT[10-0],FWFAILED,FWLOAD
ED,FWTIMEOUT}

Description: This parameter displays the current


state of an FPGA upgrade. For a device with 4 FPGAs
the value will progress from FPGA[3], FPGA[2],
FPGA[1], FPGA[0], FWLOADED as the devices initialize.
FWFAILED indicates a problem with the firmware file.
FWTIMEOUT indicates that the device failed to complete
programming within the specified time and may indicate
a busy system rather than a file problem.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 1997


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT-FW
EXAMPLES
The following example illustrates the command for retrieving the firmware images loaded on, and
provisioned for the target card.

G01M> RTRV-EQPT-FW:G01M:11STGE12-1-5:100::;
G01M 10-02-05 11:02:13
M 100 COMPLD
"11STGE12-1-5::PROFILE=1.1.1,PST=FWNONE"
/* RTRV-EQPT-FW */

RELATED COMMANDS
RTRV-EQPT-FW
RTRV-LIB-FW

RELATED AUTONOMOUS RESPONSES


None

1998 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-EQPT


Command Name: RETRIEVE EQUIPMENT

PURPOSE
The RTRV-EQPT command retrieves the data and state parameters associated with any equipment
residing in the network element (NE), regardless of the provisioning state of the equipment.
General Equipment
• System
• Shelf (SHELF with type = UNV, SFD, DCM, or ITL)
• First Level Controller (FLC)
• Matrix Zero (MT0C)
• Bus Termination Card (BTC)
• Shelf Equipment Controller (EC)
• Customer Interface Panel (USRPNL)
• Power Supply Filter (PF)
• Fan (FAN)
Active DWDM Circuit Packs
• Line Driver - LD (ALPHG, AHPHG, AHPLG, ALPFGT, A2325A, AM2017B, AM2325B, AM2125A,
AM2125B, AM2318A, RA2P)
• Optical Supervisory Channel (OSCT)
• Wavelength Tracker Optical Channel Monitoring Card (WTOCM)
• Colorless Wavelength Router (CWR8, CWR8-88)
• Wavelength Router (WR8-88A, WR2-88A)
• Mesh Card (MESH4)
• Optical Translator - OT (112SCA1, 112SNA1, 112SA1L, 112SCX10, 112SNX10, 112SX10L,
11STAR1, 11STMM10, 11STGE12, 43STX4, 43STX4P, 43SCX4L, 43SCX4, 43SCA1, 43STA1P,
4DPA4, 4DPA2, 11QPA4, 11DPE12, 11DPE12E, 11DPM12, 11STAR1A)

• Optical Translator - OT
• (112SA1L, 112SCA1, 112SCX10, 112SNA1, 112SNX10, 112SX10L,
• 11DPE12, 11DPE12E, 11DPM12, 11QPA4, 11QPEN4, 11QTA4, 11STAR1,
11STAR1A, 11STGE12, 11STMM10,
• 4DPA2, 4DPA4 )
• Variable Attenuator Card (SVAC, MVAC)
• Optical Protection Switch (OPS)
• Static Filter DWDM (SFD5/8)
• Static Filter CWDM (SFC2/4/8)
Passive DWDM Modules
• SFD44. The SFD44 is modeled as the fixed "card" in an SFD44 "shelf" with only one "slot". But
physically, the SFD44 card/shelf are not separable. RTRV-EQPT returns SFD44 shelf

1830PSS R3.6.50 - TL1 Commands and Messages 1999


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT
parameters if addressed to the shelf, and returns SFD44 card parameters if addressed to the
card.
• SFD44B. The SFD44B is modeled as the fixed "card" in an SFD44B "shelf" with only one "slot".
But physically, the SFD44B card/shelf are not separable. RTRV-EQPT returns SFD44B shelf
parameters if addressed to the shelf, and returns SFD44B card parameters if addressed to the
card. The SFD44B carries the 44 odd channels, which in addition to the 44 even channels from a
SFD44 supports an 88 channel optical line.
• SFD40. The SFD40 is modeled as the fixed "card" in an SFD "shelf" with only one "slot". But
physically, the SFD40 card/shelf are not separable. The RST-EQPT command is addressed to
the SFD40 "card".
• SFD40B. The SFD40B is modeled as the fixed "card" in an SFD40B "shelf" with only one "slot".
But physically, the SFD40B card/shelf are not separable. The RST-EQPT command is addressed
to the SFD40B "card". The SFD40B carries the 40 odd channels, which in addition to the 40 even
channels from a SFD40 supports an 80 channel optical line.
• DCM. The DCM is modeled as the fixed "card" in a DCM "shelf" with only one "slot". But
physically, multiple DCM modules of several sizes fit into a single housing. RTRV-EQPT returns
DCM shelf parameters if addressed to the shelf, and returns DCM card parameters if addressed
to the card.
• ITLB/ITLU. The ITLB/ITLU is modeled as the fixed "card" in an ITLB/ITLU "shelf" with only one
"slot". But physically, multiple ITLB/ITLU and DCM modules of several sizes fit into a single
housing. RTRV-EQPT returns ITLB/ITLU shelf parameters if addressed to the shelf, and returns
ITLB/ITLU card parameters if addressed to the card.
If AID=ALL is specified, all the equipments residing in the NE, both provisioned and unprovisioned,
should be returned.
If the specified AID is the generic SLOT AID, the command will retrieve the information of a board
which is plugged-in whether the equipment is provisioned or not. If the AID is unassigned, the AID in
the output will be a generic SLOT AID. If the AID is assigned, the AID in the output will be the AID of
the actual module that has been assigned in the slot.
All of the output parameters that are supported by an entered provisioned AID are displayed in the
successful response regardless of their value.

INPUT FORMAT

RTRV-EQPT:[TID]:[AID]:[CTAG]::[TYPEID];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

2000 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

AID Value Description


ALL (ALL AID)
SYSTEM (System AID)
SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
SLOT-<shelf>-1 (Generic Slot AID in Passive Shelf)
FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
BTC-<shelf>-<slot> (BTC Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
USRPNL-1-<slot> (User Panel)
PF-<shelf>-<slot> (Power Filter)
FAN-<shelf>-<slot> (Fan)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 2001


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

AID Value Description


112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)

Default: ALL
Addressing: &&-ranging and &-grouping
Description: Equipment Access Identifier, identifies the equipment entity access
identifier

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

2002 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

TYPEID Value Description


UNV_SHELF_36 PSS36 Universal shelf
UNV_SHELF PSS32 Universal shelf
UNV_SHELF_16 PSS16 Universal shelf
SFD44_SHELF SFD44 shelf
SFD44B_SHELF SFD44B shelf
SFD40_SHELF SFD40 shelf
SFD40B_SHELF SFD40B shelf
DCM_SHELF DCM shelf
ITLB_SHELF ITLB shelf
ITLU_SHELF ITLU shelf
FLC First Level Controller
MT0C Matrix Zero
BTC Bus Termination Card
EC Shelf Equipment Controller
USRPNL Customer Interface Panel
PF Power Supply Filter
FAN Fan
ALPHG Line Driver (low power)
AHPHG Line Driver (high power)
AHPLG Line Driver (high power, low gain)
ALPFGT Line Driver (low power)
A2325A Line Driver (The AMP with 25dbm
output power and 23db gain)
AM2325B Line Driver (23 dBm power, variable
gain, C-band, DCM removed)
AM2017B Line Driver (high power, low gain, DCM
removed)
AM2125A Uni-directional Line Driver (21dBm max
power, 25dB max gain)
AM2125B Uni-directional Line Driver (21dBm max
power, 25dB max gain, DCM removed)
AM2318A Uni-directional Line Driver (23 dBm max
power, 18 dB max gain)
RA2P Uni-directional Raman Line Driver
OSCT Optical Supervisory Channel
WTOCM Wavelength Tracker Optical Channel
Monitoring card
CWR8 Colorless Wavelength Router - 8
Degree, 44 Channel
CWR8-88 Colorless Wavelength Router - 8
Degree, 88 Channel
WR8-88A Wavelength Router - 8 Degree, 88
Channel

1830PSS R3.6.50 - TL1 Commands and Messages 2003


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

TYPEID Value Description


WR2-88A Wavelength Router - 2 Degree, 88
Channel
MESH4 Mesh card - 4 outputs
11STAR1 Optical Translator, 11G Any Rate
11STMM10 Optical Translator, 10x Client Mux
11STGE12 Optical Translator, 12x GE Client Mux
43STX4 Optical Translator, 40G, 4x Client Mux ,
44 wavelengths
43STX4P Optical Translator, 40G, 4x Client Mux ,
88 wavelengths
43SCX4 Optical Translator, 40G Coherent, 4x
Client Mux , 99 wavelengths
43SCX4L Optical Translator, 40G Coherent, 4x
Client Mux , L band wavelengths
43STA1P Optical Translator, 40G, AnyRate , 1
Client
43SCA1 Optical Translator, 40G, AnyRate , 1
Client
112SCA1 Optical Translator, 100G, AnyRate, 1
Client, C-band
112SNA1 Optical Translator, 100G, AnyRate, 1
Client, C-band, enhanced OSNR
112SA1L Optical Translator, 100G, AnyRate, 1
Client, L-band
112SCX10 Optical Translator, 100G, 10x Client
Mux, C-band
112SNX10 Optical Translator, 100G, 10x Client
Mux, C-band, enhanced OSNR
112SX10L Optical Translator, 100G, 10x Client
Mux, L-band
4DPA4 Optical Translator, AnyRate, 4x Client
Mux
4DPA2 Optical Translator, AnyRate, 2x Client
Mux
11QPA4 Optical
Translator, 11G Quad Port, Any rate, 4
client
11QTA4 Optical
Translator, 11G Quad Port with CFP
line module, Any rate, 4 client
11DPE12 Optical Translator, 11G
Double Port Ethernet 12 client
11DPE12E Optical Translator, Enhanced
11G Double Port Ethernet 12 client
11DPM12 Optical
Translator,11G Double Port, Any rate,
12 clients

2004 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

TYPEID Value Description


MVAC Multiple
Variable Attenuator Card
SVAC Single Variable Attenuator Card
OPS Optical Protection Switch
SFD44 SFD 44 module
SFD44B SFD 44B module
SFD40 SFD 40 module
SFD40B SFD 40B module
SFD5A SFD5A circuit pack
SFD5B SFD5B circuit pack
SFD5C SFD5C circuit pack
SFD5D SFD5D circuit pack
SFD5E SFD5E circuit pack
SFD5F SFD5F circuit pack
SFD5G SFD5G circuit pack
SFD5H SFD5H circuit pack
SFD5 SFD5 circuit pack (includes SFD5A -
SFD5H)
SFD8A SFD8A circuit pack
SFD8B SFD8B circuit pack
SFD8C SFD8C circuit pack
SFD8D SFD8D circuit pack
SFC2A SFC2A circuit pack
SFC2B SFC2B circuit pack
SFC2C SFC2C circuit pack
SFC2D SFC2D circuit pack
SFC2 SFC2 circuit pack (includes SFC2A -
SFC2D)
SFC4A SFC4A circuit pack
SFC4B SFC4B circuit pack
SFC4 SFC4 circuit pack (includes SFC4A,
SFC4B)
SFC8 SFC8 circuit pack
DCM Dispersion Compensation Module (all
types)
ITLB Interleaver Module (bi-directional)
ITLU Interleaver Module (uni-directional)

Default: <all applicable values listed above>


Addressing: None
Description: Provisioned equipment Type. When AID=ALL and a TYPEID
value is not specified, the command returns all equipment of all

1830PSS R3.6.50 - TL1 Commands and Messages 2005


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT
types. When AID=ALL and a TYPEID value is specified, the
command returns all equipment of the specified type.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:[<TYPEID>]:[ACTUALTYPE=\"<value>\"][,DESCR=\"<value>\"][,
HIGHTEMPTH=<value>][,LOWTEMPTH=<value>][,TEMPTOL=<value>][,TEMPERATU
RE=<value>][,AMPS=<value>][,SHELFAINS=<value>][,PROVSERNUM=\"<value>
\"][,CONNECTIVITY=<value>][,DCMDISTANCE=][,FIBERTYPE=][,EXPECTED_AMP
S=<value>][,CARDMODE=<value>][,CARDRATE=<value>][,TPID=<value>][,STP
ID1=][,STPID2=][,STPID3=][,STPID4=][,FLOWCM=][,FANSPEED=]:[<PST>][,<
SST>]" cr lf]*
^^^/* <Command_Code> */ cr lf

OUTPUT PARAMETERS

2006 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

AID Value Description


SYSTEM (System AID)
SHELF-<shelf> (Universal Shelf)
SHELF-<shelf> (Passive Shelf)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
SLOT-<shelf>-1 (Generic Slot AID in Passive Shelf)
FLC-1-<slot> (FLC Circuit Pack)
MT0C-<shelf>-<slot> (MT0C Circuit Pack)
BTC-<shelf>-<slot> (BTC Circuit Pack)
EC-<shelf>-<slot> (Shelf Equipment Controller)
USRPNL-1-<slot> (User Panel)
PF-<shelf>-<slot> (Power Filter)
FAN-<shelf>-<slot> (Fan)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
ALPFGT-<shelf>-<slot> (ALPFGT Circuit Pack)
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
RA2P-<shelf>-<slot> (RA2P Circuit Pack)
OSCT-<shelf>-<slot> (OSCT Circuit Pack)
WTOCM-<shelf>-<slot> (WTOCM Circuit Pack)
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
11STAR1-<shelf>-<slot> (11STAR1 Circuit Pack)
11STMM10-<shelf>-<slot> (11STMM10 Circuit Pack)
11STGE12-<shelf>-<slot> (11STGE12 Circuit Pack)
43STX4-<shelf>-<slot> (43STX4 Circuit Pack)
43STX4P-<shelf>-<slot> (43STX4P Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STA1P-<shelf>-<slot> (43STA1P Circuit Pack)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
112SCA1-<shelf>-<slot> (112SCA1 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot> (112SA1L Circuit Pack)
112SCX10-<shelf>-<slot> (112SCX10 Circuit Pack)

1830PSS R3.6.50 - TL1 Commands and Messages 2007


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

AID Value Description


112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot> (112SX10L Circuit Pack)
4DPA2-<shelf>-<slot> (4DPA2 Circuit Pack)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
11QPA4-<shelf>-<slot> (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12-<shelf>-<slot> (11DPE12 Circuit Pack)
11DPE12E-<shelf>-<slot> (11DPE12E Circuit Pack)
11DPM12-<shelf>-<slot> (11DPM12 Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
OPS-<shelf>-<slot> (OPSA Circuit Pack)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-<slot> (SFD5/8 Module)
SFC-<shelf>-<slot> (SFC2/4/8 Module)
DCM-<shelf>-1 (DCM Module)
ITL-<shelf>-1 (ITLB/ITLU Module)

Description: Access identifier of equipment entity

2008 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

TYPEID Value Description


UNV_SHELF_36 PSS36 Universal shelf
UNV_SHELF PSS32 Universal shelf
UNV_SHELF_16 PSS16 Universal shelf
SFD44_SHELF SFD44 shelf
SFD44B_SHELF SFD44B shelf
SFD40_SHELF SFD44 shelf
SFD40B_SHELF SFD44B shelf
DCM_SHELF DCM shelf
ITLB_SHELF ITLB shelf
ITLU_SHELF ITLU shelf
FLC First Level Controller
MT0C Matrix Zero
BTC Bus Termination Card
EC Shelf Equipment Controller
USRPNL Customer Interface Panel
PF Power Supply Filter
FAN Fan
ALPHG Line Driver, low power
AHPHG Line Driver, high power
AHPLG Line Driver (high power, low gain)
ALPFGT Line Driver , low power
A2325A Line Driver (The AMP with 25dbm
output power and 23db gain)
AM2325B Line Driver (23 dBm power, variable
gain, C-band, DCM removed)
AM2017B Line Driver (high power, low gain, DCM
removed)
AM2125A Uni-directional Line Driver (21dBm max
power, 25dB max gain)
AM2125B Uni-directional Line Driver (21dBm max
power, 25dB max gain, DCM removed)
AM2318A Uni-directional Line Driver (23 dBm max
power, 18 dB max gain)
RA2P Uni-directional Raman Line Driver
OSCT Optical Supervisory Channel
WTOCM Wavelength Tracker Optical Channel
Monitoring card
CWR8 Colorless Wavelength Router - 8
Degree, 44 Channel
CWR8-88 Colorless Wavelength Router - 8
Degree, 88 Channel
WR8-88A Wavelength Router - 8 Degree, 88
Channel

1830PSS R3.6.50 - TL1 Commands and Messages 2009


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

TYPEID Value Description


WR2-88A Wavelength Router - 2 Degree, 88
Channel
MESH4 Mesh card - 4 outputs
11STAR1 Optical Translator, 11G Any Rate
11STMM10 Optical Translator, 10x Client Mux
11STGE12 Optical Translator, 12x GE Client Mux
43SCX4 Optical Translator, 40G coherent, 4x
Client Mux, C-band
43SCX4L Optical Translator, 40G coherent, 4x
Client Mux, L-band
43STX4 Optical Translator, 40G, 4x Client Mux ,
44 wavelengths
43STX4P Optical Translator, 40G, 4x Client Mux ,
88 wavelengths
43STA1P Optical Translator, 40G, AnyRate ,1
Client
43SCA1P Optical Translator, 40G, AnyRate ,1
Client
112SCA1 Optical Translator, 100G, AnyRate, 1
Client, C-band
112SNA1 Optical Translator, 100G, AnyRate, 1
Client, C-band, enhanced OSNR
112SA1L Optical Translator, 100G, AnyRate, 1
Client, L-band
112SCX10 Optical Translator, 100G, 10x Client
Mux, C-band
112SNX10 Optical Translator, 100G, 10x Client
Mux, C-band, enhanced OSNR
112SX10L Optical Translator, 100G, 10x Client
Mux, L-band
4DPA4 Optical Translator, AnyRate, 4x Client
Mux
4DPA2 Optical
Translator, AnyRate, 2x Client Mux
11QPA4 Optical
Translator, 11G Quad Port, Any rate, 4
client
11QTA4 Optical
Translator, 11G Quad Port with CFP
line module, Any rate, 4 client
11DPE12 Optical Translator, 11G
Double Port Ethernet 12 client
11DPE12 E Optical Translator,
Enhanced 11G Double Port Ethernet 12
client
11DPM12 Optical
Translator,11G Double Port, Any rate,

2010 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

TYPEID Value Description


12 clients
MVAC Multiple
Variable Attenuator Card
SVAC Single Variable Attenuator Card
OPS Optical Protection Switch
SFD44 SFD44 module
SFD44B SFD 44B module
SFD40 SFD40 module
SFD40B SFD40B module
SFD5A SFD5A circuit pack
SFD5B SFD5B circuit pack
SFD5C SFD5C circuit pack
SFD5D SFD5D circuit pack
SFD5E SFD5E circuit pack
SFD5F SFD5F circuit pack
SFD5G SFD5G circuit pack
SFD5H SFD5H circuit pack
SFD8A SFD8A circuit pack
SFD8B SFD8B circuit pack
SFD8C SFD8C circuit pack
SFD8D SFD8D circuit pack
SFC2A SFC2A circuit pack
SFC2B SFC2B circuit pack
SFC2C SFC2C circuit pack
SFC2D SFC2D circuit pack
SFC4A SFC4A circuit pack
SFC4B SFC4B circuit pack
SFC8 SFC8 circuit pack
DCM Dispersion Compensation Module (all
types)
ITLB Interleaver Module (bi-directional)
ITLU Interleaver Module (uni-directional)

Description: Provisioned type of shelf, or provisioned type of equipment.

1830PSS R3.6.50 - TL1 Commands and Messages 2011


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

ACTUALTYPE= Value Description


UNPLUGGED Not present
UNKNOWN Present but type not known
UNV_SHELF_36 PSS36 Universal shelf
UNV_SHELF PSS32 Universal shelf
UNV_SHELF_16 PSS16 Universal shelf
SFD44_SHELF SFD44 shelf
SFD44B_SHELF SFD44B shelf
SFD40_SHELF SFD44 shelf
SFD40B_SHELF SFD44B shelf
DCM_SHELF DCM shelf
ITLB_SHELF ITLB shelf
ITLU_SHELF ITLU shelf
FLC First Level Controller
MT0C Matrix Zero
BTC Bus Termination Card
EC Shelf Equipment Controller
USRPNL Customer Interface Panel
PF Power Supply Filter
FAN Fan
ALPHG Line Driver, low power
AHPHG Line Driver, high power
AHPLG Line Driver (high power, low gain)
ALPFGT Line Driver , low power
A2325A Line Driver (25dbm output power and
23db gain)
AM2325B Line Driver (23 dBm power, variable
gain, C-band, DCM removed)
AM2017B Line Driver (high power, low gain, DCM
removed)
AM2125A Uni-directional Line Driver (21dBm max
power, 25dB max gain)
AM2125B Uni-directional Line Driver (21dBm max
power, 25dB max gain, DCM removed)
AM2318A Uni-directional Line Driver (23 dBm max
power, 18 dB max gain)
RA2P Uni-directional Raman Line Driver
OSCT Optical Supervisory Channel
WTOCM Wavelength Tracker Optical Channel
Monitoring card
CWR8 Colorless Wavelength Router - 8
Degree, 44 Channel
CWR8-88 Colorless Wavelength Router - 8
Degree, 88 Channel

2012 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

ACTUALTYPE= Value Description


WR8-88A Wavelength Router - 8 Degree 88
channel
WR2-88A Wavelength Router - 2 Degree, 88
channel
MESH4 Mesh4 card
11STAR1 Optical Translator, 11G Any Rate
11STMM10 Optical Translator, 10x Client Mux
11STGE12 Optical Translator, 12x GE Client Mux
43SCX4 Optical Translator, 40G coherent, 4x
Client Mux, C-band
43SCX4L Optical Translator, 40G coherent, 4x
Client Mux, L-band
43STX4 Optical Translator, 40G, 4x Client Mux ,
44 wavelengths
43STX4P Optical Translator, 40G, 4x Client Mux ,
88 wavelengths
43STA1P Optical Translator, 40G, AnyRate ,1
Client
43SCA1 Optical Translator, 40G, AnyRate ,1
Client
112SCA1 Optical Translator, 100G, AnyRate, 1
Client, C-band
112SNA1 Optical Translator, 100G, AnyRate, 1
Client, C-band, enhanced OSNR
112SA1L Optical Translator, 100G, AnyRate, 1
Client, L-band
112SCX10 Optical Translator, 100G, 10x Client
Mux, C-band
112SNX10 Optical Translator, 100G, 10x Client
Mux, C-band, enhanced OSNR
112SX10L Optical Translator, 100G, 10x Client
Mux, L-band
4DPA4 Optical Translator, AnyRate, 4x Client
Mux
4DPA2 Optical
Translator, AnyRate, 2x Client Mux
11QPA4 Optical
Translator, 11G Quad Port, Any rate, 4
client
11QTA4 Optical
Translator, 11G Quad Port with CFP
line module, Any rate, 4 client
11DPE12 Optical Translator, 11G
Double Port Ethernet 12 client
11DPE12 E Optical Translator,
Enhanced 11G Double Port Ethernet 12
client

1830PSS R3.6.50 - TL1 Commands and Messages 2013


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

ACTUALTYPE= Value Description


11DPM12 Optical
Translator,11G Double Port, Any rate,
12 clients
MVAC Multiple
Variable Attenuator Card
SVAC Single Variable Attenuator Card
OPS Optical Protection Switch
SFD44 SFD44 module
SFD44B SFD 44B module
SFD40 SFD40 module
SFD40B SFD40B module
SFD5A SFD5A circuit pack
SFD5B SFD5B circuit pack
SFD5C SFD5C circuit pack
SFD5D SFD5D circuit pack
SFD5E SFD5E circuit pack
SFD5F SFD5F circuit pack
SFD5G SFD5G circuit pack
SFD5H SFD5H circuit pack
SFD8A SFD8A circuit pack
SFD8B SFD8B circuit pack
SFD8C SFD8C circuit pack
SFD8D SFD8D circuit pack
SFC2A SFC2A circuit pack
SFC2B SFC2B circuit pack
SFC2C SFC2C circuit pack
SFC2D SFC2D circuit pack
SFC4A SFC4A circuit pack
SFC4B SFC4B circuit pack
SFC8 SFC8 circuit pack
DCM Dispersion Compensation Module (all
types)
ITLB Interleaver Module (bi-directional)
ITLU Interleaver Module (uni-directional)
ITLU Interleaver Module (uni-directional)

Description: Actual type of shelf, or actual type of equipment.

DESCR= Value Description


<0-255 CHARACTER ASCII STRING>

2014 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

Description: User description of the equipment.

HIGHTEMPTH= Value Description


{-5-90}(Celsius)
{23-194} (Fahrenheit)

Description: Temperature (in degrees Celsius/Fahrenheit) at which a high


temperature alarm is raised. Applies to EC, FLC, MTX, LD,
MESH, OSC, OPS, OT, PF, VAC, WR, and WTOCM circuit packs.

LOWTEMPTH= Value Description


{-5-90}(Celsius)
{23-194} (Fahrenheit)

Description: Temperature (in degrees Celsius/Fahrenheit) at which a low


temperature alarm is raised. Applies to EC, FLC, MTX, LD,
MESH, OSC, OPS, OT, PF, VAC, WR, and WTOCM circuit packs.

TEMPTOL= Value Description


{0-10} (Celsius)
{0-18} (Fahrenheit)

Description: Number of degrees Celsius/Fahrenheit above the low temperature


threshold or below the high temperature threshold at which a
temperature alarm clears. Applies to EC, FLC, MTX, LD, MESH,
OSC, OPS, OT, PF, VAC, WR, and WTOCM circuit packs.and
OPS circuit packs.

TEMPERATURE= Value Description


{-20-90} (Celsius)
{-4-194} (Fahrenheit)

Description: Current card temperature in degrees Celsius/Fahrenheit. Applies


to EC, FLC, MTX, LD, MESH, OSC, OPS, OT, PF, VAC, WR, and
WTOCM circuit packs.

AMPS= Value Description


{0, 20, 30, 50, 70, 150}

Description: Applies only to PF modules. The actual current rating of the


module. When the PF module is unequipped the reported value
will be 0.

1830PSS R3.6.50 - TL1 Commands and Messages 2015


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

SHELFAINS= Value Description


YES
NO

Description: Shelf AINS Mode can be set to YES to prevent immediate loss of
communication alarming against a newly pre-provisioned shelf.
Applies to all shelf types.

PROVSERNUM= Value Description


<0-16 CHARACTER ASCII STRING>

Description: The provisioned shelf serial number. Applies to SFD44, SFD44B,


ITL and DCM shelves only.

CONNECTIVITY= Value Description


REQUIRED Managed SFD/DCM/ITL shelf
NOTREQUIRED Unmanaged SFD/DCM/ITL shelf

Description: Shelf connectivity indicates whether or not the SFD/DCM/ITL shelf


is expected to be read/managed via the serial electrical inventory
wire. This is needed when a customer needs to locate the
SFD/DCM/ITL beyond the distance limit of the wire. When
CONNECTIVITY=REQUIRED, inventory readability indicates
presence/absence. When CONNECTIVITY=NOTREQUIRED, the
SFD/DCM/ITL is referred to as "unmanaged", and is treated as
always present, even though there is no communication.

DCMDISTANCE= Value Description


[0|10|20|30|40|50|60|70|80|90|100|110|1
20|130|140]

Description: Specifies the Compensation distance for the equipped DCM when
the DCM is unmanaged.

FIBERTYPE= Value Description


SSMF
ELEAF
TWRS

Description: Specifies the Compensation fiber type for the equipped DCM when
the DCM is unmanaged.

2016 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

EXPECTED_AMPS Value Description


=
{AUTO, 20, 30, 35, 50, 60, 70, 150}

Description: Applies only to Universal shelves. The expected current rating of


the shelf power supply modules. For PSS-36, the valid value is:
150. For PSS-32, the valid values are: AUTO, 20, 30, 50, 60, 70.
For PSS-16, the valid values are: AUTO, 20, 35.
Description: Applies only to Universal shelves. The expected current rating of
the shelf power supply modules. For PSS4, the value 3.7A is used
for E4PFACK PF,the value 8.5A is used for E4PFDCAK PF; and
the value 20.6 is used for E4PFDCBK PF.

CARDMODE= Value Description


DUALTRAN
FLEXMUX
SONETSDH
OTU3

Description: Specify the working mode of the board.

CARDRATE= Value Description


FULLRATE
SUBRATE
QINQ

Description: Specify the working rate mode of the board.


This parameter only applies to 11DPE12 and 11DPE12E pack.
For R3.5, the only supported value for CARDRATE is QINQ.

TPID= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x88A8
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12 pack working under
QINQ mode.

1830PSS R3.6.50 - TL1 Commands and Messages 2017


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

STPID1= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x88A8
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode.

STPID2= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x8100
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode.

STPID3= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x9100
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.
This parameter only applies to 11DPE12E pack working under
QINQ mode.

STPID4= Value Description


{0x0001 - 0xFFFF}( Except for the value
defined for the public protocal type in
the ethernet frame)

Default: 0x9200
Addressing: None
Description: Specify the value of TPID field in the S-VLAN TAG in the header of
the ethernet frame.

2018 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

This parameter only applies to 11DPE12E pack working under


QINQ mode.

FLOWCM= Value Description


APS/PCC
CCM

Default:APS/PCC
Addressing: None
Description: Specify flow continuity monitoring attributes when pack is in QinQ
mode.
This parameter only applies to 11DPE12E pack.

FANSPEED= Value Description


NORMAL
MAXIMUM

Default: NORMAL
Addressing: None
Description: Fan speed. For FANSPEED=NORMAL, the fan speed is
controlled automatically by the system for normal operation. For
FANSPEED=MAXIMUM, the fan runs at constant full speed for
maintenance operations.
This parameter only applies to the FAN AID

PST Value Description


IS-NR In Service, Normal.
IS-ANR In Service, Abnormal.
OOS-AU Out of Service, Autonomous - the
module is out of service due to an
autonomous event
OOS-MA Out of Service, Management - the
module is out of service due to
management action
OOS-AUMA Out of Service, Autonomous and
Management - the module is out of
service both due to an autonomous
event and management action.

Description: Primary state. Does not apply to SYSTEM or SHELF.

1830PSS R3.6.50 - TL1 Commands and Messages 2019


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

SST Value Description


AINS Autonomous in service - The module is
in the AINS state and will become in
service when plugged in.
FLT Fault - The module has a Hardware
Failure condition
MT Maintenance
MEA Mismatch of Equipment and Attributes -
An incompatible module is physically
present in a provisioned slot.
UAS Unassigned. No equipment is
provisioned in the addressed position
UEQ Unequipped - there is no module in the
addressed position
ACT Active - for EC equipment protection.
NBK No Backup - for EC equipment
protection.
STBY Standby - for EC equipment protection.

Description: Secondary state. Does not apply to SYSTEM or SHELF. Zero or


more of the above values may apply to a module. If multiple
values apply, they are comma-separated.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Input, Invalid ACcess identifier
• the AID is syntactically incorrect or any component of the AID is out of supported range

EXAMPLES
In the following example, the parameters of an OT are retrieved.

2020 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EQPT Issue 1, December 2011

RTRV-EQPT::11STAR1-2-5;

RELATED COMMANDS
DLT-EQPT
ED-EQPT
ENT-EQPT
RMV-EQPT
RST-EQPT

1830PSS R3.6.50 - TL1 Commands and Messages 2021


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EQPT

2022 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-EXT-CONT


Command Name: RETRIEVE EXTERNAL CONTROL

PURPOSE
The RTRV-EXT-CONT instructs an NE to send the control state of an external control. The command
can be used to audit the result of an OPR-EXT-CONT or a RLS-EXT-CONT command.

INPUT FORMAT

RTRV-EXT-CONT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

AID Value Description


PF-1-44-HOUSEKEEPINGOUT{1-4} (PSS-36 External Control Points)
USRPNL-1-<slot>-HOUSEKEEPINGOU (User Panel External Control Points)
T{1-4}
USRPNL-1-<slot>-HOUSEKEEPINGOU (PSS-16 User Panel External Control
T{1-4} Points)

Default: Entry required.


Addressing: None
Description: Access IDentifier of the external control output point

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System Assigned CTAG Value>


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2023


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EXT-CONT
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<CONTTYPE>,<CONTSTATE>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


PF-1-44-HOUSEKEEPINGOUT{1-4} (PSS-36 External Control Points)
USRPNL-1-<slot>-HOUSEKEEPINGOU (User Panel External Control Points)
T{1-4}
USRPNL-1-<slot>-HOUSEKEEPINGOU (PSS-16 User Panel External Control
T{1-4} Points)

Description: Access IDentifier of the external control output point.

CONTTYPE Value Description


<0-56 characters>

Description: Control Type.

CONTSTATE Value Description


OPER
RLS

Description: Control State. Identifies if the external control is in the operated


state or not. Values are:
OPER Operated
RLS Released

2024 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-EXT-CONT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
^^^/* <EXPANDED ERROR CODE DESCRIPTION> */ cr lf
[^^^/* <OPTIONAL FREE FORMAT TEXT> */ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In this example, the user retrieves the control state of USRPNL-1-40-HOUSEKEEPINGOUT2:

RTRV-EXT-CONT:SHERLOCK:USRPNL-1-40-HOUSEKEEPINGOUT2;

A successful response for this commnand would be:

cr lf lf
^^^SHERLOCK^ 01-03-16^ 03:14:32 cr lf
M^^C0236^COMPLD cr lf
^^^"USRPNL-1-40-HOUSEKEEPINGOUT2:RACKLAMP,CONTS,OPER" cr lf
^^^/* RTRV-EXT-CONT:SHERLOCK:USRPNL-1-40-HOUSEKEEPINGOUT2:C0236 */
cr lf
;

RELATED COMMANDS
OPR-EXT-CONT
RLS-EXT-CONT

1830PSS R3.6.50 - TL1 Commands and Messages 2025


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-EXT-CONT
SET-ATTR-CONT

RELATED AUTONOMOUS RESPONSES


Not Applicable

2026 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-FC100


Command Name: RTRV-FC100

PURPOSE
The RTRV-FC100 command shall be used to retrieve all parameters related to the FC client port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-FC100:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 clietn ports)
0

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2027


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC100
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,ENCMODE=<value>][,FCMODE=<value>][,LOSPROP=<value>][,MODULETYPE=<va
lue>][,CHANNEL=<value>][,DESCR=<value>][,TS=\"<value>\"][,RXPOWER=<v
alue>][,TXPOWER=<value>][,CONTAINER=<value>]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC10 (FC100 on 11DPM12 clietn ports)
0

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

2028 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC100 Issue 1, December 2011

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

ENCMODE= Value Description


{GFP-T}

Description: The parameter encmode describes the encapsulation mode used


to transport the client signal.
GFP-T Generic Framing Protocol - Transparent
encapsulation.
Restriction : parameter ENCMODE (GFP-T) is not applicable for
AIDs 4DPA4-<shelf>-<slot> -C{1~4}. Parameter ENCMODE
(GFP-T) is applicable to AID
11STMM10-<shelf>-<slot>-C{1-10}and
11DPM12-<shelf>-<slot>-C{1-12}.

FCMODE= Value Description


{FIBRE_CHANNEL, FICON,
ISC3_PEER_MODE}

Description: Attribute that controls FC interface type (Fibre Channel compliant


with INCITS x.320 or FICON).
ISC3_PEER_MODE applies only to 4DPA4.

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, 2FCLC-L, 2FCSN-I,
4FCLC-L, 4FCSN-I, SS-16.1A}

Description: Attribute that defines the pluggable module type used in providing
the physical layer function on the specified GFC port. If the value

1830PSS R3.6.50 - TL1 Commands and Messages 2029


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC100
AUTO is chosen, the NE shall accept the pluggable module type
inserted in the socket if the previous MODULETYPE value was
<null>. If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set to USER.
Note: 4DPA4 supports only 4FCLC-L and 4FCSN-I.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13,16,19,22,25,2
8,31 (11STMM10 timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)
0-0 (unassigned 4DPA4 timeslot)

Description: Timeslot assignment.


11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
FC100 requires 7 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

RXPOWER= Value Description


<numerical value>

2030 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC100 Issue 1, December 2011

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

CONTAINER= Value Description


{None,ODU0}

Default: None
Address: None
Description: Specifies the granularity for client FC100 mapping to ODU2
multiplexing structure.
Set to odu0-mapping into ODU0 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

1830PSS R3.6.50 - TL1 Commands and Messages 2031


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC100
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-FC100


command.
RTRV-FC100:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STMM10-1-5-C1::AINSCNTDWN=00-00,
AINSREF=SYSTEM,AINSTMR=08-00,ENCMODE=GFP_T,FCMODE=FIBRE_CHANNEL,LOSP
ROP=LASERON,MODULETYPE=AUTO,CHANNEL=850,DESCR=\"\",TS="ODU1-L1-2-25"
,RXPOWER=-3.62,TXPOWER=-1.06:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-FC100
RTRV-FC100
RST-FC100
DLT-FC100
ED-FC100
RMV-FC100

RELATED AUTONOMOUS RESPONSES


none

2032 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-FC1200


Command Name: RTRV-FC1200

PURPOSE
The RTRV-FC1200 command shall be used to retrieve all parameters related to the FC1200 client
port. The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-FC1200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2033


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC1200
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,CHANNEL=<value>][,
MODULETYPE=<value>][,LOSPROP=<value>][,DESCR=<value>][,RXPOWER=<valu
e>][,TXPOWER=<value>]:<PST> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition out of AINS.
SYSTEM use the system level timer
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, transition soak time out of AINS.

2034 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC1200 Issue 1, December 2011

Format is HOURS-MINUTES. The maximum time is 96-00. The


minimum value is 00-01.
Setting a value for AINSTMR will cause the value of AINSREF to
be set to OVRD.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Retrieves the channel frequency of the client port.

MODULETYPE= Value Description


{AUTO, USER, 10GB-SR, XI-64.1,
XS-64.2C, XL-64.2C}

Description: Attribute defines pluggable module type to be used in providing


physical layer function on specified FC1200 port.

LOSPROP= Value Description


<LASEROFF, LASERON>

Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

1830PSS R3.6.50 - TL1 Commands and Messages 2035


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC1200
Description: TXPOWER,Transmit Power. Measured optical transmit power
(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

2036 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC1200 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a


RTRV-FC1200 command.
RTRV-FC1200:NODE-1:11STAR1-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STAR1-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,CHANN
EL=1310,MODULETYPE=XI-641,LOSPROP=LASERON,DESCR=\"\",RXPOWER=-5.5,TX
POWER=-2.44:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-FC1200
RTRV-FC1200
RST-FC1200
DLT-FC1200
ED-FC1200
RMV-FC1200

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2037


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC1200

2038 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-FC200


Command Name: RTRV-FC200

PURPOSE
The RTRV-FC200 command shall be used to retrieve all parameters related to the FC client port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-FC200:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 clietn ports)
0

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2039


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC200
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,ENCMODE=<value>][,FCMODE=<value>][,LOSPROP=<value>][,MODULETYPE=<va
lue>][,CHANNEL=<value>][,DESCR=<value>][,TS=\"<value>\"][,RXPOWER=<v
alue>][,TXPOWER=<value>][,CONTAINER=]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-FC20 (FC200 on 11DPM12 clietn ports)
0

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer
OVRD user has chosent to use the AINSTMR value
instead of the AINSREF value for automatic
in-service transition out of AINS.

2040 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC200 Issue 1, December 2011

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

ENCMODE= Value Description


{GFP-T}

Description: The parameter encmode describes the encapsulation mode used


to transport the client signal.
GFP-T Generic Framing Protocol - Transparent
encapsulation.
Restriction : parameter ENCMODE (GFP-T) is not applicable for
AIDs 4DPA4-<shelf>-<slot> -C{1~4}. Parameter ENCMODE
(GFP-T) is applicable to AID
11STMM10-<shelf>-<slot>-C{1-10}and
11DPM12-<shelf>-<slot>-C{1-12}.

FCMODE= Value Description


{FIBRE_CHANNEL, FICON,
ISC3_PEER_MODE}

Description: Attribute that controls FC interface type (Fibre Channel compliant


with INCITS x.320 or FICON).
ISC3_PEER_MODE applies only to 4DPA4.

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, 2FCLC-L, 2FCSN-I,
4FCLC-L, 4FCSN-I, SS-16.1A}

Description: Attribute that defines the pluggable module type used in providing
the physical layer function on the specified FC200 port. If the

1830PSS R3.6.50 - TL1 Commands and Messages 2041


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC200
value AUTO is chosen, the NE shall accept the pluggable module
type inserted in the socket if the previous MODULETYPE value
was <null>. If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set to USER.
Note: 4DPA4 supports only 4FCLC-L and 4FCSN-I.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


ODU1-L1-{1-3}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{4}-{1,4,7,10,13}
(11STMM10 timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)
0-0 (unassigned 4DPA4 timeslot)

Description: Timeslot assignment.


11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
FC200 requires 14 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

RXPOWER= Value Description


<numerical value>

2042 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC200 Issue 1, December 2011

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

CONTAINER= Value Description


{None,ODU1}

Default: None
Address: None
Description: Specifies the granularity for client FC200 mapping to ODU2
multiplexing structure.
Set to odu1-mapping into ODU1 with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

1830PSS R3.6.50 - TL1 Commands and Messages 2043


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC200
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-FC200


command.
RTRV-FC200:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STMM10-1-5-C1::AINSCNTDWN=00-00,
AINSREF=SYSTEM,AINSTMR=08-00,ENCMODE=GFP_T,FCMODE=FIBRE_CHANNEL,LOSP
ROP=LASERON,MODULETYPE=AUTO,CHANNEL=1550,DESCR=\"\",TS="ODU1-L1-2-25
",RXPOWER=-3.62,TXPOWER=-1.06:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-FC200
RTRV-FC200
RST-FC200
DLT-FC200
ED-FC200
RMV-FC200

RELATED AUTONOMOUS RESPONSES


none

2044 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-FC400


Command Name: RTRV-FC400

PURPOSE
The RTRV-FC400 command shall be used to retrieve all parameters related to the FC400 client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-FC400:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 clietn ports)
0

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2045


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC400
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,ENCMODE=<value>][,FCMODE=<value>][,LOSPROP=<value>][,MODULETYPE=<va
lue>][,CHANNEL=<value>][,DESCR=<value>][,TS=\"<value>\"][,RXPOWER=<v
alue>][,TXPOWER=<value>][,CONTAINER=]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12}-FC40 (FC400 on 11DPM12 clietn ports)
0

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSCNTDWN, Automatic In-Service Count Down value, specifies


how much time is currently remaining on the AINS timer before the
facility is placed in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition.

2046 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC400 Issue 1, December 2011

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

ENCMODE= Value Description


{GFP-T}

Description: The parameter encmode describes the encapsulation mode used


to transport the client signal.
GFP-T Generic Framing Protocol - Transparent
encapsulation.
Restriction : parameter ENCMODE (GFP-T) is not applicable for
AIDs 4DPA4-<shelf>-<slot> -C{1,3}(4DPA4 Client Ports - Dual
Tran). Parameter ENCMODE (GFP-T) is applicable to AID
11STMM10-<shelf>-<slot>-C{1-10}and
11DPM12-<shelf>-<slot>-C{1-12} only for FC400 facility.

FCMODE= Value Description


{FIBRE_CHANNEL,FICON}

Description: Attribute that controls FC interface type (Fibre Channel compliant


with INCITS x.320 or FICON).

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, 4FCLC-L, 4FCSN-I}

Description: Attribute that defines the pluggable module type used in providing
the physical layer function on the specified FC400 port. If the
value AUTO is chosen, the NE shall accept the pluggable module
type inserted in the socket if the previous MODULETYPE value

1830PSS R3.6.50 - TL1 Commands and Messages 2047


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC400
was <null>. If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set to USER.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


ODU1-L1-{1-2}-{1,4,7,10,13,16,19,22,2
5,28,31,34,37,40,43,46}
(11STMM10 timeslots)
ODU1-L1-{3}-{1,4,7,10,13,16,19,22,25}
(11STMM10 timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)

Description: Attribute that shows the starting time slot in the line port ODU1
structure.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

2048 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC400 Issue 1, December 2011

CONTAINER= Value Description


{None,ODUF}

Default: None
Address: None
Description: Specifies the granularity for client FC400 mapping to ODU2
multiplexing structure.
Set to oduf-mapping into ODUflex with GMP per G.709.
This parameter only applies to 11DPM12.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

1830PSS R3.6.50 - TL1 Commands and Messages 2049


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC400
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-FC400


command.
RTRV-FC400:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD

"11STMM10-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,ENCM
ODE=GFP_T,FCMODE=FIBRE_CHANNEL,LOSPROP=LASERON,MODULETYPE=AUTO,CHANN
EL=1491,DESCR=\"\",TS="ODU1-L1-2-25",RXPOWER=-3.62,TXPOWER=-1.06:OOS
-AU,FAF"
;

RELATED COMMANDS
ENT-FC400
RTRV-FC400
RST-FC400
DLT-FC400
ED-FC400
RMV-FC400

RELATED AUTONOMOUS RESPONSES


none

2050 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-FC800


Command Name: RTRV-FC800

PURPOSE
The RTRV-FC800 command shall be used to retrieve all parameters related to the FC800 client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-FC800:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2051


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC800
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,CHANNEL=<value>][,
MODULETYPE=<value>][,LOSPROP=<value>][,DESCR=<value>][,RXPOWER=<valu
e>][,TXPOWER=<value>]:<PST> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition out of AINS.
SYSTEM use the system level timer
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

2052 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC800 Issue 1, December 2011

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum value is 00-01.
Setting a value for AINSTMR will cause the value of AINSREF to
be set to OVRD.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Retrieves the channel frequency of the client port.

MODULETYPE= Value Description


{AUTO, USER, X8FCLC-L, X8FCSN-I}

Description: Attribute defines pluggable module type to be used in providing


physical layer function on specified FC800 port.

LOSPROP= Value Description


<LASEROFF, LASERON>

Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

1830PSS R3.6.50 - TL1 Commands and Messages 2053


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC800

TXPOWER= Value Description


<numerical value>

Description: TXPOWER,Transmit Power. Measured optical transmit power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

2054 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FC800 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-FC800


command.
RTRV-FC800:NODE-1:112SCX10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"112SCX10-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,CHAN
NEL=1310,MODULETYPE=XI-641,LOSPROP=LASERON,DESCR=\"\",RXPOWER=-5.5,T
XPOWER=-2.44:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-FC800
RTRV-FC800
RST-FC800
DLT-FC800
ED-FC800
RMV-FC800

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2055


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FC800

2056 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-FE


Command Name: RTRV-FE

PURPOSE
The RTRV-FE command shall be used to retrieve all parameters related to the FE client port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-FE:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2057


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FE
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,AUTONEG=<value>][,LOSPROP=<value>][,MODULETYPE=<value>][,SSMTRANS=<
value>][,SYNCEOPPMODE=<value>][,CHANNEL=<value>][,DESCR=<value>][,RX
POWER=<value>][,TXPOWER=<value>][,STPID=<value>]:<PST>[,<SST>]" cr
lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition out of AINS.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, indicates the transition soak time out of AINS.

2058 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FE Issue 1, December 2011

Format is HOURS-MINUTES. The maximum time is 96-00. The


minimum time is 00-01.
Setting a value for AINSTMR will cause the value of AINSREF to
be set to OVRD.

AUTONEG= Value Description


{ENABLE, DISABLE}

Description: Attribute that controls status of auto-negotiation.


The AUTONEG parameter only applies to the electrical FE.

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.
Parameter LOSPROP does not apply to 4DPA2 OT.

MODULETYPE= Value Description


<pluggable module type>
{AUTO, 100BFX,100BLX10, 1000B-T2}

Default: AUTO
Addressing: None
Description: Attribute defines pluggable module type to be used in providing
physical layer function on specified FE port. If AUTO value is
chosen NE shall accept the pluggable module type inserted in the
socket if previous MODULETYPE value was <null>.
Restrictions: 100BFX is only supported on 11DPE12
OT.
100BLX10 and 1000B-T2 are
only supported on 11DPE12E OT.

SSMTRANS= Value Description


IN SDH mode :
{ACT, PRC, SSU_A, SSU_B, SEC,
DNU,NONE}

in SONET mode :
{ACT, PRS,STU, ST2, ST3E, ST3,DUS
,NONE}

Default: ACT
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2059


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FE
Description: Attribute that defines the SSM/Quality Level Transmission in the
port
This parameter shall only apply to the 11DPE12E for
sync-e function.
NOTE:This parameter only takes effect only when pack
SYNCE function is set to enable.

SYNCEOPPMODE Value Description


=
{SYNC,NON-SYNC}

Default: SYNC
Addressing: None
Description: Attribute that defines port Synchronous Ethernet Operation Mode
This parameter shall only apply to the 11DPE12E for SYNC-E
fucntion.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: STPID1
Address: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

2060 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FE Issue 1, December 2011

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
PMI Performance Monitoring Inhibited
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

1830PSS R3.6.50 - TL1 Commands and Messages 2061


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FE
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-FE


command.
RTRV-FE:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD

"11DPE12E-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,AUTO
NEG=DISABLE,LOSPROP=LASERON,MODULETYPE=AUTO,CHANNEL=1471,DESCR=\"\",
STPID=STPID1,RXPOWER=-5.5,TXPOWER=-2.44:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-FE
RTRV-FE
RST-FE
DLT-FE
ED-FE
RMV-FE

RELATED AUTONOMOUS RESPONSES


none

2062 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-FFP-EQPT


Command Name: RETRIEVE FACILITY PROTECTION
GROUP PARAMETERS

PURPOSE
The RTRV-FFP-EQPT command retrieves all provisionable parameters of a 1+1 facility protection
group (Y-cable, OPS, or E-SNCP).
When “ALL” is specified as the AID, the RTRV-FFP-EQPT command retrieves parameters for all
protection groups currently provisioned on the NE.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-FFP-EQPT:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target Identifier, specifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2063


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FFP-EQPT

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL (ALL AID)

Default: ALL
Addressing: None
Description: For Y-cable and OPS: the working port AID or the protection port
AID. For E-SNCP: the client port AID. “ALL” for all protection
groups.
Restriction: 4DPA4 OT supports protection only in FlexMux mode.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

2064 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FFP-EQPT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"WORKING,PROTECTION[,ESNCP_CLIENT]::PROTECTMODE=\"<value>\",PSDI
RN=<value>,RVRTV=<value>,WTR=<value>" cr lf]*
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

WORKING Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: The working port AID.

1830PSS R3.6.50 - TL1 Commands and Messages 2065


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FFP-EQPT

PROTECTION Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
OPS-<shelf>-<slot>-{A, B} (OPSA Line Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS, fullrate, qinq)
32}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: The protection port AID.

ESNCP_CLIENT Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12}-VTS{ (11DPE12 Client VTS, qinq)
1-10}
11DPE12E-<shelf>-<slot>-C{1-12}-VTS (11DPE12E Client VTS, qinq)
{1-10}
11DPE12E-<shelf>-<slot>-L{1-2}-VTS{1 (11DPE12E Line VTS, qinq)
-100}
11DPE12-<shelf>-<slot>-L{1-2}-VTS{1- (11DPE12 Line VTS under qinq)
100}

Description: The E-SNCP Client Port AID.

2066 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FFP-EQPT Issue 1, December 2011

PROTECTMODE= Value Description


<0-21 CHARACTER ASCII STRING>

Description: Protection mode. Indicates type of protection group. For Y-cable


protection it is "1+1 Optical Splitter". For OPS protection, it is "1+1
OPS". For E-SNCP protection, it is "1+1 E-SNCP".

PSDIRN= Value Description


UNI Unidirectional
BI Bidirectional

Description: Protection switching directionality. In unidirectional switching, local


and remote ends switch independently. Y-cable, OPS, and
E-SNCP protection groups support unidirectional operation. In
bidirectional switching, local and remote ends are coordinated by
an end-to-end protocol so that both are on working, or both are on
protection. Only Y-cable protection groups support bidirectional
operation. Both ends of a Y-cable circuit must be provisioned the
same way. A mismatch will cause an alarm.

RVRTV= Value Description


N No
Y Yes

Description: Indicates whether or not switching operation is revertive. In


non-revertive switching, protection remains active after working
has recovered from the failure that caused the automatic switch to
protection, or after the user switch-to-protection command is
cleared. Y-cable, OPS, and E-SNCP protection groups support
non-revertive operation. In revertive switching, traffic is
automatically switched back to working when working has
recovered from the failure that caused the automatic switch to
protection, or when the user switch-to-protection command is
cleared. In the failure-recovery case, the switch back is delayed by
the WTR parameter. In the case of clearing a user switch
command, there is no delay. Only bidirectional Y-cable protection
groups support revertive operation. Both ends of a Y-cable circuit
must be provisioned the same way.
Restriction: Parameter value RVRTV=Y does not apply to 43STA1P,43STX4,
43STX4P OTs (always non-revertive).

WTR= Value Description


{1-20}

Description: Wait-To-Restore. Affects switching behavior only when


RVRTV=Y. (But the WTR value is displayed for all APS groups.)

1830PSS R3.6.50 - TL1 Commands and Messages 2067


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FFP-EQPT
The protection group will wait until working has been continuously
clear for this number of minutes before switching back to working.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following command retrieves provisioning information for a Y-cable protection group.

RTRV-FFP-EQPT:ALU-1830PSS:11STMM10-5-2-C4:123456;

ALU-1830PSS 07-05-30 19:26:57


M 123456 COMPLD
"11STMM10-5-2-C4,11STMM10-5-3-C4::PROTECTMODE=\"1+1 Optical
Splitter\",PSDIRN=BI, RVRTV=N, WTR=5"
;

The following command retrieves provisioning information for all protection groups. The example
response below is for an NE with three protection groups.

RTRV-FFP-EQPT:ALU-1830PSS:ALL:123456;

2068 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-FFP-EQPT Issue 1, December 2011

ALU-1830PSS 07-08-30 19:26:57


M 123456 COMPLD
"11STMM10-5-2-C4,11STMM10-5-3-C4::PROTECTMODE=\"1+1 Optical
Splitter\", PSDIRN=BI, RVRTV=N, WTR=5"
"11STMM10-5-2-C5,11STMM10-5-3-C5::PROTECTMODE=\"1+1 Optical
Splitter\", PSDIRN=BI, RVRTV=Y, WTR=12"
"OPS-5-14-A,OPS-5-14-B::PROTECTMODE=\"1+1 OPS\", PSDIRN=UNI,
RVRTV=N, WTR=5"
"4DPA4-5-22-L1,4DPA4-5-22-L2,4DPA4-5-22-C3::PROTECTMODE=\"1+1
E-SNCP\", PSDIRN=UNI, RVRTV=N, WTR=5"
;

The following command retrieves provisioning information for all protection groups. The example
response below is for an NE with no protection groups.

RTRV-FFP-EQPT:ALU-1830PSS:ALL:123456;

ALU-1830PSS 07-08-30 19:26:57


M 123456 COMPLD
/* None Found */
;

RELATED COMMANDS
DLT-FFP-EQPT
ED-FFP-EQPT
ENT-FFP-EQPT

RELATED AUTONOMOUS RESPONSES


Not applicable.

1830PSS R3.6.50 - TL1 Commands and Messages 2069


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-FFP-EQPT

2070 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-GCC


Command Name: RETRIEVE GCC NETWORK INTERFACE

PURPOSE
The RTRV-GCC command retrieves the network interface which uses a specified GCC channel.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-GCC:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)

Default: <ALL>
Addressing: None
Description: Access IDentifier, specifies the port of the OT.

1830PSS R3.6.50 - TL1 Commands and Messages 2071


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-GCC

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>::GCCCHNL=<value>,STATUS=<value>, OSPF_HELLOINT=<value>,
OSPF_DEADINT=<value>, OSPF_METRIC=<value>, PKTTYPE=<value>,
MTU=<value>" cr lf ]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)

Description: Access IDentifier, specifies the port of the OT.

2072 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-GCC Issue 1, December 2011

GCCCHNL= Value Description


GCC0
GCC1
GCC2

Description: GCC channel type. The default value is GCC0. This parameter
specifies the GCC type used on the optical port with OTU facility.
Line Ports of 11QPA4,11QTA4, 11DPE12, 11DPE12E, 11DPM12
are required to support all three types of GCC channel.
Other OTs have only supported GCC0.

STATUS= Value Description


ENABLE
DISABLE

Description: Status of the GCC Channel, it specifies whether the retrieved GCC
channel is enabled or disabled.

OSPF_HELLOINT= Value Description


{1 - 65535}

Description: HELLO INTERVAL of the OSFP interface, in units of seconds.


This is the time elapsed before the next HELLO PDU is sent.

OSPF_DEADINT= Value Description


{1 - 65535}

Description: DEAD INTERVAL of the OSFP interface, in units of seconds. The


DEAD INTERVAL is a timer used to timeout inactive adjacencies.
The DEAD INTERVAL value is always greater than the HELLO
INTERVAL value.

OSPF_METRIC= Value Description


{1 - 65535}

Description: METRIC, or cost of the OSFP interface, in units of seconds.

PKTTYPE= Value Description


{nonstd, std}

Description: PACKET TYPE. The PACKET TYPE indicates if the packet is a


standard packet (std) or non-standard packet (nonstd).

1830PSS R3.6.50 - TL1 Commands and Messages 2073


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-GCC

MTU= Value Description


{576 - 1500}

Description: Maximum Transmission Unit

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, RTRV-GCC is used to retrieve the network interface of the specified OT port:

RTRV-GCC::11STAR1-1-12-C1:C0001:::;

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"11STAR1-1-12-C1::GCCCHNL=GCC0,STATUS=enable, OSPF_HELLOINT=10,
OSPF_DEADINT=40, OSPF_METRIC=30, PKTTYPE=std, MTU=1500, MODE=MANUAL"
/* RTRV-GCC::11STAR1-1-12-C1:C0001:::; [C0001] (5) */
;

RELATED COMMANDS
ED-GCC

RELATED AUTONOMOUS RESPONSES


None.

2074 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-HDR


Command Name: RETRIEVE HEADER

PURPOSE
The RTRV-HDR command is used to retrieve the system's output response (site) header. Normally,
the output response header consists of the site identifier (SID) and the current date and time.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-HDR:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID of receiving NE>


Addressing: None
Description: Target IDentifier of the target network element for this command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2075


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-HDR

SID Value Description


<1-20 VALID TID CHARACTERS>

Description: Site IDentifier, identifies the network node SID.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
PLNA Login Not Active
• the user is not logged in

IITA Input, Invalid TArget identifier


• an invalid TID has been entered

EXAMPLES
In the following example, a RTRV-HDR command is issued towards an NE named LASVEGAS.
Alternatively, the TID can be left out and the system will return the TID of the locally connected NE:
RTRV-HDR:LASVEGAS;
A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^P00001^COMPLD
;

RELATED COMMANDS
None.

RELATED AUTONOMOUS RESPONSES


None.

2076 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-INV-CARD


Command Name: RETRIEVE REMOTE INVENTORY (CARD)

PURPOSE
RTRV-INV-CARD retrieves standard ALU remote inventory data from each individual card EEPROM
for all cards which are physically present and readable, regardless of provisioning state (except for
unknown/unbootable cards). For SFD, SFC, ITL and DCM modules, factory-set transmission
characteristics are also retrieved from module SEEPROM. This command also retrieves card width
and height from the system controller database.
The denials for this command are described in section ERROR CODES.

INPUT FORMAT

RTRV-INV-CARD:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL (ALL AID)
SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
SLOT-<shelf>-1 (Generic Slot AID in Passive Shelf)

Default: ALL
Addressing: None
Description: Equipment Access Identifier, specifies all applicable modules in
the system.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2077


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-INV-CARD
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[COMPANY=<value>][,MNEMONIC=<value>][,CLEI=<value>][,PART
NUM=<value>][,SWPARTNUM=<value>][,FACTORY=<value>][,SERIAL=<value>][
,DATE=<value>][,EXTRADATA=<value>][,WIDTH=<value>][,HEIGHT=<value>][
,MUXINSLOSS=<value>][,DEMUXINSLOSS=<value>][,DCMFIBERTYPE=<value>][,
DCMDIST=<value>][,DCMLOSS=<value>][,DCMSLOPE=<value>][,DCMLOSSA=<val
ue>][,DCMSLOPEA=<value>][,DCMDISPFIT=<value>][,DCMFIBERLEN=<value>][
,DCMPMD=<value>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


SLOT-<shelf>-<slot> (Generic Slot AID in Universal Shelf)
SLOT-<shelf>-1 (Generic Slot AID in Passive Shelf)

Description: Equipment Access Identifier

COMPANY= Value Description


<value> <4 bytes>

Description: The board manufacturer (vendor).

MNEMONIC= Value Description


<value> {<8 Bytes>}

Description: The Alcatel-Lucent mnemonic for the equipment. In some cases


this is identical to the AID prefix. In other cases it has additional
granularity: PFDCxx, CWRxx, WRxx, SFDxx, SFCxx, OPSx, ITLx.
For a DCM module the mnemonics are: DMSMFxx, DMTWRxx,
DMLEFxx.

CLEI= Value Description


<value> {<10 Bytes >}

Description: The CLEI code for the equipment.

2078 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-INV-CARD Issue 1, December 2011

PARTNUM= Value Description


<value> <14 Bytes > (PARTNUM+ICS)

Description: The Alcatel-Lucent part number for the equipment.

SWPARTNUM= Value Description


<value> {14 Bytes >} (SOFTWARE PARTNUM+ICS)

Description: The Alcatel-Lucent part number for the software running on the
equipment.

FACTORY= Value Description


<value> {<4 Bytes >} (FACTORY IDENTIFIER)

Description: The factory manufacturer.

SERIAL= Value Description


<value> <18 Bytes > (SERIAL NUMBER)

Description: Serial number.

DATE= Value Description


<value> {{00-99}-{01-12}-{01-31}}

Description: The date the EEPROM was written. (IDENTIFIER + DATE)

EXTRADATA= Value Description


<String of characters, with blanks
replacing non-printable characters>
{<46 Bytes >}

Description: ASCII dump of the customer inventory field of the RI EEPROM.

WIDTH= Value Description


SINGLE One slot wide
DOUBLE Two slots wide
TRIPLE Three slots wide

Description: Width of the circuit pack. Does not apply to modules in passive
shelves (shelves 25-64).

1830PSS R3.6.50 - TL1 Commands and Messages 2079


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-INV-CARD

HEIGHT= Value Description


HALF Half height slot
FULL Full height slot

Description: Height of the circuit pack. Does not apply to modules in passive
shelves (shelves 25-64).

MUXINSLOSS= Value Description


<value> {<4 Bytes >} (MUX INSERTION LOSS)

Description: Average multiplex insertion loss. Applies to SFD44 and SFD44B


only.

DEMUXINSLOSS= Value Description


<value> {<4 Bytes >} (DEMUX INSERTION LOSS)

Description: Average demultiplex insertion loss. Applies to SFD44 and


SFD44B only.

DCMFIBERTYPE= Value Description


string of 4 characters

Description: The DCM compensates for this fiber type.

DCMDIST= Value Description


string of 5 characters

Description: The DCM "size" -- the length of fiber the DCM compensates for
(distance in km).

DCMLOSS= Value Description


string of 4 characters

Description: The DCM average insertion loss with no external attenuation.

DCMSLOPE= Value Description


string of 4 characters

Description: The DCM insertion loss slope over the C band with no external
attenuation.

2080 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-INV-CARD Issue 1, December 2011

DCMLOSSA= Value Description


string of 4 characters

Description: The DCM average insetion loss with external attenuation.

DCMSLOPEA= Value Description


string of 4 characters

Description: The DCM insetion loss slope over the C band with external
attenuation.

DCMDISPFIT= Value Description


string of 40 characters

Description: The DCM coefficients of a 3rd order polynomial fit of chromatic


dispersion vs. wavelength..

DCMFIBERLEN= Value Description


string of 2 characters

Description: The total length of dispersion fiber inside the DCM module (in km).

DCMPMD= Value Description


string of 4 characters

Description: The DCM polarization mode dispersion.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2081


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-INV-CARD
EXAMPLES
In this example, all card remote inventory data is retrieved.
RTRV-INV-CARD;

RELATED COMMANDS
RTRV-EQPT
RTRV-INV-PLUG

2082 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-INV-PLUG


Command Name: RETRIEVE REMOTE INVENTORY
(XFP/SFP PLUG-IN MODULES)

PURPOSE
RTRV-INV-PLUG retrieves the standard ALU remote inventory data -- plus additional information --
from all port SFP/XFP/CFP plug-in modules physically present on provisioned circuit packs, regardless
of provisioning state of the ports.
The denials for this command are described in section ERROR CODES.

INPUT FORMAT

RTRV-INV-PLUG:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2083


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-INV-PLUG

AID Value Description


ALL (ALL AID)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
ALPFGT-<shelf>-<slot>-OSC (ALPFGT OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)
112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Default: ALL
Addressing: None

2084 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-INV-PLUG Issue 1, December 2011

Description: Equipment Access Identifier, specifies applicable SFP/XFP


modules in the system.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[COMPANY=<value>][,MNEMONIC=<value>][,CLEI=<value>][,PART
NUM=<value>][,SWPARTNUM=<value>][,FACTORY=<value>][,SERIAL=<value>][
,DATE=<value>][,EXTRADATA=<value>][,CHAN_ID=<value>][,INTERCHG_MARK=
<value>][,ACRONYM_CODE=<value>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2085


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-INV-PLUG

AID Value Description


ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
ALPFGT-<shelf>-<slot>-OSC (ALPFGT OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
43SCA1-<shelf>-<slot> (43SCA1 Circuit Pack)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, VA{1-2}, (4DPA4 Ports)
C{1-4}}
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, (11QPA4 Ports)
VA{1-4}, C{1-4}}
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Line/Client Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Ports)
VA{1-2}, C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2}, (11DPE12E Ports)
VA{1-2}, C{1-12}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Ports)
VA{1-2}, C{1-12}}
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Description: Equipment Access Identifier

2086 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-INV-PLUG Issue 1, December 2011

COMPANY= Value Description


<value> <4 bytes>

Description: The SFP/XFP/CFP manufacturer (vendor).

MNEMONIC= Value Description


<value> {<8 Bytes>}

Description: The Alcatel-Lucent mnemonic (module type) for the


SFP/XFP/CFP.

CLEI= Value Description


<value> {<10 Bytes >}

Description: The CLEI code for the SFP/XFP/CFP.

PARTNUM= Value Description


<value> <14 Bytes > (PARTNUM+ICS)

Description: The Alcatel-Lucent part number for the SFP/XFP/CFP.

SWPARTNUM= Value Description


<value> {14 Bytes >} (SOFTWARE PARTNUM+ICS)

Description: The Alcatel-Lucent part number for the software running on the
SFP/XFP/CFP.

FACTORY= Value Description


<value> {<4 Bytes >} (FACTORY IDENTIFIER)

Description: The factory manufacturer.

SERIAL= Value Description


<value> <18 Bytes > (SERIAL NUMBER)

Description: Serial number of the SFP/XFP/CFP.

DATE= Value Description


<value> {{00-99}-{01-12}-{01-31}}

Description: The date the EEPROM was written. (IDENTIFIER + DATE)

1830PSS R3.6.50 - TL1 Commands and Messages 2087


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-INV-PLUG

EXTRADATA= Value Description


<String of characters, with blanks
replacing non-printable characters>
{<46 Bytes >}

Description: ASCII dump of the customer inventory field of the SFP/XFP/CFP


RI EEPROM.

CHAN_ID= Value Description


<value> <8 characters >

Description: Channel ID of the SFP/XFP/CFP. Null if tunable. DWDM Channel


IDs are frequency-based. CWDM Channel IDs are
wavelength-based.

INTERCHG_MARK Value Description


=
<value> <6 characters >

Description: Interchangeability Marking. Applies to CFPs only.

ACRONYM_CODE Value Description


=
<value> <12 characters >

Description: Acronym Code. Applies to CFPs only.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

2088 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-INV-PLUG Issue 1, December 2011

EXAMPLES
In this example, all port XFP/SFP remote inventory data is retrieved.
RTRV-INV-PLUG;

RELATED COMMANDS
RTRV-EQPT
RTRV-INV-CARD

1830PSS R3.6.50 - TL1 Commands and Messages 2089


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-INV-PLUG

2090 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-IP-IF


Command Name: RETRIEVE INTERNET PROTOCOL
INTERFACE

PURPOSE

The ED-IP-IF command sets the TCP/IP stack parameters for a single
interface (Tunnel, serial interface, LAN etc...), for the system
(Host ID), or for the control plane node (CP node address, CP notify
address).
The configured IP address on System AID is the NE's loopback IP
address, which is shared as interface address by all unnumbered
network interfaces.
The configured IP address on System AID will be also used as OSPF
Router ID.
The configured IP address on control plane node AID is used as GMRE
control plane node address. This address has to be provisioned,
before the GMRE control plane is started on the NE. This address is
used by the control plane for communicating with direct neighbors.
The configured IP address on control plane notify AID is used as
GMRE control plane notify address. This address has to be
provisioned, before the GMRE control plane is started on the NE.
This address is used by the control plane for communicating RSVP-TE
notify messages to LSP head nodes.
The parameters configurable for single network interfaces are:
- IP addresses, netmasks, hostnames, and default gateway addresses
for LAN interfaces
- DHCP server parameters for LAN interfaces
- Proxy ARP configuration for LAN interfaces
This command is supported for the following single network
interfaces:
- LAN-OAMP: the OAMP faceplate LAN connector on the active main
shelf FLC and USRPNL card
- This is intended for connecting the NE to the DCN for central
management
- LAN-CIT: the CIT faceplate LAN connector on one of the main shelf
FLC and EC cards
- This is intended for locally connecting a craft interface terminal
(ZIC).
- The ZIC can always reach the active FLC, even when plugged into
the inactive FLC's frontplate
- LAN-VOIP: the VOIP faceplate LAN connector on the active main
shelf MTX/USRPNL card
- This can be used for connectiong VOIP telephone.
- LAN-E1: the E1 faceplate LAN connector on the active main shelf
MTX/USRPNL card for exteranal equipment (eg; RAMAN Amplifier)
- This can be used as a general purpose LAN in this release
- LAN-E2: the E2 faceplate LAN connector on the active main shelf
MTX/USRPNL card for exteranal equipment (eg; RAMAN Amplifier)
- This can be used as a general purpose LAN in this release

1830PSS R3.6.50 - TL1 Commands and Messages 2091


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IP-IF
• ES1 (this is for the extension shelf, port 1)

• ES2 (this is for the extension shelf, port 2)

INPUT FORMAT

RTRV-IP-IF:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

2092 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IP-IF Issue 1, December 2011

AID Value Description


SYSTEM (System AID)
USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
EC-1-<slot>-{CIT, ES1, ES2} (Shelf Controller Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (Shelf Controller Ports, non-main
shelves)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
FLC-1-{23, 40}-{CIT, OAMP} (ports on
PSS-36 main shelf First Level
Controller)

MT0C-1-{11,15}-{VOIP,E1,E2} (ports
on PSS-36 main shelf Second Level
Controller)

MT0C-{1-24}-{11,15}-{ES1,ES2} (ports
on PSS-36 extension shelves Second
Level Controller)

CPN (Local Control Plane Node)


CPNOTIFY (Local Control Plane Notify
Interface)
LAN-{OAMP, CIT, VOIP, E1, E2}
(Customer LAN)

ALL (ALL AID)

Default: <ALL>
Addressing: None
Description: Access Identifier, specifies an access identifier to the USer Panel
Ethernet interfaces, or to the ports on the EC faceplate. ALL can
be used to retrieve properties for all interfaces.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2093


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IP-IF
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:STATUS=<value>,IP=<value>,MASK=<value>,NAME=<value>,PROXY
ARP=<value>,DHCPSERVER=<value>,IPRANGE=<value>,MACADDR=<value>,DHCPD
FLTGATEWAY=<value>,SNMPSRC=<value>,AUTOSTATE=<value>,AUTOSTATEINTERV
AL=<value>,AUTOSTATECNT=<value>,AUTOSTATEIP=<value>" cr lf
]*[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]

OUTPUT PARAMETERS

AID Value Description


SYSTEM (System AID)
USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
EC-1-<slot>-{CIT, ES1, ES2} (Shelf Controller Ports, main shelf)
EC-<shelf>-<slot>-{ES1, ES2} (Shelf Controller Ports, non-main
shelves)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
FLC-1-{23,40}-{CIT, OAMP} (ports on
PSS-36 main shelf First Level
Controller)

MT0C-1-{11,15}-{VOIP,E1,E2} (ports
on PSS-36 main shelf Second Level
Controller)
MT0C-{1-24}-{11,15}-{ES1,ES2} (ports
on PSS-36 extension shelves Second
Level Controller)

CPN (Local Control Plane Node)


CPNOTIFY (Local Control Plane Notify
Interface)

2094 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IP-IF Issue 1, December 2011

Description: Access Identifier, specifies an access


identifier to the USer Panel Ethernet interfaces, or
to the ports on the EC/FLC/MT0 faceplate. Addresses a
network interface for which to edit the IP related
parameters.
When addressing the SYSTEM AID, the loopback address
of the system can be set. The loopback address is used
as interface address by all unnumbered interfaces, and
is also used as OSPF router ID.

When addressing the CPN AID, the control plane node address of
the system can be set. This address is used to communicate
RSVP-TE and OSPF-TE messages to direct controlo plane
neighbors.
When addressing the CPNOTIFY AID, the control plane notify
address of the system can be set. This address is used by the
control plane node to communicate RSVP-TE notify messages to
LSP head nodes.

STATUS= Value Description


ENABLE
DISABLE

Description: The Status of the port. This value is valid for all AIDs.

IP= Value Description


0-0-0-0
{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Description: Internet Protocol address, it is the IP address of the target AID.


This value is not displayed for the ES1 and ES2 ports, since IP
addresses are not assigned to these two ports of the extension
shelves.

MASK= Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Description: Mask, it is the subnet mask of the provisioned target AID. This
value is not valid for the ES1 and ES2 ports.

NAME= Value Description


<1-15 ASCII CHARACTERS>

Description: Name, it is the descriptive network name of the specified Ethernet


Interface. This value is not applicable for ES1 and ES2 ports.

1830PSS R3.6.50 - TL1 Commands and Messages 2095


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IP-IF

PROXYARP= Value Description


ENABLE
DISABLE

Description: The status of PROXY ARP. This parameter is valid and shall be
displayed only for the CIT, OAMP, E1, E2 and VOIP ports. For any
other port, this value is not displayed.

DHCPSERVER= Value Description


ENABLE
DISABLE

Description: The status of DHCP Service specified by the AID. Clients


connected to this port shall be able to send bootp or DHCP request
and obtain an IP address.

IPRANGE= Value Description


{1-10}

Description: This is the range of the IP pool. The port can dole out from 1 to up
to 10 IP addresses.

MACADDR= Value Description


<12 HEXADECIMAL CHARACTERS>

Description: Medium Access Control Address, it is the MAC address assigned


to this port. When the AID is SYSTEM, the MAC is the same MAC
as the OAMP port. Note that this parameter can only be retrieved
and cannot be modified. MAC addresses are applicable to the
OAMP, VOIP, E1, E2 and CIT ports.

DHCPDFLTGATE Value Description


WAY=
ENABLE
DISABLE

Description: Distributes this interface's IP address as the Default Gateway via


DHCP. If not enabled no Default Gateway IP address will be
distributed via DHCP on this interface.

2096 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IP-IF Issue 1, December 2011

SNMPSRC= Value Description


ENABLE
DISABLE

Description: This parameter is applicable to “SYSTEM”


AID only.

Disable: The source IP address in SNMP trap/reply


messages any of the NE’s interface IP addresses or
Loopback IP address.
Eenable: The source IP address in SNMP trap/reply
messages shall be fixed as the Loopback IP.

AUTOSTATE= Value Description


ENABLE
DISABLE

Default: <Previously existing value> <system default DISABLE>


Addressing: None
Description: This parameter is applicable to
“CIT” AID only. This parameter controls the CIT port
‘s state (enable/disable) autonomously.
AUTOSTATE set to enable: it shall set CIT port state
either enable or disable autonomously on different
conditions as described below:

1. The CIT port shall be disable if the NE detects the source IP is reachable.
2. The CIT port shall be enable autonomously when the communication can not be reached to the
management system (source IP) within defined period which can be provisioned.
3. When an user manually configures the CIT port Admin State, the AUTOSTATE shall be set to
"disable" by Software.
4. When a user manually disables the AUTOSTATE the Admin STATE shall be “ENABLE”
(default value) by the SW.
5. AUTO state cannot be enabled until the Source IP is configured

AUTOSTATEINTE Value Description


RVAL=
{10-7200}

Default: <Previously existing value> <30 seconds>


Addressing: None
Description: This timer value is to check that AUTOSTATEIP is reachable when
AUTOTATE is provisioned as “enable”.

1830PSS R3.6.50 - TL1 Commands and Messages 2097


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IP-IF

AUTOSTATECNT= Value Description


{5-10000}

Default: <Previously existing value> <10>


Addressing: None
Description: This counter value is to check the number of consecutive counts
that AUTOSTATEIP is not reachable which results in CIT admin
port being enabled if AUTOSTATE is enabled. CIT admin port will
be down as a result of AUTOSTATEIP successfully reachablity on
any given AUTOSTATEINTERVAL attempt if AUTOSTATE is
enabled.

AUTOSTATEIP= Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Default: <Previously existing value>


Addressing: None
Description: This is the Source IP address and is to be monitored from NE with
the interval configured by autoStateInterval parameter. If NE can
not be reached the source IP for the count configured by
AutoStateCnt parameter then there is loss communication with
management system and subsequent action is taken (enabling the
the CIT port adminState). This address may be OMS IP address.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid Access Identifier
• the specified AID is incorrect

2098 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IP-IF Issue 1, December 2011

EXAMPLES
In the following example, RTRV-IP-IF retrieves the CIT port information.

RTRV-IP-IF::EC-1-1-CIT:C0001;

A successful response for that command would be:

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
^^^”EC-1-1-CIT:STATUS=enable,IP=192-168-1-1,MASK=255-255-255-252,NAM
E=CIT,PROXY-ARP=enable,DHCPSERVER=enable,IPRANGE=1,MACADDR=001122334
455”
/* RTRV-IP-IF::EC-1-1-CIT:C0001 [C0001] (5) */
;

In the following example, RTRV-IP-IF retrieves the OAMP port information.

RTRV-IP-IF::USRPNL-1-40-OAMP:C0001;

A successful response for that command would be:

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
^^^”USRPNL-1-40-OAMP:STATUS=enable,IP=135-17-225-12,MASK=255-255-255
-0,NAME=ManagementPort,PROXYARP=enable,MACADDR=001122334466”
/* RTRV-IP-IF::USRPNL-1-40-OAMP:C0001 [C0001] (5) */
;

RELATED COMMANDS
ED-IP-IF

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 2099


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IP-IF

2100 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-IPACL-FILTER


Command Name: RETRIEVE IP ACCESS CONTROL LIST
FILTER LIST.

PURPOSE
The RTRV-IPACL-FILTER command can be used to retrieve an IP ACL filter definition, or a list of
filters that have been defined on the system.
An IP ACL Filter is an ordered list of patterns. A filter consists of a sorted list (index, pattern) pairs,
where the index indicates the relative position in the list and the pattern indicates the pattern identifier.
When a packet is tested against a filter, it is tested against each pattern starting with the lowest index
and continuing through each remaining pattern in ascending order until a match occurs.
Up to 100 filters may be defined on the system, and each filter may contain up to 256 (index, pattern)
pairs. Internal memory allocation bounds limit the number of simultaneously defined (index, pattern)
pairs across all filters to 4000.
If a packet that normally would have been forwarded to another interface is blocked, and an
ICMP-error “true” behavior was specified for the matching pattern, an ICMP 3/13 error will be
generated for transmission to the host originating the blocked packet.
If all patterns in a filter list are tested without yielding a match, then the packet is blocked or passed
according to the ACL global default setting. There are two global default settings, one for received
packets and the other for transmitted packets. These attributes can be provisioned via the SET-IPACL
command.
IP ACL filters are constructed one filter at a time. When a pattern is added to a filter, an index is
specified that indicates the position of the pattern in this filter’s list (please note that the index is not a
property of the pattern itself, as the pattern may have other indices associated with it in other filters). If
a pattern is added to a filter with an index that is already occupied in that filter, the prior pattern defined
at that index is replaced by the new pattern. In order to re-number entries in the filter list, the pattern
must be deleted from the list and re-added via the ED-IPACL-FILTER command.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-IPACL-FILTER:[TID]::[CTAG]::[FILTERID];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID of receiving NE>


Addressing: None
Description: Target IDentifier of the target network element for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 2101


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-FILTER

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

FILTERID Value Description


ALL
{100-199}
<1-30 VALID FILTERID
CHARACTERS>

Default: ALL
Addressing: None
Description: Identifier for the ACL filter being defined. Could be either an integer
in the range 100-199 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter , which uniquely identifies the filter being defined.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^":<FILTERID>,<INDEX>,<PATTERNID>,<ACTION>,[<ICMPERROR>],[<SRCADD
R>],[<SRCPREFIX>],[<DESTADDR>],[<DESTPREFIX>],[<DESTPORT>],[<IPPROTO
COL>],[<IPFRAGMENT>],[<ICMPTYPE>],[<ICMPCODE>],[<TCPESTABLISHED>],<S
TATCOUNT>" cr lf]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

FILTERID Value Description


{100-199}
<1-30 VALID FILTERID
CHARACTERS>

Description: Identifier for the ACL filter being defined. Could be either an integer
in the range 100-199 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter , which uniquely identifies the filter being defined.

2102 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL-FILTER Issue 1, December 2011

INDEX Value Description


{1-256}

Description: Integer, 1 - 256, representing the position of the specified pattern


in the filter list. The pattern with the lowest index will be applied
first in packet filtering, followed by the remaining patterns in
ascending index order.

PATTERNID Value Description


{1-256}
<1-30 VALID PATTERNID
CHARACTERS>

Description: Identifier for the ACL pattern. This is an Integer, 1 - 256, or a


string of up to 30 case-sensitive alphanumeric characters, where
the first character is always a letter, which uniquely identifies the
pattern on the system.

ACTION Value Description


PASS
BLOCK

Description: Action to take on packets matching the ACL pattern.

ICMPERROR Value Description


TRUE
FALSE

Description: ICMP Error Reporting behavior for blocked packets. This field will
only be populated when the action is BLOCK. If no icmpError
value is specified, the behavior will be determined by the system
default setting.

SRCADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Description: Source IP Address. String xxx-xxx-xxx-xxx format.

SRCPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

1830PSS R3.6.50 - TL1 Commands and Messages 2103


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-FILTER
Description: Source IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the
reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
SRCADDR is specified and the SRCPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
SRCADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
SRCADDR is also specified. The binary form of the mask must
consist in uniterrupted series of 0 bits. followed by uninterrupted
series of 1 bits.

DESTADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Description: Destination IP Address. String xxx-xxx-xxx-xxx format.

DESTPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Description: Destination IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the


reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
DESTADDR is specified and the DESTPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
DESTADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
DESTADDR is also specified. The binary form of the mask must
consist in uniterrupted series of 0 bits. followed by uninterrupted
series of 1 bits.

DESTPORT Value Description


{0-65535}

Description: TCP/UDP Destination Port. Integer, 0 - 65535. Applicable only


when IP Protocol is TCP or UDP.

2104 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL-FILTER Issue 1, December 2011

IPPROTOCOL Value Description


{0-255}
ICMP
IPIP
TCP
UDP
RSVP
GRE
OSPF

Description: IP Protocol. Can be specified via ENT/ED-IPACL-FILTER by


explicit protocol number (Integer, 0-255) or by keyword (for
common protocol types, listed above). Note that the command
should return the value previoulsy set via ED-IPACL-FILTER. For
example, if the value set was 1, the command should return
IPPROTOCOL=1. If the value set was ICMP, the command should
return IPPROTOCOL=ICMP.

IPFRAGMENT Value Description


TRUE
FALSE

Description: IP Fragmentation.

ICMPTYPE Value Description


{0-255}

Description: ICMP Type identifier. Integer, 0 - 255. Applicable only when


IPPROTOCOL is ICMP (or 1).

ICMPCODE Value Description


{0-255}

Description: ICMP Code field. Integer, 0 - 255. Applicable only when


IPPROTOCOL is ICMP (or 1). Used along with certain ICMP types
to further specify the message type. If specified, the pattern will
only match packets with this exact ICMP code.

TCPESTABLISHED Value Description


TRUE
FALSE

1830PSS R3.6.50 - TL1 Commands and Messages 2105


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-FILTER
Description: TCP Established flag. Matches a packet depending on whether
the TCP flags in the IP header correspond to the “established”
state. Applicable only when IP Protocol is TCP.

STATCOUNT Value Description


{0-4294967295}

Description: Packet match counter. Integer, 0 - 4294967295, that increments


whenever a packet matches the specified ACL pattern. This
counter will increment regardless of the provisioned action on that
pattern.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
This example shows a filter named TestExtACL containing two patterns. Pattern #1 simply counts
incoming CLI packets on port 23. Note there were 98 TCP packets received on port 23 at the time of
this request. Pattern #2 blocks any incoming CLI traffic on port 23 that comes from a specific IP
address (10.17.0.46). In this example, there were 4 packets blocked from this IP address at the time
of the request. Note: It is important that the default Rx-Action be provisioned to PASS in order for this
example to work correctly.

RTRV-IPACL-FILTER:NODE-1::C0001;

A successful response for that command would be:

2106 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL-FILTER Issue 1, December 2011

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"TestExtACL,1,1,PASS,,,,,,23,TCP,,,,,98"
^^^"TestExtACL,2,2,BLOCK,FALSE,10-17-0-46,0-0-0-0,,,23,TCP,,,,,4"
/* RTRV-IPACL-FILTER:NODE-1 [C0001] (5) */
;

RELATED COMMANDS
DLT-IPACL-FILTER
ED-IPACL-FILTER
ENT-IPACL-FILTER

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 2107


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-FILTER

2108 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-IPACL-IF


Command Name: RETRIEVE IP ACCESS CONTROL LIST
INTERFACE LIST.

PURPOSE
The RTRV-IPACL-IF command can be used to retrieve filter associations for a particular IP network
interface, or a list of all interface/filter associations provisioned on the NE.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-IPACL-IF:[TID]:[AID]:[CTAG]::[DIRN];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID of receiving NE>


Addressing: None
Description: Target IDentifier of the target network element for this command.

1830PSS R3.6.50 - TL1 Commands and Messages 2109


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-IF

AID Value Description


ALL
LAN-{OAMP, CIT, VOIP, E1, E2}
(Customer LAN)
USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
FLC-1-<slot>-OAMP (FLC OAMP port)
MT0C-<shelf>-<slot>-VOIP (MT0C VOIP port)
MT0C-<shelf>-<slot>-{E1, E2} (MT0C External LAN ports)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)

Default: ALL
Addressing: None
Description: Access Identifier of the physical interface to which an ACL filter is
applied.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

2110 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL-IF Issue 1, December 2011

DIRN Value Description


ALL
RX
TX

Default: ALL
Addressing: None.
Description: Direction on which ACL filter association is applied. If omitted, this
command will display both directions. Valid values:
RX apply filter to the receive direction only
TX apply filter to the transmit direction only

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:<DIRN>,[<FILTERID>],<STATUS>" cr lf]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2111


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-IF

AID Value Description


USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
FLC-1-<slot>-OAMP (FLC OAMP port)
MT0C-<shelf>-<slot>-VOIP (MT0C VOIP port)
MT0C-<shelf>-<slot>-{E1, E2} (MT0C External LAN ports)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)

Description: Access Identifier of the physical network interface being displayed.

DIRN Value Description


RX
TX

Description: Direction on which ACL filter association is applied.

FILTERID Value Description


{100-199}
<1-30 VALID FILTERID
CHARACTERS>

Description: Identifier for the associated ACL filter. Could be either an integer in
the range 100-199 or a string of up to 30 case-sensitive

2112 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL-IF Issue 1, December 2011

alphanumeric characters, where the first character is always a


letter , which uniquely identifies the filter being defined. If no filter
has been associated, this field will be left blank.

STATUS Value Description


ENABLED
DISABLED

Description: ACL status for specified interface & direction

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, a RTRV-IPACL command is issued on the default system ACL settings:

RTRV-IPACL-IF:NODE-1:USRPNL-1-1-OAMP:C0001;

A successful response for that command would be:

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"USRPNL-1-1-OAMP:RX,TesExtACL,ENABLED"
^^^"USRPNL-1-1-OAMP:TX,,DISABLED"
/* RTRV-IPACL-IF:NODE-1::::ETH0 [C0001] (5) */
;

RELATED COMMANDS
ED-IPACL-IF

1830PSS R3.6.50 - TL1 Commands and Messages 2113


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-IF
RELATED AUTONOMOUS RESPONSES
None.

2114 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-IPACL-PATTERN


Command Name: RETRIEVE IP ACCESS CONTROL LIST
PATTERN LIST.

PURPOSE
The RTRV-IPACL-PATTERN command can be used to retrieve an IP ACL pattern, or a list of patterns
that have been defined on the system.
An ACL Pattern is a set of packet field descriptors that can be tested against a packet. For a pattern to
match, each of its field descriptors must fit the data in the packet. The fields that may be tested are:
• Source IP address (or range)
• Destionation IP address (or range)
• TCP/UDP destination port
• IP protocol
• IP fragmentation
• ICMP type and code
• Whether or not a TCP packet belongs to an “established” connection
Each field test is optional: a pattern may specify only some (or no) fields to test. Each pattern also has
an associated action to take when the pattern matches: block or pass. Regardless of the specified
action, a match count associated with the pattern is incremented whenever a match occurs. If a
pattern specifies a block action, it may also specify an ICMP error reporting behavior, which affects
generation of ICMP 3/13 errors for forwarded packets that are blocked. Combination of filterID and
patternID shall not exceed 4000.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-IPACL-PATTERN:[TID]::[CTAG]::[PATTERNID];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID of receiving NE>


Addressing: None
Description: Target IDentifier of the target network element for this command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 2115


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-PATTERN
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

PATTERNID Value Description


ALL
{1-256}
<1-30 VALID PATTERNID
CHARACTERS>

Default: ALL
Addressing: None
Description: The identifier of the ACL pattern being retrieved. Could be either
an integer in the range 1-256 or a string of up to 30 case-sensitive
alphanumeric characters, where the first character is always a
letter, which is selected by the user to uniquely identify the pattern
in subsequent provisioning requests. If this field is omitted, ALL
defined patterns will be retrieved.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^":<PATTERNID>,<ACTION>,[<ICMPERROR>],[<SRCADDR>],[<SRCPREFIX>],[
<SRCPORT>],[<DESTADDR>],[<DESTPREFIX>],[<DESTPORT>],[<IPPROTOCOL>],[
<IPFRAGMENT>],[<ICMPTYPE>],[<ICMPCODE>][,<TCPESTABLISHED>]" cr lf]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

PATTERNID Value Description


{1-256}
<1-30 VALID PATTERNID
CHARACTERS>

Description: Identifier for the ACL pattern. This is an Integer, 1 - 256, or a


string of up to 30 case-sensitive alphanumeric characters, where
the first character is always a letter, which uniquely identifies the
pattern on the system.

2116 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL-PATTERN Issue 1, December 2011

ACTION Value Description


PASS
BLOCK

Description: Action to take on packets matching the ACL pattern.

ICMPERROR Value Description


TRUE
FALSE

Description: ICMP Error Reporting behavior for blocked packets. This field will
only be populated when the action is BLOCK. If no icmpError
value is specified, the behavior will be determined by the system
default setting.

SRCADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Description: Source IP Address. String xxx-xxx-xxx-xxx format.

SRCPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Description: Source IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the


reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
SRCADDR is specified and the SRCPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
SRCADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
SRCADDR is also specified. The binary form of the mask must
consist in uniterrupted series of 0 bits. followed by uninterrupted
series of 1 bits.

SRCPORT Value Description


{0-65535}

Description: TCP/UDP Source Port. Integer, 0 - 65535. Applicable only when


IP Protocol is TCP or UDP.

1830PSS R3.6.50 - TL1 Commands and Messages 2117


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-PATTERN

DESTADDR Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Description: Destination IP Address. String xxx-xxx-xxx-xxx format.

DESTPREFIX Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Description: Destination IP Mask Prefix. String, xxx-xxx-xxx-xxx format. It's the


reverse of a subnet mask, where a 0 indicates a position that must
be matched and a 1 indicates a position that does not matter. If
DESTADDR is specified and the DESTPREFIX is unspecified, or
0-0-0-0, the originating IP address of the packet must match the
DESTADDR exactly. Otherwise, the pattern will allow packets
whose originating IP is within the range implied by the source IP
and subnet mask. This parameter is not valid unless the
DESTADDR is also specified. The binary form of the mask must
consist in uniterrupted series of 0 bits. followed by uninterrupted
series of 1 bits.

DESTPORT Value Description


{0-65535}

Description: TCP/UDP Destination Port. Integer, 0 - 65535. Applicable only


when IP Protocol is TCP or UDP.

IPPROTOCOL Value Description


{0-255}
ICMP
IPIP
TCP
UDP
RSVP
GRE
OSPF

Description: IP Protocol. Can be specified via ENT/ED-IPACL-PATTERNID by


explicit protocol number (Integer, 0-255) or by keyword (for
common protocol types, listed above). Note that the command
should return the value previoulsy set via ED-IPACL-PATTERN.
For example, if the value set was 1, the command should return
IPPROTOCOL=1. If the value set was ICMP, the command should
return IPPROTOCOL=ICMP.

2118 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL-PATTERN Issue 1, December 2011

IPFRAGMENT Value Description


TRUE
FALSE

Description: IP Fragmentation.

ICMPTYPE Value Description


{0-255}

Description: ICMP Type identifier. Integer, 0 - 255. Applicable only when


IPPROTOCOL is ICMP.

ICMPCODE Value Description


{0-255}

Description: ICMP Code field. Integer, 0 - 255. Applicable only when


IPPROTOCOL is ICMP. Used along with certain ICMP types to
further specify the message type. If specified, the pattern will only
match packets with this exact ICMP code.

TCPESTABLISHED Value Description


TRUE
FALSE

Description: TCP Established flag. Matches a packet depending on whether


the TCP flags in the IP header correspond to the “established”
state. Applicable only when IP Protocol is TCP.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2119


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL-PATTERN
EXAMPLES
In the following example, a RTRV-IPACL-PATTERN command is issued on the system:

RTRV-IPACL-PATTERN:NODE-1::C0001;

A successful response for that command would be:

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"1,PASS,,0-17-0-47,0-0-0-0,,,,23,TCP,,,,TRUE"
^^^"BLOCKTCP,BLOCK,,0-17-0-46,0-0-0-0,,,23,TCP,FALSE"
/* RTRV-IPACL-PATTERN:NODE-1 [C0001] (5) */
;

RELATED COMMANDS
DLT-IPACL-PATTERN
ED-IPACL-PATTERN
ENT-IPACL-PATTERN

RELATED AUTONOMOUS RESPONSES


None.

2120 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-IPACL


Command Name: RETRIEVE IP ACCESS CONTROL LIST
INFORMATION

PURPOSE
The RTRV-IPACL command can be used to retrieve system level attributes for the IP Access Control
List feature. This includes system default Rx/Tx actions, and SNMP configuration status.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-IPACL:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID of receiving NE>


Addressing: None
Description: Target IDentifier of the target network element for this command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^":<RXDFLTACTION>,<TXDFLTACTION>,<SNMPCFG>" cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 2121


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL
OUTPUT PARAMETERS

RXDFLTACTION Value Description


PASS
BLOCK

Description: Default action to take on received (incoming) packets where ACL


is enabled but no pattern matches or no action is explicitly defined.
Note: All packets are dropped if this parameter is set to "BLOCK"
when filter and its pattern are not defined for the physical network
interfaces.

TXDFLTACTION Value Description


PASS
BLOCK

Description: Default action to take on transmitted (outgoing) packets where


ACL is enabled but no pattern matches or no action is explicitly
defined.
Note: All packets are dropped if this parameter is set to "BLOCK"
when filter and its pattern are not defined for the physical network
interfaces.

SNMPCFG Value Description


ENABLED
DISABLED

Description: Indicates whether or not ACL configuration is supported via SNMP.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

2122 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-IPACL Issue 1, December 2011

EXAMPLES
In the following example, a RTRV-IPACL command is issued on the default system ACL settings:

RTRV-IPACL:NODE-1::C0001;

A successful response for that command would be:

^^^NODE-1^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"PASS,BLOCK,TRUE,DISABLED"
/* RTRV-IPACL:NODE-1 [C0001] (5) */
;

RELATED COMMANDS
SET-IPACL

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 2123


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-IPACL

2124 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ISU-STATUS


Command Name: RETRIEVE IN-SERVICE UPGRADE
STATUS

PURPOSE
The RTRV-ISU-STATUS command retrieves the status of the ongoing software release upgrade
procedure.

INPUT FORMAT

RTRV-ISU-STATUS:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2125


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ISU-STATUS
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"::WRKRELEASE=<value>,ACTRELEASE=<value>,COMTDRELEASE=<value>,WRK
DIRECTORY=<value>,
OPERATION=<value>,STATUS=<value>,RESULTSTRING=<value>,PERCENTCOMPLD=
<value>,AUDITTIME=<value>" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

WRKRELEASE= Value Description

<release number with format


1830PSS32-W.X-Y>

Description: This is the software release version to which the network element
is currently upgrading. The value is blank if the NE if a software
release upgrade is not currently in progress.

ACTRELEASE= Value Description

<release number with format


1830PSS32-W.X-Y>

Description: This is the software release version currently running on the


network element.

COMTDRELEASE= Value Description

<release number with format


1830PSS32-W.X-Y>

2126 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ISU-STATUS Issue 1, December 2011

WRKDIRECTORY= Value Description


<forward slash separated path>

Description: This is the directory path on the RFS used for the software
download.

OPERATION= Value Description


AUDIT
LOAD
ACTIVATE
COMMIT
BACKOUT

Description: This is the last software release upgrade control operation


executed on this NE.

STATUS= Value Description


COMPLETE
IP
FAILED

Description: This is the status of the last software release version upgrade
operation executed on this network element.

RESULTSTRING= Value Description


Please refer to the User Provisioning
Guide for result string values.

Description: This is a string describing the result of the last software release
version upgrade operation executed on this network element. See
the User Provisioning guide for supported string values.

PERCENTCOMPL Value Description


D=
<0-100%>

Description: This is the percentage of the last software release version upgrade
operation executed on this network element that has completed.

1830PSS R3.6.50 - TL1 Commands and Messages 2127


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ISU-STATUS

AUDITTIME= Value Description


<same format as backup date and
time>

Description: This is the timestamp of the last audit command run on the NE, in
the format percentage of the last software release version upgrade
operation executed on this network element that has completed.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example illustrates the command and associated output for retrieving the status of the
generic upgrade procedure.
RTRV-ISU-STATUS;

RHEIMS 05-28-02 14:20:41


M Pad567 COMPLD

"::WRKRELEASE=,ACTRELEASE=1830PSS32-2.0-0,COMTDRELEASE=1830PSS32-2.0
-0,OPERATION=COMMIT,STATUS=COMPLETE,RESULTSTRING="",PERCENTCOMPLD=10
0%,AUDITTIME=03-28-02 11:18:22"
;

RELATED COMMANDS
INIT-SYS-NEW
INIT-SYS-OLD
COMMIT-ISU
STA-ISU

2128 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ISU-STATUS Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 2129


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ISU-STATUS

2130 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-LAN


Command Name: RETRIEVE ETHERNET LAN INTERFACE

PURPOSE
The RTRV-LAN command retrieves parameters provisioned via the ED-LAN TL1 command. The
following interfaces can be retrieved using this command:
• OAMP

• VoIP

• E1
• E2
• CIT

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-LAN:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2131


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LAN

AID Value Description


USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
EC-1-<slot>-CIT (CIT port, main shelf)
FLC-1-{23,40}-{CIT, OAMP} (ports on
PSS-36 main shelf First Level
Controller)

MT0C-1-{11,15}-{VOIP,E1,E2} (ports
on PSS-36 main shelf Second Level
Controller)

LAN-{OAMP, CIT, VOIP, E1, E2}


(Customer LAN)

ALL (ALL AID)

Default: <ALL>
Addressing: None
Description: Access Identifier, specifies an access identifier to the User Panel
Ethernet interfaces or to the CIT port. ALL can be used to retrieve
properties for all interfaces.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:LINKSPEED=<value>,ACTUALLINKSPEED=<value>,DUPLEX=<value>,
ACTUALDUPLEX=<value>,LINKINTEGRITY=<value>" cr lf ]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

2132 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-LAN Issue 1, December 2011

OUTPUT PARAMETERS

AID Value Description


USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
EC-1-<slot>-CIT (CIT port, main shelf)
FLC-1-{23,40}-{CIT, OAMP} (ports on
PSS-36 main shelf First Level
Controller)
MT0C-1-{11,15}-{VOIP,E1,E2} (ports
on PSS-36 main shelf Second Level
Controller)

Description: Access Identifier, specifies an access identifier to the User


Panel/FLC/MTX/EC Ethernet interfaces(VOIP, OAMP, E1, E2) or
to the CIT port.

LINKSPEED= Value Description


10
100
1000
AUTO

Description: The configured Link Speed of the port.

ACTUALLINKSPEE Value Description


D=
10
100
1000

Description: The actual Link Speed of the port.

DUPLEX= Value Description


HALF
FULL
AUTO

Description: The configured Duplex state of the port.

1830PSS R3.6.50 - TL1 Commands and Messages 2133


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LAN

ACTUALDUPLEX= Value Description


HALF
FULL

Description: The actual Duplex state of the port.

LINKINTEGRITY= Value Description


LINKUP
LINKDOWN

Description: The link integrity of the physical link.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid Access Identifier
• the specified AID is incorrect

EXAMPLES
In the following example, RTRV-LAN retrieves the VoIP port information.

RTRV-LAN-IFACE::USRPNL-1-40-VOIP:C0001;

A successful response for that command would be:

2134 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-LAN Issue 1, December 2011

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
^^^”USRPNL-1-40-VOIP:LINKSPEED=AUTO,ACTUALLINKSPEED=10,DUPLEX=AUTO,A
CTUALDUPLEX=FULL,LINKINTEGRITY=LINK_UP”
/* RTRV-LAN-IFACE::USRPNL-1-40-VOIP:C0001 [C0001] (5) */
;

RELATED COMMANDS
ED-LAN

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 2135


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LAN

2136 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-LIB-FW


Command Name: RETRIEVE FIRMWARE PROVISIONING
OPTIONS FROM THE LIBRARY

PURPOSE
The RTRV-LIB-FW command allows a user to display the firmware profile(s) available for a particular
card (or all cards).

INPUT FORMAT

RTRV-LIB-FW:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2137


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LIB-FW

AID Value Description


ALL
EC-<shelf>-<slot> (Firmware Loadable Cards)
FLC-<shelf>-<slot>
MT0C-<shelf>-<slot>
AHPHG-<shelf>-<slot>
AHPLG-<shelf>-<slot>
ALPFGT-<shelf>-<slot>
ALPHG-<shelf>-<slot>
A2325A-<shelf>-<slot>
AM2017B-<shelf>-<slot>
AM2125A-<shelf>-<slot>
AM2125B-<shelf>-<slot>
AM2318A-<shelf>-<slot>
AM2325B-<shelf>-<slot>
RA2P-<shelf>-<slot>
OSCT-<shelf>-<slot>
CWR-<shelf>-<slot>
WR-<shelf>-<slot>
MESH-<shelf>-<slot>
OPS-<shelf>-<slot>
112SA1L-<shelf>-<slot>
112SCA1-<shelf>-<slot>
112SNA1-<shelf>-<slot>
112SX10L-<shelf>-<slot>
112SCX10-<shelf>-<slot>
112SNX10-shelf>-<slot>
43STA1P-<shelf>-<slot>
43SCA1-<shelf>-<slot>
43SCX4-<shelf>-<slot>
43SCX4E-<shelf>-<slot>
43SCX4L-<shelf>-<slot>
43STX4P-<shelf>-<slot>
43STX4-<shelf>-<slot>
11DPE12-<shelf>-<slot>
11DPE12E-<shelf>-<slot>
11DPM12-<shelf>-<slot>
11STAR1-<shelf>-<slot>
11STMM10-<shelf>-<slot>
11STGE12-<shelf>-<slot>
4DPA4-<shelf>-<slot>
4DPA2-<shelf>-<slot>
11QPA4-<shelf>-<slot>
11QTA4-<shelf>-<slot>
11STAR1A-<shelf>-<slot>
MVAC-<shelf>-<slot>
SVAC-<shelf>-<slot>
WTOCM-<shelf>-<slot>

Default: Entry Required


Addressing: None
Description: The AID of the card of interest.

2138 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-LIB-FW Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT


<no successful response format found>

OUTPUT PARAMETERS

Firmware_profiles

<string>

Description: <string> = "Firmware profiles for card type: <AID>"

Preferred_profile Value Description


<string>

Description: <string>= "Preferred profile:


<profile-name>"
This parameter allows the provisioning of a particular
firmware profile for the specified card. The format
is a string consisting of three positive integer
fields separated by the dot character ".". The first
field indicates a major version number, the second a
minor version number, and the third (optional) field
is a reserved integer field.
Major versions indicate a change in register map or
function that is often not backward compatible.
Minor versions indicate a software backward compatible
change.
Consult the user documentation and release notes for
more information on software/firmware compatibility.

Other_profiles
<string>

1830PSS R3.6.50 - TL1 Commands and Messages 2139


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LIB-FW
Description: <string> = "Other profiles:
<profile-name(n)>"
This parameter allows the provisioning of a
particular firmware profile for the specified card.
The format is a string consisting of three positive
integer fields separated by the dot character ".". The
first field indicates a major version number, the
second a minor version number, and the third
(optional) field is a reserved integer field.
Major versions indicate a change in register map or
function that is often not backward compatible.
Minor versions indicate a software backward compatible
change.
Consult the user documentation and release notes for
more information on software/firmware compatibility.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR_CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example illustrates the command for retrieving the available firmware for a card that is
stored in the firmware library of the network element.

RTRV-LIB-FW:NODE-1:11STGE12-2-2:ctag12345:::;
NODE-1 03-07-08 09:04:33
M ctag12345 COMPLD
"Firmware profiles for card type 11STGE12,Preferred
profile: profile_3.0.1,Other profiles: profile_2.0.1 "
/* RTRV-LIB-FW:NODE-1:11STGE12-2-2:ctag12345:::;[ctag12345] (2) */
;

RELATED COMMANDS
RTRV-EQPT-FW
RTRV-LIB-FW

2140 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-LIB-FW Issue 1, December 2011

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 2141


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LIB-FW

2142 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-LPBK-EQPT


Command Name: RETRIEVE LOOPBACK EQPT

PURPOSE
The RTRV-LPBK-EQPT command retrieves the ports that are in a loopback within the specified range
of port AIDs. The command is executed regardless of the provisioning of the specified facilities.
The successful response for a RTRV-LPBK-EQPT contains one line of parsable data, in ascending
order, for each port that is in a loopback within the specified range of AIDs. No output data is returned
for an AID that doesn't have a loopback.

INPUT FORMAT

RTRV-LPBK-EQPT:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2143


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LPBK-EQPT

AID Value Description


112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STAR1A-<shelf>-<slot>-{L1, C1} (11STAR1A Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, C{1-4}} (4DPA4 Line/Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Line/Client Ports)
C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},C{1-1 (11DPE12E Lines/Clients Ports)
2}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Line/Client Ports)
C{1-12}}
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)

Default: Entry required


Addressing: None
Description: OT Client/Line port Access Identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2144 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-LPBK-EQPT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>::,,,LPBKTYPE=<value>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SA1L-<shelf>-<slot>-{L1, C1} (112SA1L Ports)
112SX10L-<shelf>-<slot>-{L1, C{1-10}} (112SX10L Ports)
112SCA1-<shelf>-<slot>-{L1, C1} (112SCA1 Ports)
112SNA1-<shelf>-<slot>-{L1, C1} (112SNA1 Ports)
112SCX10-<shelf>-<slot>-{L1, C{1-10}} (112SCX10 Ports)
112SNX10-<shelf>-<slot>-{L1, C{1-10}} (112SNX10 Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)
43STX4-<shelf>-<slot>-{L1, C{1-4}} (43STX4 Ports)
43STX4P-<shelf>-<slot>-{L1, C{1-4}} (43STX4P Ports)
43SCX4-<shelf>-<slot>-{L1, C{1-4}} (43SCX4 Ports)
43SCX4L-<shelf>-<slot>-{L1, C{1-4}} (43SCX4L Ports)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-{L1, (11STMM10 Ports)
C{1-10}}
11STGE12-<shelf>-<slot>-{L1, C{1-10}} (11STGE12 Ports)
4DPA4-<shelf>-<slot>-{L{1-2}, C{1-4}} (4DPA4 Line/Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-{L{1-2}, (11DPE12 Line/Client Ports)
C{1-12}}
11DPE12E-<shelf>-<slot>-{L{1-2},C{1-1 (11DPE12E Lines/Clients Ports)
2}}
11DPM12-<shelf>-<slot>-{L{1-2}, (11DPM12 Line/Client Ports)
C{1-12}}

Description: OT Client/Line port Access Identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2145


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LPBK-EQPT

LPBKTYPE= Value Description


FACILITY
TERMINAL
TESTSIGNAL

Description: Loopback Type, specifies the type of loopback.


FACILITY Specifies a loopback at the receive side (from the
client equipment or a DWDM line) to the transmit
side (toward the client equipment or DWDM line) of
the specified facility.
TERMINAL Specifies a loopback where the signal that
is about to be transmitted toward the client is
transmitted back toward a DWDM domain.
TESTSIGNAL Specifies a test signal that is sent out the
client transmit port on the 112SCA1 OT or the
112SA1L OT.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, the active loopback for port 11STAR1-1-10-C1 is reported.

RTRV-LPBK-EQPT::11STAR1-1-10-C1;

The output response, shown below, assumes Session Number 2 was used to enter the command and
a system generated CTAG value of abc123.

2146 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-LPBK-EQPT Issue 1, December 2011

NODE1 07-01-05 09:38:11


M abc123 COMPLD
"11STAR1-1-10-C1:,,,LPBKTYPE=FACILITY"
/* RTRV-LPBK-EQPT::11STAR1-1-10-C1 [abc123] (2) */
;

In the following example, the test signal enabled for port 112SCA1-1-10-C1 is reported.

RTRV-LPBK-EQPT::11sSCA1-1-10-C1;

The output response, shown below, assumes Session Number 2 was used to enter the command and
a system generated CTAG value of abc123.

NODE1 07-01-05 09:38:11


M abc123 COMPLD
"112SCA1-1-10-C1:,,,LPBKTYPE=TESTSIGNAL"
/* RTRV-LPBK-EQPT::112SCA1-1-10-C1 [abc123] (2) */
;

RELATED COMMANDS
OPR-LPBK-EQPT
RLS-LPBK-EQPT

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 2147


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-LPBK-EQPT

2148 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-MAP


Command Name: RETRIEVE NETWORK MAP TABLE

PURPOSE
This command allows the operator to get all the entries contained in the TL1 Network mapping table of
the specified NE. The TL1 Network mapping table associates Target Identifiers (TIDs) with IP
addresses. Every NE will have its own mapping table.
Note that this command retrieves all dynamic mappings found via OSPF. There is no Static mapping.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-MAP:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<NETID>:<IPADDR>:<SWRELEASE>" cr lf
^^^"<SID>:<MAPSIZE>:" cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 2149


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-MAP
OUTPUT PARAMETERS

NETID Value Description


<1-20 VALID TID CHARACTERS>

Description: Network Element Target IDentifier, it is the TID of the remote NE


corresponding to that entry in the mapping table.

IPADDR Value Description


{0-126, 128-223} - {0-255} - {0-255} -
{0-255}

Description: Internet Protocol Address, it is the IP address (in the format


nnn-nnn-nnn-nnn) of the remote NE corresponding to that entry in
the mapping table entry. The displayed IP address is the Router ID
of each NE, i.e. its NEID.

SWRELEASE Value Description


<1-20 CHARACTERS>

Description: Software release that is active on the NE.

SID Value Description


<1-20 VALID TID CHARACTERS>

Description: Site IDentifier, identifies the network node SID.

MAPSIZE Value Description


{0-1024}

Description: Current MAP Size. It is the number of entries that this local
Network mapping table currently holds. This number is specified
on the bottom line. The entries in the top of this table show the
associated Target Identifiers (TIDs) with their respective IP
addresses.

2150 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-MAP Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, RTRV-MAP retrieves the entries contained in the Network map table:
RTRV-MAP:::C0001 ;
A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD

^^^"LASVEGAS:128-251-94-47:V1.04.0"
^^^"BOSTON-NE2:128-251-94-44:V1.04.0"
^^^"BOSTON-NE3:128-251-94-66:V1.04.0"
^^^ "LASVEGAS :3"
/* RTRV-MAP:::C0001 [C0001] (5) */
;

RELATED COMMANDS
None.

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 2151


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-MAP

2152 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-NE-IPIPT


Command Name: RETRIEVE NETWORK ELEMENT IP IN IP
TUNNEL

PURPOSE
This command allows the operator to retrieve the parameters of an IP in IP tunnel instance on the NE.
The IP in IP tunnel that has to be retrieved is specified by its ID parameter.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-NE-IPIPT:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


<Product Specific Values>
ALL (ALL AID)
IPIPT-{1-64} (Internet Protocol in Internet Protocol
Tunnel)

Default: ALL
Addressing: &&-ranging and &-grouping
Description: IP in IP Tunnel Identifier, it is the identifier of the specific IP in IP
tunnel to retrieve.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2153


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NE-IPIPT
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>::ALMPROF=<value>,LOCALEPIP=<value>,REMOTEEPIP=<value>,ENC
APTYP=<value>[,BOUNDTO=<value>][,TUNIP=<value>],IFNAME=<value>" cr
lf ]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


<Product Specific Values>
IPIPT-{1-64} (Internet Protocol in Internet Protocol
Tunnel)

Description: IP in IP Tunnel Identifier, it is the identifier of the retrieved IP in IP


tunnel.

ALMPROF= Value Description


<userlabel>

Description: The Alarm Severity Assignement profile (ASAP) name to use with
this IPIPT entity.
<userlabel> 1-40 alphanumeric characters (plus '-')
assigned as the userlabel for the used profile

LOCALEPIP= Value Description


{0-99,102-126,128-223} - {0-255} -
{0-255} - {0-255}

Description: Internet Protocol address. It is the local tunnel endpoint IP


address. This address is used in the encapsulation header.

REMOTEEPIP= Value Description


{0-99,102-126,128-223} - {0-255} -
{0-255} - {0-255}

2154 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-NE-IPIPT Issue 1, December 2011

Description: Internet Protocol address. It is the remote tunnel endpoint IP


address. This address is used in the encapsulation header.

ENCAPTYP= Value Description


GRE
IPINIP

Description: Encapsulation Type. Defines the way of encapsulating IP packets


in IP packets.
GRE Generic Routing Encapsulation. Encapsulation is
according to RFC2784.
IPINIP IP-in-IP encapsulation. Encapsulation is according
to RFC2003.

BOUNDTO= Value Description


LAN-{1, 2} Customer LANs are separated (MCN=1
and SCN=2)
LAN-1 (Customer LAN)

Description: Customer LAN interface to which the tunnel is bound.


This parameter is only present, if the IP in IP tunnel is bound
to a LAN interface.

TUNIP= Value Description


{0-99,102-126,128-223} - {0-255} -
{0-255} - {0-255}

Description: Internet Protocol address. It is the local address of the tunnel


network interface. This address is used in the encapsulated packet
header.
If the tunnel interface is configured as unnumbered
interface, this parameter is not present in the output response.

IFNAME= Value Description


<2-15 alphanumeric charecters>

Description: The internal name of the network interface representing the IP in


IP tunnel.

1830PSS R3.6.50 - TL1 Commands and Messages 2155


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NE-IPIPT
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^^DENY cr lf
^^^<ERROR^CODE> cr lf
[^^^/*^<Expanded^Error^Code^Description>^*/ cr lf]
[^^^/*^<Informational^Error^Description^Text>^*/ cr lf]
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, RTRV-NE-IPIPT retrieves the IP in IP tunnel whose ID is equal to 3:

RTRV-NE-IPIPT:IPIPT-3::C0001;

A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"IPIPT-3::ALMPROF=ALL-IPIPT-ALARMS,LOCALEPIP=10-10-20-12,REMOTEEP
IP=10-10-40-12,ENCAPTYP=GRE,BOUNDTO=LAN-1,IFNAME=ipip5"
/* RTRV-NE-IPIPT:IPIPT-3::C0001 [C0001] (5) */
;

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"IPIPT-3::ALMPROF=ALL-IPIPT-ALARMS,LOCALEPIP=10-10-20-12,REMOTEEP
IP=10-10-40-12,ENCAPTYP=GRE"
/* RTRV-NE-IPIPT:IPIPT-3::C0001 [C0001] (5) */
;

RELATED COMMANDS
DLT-NE-IPIPT
ENT-NE-IPIPT

RELATED AUTONOMOUS RESPONSES


None.

2156 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-NE-IPRT


Command Name: RETRIEVE NETWORK ELEMENT IP
ROUTE

PURPOSE
This command allows the operator to retrieve all the IP routes contained in the IP routing table.
Retrieved IP routes can be static routes entered via the ENT-NE-IPRT command or dynamic routes
discovered by OSPF.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-NE-IPRT:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<DESTADDR>, <MASK>, <NEXTHOP>,, <DISTANCE>, <ADVERTISE>" cr
lf]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 2157


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NE-IPRT
OUTPUT PARAMETERS

DESTADDR Value Description


{1-99,102-126,
128-223}-{0-255}-{0-255}-{0-255}

Description: Destination Address, IP address of the destination host or network


(in the format nnn-nnn-nnn-nnn).

MASK Value Description


{0-255}-{0-255}-{0-255}-{0-255}

Description: IP Mask, IP subnet mask of the route destination (in the format
nnn-nnn-nnn-nnn).

NEXTHOP Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Description: Next hop address, a.k.a. the gateway address, IP address of the
next interface in the route (in the format nnn-nnn-nnn-nnn). The
target NE shall be directly connected to this interface via the
appropriate Ethernet interface.

DISTANCE Value Description


[1..255]

Description: The distance value.

ADVERTISE Value Description


N
Y

Description: Specifies whether the IP route is leaked into the OSPF routing
protocol.
N Route is only known on the local NE
Y Route is leaked into OSPF and advertised to the
network.

2158 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-NE-IPRT Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, RTRV-NE-IPRT retrieves all the IP routes contained in the IP routing table:
RTRV-NE-IPRT:::C0001;
A successful response for that command would be:

^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"128-210-54-0,255-255-255-0,128-210-54-21,4,N"
^^^"128-210-0-0,255-255-0-0,10-10-10-1,110,Y"
/* RTRV-NE-IPRT:::C0001 [C0001] (5) */
;

RELATED COMMANDS
DLT-NE-IPRT
ED-NE-IPRT
ENT-NE-IPRT

1830PSS R3.6.50 - TL1 Commands and Messages 2159


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NE-IPRT
RELATED AUTONOMOUS RESPONSES
None.

2160 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-NE


Command Name: RETRIEVE NETWORK ELEMENT

PURPOSE
RTRV-NE retrieves general system-level equipment parameters.
The denials for this command are described in section ERROR CODES.

INPUT FORMAT

RTRV-NE:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"::SYSAINSTMR=<value>" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2161


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NE

SYSAINSTMR= Value Description


{{00-96}-{00-59}} Hours-Minutes

Description: System default AINS timer. The system level timer for an entity to
remain in automatic in-service mode (AINS). Minimum time is 1
minute. Maximum time is 96 hours. This value is used for all ports
which have their AINSREF set to SYSTEM, i.e. ports that do not
have their own port-level AINS timer provisioned.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In this example, NE data is retrieved.
RTRV-NE;

RELATED COMMANDS
ED-NE
RTRV-NETYPE

2162 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-NETYPE


Command Name: RETRIEVE NETWORK ELEMENT TYPE

PURPOSE
RTRV-NETYPE retrieves general system-level equipment parameters.
The denials for this command are described in section ERROR CODES.

INPUT FORMAT

RTRV-NETYPE:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


< 1-6 VALID CTAG CHARACTERS >

Default: < System assigned CTAG value >


Addressing: None
Description: Correlation Tag, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<VENDOR>,<MODEL>,<NETYPE>,<SWVERSION>::NEMODE=<value>" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2163


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NETYPE

VENDOR Value Description


<0-40 CHARACTER ASCII STRING>

Description: The NE equipment vendor name -- "Alcatel-Lucent".

MODEL Value Description


<0-40 CHARACTER ASCII STRING>

Description: The NE equipment model name -- "1830 PSS".

NETYPE Value Description


<0-40 CHARACTER ASCII STRING>

Description: The NE equipment type -- "ADM" (add-drop multiplexer).

SWVERSION Value Description


<0-40 CHARACTER ASCII STRING>

Description: The NE active software version.

NEMODE= Value Description


SONET
SDH

Description: System SONET/SDH operation mode. This affects system-wide


naming of cards and ports. It affects the content of alarm and
event text. When the mode is changed, PM is restarted with
cleared counters, new PM names, and new TCA defaults. Byte
filtering changes to conform to the specified standard. The NE
clears its database, clears all services, and performs a cold restart.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

2164 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-NETYPE Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In this example, NETYPE data is retrieved.
RTRV-NETYPE;

RELATED COMMANDS
RTRV-NE

1830PSS R3.6.50 - TL1 Commands and Messages 2165


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NETYPE

2166 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-NTP-ADDR


Command Name: RETRIEVE NTP SERVER IP ADDRESS

PURPOSE
The RTRV-NTP-ADDR command retrieves addresses of NTP servers. If the NTP protocol is enabled
(via ED-NTP), the command will also retrieve the selected server reference, and the states of the
servers.

INPUT FORMAT

RTRV-NTP-ADDR:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

OUTPUT PARAMETERS

IP= Value Description


{1-99,102-126,128-223}-{0-255}-{0-255}
-{0-255}

Description: Network address of the NTP server. Index is in the range between
[1-3].

1830PSS R3.6.50 - TL1 Commands and Messages 2167


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NTP-ADDR
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example RTRV-NTP-ADDR retrieves the status of NTP servers with NTP enabled.
RTRV-NTP-ADDR;
The output response is shown below.

LASVEGAS 01-02-27 08:46:59


M C0001 COMPLD
IP1=192-168-0-221
IP2=192-168-0-222
IP3=192-168-0-223
/* RTRV-NTP-ADDR [C0001] (5)*/

RELATED COMMANDS
DLT-NTP-ADDR
ED-DAT
ENT-NTP-ADDR
RTRV-NTP

RELATED AUTONOMOUS RESPONSES


None

2168 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-NTP


Command Name: RETRIEVE NETWORK TIME PROTOCOL

PURPOSE
The RTRV-NTP command retrieves the NTP provisioning parameters and current operating mode.

INPUT FORMAT

RTRV-NTP:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2169


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NTP
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"::NTP={ENABLE,DISABLE},CLKMODE=<value>,DRIFT=<driftValue>" cr lf
^^^"/*^Sel^^^IP^^^^^^^^^^^^^^^RefID^^^^^^^^^str^t^poll^reach^delay^^
^^offset^^^^jitter^*/" cr lf
^^^"/*^<sel>^^^1^<IPAddress>^^<IPAddress>^^<STR>^^<t>^^<POLL>^^<REAC
H>^^<DELAY>^^<OFFSET>^^<JITTER>r^*/" cr lf
^^^"/*^<sel>^^^2^<IPAddress>^^<IPAddress>^^<STR>^^<t>^^<POLL>^^<REAC
H>^^<DELAY>^^<OFFSET>^^<JITTER>r^*/" cr lf
^^^"/*^<sel>^^^3^<IPAddress>^^<IPAddress>^^<STR>^^<t>^^<POLL>^^<REAC
H>^^<DELAY>^^<OFFSET>^^<JITTER>r^*/" cr lf
^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

NTP= Value Description


{ ENABLE, DISABLE}

Description: Enable or disable time synchronization from the NTP server.


Factory Default is DISABLE

CLKMODE= Value Description


{FREE-RUNNING, HOLDOVER,
NTPSYNC,NTPSYNCR}

Description: The current operating mode of the NTP service


FREE-RUNNING NTP is not enabled, or the NE is not
synchronized to an NTP server and is instead using
its own internal clock as a source.
HOLDOVER NTP is enabled but the NE has lost NTP
server connectivity, and is using the last known
clock update to synchronize its clock
NTPSYNC NTP is enabled, and the NE is using the NTP
protocol to synchronize to an NTP server.
NTPSYNCR Network Time Protocol Synchronized
Redundant
NTP is enabled and synchronized to a
reference server and a backup reference is also
eligible to become the primary reference
Sel
{*+^}

2170 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-NTP Issue 1, December 2011

Description: A one-character selection status


indicator
* indicates selected reference
+ indicates eligible for selection
^ (space) indicates ineligible for
selection

<IPAddress>
{1-99,102-126,128-223}-{0-255}-{0-255}-{0-255}
Description: NTP Server IP address

<RefID>
{<IPAddress>|<KissOfDeathCode>|<RefID>}
Description: NTP Server's reference clock
identifier. (one of the following three options)
IPAddress of the server's server
KissOfDeath code sent by the server to
advise the client of an unusual condition
RefID identification of the time reference
source when not another IP network link

Table of Kiss Of Death Codes


Code Description
ACST manycast server
AUTH authentication error
AUTO Autokey sequence error
BCST broadcast server
CRYPT Autokey protocol error
DENY access denied by server
INIT association initialized
MCST multicast server
RATE rate exceeded
TIME association timeout
STEP step time change

Table of RefID values and their meanings

1830PSS R3.6.50 - TL1 Commands and Messages 2171


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NTP

Type RefID Description


1 LOCL Undisciplined Local Clock
2 GPS Trak 8820 GPS Receiver
3 WWV PSTI/Traconex 1020 WWV/WWVH Receiver
4 WWVB Spectracom WWVB/GPS Receivers
5 GPS | OMEGA | GOES TrueTime GPS/GOES/OMEGA Receivers
6 IRIG IRIG Audio Decoder
7 CHU Radio CHU Audio Demodulator/Decoder
8 PARSE Generic Reference Driver
9 GPS Magnavox MX4200 GPS Receiver
10 GPS Austron 2200A/2201A GPS Receivers
11 GPS Arbiter 1088A/B GPS Receiver
12 IRIG KSI/Odetics TPRO/S IRIG Interface
13 Leitch CSD 5300 Master Clock Controller
14 EES M201 MSF Receiver
15 reserved
16 BTFP Bancomm GPS/IRIG Receiver
17 Datum Precision Time System
18 NIST | USNO | PTB | WWVB NIST/USNO/PTB Modem Time Services
19 WWV Heath WWV/WWVH Receiver
20 GPS Generic NMEA GPS Receiver
21 TrueTime GPS-VME Interface
22 PPS PPS Clock Discipline
23 reserved
24 reserved
25 reserved
26 GPS Hewlett Packard 58503A GPS Receiver
27 MSFa | MSF | DCF | WWVB Arcron MSF Receiver
28 SHM Shared Memory Driver
29 GPS Trimble Navigation Palisade GPS
30 GPS Motorola UT Oncore GPS
31 GPS Rockwell Jupiter GPS
32 CHRONOLOG Chrono-log K-series WWVB receiver
33 DUMBCLOCK Dumb Clock
34 WWVB Ultralink WWVB Receivers
35 PCF Conrad Parallel Port Radio Clock
36 WVf | WHf Radio WWV/H Audio Demodulator/Decoder
37 GPS Forum Graphic GPS Dating station
38 .hopf. (default), GPS, DCF hopf GPS/DCF77 6021/komp for Serial Line
39 .hopf. (default), GPS, DCF hopf GPS/DCF77 6039 for PCI-Bus

2172 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-NTP Issue 1, December 2011

Type RefID Description


40 JJY JJY Receivers
41 TrueTime 560 IRIG-B Decoder
42 GPS Zyfer GPStarplus Receiver
43 RIPENCC RIPE NCC interface for Trimble Palisade
44 neol NeoClock4X - DCF77 / TDF serial line

<STR>
{1-16}
Description: NTP Server stratum

<T>
{ubl}
Description: NTP Server mode
u - unicast
b - broadcast
l - ("ell") local
<POLL>
0-9999
Description: NTP Server polling interval (log base 2 seconds)

<REACH>
{000 - 377}
Description: NTP Server success status of last eight attempts to contact the
server (octal)

<DELAY>
Description: NTP Server round trip delay in milliseconds.

<OFFSET>
Description: NTP Server millisecond offset three decimal places

<JITTER>
Description: NTP Server jitter milliseconds to three decimal places

1830PSS R3.6.50 - TL1 Commands and Messages 2173


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-NTP
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
In the following example, RTRV-NTP retrieves the NTP provisioning parameters when the NTP client
interface is disabled.
RTRV-NTP;
The output response is shown below.

LASVEGAS 01-02-27 08:46:59


M C0001 COMPLD
NTP=ENABLE CLKMODE=NTPSYNC
Sel IP PST SST str
t poll reach delay offset jitter
+ 1 064.090.182.055 IS STBYH 3 u 1024
377 43.597 -0.876 2.116
* 2 129.006.015.028 IS WRK 3 u 1024
357 42.032 -1.315 1.612
3 132.163.004.101 OOS-AU --- 3 u 1024
000 --- --- ---
/* RTRV-NTP [C0001] (5) */

RELATED COMMANDS
ED-NTP
ED-DAT

RELATED AUTONOMOUS RESPONSES


None

2174 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OC12


Command Name: RTRV-OC12

PURPOSE
The RTRV-OC12 command shall be used to retrieve all parameters related to the OC12 client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OC12:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2175


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC12
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,SIGMODE=<value>][,SDTH=<value>][,SFTH=<value>][,J0_EX=<value>][,J0_
TX=<value>][,J0_INC=<value>][,J0_FMT=][,J0_STAT=<value>][,TIMMRESP=<
value>][,TRCCMP=][,LOSPROP=<value>][,MODULETYPE=<value>][,CHANNEL=<v
alue>][,DESCR=<value>][,TS=\"<value>\"][,RXPOWER=<value>][,TXPOWER=<
value>][,CONTAINER=<value>]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC12 (OC12 on 11DPM12 client ports)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Timer value, specifies how much time is


currently remaining on the AINS timer before the facility is placed
in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

2176 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC12 Issue 1, December 2011

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

SIGMODE= Value Description


{TRANSPARENT}

Description: Indicates whether a SONET/SDH signal is transported in


TRANSPARENT mode or TERMINATED mode. Currently applies
only to 4DPA4. Only TRANSPARENT applies to 4DPA4.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Description: Attribute that specifies BER threshold for SD defect declaration.


Does not apply to 4DPA4.

SFTH= Value Description


{10-3,10-4, 10-5}

Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Description: Expected J0. Does not apply to 4DPA4.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Description: Transmitted J0. Does not apply to 4DPA4.

1830PSS R3.6.50 - TL1 Commands and Messages 2177


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC12
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_INC= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Incoming J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

J0_STAT= Value Description


{UNAVAILABLE,NORMAL,MISMATCH,
UNSPECIFIED}

Description: J0 Incoming Status. This is the status of the incoming section


trace.
• UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) .
The received value in this case may be omitted or a
"?" may be used.
• NORMAL This indicates that the incoming and the
expected trace contains a valid match. The received value in this
case is shown.

• MISMATCH This indicates that the incoming and the


expected trace do not match. The received value in this case is
shown.

• UNSPECIFIED This indicates that the comparison parameter is


set to disabled. The received value in this case may be left blank
"".

2178 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC12 Issue 1, December 2011

Restriction : Parameter J0_STAT is not applicable to 4DPA4 OT.

TIMMRESP= Value Description


{ENABLED, DISABLED}

Description: J0 Trace Identifier Mismatch Response. This parameter


determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED, DISABLED}

Description: J0 Trace compare. This parameter enables and disables the


comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SL-4.1,SL-4.2,
SL-16.2C, SS-4.1, SS-16.1A,
SS-16.2C}

Description: Attribute that defines the pluggable


module type used in providing the physical layer
function on the specified OC12 port. If the value
AUTO is chosen, the NE shall accept the pluggable
module type inserted in the socket if the previous
MODULETYPE value was <null>.
If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set
to USER.
Note: SL-4.2 and SS-4.1 are supported only on 4DPA4 OT.

1830PSS R3.6.50 - TL1 Commands and Messages 2179


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC12

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


ODU1-L1-{1-4}-{1, 13, 25, 37}
(11STMM10 timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)
{L1,L2}-(<ts_list>) (4DPA4
timeslots)
0-0 (unassigned 4DPA4 timeslot)

Description: Timeslot assignment.


11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port.
Timeslots are numbered 1-16 within the ODU1 on each line.
OC12/STM4 requires 4 timeslots. <ts_list> can include a list of
individual timeslots and/or a list of timeslot ranges. The syntax is:
<x1[-y1][,x2[-y2]][,x3[-y3]]...>. If only one timeslot is specified, the
request is for a contiguous range of timeslots starting at that value.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

2180 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC12 Issue 1, December 2011

CONTAINER= Value Description


{None,OPTSG, ODU0}

Description: Specifies the granularity for client signal mapping to ODU2


multiplexing structure.
Set to optsg - proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

1830PSS R3.6.50 - TL1 Commands and Messages 2181


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC12
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-OC12


command.
RTRV-OC12:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD

"11STMM10-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,SDTH
=10-6, SFTH=10-3, J0_EX="TRAILTRACE",
J0_TX="TRAILTRACE",TIMMRESP=ENABLED,TRCCMP=ENABLED,J0_STAT=NORMAL,LO
SPROP=LASERON,MODULETYPE=AUTO,CHANNEL=1551,DESCR=\"\",TS="ODU1-L1-2-
1",RXPOWER=-3.62,TXPOWER=-1.06:IS-NR,"
;

RELATED COMMANDS
ENT-OC12
RTRV-OC12
RST-OC12
DLT-OC12
ED-OC12
RMV-OC12

RELATED AUTONOMOUS RESPONSES


none

2182 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OC192


Command Name: RTRV-OC192

PURPOSE
The RTRV-OC192 command shall be used to retrieve all parameters related to the OC192 client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OC192:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

1830PSS R3.6.50 - TL1 Commands and Messages 2183


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC192

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,MAPPINGMODE=<value>][,CHANNEL=<value>][, SDTH=<value>][,
SFTH=<value>][, J0_EX=<value>][,
J0_INC=<value>][,J0_FMT=][,J0_STAT=][, TRCCMP=<value>][,
LOSPROP=<value>][,
MODULETYPE=<value>][,DESCR=<value>][,RXPOWER=<value>][,TXPOWER=<valu
e>]:<PST> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service.
The maximum time is 96-00.

2184 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC192 Issue 1, December 2011

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosent to use the AINSTMR value
instead of the AINSREF value for automatic
in-service transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

MAPPINGMODE= Value Description


BITSYNC bit synchronous CBR mapping
ASYNC asynchronous CBR mapping

Description: Type of mapping of OC192/STM64 into an ODU2 structure.


The MAPPINGMODE parameter applies to the 43STX4 and
43STX4P OTs.
The MAPPINGMODE parameter applies to the 43SCX4L OT and
43SCX4 OT.
The MAPPINGMODE parameter applies to the 112SCX10,
112SNX10, and 112SX10L OTs.
This parameter shall not apply to the 11QPA4and 11QTA4 OTs.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Retrieves the channel frequency of the client port.

1830PSS R3.6.50 - TL1 Commands and Messages 2185


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC192

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Description: Attribute that specifies BER threshold for SD defect declaration.


The SDTH parameter is not supported on the 43STX4 and
43STX4P OTs.
The SDTH parameter applies to the 43SCX4L OT and 43SCX4
OT..

SFTH= Value Description


{10-3,10-4, 10-5}

Description: Attribute that specifies BER threshold for Excessive BER defect
declaration.
The SFTH parameter is not supported on the 43STX4 and
43STX4P OTs.
The SFTH parameter applies to the 43SCX4L OT and 43SCX4
OT.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Expected J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_INC= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Incoming J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

2186 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC192 Issue 1, December 2011

J0_FMT= Value Description


{1, 16}

Description: J0 format.

J0_STAT= Value Description


{UNAVAILABLE,NORMAL,MISMATCH,
UNSPECIFIED}

Description: J0 Incoming Status. This is the status of the incoming section


trace.
• UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) .
The received value in this case may be omitted or a
"?" may be used.
• NORMAL This indicates that the incoming and the
expected trace contains a valid match. The received value in this
case is shown.

• MISMATCH This indicates that the incoming and the


expected trace do not match. The received value in this case is
shown.

• UNSPECIFIED This indicates that the comparison parameter is


set to disabled.

TRCCMP= Value Description


{ENABLED, DISABLED}

Description: J0 Trace Comparison. This parameter enables and disables J0


section trace mismatch detection. That is, this parameter enables
and disables comparison between the incoming J0 value and the
provisioned expected J0 value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

1830PSS R3.6.50 - TL1 Commands and Messages 2187


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC192

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11STAR1, 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
112SCX10, 112SNX10, and 112SX10L
OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QPA4 OTs.
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11QTA4 OTs.

Description: Attribute that defines the pluggable


module type used in providing the physical layer
function on the specified OC192 port. If the value
AUTO is chosen, the NE shall accept the pluggable
module type inserted in the socket if the previous
MODULETYPE value was <null>.
If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set
to USER.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

2188 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC192 Issue 1, December 2011

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2189


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC192
EXAMPLES

The following example shows the successful execution of a RTRV-OC192


command.
RTRV-OC192:NODE-1:11STAR1-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STAR1-1-5-C1::AINSCNTDWN=00-05,AINSREF=SYSTEM,AINSTMR=08-00,MAPPI
NGMODE=ASYNC,CHANNEL=850,SDTH=10-6, SFTH=10-3, J0_EX="TRAILTRACE",
J0_INC="TRAILTRACE",TRCCMP=ENABLED,J0_STAT=NORMAL,LOSPROP=LASERON,MO
DULETYPE=AUTO,DESCR=\"\",RXPOWER=-5.5,TXPOWER=-2.44:IS-NR,"
;

RELATED COMMANDS
ENT-OC192
RTRV-OC192
RST-OC192
DLT-OC192
ED-OC192
RMV-OC192

RELATED AUTONOMOUS RESPONSES


none

2190 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OC3


Command Name: RTRV-OC3

PURPOSE
The RTRV-OC3 command shall be used to retrieve all parameters related to the OC3 client port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OC3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2191


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC3
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,SIGMODE=<value>][,SDTH=<value>][,SFTH=<value>][,J0_EX=<value>][,J0_
TX=<value>][,J0_INC=<value>][,J0_FMT=][,J0_STAT=<value>][,TIMMRESP=<
value>][,TRCCMP=<value>][,LOSPROP=<value>][,MODULETYPE=<value>][,CHA
NNEL=<value>][,DESCR=<value>][,TS=\"<value>\"][,RXPOWER=<value>][,TX
POWER=<value>][,CONTAINER=]:<PST>[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC3 (OC3 on 11DPM12 client ports)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Timer value, specifies how much time is


currently remaining on the AINS timer before the facility is placed
in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition.

AINSTMR= Value Description


{{00-96}-{00-59}}

2192 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC3 Issue 1, December 2011

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

SIGMODE= Value Description


{TRANSPARENT}

Description: Indicates whether a SONET/SDH signal is transported in


TRANSPARENT mode or TERMINATED mode. Currently applies
only to 4DPA4. Only TRANSPARENT applies to 4DPA4.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Description: Attribute that specifies BER threshold for SD defect declaration.


Does not apply to 4DPA4.

SFTH= Value Description


{10-3,10-4, 10-5}

Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4.

J0_EX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Description: Expected J0. Does not apply to 4DPA4.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if J0_FMT is
16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Description: Transmitted J0. Does not apply to 4DPA4.

1830PSS R3.6.50 - TL1 Commands and Messages 2193


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC3
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_INC= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Incoming J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Description: J0 format.
Not currently provisionable on 4DPA4. Only 16-byte format applies
to 4DPA4.

J0_STAT= Value Description


{UNAVAILABLE,NORMAL,MISMATCH,
UNSPECIFIED}

Description: J0 Incoming Status. This is the status of the incoming section


trace.
• UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) .
The received value in this case may be omitted or a
"?" may be used.
• NORMAL This indicates that the incoming and the
expected trace contains a valid match. The received value in this
case is shown.

• MISMATCH This indicates that the incoming and the


expected trace do not match. The received value in this case is
shown.

• UNSPECIFIED This indicates that the comparison parameter is


set to disabled. The received value in this case may be left blank
"".

2194 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC3 Issue 1, December 2011

Restriction : Parameter J0_STAT is not applicable to 4DPA4 OT.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: J0 Trace Identifier Mismatch Response. This parameter


determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: J0 Trace compare. This parameter enables and disables the


comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SL-1.1, SL-16.2C,
SS-16.1A, SS-16.2C}

Description: Attribute that defines the pluggable


module type used in providing the physical layer
function on the specified OC3 port. If the value AUTO
is chosen, the NE shall accept the pluggable module
type inserted in the socket if the previous MODULETYPE
value was <null>.
If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set
to USER.
Note: The module types SS-1.1 , SL-1.2 are supported only by
4DPA4 Client ports.

1830PSS R3.6.50 - TL1 Commands and Messages 2195


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC3

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

TS= Value Description


ODU1-L1-{1-4}-{1, 4, 7, 10, 13, 16, 19,
22, 25, 28, 31, 34, 37, 40, 43, 46}
(11STMM10 timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)
{L1,L2}-({1-16}) (4DPA4
timeslots)
0-0 (unassigned 4DPA4 timeslot)

Description: Timeslot assignment.


11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4: Timeslot assignment on the specified Line port (L1 or L2).

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

2196 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC3 Issue 1, December 2011

CONTAINER= Value Description


{None,OPTSG, ODU0}

Description: Specifies the granularity for client signal mapping to ODU2


multiplexing structure.
Set to optsg - proprietary mapping into sub-ODU1 time slots.The
ODU1 will be mapped into ODU2 with AMP per G.709.

Set to odu0-mapping into ODU0 with GMP per G.709.


This parameter only applies to 11DPM12.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2197


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC3
EXAMPLES

The following example shows the successful execution of a RTRV-OC3


command.
RTRV-OC3:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STMM10-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,SDTH
=10-6, SFTH=10-3, J0_EX="TRAILTRACE",
J0_TX="TRAILTRACE",TIMMRESP=ENABLED,TRCCMP=ENABLED,J0_STAT=NORMAL,LO
SPROP=LASERON,MODULETYPE=AUTO,CHANNEL=1531,DESCR=\"\",TS="ODU1-L1-2-
1",RXPOWER=-3.62,TXPOWER=-1.06:IS-NR,"
;

RELATED COMMANDS
ENT-OC3
RTRV-OC3
RST-OC3
DLT-OC3
ED-OC3
RMV-OC3

RELATED AUTONOMOUS RESPONSES


none

2198 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OC48


Command Name: RTRV-OC48

PURPOSE
The RTRV-OC48 command shall be used to retrieve all parameters related to the OC48 client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OC48:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2199


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC48
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,SIGMODE=<value>][,MAPPINGMODE=<value>][,SDTH=<value>][,SFTH=<value>
][,J0_EX=<value>][,J0_TX=<value>][,J0_INC=<value>][,J0_FMT=<value>][
,J0_STAT=<value>][,TIMMRESP=<value>][,TRCCMP=<value>][,LOSPROP=<valu
e>][,MODULETYPE=<value>][,CHANNEL=<value>][,DESCR=<value>][,TS=\"<va
lue>\"][,CONTAINER=<value>][,RXPOWER=<value>][,TXPOWER=<value>]:<PST
> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-{L{1-2}, C{1-2}} (4DPA2 Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OC48 (OC48 on 11DPM12 client ports)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Timer value, specifies how much time is


currently remaining on the AINS timer before the facility is placed
in service. The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

2200 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC48 Issue 1, December 2011

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, indicates the transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

SIGMODE= Value Description


{TRANSPARENT}

Description: Indicates whether a SONET/SDH signal is transported in


TRANSPARENT mode or TERMINATED mode. Currently applies
only to 4DPA4 and 4DPA2. Only TRANSPARENT applies to
4DPA4 and 4DPA2.

MAPPINGMODE= Value Description


{ASYNC,SYNC}

Description: Type of mapping of OC48/STM16 into an ODU1 structure.


Currently applies only to 4DPA4 . Only ASYNC applies to 4DPA4.
It also applies to 11DPM12 OT when client signal type is OC48
with Container=ODU1. ASYNC or SYNC could be applied to
11DPM12.

SDTH= Value Description


{10-5, 10-6, 10-7, 10-8, 10-9}

Description: Attribute that specifies BER threshold for SD defect declaration.


Does not apply to 4DPA4 and 4DPA2.

SFTH= Value Description


{10-3,10-4, 10-5}

Description: Attribute that specifies BER threshold for Excessive BER defect
declaration. Does not apply to 4DPA4 and 4DPA2.

1830PSS R3.6.50 - TL1 Commands and Messages 2201


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC48

J0_EX= Value Description


<15 T.50 character string if the J0_FMT
is 16_byte>
<1 byte in numerical format (value
range 0-255) if J0_FMT is 1_byte>

Description: Expected J0. Does not apply to 4DPA4 and 4DAP2.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_TX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (0-255) if J0
format is 1_byte>

Default: <null>
Addressing: None
Description: Transmitted J0. Does not apply to 4DPA4 and 4DPA2.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_INC= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Incoming J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Description: J0 format.
Not currently provisionable on 4DPA4 and 4DPA2. Only 16-byte
format applies to 4DPA4 and 4DPA2.

2202 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC48 Issue 1, December 2011

J0_STAT= Value Description


{UNAVAILABLE,NORMAL,MISMATCH,
UNSPECIFIED}

Description: J0 Incoming Status. This is the status of the incoming section


trace.
• UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) .
The received value in this case may be omitted or a
"?" may be used.
• NORMAL This indicates that the incoming and the
expected trace contains a valid match. The received value in this
case is shown.

• MISMATCH This indicates that the incoming and the


expected trace do not match. The received value in this case is
shown.

• UNSPECIFIED This indicates that the comparison parameter is


set to disabled. The received value in this case may be left blank
"".

Restriction : Parameter J0_STAT is not applicable to 4DPA4 and


4DPA2 OTs.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: J0 Trace Identifier Mismatch Response. This parameter


determines whether an OT will take a Consequent Action upon
detection of an J0 trace mismatch at its input. If enabled the
consequent action is "insert AIS" and RDI in the backward
direction. Does not apply to 4DPA4 and 4DPA2.
ENABLED enable TIMM consequent action
DISABLED disable TIMM consequent action

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: J0 Trace compare. This parameter enables and disables the


comparison between the incoming J0 value and the provisioned
(i.e., expected) J0 value. Does not apply to 4DPA4 and 4DPA2.
ENABLED enable compare
DISABLED disable compare

1830PSS R3.6.50 - TL1 Commands and Messages 2203


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC48

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C,
SL-16.2D,SS-16.1A, SS-16.2C}

Description: Attribute that defines the pluggable module type used in providing
the physical layer function on the specified OC48 port. If the value
AUTO is chosen, the NE shall accept the pluggable module type
inserted in the socket if the previous MODULETYPE value was
<null>. If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set to USER.
Note: SI-16.1 and SL-16.2
are not supported on
4DPA2 OT.
SL-16.2C, SS-16.2C, and SL-16.2D are the
only types supported on the line port of 4DPA2 OT.
SL-16.2D is not supported on the client
ports of 4DPA2 , 4DPA4 and 11STMM10 OTs.

CHANNEL= Value Description


NONE (not yet assigned)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths)
{850, 1310, 1550} (B&W wavelengths)

Description: Specifies the channel frequency of the client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

2204 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC48 Issue 1, December 2011

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)
{L1,L2}-(1) (4DPA4 timeslots)
0-0 (unassigned 4DPA4 timeslot)

Description: Timeslot asignment.


11STMM10: Timeslot assignment on the Line port
<ODU1#>-<Time Slot within ODU1>.
4DPA4 and 4DPA2: Timeslot assignment on the specified Line
port (L1 or L2). Timeslot 1 represents the entire OTU1 capacity
(all 16 timeslots).
Parameter TS does not apply to 4DPA2.

CONTAINER= Value Description


{None, ODU1}

Description: Specifies the granularity for client OC48 mapping to ODU2


multiplexing structure.
Set to odu1-mapping into ODU1 per G.709.
This parameter only applies to 11DPM12.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal

1830PSS R3.6.50 - TL1 Commands and Messages 2205


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC48
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

2206 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC48 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RTRV-OC48


command.
RTRV-OC48:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STMM10-1-5-C1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=08-00,SDTH
=10-6, SFTH=10-3, J0_EX="TRAILTRACE",
J0_TX="TRAILTRACE",TIMMRESP=ENABLED,TRCCMP=ENABLED,J0_STAT=NORMAL,LO
SPROP=LASERON,MODULETYPE=AUTO,CHANNEL=1511,DESCR=\"\",RXPOWER=-3.62,
TXPOWER=-1.06,TS="ODU1-L1-2-1":IS-NR,"
;

RELATED COMMANDS
ENT-OC48
RTRV-OC48
RST-OC48
DLT-OC48
ED-OC48
RMV-OC48

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2207


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC48

2208 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OC768


Command Name: RTRV-OC768

PURPOSE
The RTRV-OC768 command shall be used to retrieve all parameters related to the OC768 client port.
The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OC768:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2209


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC768
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
, J0_EX=<value>][, J0_INC=<value>][,J0_FMT=][,J0_STAT=][,
TRCCMP=<value>][, LOSPROP=<value>][,DESCR=<value>]:<PST> [,<SST>]"
cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Description: Access Identifier, specifies an access Identifier to the OT (client)


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: Automatic In-Service Count Down value, specifies how much time
is currently remaining on the AINS timer before the facility is
placed in service.
The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosent to use the AINSTMR value
instead of the AINSREF value for automatic
in-service transition out of AINS.

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, transition soak time out of AINS.

2210 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC768 Issue 1, December 2011

Format is HOURS-MINUTES. The maximum time is 96-00. The


minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for auto-in-service transitions out of AINS will
cause the value of AINSREF to be set to OVRD.

J0_EX= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Expected J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_INC= Value Description


<15 T.50 character string if format is
16_bytes>
<1 byte in numerical format (value
range 0-255) if J0 format is 1_byte>

Description: Incoming J0.


15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

J0_FMT= Value Description


{1, 16}

Description: J0 format.

J0_STAT= Value Description


{UNAVAILABLE,NORMAL,MISMATCH,
UNSPECIFIED}

Description: J0 Incoming Status. This is the status of the incoming section


trace.

1830PSS R3.6.50 - TL1 Commands and Messages 2211


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC768
• UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) .
The received value in this case may be omitted or a
"?" may be used.
• NORMAL This indicates that the incoming and the
expected trace contains a valid match. The received value in this
case is shown.

• MISMATCH This indicates that the incoming and the


expected trace do not match. The received value in this case is
shown.

• UNSPECIFIED This indicates that the comparison parameter is


set to disabled.

TRCCMP= Value Description


{ENABLED, DISABLED}

Description: J0 Trace Comparison. This parameter enables and disables J0


section trace mismatch detection. That is, this parameter enables
and disables comparison between the incoming J0 value and the
provisioned expected J0 value.
ENABLED enable compare
DISABLED disable compare

LOSPROP= Value Description


{LASEROFF, LASERON}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when far end failure gets
signalled.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

2212 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OC768 Issue 1, December 2011

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2213


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OC768
EXAMPLES

The following example shows the successful execution of a RTRV-OC768


command.
G07U> rtrv-oc768::43STA1P-1-7-C1:234;

G07U 10-01-18 07:57:10


M 234 COMPLD
"43STA1P-1-7-
C1::J0_EX=\"\",J0_FMT=16,J0_INC=\"\",TRCCMP=DISABLED,AINSTMR=00-10,A
INSCNTDWN=00- 00,LOSPROP=LASERON,AINSREF=SYSTEM,DESCR=
\"\":OOS-AUMA,SGEO"
/* RTRV-OC768 */
;

RELATED COMMANDS
ENT-OC768
RTRV-OC768
RST-OC768
DLT-OC768
ED-OC768
RMV-OC768

RELATED AUTONOMOUS RESPONSES


none

2214 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OCH-WAVEKEY


Command Name: RTRV-OCH-WAVEKEY

PURPOSE
The RTRV-OCH-WAVEKEY command is used to retrieve WaveTracker Key details for ports within the
system.
For retrivial of expected WaveTracker decoder keys use the WTMONITOR option with a port AID.
For retrivial of expected WaveTracker encoder keys use the WTSOURCE option with a port AID.
For retrivial of unexpected WaveTracker keys use the UNEXPECTED option with a port AID.
For retrivial of channel powers and WaveTracker keys on the WTOCM use the WTOCMCHAN option
with a port AID.
For retrivial of unexpected WaveTracker keys per channel on the WTOCM use the WTOCMUNEX
option with a port AID.

INPUT FORMAT

RTRV-OCH-WAVEKEY:[TID]:[AID]:[CTAG]::[COMMAND];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2215


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH-WAVEKEY

AID Value Description


+ The following aids are valid when
COMMAND=WTMONITOR or
UNEXPECTED
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A LINE Ports)
LINEOUT}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B LINE Ports)
LINEOUT}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A LINE Ports)
LINEOUT}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-SIGIN (MESH4 SIGIN Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
+ The following aids are valid when
COMMAND=WTSOURCE
SVAC-<shelf>-<slot>-L1 (SVAC Line Port)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)

2216 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH-WAVEKEY Issue 1, December 2011

AID Value Description


11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
+ The following aids are valid when
COMMAND=WTOCMCHAN or
WTOCMUNEX
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OTS.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

COMMAND Value Description


WTMONITOR
WTSOURCE
UNEXPECTED
WTOCMCHAN
WTOCMUNEX

Default: WTMONITOR
Addressing: None
Description: Command to run to retrieve expected decoder, expected encoder
or unexpected keys. See the AID parameter definition to identify
which AIDs apply to which commands.
WTMONITOR retrieve expected decoder keys
WTSOURCE retrieve expected encoder keys
UNEXPECTED retrieve unexpected keys
WTOCMCHAN Retrieve the channel data from the
WTOCM card
WTOCMUNEX Retrieve the unexpected keys received on
the WTOCM card

1830PSS R3.6.50 - TL1 Commands and Messages 2217


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH-WAVEKEY
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>::[DIRN=<value>] [,CHANNEL=<value>] [,WK1=<value>]
[,WK2=<value>] [,STATUS=<value>] [,POWER=<value>]
[,OUTPOWER=<value>] [,DEVPOWER=<value>] [,TOLPOWER=<value>]
[,EXPOUTPOWER=<value>] [,UNEXKEY=<value>]
[,UNEXPOWER=<value>][,CHANPOWER=<value>] [,CHANPOWERMON=<value>]
[,CHANWK1=<value>] [,CHANWK2=<value>] [,CHANAPPL=<value>]
[,CHANUNEXKEY=<value>]" cr lf]*
[^^^/*^<Command_Echo>^*/ cr lf]
;

OUTPUT PARAMETERS

2218 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH-WAVEKEY Issue 1, December 2011

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A LINE Ports)
LINEOUT}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B LINE Ports)
LINEOUT}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A LINE Ports)
LINEOUT}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-SIGIN (MESH4 SIGIN Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
SVAC-<shelf>-<slot>-L1 (SVAC Line Port)

1830PSS R3.6.50 - TL1 Commands and Messages 2219


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH-WAVEKEY

AID Value Description


MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)

Description: Access Identifier, specifies an access Identifier to the OTS.

DIRN= Value Description


TRMT
RCV

Description: DIRN, Describes the direction of the reported channel


TRMT Report the transmit direction channels
RCV Report the receive direction channels

CHANNEL= Value Description


{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170, NONE}

Description: CHANNEL, Channel Frequency.

WK1= Value Description


{integer in range 0<WK1<4096}

Description: WK1, The first WavelengthTracker key.

WK2= Value Description


{integer in range 0<WK2<4096}

Description: WK2, The second WavelengthTracker key.

2220 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH-WAVEKEY Issue 1, December 2011

STATUS= Value Description


PRESENT
NOT PRESENT
NOT AVAILABLE

Description: STATUS, This shall describe the operational status for the optical
channels currently in the IS state. The SCOT software controls the
transition from provisioned to operational status.
PRESENT Seen by WaveTracker
NOT PRESENT Not seen by WaveTracker
NOT AVAILABLE WaveTracker data not available

POWER= Value Description


{-99.00 to +11.00}

Description: POWER, The expected channel power to be measured at the


addressed WaveTracker detector.

OUTPOWER= Value Description


<numerical value>

Description: OUTPOWER, Measured egress power (dBm).

DEVPOWER= Value Description


{0.00 to 10.00}

Description: DEVPOWER, The deviation from expected channel power to be


measured at the addressed WaveTracker detector that will trigger
an OPR alarm.

TOLPOWER= Value Description


{0.00 to 5.00}

Description: TOLPOWER, The amount of power change from the OPR alarm
set point needed to clear the OPR alarm.

1830PSS R3.6.50 - TL1 Commands and Messages 2221


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH-WAVEKEY

EXPOUTPOWER= Value Description


{-20.00 to -5.5} 4DPA4, 11QPA4, and
11DPE12 packs
{-17.00 to +1.7} 112SCX10, 112SX10L,
112SCA1, 112SA1L packs
{-17.00 to +1.7} 112SCX10, 112SX10L,
112SCA1, 112SA1L, 112SNX10,
112SNA1 packs
{-17.00 to -1.3} 43SCX4 pack
{-20.00 to +4.00} All Other OT Packs

Description: EXPOUTPOWER, The expected channel output power


provisioned at the addressed WaveTracker encoder for OT line
ports or the OPSA A and B ports.

UNEXKEY= Value Description


{integer in range 0<KEY<4096}

Description: UNEXKEY, The key value of the unexpected key.

UNEXPOWER= Value Description


{-99.00 to +11.00}

Description: UNEXPOWER, The channel power for the unexpected key.

CHANPOWER= Value Description


{-99.00 to +11.00}

Description: CHANPOWER, The power measured at the channel frequency on


the WTOCM input port.

CHANPOWERMON Value Description


=
{-99.00 to +11.00}

Description: CHANPOWERMON, The power measured at the channel


frequency calculated for the monitored port.

CHANWK1= Value Description


{integer in range 0<WK1<4096}

Description: CHANWK1, The first provisioned WavelengthTracker key


measured at the channel frequency.

2222 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH-WAVEKEY Issue 1, December 2011

CHANWK2= Value Description


{integer in range 0<WK1<4096}

Description: CHANWK2, The second provisioned WavelengthTracker key


measured at the channel frequency.

CHANAPPL= Value Description


NOTAPPL
APPLUNAVAIL
APPLUNCONFIRM
APPLCONFIRM
APPLUNEXPECTED

Description: CHANAPPL, Reports the WTOCM measurement status for the


channel.
NOTAPPL no wave keys configured. This will either be an
unkeyed OCH cross connect or no cross connect
APPLUNAVAIL wave keys configured but not processed.
The wave key data has been programmed into the
WTOCM but the wave key procesing has not
started because no power has been detected for the
channel or a hardware fault prevents the key
processing.
APPLUNCONFIRM wave keys configured and processing
started but not finished. Wavekey processing is
on-going but is not yet complete.
APPLCONFIRM wave keys configured, processing complete
and keys confirmed. All processing is done and the
programmed keys were detected.
APPLUNEXPECTED wave keys configured, processing
complete and unexpected keys detected. All
processing is done and unexpected keys were
detected. If expected keys were also detected they
will be reported using the WTOCMUNEX command.

CHANUNEXKEY= Value Description


{integer in range 0<WK1<4096}

Description: CHANUNEXKEY, The key value of the unexpected key measured


on the reported channel.

1830PSS R3.6.50 - TL1 Commands and Messages 2223


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH-WAVEKEY
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a RTRV-OCH-WAVEKEY::WTMONITOR
command

RTRV-OCH-WAVEKEY:NODE-1:ALPHG-3-9-LINE:789012:WTMONITOR;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
"ALPHG-3-9-LINE:DIRN=TRMT, CHANNEL=9170, WK1=179, WK2=723,
STATUS=PRESENT, POWER=-12.5, OUTPOWER=-12.1, DEVPOWER=6, TOLPOWER=3"
cr lf
"ALPHG-3-9-LINE:DIRN=TRMT, CHANNEL=9180, WK1=179, WK2=723,
STATUS=PRESENT, POWER=-12.5, OUTPOWER=-12.1, DEVPOWER=6, TOLPOWER=3"
cr lf
.
.
.
"ALPHG-3-9-LINE:DIRN=TRMT, CHANNEL=9380, WK1=179, WK2=723,
STATUS=PRESENT, POWER=-12.5, OUTPOWER=-12.1, DEVPOWER=6, TOLPOWER=3"
cr lf
/* RTRV-OCH-WAVEKEY */
;

The following example shows the successful execution of a RTRV-OCH-WAVEKEY::WTSOURCE


command

2224 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH-WAVEKEY Issue 1, December 2011

RTRV-OCH-WAVEKEY:NODE-1:4DPA4-3-9-VA1:789012:WTSOURCE;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
"4DPA4-3-9-VA1:DIRN=TRMT, CHANNEL=9600, WK1=179, WK2=723,
OUTPOWER=-8.16, EXPOUTPOWER=-8.16" cr lf
/* RTRV-OCH-WAVEKEY */
;

The following example shows the successful execution of a RTRV-OCH-WAVEKEY::UNEXPECTED


command

RTRV-OCH-WAVEKEY:NODE-1:AHPHG-1-2-SIG:789012:UNEXPECTED;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
"AHPHG-1-2-SIG::DIRN=TRMT,CHANNEL=9600,UNEXKEY=10030,UNEXPOWER=3.87"
cr lf
/* RTRV-OCH-WAVEKEY */
;

The following example shows the successful execution of a RTRV-OCH-WAVEKEY::WTOCMCHAN


command

RTRV-OCH-WAVEKEY:NODE-1:WTOCM-3-9-IN1:789012:WTOCMCHAN;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
" WTOCM-3-9-IN1:CHANNEL=9170, CHANPOWER=-12.5, CHANPOWERMON=-2.1,
CHANWK1=179, CHANWK2=723, CHANAPPL=APPLCONFIRM" cr lf
" WTOCM-3-9-IN1:CHANNEL=9180, CHANPOWER=-12.5, CHANPOWERMON=-2.1,
CHANWK1=200, CHANWK2=800, CHANAPPL=APPLCONFIRM " cr lf
.
.
.
" WTOCM-3-9-IN1:CHANNEL=9380, CHANPOWER=-12.5, CHANPOWERMON=-2.1,
CHANWK1=300, CHANWK2=900, CHANAPPL=APPLCONFIRM " cr lf
/* RTRV-OCH-WAVEKEY */
;

The following example shows the successful execution of a RTRV-OCH-WAVEKEY::WTOCMUNEX


command

1830PSS R3.6.50 - TL1 Commands and Messages 2225


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH-WAVEKEY

RTRV-OCH-WAVEKEY:NODE-1:WTOCM-1-2-IN2:789012:WTOCMUNEX;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
" WTOCM-1-2-IN2::CHANNEL=9600,CHANUNEXKEY=10030" cr lf
" WTOCM-1-2-IN2::CHANNEL=9600,CHANUNEXKEY=10120" cr lf
/* RTRV-OCH-WAVEKEY */
;

RELATED COMMANDS
ED-OCH
RTRV-OCH

RELATED AUTONOMOUS RESPONSES


none

2226 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OCH


Command Name: RTRV-OCH

PURPOSE
The RTRV-OCH command is used to retrieve the parameters of an optical line. This includes the
current operating parameters of the SCOT software, AIDs of assigned circuit packs, and
characteristics of connected fiber type.

INPUT FORMAT

RTRV-OCH:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2227


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

AID Value Description


ALL (ALL AID)
ALPHG-<shelf>-<slot> (ALPHG Circuit Pack)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG NE Boundary Ports)
LINE}
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot> (AHPHG Circuit Pack)
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG NE Boundary Ports)
LINE}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot> (AHPLG Circuit Pack)
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG NE Boundary Ports)
LINE}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,

2228 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

AID Value Description


9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
A2325A-<shelf>-<slot> (A2325A Circuit Pack)
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A NE Boundary Ports)
LINE}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2017B-<shelf>-<slot> (AM2017B Circuit Pack)
AM2017B-<shelf>-<slot>-{SIG, LINE} (AM2017B NE Boundary Ports)
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot> (AM2325B Circuit Pack)
AM2325B-<shelf>-<slot>-{SIG, LINE} (AM2325B NE Boundary Ports)
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,

1830PSS R3.6.50 - TL1 Commands and Messages 2229


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

AID Value Description


9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot> (AM2125A Circuit Pack)
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot> (AM2125B Circuit Pack)
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot> (AM2318A Circuit Pack)
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)

2230 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

AID Value Description


LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
CWR-<shelf>-<slot> (CWR8/CWR8-88 Circuit Pack)
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
WR-<shelf>-<slot> (WR8-88A/WR2-88A Circuit Pack)
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
WR-<shelf>-<slot>-{SIG, THRU}-{9605, (WR8-88A Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,

1830PSS R3.6.50 - TL1 Commands and Messages 2231


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

AID Value Description


9180, 9175, 9170}
MESH-<shelf>-<slot> (MESH4 Circuit Pack)
MESH-<shelf>-<slot>-SIGIN (MESH4 SIGIN Port)
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OPS-<shelf>-<slot> (OPSA Circuit Pack)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot> (SVAC Circuit Pack)
MVAC-<shelf>-<slot> (MVAC Circuit Pack)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
SFD-<shelf>-1 (SFD44/SFD44B/SFD40/SFD40B
Module)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SFD-<shelf>-<slot> (SFD5/8 Module)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 NE Boundary Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,

2232 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

AID Value Description


9250, 9240, 9230, 9220, 9210, 9200,
9190, 9180, 9170}
SFC-<shelf>-<slot> (SFC2/4/8 Module)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
4DPA4-<shelf>-<slot> (4DPA4 Circuit Pack)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)

Default: <Entry Required>


Addressing: By Pack, Port, Range of Frequency, Specific Frequency
Description: Access Identifier, specifies an access Identifier to the OTS.
Entering a pack AID will report all the OCH on that pack. Entering
a port AID will report all the OCH on that port.
SFD5A channel I/O ports: 9190, 9200, 9210, 9220, 9230
SFD5B channel I/O ports: 9240, 9250, 9260, 9270, 9280
SFD5C channel I/O ports: 9290, 9300, 9310, 9320, 9330
SFD5D channel I/O ports: 9340, 9350, 9360, 9370, 9380
SFD5E channel I/O ports: 9410, 9420, 9430, 9440, 9450
SFD5F channel I/O ports: 9460, 9470, 9480, 9490, 9500
SFD5G channel I/O ports: 9510, 9520, 9530, 9540, 9550
SFD5H channel I/O ports: 9560, 9570, 9580, 9590, 9600

1830PSS R3.6.50 - TL1 Commands and Messages 2233


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>:[TYPEID]:[POWER=<value>] [,DEVPOWER=<value>]
[,TOLPOWER=<value>] [,DIRN=<value>] [,STATUS=<value>]
[,CHANNEL=<value>] [,AINSTMR=<value>] [,AINSCNTDWN=<value>]
[,AINSREF=<value>] [,OUTPOWER=<value>] [,DESCR=<value>]
[,MODULETYPE=<value>] [,EXPOUTPOWER=<value>] [,WK1=<value>]
[,WK2=<value>] [,CALCMODE=<value>] [,SWTHRESH=<value>]
[,SWTOL=<value>] [,VOAATTEN=<value>]:<PST> [,SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

2234 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,

1830PSS R3.6.50 - TL1 Commands and Messages 2235


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

AID Value Description


9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2017B-<shelf>-<slot>-{SIG, (AM2017B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2325B-<shelf>-<slot>-{SIG, (AM2325B Optical Channels)
LINE}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555,
9550, 9545, 9540, 9535, 9530, 9525,
9520, 9515, 9510, 9505, 9500, 9495,
9490, 9485, 9480, 9475, 9470, 9465,
9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405,
9400, 9395, 9390, 9385, 9380, 9375,
9370, 9365, 9360, 9355, 9350, 9345,
9340, 9335, 9330, 9325, 9320, 9315,
9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255,
9250, 9245, 9240, 9235, 9230, 9225,
9220, 9215, 9210, 9205, 9200, 9195,
9190, 9185, 9180, 9175, 9170}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,

2236 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

AID Value Description


9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 Optical Channels)
THRU, OMD}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
WR-<shelf>-<slot>-{SIG, THRU}-{9605, (WR8-88A Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,

1830PSS R3.6.50 - TL1 Commands and Messages 2237


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

AID Value Description


9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
MESH-<shelf>-<slot>-SIGIN-{9605, (MESH4 SIGIN Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
MVAC-<shelf>-<slot>-G{1-8} (MVAC Ports)
SFD-<shelf>-<slot>-{9600, 9590, 9580, (SFD5/8 NE Boundary Ports)
9570, 9560, 9550, 9540, 9530, 9520,
9510, 9500, 9490, 9480, 9470, 9460,
9450, 9440, 9430, 9420, 9410, 9380,
9370, 9360, 9350, 9340, 9330, 9320,
9310, 9300, 9290, 9280, 9270, 9260,
9250, 9240, 9230, 9220, 9210, 9200,
9190, 9180, 9170}
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,

2238 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

AID Value Description


9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SFC-{1-8}-{2-17, 20-35}-{1471, 1491, (SFC2/4/8 NE Boundary Ports)
1511, 1531, 1551, 1571, 1591, 1611}
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-VA{1-2} (11DPE12 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)

Description: Access Identifier, specifies an access Identifier to the OTS.

1830PSS R3.6.50 - TL1 Commands and Messages 2239


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

TYPEID Value Description


11STAR1 (11STAR1 Circuit Pack)
11STMM10 (11STMM10 Circuit Pack)
11STGE12 (11STGE12 Circuit Pack)
43SCX4-<shelf>-<slot> (43SCX4 Circuit Pack)
43SCX4L-<shelf>-<slot> (43SCX4L Circuit Pack)
43STX4 (43STX4 Circuit Pack)
43STX4P (43STX4P Circuit Pack)
43STA1P (43STA1P Circuit Pack)
43SCA1 (43SCA1 Circuit Pack)
112SA1L (112SA1L Circuit Pack)
112SX10L (112SX10L Circuit Pack)
112SCA1 (112SCA1 Circuit Pack)
112SCX10 (112SCX10 Circuit Pack)
112SNA1-<shelf>-<slot> (112SNA1 Circuit Pack)
112SNX10-<shelf>-<slot> (112SNX10 Circuit Pack)
4DPA4 (4DPA4 Circuit Pack)
11QPA4 (11QPA4 Circuit Pack)
11QTA4-<shelf>-<slot> (11QTA4 Circuit Pack)
11DPE12 (11DPE12 Circuit Pack)
11DPE12E (11DPE12E Circuit Pack)
11DPM12 (11DPM12 Circuit Pack)
ALPHG (ALPHG Circuit Pack)
AHPHG (AHPHG Circuit Pack)
AHPLG (AHPLG Circuit Pack)
A2325A (A2325A Circuit Pack)
AM2017B (AM2017B Circuit Pack)
AM2325B (AM2325B Circuit Pack)
AM2125A (AM2125A Circuit Pack)
AM2125B (AM2125B Circuit Pack)
AM2318A (AM2318A Circuit Pack)
CWR8 (CWR8 Circuit Pack)
CWR8-88 (CWR8-88 Circuit Pack)
WR8-88A (WR8-88A Circuit Pack)
MESH4 (MESH4 Circuit Pack)
OPS (OPSA Circuit Pack)
SFD44 (SFD44 Module)
SFD44B (SFD44B Module)
SFD40 (SFD40 Module)
SFD04B (SFD40B Module)
SFD5A (SFD5A circuit pack)
SFD5B (SFD5B circuit pack)

2240 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

TYPEID Value Description


SFD5C (SFD5C circuit pack)
SFD5D (SFD5D circuit pack)
SFD5E (SFD5E circuit pack)
SFD5F (SFD5F circuit pack)
SFD5G (SFD5G circuit pack)
SFD5H (SFD5H circuit pack)
SFD8A (SFD8A circuit pack)
SFD8B (SFD8B circuit pack)
SFD8C (SFD8C circuit pack)
SFD8D (SFD8D circuit pack)
SFC2A (SFC2A circuit pack)
SFC2B (SFC2B circuit pack)
SFC2C (SFC2C circuit pack)
SFC2D (SFC2D circuit pack)
SFC4A (SFC4A circuit pack)
SFC4B (SFC4B circuit pack)
SFC8 (SFC8 circuit pack)
SVAC (SVAC Circuit Pack)
MVAC (MVAC Circuit Pack)

Description: TYPEID, Identifies the type of equipment on which the facility is


located.

POWER= Value Description


{-99.00 to +11.00}

Description: POWER, The expected channel power to be measured at the


addressed WaveTracker detector.

DEVPOWER= Value Description


{0.00 to 10.00}

Description: DEVPOWER, The deviation from expected channel power to be


measured at the addressed WaveTracker detector that will trigger
an OPR alarm.

TOLPOWER= Value Description


{0.00 to 5.00}

Description: TOLPOWER, The amount of power change from the OPR alarm
set point needed to clear the OPR alarm.

1830PSS R3.6.50 - TL1 Commands and Messages 2241


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH

DIRN= Value Description


TRMT
RCV

Description: DIRN, Describes the direction of the reported channel


TRMT Report the transmit direction channels
RCV Report the receive direction channels

STATUS= Value Description


PRESENT
NOT PRESENT
NOT AVAILABLE

Description: STATUS, This shall describe the operational status for the optical
channels currently in the IS state. The SCOT software controls the
transition from provisioned to operational status.
PRESENT Seen by WaveTracker
NOT PRESENT Not seen by WaveTracker
NOT AVAILABLE WaveTracker data not available

CHANNEL= Value Description


{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170, NONE}

Description: CHANNEL, Channel Frequency. Specifies the channel for the


WaveTracker parameters DEVPOWER, POWER, and
TOLPOWER. A value of NONE means the channel frequency is
not provisioned.

AINSTMR= Value Description


{{00-96}-{00-59}}

2242 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

Description: AINSTMR, Transition soak time out of AINS. Format is


HOURS-MINUTES. Setting this value will cause AINSREF to be
set to OVRD. Maximum time is 96-00.

AINSCNTDWN= Value Description


{{00-96}-{00-59}}

Description: AINSCNTDWN, Time remaining to transition out of AINS. Format


is HOURS-MINUTES. Maximum time is 96-00.

AINSREF= Value Description


SYSTEM
OVRD

Description: AINSREF, Indicates the reference timer used for automatic


in-service transition.
SYSTEM Use the system level timer
OVRD Override of the system level timer

OUTPOWER= Value Description


<numerical value>

Description: OUTPOWER, Measured egress power (dBm).

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if it


contains non- alphanumeric characters.

MODULETYPE= Value Description


AUTO
USER
fVOA
sVOA

Description: MODULETYPE, Specifies the Signal and SFP type for the VA port.
AUTO Auto detect SFP type
USER User defined SFP
fVOA Fast VOA
sVOA Slow VOA

1830PSS R3.6.50 - TL1 Commands and Messages 2243


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH
The sVOA Module type only appies to 11QPA4,11DPM12 and
11DPE12, 11DPE12E.
The USER Module type does not appies to 11QPA4,
11DPE12,11DPE12E,11DPM12 and 4DPA4
<specific-type>

EXPOUTPOWER= Value Description


{-20.00 to -5.5}4DPA4, 11QPA4, and
11DPE12 packs
{-17.00 to +1.7} 112SCX10, 112SX10L,
112SCA1, 112SA1L packs
{-17.00 to +1.7} 112SCX10, 112SX10L,
112SCA1, 112SA1L, 112SNX10,
112SNA1 packs
{-17.00 to -1.3} 43SCX4 pack
{-17.00 to -1.3} 43SCX4L packs
{-20.00 to +4.00} All Other OT Packs

Description: EXPOUTPOWER, The expected channel output power


provisioned at the addressed WaveTracker encoder for OT line
ports, the SVAC A and B ports, or the MVAC G(1-8) ports.

WK1= Value Description


{integer in range 0<WK1<4096}

Description: WK1, The first WavelengthTracker key.

WK2= Value Description


{integer in range 0<WK2<4096}

Description: WK2, The second WavelengthTracker key.

CALCMODE= Value Description


{AUTO, MANUAL}

Description: CALCMODE, Operating mode for the OPSA switch threshodl


calculations.

SWTHRESH= Value Description


{-30.00 to +5.00}

Description: SWTHRESH, Switching threshold for the OPSA A and B ports.


Only settable if the CALCMODE is MANUAL.

2244 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OCH Issue 1, December 2011

SWTOL= Value Description


{0 to 5.00}

Description: SWTOL, Switching threshold tolerance for the OPSA A and B


ports. Only settable if the CALCMODE is MANUAL.

VOAATTEN= Value Description


{0 to 20.0, -1}

Description: VOAATTEN, Specifies the attenuation value for the VOA in the
egress direction of the OPSA A and B ports. A value of -1 sets the
VOA to maximum attentuation. Only settable if the optical line is in
manual power managed mode, refer to ED-PWRMGMT-TYPE
command.

PST Value Description


{IS-NR, OOSAU-MA}

Description: PST, Primary State


IS-NR In Service, Normal
OOS-AUMA Out of Service, Autonomous and
Management

SST Value Description


AINS
FAF
FLT
MT
SGEO
UAS

Description: SST, Secondary State


AINS Automatic In-Service
FAF Facility Failure
FLT Port Failure
MT Maintenance
SGEO Supporting Entity Outage
UAS Unassigned

1830PSS R3.6.50 - TL1 Commands and Messages 2245


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OCH
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a RTRV-OCH command.

RTRV-OCH:NODE-1:ALPHG-2-5-LINE-9560:789012;
IP 789012
<
NODE-1 1998-10-26 16:42:11
M 789012 COMPLD
"ALPHG-2-5-LINE-9560:ALPHG:POWER=2.0, DEVPOWER=5, TOLPOWER=2,
DIRN=TRMT, STATUS=PRESENT, OUTPOWER=1.8, DESCR=\"\", WK1=1200,
WK2=1400"
/* RTRV-OCH */
;

RELATED COMMANDS
DLT-OCH
ED-OCH
ENT-OCH
RMV-OCH
RST-OCH

RELATED AUTONOMOUS RESPONSES


none

2246 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ODU0


Command Name: RTRV-ODU0

PURPOSE
The RTRV-ODU0 command is used to retrieve all parameters related to the non-terminated ODU0
tributary for specified ODU0 facility.
The ODU0 object entity shall be automatically created on the line side by the system when the Line
port has prvsioned by ODU2.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ODU0:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2247


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU0
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>:: [TRCCMP=<value>][,EXP_SAPI
=<value>][,INC_SAPI=][,TIMMRESP=<value>][,TRCSTATUS=][,PST=]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU0 on 11DPM12 line
ODU0#{1-8} ports)

Description: Access Identifier, specifies an access Identifier to the OT client or


line port.

TRCCMP= Value Description


{ENABLED , DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

2248 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU0 Issue 1, December 2011

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel Incoming TTI, Actual incoming Source Access


Point Identifier (RX_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

PST= Value Description


{IS,OOS}

1830PSS R3.6.50 - TL1 Commands and Messages 2249


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU0
Description: Admin State, specifies the admin state to
which the facility is set. In Client side, under IS,
LO ODU alarm will report if cross-connect exists and
there is alarm. In Line side, under IS, LO ODU alarm
will report if alarm exist regardless the present of
cross-connect. OOS will suppress the LO ODU alarm
reporting.
IS In Service
OOS Out Of Service
It only applies to 11DPM12 Line port Low Order ODUk.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a RTRV-ODU0 command on the line of a
11DPM12 OT:

RTRV-ODU0:NODE-1:11DPM12 -1-5-L1-ODU2ODU0#1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11DPM12 -1-5-L1-ODU2ODU0#1:: EXP_SAPI=ABCDEF, INC_SAPI=ABCDEDF,
TRCCMP=ENABLED,TIMMRESP=DISABLED, TRCSTATUS= NORMAL,PST=IS"
;

RELATED COMMANDS
ED-ODU0

RELATED AUTONOMOUS RESPONSES


None

2250 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ODU1


Command Name: RTRV-ODU1

PURPOSE
The RTRV-ODU1 command shall be used to retrieve all parameters related to the ODU1 port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ODU1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODU1 on 11DPM12 line
ODU1#{1-8} ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (High Order ODU1 on 11DPM12 client
ODU1 ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 2251


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU1
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[ PLDTYPE=<value>][,TX_SAPI=<value>][,EXP_SAPI
=<value>][,INC_SAPI=][,
TRCCMP=<value>][,TRCSTATUS=][,TIMMRESP=<value>][,PTMMRESP=<value>][,
ODU0INTERWK=][,PST=]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

PLDTYPE= Value Description


<0-255> decimal format

Description: Payload Type (PT) field content of a Payload Structure Identifier


(PSI) of the OTUk structure. PLDTYPE defaults to 128 (0x80)
regardless of client signal type. The value 128 (0x80) indicates a
proprietary mixture of sub-ODU1 signals. PLDTYPE should be set
manually to 32 (0x20) when ODU0INTERWK parameter is
enabled. It can be set to other values if desired, assuming the
other end is set to be the same.
This parameter applies only to 4DPA4 line AID. It does not apply
to the 11STMM10 client AID.

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail

2252 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU1 Issue 1, December 2011

Trace Identifier shall follow the format defined in ITU-T G.709,


Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (i.e., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
TX_SAPI is not applicable to 11STMM10 client ports.

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel incoming TTI, Incoming TTI message Source


Access Point Identifier (RX_SAPI). Trail trace is supported on both
OTUk Section Monitoring as well as ODUk Path Monitoring levels
TTI is monitored and compared with the provisioned expected
value. A Trail Trace Mismatch alarm is reported if they do not
match.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The status of this value is contained in the parameter
"TRCSTATUS".

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

1830PSS R3.6.50 - TL1 Commands and Messages 2253


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU1

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output, applies only to
the line side.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

PTMMRESP= Value Description


{ENABLED,DISABLED}

Description: ODU2 Payload Type Mismatch Response. This parameter


determines whether an OT will take a Consequent Action or pass
the received signal monitoring, applies only to the line side.
ENABLED
DISABLED
This parameter does not apply to the 11STMM10 client AID.

2254 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU1 Issue 1, December 2011

ODU0INTERWK= Value Description


{ENABLED,DISABLED}

Description: ODU0 Interworking. ODU0INTERWK refers to whether standard


ODU0 Interworking is used (ENABLED or DISABLED). When
ODU0INTERWK=DISABLED, ODU1 Payload Type (PT) should be
set to 0x80 and there is proprietary encoding of OPTS OH in the
PSI bytes and LosProp in APS/PCC bytes. The 4DPA4 OT can
then interwork at 2xODU0 only with another 4DPA4 OT. When
ODU0INTERWK=ENABLED, the ODU1 PT should be set to 0x20
(ODU multiplex structure), and there is no proprietary use of PSI or
APS/PCC bytes. The 4DPA4 OT can then interwork with standard
2xODU0 equipment.
ENABLED
DISABLED
This parameter does not apply to the 11STMM10 client AID.

PST= Value Description


{IS,OOS}

Description: Admin State, specifies the admin state to


which the facility is set. In Client side, under IS,
LO ODU alarm will report if cross-connect exists and
there is alarm. In Line side, under IS, LO ODU alarm
will report if alarm exist regardless the present of
cross-connect. OOS will suppress the LO ODU alarm
reporting.
IS In Service
OOS Out Of Service
It only applies to 11DPM12 Line port Low Order ODUk.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2255


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU1
EXAMPLES

The following example shows the successful execution of a RTRV-ODU1


command for a line AID on the 4DPA4 OT.
RTRV-ODU1:NODE-1:4DPA4-1-5-L1-1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"4DPA4-1-5-L1-1::TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,
INC_SAPI=ABCDEDFHIJKLMNO, TRCCMP=ENABLED,TIMMRESP=DISABLED,
TRCSTATUS= PTMMRESP=DISABLED,PLDTYPE=2, ODU0INTERWK=DISABLED"
;

The following example shows the successful execution of a RTRV-ODU1


command for a client AID on a 11STMM10 OT.
RTRV-ODU1:NODE-1:11STMM10-1-5-C1-1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STMM10-1-5-C1-1::TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO
, INC_SAPI=ABCDEFGHIJKLMNO, TRCCMP=ENABLED, TRCSTATUS=NORMAL,
TIMMRESP=DISABLED"
;

RELATED COMMANDS
ED-ODU1

RELATED AUTONOMOUS RESPONSES


none

2256 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ODU2


Command Name: RTRV-ODU2

PURPOSE
The RTRV-ODU2 command shall be used to retrieve all parameters related to the ODU2 port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ODU2:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

1830PSS R3.6.50 - TL1 Commands and Messages 2257


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU2
Default: Entry Required
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[ MAPPINGMODE=<value>][, TX_SAPI=<value>][, EXP_SAPI
=<value>][,INC_SAPI=<value>][, TRCCMP=<value>][,TRCSTATUS=<value>][,
TIMMRESP=<value>][, PTMMRESP=<value>][, PLDTYPE=<value>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)

2258 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU2 Issue 1, December 2011

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

MAPPINGMODE= Value Description


{BITSYNC,ASYNC}

Description: ODUkP to CBRx mapping mode. This parameter indicates the


mapping mode that will be used when the client port signaltype is
provisioned to OC192_STM64, or 10GBE_WAN.
BITSYNC bit synchronous CBR mapping per definition in
Section 17.1 of ITU-T G.709 recommendation.
ASYNC mapping mode indicates asynchronous CBR
mapping per definition in Section 17.1 of ITU-T
G.709 recommendation
This paramter does not apply to the 11STMM10 OT.
This paramter does not apply to the 112SX10L OT.
This paramter does not apply to the 112SCX10 OT.
This paramter does not apply to the 112SNX10 OT.
This paramter does not apply to the 43SCX4L OT or 43SCX4 OT.
The parameter does not apply to 11QPA4 and 11QTA4 client side.
The parameter does not apply to 11DPE12 and 11DPE12E line
side.
The parameter does apply to 11DPE12 and 11DPE12E line
side.but the value of the mapping mode only can be bitsyc.
The parameter apply to 11QPA4 and 11QTA4 line side

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (i.e., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
This parameter does not apply to the 112SX10L client AID.
This parameter does not apply to the 112SCX10 client AID.
This parameter does not apply to the 112SNX10 client AID.
This parameter does not apply to the 43SCX4L or 43SCX4 client
AID.

1830PSS R3.6.50 - TL1 Commands and Messages 2259


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU2
The parameter does not apply to the 11QPA4 and 11QTA4 client
side

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel incoming TTI, Incoming TTI message Source


Access Point Identifier (RX_SAPI). Trail trace is supported on both
OTUk Section Monitoring as well as ODUk Path Monitoring levels
TTI is monitored and compared with the provisioned expected
value. A Trail Trace Mismatch alarm is reported if they do not
match.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The status of this value is contained in the parameter
"TRCSTATUS".

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.

2260 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU2 Issue 1, December 2011

UNAVAILABLE No value could be obtained by the


system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output, applies only to
the line side.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection
The TIMMRESP parameter does not apply to the 112SX10L client
AID.
The TIMMRESP parameter does not apply to the 112SCX10 client
AID.
The TIMMRESP parameter does not apply to the 112SNX10 client
AID.
The TIMMRESP parameter does not apply to the 43SCX4L or
43SCX4 client AID.
The TIMMRESP paramter does not apply for the 11QPA4 and
11QTA4 client AID.

PTMMRESP= Value Description


{ENABLED,DISABLED}

Description: ODU2 Payload Type Mismatch Response. This parameter


determines whether an OT will take a Consequent Action or pass
the received signal monitoring, applies only to the line side.
ENABLED
DISABLED

1830PSS R3.6.50 - TL1 Commands and Messages 2261


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU2

PLDTYPE= Value Description


<0-255> decimal format

Description: Payload Type (PT) field content of a Payload Structure Identifier


(PSI) of the OTUk structure. PLDTYPE has a default value and is
based on the encoded client signal, applies only to the line side. If
no client signal is provisioned then the NULL (decimal 253) value
is used.
PLDTYPE only applies when the client signal is not an OTM0.2
signal.
In order to facilitate interworking with non compliant PT values, it
shall be possible to provision the payload type to a different value
in decimal format The following table shall be used for the default
values.
MSB LSB Hex code Decimal Interpretation
1234 5678 Format
1111 1101 FD 253 NULL- No client signal
0000 0010 02 2 Asynchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0011 03 3 Bit synchronous CBR mapping
10G WAN PHY/OC192/STM64 10.709Gb/s
0000 0101 05 5 GFP mapping (standard)
10G LAN PHY GFP-F 10.709Gb/s
0001 0100 20 32 ODUk multiplexed structure
1000 xxxx 80-8F 128-143 Reserved codes for proprietary use
" " 80 128 10GbE LAN PHY Proprietary GFP-F with
Preamble transparency 10.709Gb/s
" " 81 129 10G Fibre Channel CBR 11.27Gb/s
" " 82 130 10GbE LAN PHY- 11.049Gb/s Mode CBR
" " 83 131 10GbE LAN PHY- 11.096Gb/s Mode CBR

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

2262 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU2 Issue 1, December 2011

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-ODU2


command for a line AID on the 11STAR1 OT.
RTRV-ODU2:NODE-1:11STAR1-1-5-L1-1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STAR1-1-5-L1-1::MAPPINGMODE=ASYNC,
TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,INC_SAPI=ABCDEFGHIJ
KLMNO,TRCCMP=ENABLED,TRCSTATUS=NORMAL,TIMMRESP=DISABLED,PTMMRESP=DIS
ABLED,PLDTYPE=2"
;

The following example shows the successful execution of a RTRV-ODU2


command for a line AID on a 11STMM10 OT.
RTRV-ODU2:NODE-1:11STAR1-1-5-L1-1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11STAR1-1-5-L1-1::TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,
INC_SAPI=ABCDEFGHIJKLMNO,TRCCMP=ENABLED,TRCSTATUS=NORMAL,
TIMMRESP=DISABLED,PTMMRESP=DISABLED,PLDTYPE=3"
;

RELATED COMMANDS
ED-ODU2

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2263


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU2

2264 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ODU3


Command Name: RTRV-ODU3

PURPOSE
The RTRV-ODU3 command shall be used to retrieve all parameters related to the ODU3 port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ODU3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 2265


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU3
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[ MAPPINGMODE=<value>][, PLDTYPE=<value>][,
TX_SAPI=<value>][, EXP_SAPI =<value>][,INC_SAPI=<value>][,
TRCCMP=<value>][,TRCSTATUS=<value>][, TIMMRESP=<value>][,
PTMMRESP=<value>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

MAPPINGMODE= Value Description


{BITSYNC,ASYNC}

Description: ODUkP to CBRx mapping mode. This parameter indicates the


mapping mode that will be used when the client port signaltype is
provisioned to OC768_STM256.
BITSYNC bit synchronous CBR mapping per definition in
Section 17.1 of ITU-T G.709 recommendation.
ASYNC mapping mode indicates asynchronous CBR
mapping per definition in Section 17.1 of ITU-T
G.709 recommendation
This parameter applies only to the line AID for 43STA1P OT when
client signal is not OTU3.
This parameter applies only to the line AID for 43SCA1 OT when
client signal is not OTU3.

2266 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU3 Issue 1, December 2011

PLDTYPE= Value Description


<0-255> decimal format

Description: Payload Type (PT) field content of a Payload Structure Identifier


(PSI) of the OTUk structure. PLDTYPE has a default value and is
based on the encoded client signal, applies only to the line side. If
no client signal is provisioned then the NULL (decimal 253) value
is used.
Restriction: PLDTYPE is not applicable for 43STA1P
OT.
Restriction: PLDTYPE is not applicable for 43SCX4 OT
when OPRMODE=REGEN

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (i.e., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
Restriction: TX_SAPI is not applicable for 43SCX4 OT
when OPRMODE=REGEN

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel incoming TTI, Incoming TTI message Source


Access Point Identifier (RX_SAPI). Trail trace is supported on both

1830PSS R3.6.50 - TL1 Commands and Messages 2267


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU3
OTUk Section Monitoring as well as ODUk Path Monitoring levels
TTI is monitored and compared with the provisioned expected
value. A Trail Trace Mismatch alarm is reported if they do not
match.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The status of this value is contained in the parameter
"TRCSTATUS".

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

2268 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU3 Issue 1, December 2011

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output, applies only to
the line side.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection
Restriction: TIMMRESP is not applicable for 43SCX4
OT when OPRMODE=REGEN

PTMMRESP= Value Description


{ENABLED,DISABLED}

Description: ODU3 Payload Type Mismatch Response. This parameter


determines whether an OT will take a Consequent Action or pass
the received signal monitoring, applies only to the line side.
ENABLED
DISABLED
Restriction: PTMMRESP is not applicable for 43SCX4
OT when OPRMODE=REGEN

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2269


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU3
EXAMPLES

The following example shows the successful execution of a RTRV-ODU3


command for a line AID on the 43STX4 OT.
RTRV-ODU3:NODE-1:43STX4-1-5-L1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"43STX4-1-5-L1::TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,
INC_SAPI=ABCDEFGHIJKLMNO, TRCCMP=ENABLED, TRCSTATUS=NORMAL,
TIMMRESP=DISABLED,PTMMRESP=DISABLED,PLDTYPE=20"
;

RELATED COMMANDS
ED-ODU3

RELATED AUTONOMOUS RESPONSES


none

2270 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ODU4


Command Name: RTRV-ODU4

PURPOSE
The RTRV-ODU4 command shall be used to retrieve all parameters related to the ODU4 port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ODU4:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 2271


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU4
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[, PLDTYPE=<value>][, TX_SAPI=<value>][, EXP_SAPI
=<value>][,INC_SAPI=<value>][, TRCCMP=<value>][,TRCSTATUS=<value>][,
TIMMRESP=<value>][, PTMMRESP=<value>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Description: Access Identifier, specifies an access Identifier to the OT (client,


line) port.

PLDTYPE= Value Description


<0-255> decimal format

Description: Payload Type (PT) field content of a Payload Structure Identifier


(PSI) of the OTUk structure. PLDTYPE has a default value and is
based on the encoded client signal, applies only to the line side. If
no client signal is provisioned then the NULL (decimal 253) value
is used.

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail

2272 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU4 Issue 1, December 2011

Trace Identifier shall follow the format defined in ITU-T G.709,


Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (i.e., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel incoming TTI, Incoming TTI message Source


Access Point Identifier (RX_SAPI). Trail trace is supported on both
OTUk Section Monitoring as well as ODUk Path Monitoring levels
TTI is monitored and compared with the provisioned expected
value. A Trail Trace Mismatch alarm is reported if they do not
match.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The status of this value is contained in the parameter
"TRCSTATUS".

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

1830PSS R3.6.50 - TL1 Commands and Messages 2273


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU4

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output, applies only to
the line side.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

PTMMRESP= Value Description


{ENABLED,DISABLED}

Description: ODU4 Payload Type Mismatch Response. This parameter


determines whether an OT will take a Consequent Action or pass
the received signal monitoring, applies only to the line side.
ENABLED
DISABLED

2274 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODU4 Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-ODU4


command for a line AID on the 112SCX10 OT.
RTRV-ODU4:NODE-1:112SCX10-1-5-L1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD

"112SCX10-1-5-L1::TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,
INC_SAPI=ABCDEFGHIJKLMNO, TRCCMP=ENABLED, TRCSTATUS=NORMAL,
TIMMRESP=DISABLED,PTMMRESP=DISABLED,PLDTYPE=20"
;

RELATED COMMANDS
ED-ODU4

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2275


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODU4

2276 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ODUF


Command Name: RTRV-ODUF

PURPOSE
The RTRV-ODUF command is used to retrieve all parameters related to the non-terminated ODUFlex
tributary for specified ODUFlex facility.
The ODUFlex object entity shall be automatically created on the line side by the system when the Line
port has provisioned LO(low order) ODUk sub-structure on ODU2.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ODUF:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2277


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODUF
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr l
^^^"<AID>::[TRCCMP=<value>] [,EXP_SAPI
=<value>][,INC_SAPI=][,TIMMRESP=<value>][,TRCSTATUS=][,PST=]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (Low Order ODUflex on 11DPM12 line
ODUF#{1-8} ports)

Description: Access Identifier, specifies an access Identifier to the ODUF entity.

TRCCMP= Value Description


{ENABLED , DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

2278 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODUF Issue 1, December 2011

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel Incoming TTI, Actual incoming Source Access


Point Identifier (RX_SAPI).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel upon detection of an
optical channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

PST= Value Description


{IS,OOS}

1830PSS R3.6.50 - TL1 Commands and Messages 2279


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODUF
Description: Admin State, specifies the admin state to
which the facility is set. In Client side, under IS,
LO ODU alarm will report if cross-connect exists and
there is alarm. In Line side, under IS, LO ODU alarm
will report if alarm exist regardless the present of
cross-connect. OOS will suppress the LO ODU alarm
reporting.
IS In Service
OOS Out Of Service
It only applies to 11DPM12 Line port Low Order ODUk.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a RTRV-ODUF command on the line of a
11DPM12 OT:

RTRV-ODUF:NODE-1:11DPM12 -1-5-L1-ODU2ODUF#1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"11DPM12 -1-5-L1-ODU2ODUF#1:: EXP_SAPI=ABCDEF, INC_SAPI=ABCDEDF,
TRCCMP=ENABLED,TIMMRESP=DISABLED, TRCSTATUS= NORMAL,PST=IS"
;

RELATED COMMANDS
ED-ODUF

RELATED AUTONOMOUS RESPONSES


None

2280 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-ODUPTF


Command Name: RETRIEVE LOGICAL FACILITY ODUPTF
TERMINATION ENTITY.

PURPOSE
The RTRV-ODUPTF command shall be used to retrieve all parameters related to the ODUPTF
instance.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-ODUPTF:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 clietn
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)

Default: Entry Required


Addressing: None
Description: Access Identifier, specifies an access Identifier of the ODU pool.

1830PSS R3.6.50 - TL1 Commands and Messages 2281


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODUPTF

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[PLDTYPE=<value>][,TX_STRUCT=<value>][,EXP_STRUCT=<value>
][,INC_STRUCT=<value>][,PTMMRESP=<value>][, TX_SAPI =<value>]
[,EXP_SAPI=<value>]
[,INC_SAPI=<value>][,TRCSTATUS=<value>][,TRCCMP=<value>][,TIMMRESP=<
value>][,ODU0INTERWK=<value>][,PST=<value>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<SessionNumber>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPM12-<shelf>-<slot>-ODU1PTF{1- (Virtual ODU1 entity for 11DPM12
8} connection plane)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU1 on 11DPM12 client
1 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODU0 on 11DPM12 client
0 ports)
11DPM12-<shelf>-<slot>-C{1-12}-ODU (Low Order ODUflex on 11DPM12 client
F ports)
11DPM12-<shelf>-<slot>-L{1-2}-ODU2 (ODU2 on 11DPM12 line ports)

Description: Access Identifier, specifies an access Identifier of the ODU pool.

PLDTYPE= Value Description


<0-255> decimal value

Description: Payload Type(PT) field content of a Payload Structure Identifier


(PSI) of the OTUk structure.

2282 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODUPTF Issue 1, December 2011

When it applies to ODU1PTF{1-8} on 11DPM12,ODU1


PLDTYPE could be set to 0x80 (decimal 128) and there
is proprietary encoding of OPTS OH in PSI bytes and
LosProp in APS.
For standard 2xODU0 equipment ODU1 PLDTYPE could be
set to 0x20 (ODU multiplex structure).
When it applies to 11DPM12-<shelf>-<slot>-L{1-2}-ODU2,
0x21 indicate a GMP capable multiplexed ODUk
structure.
0x20 indicate interworking with legacy 4xODU1 to ODU2
equipment.
This parameter does not applied to
11DPM12-<shelf>-<slot>-C{1-12}-ODU0,
11DPM12-<shelf>-<slot>-C{1-12}-ODU1.
The value 128 (0x80) indicates a proprietary mixture of sub-ODU1
signals.

TX_STRUCT= Value Description


< 0-400 VALID HOSTRUCT
ALPHANUMERICAL CHARACTERS >

Description: TX_STRUCT specifies the structure of the transmitting Time-slot


Map.

EXP_STRUCT= Value Description


< 0-400 VALID HOSTRUCT
ALPHANUMERICAL CHARACTERS >

Description: EXP_STRUCT specifies the structure of the expected Time-slot


Map

INC_STRUCT= Value Description


< 0-400 VALID HOSTRUCT
ALPHANUMERICAL CHARACTERS >

Description: INC_STRUCT specifies the structure of the incoming Time-slot


Map

PTMMRESP= Value Description


{ENABLED,DISABLED}

Description: Payload Type Mismatch Response. This


parameter determines whether an OT will take a
Consequent Action or pass the received signal.
ENABLED Enabled
DISABLED Disabled

1830PSS R3.6.50 - TL1 Commands and Messages 2283


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODUPTF

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI).

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected incoming Trail Trace Identifier (TTI),


Expected incoming Source Access Point Identifier (TX_SAPI).

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel actual incoming Trail Trace Identifier (TTI), Actual
incoming Source Access Point Identifier (TX_SAPI).

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TRCCMP= Value Description


{ENABLED,DISABLED}

2284 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-ODUPTF Issue 1, December 2011

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).

TIMMRESP= Value Description


{ENABLED, DISABLED}

Description: Optical Channel Path Trace Identifier


Mismatch Response. This parameter determines whether
an OT will take a Consequent Action (or pass the
received optical channel upon detection of an optical
channel path trace mismatch at its input.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

ODU0INTERWK= Value Description


{ENABLED,DISABLED}

Description:ODU0 Interworking. ODU0INTERWK refers to


whether standard ODU0 Interworking is used (ENABLED or
DISABLED). When ODU0INTERWK=DISABLED, ODU1 Payload
Type (PT) should be set to 0x80 and there is
proprietary encoding of OPTS OH in the PSI bytes and
LosProp in APS/PCC bytes. The 11DPM12 OT can then
interwork at 2xODU0 only with another 4DPA4 OT. When
ODU0INTERWK=ENABLED, the ODU1 PT should be set to 0x20
(ODU multiplex structure), and there is no proprietary
use of PSI or APS/PCC bytes. The 11DPM12 OT can then
interwork with standard 2xODU0 equipment.
ENABLED Enabled
DISABLED Disabled
It only applies to AID for
11DPM12-<shelf>-<slot>-ODU1PTF{1-8}.

PST= Value Description


{IS,OOS}

1830PSS R3.6.50 - TL1 Commands and Messages 2285


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-ODUPTF
Description:Admin State, specifies the admin state to
which the facility is set. OOS will suppress the
ODUPTF alarm reporting.
IS In Service
OOS Out Of Service

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful response of retrieval of


ODU1PTF on 11DPM12 OT:
RTRV-ODUPTF:NODE-1: 11DPM12-1-7- ODU1PTF2;

^^^NODE-1^05-23-09^17:35:03
M^789012^COMPLD
“11DPM12-1-7- ODU1PTF2::PLDTYPE=128,
TX_STRUCT=”1-1,3,5,7,9,11,13,15”,
EXP_STRUCT=”1gbe#1-1,3,5,7,9,11,13,15”,
INC_STRUCT=”1gbe#1-1,3,5,7,9,11,13,15”, PTMMRESP=DISABLED,
TX_SAPI=ABCD, EXP_SAPI=ABCD, INC_SAPI=123, TRCCTATUS=MISMATCH,
TRCCMP=ENABLED, TIMMRESP=ENABLED, ODU0INTERWK=ENABLED:PST=IS”
;

RELATED COMMANDS
ED-ODUPTF

RELATED AUTONOMOUS RESPONSES


none

2286 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OPT-INTRUSION


Command Name: RETRIEVE OPTICAL INTRUSION

PURPOSE
The RTRV-OPT-INTRUSION command is used to retrieve the parameters used for Optical Intrusion
Monitoring: OptBaseline, OptIntLoss, PollPeriod, and LossOfSpan values, and also whether intrusion
monitoring is turned on or off.

INPUT FORMAT

RTRV-OPT-INTRUSION:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALPHG-<shelf>-<slot>-LINE (ALPHG LINE Port)
AHPHG-<shelf>-<slot>-LINE (AHPHG LINE Port)
AHPLG-<shelf>-<slot>-LINE (AHPLG LINE Port)
ALPFGT-<shelf>-<slot>-LINE (ALPFGT LINE Port)
A2325A-<shelf>-<slot>-LINE (A2325A LINE Port)
AM2017B-<shelf>-<slot>-LINE (AM2017B LINE Port)
AM2325B-<shelf>-<slot>-LINE (AM2325B LINE Port)
AM2125A-<shelf>-<slot>-LINEIN (AM2125A LINEIN Port)
AM2125B-<shelf>-<slot>-LINEIN (AM2125B LINEIN Port)
AM2318A-<shelf>-<slot>-LINEIN (AM2318A LINEIN Port)
OSCT-<shelf>-<slot>-LINE (OSCT LINE Port)

Default: <entry required>


Addressing: None
Description: Access Identifier, specifies an access Identifier to the LD.

1830PSS R3.6.50 - TL1 Commands and Messages 2287


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OPT-INTRUSION

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[DETECTION=<value>][,BASELINE=<value>][,THRESHOLD=<value>
][,POLLPERIOD=<value>][,SPANLOSS=<value>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


ALPHG-<shelf>-<slot>-LINE (ALPHG LINE Port)
AHPHG-<shelf>-<slot>-LINE (AHPHG LINE Port)
AHPLG-<shelf>-<slot>-LINE (AHPLG LINE Port)
ALPFGT-<shelf>-<slot>-LINE (ALPFGT LINE Port)
A2325A-<shelf>-<slot>-LINE (A2325A LINE Port)
AM2017B-<shelf>-<slot>-LINE (AM2017B LINE Port)
AM2325B-<shelf>-<slot>-LINE (AM2325B LINE Port)
AM2125A-<shelf>-<slot>-LINEIN (AM2125A LINEIN Port)
AM2125B-<shelf>-<slot>-LINEIN (AM2125B LINEIN Port)
AM2318A-<shelf>-<slot>-LINEIN (AM2318A LINEIN Port)
OSCT-<shelf>-<slot>-LINE (OSCT LINE Port)

Description: Access Identifier, specifies an access Identifier to the LD.

DETECTION= Value Description


ON
OFF

Description: Specifies if Optical Intrusion Monitoring is enable or disable.

2288 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OPT-INTRUSION Issue 1, December 2011

BASELINE= Value Description


Integer number in the range [1, 50] or
(-1).

Description: Specifies the baseline span loss value (in dB) that is used in
optical intrusion monitoring. If a baseline has not been set, then the
value of BASELINE is (-1).

THRESHOLD= Value Description


Real number in the range [1, 5] in
increments of 0.5 .

Description: Specifies the allowed deviation (in dB) from the baseline span loss.
If detection is set to on, and the deviation from the baseline span
loss is greater than or equal to the threshold value, then the
Optical Intrusion Detected alarm is raised.

POLLPERIOD= Value Description


Integer number in the range [20, 120]

Description: Specifies the polling period (in seconds) for optical intrusion
monitoring. The span loss is measured and compared with the
baseline once every pollperiod.

SPANLOSS= Value Description


Integer number in the range [0, 99]

Description: Specify the most recently measured span loss in dB.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2289


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OPT-INTRUSION
EXAMPLES
The following example shows the successful execution of an RTRV-OPT-INTRUSION command.

RTRV-OPT-INTRUSION:NODE-1:ALPHG-2-5-LINE:789012;
IP 789012
<
NODE-1 1998-10-26 16:42:11
M 789012 COMPLD
"ALPHG-2-5-LINE::DETECTION=ON, BASELINE=20, THRESHOLD=1.5,
POLLPERIOD=30, SPANLOSS=21"
/* RTRV-OPT-INTRUSION:NODE-1:ALPHG-2-5-LINE:789012;*/
;

RELATED COMMANDS
SET-OPT-INTRUSION

RELATED AUTONOMOUS RESPONSES


None

2290 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OSPF-AREA


Command Name: RETRIEVE OSPF AREA

PURPOSE
The RTRV-OSPF-AREA command retrieves the parameters of a configured OSPF Area that the NE is
part of. The NE can be part of up to 3 OSPF areas, in addition to the default backbone area (0-0-0-0).
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OSPF-AREA:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


OSPFAREA-{0-3} (OSPF Areas)
ALL (ALL AID)

Default: <ALL>
Addressing: None
Description: Access Identifier, specifies an access identifier for an OSPF area

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2291


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF-AREA
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>::AREAID=<value>,AREATYPE=<value>,OPQLSADNS=<value>,OPQLSA
WAVKEY=<value>,NSSATRANSLATE=<value>,STUBDFTMTC=<value>,VIRTUALLINK=
<value>" cr lf ]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


OSPFAREA-{0-3} (OSPF Areas)

Description: Access Identifier, specifies an access identifier for an OSPF area

AREAID= Value Description


{0-255}-{0-255}-{0-255}-{1-254}

Description: Area ID, an IP address that uniquely identifies the OSPF area. The
area 0-0-0-0 is reserved for the OSPF backbone. Area ID of the
OSPF Area. This ID has the format of an IP Address. The ID
0-0-0-0 is not allowed since the backbone area always exists and
is automatically enabled or disabled. OSPFID is like IP address but
is not an IP address and hence does not have any restrictions.

AREATYPE= Value Description


NORM
STUB
TOTALLY_STUB
NSSA
NSSA_TOTALLY_STUB

Description: Specifies an OSPF area type:

normal areas are defined as areas that can accept


intra-area, inter-area and external routes.

stub areas do not accept routes belonging to external autonomous


systems (AS); however, these areas have inter-area and intra-area
routes. This reduces the size of the routing databases for the

2292 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OSPF-AREA Issue 1, December 2011

area's internal routers. Routers in the stub area also contain a


default route which is advertised
nssa (Not So Stub Areas) can import AS external routes from
within the area and send them to other areas, but cannot receive
AS external routes from other areas. Inter-area and intra-area
routes are allowed along with a default route which is advertised to
the area by the ABR..

totally_stub areas do not allow routes other than intra-area and


the default route to be propagated within the area. This further
reduces the size of the routing databases for the area's internal
routers. The ABR advertises a default route into the area and all
the routers belonging to this area use the default route to send any
traffic outside the area.
nssa_totally_stub areas are similar to nssa with the added
restriction that inter-area routes are not allowed.

OPQLSADNS= Value Description


{Y, N}

Description: Opaque LSA status for the DNS


application. Determines, whether opaque
LSAs for the DNS application shall be distributed
into this OSPF area, and received from this area. DNS
opaque LSAs can only be enabled in one OSPF Area.

Y DNS opaque LSAs are distributed to the area, and


received from the area
N DNS opaque LSAs are not distributed to the area,
and not received from the area

OPQLSAWAVKEY Value Description


=
{Y, N}

1830PSS R3.6.50 - TL1 Commands and Messages 2293


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF-AREA
Description: Opaque LSA status for the Wave KEY
application. Determines, whether opaque
LSAs for the Wave KEY application shall be
distributed into this OSPF area, and received from
this area.
Wave Key opaque LSAs can only be enabled in one OSPF
Area.

Y Wave KEY opaque LSAs are distributed to the


area, and received from the area
N Wave KEY opaque LSAs are not distributed to the
area, and not received from the area

NSSATRANSLATE Value Description


=
CANDIDATE
ALWAYS
NEVER

Description: Applicable only if area type is nssa.


Determines behavior of NSSA ABR router translation of
internal area type 7 LSAs to type 5 LSAs which get
propagated into other areas.
- candidate OSPF ospf elects one of candidate routers
to be a translator for this area.
- always router will be always used as translator for
this area
- never router will never be used as translator for
this area
Default: candidate

STUBDFTMTC= Value Description


{0-16777215}

Description: Applicable only for stub, nssa type areas. Specifies the cost for
the default route originated by stub, nssa area ABR.

VIRTUALLINK= Value Description


Specify the Loopback interface IP
Address of the NE to terminate the
virtual link

2294 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OSPF-AREA Issue 1, December 2011

Description: Applicable only for normal Areas. Allows


for the creation of a virtual link for this area..
OSPF requires that all areas attach directly to Area
0.0.0.0, but the attachment need not be physical. One
can take any physical arrangement of areas and attach
them logically through OSPF virtual links. Specify
the Loopback interface IP Address of the NE to
terminate the virtual link. This NE should have an
interface that is connected to Area 0.0.0.0 and a non
0.0.0.0 Area.
Note: A virtual link must be configured on both NEs.
Virtual links can not be established through Area
0.0.0.0, stub, nssa type areas.
Note: When a virtual link is created across an OSC or GCC path,
the MTU size must be set to 1500 bytes for the OSC/GCC in
terfaces on that path.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid Access Identifier
• the specified AID is incorrect

EXAMPLES
In the following example, RTRV-OSPF-AREA retrieves the parameters for OSPFAREA-1.

RTRV-OSPF-AREA::OSPFAREA-1;

A successful response for that command would be:

1830PSS R3.6.50 - TL1 Commands and Messages 2295


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF-AREA

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD

^^^”OSPFAREA-1::AREAID=192-1-1-1,AREATYPE=NONSTUB"

/* RTRV-OSPF-AREA::OSPFAREA-1 [C0001] (5) */


;

RELATED COMMANDS
DLT-OSPF-AREA
ED-OSPF-AREA

RELATED AUTONOMOUS RESPONSES


None

2296 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OSPF-IF


Command Name: RETRIEVE OSPF PROTOCOL ADDRESS
INTERFACES

PURPOSE
The RTRV-OSPF-IF command retrieves parameters provisioned via the ED-OSPF-IFACE TL1
command. If the AID is specified, then the system shall return information only for that AID. If no AID is
specified or if the AID is ALL, then the system shall return information for all appropriate interfaces.
The following interfaces can be retrieved using this command:
• OAMP

• VOIP

• E1
• E2
• GCC

• OSC

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OSPF-IF:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2297


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF-IF

AID Value Description


USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
EC-1-<slot>-CIT (CIT port, main shelf)
FLC-1-{23,40}-{CIT, OAMP} (ports on
PSS-36 main shelf First Level Controller
MT0C-1-{11,15}-{VOIP,E1,E2} (ports
on PSS-36 main shelf Second Level
Controller)

LAN-{OAMP, CIT, VOIP, E1, E2}


(Customer LAN)

11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)
ALL (ALL AID)

Default: <ALL>
Addressing: None
Description: Access Identifier, specifies an access identifier to a USRPNL
Ethernet interface, an OSC port, or a GCC port. ALL can be used
to retrieve properties for all provisioned interfaces.

2298 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OSPF-IF Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>:STATUS=<value>,IP=<value>,AREAID=<value>,HELLOINT=<value>
,DEADINT=<value>,METRIC=<value>,RTPRIORITY=<value>,ADJSTATE=<value>,
MD5KEY=<value>,MD5KEYID=<value>,MD5ENABLE=<value>" cr lf ]*
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2299


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF-IF

AID Value Description


USRPNL-1-<slot>-OAMP (Management Interface port)
USRPNL-1-<slot>-VOIP (Voice over IP port)
USRPNL-1-<slot>-E1 (External E1 LAN IP port)
USRPNL-1-<slot>-E2 (External E2 LAN IP port)
EC-1-<slot>-CIT (CIT port, main shelf)
FLC-1-{23,40}-{CIT, OAMP} (ports on
PSS-36 main shelf First Level Controller
MT0C-1-{11,15}-{VOIP,E1,E2} (ports
on PSS-36 main shelf Second Level
Controller)

11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)

Description: Access Identifier, specifies an access identifier to a USRPNL


Ethernet interface, VOIP, OAMP, E1, E2, CIT ports, an OSC port,
or a GCC port.

STATUS= Value Description


ENABLE
DISABLE
REDISTRIBUTE

Description: The Status of the interface. This parameter is valid for only OAMP,
VoIP, E1, E2, CIT ports. REDISTRIBUTE is only applicable to LAN
AID.

2300 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OSPF-IF Issue 1, December 2011

IP= Value Description


{1-99,
102-126,128-223}-{0-255}-{0-255}-{0-25
5}

Description: Internet Protocol address, it is the IP address of the target AID.


This parameter is valid for only OAMP, VoIP, E1, E2, CIT ports.
Only OAMP port may have value 0-0-0-0.

AREAID= Value Description


{0-3}

Description: OSPF AREA ID, it is the area ID of the interface of the target AID.
This parameter is not applicable to CIT port. This parameter is
valid for all AIDs except CIT port.

HELLOINT= Value Description


{1-65535}

Description: HELLO INTERVAL of the OSPF Interface. This is the time elapsed
before the next HELLO PDU is sent. This parameter is only valid
for the CIT, OAMP, E1, E2 and VOIP ports.

DEADINT= Value Description


{1-65535}

Description: DEAD INTERVAL of the OSPF Interface. This is the time elapsed
between not hearing a router's Hello PDU before the neighbors will
declare it down. This parameter is only valid for the OAMP, E1, E2
and VOIP ports. For all other AIDs, this value is not displayed.

METRIC= Value Description


{1-65535}

Description: METRIC or Cost of the OSPF Interface. This parameter is only


valid for the OAMP, E1, E2 and VOIP ports. For all other AIDs, this
value is not displayed.

RTPRIORITY= Value Description


{0-255}

Description: Router Priority of the OSPF Interface. By default, the interface


shall be set to 1. This parameter is used on the LAN to determine
which router will become the designated router. This parameter is

1830PSS R3.6.50 - TL1 Commands and Messages 2301


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF-IF
only valid for the OAMP, E1, E2 and VOIP ports. For all other
AIDs, this value is not displayed.

ADJSTATE= Value Description


FULL
DOWN
2WAY
INIT
EXCHANGE
EXCHANGESTART
ATTEMPT

UNKNOWN
LOADING

Description: Remote NE's adjacency state. Under normal operation, the state
shall support either FULL or 2WAY, per OSPF routing protocol.
This parameter is valid for all AIDs except CIT port.

MD5KEY= Value Description


{<1-16 CHARACTERS>}

Description: Key used for MD5 128 bit hash value key calculation. The string
shall be 1 to 16 uppercase, lowercase alphanumeric characters
including NUL character. The system default value is NUL.

MD5KEYID= Value Description


{1-255}

Description: MD5Key ID used for MD5 128bit hash value key calculation.

MD5ENABLE= Value Description


Y
N

Description: Specifies if the authentication is activated (Y) or un-activated on


the OSPF area.

2302 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OSPF-IF Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IIAC Invalid Access Identifier
• the specified AID is not for one of the following ports: ALL, OAMP, VOIP, E1, E2, 11STAR1,
11STAR1A, 4DPA4, STMM10, EC, ALPHG, AHPHG, AHPLG, CIT, GCC or OSC

EXAMPLES
In the following example, RTRV-IP-IF retrieves the OAMP port information.

RTRV-OSPF-IF::USRPNL-1-40-OAMP:C0001;

A successful response for that command would be:

^^^RENO^01-02-08^08:46:59
M^^C0001^COMPLD
^^^”USRPNL-1-40-OAMP:STATUS=enable, IP=192-168-1-1,AREAID=0-0-0-0,
HELLOINT=10,DEADINT=40, METRIC=10, RTPRIORITY=5, ADJSTATE=FULL”
/* RTRV-OSPF-IF::USRPNL-1-40-OAMP:C0001 [C0001] (5) */
;

RELATED COMMANDS
ED-OSPF-IF

RELATED AUTONOMOUS RESPONSES


None

1830PSS R3.6.50 - TL1 Commands and Messages 2303


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF-IF

2304 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OSPF


Command Name: RETRIEVE OSPF PARAMETERS

PURPOSE
The RTRV-OSPF command retrieves the global OSPF parameters

The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OSPF:[TID]::[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"::ROUTERID=<value>,STATRTEXTMETRIC=<value>,
STATRTEXTMTCTYPE=<value>,DEFRTEXTMETRIC=<value>,DEFRTEXTMTCTYPE=<val
ue>" cr lf
[^^^/*^<Command^Echo>^[<CTAG>]^(<Session_Number>)*/
crlf]
;

1830PSS R3.6.50 - TL1 Commands and Messages 2305


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF
OUTPUT PARAMETERS
• ROUTERID=

{0-255}{0-255}-{0-255}-{0-255}

Description: Router ID. This is the address broadcast by the link


LSA and uniquely identifies the router in the OSPF domain.
This address can be changed via the LOOPBKIP parameter of the
ENT-IP-IF command.

STATRTEXTMETRI Value Description


C=
{0-16777214}

Description: Static Route External Metric. Determines the cost metric value to
be set in all AS-External LSAs (Type 5 LSAs), which result from
ADVERTISED non default routes, which are configured via
ENT-NE-IPRT.
STATRTEXTMTCTYPE=

{INT, EXT}

Description: Static Route External Metric Type.


Determines the metric type to be set in all
AS-External LSAs (Type 5 LSAs), which result from
ADVERTISED non default routes, which are configured
via ENT-NE-IPRT.
INT Internal metric type (metric type 1). The metric
value is assumed comparable to intra-AS metric values.
EXT External metric type (metric type 2). The metric
value is assumed higher than the path cost of any
intra-AS path.
DEFRTEXTMETRIC=

{0-16777214}
Description: Default Route External Metric.
Determines the cost metric value to be set in all
AS-External LSAs (Type 5 LSAs), which result from
ADVERTISED
default routes, which are configured via ENT-NE-IPRT.

DEFRTEXTMTCTY Value Description


PE=
{INT,EXT}

2306 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OSPF Issue 1, December 2011

Description: Default Route External Metric Type.


Determines the metric type to be set in all
AS-External LSAs (Type 5 LSAs), which result from
ADVERTISED default routes, which are configured via
ENT-NE-IPRT.
INT Internal metric type (metric type 1). The metric
value is assumed comparable to intra-AS metric values.
EXT External metric type (metric type 2). The metric
value is assumed higher than the path cost of any
intra-AS path.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

In the following example, RTRV-OSPF retrieves the OSPF parameters


RTRV-OSPF:::C0001;
A successful response would be:
^^^LASVEGAS^01-02-07^08:46:59
M^^C0001^COMPLD
^^^"::ROUTERID=143-209-110-66,STATRTEXTMETRIC=
20,STATRTEXTMTCTYPE=EXT,DEFRTEXTMETRIC=10,DEFRTEXTMTCTYPE=EXT"
/* RTRV-OSPF:::C0001 [C0001] (5) */
;

RELATED COMMANDS
ED-OSPF

RELATED AUTONOMOUS RESPONSES


None.

1830PSS R3.6.50 - TL1 Commands and Messages 2307


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OSPF

2308 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OTS


Command Name: RTRV-OTS

PURPOSE
The RTRV-OTS command is used to retrieve the parameters of an optical line. This includes the
current operating parameters of the SCOT software, AIDs of assigned circuit packs, and
characteristics of connected fiber type.

INPUT FORMAT

RTRV-OTS:[TID]:[AID]:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2309


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS

AID Value Description


ALL (ALL AID)
ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Ports)
LINE, OSC}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Ports)
DCM, OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Ports)
DCM, OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-<slot>-EXP (SFD5/8 Expansion Port)
SFC-<shelf>-<slot>-EXP (SFC2/4 Expansion Port)
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Default: ALL

2310 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTS Issue 1, December 2011

Addressing: None
Description: Access Identifier, specifies an access Identifier to the OTS.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>:[TYPEID]:[GAIN=<value>] [,MAXGAIN=<value>]
[,MINGAIN=<value>] [,TYPE=<value>] [,INPOWER=<value>]
[,SIGOUTPWR=<value>] [,OUTPWRT=<value>] [,MODULETYPE=<value>]
[,AINSTMR=<value>] [,AINSCNTDWN =<value>] [,AINSREF =<value>]
[,OUTPOWER=<value>] [,DESCR=<value>] [,DELTAGMAX=<value>]
[,DEVIATIONIN=<value>] [,DEVIATIONOUT=<value>]
[,DROPTARGETPWR=<value>] [,GAINBACKOFF=<value>] [,GAINTILT=<value>]
[,TARGETPOWER=<value>] [,TILT=<value>] [,LOSTHRESHOLD=<value>]
[,LOSTOLERANCE=<value>] [,LOSOUTTHRESHOLD=<value>]
[,LOSOUTTOLERANCE=<value>] [,AVGMUXLOSS=,<value>]
[,AVGDEMUXLOSS=<value>] [,ADDCHANNELCNT=<value>]
[,ADDDEGREECNT=<value>]
[,ADDEGRESSPWR=<value>][,MAXFLATGAIN=<value>][,TILTCALDCM=<value>]
[,CONNADDRESS=<value>] [,CONNLOSS=<value>] [,CHANPOWER=<value>]
[,CHANPOWERMON=<value>] [,OPPDIRECTION=<value>]
[,INTOOUTGAIN=<value>] [,TILTACTUAL=<value>] [,TILTTARGET=<value>]
[,INPOWERDCM=<value>] [,OUTPOWERDCM=<value>] [,OUTPOWERASE=<value>]
[,RAMFIBERTYPE=<value>] [,RAMOPRMODE=<value>]
[,VOASETTING=<value>]:[<PST>],[<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2311


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS

AID Value Description


ALPHG-<shelf>-<slot>-{DCM, SIG, (ALPHG Optical Ports)
LINE, OSC}
AHPHG-<shelf>-<slot>-{DCM, SIG, (AHPHG Optical Ports)
LINE, OSC}
AHPLG-<shelf>-<slot>-{DCM, SIG, (AHPLG Optical Ports)
LINE, OSC}
ALPFGT-<shelf>-<slot>-{SIG, LINE, (ALPFGT Managed Ports)
OSCSFP}
A2325A-<shelf>-<slot>-{DCM, SIG, (A2325A Optical Ports)
LINE, OSC}
AM2017B-<shelf>-<slot>-{SIG, LINE, (AM2017B Optical Ports)
OSC}
AM2325B-<shelf>-<slot>-{SIG, LINE, (AM2325B Optical Ports)
OSC}
AM2125A-<shelf>-<slot>-{DCM, (AM2125A Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2125B-<shelf>-<slot>-{DCM, (AM2125B Ports)
LINEIN, LINEOUT, OSC, OSCSFP}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Ports)
LINEOUT, OSC, OSCSFP}
RA2P-<shelf>-<slot>-{LINEIN, (RA2P Ports)
LINEOUT}
OSCT-<shelf>-<slot>-{SIG, LINE, OSC, (OSCT Ports)
OSCSFP}
CWR-<shelf>-<slot>-{SIG, CLS{1-8}, (CWR8/CWR8-88 NE Boundary Ports)
THRU, OMD}
WR-<shelf>-<slot>-{SIG, THRU, (WR8-88A NE Boundary Ports)
ADDIN{1-8}, DROPOUT,
MESHOUT{1-3}}
MESH-<shelf>-<slot>-{SIGIN, (MESH4 Ports)
SIGOUT{1-4}}
DCM-<shelf>-1-DCM (DCM Optical Port)
ITL-<shelf>-1-{SIG, E, O} (ITLB Optical Ports)
ITL-<shelf>-1-{SIGIN, EOUT, OOUT} (ITLU Optical Ports)
SFD-<shelf>-1-OMD (SFD44/SFD44B/SFD40/SFD40B
Mux/Demux Port)
SFD-<shelf>-<slot>-OMD (SFD5/8 Mux/Demux Port)
SFC-<shelf>-<slot>-OMD (SFC2/4/8 Mux/Demux Port)
SFD-<shelf>-<slot>-EXP (SFD5/8 Expansion Port)
SFC-<shelf>-<slot>-EXP (SFC2/4 Expansion Port)
WTOCM-<shelf>-<slot>-{IN1, IN2, IN3, (WTOCM Ports)
IN4}

Description: Access Identifier, specifies an access Identifier to the OTS.

2312 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTS Issue 1, December 2011

TYPEID Value Description


ALPHG (ALPHG Circuit Pack)
AHPHG (AHPHG Circuit Pack)
AHPLG (AHPLG Circuit Pack)
ALPFGT (ALPFGT Circuit Pack)
OSCT (OSCT Circuit Pack)
A2325A (A2325A Circuit Pack)
AM2017B (AM2017B Circuit Pack)
AM2325B (AM2325B Circuit Pack)
AM2125A (AM2125A Circuit Pack)
AM2125B (AM2125B Circuit Pack)
AM2318A (AM2318A Circuit Pack)
CWR8 (CWR8 Circuit Pack)
CWR8-88 (CWR8-88 Circuit Pack)
WR8-88A (WR8-88A Cirecuit Pack)
MESH4 (MESH4 Cirecuit Pack)
DCM (DCM Module)
ITLB (ITLB Module)
ITLU (ITLU Module)
SFD44 (SFD44 Module)
SFD44B (SFD44B Module)
SFD40 (SFD40 Module)
SFD40B (SFD40B Module)
SFD5A (SFD5A circuit pack)
SFD5B (SFD5B circuit pack)
SFD5C (SFD5C circuit pack)
SFD5D (SFD5D circuit pack)
SFD5E (SFD5E circuit pack)
SFD5F (SFD5F circuit pack)
SFD5G (SFD5G circuit pack)
SFD5H (SFD5H circuit pack)
SFD8A (SFD8A circuit pack)
SFD8B (SFD8B circuit pack)
SFD8C (SFD8C circuit pack)
SFD8D (SFD8D circuit pack)
SFC2A (SFC2A circuit pack)
SFC2B (SFC2B circuit pack)
SFC2C (SFC2C circuit pack)
SFC2D (SFC2D circuit pack)
SFC4A (SFC4A circuit pack)
SFC4B (SFC4B circuit pack)
SFC8 (SFC8 circuit pack)

1830PSS R3.6.50 - TL1 Commands and Messages 2313


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS

TYPEID Value Description


WTOCM (WTOCM Circuit Pack)

Description: TYPEID, Identifies the type of equipment on which the facility is


located.

GAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)
{7.0-24.0} (MESH4)
{0-25.0} (RA2P)

Description: GAIN, Specifies the desired gain in dB.

MAXGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)
{7.0-24.0} (MESH4)
{0-20.0} (RA2P)

Description: MAXGAIN, This parameter is used by Automatic Power


Management. Specifies the maximum gain allowed for the egress
amplifier. The gain may be set above this value but it is not
recommended.

2314 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTS Issue 1, December 2011

MINGAIN= Value Description


{10.0-30.0} (ALPHG)
{13.0-33.0} (AHPHG)
{6.0-24.0} (AHPLG, AM2017B)
{13.0-23.0} (ALPFGT)
{16.0-32.0} (A2325A, AM2325B)
{15.0-31.0} (AM2125A)
{15.0-31.0} (AM2125B)
{7.0-24.0} (AM2318A)
{7.0-24.0} (MESH4)
{0-20.0} (RA2P)

Description: MINGAIN, This parameter is used by Automatic Power


Management. Specifies the minimum gain allowed for the egress
amplifier. The gain may be set below this value but it is not
recommended.

TYPE= Value Description


OC3
100BASEFX

Description: TYPE, Specifies the Signal type for the OSCT.

INPOWER= Value Description


<numerical value>

Description: INPOWER, Measured ingress power (dBm).

SIGOUTPWR= Value Description


<numerical value>

Description: SIGOUTPWR, Measured Signal Power Egress (dBm). This is


equal to the total ingress power plus the programmed gain.

OUTPWRT= Value Description


<numerical value>

Description: OUTPWRT, Target per channel egress power (dBm).

1830PSS R3.6.50 - TL1 Commands and Messages 2315


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS

MODULETYPE= Value Description


AUTO
SS-16.2O
SL-16.2O
SUL-1.2O
SEU-1.2O

Description: MODULETYPE, Specifies the Signal and SFP type for the OSCT.
SS-16.2O OC3 Short Haul
SL-16.2O OC3 Long Haul
SUL-1.2O OC3 Ultra-Long Haul
SEU-1.2O OC3 Enhanced Ultra-Long Haul

AINSTMR= Value Description


{{00-96}-{00-59}}

Description: AINSTMR, Transition soak time out of AINS. Format is


HOURS-MINUTES. Setting this value will cause AINSREF to be
set to OVRD. Maximum time is 96-00.
SYSTEM Use the system level timer

AINSCNTDWN= Value Description


{{00-96}-{00-59}}

Description: AINSCNTDWN, Time remaining to transition out of AINS. Format


is HOURS-MINUTES. Maximum time is 96-00.

AINSREF= Value Description


SYSTEM
OVRD

Description: AINSREF, Indicates the reference timer used for automatic


in-service transition.
SYSTEM Use the system level timer
OVRD Override of the system level timer

OUTPOWER= Value Description


<numerical value>

Description: OUTPOWER, Measured egress power (dBm).

2316 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTS Issue 1, December 2011

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if it


contains non- alphanumeric characters.

DELTAGMAX= Value Description


{0-99.99}

Description: DELTAGMAX, Indicates the maximum allowed difference between


the provisioned gain and the measured gain before an alarm is
raised.

DEVIATIONIN= Value Description


{0-10.0}

Description: DEVIATIONIN, Indicates the Deviation-in values used for the


adjustment.

DEVIATIONOUT= Value Description


{0-10.0}

Description: DEVIATIONOUT, Indicates the Deviation-out values used for the


adjustment.
.

DROPTARGETPW Value Description


R=
{-26.5 to -4.0}

Description: DROPTARGETPWR, This indicates the per channel default


common power out of a CLS port.

GAINBACKOFF= Value Description


{0-10.0}

Description: GAINBACKOFF, This indicates maximum allowed change in


amplifier gain.

GAINTILT= Value Description


{-3.0-0.0}

1830PSS R3.6.50 - TL1 Commands and Messages 2317


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS
Description: GAINTILT, This indicates the amount of current amplifier tilt. This
result is after the internal tilt software modifies the provisioned
TILT value.

TARGETPOWER= Value Description


{-30.0 to +11.0}

Description: TARGETPOWER, This indicates the per channel default common


power.

TILT= Value Description


{-3.0 to 0}

Description: TILT, Amplifier tilt.

LOSTHRESHOLD= Value Description


{-32.0 to +20.0} for SFD5
{-26.0 to +9.8} for SFC2, SFC4, SFC8

Description: LOSTHRESHOLD, specifies the LOS threshold for the OMD port.

LOSTOLERANCE= Value Description


{0.5 to 6.0}

Description: LOSTOLERANCE, difference between the set and clear points for
the OMD port LOS.

LOSOUTTHRESH Value Description


OLD=
{-32.0 to +20.0} for SFD5
{-32.0 to +17.0} for SFD8

Description: LOSOUTTHRESHOLD, specifies the LOS threshold for the OMD


port output.

LOSOUTTOLERAN Value Description


CE=
{0.5 to 6.0}

Description: LOSOUTTOLERANCE, difference between the set and clear


points for the OMD OUT port LOS.

2318 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTS Issue 1, December 2011

AVGMUXLOSS= Value Description


{0 to 10.0}

Description: AVGMUXLOSS, average loss from the channel inputs to the OMD
output.

AVGDEMUXLOSS= Value Description


{0 to 10.0}

Description: AVGDEMUXLOSS, average loss from the OMD input to the


channel outputs.

ADDCHANNELCNT Value Description


=
{8-44}
{8-88}

Description: ADDCHANNELCNT, Indicates the maximum number of channels


supported on the add path to this egress line.

ADDDEGREECNT= Value Description


{1-8}

Description: ADDDEGREECNT, Indicates the reserved degree feed to this add


path

ADDEGRESSPWR Value Description


=
{-35.0 to 11.0}

Description: ADDEGRESSPWR, The desired output power for each add


channel as the channel come out the CWR SIG-OUT port.

MAXFLATGAIN= Value Description


{-5.0 to 5.0}

Description: MAXFLATGAIN, Provides a correction in dB to the assumed max


flat gain value.

TILTCALDCM= Value Description


{0.0 to 100.0}

1830PSS R3.6.50 - TL1 Commands and Messages 2319


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS
Description: TILTCALDCM, Provides the coefficient, as a percentage, for the
SRSTilt equation for the DCM.

CONNADDRESS= Value Description


{SHELF/SLOT/PORT, DELETE}

Description: CONNADDRESS, Specifies the assigned port being monitored by


the wtocm input port.
SHELF/SLOT/PORT Address of monitored port
DELETE Clear the current address value

CONNLOSS= Value Description


{0.0 to 15.0}

Description: CONNLOSS, Specifies the installed loss between the port being
monitored and the wtocm input port.

CHANPOWER= Value Description


{-99.00 to 20.00}

Description: CHANPOWER, Specifies the total power in dBm at the wtocm


input port. A value of -99 represents no detected power.

CHANPOWERMON Value Description


=
{-99.00 to 20.00}

Description: CHANPOWERMON, Specifies the total power in dBm calculated


at the monitored port. A value of -99 represents no detected
power.

OPPDIRECTION= Value Description


<valid port aid>

Description: OPPDIRECTION, Specifies the other uni-directional port, that with


this addressed port, creates a bi-directional connection point.

INTOOUTGAIN= Value Description


{15.00-31.00} (AM2125A)
{15.0-31.0} (AM2125B)
{7.00-24.00} (AM2318A)
{7.00-24.00} (MESH4)

2320 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTS Issue 1, December 2011

Description: INTOOUTGAIN, Specifies the gain from card input port to card
output port.

TILTACTUAL= Value Description


{-10.00 to 5.00}

Description: TILTACTUAL, Specifies actual adjusted tilt value.

TILTTARGET= Value Description


{-3.00 to 3.00} RA2P
{-3.00 to 0.00} non-Raman

Description: TILTTARGET, Specifies the target tilt value.

INPOWERDCM= Value Description


{-99.00 to 20.00}

Description: INPOWERDCM, Specifies the total power in dBm measured at


the DCM input port. A value of -99 represents no detected power.

OUTPOWERDCM= Value Description


{-99.00 to 20.00}

Description: OUTPOWERDCM, Specifies the total power in dBm measured at


the DCM output port. A value of -99 represents no detected power.

OUTPOWERASE= Value Description


{-99, -30 to +10}

Description: OUTPOWERASE, Specifies the ASE power in dBm calculated at


the output port. A value of -99 represents no detected power.

RAMFIBERTYPE= Value Description


{SSMF, TWRS, ELEAF}

Description: RAMFIBERTYPE, Specifies the type of fiber connected to the


Raman amplifier.

RAMOPRMODE= Value Description


{POWER, GAIN, MAXPOWER}

1830PSS R3.6.50 - TL1 Commands and Messages 2321


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS
Description: RAMOPRMODE, Specifies the operating mode for the Raman
amplifier.

VOASETTING= Value Description


{0 to 18.00}

Description: VOASETTING, Specifies the setting for the VOA after the
VGOAM.

PST Value Description


{IS-NR, OOSAU-MA}

Description: PST, Primary State for the OTS.


IS-NR In Service, Normal
OOS-AUMA Out of Service, Autonomous and
Management

SST Value Description


AINS
FAF
FLT
MT
SGEO
UAS

Description: SST, Secondary State for the OTS.


AINS Automatic In-Service
FAF Facility Failure
FLT Port Failure
MT Maintenance
SGEO Supporting Entity Outage
UAS Unassigned

2322 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTS Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example shows the successful execution of a RTRV-OTS command

rtrv-ots:NODE-1:ALPHG-3-9-LINE:789012;
IP 789012
<
NODE-1 07-10-26 16:42:11
M 789012 COMPLD
"ALPHG-3-9-LINE:ALPHG:GAIN=21.0, MAXGAIN=17.50, MINGAIN=6.79,
TYPE=OC3, INPOWER=-6.16, SIGOUTPWR=-4.89, OUTPWRT=-18.0,
MODULETYPE=SL-16.2O,
AINSTMR=50, AINSCNTDWN=50, AINSREF=50, OUTPOWER=-17.99, DESCR=\"\",
DELTAGMAX=3, DEVIATIONIN=5, DEVIATIONOUT=5, GAINBACKOFF=2,
GAINTILT=-1.0, TARGETPOWER=-10, TILT=0, MAXFLATGAIN=1.0,
TILTCALDCM=100:IS,AINS"
/* RTRV-OTS:NODE-1:ALPHG-3-9-LINE:789012; */
;

RELATED COMMANDS
DLT-OTS
ED-OTS
ENT-OTS
RMV-OTS
RST-OTS

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2323


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTS

2324 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OTU1


Command Name: RTRV-OTU1

PURPOSE
The RTRV-OTU1 command shall be used to retrieve all parameters related to the OTU1 client and line
port. The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OTU1:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2325


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU1
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][,AINSREF=<value>][,AINSTMR=<value>][
,OPRMODE=<value>][,OTURATE=<value>][,FECTYPE=<value>][,TX_SAPI=<valu
e>][,EXP_SAPI
=<value>][,INC_SAPI=<value>][,TRCSTATUS=<value>][,TRCCMP=<value>][,T
IMMRESP=<value>][,LOSPROP=<value>][,MODULETYPE=<value>][,CHANNELTX=<
value>][,CHANNELRX=<value>][,DESCR=<value>][,NETSMAP=<value>][,FETSM
AP=<value>][,TS=<value>][,RXPOWER=<value>][,TXPOWER=<value>]:<PST>
[,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12}-OTU (OTU1 on 11DPM12 client ports)

Description: Access Identifier, specifies an access Identifier to the client or line


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSCNTDWN (AINS Countdown), this is the time remaining to


transition out of AINS.
The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

2326 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU1 Issue 1, December 2011

AINSTMR= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSTMR, transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for automatic in-service transition out of AINS
will cause the value of AINSREF to be set to OVRD.

OPRMODE= Value Description


{ADD_DROP, CROSSREGEN}

Description: 4DPA4 line port operational mode. In ADD_DROP, client port


signals are added to and dropped from the line port. In
CROSSREGEN mode, line-to-line regeneration is performed and
no client ports are used. This parameter applies to 4DPA4 only.
Operational mode is directly provisionable only on port L1. The
value on port L2 is read-only, and is always equal to the L1 value.

OTURATE= Value Description


2.66 (4DPA4 OT line AID only ;
cardMode=FlexMux)

Description: OTU1 rate. Specifies the OTU1 rate (standard 2.66 Gb/s
11.27Gb/s).
Only the value OTURATE=2.66 is suppported on the 4DPA4 OT.
This parameter does not apply to the 11STMM10 OT.

FECTYPE= Value Description


{NOFEC, RSFEC}

Description: Forward Error Correction mode (FEC Mode). This parameter


indicates the type of Forward Error Correction on a DWDM line
and client side port.
NOFEC NO FEC (applies to 11STMM10 OT client AID and
4DPA4 OT line AID).
RSFEC Reed-Solomon FEC (applies to 11STMM10 OT
client AID and 4DPA4 OT line AID)
FECTYPE applies to the 11STMM10 OT client port AID when the
signal type is OTM0_1.

1830PSS R3.6.50 - TL1 Commands and Messages 2327


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU1

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Actual Optical channel Incoming TTI, Expected incoming Source


Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

2328 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU1 Issue 1, December 2011

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

1830PSS R3.6.50 - TL1 Commands and Messages 2329


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU1

LOSPROP= Value Description


{LASERON, LASEROFF}

Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, SI-16.1, SL-16.1,
SL-16.2, SL-16.2C, SS-16.1A,
SS-16.2C} (applicable to the
11STMM10 OT)
{AUTO, USER, SL-16.1, SL-16.2C,
SS-16.1A, SS-16.2C, SL-16.2D
,4FC-OC ,4FC-OD} (applicable to the
4DPA4 OT)

Description: Attribute defines pluggable module type to be used in providing


physical layer function on the specified OTU1 port. If AUTO value
is chosen NE shall accept the pluggable module type inserted in
the socket if previous MODULETYPE value was <null>. If the user
wants to use a pluggable module type which is not on the ALU
qualified list, without getting an alarm, this attribute shall be set to
USER.
Note: 4FC-OC, 4FC-OD module types are supported by 4DPA4 line ports only
when CardMode=DualTran.

CHANNELTX= Value Description


NONE (not yet assigned)
{9600, 9590, 9580, 9570, 9560, 9550,
9540, 9530, 9520, 9510, 9500, 9490,
9480, 9470, 9460, 9450, 9440, 9430,
9420, 9410, 9400, 9390, 9380, 9370,
9360, 9350, 9340, 9330, 9320, 9310,
9300, 9290, 9280, 9270, 9260, 9250,
9240, 9230, 9220, 9210, 9200, 9190,
9180, 9170} (applies to 4DPA4 OT Line
AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (applies to 11STMM10
Client AIDs, 11DPM12 Client AIDS and
4DPA4 Line AIDs)
{850, 1310, 1550} (B&W wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs and 4DPA4 Line
AIDs)

2330 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU1 Issue 1, December 2011

Description: Attribute defines the transmit frequency of the transponder optical


interface. This parameter applies to the line port of the 4DPA4
OTor the client port of the 11STMM10 OT or 11DPM12 OT.

CHANNELRX= Value Description


NONE (not yet assigned)
{9600, 9590, 9580, 9570, 9560, 9550,
9540, 9530, 9520, 9510, 9500, 9490,
9480, 9470, 9460, 9450, 9440, 9430,
9420, 9410, 9400, 9390, 9380, 9370,
9360, 9350, 9340, 9330, 9320, 9310,
9300, 9290, 9280, 9270, 9260, 9250,
9240, 9230, 9220, 9210, 9200, 9190,
9180, 9170} (applies to 4DPA4 OT Line
AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (applies to 11STMM10
Client AIDs, 11DPM12 Client AIDS and
4DPA4 Line AIDs)
{850, 1310, 1550} (B&W wavelengths;
applies to 11STMM10 Client AIDs,
11DPM12 Client AIDs and 4DPA4 Line
AIDs)

Description: Attribute defines the receive frequency of the transponder optical


interface. This parameter applies to the line port of the 4DPA4
OTor the client port of the 11STMM10 OT or 11DPM12 OT.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

NETSMAP= Value Description


<350 CHARACTER STRING>

Description: NETSMAP, Near End TimeSlot Map. Displays a list of


port-to-timeslot assignment on the line port. Applies to 4DPA4
only when cardMode=FlexMux.
The format of the string is 16 sets of [x][y][z] separated by commas
as follows:
[<TS1>][<SigType>][<ClientPortID>],
[<TS2>][<SigType>][<ClientPortID>],
...[<TS16>][<SigType>][<ClientPortID>]

1830PSS R3.6.50 - TL1 Commands and Messages 2331


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU1

FETSMAP= Value Description


<350 CHARACTER ASCII STRING>

Description: FETSMAP, Far End TimeSlot Map. Displays a list of


port-to-timeslot assignment on the line port. Applies to 4DAP4
only when cardMode=FlexMux.
The format of the string is 16 sets of [x][y][z] separated by commas
as follows:
[<TS1>][<SigType>][<ClientPortID>],
[<TS2>][<SigType>][<ClientPortID>],
...[<TS16>][<SigType>][<ClientPortID>]

TS= Value Description


ODU1-L1-{1-4}-{1} (11STMM10
timeslots)
ODU1-L1-0-0 (unassigned
11STMM10 timeslot)

Description: Timeslot asignment on the Line port <ODU1#>-<Time Slot within


ODU1>. This parameter does not apply to the 4DPA4 OT.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical transmit power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement

2332 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU1 Issue 1, December 2011

OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-OTU1


command for the client port of an 11STMM10 OT.
RTRV-OTU1:NODE-1:11STMM10-1-5-C1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD

"11STMM10-1-5-C1::AINSCNTDWN=00-00,AINSREF=OVRD,AINSTMR=08-00,FECTYP
E=RSFEC,TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,TRCCMP=ENAB
LED,TIMMRESP=DISABLED,LOSPROP=LASER_ON, MODULETYPE=AUTO,
CHANNELTX=850, CHANNELRX=850,
DESCR=\"\",RXPOWER=-3.62,TXPOWER=-1.06:OOS-AU,FAF"
;

1830PSS R3.6.50 - TL1 Commands and Messages 2333


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU1
RELATED COMMANDS
ENT-OTU1
RTRV-OTU1
RST-OTU1
DLT-OTU1
ED-OTU1
RMV-OTU1

RELATED AUTONOMOUS RESPONSES


none

2334 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OTU2


Command Name: RTRV-OTU2

PURPOSE
The RTRV-OTU2 command shall be used to retrieve all parameters related to the OTU2 client and line
port. The command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OTU2:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2335


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2

AID Value Description


ALL
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

2336 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU2 Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][, AINSREF=<value>][,
AINSTMR=<value>][,
OPRMODE=<value>][,CROSSREGPARTNER=<value>][,MULTICASTFROM=<value>][,
INC_RES=<value>][,PREFECBER=<value>] [,POSTFECBER=<value>][,
OTURATE=<value>][, FECTYPE=<value>][, TX_SAPI=<value>][, EXP_SAPI
=<value>][,INC_SAPI=<value>][, TRCCMP=<value>][,TRCSTATUS=<value>][,
TIMMRESP=<value>][,LOSPROP=<value>][,MODULETYPE=<value>][,
CHANNELTX=<value>][,CHANNELRX=<value>][,STPID=<value>][,NETSMAP=<val
ue>][,FETSMAP=<value>][,DESCR=<value>][,RXPOWER=<value>][,TXPOWER=<v
alue>]:<PST> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2}-OTU (OTU2 on 11DPM12 line ports)

Description: Access Identifier, specifies an access Identifier to the client or line


port.

1830PSS R3.6.50 - TL1 Commands and Messages 2337


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSCNTDWN (AINS Countdown), this is the time remaining to


transition out of AINS.
The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSTMR, transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for automatic in-service transition out of AINS
will cause the value of AINSREF to be set to OVRD.

OPRMODE= Value Description


{ADD_DROP, CROSSREGEN,,
ADDONLY, DROP_CONTINUE}

Description: The Operational Mode. This parameter configures the operating


mode of the line port only of an OT.
ADD_DROP bidirectional mode with a bidirectional signal
added and dropped,
CROSSREGEN In this mode, the Line port input signal is looped towards another line port on the
same pack. This mode only applies to 11QPA4 pack.

ADDONLY in this mode, pack is processing signal in ingress


direction (from client side towards the line side). This mode only
applies to 11QPA4 pack.
DROP_CONTINUE In this mode, pack is processing the signal in
egress direction and looping the signal from the line side input
towards the line side output. This mode only applies to 11QPA4
pack.

2338 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU2 Issue 1, December 2011

This parameter does not apply to the 43STX4 and 43STX4P OTs.
This parameter does not apply to the 43SCX4OT or the 43SCX4L
OT.
This parameter does not apply to the 112SX10L OT.
This parameter does not apply to the 112SCX10 OT.
This parameter does not apply to the 112SNX10 OT.

CROSSREGPART Value Description


NER=
L{1-4}

Description: The destination line port for the loopback. The


value shall not be same as its port number

Only applied to 11QPA4 line ports L{1-4}and OPRMODE is


CROSSREGEN.

MULTICASTFROM Value Description


=
C{1-4}

INC_RES= Value Description


{2 characters}

Description: incoming RES (INC_RES) OTU2 overhead. This parameter


determines the incoming RES overhead of an OTUk information
structure. Its hex representation is 00. When no value can be
obtained from the pack, default display will be “?”.

PREFECBER= Value Description


<Numerical value>

Description: Display 1-second pre-fec BER. The PREFECBER parameter is the


number of the bit errors during the defined accumulation period
(i.e. 1 second) at the line side optical receiver. BER is to be
calculated from FEC-EC and FEC-UBC

POSTFECBER= Value Description


<Numerical value>

Description: Display 1-second post-fec BER. The POSTFECBER parameter is


the number of the bit errors during the defined accumulation period
(i.e. 1 second) at the line side optical receiver. BER is to be
calculated from FEC-UBC

1830PSS R3.6.50 - TL1 Commands and Messages 2339


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2

OTURATE= Value Description


{10.709, 11.049, 11.096} client side
{10.709, 11.049, 11.096, 11.27} line side

Description: OTU2 rate. Specifies the OTU2 rate (standard 10.709,


overclocked 11.049Gb/s, overclocked 11.096Gb/s, overclocked
11.27Gb/s).
OTURATE can be set on the client side only when the client signal
is OTM0.2 (see ENT-OTU2).
This parameter shall apply to the 43SCX4 OT and the 43SCX4L
OT.
This parameter does not apply to the 43STX4 and 43STX4P OT.
Each time the client side signal is changed (ENT/DLT-rr
command) a REPT-DBCHG is generated and the OTURATE is set
per table below:

Table: OTURATE line side (non REGEN mode)


Client signal OTURATE line side
OC-192/STM-64 Standard 10.709
10GbE WAN PHY,
10GbE LAN(GFP-F),
10GbE LAN (GFP-P)
OTM0.2 (11.049) 11.049
10GE LAN CBR11.049
OTM0.2 (11.096) 11.096
10GE LAN CBR11.096
10GFC 11.27

FECTYPE= Value Description


{NOFEC,EFEC,RSFEC,EFEC2}
{NOFEC,EFEC,RSFEC,EFEC2}

Description: Forward Error Correction mode (FEC Mode). This parameter


indicates the type of Forward Error Correction on a DWDM line
and client side port.
NOFEC NO FEC (11STAR1 client AID)
NOFEC NO FEC (43STX4 and 43STX4P client AID)
NOFEC NO FEC (11QPA4 and 11QTA4 client AID)
NOFEC NO FEC (43SCX4 and 43SCX4L client AID)
NOFEC NO FEC (112SCX10, 112SNX10 and 112SX10L
client AID)
EFEC Enhanced FEC (112SCX10 client AID)
EFEC Enhanced FEC (112SNX10 client AID)

2340 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU2 Issue 1, December 2011

EFEC Enhanced FEC (112SX10L client AID)


EFEC Enhanced FEC (43SCX4 and 43SCX4L client AID)
RSFEC Reed-Solomon FEC (43STX4 and 43STX4P client
AID)
RSFEC Reed-Solomon FEC (112SX10L client AID)
RSFEC Reed-Solomon FEC (112SCX10 client AID)
RSFEC Reed-Solomon FEC (112SNX10 client AID)
RSFEC Reed-Solomon FEC (43SCX4 and 43SCX4L client
AID)
RSFEC Reed-Solomon FEC (11QPA4 and 11QTA4 client
and line AID, 11DPE12 and 11DPE12E line
AID,11DPM12 line AID)
EFEC2 ALU FEC (11STMM10 OT, 11STGE12, 11QPA4
and 11DPE12,11DPE12E, 11QTA4 OT line port
AID only, 11DPM12 line AID)
EFEC2 ALU FEC (112SCX10 client AID)
EFEC2 ALU FEC (112SNX10 client AID)
EFEC2 ALU FEC (112SX10L client AID)
EFEC2 ALU FEC (43SCX4 and 43SCX4L client AID)
FECTYPE applies to client port AID when the signal type is
OTM0_2.

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).

1830PSS R3.6.50 - TL1 Commands and Messages 2341


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel incoming TTI, Incoming TTI message Source


Access Point Identifier (RX_SAPI). Trail trace is supported on both
OTUk Section Monitoring as well as ODUk Path Monitoring levels
TTI is monitored and compared with the provisioned expected
value. A Trail Trace Mismatch alarm is reported if they do not
match.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The status of this value is contained in the parameter
"TRCSTATUS".

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.

2342 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU2 Issue 1, December 2011

UNAVAILABLE No value could be obtained by the


system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

LOSPROP= Value Description


{LASERON, LASEROFF}

Description: Attribute that controls status of the client side transmitter during
signal failure on the line input port or when a far end failure gets
signalled.

1830PSS R3.6.50 - TL1 Commands and Messages 2343


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2

MODULETYPE= Value Description


{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
11STAR1, 43STX4, 43STX4P,
43SCX4L and 43SCX4 OTs
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
112SX10L OT
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
112SCX10 OT
{AUTO, USER, 10GB-ZR, XI-64.1,
XS-64.2B, XS-64.2C, XL-64.2C} for
112SNX10 OT
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
11QPA4 client side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XS-64.2b, XS-64.2C} for the
11QTA4 client side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the 11DPE12
line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the
11DPE12E line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C} for the 11QPA4
line side
{AUTO, USER, 10GB-ZR, XI-64.1,
XL-64.2C, XL-64.2D, XL-64TU,
XS-64.2b, XS-64.2C } for the 11DPM12
line side

Description: Attribute that defines the pluggable


module type used in providing the physical layer
function on the specified OTM0.2 client port. If the
value AUTO is chosen, the NE shall accept the
pluggable module type inserted in the socket if the
previous MODULETYPE value was <null>.
If the pluggable module type inserted is not on the
ALU-qualified list, then this attribute should be set
to USER.
This parameter shall not apply to the 11QTA4 OT line port.

2344 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU2 Issue 1, December 2011

CHANNELTX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies; applies to Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to Client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)
{850, 1310, 1550} (B&W wavelengths;
applies to Client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)

Description: Attribute defines the transmit frequency of the transponder optical


interface.

1830PSS R3.6.50 - TL1 Commands and Messages 2345


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2

CHANNELRX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170} (DWDM
frequencies; applies to Line AIDs)
{1471, 1491, 1511, 1531, 1551, 1571,
1591, 1611} (CWDM wavelengths;
applies to Client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)
{850, 1310, 1550} (B&W wavelengths;
applies to Client AIDs. Also applies to
the line AIDs of the 11QPA4 and
11QTA4 OT.)

Description: Attribute defines the receive frequency of the transponder optical


interface.

STPID= Value Description


{STPID1,STPID2,STPID3,STPID4}

Default: STPID1
Address: None
Description: The STPID (SVLAN Tag Protocol Identifier) can be selected
between four global STPID values which has been provisioned on
pack level for SVLAN tagged packets in qinq mode.
This parameter shall only apply to 11DPE12E OT.

NETSMAP= Value Description


<350 CHARACTER STRING>

Description: NETSMAP, Near End TimeSlot Map. Displays a list of


port-to-timeslot assignment on the line port. Applies to 11STMM10
Line port only.

2346 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU2 Issue 1, December 2011

The format of the string is 64 sets of [x][y][z] separated by commas


as follows:
[<TS1>][<SigType>][<ClientPortID>],
[<TS2>][<SigType>][<ClientPortID>],
...[<TS64>][<SigType>][<ClientPortID>]

FETSMAP= Value Description


<350 CHARACTER ASCII STRING>

Description: FETSMAP, Far End TimeSlot Map. Displays a list of


port-to-timeslot assignment on the line port. Applies to 11STMM10
line port only.
The format of the string is 64 sets of [x][y][z] separated by commas
as follows:
[<TS1>][<SigType>][<ClientPortID>],
[<TS2>][<SigType>][<ClientPortID>],
...[<TS64>][<SigType>][<ClientPortID>]

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical receive power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal

1830PSS R3.6.50 - TL1 Commands and Messages 2347


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

2348 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU2 Issue 1, December 2011

EXAMPLES

The following example shows the successful execution of a RTRV-OTU2


command for the line port of an 11STMM10.
RTRV-OTU2:NODE-1:11STMM10-1-5-L1:123456;
NODE-1 05-23-09 17:35:03
M 789012 COMPLD
"11STMM10-1-5-L1::AINSCNTDWN=00-00,AINSREF=OVRD,AINSTMR=08-00,FECTYP
E=RSFEC,TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,INC_SAPI=AB
CDEFGHIJKLMNO,TRCCMP=ENABLED,TRCSTATUS=NORMAL,TIMMRESP=DISABLED,LOSP
ROP=LASER_ON, CHANNEL=9560,
DESCR=\"\",RXPOWER=-3.62,TXPOWER=-1.06:OOS-AU,FAF"
;

The following example shows the successful execution of a RTRV-OTU2


command for the line port of an 11STMM10.
RTRV-OTU2:NODE-1:11STMM10-1-5-L1:123456;
NODE-1 05-23-09 17:35:03
M 789012 COMPLD
"11STMM10-1-5-L1::AINSCNTDWN=00-00,AINSREF=OVRD,AINSTMR=08-00,FECTYP
E=RSFEC,TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,INC_SAPI=AB
CDEFGHIJKLMNO,TRCCMP=ENABLED,TRCSTATUS=NORMAL,TIMMRESP=DISABLED,LOSP
ROP=LASER_ON, CHANNELTX=9560,
DESCR=\"\",RXPOWER=-3.62,TXPOWER=-1.06:OOS-AU,FAF"
;

RELATED COMMANDS
ENT-OTU2
RTRV-OTU2
RST-OTU2
DLT-OTU2
ED-OTU2
RMV-OTU2

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2349


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU2

2350 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OTU3


Command Name: RTRV-OTU3

PURPOSE
The RTRV-OTU3 command shall be used to retrieve all parameters related to the OTU3 line port. The
command is executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OTU3:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>

1830PSS R3.6.50 - TL1 Commands and Messages 2351


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU3
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][, AINSREF=<value>][,
AINSTMR=<value>][, OPRMODE=<value>][, FECTYPE=<value>][,
TX_SAPI=<value>][, EXP_SAPI =<value>][,INC_SAPI=<value>][,
TRCCMP=<value>][,TRCSTATUS=<value>][, TIMMRESP=<value>][,
CHANNEL=<value>][, CHANNELTX=<value>][, CHANNELRX=<value>][,
LOSPROP=<value>][,DESCR=<value>][,RXPOWER=<value>][,TXPOWER=<value>]
:<PST> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-{L1, C1} (43STA1P Ports)
43SCA1-<shelf>-<slot>-{L1, C1} (43SCA1 Ports)

Description: Access Identifier, specifies an access Identifier to the client or line


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSCNTDWN (AINS Countdown), this is the time remaining to


transition out of AINS.
The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition.

2352 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU3 Issue 1, December 2011

SYSTEM use the system level timer.


OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSTMR, transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for automatic in-service transition out of AINS
will cause the value of AINSREF to be set to OVRD.

OPRMODE= Value Description


{ADD_DROP}
{ADD_DROP, REGEN}

Description: The Operational Mode. This parameter configures the operating


mode of the line port of an OT.
ADD_DROP bidirectional mode with a bidirectional signal
added and dropped,
REGEN unidirectional transmission mode where the client
interface is not used.

FECTYPE= Value Description


{AFEC, UFEC}

Description: Forward Error Correction mode (FEC Mode). This parameter


indicates the type of Forward Error Correction on a DWDM line
port.
EFEC Enhanced FEC (43STX4/43STX4P OT line AID)
UFEC Ultra Forward Error Correction (43STA1P OT
line AID)
AFEC Advanced Forward Error Correction
(43STX4/43STX4P line AID, and the 43SCX4L/43SCX4 OT line
AID)
AFEC Advanced Forward Error Correction (43SCA1
OT line AID)

TX_SAPI= Value Description


<0-15 characters>

1830PSS R3.6.50 - TL1 Commands and Messages 2353


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU3
Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit
Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel incoming TTI, Incoming TTI message Source


Access Point Identifier (RX_SAPI). Trail trace is supported on both
OTUk Section Monitoring as well as ODUk Path Monitoring levels
TTI is monitored and compared with the provisioned expected
value. A Trail Trace Mismatch alarm is reported if they do not
match.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The status of this value is contained in the parameter
"TRCSTATUS".

TRCCMP= Value Description


{ENABLED,DISABLED}

2354 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU3 Issue 1, December 2011

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).
ENABLED enable compare
DISABLED disable compare

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

1830PSS R3.6.50 - TL1 Commands and Messages 2355


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU3

CHANNEL= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170}
(DWDM frequencies; applies to Line
AIDs)

Note : for 43STX4 only even DWDM


channels are applicable.

Note : This parameter does not apply to


the 43SCX4L or 43SCX4 Line AID.

Description: Attribute defines frequency of the transponder optical interface.

2356 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU3 Issue 1, December 2011

CHANNELTX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170, 9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to the
43SCX4 and 43SCA1 Line AIDs)

{9285, 9280, 9275, 9270, 9265, 9260,


9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to
43SCX4L Line AID)
Note : This parameter only applies to
the 43SCX4 OT Line AID.

Note : This parameter only applies to


the 43SCX4L, 43SCX4 or 43SCA1 OT
Line AID.

1830PSS R3.6.50 - TL1 Commands and Messages 2357


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU3
Description: Attribute defines the transmit frequency of the transponder optical
interface.

CHANNELRX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170, 9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to the
43SCX4 and 43SCA1Line AIDs)

{9285, 9280, 9275, 9270, 9265, 9260,


9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to
43SCX4L Line AID)
Note : This parameter only applies to
the 43SCX4 L OT, 43SCX4 OT, or
43SCA1 OT Line AID.

2358 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU3 Issue 1, December 2011

Description: Attribute defines the receive frequency of the transponder optical


interface.

LOSPROP= Value Description


{LASERON, LASEROFF}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when a far end failure gets
signalled.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical receive power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous
OOS-AUMA Out Of Service - AUtonomous and
MAnagement
OOS-MA Out Of Service - MAnagement

1830PSS R3.6.50 - TL1 Commands and Messages 2359


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU3

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES

The following example shows the successful execution of a RTRV-OTU3


command for the line port of an 43STX4 OT.
RTRV-OTU3:NODE-1:43STX4-1-5-L1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD

"43STX4-1-5-L1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=00-10,FECTYP
E=AFEC,TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,
INC_SAPI=ABCDEFGHIJKLMNO, TRCCMP=ENABLED, TRCSTATUS=NORMAL,
TIMMRESP=DISABLED,CHANNEL=9560,
DESCR=\"\",RXPOWER=-5.5,TXPOWER=-2.44:OOS-AU,FAF"
;

RELATED COMMANDS
RTRV-OTU3

2360 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU3 Issue 1, December 2011

RST-OTU3
DLT-OTU3
ED-OTU3
RMV-OTU3

RELATED AUTONOMOUS RESPONSES


none

1830PSS R3.6.50 - TL1 Commands and Messages 2361


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU3

2362 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-OTU4


Command Name: RTRV-OTU4

PURPOSE
The RTRV-OTU4 command shall be used to retrieve all parameters related to the OTU4 line port.
This command will also be applicable to the OTU4 client port in a future release. The command is
executed regardless of the state of the port.
The denials for this command are detailed in section ERROR CODES.

INPUT FORMAT

RTRV-OTU4:[TID]:AID:[CTAG];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


ALL
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Default: ALL
Addressing: None
Description: Access Identifier, specifies an access Identifier to the OT client or
line port.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

1830PSS R3.6.50 - TL1 Commands and Messages 2363


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU4
Default: <System-assigned CTAG value>
Addressing: None
Description: Correlation TAG, associates the input command with its output
responses.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<AID>::[AINSCNTDWN=<value>][, AINSREF=<value>][,
AINSTMR=<value>][, OPRMODE=<value>][, FECTYPE=<value>][,
TX_SAPI=<value>][, EXP_SAPI =<value>][,INC_SAPI=<value>][,
TRCCMP=<value>][,TRCSTATUS=<value>][, TIMMRESP=<value>][,
CHANNELTX=<value>][,CHANNELRX=<value>][,
LOSPROP=<value>][,MODULETYPE=<value>][,DESCR=<value>][,RXPOWER=<valu
e>][,TXPOWER=<value>]:<PST> [,<SST>]" cr lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)

Description: Access Identifier, specifies an access Identifier to the client or line


port.

AINSCNTDWN= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSCNTDWN (AINS Countdown), this is the time remaining to


transition out of AINS.
The maximum time is 96-00.

AINSREF= Value Description


{SYSTEM, OVRD}

2364 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU4 Issue 1, December 2011

Description: AINSREF, indicates the reference timer is used for automatic


in-service transition.
SYSTEM use the system level timer.
OVRD user has chosen to use the AINSTMR value instead
of the AINSREF value for automatic in-service
transition out of AINS.

AINSTMR= Value Description


{00-96}-{00-59} (Time, in HH-MM format)

Description: AINSTMR, transition soak time out of AINS.


Format is HOURS-MINUTES. The maximum time is 96-00. The
minimum time is 00-01.
Setting a value for AINSTMR on a facility that was previously using
the AINSREF value for automatic in-service transition out of AINS
will cause the value of AINSREF to be set to OVRD.

OPRMODE= Value Description


{ADD_DROP, REGEN}

Description: The Operational Mode. This parameter configures the operating


mode of the line port of an OT.
ADD_DROP bidirectional mode with a bidirectional signal
added and dropped.
REGEN unidirectional transmission mode using line
interface only.

FECTYPE= Value Description


{AFEC}

Description: Forward Error Correction mode (FEC Mode). This parameter


indicates the type of Forward Error Correction on a port.
AFEC Advanced FEC (112SCA1 OT line AID, 112SNA1
OT line AID, 112SNX10 OT line AID, or 112SCX10
OT line AID or 112SA1L OT line AID or 112SX10L
OT line AID)

TX_SAPI= Value Description


<0-15 characters>

Description: Optical channel transmitted Trail Trace Identifier (TTI), Transmit


Source Access Point Identifier (TX_SAPI). This parameter
determines the Transmit TTI channel content of the Section
Monitoring overhead of an OTUk information structure or the Path
Monitoring overhead of the OTUkP information structure. The Trail
Trace Identifier shall follow the format defined in ITU-T G.709,

1830PSS R3.6.50 - TL1 Commands and Messages 2365


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU4
Clause 15.2. A TX_SAPI of less than 15 characters is padded out
to the right to 15 unprintable characters (e.g.., whose hex
representation is 0x00).
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.

EXP_SAPI= Value Description


<0-15 characters>

Description: Optical channel expected Incoming TTI, Expected incoming


Source Access Point Identifier (EXP_SAPI).
See IOM introduction for valid character set. If "" (i.e., no
characters) is entered, then the transmitted section trace message
in the SAPI field is 00 hexadecimal.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.

INC_SAPI= Value Description


<0-15 characters>

Description: Optical channel incoming TTI, Incoming TTI message Source


Access Point Identifier (RX_SAPI). Trail trace is supported on both
OTUk Section Monitoring as well as ODUk Path Monitoring levels
TTI is monitored and compared with the provisioned expected
value. A Trail Trace Mismatch alarm is reported if they do not
match.
15 ASCII characters, enclosed in quotation marks. The coded
representation is the 7 bit hex representation as specified by the
ITU-T Recommendation T.50 (09/92) International Reference
Alphabet.
The status of this value is contained in the parameter
"TRCSTATUS".

TRCCMP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Trace Comparison. This parameter enables and


disables section Trace Identifier MisMatch (TIMM) defect detection
(i.e., enables and disables comparison between the actual
incoming SAPI (INC_SAPI) and the provisioned expected
incoming SAPI (EXP_SAPI).

2366 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU4 Issue 1, December 2011

ENABLED enable compare


DISABLED disable compare

TRCSTATUS= Value Description


{UNAVAILABLE, NORMAL,
MISMATCH, UNSPECIFIED}

Description: Optical Channel Incoming Trail Trace identification (TTI) Status.


This is the status of the incoming optical channel section or path
trace.
UNAVAILABLE No value could be obtained by the
system, because there has been either a control system
failure, signal/transmission failure (such as dLOS,
dLOF or dLOM) or reception of maintenance signal which
overrides the TTI field (such as ODU-AIS, ODU-OCI or
ODU-LCK).
The received value in this case may be omitted or a
"?" may be used.
NORMAL This indicates that the incoming and the expected
trace contains a valid match. The received value in
this case is shown.
MISMATCH This indicates that the incoming and the
expected trace do not match. The received value in
this case is shown.
UNSPECIFIED This indicates that the comparison parameter
(TRCCMP) is set to DISABLE. The received value is shown.

TIMMRESP= Value Description


{ENABLED,DISABLED}

Description: Optical Channel Path Trace Identifier Mismatch Response. This


parameter determines whether an OT will take a Consequent
Action (or pass the received optical channel. upon detection of an
optical channel path trace mismatch at its output.
ENABLED enable TIMM defect detection
DISABLED disable TIMM defect detection

1830PSS R3.6.50 - TL1 Commands and Messages 2367


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU4

CHANNELTX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170,9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to Line
AIDs for the 112SCA1, 112SNA1,
112SNX10 and 112SCX10 OTs)
{9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to Line
AIDs on the 112SA1L and 112SX10L
OTs)

Description: Attribute defines the transmit frequency of the transponder line


interface.

2368 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU4 Issue 1, December 2011

CHANNELRX= Value Description


NONE (not yet assigned)
{9605, 9600, 9595, 9590, 9585, 9580,
9575, 9570, 9565, 9560, 9555, 9550,
9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490,
9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430,
9425, 9420, 9415, 9410, 9405, 9400,
9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340,
9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280,
9275, 9270, 9265, 9260, 9255, 9250,
9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190,
9185, 9180, 9175, 9170,9165, 9160,
9155, 9150, 9145, 9140, 9135, 9130,
9125, 9120, 9115}
(DWDM frequencies; applies to Line
AIDs for the 112SCA1, 112SNA1,
112SNX10 and 112SCX10 OTs)
{9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175,
9170,9165, 9160, 9155, 9150, 9145,
9140, 9135, 9130, 9125, 9120, 9115,
9110, 9105, 9100, 9095, 9090, 9085
9080, 9075, 9070, 9065, 9060, 9055,
9050, 9045, 9040, 9035, 9030, 9025,
9020, 9015, 9010, 9005, 9000, 8995,
8990, 8985, 8980, 8975, 8970, 8965,
8960, 8955, 8950, 8945, 8940, 8935,
8930, 8925, 8920, 8915, 8910, 8905,
8900, 8895, 8890, 8885, 8880, 8875,
8870, 8865, 8860, 8855, 8850, 8845,
8840, 8835, 8830, 8825, 8820, 8815,
8810, 8805, 8800, 8795, 8790, 8785,
8780, 8775, 8770, 8765, 8760, 8755,
8750, 8745, 8740, 8735, 8730, 8725,
8720, 8715, 8710, 8705, 8700, 8695,
8690, 8685, 8680, 8675, 8670, 8665,
8660, 8655, 8650}
(DWDM frequencies; applies to Line
AIDs on the 112SA1L and 112SX10L
OTs)

Description: Attribute defines the receive frequency of the transponder line


interface.

1830PSS R3.6.50 - TL1 Commands and Messages 2369


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU4

LOSPROP= Value Description


{LASERON, LASEROFF}

Description: Attribute that controls status of the client side transmitter during the
signal failure on the line input port or when a far end failure gets
signalled.

MODULETYPE= Value Description


{AUTO, USER, C113G10C,
C113G4CD}

Description: Attribute defines the CFP pluggable module type to be used to


provide the physical layer function on the specified client port.

DESCR= Value Description


<255 CHARACTER ASCII STRING>

Description: DESCR, Description string. Enclose the string in double quotes if


it contains non-alphanumeric characters.

RXPOWER= Value Description


<numerical value>

Description: RXPOWER, Receive Power. Measured optical receive power


(dBm).

TXPOWER= Value Description


<numerical value>

Description: TXPOWER, Transmit Power. Measured optical receive power


(dBm).

PST Value Description


{IS-NR, IS-ANR, OOS-AU, OOS-AUMA,
OOS-MA}

Description: Primary State, specifies the primary state to which the facility is
set.
IS-NR In Service - Normal
IS-ANR In Service - Abnormal
OOS-AU Out Of Service - AUtonomous

2370 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-OTU4 Issue 1, December 2011

OOS-AUMA Out Of Service - AUtonomous and


MAnagement
OOS-MA Out Of Service - MAnagement

SST Value Description


{AINS, FAF, LPBK, SGEO, UAS, MT}

Description: Secondary State, specifies the secondary state to which the facility
is set.
AINS Automatic In-Service
FAF Facility Failure
LPBK Loopback
SGEO Supporting Entity Outage
UAS Unassigned
MT Maintenance

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

1830PSS R3.6.50 - TL1 Commands and Messages 2371


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-OTU4
EXAMPLES

The following example shows the successful execution of a RTRV-OTU4


command for the line port of an 1112SCX10 OT.
RTRV-OTU4:NODE-1:112SCX10-1-5-L1:123456;
NODE-1 05-23-09 17:35:03
M 123456 COMPLD
"112SCX10-1-5-L1::AINSCNTDWN=00-00,AINSREF=SYSTEM,AINSTMR=00-10,FECT
YPE=AFEC,TX_SAPI=ABCDEFGHIJKLMNO,EXP_SAPI=ABCDEFGHIJKLMNO,
INC_SAPI=ABCDEFGHIJKLMNO, TRCCMP=ENABLED, TRCSTATUS=NORMAL,
TIMMRESP=DISABLED,CHANNELTX=9560, CHANNELRX=9560,
DESCR=\"\",RXPOWER=-5.5,TXPOWER=-2.44:OOS-AU,FAF"
;

RELATED COMMANDS
RTRV-OTU4
RST-OTU4
DLT-OTU4
ED-OTU4
RMV-OTU4

RELATED AUTONOMOUS RESPONSES


none

2372 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PATH-OCH


Command Name: RETRIEVE OPTICAL PATH (OCH)

PURPOSE
The RTRV-PATH-OCH command retrieves the topology of the the path traced by a particular optical
channel from one edge of the network element to the other. The command is executed regardless of
the provisioning of the specified port or the state of the optical connection.
The successful response for a RTRV-PATH-OCH contains one line of parsable output data, in order
(first tracing the connfrom links from the edge of the network element to the specified point and then
tracing the connto links from the specified point to the edge of the network element), for each optical
channel associated with the specified AID.

INPUT FORMAT

RTRV-PATH-OCH:[TID]:[AIDOCH]:[CTAG];

INPUT PARAMETERS

TID Value Description


<1-20 VALID TID CHARACTERS>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2373


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PATH-OCH

AIDOCH Value Description


ALL
AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,

2374 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PATH-OCH Issue 1, December 2011

AIDOCH Value Description


9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,

1830PSS R3.6.50 - TL1 Commands and Messages 2375


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PATH-OCH

AIDOCH Value Description


9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
RA2P-<shelf>-<slot>-LINEIN-{9605, (RA2P Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
11QPA4-<shelf>-<slot>-L{1-4} (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L{1-4} (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}

2376 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PATH-OCH Issue 1, December 2011

AIDOCH Value Description


SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)
SFD-<shelf>-1-{9605, 9600, 9595, (SFD44/SFD44B/SFD40/SFD40B NE
9590, 9585, 9580, 9575, 9570, 9565, Boundary Ports)
9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505,
9500, 9495, 9490, 9485, 9480, 9475,
9470, 9465, 9460, 9455, 9450, 9445,
9440, 9435, 9430, 9425, 9420, 9415,
9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355,
9350, 9345, 9340, 9335, 9330, 9325,
9320, 9315, 9310, 9305, 9300, 9295,
9290, 9285, 9280, 9275, 9270, 9265,
9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205,
9200, 9195, 9190, 9185, 9180, 9175,
9170}
SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

Default: ALL
Addressing: None.
Description: wavelength Access Identifier, specifies the selected wavelength
facility to which the command is directed.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: Entry required.


Addressing: None.
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2377


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PATH-OCH
SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
^^^"<OCHTRAILNAME>" cr lf
^^^"<AIDOCH>:<DIR>[,AZMIN=<value>][,AZMEAS=<value>][,AZMAX=<value>][
,ZAMIN=<value>][,ZAMEAS=<value>][,ZAMAX=<value>],<PST>[,<SST>]" cr
lf
...
^^^"<AIDOCH>:<DIR>[,AZMIN=<value>][,AZMEAS=<value>][,AZMAX=<value>][
,ZAMIN=<value>][,ZAMEAS=<value>][,ZAMAX=<value>],<PST>[,<SST>]" cr
lf
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

OCHTRAILNAME Value Description


< 1-60 VALID CKTID CHARACTERS >

Description: FROM-TO circuit ID previously assigned to optical connection.

2378 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PATH-OCH Issue 1, December 2011

AIDOCH Value Description


AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPFGT-<shelf>-<slot>-LINE-{9605, (ALPFGT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

1830PSS R3.6.50 - TL1 Commands and Messages 2379


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PATH-OCH

AIDOCH Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
OSCT-<shelf>-<slot>-LINE-{9605, (OSCT LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
CWR-<shelf>-<slot>-CLS{1-8} (CWR8/CWR8-88 CLS Port)
11STAR1-<shelf>-<slot>-L1 (11STAR1 Line Port)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
OPS-<shelf>-<slot>-{SIG, A, B} (OPSA Ports)
OPS-<shelf>-<slot>-SIG (OPSA Common Port)
SFC-<shelf>-<slot>-{1471, 1491, 1511, (SFC2/4/8 NE Boundary Ports)
1531, 1551, 1571, 1591, 1611}
SFC-<shelf>-<slot>-OMD-{1471, 1491, (SFC2/4/8 Mux/Demux Opitcal
1511, 1531, 1551, 1571, 1591, 1611} Channels)

2380 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PATH-OCH Issue 1, December 2011

AIDOCH Value Description


SVAC-<shelf>-<slot>-C1 (SVAC Client Port)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)

A2325A-<shelf>-<slot>-LINE-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,


9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(A2325A LINE Port Optical Channels)
AM2125A-<shelf>-<slot>-{LINEIN, LINEOUT}-{9605, 9600, 9595, 9590, 9585,
9580, 9575, 9570, 9565, 9560, 9555, 9550, 9545, 9540, 9535,
9530, 9525, 9520, 9515, 9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455, 9450, 9445, 9440, 9435,
9430, 9425, 9420, 9415, 9410, 9405, 9400, 9395, 9390, 9385,
9380, 9375, 9370, 9365, 9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305, 9300, 9295, 9290, 9285,
9280, 9275, 9270, 9265, 9260, 9255, 9250, 9245, 9240, 9235,
9230, 9225, 9220, 9215, 9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170} (AM2125A Optical Channels)
RA2P-<shelf>-<slot>-LINEIN-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570,
9565, 9560, 9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520,
9515, 9510, 9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420,
9415, 9410, 9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370,
9365, 9360, 9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270,
9265, 9260, 9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220,
9215, 9210, 9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(RA2P Optical Channels)
11QPA4-<shelf>-<slot>-L1-4 (11QPA4 Line Ports)
11QTA4-<shelf>-<slot>-L1-4 (11QTA4 Line Ports)
11DPE12-<shelf>-<slot>-L1-2 (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L1-2 (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L1-2 (11DPM12 Line Ports)
SFD-<shelf>-1-{9605, 9600, 9595, 9590, 9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530, 9525, 9520, 9515, 9510,
9505, 9500, 9495, 9490, 9485, 9480, 9475, 9470, 9465, 9460,
9455, 9450, 9445, 9440, 9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380, 9375, 9370, 9365, 9360,
9355, 9350, 9345, 9340, 9335, 9330, 9325, 9320, 9315, 9310,
9305, 9300, 9295, 9290, 9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230, 9225, 9220, 9215, 9210,
9205, 9200, 9195, 9190, 9185, 9180, 9175, 9170}
(SFD44/SFD44B/SFD40/SFD40B NE Boundary Ports)
Description: wavelength AID; indicates the FROM (receive side from the
network) port of the optical connection.

1830PSS R3.6.50 - TL1 Commands and Messages 2381


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PATH-OCH

DIR Value Description


1WAY
2WAY

Description: Optical connection Type.


1WAY One-way optical connection
2WAY Two-way optical connection

AZMAX Value Description


{numerical value}

Description: Specified maximum optical power (dBm) in the A->Z direction at


this point.

AZMEAS Value Description


{numerical value}

Description: Specified measured optical power (dBm) in the A->Z direction at


this point.

AZMIN Value Description


{numerical value}

Description: Specified minimum optical power (dBm) in the A->Z direction at


this point.

PST Value Description


IS-NR In Service NoRmal
IS-ANR In Service AbNoRmal
OOS-AU Out Of Service AUtonomous
OOS-MA Out Of Serivce MAnagement
OOSAUMA Out Of Service AUtonomous and
MAnagement
OOS-MAANR Out Of Service Management and
AbNoRmal

Description: Primary State and qualifier.

2382 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PATH-OCH Issue 1, December 2011

SST Value Description


AINS Automatic IN Service
FAF Facility Failure
FLT FauLT
LPBK LooPBacK
MT MainTenance
MEA MismAtch
SGEO SupportinG Entity Outage
UAS UnASsigned
UEQ UnEQuipped
Description: Secondary State associated with this
entity. Multiple SST vaules may be
displayed in the format
{<value>[&<value>]}

Description: Secondary State associated with this entity. Multiple SST vaules
may be displayed in the format {<value>[&<value>]}

ZAMAX Value Description


{numerical value}

Description: Specified maximum optical power (dBm) in the Z->A direction at


this point.

ZAMEAS Value Description


{numerical value}

Description: Specified measured optical power (dBm) in the Z->A direction at


this point.

ZAMIN Value Description


{numerical value}

Description: Specified minimum optical power (dBm) in the Z->A direction at


this point.

1830PSS R3.6.50 - TL1 Commands and Messages 2383


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PATH-OCH
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^<CTAG>^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

EXAMPLES
The following example illustrates the command and associated output for port ALPHG-1-1-LINE-9595
one-way connected to port 11STAR1-1-2-L1

RTRV-PATH-OCH:AHPHG-1-2-LINE-9595::100;

G02U 70-01-01 19:45:56


M 100 COMPLD
"NETWORK TELEVISION FEED FOR LIVE COVERAGE OF THE MARS LANDING"
"AHPHG-1-2-LINE-9595:1WAY,AZMIN=-29.0, AZMEAS=-24.7,
AZMAX=-21.4,IS-NR"
"AHPHG-1.2-SIG-9595:1WAY,AZMIN=-19.0, AZMEAS=-15.0,
AZMAX=-14.0,IS-NR"
"CWR-1-4-SIG-9595:1WAY,AZMIN=-20.0, AZMEAS=-16.0,
AZMAX=-15.0,IS-NR"
"CWR-1-4-THRU-9595:1WAY,AZMIN=-21.0, AZMEAS=-17.0,
AZMAX=-16.0,IS-NR"
"CWR-2-4-THRU-9595:1WAY,AZMIN=-22.0, AZMEAS=-18.0,
AZMAX=-17.0,IS-NR"
"CWR-2-4-SIG-9595:1WAY,AZMIN=-23.0, AZMEAS=-19.0,
AZMAX=-18.0,IS-NR"
"AHPHG-2-2-SIG-9595:1WAY,AZMIN=-24.0, AZMEAS=-20.0,
AZMAX=-19.0,IS-NR"
"AHPHG-2-2-LINE-9595:1WAY,AZMIN=-19.4, AZMEAS=-16.9,
AZMAX=-14.5,IS-NR"
/* RTRV-PATH-OCH */
;

RELATED COMMANDS
DLT-CRS-OCH

2384 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PATH-OCH Issue 1, December 2011

ED-CRS-OCH
ENT-CRS-OCH
RTRV-CRS-OCH

1830PSS R3.6.50 - TL1 Commands and Messages 2385


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PATH-OCH

2386 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-100GBE


Command Name: RETRIEVE PERFORMANCE
MONITORING 100GBE

PURPOSE
The RTRV-PM-GBE100 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified 100GBE facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-GBE100 command contains lines of parsable output data for
each provisioned 100GBE AID specified. No output data is provided if the facility is not provisioned.
No output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-100GBE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],
[TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-C1 (112SNA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2387


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-100GBE

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds -
Near End Section Synonyms:
SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2388 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-100GBE Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2389


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-100GBE
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2390 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-100GBE Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SA1L-<shelf>-<slot>-C1 (112SA1L Client Port)
112SCA1-<shelf>-<slot>-C1 (112SCA1 Client Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


100GBE

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2391


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-100GBE

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2392 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-100GBE Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2393


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-100GBE

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent ***Bad Attribute Name: ValueDescription ****
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2394 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-100GBE Issue 1, December 2011

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port 112SCA1-1-6-C1
is retrieved.

RTRV-PM-100GBE::112SCA1-1-6-C1:12345::CV-PCS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"112SCA1-1-6-C1,100GBE:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-100GBE::112SCA1-1-6-C1:12345::CV-PCS,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2395


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-100GBE

2396 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-10GBE


Command Name: RETRIEVE PERFORMANCE
MONITORING 10GBE

PURPOSE
The RTRV-PM-10GBE command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified 10GBE facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-10GBE command contains lines of parsable output data for
each provisioned 10GBE AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-10GBE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2397


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-10GBE

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2398 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-10GBE Issue 1, December 2011

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ETHPKTER Ethernet Frame Error Ratio
Synonyms: ETHPKTER
ETHOCTETS Ethernet Number of Bytes
Synonyms: ETHOCTETS
ETHPKTS Ethernet Number of Frames
Synonyms: ETHPKTS
ETHMCSTPKTS Ethernet Incoming Multicast Frames
Synonyms: ETHMCSTPKTS
ETHBCSTPKTS Ethernet Incoming Broadcast Frames
Synonyms: ETHBCSTPKTS
ETHCOLLISIONS Ethernet Collision Events
Synonyms: ETHCOLLISIONS
ETHCRCAE Ethernet
Incoming Errored Frames
Synonyms:
ETHCRCAE
ETHDROPEVTS Ethernet Incoming Drop Events
Synonyms: ETHDROPEVTS
ETHFRGMTS Ethernet Incoming Fragmented Frames
Synonyms: ETHFRGMTS
ETHJABRS Ethernet Incoming Jabber Frames
Synonyms: ETHJABRS
ETHOVRSIZEPKTS Ethernet Incoming Oversize Frames
Synonyms: ETHOVRSIZEPKTS
ETHUNDRSIZEPKTS Ethernet Incoming Undersize Frames
Synonyms: ETHUNDRSIZEPKTS
ETHPKTS64OCTETS Ethernet 64-byte Frames
Synonyms:
ETHPKTS64OCTETS
ETHPKTS127OCTETS Ethernet 65-127-byte Frames
Synonyms:
ETHPKTS127OCTETS
ETHPKTS255OCTETS Ethernet 128-255-byte Frames
Synonyms:
ETHPKTS255OCTETS
ETHPKTS511OCTETS Ethernet 256-511-byte Frames
Synonyms:
ETHPKTS511OCTETS
ETHPKTS1023OCTETS Ethernet 512-1023-byte Frames
Synonyms:
ETHPKTS1023OCTETS
ETHPKTS1518OCTETS Ethernet 1024-1518-byte Frames
Synonyms:
ETHPKTS1518OCTETS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark

1830PSS R3.6.50 - TL1 Commands and Messages 2399


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-10GBE

MONTYPE Value Description


High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.
PCS layer monitored parameters such as CVS-PCS, ES-PCS,
SES-PCS and SEFS-PCS shall not applied to 11DPE12 and
11DPE12E line side when configured as 10GBE signal type.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2400 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-10GBE Issue 1, December 2011

{0-1048575} - DN <LEVEL> - Down, Only PM data for


the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2401


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-10GBE
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None

2402 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-10GBE Issue 1, December 2011

Description: Number of 1-day historical registers, specifies the number of


previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


10GBE

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2403


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-10GBE

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ETHPKTER Ethernet Frame Error Ratio
Synonyms: ETHPKTER
ETHOCTETS Ethernet Number of Bytes
Synonyms: ETHOCTETS
ETHPKTS Ethernet Number of Frames
Synonyms: ETHPKTS
ETHMCSTPKTS Ethernet Incoming Multicast Frames
Synonyms: ETHMCSTPKTS
ETHBCSTPKTS Ethernet Incoming Broadcast Frames
Synonyms: ETHBCSTPKTS
ETHCOLLISIONS Ethernet Collision Events
Synonyms: ETHCOLLISIONS
ETHCRCAE Ethernet
Incoming Errored Frames
Synonyms:
ETHCRCAE
ETHDROPEVTS Ethernet Incoming Drop Events
Synonyms: ETHDROPEVTS
ETHFRGMTS Ethernet Incoming Fragmented Frames
Synonyms: ETHFRGMTS
ETHJABRS Ethernet Incoming Jabber Frames
Synonyms: ETHJABRS
ETHOVRSIZEPKTS Ethernet Incoming Oversize Frames
Synonyms: ETHOVRSIZEPKTS
ETHUNDRSIZEPKTS Ethernet Incoming Undersize Frames
Synonyms: ETHUNDRSIZEPKTS
ETHPKTS64OCTETS Ethernet 64-byte Frames
Synonyms:
ETHPKTS64OCTETS
ETHPKTS127OCTETS Ethernet 65-127-byte Frames
Synonyms:
ETHPKTS127OCTETS
ETHPKTS255OCTETS Ethernet 128-255-byte Frames
Synonyms:
ETHPKTS255OCTETS
ETHPKTS511OCTETS Ethernet 256-511-byte Frames
Synonyms:
ETHPKTS511OCTETS
ETHPKTS1023OCTETS Ethernet 512-1023-byte Frames
Synonyms:
ETHPKTS1023OCTETS
ETHPKTS1518OCTETS Ethernet 1024-1518-byte Frames
Synonyms:
ETHPKTS1518OCTETS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark

2404 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-10GBE Issue 1, December 2011

MONTYPE Value Description


High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.

1830PSS R3.6.50 - TL1 Commands and Messages 2405


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-10GBE
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

2406 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-10GBE Issue 1, December 2011

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent ***Bad Attribute Name: ValueDescription ****
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port 11STAR1-1-6-C1
is retrieved.

RTRV-PM-10GBE::11STAR1-1-6-C1:12345::CV-PCS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STAR1-1-6-C1,10GBE:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-10GBE::11STAR1-1-6-C1:12345::CV-PCS,,,,15-MIN [12345]
(1) */
;

1830PSS R3.6.50 - TL1 Commands and Messages 2407


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-10GBE
RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2408 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-1GBE


Command Name: RETRIEVE PERFORMANCE
MONITORING 1GBE

PURPOSE
The RTRV-PM-GBE command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified 1GBE facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-1GBE command contains lines of parsable output data for
each provisioned 1GBE AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-1GBE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2409


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-1GBE

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2410 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-1GBE Issue 1, December 2011

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ETHPKTER Ethernet Frame Error Ratio
Synonyms: ETHPKTER
ETHOCTETS Ethernet Number of Bytes
Synonyms: ETHOCTETS
ETHPKTS Ethernet Number of Frames
Synonyms: ETHPKTS
ETHMCSTPKTS Ethernet Incoming Multicast Frames
Synonyms: ETHMCSTPKTS
ETHBCSTPKTS Ethernet Incoming Broadcast Frames
Synonyms: ETHBCSTPKTS
ETHCOLLISIONS Ethernet Collision Events
Synonyms: ETHCOLLISIONS
ETHCRCAE Ethernet
Incoming Errored Frames
Synonyms:
ETHCRCAE
ETHDROPEVTS Ethernet Incoming Drop Events
Synonyms: ETHDROPEVTS
ETHFRGMTS Ethernet Incoming Fragmented Frames
Synonyms: ETHFRGMTS
ETHJABRS Ethernet Incoming Jabber Frames
Synonyms: ETHJABRS
ETHOVRSIZEPKTS Ethernet Incoming Oversize Frames
Synonyms: ETHOVRSIZEPKTS
ETHUNDRSIZEPKTS Ethernet Incoming Undersize Frames
Synonyms: ETHUNDRSIZEPKTS
ETHPKTS64OCTETS Ethernet 64-byte Frames
Synonyms:
ETHPKTS64OCTETS
ETHPKTS127OCTETS Ethernet 65-127-byte Frames
Synonyms:
ETHPKTS127OCTETS
ETHPKTS255OCTETS Ethernet 128-255-byte Frames
Synonyms:
ETHPKTS255OCTETS
ETHPKTS511OCTETS Ethernet 256-511-byte Frames
Synonyms:
ETHPKTS511OCTETS
ETHPKTS1023OCTETS Ethernet 512-1023-byte Frames
Synonyms:
ETHPKTS1023OCTETS
ETHPKTS1518OCTETS Ethernet 1024-1518-byte Frames
Synonyms:
ETHPKTS1518OCTETS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark

1830PSS R3.6.50 - TL1 Commands and Messages 2411


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-1GBE

MONTYPE Value Description


High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2412 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-1GBE Issue 1, December 2011

{0-1048575} - DN <LEVEL> - Down, Only PM data for


the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2413


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-1GBE
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None

2414 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-1GBE Issue 1, December 2011

Description: Number of 1-day historical registers, specifies the number of


previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
11STGE12-<shelf>-<slot>-C{1-10} (11STGE12 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


1GBE

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2415


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-1GBE

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ETHPKTER Ethernet Frame Error Ratio
Synonyms: ETHPKTER
ETHOCTETS Ethernet Number of Bytes
Synonyms: ETHOCTETS
ETHPKTS Ethernet Number of Frames
Synonyms: ETHPKTS
ETHMCSTPKTS Ethernet Incoming Multicast Frames
Synonyms: ETHMCSTPKTS
ETHBCSTPKTS Ethernet Incoming Broadcast Frames
Synonyms: ETHBCSTPKTS
ETHCOLLISIONS Ethernet Collision Events
Synonyms: ETHCOLLISIONS
ETHCRCAE Ethernet
Incoming Errored Frames
Synonyms:
ETHCRCAE
ETHDROPEVTS Ethernet Incoming Drop Events
Synonyms: ETHDROPEVTS
ETHFRGMTS Ethernet Incoming Fragmented Frames
Synonyms: ETHFRGMTS
ETHJABRS Ethernet Incoming Jabber Frames
Synonyms: ETHJABRS
ETHOVRSIZEPKTS Ethernet Incoming Oversize Frames
Synonyms: ETHOVRSIZEPKTS
ETHUNDRSIZEPKTS Ethernet Incoming Undersize Frames
Synonyms: ETHUNDRSIZEPKTS
ETHPKTS64OCTETS Ethernet 64-byte Frames
Synonyms:
ETHPKTS64OCTETS
ETHPKTS127OCTETS Ethernet 65-127-byte Frames
Synonyms:
ETHPKTS127OCTETS
ETHPKTS255OCTETS Ethernet 128-255-byte Frames
Synonyms:
ETHPKTS255OCTETS
ETHPKTS511OCTETS Ethernet 256-511-byte Frames
Synonyms:
ETHPKTS511OCTETS
ETHPKTS1023OCTETS Ethernet 512-1023-byte Frames
Synonyms:
ETHPKTS1023OCTETS
ETHPKTS1518OCTETS Ethernet 1024-1518-byte Frames
Synonyms:
ETHPKTS1518OCTETS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark

2416 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-1GBE Issue 1, December 2011

MONTYPE Value Description


High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds -
Near End Section Synonyms:
SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.

1830PSS R3.6.50 - TL1 Commands and Messages 2417


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-1GBE
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

2418 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-1GBE Issue 1, December 2011

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port 11STAR1-1-6-C1
is retrieved.

RTRV-PM-1GBE::11STMM10-1-6-C1:::CV-PCS,,,,15-MIN;

1830PSS R3.6.50 - TL1 Commands and Messages 2419


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-1GBE

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,1GBE:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-GBE::11STMM10-1-6-C1:::CV-PCS,,,,15-MIN [12345] (1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2420 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-CBR2G5


Command Name: RETRIEVE PERFORMANCE
MONITORING CBR2G5

PURPOSE
The RTRV-PM-CBR2G5 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified CBR2G5 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-CBR2G5 command contains lines of parsable output data
for each provisioned CBR2G5 AID specified. No output data is provided if the facility is not
provisioned. No output data is provided if the date and time specified exceeds the available collection
periods (i.e., exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
Since CBR2G5 facility provides non-intrusive monitoring of OC48 or STM16 signal (system standard
attribute determines which of the two is being monitored) monitored types applicable in this command
will follow RTRV-PM-OC48 when system in SONET mode and RTRV-PM-STM16 when system in SDH
mode.
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-CBR2G5:[TID]:AID:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2421


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBR2G5

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S (SONET
mode)
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS (SONET
mode)
BBE-RS Background Block Error - Near End RS
Section Synonyms: BBE-RS (SDH
mode)
ES-RS Errored Seconds - Near End RS
Section Synonyms: ES-RS (SDH mode)
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S (SONET
mode)
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S (SONET mode)
SES-RS Severely Errored Seconds - Near End
RS Section Synonyms: SES-RS
(SDH mode)
UAS-RS Unavailable Seconds - Near End RS
Section Synonyms: UAS-RS (SDH
mode)
ALL All Monitored Types

2422 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBR2G5 Issue 1, December 2011

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

1830PSS R3.6.50 - TL1 Commands and Messages 2423


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBR2G5

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None

2424 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBR2G5 Issue 1, December 2011

Description: Number of 15-minute historical registers, specifies the number of


previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


CBR2G5

1830PSS R3.6.50 - TL1 Commands and Messages 2425


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBR2G5
Description: Identifies the type of AID for the PM data being retrieved.

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S (SONET
mode)
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS (SONET
mode)
BBE-RS Background Block Error - Near End RS
Section Synonyms: BBE-RS (SDH
mode)
ES-RS Errored Seconds - Near End RS
Section Synonyms: ES-RS (SDH mode)
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-RS Severely Errored Seconds - Near End
RS Section Synonyms: SES-RS
(SDH mode)
UAS-RS Unavailable Seconds - Near End RS
Section Synonyms: UAS-RS (SDH
mode)
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S (SONET
mode)
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S (SONET mode)

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

2426 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBR2G5 Issue 1, December 2011

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

1830PSS R3.6.50 - TL1 Commands and Messages 2427


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBR2G5

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid

2428 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBR2G5 Issue 1, December 2011

• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, CV PM data for the current 15 minute interval for port 11STMM10-1-6-C1 is
retrieved.

RTRV-PM-CBR2G5::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,CBR2G5:CV-S,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-CBR2G5::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2429


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBR2G5

2430 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-CBRAR


Command Name: RETRIEVE PERFORMANCE
MONITORING CBRAR

PURPOSE
The RTRV-PM-CBRAR command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified CBRAR facility
(DATATYPE=FE or DATATYPE=HDSDI or DATATYPE=SDSDI or DATATYPE=3GSDI).
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-CBRAR command contains lines of parsable output data for
each provisioned CBRAR AID specified. No output data is provided if the facility is not provisioned.
No output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-CBRAR:[TID]:AID:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TM
PER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY]:DATATYPE;

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2431


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBRAR

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Synonyms: OPR-AVG
Average
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Synonyms: OPT-AVG
Average
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2432 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBRAR Issue 1, December 2011

{0-1048575} - DN <LEVEL> - Down, Only PM data for


the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2433


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBRAR
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None

2434 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBRAR Issue 1, December 2011

Description: Number of 1-day historical registers, specifies the number of


previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

DATATYPE Value Description


{FE,HDSDI,SDSDI,3GSDI}

Default: FE
Addressing: None
Description: Client Data type, identifies the type of client data (FE or HDSDI)
whose PM data registers are being retrieved.

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>,<DATATYPE>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


CBRAR

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2435


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBRAR

MONTYPE Value Description


OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.

2436 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBRAR Issue 1, December 2011

NA Not Available, the data is not available for the entire


period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

1830PSS R3.6.50 - TL1 Commands and Messages 2437


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBRAR

DATATYPE Value Description


{FE,HDSDI,SDSDI,3GSDI}

Description: Client Data type, identifies the type of client data (FE or HDSDI)
whose PM data registers are being retrieved.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, OPR-L PM data for the current 15 minute interval for port 4DPA4-1-6-C1 is
retrieved.

RTRV-PM-CBRAR::4DPA4-1-6-C1::OPR-L,,,,15-MIN,FE;

2438 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-CBRAR Issue 1, December 2011

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"4DPA4-1-6-C1,CBRAR:FE,OPR-L,-6.0,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-CBRAR::4DPA4-1-6-C1::FE,OPR-L,,,,15-MIN [12345] (1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2439


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-CBRAR

2440 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-EQPT


Command Name: RETRIEVE PERFORMANCE
MONITORING EQUIPMENT

PURPOSE
The RTRV-PM-EQPT command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified card.
For each monitored parameter, the current and/or up tothirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-EQPT command contains lines of parsable output data for
each provisioned EQPT AID specified. No output data is provided if the card is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-EQPT:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.
[DRV]

AID Value Description


EC-<shelf>-<slot> (Shelf Controller)
ALL

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2441


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-EQPT

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CPUAVG Average CPU Utilization Synonyms:
CPUAVG
HEAPUSG Peak heap memory usage
Synonyms: HEAPUSG
POOLUSG Peak pool memory usage
Synonyms: POOLUSG
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-100} - {DN,
UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2442 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-EQPT Issue 1, December 2011

{0-100} - DN <LEVEL> - Down, Only PM data for the


specified MONTYPE that is less-than or equal-to ( ≤ )
the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.

{0-100} - UP <LEVEL> - Up, Only PM data for the


specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note : when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


NA

Default: NA
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit).

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

1830PSS R3.6.50 - TL1 Commands and Messages 2443


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-EQPT
Default: Current date
Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

2444 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-EQPT Issue 1, December 2011

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


EC-<shelf>-<slot> (Shelf Controller)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


EQPT

Description: Identifies the type of AID for the PM data being retrieved.

MONTYPE Value Description


CPUAVG Average CPU Utilization Synonyms:
CPUAVG
HEAPUSG Peek heap memory usage
Synonyms: HEAPUSG
POOLUSG Peek pool memory usage
Synonyms: POOLUSG

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-100}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-100 Measured value of the monitored digital parameter,
value reported if VLDTY is not NA.

1830PSS R3.6.50 - TL1 Commands and Messages 2445


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-EQPT
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

2446 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-EQPT Issue 1, December 2011

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

1830PSS R3.6.50 - TL1 Commands and Messages 2447


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-EQPT
• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, PM data for the current 15 minute interval for port EC-1-1 is retrieved.

RTRV-PM-EQPT::EC-1-1:12345::,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"EC-1-1,EQPT:CPUAVG,59,,NEND,,15-MIN,3-27,11-15"
"EC-1-1,EQPT:HEAPUSG,14,,NEND,,15-MIN,3-27,11-15"
"EC-1-1,EQPT:POOLUSG,20,,NEND,,15-MIN,3-27,11-15"
/* RTRV-PM-EQPT::EC-1-1:12345::,,,,15-MIN [12345] (1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

2448 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-FC100


Command Name: RETRIEVE PERFORMANCE
MONITORING FC100

PURPOSE
The RTRV-PM-FC100 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified FC100 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-FC100 command contains lines of parsable output data for
each provisioned FC100 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-FC100:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2449


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC100

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2450 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC100 Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2451


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC100
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2452 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC100 Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC100

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2453


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC100

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2454 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC100 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2455


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC100

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2456 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC100 Issue 1, December 2011

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port
11STMM10-1-6-C1 is retrieved.

RTRV-PM-FC100::11STMM10-1-6-C1:12345::CV-PCS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,FC100:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-FC100::11STMM10-1-6-C1:::CV-PCS,,,,15-MIN [12345] (1)
*/
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2457


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC100

2458 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-FC1200


Command Name: RETRIEVE PERFORMANCE
MONITORING FC1200

PURPOSE
The RTRV-PM-FC1200 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified FC1200 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-FC1200 command contains lines of parsable output data for
each provisioned FC1200 AID specified. No output data is provided if the facility is not provisioned.
No output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-FC1200:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],
[TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
ALL

Default: ALL
Addressing: None
Description:Acces Identifier , identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2459


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC1200

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2460 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC1200 Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND}

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2461


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC1200
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2462 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC1200 Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC1200

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2463


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC1200

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm for analog values
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2464 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC1200 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2465


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC1200

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2466 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC1200 Issue 1, December 2011

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port 11STAR1-1-6 is
retrieved.

RTRV-PM-FC1200::11STAR1-1-6-C1:12345::CV-PCS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STAR1-1-6-C1,FC1200:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-FC1200::11STAR1-1-6-C1:12345::CV-PCS,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2467


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC1200

2468 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-FC200


Command Name: RETRIEVE PERFORMANCE
MONITORING FC200

PURPOSE
The RTRV-PM-FC200 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified FC200 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-FC200 command contains lines of parsable output data for
each provisioned FC200 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-FC200:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.
[DRV]

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
ALL
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2469


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC200

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2470 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC200 Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2471


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC200
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2472 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC200 Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC200

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2473


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC200

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2474 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC200 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2475


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC200

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2476 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC200 Issue 1, December 2011

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port
11STMM10-1-6-C1 is retrieved.

RTRV-PM-FC200::11STMM10-1-6-C1:12345::CV-PCS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,FC200:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-FC200::11STMM10-1-6-C1:::CV-PCS,,,,15-MIN [12345] (1)
*/
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2477


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC200

2478 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-FC400


Command Name: RETRIEVE PERFORMANCE
MONITORING FC400

PURPOSE
The RTRV-PM-FC400 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified FC400 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-FC400 command contains lines of parsable output data for
each provisioned FC400 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-FC400:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.
[DRV]

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2479


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC400

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2480 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC400 Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2481


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC400
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2482 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC400 Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1,3} (4DPA4 Client Ports - DualTran)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC400

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2483


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC400

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2484 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC400 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2485


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC400

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2486 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC400 Issue 1, December 2011

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port
11STMM10-1-6-C1 is retrieved.

RTRV-PM-FC400::11STMM10-1-6-C1:12345::CV-PCS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,FC400:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-FC400::11STMM10-1-6-C1:12345::CV-PCS,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2487


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC400

2488 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-FC800


Command Name: RETRIEVE PERFORMANCE
MONITORING FC800

PURPOSE
The RTRV-PM-FC800 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified FC800 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-FC800 command contains lines of parsable output data for
each provisioned FC800 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-FC800:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.
[DRV]

1830PSS R3.6.50 - TL1 Commands and Messages 2489


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC800

AID Value Description


112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2490 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC800 Issue 1, December 2011

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

1830PSS R3.6.50 - TL1 Commands and Messages 2491


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC800
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None

2492 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC800 Issue 1, December 2011

Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2493


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC800
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FC800

Description: Identifies the type of AID for the PM data being retrieved.

2494 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC800 Issue 1, December 2011

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

1830PSS R3.6.50 - TL1 Commands and Messages 2495


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC800

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

2496 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FC800 Issue 1, December 2011

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

1830PSS R3.6.50 - TL1 Commands and Messages 2497


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FC800
EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port
112SCX10-1-6-C1 is retrieved.

RTRV-PM-FC800::112SCX10-1-6-C1:12345::CV-PCS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"112SCX10-1-6-C1,FC800:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-FC800::112SCX10-1-6-C1:12345::CV-PCS,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

2498 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-FE


Command Name: RETRIEVE PERFORMANCE
MONITORING FE

PURPOSE
The RTRV-PM-FE command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified FE facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-FE command contains lines of parsable output data for each
provisioned FE AID specified. No output data is provided if the facility is not provisioned. No output
data is provided if the date and time specified exceeds the available collection periods (i.e., exceeds
8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-FE:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TMP
ER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)
ALL

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2499


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FE
Description: Access Identifier, identifies the
entity access identifier.
NOTE:for the 11DPE12,only optical FE SFP is supported
(the OPR/OPT is not supported as the SFP limitation).
for the 11DPE12E, the optical FE SFP and electrical FE
SFP are supported ,and for the electrical FE , the
OPR/OPT is not supported .

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2500 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FE Issue 1, December 2011

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ETHPKTER Ethernet Frame Error Ratio
Synonyms: ETHPKTER
ETHOCTETS Ethernet Number of Bytes
Synonyms: ETHOCTETS
ETHPKTS Ethernet Number of Frames
Synonyms: ETHPKTS
ETHMCSTPKTS Ethernet Incoming Multicast Frames
Synonyms: ETHMCSTPKTS
ETHBCSTPKTS Ethernet Incoming Broadcast Frames
Synonyms: ETHBCSTPKTS
ETHCOLLISIONS Ethernet Collision Events
Synonyms: ETHCOLLISIONS
ETHCRCAE Ethernet
Incoming Errored Frames
Synonyms:
ETHCRCAE
ETHDROPEVTS Ethernet Incoming Drop Events
Synonyms: ETHDROPEVTS
ETHFRGMTS Ethernet Incoming Fragmented Frames
Synonyms: ETHFRGMTS
ETHJABRS Ethernet Incoming Jabber Frames
Synonyms: ETHJABRS
ETHOVRSIZEPKTS Ethernet Incoming Oversize Frames
Synonyms: ETHOVRSIZEPKTS
ETHUNDRSIZEPKTS Ethernet Incoming Undersize Frames
Synonyms: ETHUNDRSIZEPKTS
ETHPKTS64OCTETS Ethernet 64-byte Frames
Synonyms:
ETHPKTS64OCTETS
ETHPKTS127OCTETS Ethernet 65-127-byte Frames
Synonyms:
ETHPKTS127OCTETS
ETHPKTS255OCTETS Ethernet 128-255-byte Frames
Synonyms:
ETHPKTS255OCTETS
ETHPKTS511OCTETS Ethernet 256-511-byte Frames
Synonyms:
ETHPKTS511OCTETS
ETHPKTS1023OCTETS Ethernet 512-1023-byte Frames
Synonyms:
ETHPKTS1023OCTETS
ETHPKTS1518OCTETS Ethernet 1024-1518-byte Frames
Synonyms:
ETHPKTS1518OCTETS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark

1830PSS R3.6.50 - TL1 Commands and Messages 2501


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FE

MONTYPE Value Description


High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds - Near End
Section Synonyms: SES-PCS
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.
OPR/OPT related parameters are only applied to 11DPE12E
optical FE SFP.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2502 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FE Issue 1, December 2011

{0-1048575} - DN <LEVEL> - Down, Only PM data for


the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2503


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FE
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None

2504 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FE Issue 1, December 2011

Description: Number of 1-day historical registers, specifies the number of


previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11DPE12-<shelf>-<slot>-C{1-12} (11DPE12 Client Ports)
11DPE12E-<shelf>-<slot>-C{1-12} (11DPE12E Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


FE

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2505


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FE

MONTYPE Value Description


CVS-PCS Code Violations - Near End PCS
Synonyms: CV-PCS
ETHPKTER Ethernet Frame Error Ratio
Synonyms: ETHPKTER
ETHOCTETS Ethernet Number of Bytes
Synonyms: ETHOCTETS
ETHPKTS Ethernet Number of Frames
Synonyms: ETHPKTS
ETHMCSTPKTS Ethernet Incoming Multicast Frames
Synonyms: ETHMCSTPKTS
ETHBCSTPKTS Ethernet Incoming Broadcast Frames
Synonyms: ETHBCSTPKTS
ETHCOLLISIONS Ethernet Collision Events
Synonyms: ETHCOLLISIONS
ETHCRCAE Ethernet
Incoming Errored Frames
Synonyms:
ETHCRCAE
ETHDROPEVTS Ethernet Incoming Drop Events
Synonyms: ETHDROPEVTS
ETHFRGMTS Ethernet Incoming Fragmented Frames
Synonyms: ETHFRGMTS
ETHJABRS Ethernet Incoming Jabber Frames
Synonyms: ETHJABRS
ETHOVRSIZEPKTS Ethernet Incoming Oversize Frames
Synonyms: ETHOVRSIZEPKTS
ETHUNDRSIZEPKTS Ethernet Incoming Undersize Frames
Synonyms: ETHUNDRSIZEPKTS
ETHPKTS64OCTETS Ethernet 64-byte Frames
Synonyms:
ETHPKTS64OCTETS
ETHPKTS127OCTETS Ethernet 65-127-byte Frames
Synonyms:
ETHPKTS127OCTETS
ETHPKTS255OCTETS Ethernet 128-255-byte Frames
Synonyms:
ETHPKTS255OCTETS
ETHPKTS511OCTETS Ethernet 256-511-byte Frames
Synonyms:
ETHPKTS511OCTETS
ETHPKTS1023OCTETS Ethernet 512-1023-byte Frames
Synonyms:
ETHPKTS1023OCTETS
ETHPKTS1518OCTETS Ethernet 1024-1518-byte Frames
Synonyms:
ETHPKTS1518OCTETS
ES-PCS Errored Seconds - Near End Section
Synonyms: ES-PCS
OPR-H Optical Power Received - Tide Mark

2506 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FE Issue 1, December 2011

MONTYPE Value Description


High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SEFS-PCS Severely Errored Frame Seconds -
Section Synonyms: SEFS-PCS
SES-PCS Severely Errored Seconds -
Near End Section Synonyms:
SES-PCS

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.
OPR/OPT related parameters are only applied to 11DPE12E
optical FE SFP.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0 dBm to +51.0dBm analog value
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

1830PSS R3.6.50 - TL1 Commands and Messages 2507


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FE
Description: Validity, is the validity indicator for monitored information.
ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

2508 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-FE Issue 1, December 2011

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, CV PCS PM data for the current 15 minute interval for port 11DPE12-1-6-C1
is retrieved.

RTRV-PM-FE::11DPE12-1-6-C1:::CV-PCS,,,,15-MIN;

1830PSS R3.6.50 - TL1 Commands and Messages 2509


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-FE

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11DPE12-1-6-C1,FE:CV-PCS,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-FE::11DPE12-1-6-C1:::CV-PCS,,,,15-MIN [12345] (1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2510 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OC12


Command Name: RETRIEVE PERFORMANCE
MONITORING OC12

PURPOSE
The RTRV-PM-OC12 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OC12 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OC12 command contains lines of parsable output data for
each provisioned OC12 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OC12:[TID]:AID:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TMP
ER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2511


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC12

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2512 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC12 Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2513


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC12
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2514 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC12 Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC12

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2515


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC12

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2516 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC12 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2517


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC12

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2518 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC12 Issue 1, December 2011

EXAMPLES
In the following example, CV PM data for the current 15 minute interval for port 11STMM10-1-6-C1 is
retrieved.

RTRV-PM-OC12::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,OC12:CV-S,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OC12::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2519


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC12

2520 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OC192


Command Name: RETRIEVE PERFORMANCE
MONITORING OC192

PURPOSE
The RTRV-PM-OC192 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified OC192 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OC192 command contains lines of parsable output data for
each provisioned OC192 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OC192:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2521


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC192

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2522 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC192 Issue 1, December 2011

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

1830PSS R3.6.50 - TL1 Commands and Messages 2523


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC192
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None

2524 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC192 Issue 1, December 2011

Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2525


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC192
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11STAR1-<shelf>-<slot>-C1 (11STAR1 Client Port)
11QPA4-<shelf>-<slot>-C{1-4} (11QPA4 Client Ports)
11QTA4-<shelf>-<slot>- C{1-4} (11QTA4 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC192

Description: Identifies the type of AID for the PM data being retrieved.

2526 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC192 Issue 1, December 2011

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

1830PSS R3.6.50 - TL1 Commands and Messages 2527


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC192

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

2528 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC192 Issue 1, December 2011

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

1830PSS R3.6.50 - TL1 Commands and Messages 2529


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC192
EXAMPLES
In the following example, CV PM data for the current 15 minute interval for port 11STAR1-1-6-C1 is
retrieved.

RTRV-PM-OC192::11STAR1-1-6-C1:12345::CV-S,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STAR1-1-6-C1,OC192:CV-S,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OC192::11STAR1-1-6-C1:12345::CV-S,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2530 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OC3


Command Name: RETRIEVE PERFORMANCE
MONITORING OC3

PURPOSE
The RTRV-PM-OC3 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OC3 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OC3 command contains lines of parsable output data for
each provisioned OC3 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OC3:[TID]:AID:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TMPE
R],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2531


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC3

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2532 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC3 Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2533


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC3
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2534 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC3 Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)

11DPM12-<shelf>-<slot>-C1-12 (11DPM12 Client Ports)


Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC3

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2535


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC3

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2536 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC3 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2537


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC3

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2538 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC3 Issue 1, December 2011

EXAMPLES
In the following example, CV PM data for the current 15 minute interval for port 11STMM10-1-6-C1 is
retrieved.

RTRV-PM-OC3::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,OC3:CV-S,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OC3::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN [12345] (1)
*/
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2539


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC3

2540 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OC48


Command Name: RETRIEVE PERFORMANCE
MONITORING OC48

PURPOSE
The RTRV-PM-OC48 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OC48 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OC48 command contains lines of parsable output data for
each provisioned OC48 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.5 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OC48:[TID]:AID:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TMP
ER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2541


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC48
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None

2542 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC48 Issue 1, December 2011

Description: Monitor level, specifies the discrimination level of PM parameter


values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

1830PSS R3.6.50 - TL1 Commands and Messages 2543


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC48
Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

2544 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC48 Issue 1, December 2011

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-C{1-4} (4DPA4 Client Ports)
4DPA2-<shelf>-<slot>-L{1-2} (4DPA2 Line Ports)
4DPA2-<shelf>-<slot>-C{1-2} (4DPA2 Client Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC48

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2545


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC48

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2546 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC48 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2547


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC48

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2548 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC48 Issue 1, December 2011

EXAMPLES
In the following example, CV PM data for the current 15 minute interval for port 11STMM10-1-6-C1 is
retrieved.

RTRV-PM-OC48::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STMM10-1-6-C1,OC48:CV-S,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OC48::11STMM10-1-6-C1:12345::CV-S,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2549


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC48

2550 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OC768


Command Name: RETRIEVE PERFORMANCE
MONITORING OC768

PURPOSE
The RTRV-PM-OC768 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified OC768 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OC768 command contains lines of parsable output data for
each provisioned OC768 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OC768:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2551


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC768

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter

2552 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC768 Issue 1, December 2011

(MONTYPE). The format of MONLEV is <LEVEL> -


<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN

1830PSS R3.6.50 - TL1 Commands and Messages 2553


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC768
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0

2554 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC768 Issue 1, December 2011

Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OC768

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2555


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC768

MONTYPE Value Description


CV-S Coding Violation - Section
Synonyms: CVS-S
ES-S Errored Seconds - Near End Section
Synonyms: ES-RS
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
SEFS-S Severely Errored Frame Seconds -
Near End Section Synonyms:
SEFS-S

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2556 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC768 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2557


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC768

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2558 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OC768 Issue 1, December 2011

EXAMPLES
In the following example, CV PM data for the current 15 minute interval for port 43STA1P-1-6-C1 is
retrieved.

RTRV-PM-OC768::43STA1P-1-6-C1:12345::CV-S,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"43STA1P-1-6-C1,OC768:CV-S,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OC768::43STA1P-1-6-C1:12345::CV-S,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2559


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OC768

2560 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OCH


Command Name: RETRIEVE PERFORMANCE
MONITORING OPTICAL CHANNEL

PURPOSE
The RTRV-PM-OCH command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OCH facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OCH command contains lines of parsable output data for
each provisioned OCH AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers)
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OCH:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TM
PER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2561


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

AID Value Description


AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

2562 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

AID Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2325B-<shelf>-<slot>-LINE-{9605, (AM2325B LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot>-LINE-{9605, (AM2017B LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,

1830PSS R3.6.50 - TL1 Commands and Messages 2563


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

AID Value Description


9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)
4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

2564 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

1830PSS R3.6.50 - TL1 Commands and Messages 2565


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

MONTYPE Value Description


OPOCHIN-H Optical Power Received - Tide Mark
High Synonyms: OPOCHINH
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHIN-L Optical Power Received - Tide Mark
Low Synonyms: OPOCHINL
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHIN-AVG Optical Power Received - Average
Synonyms: OPOCHINAVG
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHOUT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPOCHOUTH
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHOUT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPOCHOUTL
(AHPHG, AHPLG, A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHOUT-AVG Optical Power Transmitted - Average
Synonyms: OPOCHOUTAVG
(AHPHG, AHPLG, A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPR-H Optical Power Received - Tide
Mark High Synonyms: OPR-H
(SVAC Client , 4DPA4 and 11QPA4 VA
ports)
OPR-L Optical Power Received - Tide
Mark Low Synonyms: OPR-L
(SVAC Client , 11QPA4 and 4DPA4 VA
ports only)
OPR-AVG Optical Power Synonyms: OPR-AVG (SVAC Client ,
Received - Average 11QPA4 and 4DPA4 VA ports only)
OPT-H Optical Power Transmitted -
Tide Mark High Synonyms: OPT-H
(SVAC Line, 11QPA4 and 4DPA4 VA
ports only)
OPT-L Optical Power Transmitted -
Tide Mark Low Synonyms: OPT-L
(SVAC Line, 11QPA4 and 4DPA4 VA
ports only)
OPT-AVG Optical Power Synonyms: OPT-AVG (SVAC Line,
Transmitted - Average 11QPA4 and 4DPA4 VA ports only)

2566 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

MONTYPE Value Description


ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is validated but
ignored. That is, the MONLEV parameter is not applicable to
retrieving analog PM. Analog monitored values will always be
retrieved if the specified MONTYPE value is analog (i.e., OPR-L,
OPR-H, OPR-AVG, OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H,
OPIN-AVG, OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L,
OPOCHIN-H, OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{ NEND}

Default: NEND
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2567


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH
Description: Location specifies whether PM registers for near-end and/or
near-end EGRESS PM monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit).

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

2568 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2569


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

AID Value Description


AHPHG-<shelf>-<slot>-LINE-{9605, (AHPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
ALPHG-<shelf>-<slot>-LINE-{9605, (ALPHG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AHPLG-<shelf>-<slot>-LINE-{9605, (AHPLG LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
A2325A-<shelf>-<slot>-LINE-{9605, (A2325A LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,

2570 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

AID Value Description


9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2325B-<shelf>-<slot>-LINE-{9605, (AM2325B LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot>-LINE-{9605, (AM2017B LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,
9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2017B-<shelf>-<slot>-LINE-{9605, (AM2017B LINE Port Optical Channels)
9600, 9595, 9590, 9585, 9580, 9575,
9570, 9565, 9560, 9555, 9550, 9545,
9540, 9535, 9530, 9525, 9520, 9515,
9510, 9505, 9500, 9495, 9490, 9485,
9480, 9475, 9470, 9465, 9460, 9455,
9450, 9445, 9440, 9435, 9430, 9425,
9420, 9415, 9410, 9405, 9400, 9395,
9390, 9385, 9380, 9375, 9370, 9365,
9360, 9355, 9350, 9345, 9340, 9335,
9330, 9325, 9320, 9315, 9310, 9305,
9300, 9295, 9290, 9285, 9280, 9275,

1830PSS R3.6.50 - TL1 Commands and Messages 2571


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

AID Value Description


9270, 9265, 9260, 9255, 9250, 9245,
9240, 9235, 9230, 9225, 9220, 9215,
9210, 9205, 9200, 9195, 9190, 9185,
9180, 9175, 9170}
AM2125A-<shelf>-<slot>-{LINEIN, (AM2125A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2125B-<shelf>-<slot>-{LINEIN, (AM2125B Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
AM2318A-<shelf>-<slot>-{LINEIN, (AM2318A Optical Channels)
LINEOUT}-{9605, 9600, 9595, 9590,
9585, 9580, 9575, 9570, 9565, 9560,
9555, 9550, 9545, 9540, 9535, 9530,
9525, 9520, 9515, 9510, 9505, 9500,
9495, 9490, 9485, 9480, 9475, 9470,
9465, 9460, 9455, 9450, 9445, 9440,
9435, 9430, 9425, 9420, 9415, 9410,
9405, 9400, 9395, 9390, 9385, 9380,
9375, 9370, 9365, 9360, 9355, 9350,
9345, 9340, 9335, 9330, 9325, 9320,
9315, 9310, 9305, 9300, 9295, 9290,
9285, 9280, 9275, 9270, 9265, 9260,
9255, 9250, 9245, 9240, 9235, 9230,
9225, 9220, 9215, 9210, 9205, 9200,
9195, 9190, 9185, 9180, 9175, 9170}
SVAC-<shelf>-<slot>-{L1, C1} (SVAC Ports)

2572 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

AID Value Description


4DPA4-<shelf>-<slot>-VA{1-2} (4DPA4 eVOA Ports)
11QPA4-<shelf>-<slot>-VA{1-4} (11QPA4 eVOA Ports)
11DPE12E-<shelf>-<slot>-VA{1-2} (11DPE12E eVOA Ports)
11DPM12-<shelf>-<slot>-VA{1-2} (11DPM12 eVOA Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OCH

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2573


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

MONTYPE Value Description


OPOCHIN-H Optical Power Received - Tide Mark
High Synonyms: OPOCHINH
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHIN-L Optical Power Received - Tide Mark
Low Synonyms: OPOCHINL
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHIN-AVG Optical Power Received - Average
Synonyms: OPOCHINAVG
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHOUT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPOCHOUTH
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHOUT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPOCHOUTL
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPOCHOUT-AVG Optical Power Transmitted - Average
Synonyms: OPOCHOUTAVG
(AHPHG, AHPLG,A2325A, AM2325B,
AM2017B and ALPHG optical channels
only)
OPR-H Optical Power Received - Tide
Mark High Synonyms: OPR-H
(SVAC Client and 11QPA4, 4DPA4 VA
ports only)
OPR-L Optical Power Received - Tide
Mark Low Synonyms: OPR-L
(SVAC Client and 11QPA4,4DPA4 VA
ports only)
OPR-AVG Optical Power Synonyms: OPR-AVG (SVAC Client
Received - Average and 11QPA4, 4DPA4 VA ports only)
OPT-H Optical Power Transmitted -
Tide Mark High Synonyms: OPT-H
(SVAC Line and 11QPA4, 4DPA4 VA
ports only)
OPT-L Optical Power Transmitted -
Tide Mark Low Synonyms: OPT-L
(SVAC Line and 11QPA4, 4DPA4 VA
ports only)
OPT-AVG Optical Power Synonyms: OPT-AVG (SVAC Line and
Transmitted - Average 11QPA4, 4DPA4 VA ports only)

2574 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{-51.0 - 51.0, -99.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
{-51.0dBm to +51.0 dBm or -99.0dBm to indicate no power} Measured value
of the monitored parameter, value reported if VLDTY is not NA.
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND }

Description: Location, identifies the location where the MONTYPE is


monitored.

1830PSS R3.6.50 - TL1 Commands and Messages 2575


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction for LDRX
TRMT Transmit direction for LDTX

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:

2576 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OCH Issue 1, December 2011

IDNC Input, Data Not Consistent


• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

EXAMPLES
In the following example, OPOCHIN & OPOCHOUT PM data for the current 15 minute interval for port
ALPHG-5-6-LINE-9590 is retrieved.

RTRV-PM-OCH::ALPHG-5-6-LINE-9590:12345::ALL,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"ALPHG-5-6-LINE-9590,OCH:OPOCHIN-AVG,-20.8,PRTL,NEND,RCV,15-MIN,3-27
,11-15"
"ALPHG-5-6-LINE-9590,OCH:OPOCHIN-L,-21.2,PRTL,NEND,RCV,15-MIN,3-27,1
1-15"
"ALPHG-5-6-LINE-9590,OCH:OPOCHIN-H,-20.4,PRTL,NEND,RCV,15-MIN,3-27,1
1-15"
"ALPHG-5-6-LINE-9590,OCH:OPOCHOUT-AVG,-5.8,PRTL,NEND,RCV,15-MIN,3-27
,11-15"
"ALPHG-5-6-LINE-9590,OCH:OPOCHOUT-L,-6.2,PRTL,NEND,RCV,15-MIN,3-27,1
1-15"

"ALPHG-5-6-LINE-9590,OCH:OPOCHOUT-H,-5.4,PRTL,NEND,RCV,15-MIN,3-27,1
1-15"
/* RTRV-PM-OCH::APLHG-5-6-LINE-9590:12345::ALL,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2577


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OCH

2578 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-ODU1


Command Name: RETRIEVE PERFORMANCE
MONITORING ODU1

PURPOSE
The RTRV-PM-ODU1 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified ODU1 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-ODU1 command contains lines of parsable output data for
each provisioned ODU1 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-ODU1:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2579


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU1

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms:
UAS-ODU
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2580 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU1 Issue 1, December 2011

{0-1048575} - DN <LEVEL> - Down, Only PM data for


the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND}

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)
Only the value RCV is supported.

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None

1830PSS R3.6.50 - TL1 Commands and Messages 2581


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU1
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None

2582 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU1 Issue 1, December 2011

Description: Number of 1-day historical registers, specifies the number of


previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU1

Description: Identifies the type of AID for the PM data being retrieved.

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms:
UAS-ODU

1830PSS R3.6.50 - TL1 Commands and Messages 2583


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU1
Description: Monitored Parameter Type, identifies the type of monitored
parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored
parameter, value reported if VLDTY is not NA.
NA Not Available, value reported if VLDTY is NA.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
accumulate normally.

LOCN Value Description


{NEND }

Description: Location, identifies the location where the MONTYPE is


monitored.

2584 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU1 Issue 1, December 2011

DIRN Value Description


{RCV}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent

1830PSS R3.6.50 - TL1 Commands and Messages 2585


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU1
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 4DPA4-1-6-L1 is
retrieved.

RTRV-PM-ODU1::4DPA4-1-6-L1:12345::BBE-ODU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"4DPA4-1-6-L1,ODU1:BBE-ODU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-ODU1::4DPA4-1-6-L1:12345::BBE-ODU,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2586 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-ODU2


Command Name: RETRIEVE PERFORMANCE
MONITORING ODU2

PURPOSE
The RTRV-PM-ODU2 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified ODU2 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-ODU2 command contains lines of parsable output data for
each provisioned ODU2 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-ODU2:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2587


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU2

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms: UAS-ODU
ALL All Monitored Types

Default: ALL

2588 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU2 Issue 1, December 2011

Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.
Note: when entered value for MONLEV is 0-UP the
command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND,FEND}

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.

1830PSS R3.6.50 - TL1 Commands and Messages 2589


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU2
The far-end parameters are only supported on 11STAR1,11QPA4
, 11QTA4, 11STAR1A client ports, 11DPM12,11DPE12E line ports
and 43STX4P client ports.

DIRN Value Description


{RCV}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)
Only the value RCV is supported.

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

2590 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU2 Issue 1, December 2011

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2591


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU2

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU2

Description: Identifies the type of AID for the PM data being retrieved.

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms: UAS-ODU

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.

2592 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU2 Issue 1, December 2011

0-4294967295 Measured value of the monitored


parameter, value reported if VLDTY is not NA.
NA Not Available, value reported if VLDTY is NA.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
accumulate normally.

LOCN Value Description


{NEND,FEND }

Description: Location, identifies the location where the MONTYPE is


monitored.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.
The far-end parameters are only supported on 11STAR1,11QPA4,
11QTA4, 11STAR1A client ports, 11DPM12,11DPE12E line ports
and 43STX4P client ports.

DIRN Value Description


{RCV}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.

1830PSS R3.6.50 - TL1 Commands and Messages 2593


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU2

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid

2594 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU2 Issue 1, December 2011

• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 11STAR1-1-6-L1 is
retrieved.

RTRV-PM-ODU2::11STAR1-1-6-L1:12345::BBE-ODU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STAR1-1-6-L1,ODU2:BBE-ODU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-ODU2::11STAR1-1-6-L1:12345::BBE-ODU,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2595


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU2

2596 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-ODU3


Command Name: RETRIEVE PERFORMANCE
MONITORING ODU3

PURPOSE
The RTRV-PM-ODU3 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified ODU3 facility.
For each monitored parameter, the current and/or up to thirty-three (33) 15-minute historical PM
registers, or the current and/or up to eight (8) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-ODU3 command contains lines of parsable output data for
each provisioned ODU3 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-ODU3:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
ALL

Default: ALL

1830PSS R3.6.50 - TL1 Commands and Messages 2597


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU3
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms: UAS-ODU
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2598 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU3 Issue 1, December 2011

{0-1048575} - DN <LEVEL> - Down, Only PM data for


the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND,FEND}

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.
The far-end parameters are only supported 43STX4P,43STA1 line
ports.

DIRN Value Description


{RCV}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)
Only the value RCV is supported.

1830PSS R3.6.50 - TL1 Commands and Messages 2599


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU3

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

2600 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU3 Issue 1, December 2011

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU3

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2601


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU3

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms: UAS-ODU

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored
parameter, value reported if VLDTY is not NA.
NA Not Available, value reported if VLDTY is NA.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
accumulate normally.

2602 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU3 Issue 1, December 2011

LOCN Value Description


{NEND,FEND }

Description: Location, identifies the location where the MONTYPE is


monitored.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.
The far-end parameters are only supported 43STX4P,43STA1 line
ports.

DIRN Value Description


{RCV}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

1830PSS R3.6.50 - TL1 Commands and Messages 2603


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU3
UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 43STX4-1-6-L1 is
retrieved.

RTRV-PM-ODU3::43STX4-1-6-L1:12345::BBE-ODU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"43STX4-1-6-L1,ODU3:BBE-ODU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-ODU3::43STX4-1-6-L1:12345::BBE-ODU,,,,15-MIN [12345]
(1) */
;

2604 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU3 Issue 1, December 2011

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2605


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU3

2606 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-ODU4


Command Name: RETRIEVE PERFORMANCE
MONITORING ODU4

PURPOSE
The RTRV-PM-ODU4 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified ODU4 facility.
For each monitored parameter, the current and/or up to thirty-three (33) 15-minute historical PM
registers, or the current and/or up to eight (8) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-ODU4 command contains lines of parsable output data for
each provisioned ODU4 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-ODU4:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
ALL

Default: ALL

1830PSS R3.6.50 - TL1 Commands and Messages 2607


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU4
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms: UAS-ODU
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

2608 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU4 Issue 1, December 2011

{0-1048575} - DN <LEVEL> - Down, Only PM data for


the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG) or ALL

LOCN Value Description


{NEND}

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)
Only the value RCV is supported.

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

1830PSS R3.6.50 - TL1 Commands and Messages 2609


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU4

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with

2610 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU4 Issue 1, December 2011

MONDAT and MONTM will be the first output followed by the


NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


ODU4

Description: Identifies the type of AID for the PM data being retrieved.

MONTYPE Value Description


BBE-ODU Background Block Error - Near End
ODUk Path Synonyms: BBE-ODU
ES-ODU Errored Seconds - Near End ODUk
Path Synonyms: ES-ODU
SES-ODU Severely Errored Seconds - Near End
ODUk Path Synonyms: SES-ODU
UAS-ODU Unavailable Seconds - Near End ODUk
Path Synonyms: UAS-ODU

1830PSS R3.6.50 - TL1 Commands and Messages 2611


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU4
Description: Monitored Parameter Type, identifies the type of monitored
parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored
parameter, value reported if VLDTY is not NA.
NA Not Available, value reported if VLDTY is NA.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
accumulate normally.

LOCN Value Description


{NEND }

Description: Location, identifies the location where the MONTYPE is


monitored.

2612 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-ODU4 Issue 1, December 2011

DIRN Value Description


{RCV}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent

1830PSS R3.6.50 - TL1 Commands and Messages 2613


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-ODU4
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 112SCX10-1-6-L1 is
retrieved.

RTRV-PM-ODU4::112SCX10-1-6-L1:12345::BBE-ODU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"112SCX10-1-6-L1,ODU4:BBE-ODU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-ODU4::112SCX10-1-6-L1:12345::BBE-ODU,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2614 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OSC


Command Name: RETRIEVE PERFORMANCE
MONITORING OPTICAL SUPERVISORY
CHANNEL

PURPOSE
The RTRV-PM-OSC command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OSC facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OSC command contains lines of parsable output data for
each provisioned OSC AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OSC:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TM
PER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2615


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OSC

AID Value Description


AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2616 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OSC Issue 1, December 2011

MONTYPE Value Description


OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPR-AVG
CV-S Code Violations - Near End Section
Synonyms: CV-S
(SONET mode only)
ES-S Errored Seconds - Near End Section
Synonyms: ES-S
(SONET mode only)
SEFS-S Severely Errored Frame Seconds -
Section Synonyms: SEFS-S (SONET
mode only)
SES-S Severely Errored Seconds - Near End
Section Synonyms: SES-S
(SONET mode only)
BBE-RS Background Block Error - Near End RS
Section Synonyms: BBE-RS (SDH
mode only)
ES-RS Errored Seconds - Near End RS
Section Synonyms: ES-RS (SDH mode
only)
SES-RSS Severely Errored Seconds - Near
End RS Section Synonyms: SES-RS
(SDH mode only)
UAS-RS Unavailable Seconds - Near End RS
Section Synonyms: UAS-RS
(SDH mode only)
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

1830PSS R3.6.50 - TL1 Commands and Messages 2617


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OSC
Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV, TRMT,ALL}

Default: ALL
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

2618 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OSC Issue 1, December 2011

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

1830PSS R3.6.50 - TL1 Commands and Messages 2619


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OSC

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

AID Value Description


AHPHG-<shelf>-<slot>-OSC (AHPHG OSC Port)
ALPHG-<shelf>-<slot>-OSC (ALPHG OSC Port)
AHPLG-<shelf>-<slot>-OSC (AHPLG OSC Port)
ALPFGT-<shelf>-<slot>-OSCSFP (ALPFGT OSCSFP Port)
A2325A-<shelf>-<slot>-OSC (A2325A OSC Port)
AM2325B-<shelf>-<slot>-OSC (AM2325B OSC Port)
AM2017B-<shelf>-<slot>-OSC (AM2017B OSC Port)
AM2125A-<shelf>-<slot>-OSCSFP (AM2125A OSCSFP Port)
AM2125B-<shelf>-<slot>-OSCSFP (AM2125B OSCSFP Port)
AM2318A-<shelf>-<slot>-OSCSFP (AM2318A OSCSFP Port)
OSCT-<shelf>-<slot>-OSCSFP (OSCT OSCSFP Port)

Description: Access Identifier, identifies the entity access identifier.

2620 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OSC Issue 1, December 2011

AIDTYPE Value Description


OSC

Description: Identifies the type of AID for the PM data being retrieved.

MONTYPE Value Description


CVS Code Violations - Near End Section
Synonyms: CV-S
ESS Errored Seconds - Near End Section
Synonyms: ES-S
SEFSS Severely Errored Frame Seconds -
Section Synonyms: SEFS-S
SESS Severely Errored Seconds - Near End
Section Synonyms: SES-S
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored
parameter, value reported if VLDTY is not NA.
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

1830PSS R3.6.50 - TL1 Commands and Messages 2621


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OSC

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit (egress) direction.

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

2622 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OSC Issue 1, December 2011

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

1830PSS R3.6.50 - TL1 Commands and Messages 2623


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OSC
EXAMPLES
In the following example, CVS PM data for the current 15 minute interval for port ALPHG-6-6-OSC is
retrieved.

RTRV-PM-OSC:: ALPHG-6-6-OSC:12345::CVS,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
" ALPHG-6-6-OSC,OSC:CVS,59,COMPL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OSC:: ALPHG-6-6-OSC:12345::CVS,,,,15-MIN [12345] (1)
*/
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2624 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OTS


Command Name: RETRIEVE PERFORMANCE
MONITORING OTS

PURPOSE
The RTRV-PM-OTS command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OTS facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OTS command contains lines of parsable output data for
each provisioned OTS AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OTS:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[TM
PER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2625


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTS

AID Value Description


AHPHG-<shelf>-<slot>-LINE (AHPHG LINE Port)
ALPHG-<shelf>-<slot>-LINE (ALPHG LINE Port)
AHPLG-<shelf>-<slot>-LINE (AHPLG LINE Port)
ALPFGT-<shelf>-<slot>-LINE (ALPFGT LINE Port)
OSCT-<shelf>-<slot>-LINE (OSCT LINE Port)
A2325A-<shelf>-<slot>-LINE (A2325A LINE Port)
AM2325B-<shelf>-<slot>-LINE (AM2325B LINE Port)
AM2017B-<shelf>-<slot>-LINE (AM2017B LINE Port)
AM2125A-<shelf>-<slot>-LINEIN (AM2125A LINEIN Port)
AM2125B-<shelf>-<slot>-LINEIN (AM2125B LINEIN Port)
AM2318A-<shelf>-<slot>-LINEIN (AM2318A LINEIN Port)
RA2P-<shelf>-<slot>-LINEIN (RA2P LINEIN Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


OPIN-H Total Optical Power Received - Tide
Mark High Synonyms: OPINH
OPIN-L Total Optical Power Received - Tide
Mark Low Synonyms: OPINL
OPIN-AVG Total Optical Power Received - Average
Synonyms: OPINAVG
OPOUT-H Total Optical Power Transmitted - Tide
Mark High Synonyms: OPOUTH
OPOUT-L Total Optical Power Transmitted - Tide
Mark Low Synonyms: OPOUTL
OPOUT-AVG Total Optical Power Transmitted -
Average Synonyms:
OPOUTAVG
ALL All Monitored Types

2626 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTS Issue 1, December 2011

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter x PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is validated but
ignored. That is, the MONLEV parameter is not applicable to
retrieving analog PM. Analog monitored values will always be
retrieved if the specified MONTYPE value is analog (i.e., OPR-L,
OPR-H, OPR-AVG, OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H,
OPIN-AVG, OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L,
OPOCHIN-H, OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{ NEND}

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end and/or
near-end EGRESS PM monitoring are to be reported.

1830PSS R3.6.50 - TL1 Commands and Messages 2627


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTS

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit).

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None

2628 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTS Issue 1, December 2011

Description: Number of 15-minute historical registers, specifies the number of


previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

OUTPUT PARAMETERS

1830PSS R3.6.50 - TL1 Commands and Messages 2629


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTS

AID Value Description


AHPHG-<shelf>-<slot>-LINE (AHPHG LINE Port)
ALPHG-<shelf>-<slot>-LINE (ALPHG LINE Port)
AHPLG-<shelf>-<slot>-LINE (AHPLG LINE Port)
ALPFGT-<shelf>-<slot>-LINE (ALPFGT LINE Port)
A2325A-<shelf>-<slot>-LINE (A2325A LINE Port)
AM2325B-<shelf>-<slot>-LINE (AM2325B LINE Port)
AM2017B-<shelf>-<slot>-LINE (AM2017B LINE Port)
AM2125A-<shelf>-<slot>-LINEIN (AM2125A LINEIN Port)
AM2125B-<shelf>-<slot>-LINEIN (AM2125B LINEIN Port)
AM2318A-<shelf>-<slot>-LINEIN (AM2318A LINEIN Port)
RA2P-<shelf>-<slot>-LINEIN (RA2P LINEIN Port)
OSCT-<shelf>-<slot>-LINE (OSCT LINE Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTS

Description: Identifies the type of AID for the PM data being retrieved.

MONTYPE Value Description


OPIN-H Total Optical Power Received - Tide
Mark High Synonyms: OPINH
OPIN-L Total Optical Power Received - Tide
Mark Low Synonyms: OPINL
OPIN-AVG Total Optical Power Received - Average
Synonyms: OPINAVG
OPOUT-H Total Optical Power Transmitted - Tide
Mark High Synonyms: OPOUTH
OPOUT-L Total Optical Power Transmitted - Tide
Mark Low Synonyms: OPOUTL
OPOUT-AVG Total Optical Power Transmitted -
Average Synonyms:
OPOUTAVG

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{-51.0 - 51.0, -99.0}
NA

2630 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTS Issue 1, December 2011

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
{-51.0dBm to +51.0 dBm or -99.0dBm to indicate no power} Measured value
of the monitored parameter, value reported if VLDTY is not NA.
NA Not Available, value reported if VLDTY is NA. Not
Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates normal accumulation in the current
period

LOCN Value Description


{NEND }

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction for LDRX
TRMT Transmit direction for LDTX

TMPER Value Description


15-MIN
1-DAY

1830PSS R3.6.50 - TL1 Commands and Messages 2631


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTS
Description: Time Period, identifies the accumulation time period for
performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

2632 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTS Issue 1, December 2011

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, OPOUT-H PM data for the current 15 minute interval for port
ALPHG-1-9-LINE is retrieved.

RTRV-PM-OTS:: ALPHG-1-9-LINE:12345::OPOUTH,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"ALPHG-1-9-LINE:OPOUTH,10.4,COMPL,NEND,TRMT,15-MIN,3-27,11-15"
/* RTRV-PM-OTS:: ALPHG-1-9-LINE:12345::OPOUTH,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2633


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTS

2634 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OTU1


Command Name: RETRIEVE PERFORMANCE
MONITORING OTU1

PURPOSE
The RTRV-PM-OTU1 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OTU1 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OTU1 command contains lines of parsable output data for
each provisioned OTU1 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OTU1:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

1830PSS R3.6.50 - TL1 Commands and Messages 2635


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU1

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

MONTYPE Value Description


BBE-OTU Background Block Synonyms: BBE-OTU
Error - Near End OTUk Section
ES-OTU Errored Seconds - Near End
OTUk Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near
End Synonyms: FECC
FECUBC FEC Errors Uncorrectable
Errors - Near End Synonyms:
FECUBC
OPR-H Optical Power Received - Tide
Mark High Synonyms: OPR-H
OPR-L Optical Power Received - Tide
Mark Low Synonyms: OPR-L
OPR-AVG Optical Power Synonyms: OPR-AVG
Received - Average
OPT-H Optical Power Transmitted -
Tide Mark High Synonyms: OPT-H
OPT-L Optical Power Transmitted -
Tide Mark Low Synonyms: OPT-L
OPT-AVG Optical Power Synonyms: OPT-AVG
Transmitted - Average
SES-OTU Severely Errored Synonyms: SES-OTU
Seconds - Near End OTUk Section
UAS-OTU Unavailable Seconds - Synonyms: UAS-OTU
Near End OTUk Section
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

2636 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU1 Issue 1, December 2011

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

1830PSS R3.6.50 - TL1 Commands and Messages 2637


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU1

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

2638 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU1 Issue 1, December 2011

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


11STMM10-<shelf>-<slot>-C{1-10} (11STMM10 Client Ports)
4DPA4-<shelf>-<slot>-L{1-2} (4DPA4 Line Ports)
11DPM12-<shelf>-<slot>-C{1-12} (11DPM12 Client Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU1

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2639


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU1

MONTYPE Value Description


BBE-OTU Background Block Error - Near End
OTUk Section Synonyms: BBE-OTU
ES-OTU Errored Seconds - Near End OTUk
Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near End
Synonyms: FECC
FECUBC FEC Errors Uncorrectable Errors -
Near End Synonyms: FECUBC
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-OTU Severely Errored Seconds - Near End
OTUk Section Synonyms: SES-OTU
UAS-OTU Unavailable Seconds - Near End OTUk
Section Synonyms: UAS-OTU

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2640 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU1 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

1830PSS R3.6.50 - TL1 Commands and Messages 2641


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU1

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

2642 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU1 Issue 1, December 2011

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 4DPA4-1-6-L1 is
retrieved.

RTRV-PM-OTU1::4DPA4-1-6-L1:12345::BBE-OTU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"4DPA4-1-6-L1,OTU1:BBE-OTU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OTU1::4DPA4-1-6-L1:12345::BBE-OTU,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS

RELATED AUTONOMOUS RESPONSES

1830PSS R3.6.50 - TL1 Commands and Messages 2643


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU1

2644 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OTU2


Command Name: RETRIEVE PERFORMANCE
MONITORING OTU2

PURPOSE
The RTRV-PM-OTU2 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OTU2 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OTU2 command contains lines of parsable output data for
each provisioned OTU2 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OTU2:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2645


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU2

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2646 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU2 Issue 1, December 2011

MONTYPE Value Description


BBE-OTU Background Block Error - Near End
OTUk Section Synonyms: BBE-OTU
ES-OTU Errored Seconds - Near End OTUk
Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near End
Synonyms: FECC
FECUBC FEC Errors Uncorrectable Errors - Near
End Synonyms: FECUBC
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-OTU Severely Errored Seconds - Near End
OTUk Section Synonyms: SES-OTU
UAS-OTU Unavailable Seconds - Near End OTUk
Section Synonyms: UAS-OTU
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

1830PSS R3.6.50 - TL1 Commands and Messages 2647


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU2
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND,FEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.
The far-end parameters are only supported on 11STAR1,11QPA4,
11QTA4, 11STAR1A client ports, 11DPM12,11DPE12E line ports
and 43STX4P client ports.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

2648 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU2 Issue 1, December 2011

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

1830PSS R3.6.50 - TL1 Commands and Messages 2649


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU2

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

2650 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU2 Issue 1, December 2011

AID Value Description


43STX4-<shelf>-<slot>-C{1-4} (43STX4 Client Ports)
43STX4P-<shelf>-<slot>-C{1-4} (43STX4P Client Ports)
43SCX4-<shelf>-<slot>-C{1-4} (43SCX4 Client Ports)
43SCX4L-<shelf>-<slot>-C{1-4} (43SCX4L Client Ports)
11STAR1-<shelf>-<slot>-{L1, C1} (11STAR1 Ports)
11STMM10-<shelf>-<slot>-L1 (11STMM10 Line Port)
11STGE12-<shelf>-<slot>-L1 (11STGE12 Line Port)
112SX10L-<shelf>-<slot>-C{1-10} (112SX10L Client Ports)
112SCX10-<shelf>-<slot>-C{1-10} (112SCX10 Client Ports)
112SNX10-<shelf>-<slot>-C{1-10} (112SNX10 Client Ports)
11QPA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QPA4 Line/Client Ports)
11QTA4-<shelf>-<slot>-{L{1-4}, C{1-4}} (11QTA4 Ports)
11DPE12-<shelf>-<slot>-L{1-2} (11DPE12 Line Ports)
11DPE12E-<shelf>-<slot>-L{1-2} (11DPE12E Line Ports)
11DPM12-<shelf>-<slot>-L{1-2} (11DPM12 Line Ports)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU2

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2651


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU2

MONTYPE Value Description


BBE-OTU Background Block Error - Near End
OTUk Section Synonyms: BBE-OTU
ES-OTU Errored Seconds - Near End OTUk
Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near End
Synonyms: FECC
FECUBC FEC Errors Uncorrectable Errors - Near
End Synonyms: FECUBC
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-OTU Severely Errored Seconds - Near End
OTUk Section Synonyms: SES-OTU
UAS-OTU Unavailable Seconds - Near End OTUk
Section Synonyms: UAS-OTU

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

2652 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU2 Issue 1, December 2011

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND,FEND}

Description: Location, identifies the location where the MONTYPE is


monitored.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.
The far-end parameters are only supported on 11STAR1,11QPA4
, 11QTA4, 11STAR1A client ports, 11DPM12,11DPE12E line ports
and 43STX4P client ports.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

1830PSS R3.6.50 - TL1 Commands and Messages 2653


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU2

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid

2654 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU2 Issue 1, December 2011

• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 11STAR1-1-6-L1 is
retrieved.

RTRV-PM-OTU2::11STAR1-1-6-L1:12345::BBE-OTU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"11STAR1--1-6-L1,OTU2:BBE-OTU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OTU2::11STAR1--1-6-L1:12345::BBE-OTU,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2655


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU2

2656 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OTU3


Command Name: RETRIEVE PERFORMANCE
MONITORING OTU3

PURPOSE
The RTRV-PM-OTU3 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OTU3 facility.
For each monitored parameter, the current and/or up to thirty-three (33) 15-minute historical PM
registers, or the current and/or up to eight (8) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OTU3 command contains lines of parsable output data for
each provisioned OTU3 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OTU3:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

1830PSS R3.6.50 - TL1 Commands and Messages 2657


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU3

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)
ALL

Default: ALL
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2658 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU3 Issue 1, December 2011

MONTYPE Value Description


BBE-OTU Background Block Error - Near End
OTUk Section Synonyms: BBE-OTU
ES-OTU Errored Seconds - Near End OTUk
Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near End
Synonyms: FECC
FECUBC FEC Errors Uncorrectable Errors - Near
End Synonyms: FECUBC
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-OTU Severely Errored Seconds - Near End
OTUk Section Synonyms: SES-OTU
UAS-OTU Unavailable Seconds - Near End OTUk
Section Synonyms: UAS-OTU
ALL All Monitored Types

Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:

1830PSS R3.6.50 - TL1 Commands and Messages 2659


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU3
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, OPIN-L, OPIN-H, OPIN-AVG,
OPOUT-L, OPOUT-H, OPOUT-AVG, OPOCHIN-L, OPOCHIN-H,
OPOCHIN-AVG, OPOCHOUT-L, OPOCHOUT-H,
OPOCHOUT-AVG) or ALL

LOCN Value Description


{NEND,FEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.
The far-end parameters are only supported 43STX4P,43STA1 line
ports.

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

2660 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU3 Issue 1, December 2011

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

1830PSS R3.6.50 - TL1 Commands and Messages 2661


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU3
Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

AID Value Description


43STX4-<shelf>-<slot>-L1 (43STX4 Line Port)
43STX4P-<shelf>-<slot>-L1 (43STX4P Line Port)
43SCX4-<shelf>-<slot>-L1 (43SCX4 Line Port)
43SCX4L-<shelf>-<slot>-L1 (43SCX4L Line Port)
43STA1P-<shelf>-<slot>-L1 (43STA1P Line Port)
43SCA1-<shelf>-<slot>-L1 (43SCA1 Line Port)
43STA1P-<shelf>-<slot>-C1 (43STA1P Client Port)
43SCA1-<shelf>-<slot>-C1 (43SCA1 Client Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU3

Description: Identifies the type of AID for the PM data being retrieved.

2662 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU3 Issue 1, December 2011

MONTYPE Value Description


BBE-OTU Background Block Error - Near End
OTUk Section Synonyms: BBE-OTU
ES-OTU Errored Seconds - Near End OTUk
Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near End
Synonyms: FECC
FECUBC FEC Errors Uncorrectable Errors - Near
End Synonyms: FECUBC
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-OTU Severely Errored Seconds - Near End
OTUk Section Synonyms: SES-OTU
UAS-OTU Unavailable Seconds - Near End OTUk
Section Synonyms: UAS-OTU

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

1830PSS R3.6.50 - TL1 Commands and Messages 2663


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU3

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND,FEND}

Description: Location, identifies the location where the MONTYPE is


monitored.
Location specifies whethere PM registers for far-end PM
monitoring are to be reported.
The far-end parameters are only supported 43STX4P,43STA1 line
ports.

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

2664 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU3 Issue 1, December 2011

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.
Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid

1830PSS R3.6.50 - TL1 Commands and Messages 2665


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU3
• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 43STX4-1-6-L1 is
retrieved.

RTRV-PM-OTU3::43STX4-1-6-L1:12345::BBE-OTU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"43STX4--1-6-L1,OTU3:BBE-OTU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OTU3::43STX4--1-6-L1:12345::BBE-OTU,,,,15-MIN [12345]
(1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

2666 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-OTU4


Command Name: RETRIEVE PERFORMANCE
MONITORING OTU4

PURPOSE
The RTRV-PM-OTU4 command retrieves the current and/or historical 15-minute and/or 1-day PM data
corresponding to the PM data collection register(s) selected for the specified OTU4 facility.
For each monitored parameter, the current and/or up to thirty-three (33) 15-minute historical PM
registers, or the current and/or up to eight (8) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-OTU4 command contains lines of parsable output data for
each provisioned OTU4 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-OTU4:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[T
MPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description


<VALID TID VALUE>

Default: <SID>
Addressing: None
Description: Target IDentifier, identifies the network node TID for the command.

AID Value Description


112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)
ALL

Default: ALL

1830PSS R3.6.50 - TL1 Commands and Messages 2667


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU4
Addressing: None
Description: Access Identifier, identifies the entity access identifier.

CTAG Value Description


<1-6 VALID CTAG CHARACTERS>

Default: <System-assigned CTAG value>


Addressing: None
Description: Correlation TAG, associates input command with its output
responses.

2668 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU4 Issue 1, December 2011

MONTYPE Value Description


BBE-OTU Background Block Error - Near End
OTUk Section Synonyms: BBE-OTU
ES-OTU Errored Seconds - Near End OTUk
Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near End
Synonyms: FECC
FECUBC FEC Errors Uncorrectable Errors - Near
End Synonyms: FECUBC
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-OTU Severely Errored Seconds - Near End
OTUk Section Synonyms: SES-OTU
UAS-OTU Unavailable Seconds - Near End OTUk
Section Synonyms: UAS-OTU
CDR-AVG Chromatic Dispersion Received -
Average Synonyms:
CDR-AVG
CDR-H Chromatic Dispersion Received - Tide
Mark High Synonyms: CDR-H
CDR-L Chromatic Dispersion Received - Tide
Mark Low Synonyms: CDR-L
DGDR-AVG Differential Group Delay Received -
Average Synonyms:
DGDR-AVG
DGDR-H Differential Group Delay Received -
Tide Mark High Synonyms: DGDR-H
DGDR-L Differential Group Delay Received -
Tide Mark Low Synonyms: DGDR-L
FOFFR-AVG Frequency Offset Received - Average
Synonyms:
FOFFR-AVG
FOFFR-H Frequency Offset Received - Tide Mark
High Synonyms: FOFFR-H
FOFFR-L Frequency Offset Received - Tide Mark
Low Synonyms: FOFFR-L
ALL All Monitored Types

1830PSS R3.6.50 - TL1 Commands and Messages 2669


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU4
Default: ALL
Addressing: None
Description: Monitored parameter type, identifies the type of monitored
parameter whose PM data registers are being retrieved.
The MONTYPEs CDR-AVG, CDR-H, CDR-L, DGDR-AVG,
DGDR-H, DGDR-L, FOFFR-AVG, FOFFR-H and FOFFR-L shall
only apply to the line interface (L1) of the 112SCX10 and 112SCA1
packs.

MONLEV Value Description


{ LEVEL - DIRECTION : {0-1048575} -
{DN, UP} }

Default: 1-UP
Addressing: None
Description: Monitor level, specifies the discrimination level of PM parameter
values to be reported for the specified monitored parameter
(MONTYPE). The format of MONLEV is <LEVEL> -
<DIRECTION>. Values are:
{0-1048575} - DN <LEVEL> - Down, Only PM data for
the specified MONTYPE that is less-than or equal-to (
≤ ) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-DN the


command result is only PM data for the specified
MONTYPE that is equal-to 0.
{0-1048575} - UP <LEVEL> - Up, Only PM data for the
specified MONTYPE that is greater-than or equal-to ( ≥
) the value of < LEVEL> is reported.

Note: when entered value for MONLEV is 0-UP the


command result is only PM data for the specified
MONTYPE
that is greater-than or equal-to 0 (this result
coincide with all PM data for specified MONTYPE).
For retrieval of analog PM, the MONLEV filter is ignored. That is,
the MONLEV parameter is not applicable to retrieving analog PM.
Analog monitored values will always be retrieved if the specified
MONTYPE value is analog (i.e., OPR-L, OPR-H, OPR-AVG,
OPT-L, OPT-H, OPT-AVG, CDR-L, CDR-H, CDR-AVG, DGDR-L,
DGDR-H, DGDR-AVG, FOFFR-L, FOFFR-H, FOFFR-AVG) or ALL

LOCN Value Description


{NEND }

Default: NEND
Addressing: None
Description: Location specifies whether PM registers for near-end PM
monitoring are to be reported.

2670 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU4 Issue 1, December 2011

DIRN Value Description


{RCV,TRMT,ALL}

Default: RCV
Addressing: None
Description: Direction, specifies the direction of the signal being monitored
(receive or transmit)

TMPER Value Description


{15-MIN, 1-DAY, BOTH}

Default: 15-MIN
Addressing: None
Description: Time Period, identifies the accumulation time period for the
retrieved performance monitoring information.

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Default: Current date


Addressing: None
Description: Monitor date, specifies the (starting) date of the PM collection
period for which PM data is to be reported.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Default: Current hour and beginning of the current 15-minute window.


Addressing: None
Description: Monitor Time, if TMPER of 15-MIN, BOTH is entered, specifies the
(starting) time of the PM collection period for which PM data is to
be retrieved. If TMPER of 1-DAY is entered, the value of MONTM
is ignored (i.e., an entered value is validated, but does not affect
the command execution). The minutes 0-14, 15-29, 30-44 resp.
45-59 specifies the first, second, third respective the fourth
15-minute period within the specified hour.

NUM15MIN Value Description


ALL
0-32

Default: 0

1830PSS R3.6.50 - TL1 Commands and Messages 2671


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU4
Addressing: None
Description: Number of 15-minute historical registers, specifies the number of
previous 15-minute historical PM registers to retrieve in addition to
that specified by MONDAT and MONTM. The register specified
with MONDAT and MONTM will be the first output followed by the
NUM15MIN previous registers. Values are:
0-32 0-32 previous historical 15-minute PM data registers
ALL All previous historical 15-minute PM data registers

NUM1DAY Value Description


ALL
0-7

Default: 0
Addressing: None
Description: Number of 1-day historical registers, specifies the number of
previous 1-day historical PM registers to retrieve in addition to that
specified by MONDAT and MONTM. The register specified with
MONDAT and MONTM will be the first output followed by the
NUM1DAY previous registers.Values are:
0-7 0-7 previous historical 1-day PM data registers
ALL All previous historical 1-day PM data registers

SUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^COMPLD cr lf
[^^^"<AID>,<AIDTYPE>:<MONTYPE>,<MONVAL>,<VLDTY>,<LOCN>,<DIRN>,<TMPER
>,<MONDAT>,<MONTM>" cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

Note: The first line of parsable output is provided only when a value for NUM15MIN is entered. The
second line of parsable output is provided for each PM data register reported.

OUTPUT PARAMETERS

2672 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU4 Issue 1, December 2011

AID Value Description


112SCA1-<shelf>-<slot>-L1 (112SCA1 Line Port)
112SNA1-<shelf>-<slot>-L1 (112SNA1 Line Port)
112SA1L-<shelf>-<slot>-L1 (112SA1L Line Port)
112SCX10-<shelf>-<slot>-L1 (112SCX10 Line Port)
112SNX10-<shelf>-<slot>-L1 (112SNX10 Line Port)
112SX10L-<shelf>-<slot>-L1 (112SX10L Line Port)

Description: Access Identifier, identifies the entity access identifier.

AIDTYPE Value Description


OTU4

Description: Identifies the type of AID for the PM data being retrieved.

1830PSS R3.6.50 - TL1 Commands and Messages 2673


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU4

MONTYPE Value Description


BBE-OTU Background Block Error - Near End
OTUk Section Synonyms: BBE-OTU
ES-OTU Errored Seconds - Near End OTUk
Section Synonyms: ES-OTU
FECC FEC Errors Corrected - Near End
Synonyms: FECC
FECUBC FEC Errors Uncorrectable Errors - Near
End Synonyms: FECUBC
OPR-H Optical Power Received - Tide Mark
High Synonyms: OPR-H
OPR-L Optical Power Received - Tide Mark
Low Synonyms: OPR-L
OPR-AVG Optical Power Received - Average
Synonyms: OPR-AVG
OPT-H Optical Power Transmitted - Tide Mark
High Synonyms: OPT-H
OPT-L Optical Power Transmitted - Tide Mark
Low Synonyms: OPT-L
OPT-AVG Optical Power Transmitted - Average
Synonyms: OPT-AVG
SES-OTU Severely Errored Seconds - Near End
OTUk Section Synonyms: SES-OTU
UAS-OTU Unavailable Seconds - Near End OTUk
Section Synonyms: UAS-OTU
CDR-AVG Chromatic Dispersion Received -
Average Synonyms:
CDR-AVG
CDR-H Chromatic Dispersion Received - Tide
Mark High Synonyms: CDR-H
CDR-L Chromatic Dispersion Received - Tide
Mark Low Synonyms: CDR-L
DGDR-AVG Differential Group Delay Received -
Average Synonyms:
DGDR-AVG
DGDR-H Differential Group Delay Received -
Tide Mark High Synonyms: DGDR-H
DGDR-L Differential Group Delay Received -
Tide Mark Low Synonyms: DGDR-L
FOFFR-AVG Frequency Offset Received - Average
Synonyms:
FOFFR-AVG
FOFFR-H Frequency Offset Received - Tide Mark
High Synonyms: FOFFR-H
FOFFR-L Frequency Offset Received - Tide Mark
Low Synonyms: FOFFR-L

2674 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU4 Issue 1, December 2011

Description: Monitored Parameter Type, identifies the type of monitored


parameter whose PM data is being reported.

MONVAL Value Description


{0-4294967295}
{-51.0 - 51.0}
NA

Description: Monitored Value, identifies the measured value of the monitored


parameter reported.
0-4294967295 Measured value of the monitored digital
parameter, value reported if VLDTY is not NA.
{-51.0 - 51.0} -51.0dBm to +51.0 dBm for analog parameters
NA Not Available, value reported if VLDTY is NA. NA is
displayed also if optical layer monitoring is disabled.

VLDTY Value Description


ADJ
COMPL
LONG
NA
PRTL
""

Description: Validity, is the validity indicator for monitored information.


ADJ Data has been manually adjusted or initialized.
COMPL Data has been accumulated over the entire period.
LONG Data is accumulated over a period greater than the
indicated time.
NA Not Available, the data is not available for the entire
period (e.g., Module failed, Module being reset etc.).
PRTL Partial, the data was accumulated over some
portion of the time period, but not the entire period
(e.g., Module failed, cold-start of the module during
accumulation period).
"" NULL indicates that current register is being
collected normally.

LOCN Value Description


{NEND}

Description: Location, identifies the location where the MONTYPE is


monitored.

1830PSS R3.6.50 - TL1 Commands and Messages 2675


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU4

DIRN Value Description


{RCV,TRMT}

Description: Direction, indicates the direction of the signal being monitored.


RCV Receive direction.
TRMT Transmit direction (only analog transmit parameters
use TRMT)

TMPER Value Description


15-MIN
1-DAY

Description: Time Period, identifies the accumulation time period for


performance monitoring information (1-day or 15-minute collection
register).

MONDAT Value Description


{ MONTH - DAY : {01-12} - {01-31} }

Description: Monitor Date, identifies the date when the PM collection period
began.

MONTM Value Description


{ HOUR - MINUTE : {00-23} - {00-59} }

Description: Monitor Time, identifies the time of day when the PM collection
period began.

UNSUCCESSFUL RESPONSE FORMAT

cr lf lf
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> cr lf
M^^<CTAG>^DENY cr lf
^^^<ERROR CODE> cr lf
[^^^/*^<Expanded_Error_Code_Description>^*/ cr lf]
[^^^/*^<Informational_Error_Description_Text>^*/ cr lf]
[^^^/*^<Optional_Suggested_Action_Text>^*/ cr lf]
[^^^/*^<Command_Echo>^[<CTAG>]^(<Session_Number>)^*/ cr lf]
;

ERROR CODES
Refer to Appendix D, Error Codes, for a complete list of Error Codes. Appendix D also contains a list
of Error Codes that are used if the command cannot be correctly parsed by the Command Parser.

2676 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
RTRV-PM-OTU4 Issue 1, December 2011

Parser generated Error Codes are not duplicated below. Other non-Parser Error Codes used with this
command are:
IDNC Input, Data Not Consistent
• any invalid combinations of month and number of days are entered in the MONDAT parameter

• any value is entered for the NUM15MIN parameter, and TMPER=1-DAY is entered

• any value is entered for the NUM1DAY parameter, and TMPER=15-MIN,

IDNV Input, Data Not Valid


• TMPER of {15-MIN, BOTH} is entered and the date and time specified by MONDAT and MONTM
is not within the previous 8.25 hours of the current time

• TMPER of 1-DAY is entered and the date and time specified by MONDAT and MONTM is not
within the previous 8 days of the current date

EXAMPLES
In the following example, BBE PM data for the current 15 minute interval for port 112SCX10-1-6-L1 is
retrieved.

RTRV-PM-OTU4::112SCX10-1-6-L1:12345::BBE-OTU,,,,15-MIN;

<SID> <YY-MM-DD> <HH:MM:SS>


M 12345 COMPLD
"112SCX10--1-6-L1,OTU3:BBE-OTU,59,PRTL,NEND,RCV,15-MIN,3-27,11-15"
/* RTRV-PM-OTU4::112SCX10--1-6-L1:12345::BBE-OTU,,,,15-MIN
[12345] (1) */
;

RELATED COMMANDS
INIT-REG-rr

RELATED AUTONOMOUS RESPONSES


No related autonomous message.

1830PSS R3.6.50 - TL1 Commands and Messages 2677


8DG61100 EAAAQZZA
Issue 1, December 2011 RTRV-PM-OTU4

2678 1830PSS R3.6.50 - TL1 Commands and Messages


8DG61100 EAAAQZZA
Issue 1, December 2011

Command Code: RTRV-PM-STM16


Command Name: RETRIEVE PERFORMANCE
MONITORING STM16

PURPOSE
The RTRV-PM-STM16 command retrieves the current and/or historical 15-minute and/or 1-day PM
data corresponding to the PM data collection register(s) selected for the specified STM16 facility.
For each monitored parameter, the current and/or up to thirty-two (32) 15-minute historical PM
registers, or the current and/or up to seven (7) 1-day historical PM registers or both 15-minute and
1-day PM registers can be retrieved.
The successful response for a RTRV-PM-STM16 command contains lines of parsable output data for
each provisioned STM16 AID specified. No output data is provided if the facility is not provisioned. No
output data is provided if the date and time specified exceeds the available collection periods (i.e.,
exceeds 8.25 hours of 15-minute PM registers or 8 days for 1-day PM registers).
The denials for this command are detailed in section Deny Scenarios.

INPUT FORMAT

RTRV-PM-STM16:[TID]:[AID]:[CTAG]::[MONTYPE],[MONLEV],[LOCN],[DIRN],[
TMPER],[MONDAT],[MONTM],[NUM15MIN],[NUM1DAY];

INPUT PARAMETERS

TID Value Description

You might also like