61186003L1 35D

MX2820 System
TL1 Reference Guide

Document Number: 61186003L1-35D
October 2007
MX2820 System TL1 Reference Guide
Trademarks
Front Matter
Any brand names and product names included in this document are trademarks, registered
trademarks, or trade names of their respective holders.
To the Holder of the Document

The contents of this document are current as of the date of publication. ADTRAN reserves the
right to change the contents without prior notice.
In no event will ADTRAN be liable for any special, incidental, or consequential damages or
for commercial losses even if ADTRAN has been advised thereof as a result of issue of this
publication.
901 Explorer Boulevard

P.O. Box 140000
Huntsville, AL 35814-4000
(256) 963-8000
2007 ADTRAN, Inc.

All Rights Reserved.
ii 61186003L1-35D
Revision History
Revision Date Description
A November 2003 Initial release
B August 2004 Add STS-1 and Clock Modules and associated commands
C March 2005 Add RADIUS documentation
D October 2007 Add 1186002L3 and update document format and add SSH
Conventions
The following typographical conventions are used in this document:
This font indicates a cross-reference link.
This font indicates screen menus, fields, and parameters.
THIS FONT indicates keyboard keys (ENTER, ESC, ALT). Keys that are to be pressed simultaneously
are shown with a plus sign (ALT+X indicates that the ALT key and X key should be pressed at the
same time).
This font indicates references to other documentation and is also used for emphasis.
This font indicates on-screen messages and prompts.
This font indicates text to be typed exactly as shown.
This font indicates silk-screen labels or other system label items.
This font is used for strong emphasis.
NOTE
Notes inform the user of additional, but essential, information or
features.
CAUTION
Cautions inform the user of potential damage, malfunction, or
disruption to equipment, software, or environment.
WARNING
Warnings inform the user of potential bodily pain, injury, or death.
61186003L1-35D iii
Training
ADTRAN offers training courses on our products. These courses include overviews on product
features and functions while covering applications of ADTRAN product lines. ADTRAN
provides a variety of training options, including customized training and courses taught at our
facilities or at customer sites.
For inquiries concerning training, contact ADTRAN:
Training Phone: 800-615-1176, ext. 6996
Training Fax: 256-963-6217
Training Email: training@adtran.com
iv 61186003L1-35D
Contents
Section 1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
TL1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Transport Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
TL1 Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
TL1 Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Operations Support System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
SCU Client Management Modes of Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
MX2820 System TL1 Command Cross-Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Section 2
TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Notations and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
General Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
TID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
SCU Client Management Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
INE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Expansion Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Common Language Location Identifier (CLLI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Acknowledgment Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Acknowledgment Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Normal Response Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
MX2820 System TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
ADTRAN TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
User Account Requirements (Access Privileges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Section 3
ADTRAN AID Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
SCU Operation Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
SCU Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
61186003L1-35D v
Intelligent Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Expansion Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
AID Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Section 4
Common (SCU) TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
ACT-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
RADIUS Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Challenge response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
CANC-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
MENUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
SET-DAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Section 5
Provisioning TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
ED-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
vi 61186003L1-35D
Contents

Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
RTRV-rr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
RTRV-TH-rr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7
SET-TH-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9
Transmission Entity Data Parameter Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Section 6
Security TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
DLT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
ED-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
61186003L1-35D vii
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

ENT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
RTRV-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
Section 7
Surveillance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
ALW-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
INH-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
RTRV-ALM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Format for no Alarm Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Format for Alarm Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7
viii 61186003L1-35D
Contents
RTRV-ALM-ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Environmental Alarm Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
RTRV-COND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
RTRV-HDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
RTRV-PM-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
RTRV-PMSCHED-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
RTRV-SYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
61186003L1-35D ix
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19

Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20
RTRV-VER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22
RTRV-VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24
SCHED-PMREPT-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26
Section 8
System Maintenance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
SW-TOPROTN-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
SW-TOWKG-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5
x 61186003L1-35D
Contents
Section 9
System Test TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
OPR-LPBK-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3
RLS-LPBK-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5
Appendix A
Input Commands Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Appendix B
Response Messages Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1
Appendix C
Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1
Appendix D
Alarms and Alarm Condition Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
SCU Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1
M13 MUX Card Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-3
STS-1 MUX Card Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-5
MX2820 Clock Card Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-7
Appendix E
Autonomous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1
Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-2
SCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3
Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3
Performance Monitoring Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3
61186003L1-35D xi
Condition Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3

Autonomous Message Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
M13 MUX Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
Command Response from Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
Corresponding Clears. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4
Threshold Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5
M13 MUX Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5
Environmental Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5
Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5
Appendix F
Performance Monitoring Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1
M13 Mux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1
STS-1 MUX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-3
Appendix G
MX2820 Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Limitations of Diagrams. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Event Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Criteria Monitored for an Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1
Definition of AINS Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3
Definitions of Available and Unavailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3
Recursive alarm suppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3
Traditional States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3
Backward Compatibility with Traditional States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-4
Operational Service State Model for Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Independent Equipment Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Indication of the Active Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
State E1a: IS ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-6
State E1b: IS STDBYH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7
State E3: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7
State E4a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8
State E4b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8
State E5a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9
State E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9
State E6: OOS-AUMA UAS, UEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-10
Operational Service State Model for Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11
The Network Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11
Network Facility vs. DS1/E1 Facility Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11
Special Note about the EC-1/STS-1 Facility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11
Change of Facility Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15
State F1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15
State F1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-16
xii 61186003L1-35D
Contents
State F2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-17

State F3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-18
State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-19
State F4: OOS-AU FLT, AINS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-20
State F5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-21
State F6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-22
State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-23
State F7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-24
State F8: OOS-AUMA SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-25
Operational Service State Model for VT Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-26
Operation in T1 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-26
Operation in E1 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-26
Effects of the Traditional State for an Attached DS1/E1 Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-28
State P1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-29
State P1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-30
State P2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-31
State P3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-32
State P3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-33
State P4: OOS-MA, SDEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-34
State P5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-35
State P6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-36
State P7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-37
State P7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-38
State P8: OOS-AUMA SGEO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-39
Appendix H
List of Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1
61186003L1-35D xiii
Figures
Figure G-1. MX2820 System Service State Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-2

Figure G-2. Equipment Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5
Figure G-3. Facility Service States, Provisioned Service State = IS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-12
Figure G-4. Facility Service States, Provisioned Service State = OOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-13
Figure G-5. Other Facility Service States, Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-14
Figure G-6. VT Service States, Provisioned Service State = IS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-26
Figure G-7. VT Service States, Provisioned Service State = OOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-27
Figure G-8. Other VT Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-27
xiv 61186003L1-35D
Tables
Tables
Table 1-1. MX2820 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Table 1-2. TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Table 2-1. TL1 Input Command General Format Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Table 2-2. TL1 Response Message Format Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Table 2-3. MX2820 TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
Table 3-1. 19-Inch Chassis AID Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Table 3-2. 23-Inch Chassis AID Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2
Table 3-3. MX2820 AID Parameter Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning Parameters
AID: 1-EQPT-SCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10
Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13
Table 5-3. DS3 MUX (P/N 1186002Lx) T3 Data Provisioning Parameters
AID: 1-T3-(MUX1-MUX9)-1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19
AID: 1-T1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20
Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22
Table 5-6. STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning Parameters
AID: 1-STS1-(MUX1-MUX9)-1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27
Table 5-7. STS-1 MUX (P/N 1186005Lx) VT Data Provisioning Parameters
AID: 1-VT1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
Table 5-8. STS-1 MUX (P/N 1186005Lx) T1 Data Provisioning Parameters
AID: 1-T1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29
Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning Parameters
AID: 1-EQPT-CLK-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
Table 7-1. MX2820 Environmental Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Table A-1. TL1 Input Commands Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-1
Table B-1. TL1 Response Messages Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-1
Table C-1. MX2820 System Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-1
Table D-1. MX2820 SCU Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-1
Table D-2. MX2820 M13 MUX Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-3
Table D-3. MX2820 STS-1 MUX Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-5
Table D-4. MX2820 Clock Card Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-7
Table E-1. Autonomous Messages Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .E-1
Table F-1. M13 MUX Performance Monitoring MONTYPE Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1
Table F-2. STS-1 MUX Performance Monitoring MONTYPE Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-3
Table G-1. State E1a: IS ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-6
Table G-2. State E1b: IS STDBYH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7
Table G-3. State E3: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7
Table G-4. State E4a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8
Table G-5. State E4b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8
Table G-6. State E5a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9
Table G-7. State E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9
Table G-8. State E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-10
Table G-9. Change of Facility Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15
61186003L1-35D xv
Table G-10. State F1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15

Table G-11. State F1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-16
Table G-12. State F2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-17
Table G-13. State F3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-18
Table G-14. State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-19
Table G-15. State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-20
Table G-16. State F5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-21
Table G-17. State F6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-22
Table G-18. State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-23
Table G-19. State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-24
Table G-20. State OOS-AUMA SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-25
Table G-21. Transition Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-28
Table G-22. State P1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-29
Table G-23. State P1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-30
Table G-24. State P2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-31
Table G-25. State P3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-32
Table G-26. State P3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-33
Table G-27. State P4: OOS-MA, SDEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-34
Table G-28. State P5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-35
Table G-29. State P6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-36
Table G-30. State P7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-37
Table G-31. State P7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-38
Table G-32. State P8: OOS-AUMA SGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-39
xvi 61186003L1-35D
Section 1
Introduction
PURPOSE
This manual provides Transaction Language 1 (TL1) reference information for the MX2820
System. This document is intended for use by operating company personnel who use TL1
commands to perform network management tasks for the MX2820 System and its associated
network equipment. For additional information about the MX2820 System, refer to the
MX2820 System Manual (P/N 61186003L1-1).
TL1 OVERVIEW
TL1 software provides an ASCII-based protocol that allows the exchange of messages between
an Operations Support System (OSS) and the MX2820 System. The TL1 software also allows
the exchange of messages between the OSS and the network equipment that connects to the
MX2820 System. An OSS is also referred to as an Operations System (OS).
Transport Methods
The TL1 software uses the following methods for transporting messages:
X.25 packet network (Network Management)
Transmission Control Protocol/Internet Protocol (TCP/IP) Telnet socket
There are two configurable ports for TL1 access (having default values of 2000 and 2001). The
first indicates that the connection was made and describes the MENUS command. The second
is a raw connection that will not send anything upon connection.
TL1 Sessions
The maximum number of TL1 logon sessions at one time depends on the physical and logical
interfaces to the MX2820 System Controller Unit (SCU).
The X.25 interface allows a maximum of four TL1sessions, one per Switched Virtual Circuit
(SVC) with up to four SVCs.
The Ethernet interface allows up to eight Telnet sessions. All eight sessions can be TL1 over
TCP/IP.
61186003L1-35D 1-1
TL1 Message Types

The TL1 software provides four types of operation messages:
Input command
An input command is a message from an OS or other source to a Network Element (NE).
The message instructs or requests the NE to perform a management-related function.
Acknowledgment
An acknowledgment is a reply from the NE that indicates an input command is being
acted upon. An NE sends an acknowledgment response if a normal response or error
response cannot be sent within two seconds. The MX2820 System supports the In
Progress (IP) acknowledgment response.
The IP acknowledgment response indicates the request has been initiated and produces
subsequent output messages which provide a termination report or a termination report
with command results.
Output response (Response message or Error message)
An output response is a detailed reply or set of replies to an input command. It contains
information that indicates whether the command was successfully executed. The output
response also contains any data that needs to be returned to the OS/user.
Autonomous
An autonomous message is generated by an NE either on a periodic basis or is generated
by an NE to report an alarm or an event that occurs at the NE. These messages are
normally triggered by alarm conditions and are not in response to any input command.
OPERATIONS SUPPORT SYSTEM

An OSS consists of application software that runs on a host computer and allows the host
computer to provide network management functions. The SCU provides the network
management interface for the MX2820 System and the network equipment that interconnects
to and interworks with the MX2820 System.
The SCU and the MX2820 System supports the following network management functions:
Configuration
Fault
Performance Monitoring
Security
Test
From a network management standpoint, the MX2820 System and the network equipment are
referred to as NEs that exchange messages with the host computer of the OS.
1-2 61186003L1-35D
Section 1, Introduction - SCU Client Management Modes of Operations
SCU CLIENT MANAGEMENT MODES OF OPERATIONS

If an SCU is a client unit, the SCU can operate in two modes: Intelligent Network Element
(INE) and Expansion Shelf. The mode of operation has an impact on the Target Identifier (TID)
and the Access Identifier (AID) fields in a TL1 command. Refer to the TL1 Commands section
in this document for additional information about these fields.
If an SCU is a host unit, the client management mode is not available.
NETWORK ELEMENTS
The MX2820 System supports and/or provides the NEs shown in Table 1-1.
NOTE
This reference guide is also used for the coinciding RoHS products
not specifically mentioned. The RoHS part number uses an E or
G instead of an L in the part number.
Table 1-1. MX2820 Network Elements
Network Element Part Number
System Controller Unit 1186003Lx
DS3 MUX 1186002Lx
Clock Card 1186004Lx
STS-1 MUX 1186005Lx
Note: Refer to www.adtran.com for a complete list of products.
REFERENCES
For more information, including details on each list series, refer to the MX2820 System
Manual (P/N 61186003L1-1).
61186003L1-35D 1-3
MX2820 SYSTEM TL1 COMMAND CROSS-REFERENCE

Table 1-2 lists the available TL1 commands for the MX2820 System.
Table 1-2. TL1 Commands
Common (SCU) Section-Page Command Type
ACT-USER 4-2 Common
ALW-MSG 7-2 Surveillance
CANC-USER 4-4 Common
DLT-USER-SECU 6-2 Security
ED-rr 5-2 Provisioning
ED-USER-SECU 6-4 Security
ENT-USER-SECU 6-6 Security
INH-MSG 7-4 Surveillance
MENUS 4-5 Common
OPR-LPBK-rr 9-2 System Test
RLS-LPBK-rr 9-4 System Test
RTRV-rr 5-4 Provisioning
RTRV-ALM 7-6 Surveillance
RTRV-ALM-ENV 7-8 Surveillance
RTRV-COND 7-11 Surveillance
RTRV-HDR 7-13 Surveillance
RTRV-PM-rr 7-15 Surveillance
SCHED-PMREPT-rr 7-25 Surveillance
RTRV-PMSCHED-rr 7-17 Surveillance
RTRV-SYS 7-19 Surveillance
RTRV-TH-rr 5-6 Provisioning
RTRV-USER-SECU 6-8 Security
RTRV-VER 7-21 Surveillance
RTRV-VERSION 7-23 Surveillance
SET-DAT 4-6 Common
SET-TH-rr 5-8 Provisioning
SW-TOPROTN-rr 8-2 System Maintenance
SW-TOWKG-rr 8-4 System Maintenance
1-4 61186003L1-35D
Section 2
TL1 Commands
INTRODUCTION
This section provides information about the TL1 commands for the MX2820 System.
SYNTAX
The following syntax is used with TL1 commands.
A colon (:) separates the fields of a TL1 command.
The colon also separates unused or empty fields from required fields in a TL1 command.
A comma (,) separates data entry items within a common data block, a specific data block,
and a state block.
A semicolon (;) indicates the end of a TL1 command.
NOTE
The carriage return does not indicate the end of a TL1 command.
NOTE
The BACKSPACE and DELETE keys are nonfunctional when entering
TL1 commands. To abort a command, press CTRL+X.
61186003L1-35D 2-1
NOTATIONS AND CONVENTIONS

The following notations and conventions are used for TL1 input commands:
<> Information inside of the less than and greater than symbols
indicates a data entry item for a command. The symbols are not
transmitted as part of the command.
[] Information inside of brackets indicates the parameter is
optional for an input command. The brackets are not transmit-
ted as part of the command.
{|} Information inside of braces and separated by a pipe indicates
that one of the parameters must be selected from the list. The
braces and the pipes are not transmitted as part of the
command.
Unless noted otherwise, the TL1 input commands are not case sensitive. This manual
presents the commands in all uppercase as a documentation standard/convention.
GENERAL FORMAT
A TL1 input command for the MX2820 System has the following general format:
<verb>:<tid>:<aid>:<ctag>:<general block>:<common data block>:
<specific data block>:<state block>;
Table 2-1 provides a description for each field. Appendix A, Input Commands Data
Dictionary and Appendix B, Response Messages Data Dictionary contains additional infor-
mation about the parameters used with TL1 commands and response messages to the TL1
commands.
NOTE
The MX2820 System does not output an error message for data
entries in a non-supported field of a TL1 command.
Table 2-1. TL1 Input Command General Format Descriptions
Field Description
<verb> This field contains the TL1 command verb. The command verb indicates the
action that is to be performed at the MX2820 System shelf, or another NE. The
command verb can have up to two optional modifiers.
The valid forms are as follows:
VERB
VERB-MODIFIER
VERB-MODIFIER-MODIFIER.
<tid> This field is the Target Identifier (TID). For more information, refer to the TID
on page 2-3 subsection.
2-2 61186003L1-35D
Section 2, TL1 Commands - General Format
Table 2-1. TL1 Input Command General Format Descriptions (Continued)
Field Description
<aid> This field is the Access Identifier (AID). For more information, refer to Section
3, ADTRAN AID Formats.
<ctag> The Correlation Tag (CTAG) is a one-to-six alphanumeric identifier that is ech-
oed in the response message for a TL1 command. The CTAG correlates input
commands with response messages. All response messages to a TL1 command
must have the same CTAG.
<general block> This field is not used in this application and should be left empty. This field
requires entering a field separator unless the <ctag> field is the last required
field.
<common data This field contains data that applies to specific TL1 commands. Refer to the
block> specific TL1 command sections and to applicable data dictionary appendices in
this document for additional information.
<specific data This field contains data that applies to specific TL1 commands. Refer to the
block> specific TL1 command sections and to applicable data dictionary appendices in
<state block> This field contains data that applies to specific TL1 commands. Refer to the
specific TL1 command sections and to applicable data dictionary appendices in
: The colon is used as a field separator.
; The semicolon is used as a TL1 command terminator. The command termina-

tor can be used after the last non-empty field without supplying the remaining
colon separators.
TID
The TID parameter indicates the end-target NE for a TL1 command. The client management
mode of operation for the SCU can have an impact on the value for this field. The following
subsection provides additional information.
NOTE
If the SCU functions as the host network management unit, the
client management mode of operation is not available.
SCU Client Management Operation Mode
INE
When operating in the INE mode, the SCU has a unique TID and operates as an independent
intelligent network element. TL1 commands route to this SCU if the TIDs in the commands
match the TID of this SCU. INE is the default client management mode for the SCU. With this
operation mode, the shelf number for the <aid> field is always a 1.
61186003L1-35D 2-3
Expansion Shelf
Up to thirty-two SCUs can share a common TID for systems operating in the Expansion
Shelf mode. TL1 commands route to the appropriate SCU based on the shelf number in the
<aid> field.
Common Language Location Identifier (CLLI)

The CLLI code is often used as the TID in TL1 commands. The CLLI code is one- to twenty-
alphanumeric characters that are not case sensitive. The CLLI code identifies physical
locations and equipment such as buildings, central offices, antennae, channel banks, and
shelves. CLLI codes are also used as unique identifiers for a single NE. CLLI codes are
assigned at the OS. The following example provides a CLLI code.
Example:
HTVLALEXD16
Input Parameters:
HTVL The first four character identify the place name (Huntsville).
AL The next two characters identify the state, region, or territory
(Alabama).
EX The next two characters identify the central office location code.
These characters typically identify the street location of the
specific central office.
In this example, EX represents Explorer Blvd.
D The next single alpha character is the equipment type code. The
equipment type code of D identifies general administrative
equipment.
16 The last two numeric characters represent a unique identifier
number for a specific central office. These characters identify
which NE is being addressed.
ACKNOWLEDGMENT RESPONSES
If an NE cannot send a normal response or an error response to the OS/user within two
seconds of receiving a TL1 command, the NE sends an acknowledgment response of IP.
Acknowledgment Syntax
The syntax for the acknowledgment responses supported by the MX2820 System are as
follows:
NOTE
This symbol (<) represents the TL1 ready indicator.
IP[^<CTAG>] <cr> <lf>

<
2-4 61186003L1-35D
Section 2, TL1 Commands - Normal Response Messages
NORMAL RESPONSE MESSAGES

The standard TL1 response message for the MX2820 System has the following format:
<cr> <lf> <lf>
^^^<source identifier>^<date>^<time> <cr> <lf>
M^^<ctag>^<code> <cr> <lf>
^^^<error_code> <cr> <lf>;
Table 2-2 provides a description for each field.
Table 2-2. TL1 Response Message Format Descriptions
Field or Symbol Description
<cr> Carriage Return
<lf> Line Feed
Caret (^) The Caret represents one space character in the acknowledgment or response
message.
<source identifier> The Source Identifier (SID) identifies the shelf TID.
<date> The Date field is in the form YY-MM-DD.

YY indicates year and ranges from 00 to 99.
MM indicates month and ranges from 01 to 12.
DD indicates day and ranges from 01 to 31.
<time> The Time field is in the form HH-MM-SS.

HH indicates hour and ranges from 00 to 23.
MM indicates minutes and ranges from 00 to 59.
SS indicates seconds and ranges from 00 to 59.
<ctag> The Correlation Tag (CTAG) corresponds to the CTAG from the TL1 input com-
mand.
<code> The Code field indicates the transaction status for the TL1 input command.
COMPLD indicates normal completion.
DENY indicates an error condition.
<error_code> The Error Code appears after a DENY condition. Refer to Appendix C, MX2820
System Error Codes for applicable error codes.
The MX2820 System does not output an Error message for data entries in a
non-supported field of a TL1 command.
61186003L1-35D 2-5
MX2820 SYSTEM TL1 COMMANDS

Table 2-3 provides TL1 command categories for the MX2820 System.
Table 2-3. MX2820 TL1 Commands
Common Provisioning Security Surveillance System System Test

(SCU) Maintenance
ACT-USER ED-rr DLT-USER-SECU ALW-MSG SW-TOPROTN-rr OPR-LPBK-rr
CANC-USER RTRV-rr ED-USER-SECU INH-MSG SW-TOWKG-rr RLS-LPBK-rr
MENUS SET-TH-rr ENT-USER-SECU RTRV-ALM
SET-DAT RTRV-TH-rr RTRV-USER-SECU RTRV-ALM-ENV
RTRV-COND
RTRV-HDR
RTRV-PM-rr
RTRV-PMSCHED-rr
RTRV-SYS
RTRV-VER
RTRV-VERSION
SCHED-PMREPT-rr
ADTRAN TL1 Commands

The following TL1 commands are ADTRAN-specific commands:
MENUS on page 4-5
RTRV-VER on page 7-21
RTRV-VERSION on page 7-23
2-6 61186003L1-35D
Section 2, TL1 Commands - User Account Requirements (Access Privileges)
USER ACCOUNT REQUIREMENTS (ACCESS PRIVILEGES)

The SCU provides the ability to control access to the MX2820 System with user security
accounts that require users to enter a username and password. The SCU can also control
access to the system which involves assigning command access privileges and operation privi-
leges to user security accounts. Command access privileges determine which commands a
user is allowed to enter. Operation privileges determine which operations a user is allowed to
perform.
User accounts are created at the ADMIN level of the SCU. The pre-defined user accounts are
as follows:
ADMIN, ADTRAN These user accounts include all allowances of the READWRITE
account, add write access to all SCU and line card provision
items, and add access to provision passwords for each user
account through the General Provisioning menu. Creating user
accounts requires assigning username, password, and
command privilege level.
READONLY This user account allows read access to any parameter in the
SCU and line cards. READONLY user accounts have no security
access.
READWRITE, TEST These user accounts includes all allowances of the READONLY
account and adds write access to a limited number of SCU
items and all line card provision items. Changes to network
management items, such as Internet Protocol (IP) address and
TID are not allowed. A READWRITE or TEST user account can
change its own password, but has no other security access.
All accounts can be deleted and replaced with user-defined accounts. Any inactive account
(not currently logged on) can be disabled.
TL1 login accounts (TL1 sessions) require use of the ACT-USER command to access the
system.
61186003L1-35D 2-7
This page is intentionally blank.
2-8 61186003L1-35D
Section 3
ADTRAN AID Formats
INTRODUCTION
This section provides information about ADTRAN AID formats for the MX2820 System.
SCU OPERATION MODE

The operation mode for the SCU can affect how and when the AID parameter is entered for the
TL1 commands. In addition, a NE entity, such as the card type, being targeted by the TL1
command can affect the AID parameter.
SCU Unit
How the SCU functions in the network management configuration determines whether the
client management mode is available. If the SCU functions as a host unit, the client
management mode is not available and the AID parameter is determined by the NE entity
being targeted by the TL1 command. If the SCU functions as a client, the client management
mode is available and defaults to INE.
Intelligent Network Element

If the SCU operates in the INE mode, the shelf number for the AID parameter in a TL1
command is always one. The SCU has a unique TID when operating in the INE mode. TL1
commands route to this SCU if the TID in the command matches the TID of the SCU. INE
shelves are provisioned with a unique TID during system turnup, and the shelf number is
forced to one.
Expansion Shelf
If the SCU operates in the Expansion Shelf mode, a common TID can be shared by up to 32
SCUs. TL1 commands route to the appropriate SCU based on the shelf number in the AID.
The shelf number ranges from 132. The Expansion Shelf is automatically assigned the TID of
the host and is provisioned with a shelf number during system turnup.
61186003L1-35D 3-1
AID STRUCTURE
The AID parameter for the MX2820 System consists of a hierarchy-based format that includes
the following data separated by dashes: the shelf number, the category type, and one or two
additional entries. The terms unit or bank can also be used to describe the shelf number.
The shelf number is assigned by TIRKS.
For the MX2820 System, if the SCU is in the INE client mode, the shelf number is always one.
If the SCU is in the Expansion Shelf client mode, the shelf number ranges from 1 to 254.
Table 3-1 provides the AID inputs for the 19-inch chassis and Table 3-2 provides the AID
inputs for the 23-inch chassis.
Table 3-1. 19-Inch Chassis AID Inputs
Shelf Category Entity 1 Entity 2
1 to 254 T3 MUX1 to 1
MUX7
STS1
T1 MUX1 to 1 to 28 (corresponding to individual DS1s within DS3)

MUX7
VT1 MUX1 to 1 to 28 (corresponding to individual VTs within the STS-1)

MUX7
EQPT MUX1 to A or B
MUX7 A = Working Unit
B = Protect Unit
CLK
SCU N/A
ENV 1 to 5 N/A
Table 3-2. 23-Inch Chassis AID Inputs
Shelf Category Entity 1 Entity 2
1 to 254 T3 MUX1 to 1
MUX9
STS1
T1 MUX1 to 1 to 28 (corresponding to individual DS1s within DS3)

MUX9
VT1 MUX1 to 1 to 28 (corresponding to individual VTs within the STS-1)

MUX9
EQPT MUX1 to A or B
MUX9 A = Working Card
B = Protect Card
CLK
SCU N/A
ENV 1 to 5 N/A
3-2 61186003L1-35D
Section 3, ADTRAN AID Formats - AID Structure
There are no spaces between the parts of the AID parameter. Leading zeros are not significant.
They are ignored on input and suppressed on output.
Table 3-3 provides some examples of AID parameters.
Table 3-3. MX2820 AID Parameter Examples
AID Description
6-T3-MUX4-1 Shelf 6, Category T3, MUX Pair, Facility Input 1
6-T1-MUX4-26 Shelf 6, Category T1, MUX Pair, DS1 26 of 28
6-EQPT-MUX4-A Shelf 6, Category Eqpt, MUX Pair, Working Card
6-ENV-2 Shelf 6, Category Env, Auxiliary Alarm Input #2
6-EQPT-SCU Shelf 6, Category Eqpt, SCU
6-EQPT-CLK-B Shelf 6, Category Eqpt, CLK Pair, Protect Card
The TL1 command sections and the data dictionaries in the appendices also contain infor-
mation about the AID parameter.
61186003L1-35D 3-3
3-4 61186003L1-35D
Section 4
Common (SCU) TL1 Commands
INTRODUCTION
The following TL1 commands apply to the SCU or apply to the MX2820 System:
ACT-USER on page 4-2
CANC-USER on page 4-4
MENUS on page 4-5
SET-DAT on page 4-6
61186003L1-35D 4-1
ACT-USER
The ACT-USER (Activate-User) command allows access to the MX2820 System from a local or
remote terminal. The user must have a valid User ID (UID) and Private ID (PID).
Minimum User Access Privilege

NONE
Input Format
ACT-USER:[<TID>]:<UID>:[<CTAG>]::<PID>;
Example:
ACT-USER:HTVLALEXD16:USER1:1::PASSWORD1;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
UID The UID indicates the User ID or logon name for the user. The
UID can have up to 10 alphanumeric characters.
CTAG For the Correlation Tag (CTAG), refer to Appendix A, Input
Commands Data Dictionary for additional information.
PID The PID contains the password for the user. The password
consists of an alphanumeric character string with a maximum
length of 12 characters. The first character must be a letter.
Valid characters are as follows:
Letters AZ
Digits 09
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 1
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
;
4-2 61186003L1-35D
Section 4, Common (SCU) TL1 Commands - ACT-USER
Example:
HTVLALEXD16 02-05-30 13:28:03
M 1 COMPLD
;
Error Response
<cr> <lf> <lf>
M^^<CTAG>^DENY <cr> <lf>
^^^<error_code> <cr> <lf>
;
Refer to Appendix B, Response Messages Data Dictionary for Normal Response and Error
Response parameter descriptions.
RADIUS Authentication
Login through TL1 occurs through the use of the ACT-USER command. When RADIUS
authentication is enabled, this command works as with local authentication.
Input Format
ACT-USER::<username>:::<password>;
If the username or password is enclosed in quotation marks it is treated as a case-sensitive

string. Otherwise, all of the characters present are shifted to upper case. If the username or
password contains a quotation mark, it must be doubled in the command string in order to
prevent unwanted string termination.
Example:
Login: AdMiN
Password: PaSsWoRd
The proper command to login with the above combination is as follows:
ACT-USER::AdMiN:::PaSsWoRd;
Challenge response
If the RADIUS server sends a challenge request, the initial login is denied with a PLNA error
code. Immediately after the DENY message are three lines of text. The first indicates the
challenge message sent by the server. The second and third lines are as follows:
/*REPEAT ACT-USER COMMAND. */
/*USE SAME USERNAME. USE CHALLENGE RESPONSE AS PASSWORD. */
When this challenge is received, follow the same format used prior to login, but now instead of
the password use the challenge request.
61186003L1-35D 4-3
CANC-USER
The CANC-USER (Cancel-User) command terminates a TL1 session.

READONLY
Input Format
CANC-USER:[<TID>]::[<CTAG>];
Example:
CANC-USER:HTVLALEXD16::5;
Input Parameters
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 5
<
Normal Response
<cr> <lf> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
Example:
HTVLALEXD16 02-05-30 16:36:54
M 5 COMPLD
;
Error Response
<cr> <lf> <lf>
;
4-4 61186003L1-35D
Section 4, Common (SCU) TL1 Commands - MENUS
MENUS
The MENUS command switches the interface for a TL1 session between the TL1 mode and the
Menus mode. To accomplish this, the MENUS command is entered while in a TL1 session. The
menu session can be switched back to a TL1 session by logging off the menu session.
The Local Echo should be disabled while in the Menus mode. Y-modem software updates to
the SCU or to a line access module are not supported while in the Menus mode.

READONLY
Input Format
MENUS:[<TID>];
Example:
MENUS:HTVLALEXD16;
Input Parameters
Response Format
Acknowledgment
The NE does not send an acknowledgment response for the MENUS command.
Normal Response
The TL1 session switches to Menus mode.
Error Response
<cr> <lf> <lf>
^^^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
;
61186003L1-35D 4-5
SET-DAT
The SET-DAT (Set-Date) command sets the date and time for the SCU.

ADMIN
Input Format
SET-DAT:[<TID>]::[<CTAG>]::[YY-MM-DD][<,HH-MM-SS>];
Example:
SET-DAT:HTVLALEXD16::32::02-06-03,11-32-00;
Input Parameters
TID The Target Identifier TID identifies the target NE for the
command. Refer to the TID on page 2-3 for additional
information.
YY-MM-DD This parameter indicates the year, month, and day. Refer to
Appendix A, Input Commands Data Dictionary for additional
information.
HH-MM-SS This parameter indicates the hour, minutes, and seconds. Refer
to Appendix A, Input Commands Data Dictionary for
additional information.
Response Format
Acknowledgment
The NE does not send an acknowledgment response for this TL1 command.
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS > <cr> <lf>
;
Example:
HTVLALEXD16 02-06-03,11-32-00
M 32 COMPLD
;
4-6 61186003L1-35D
Section 4, Common (SCU) TL1 Commands - SET-DAT
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 4-7
4-8 61186003L1-35D
Section 5
Provisioning TL1 Commands
INTRODUCTION
The Provisioning TL1 commands for the MX2820 System allow reconfiguration of an NE. The
Provisioning TL1 commands for the MX2820 System are as follows:
ED-rr on page 5-2
RTRV-rr on page 5-4
RTRV-TH-rr on page 5-6
SET-TH-rr on page 5-8
61186003L1-35D 5-1
ED-RR
The ED-rr command instructs the NE to change parameters associated with one or more facil-
ities (transmission entities) for the specified AID type.
For the MX2820 System, the supported rr modifiers are as follows:
EQPT
T1
T3
STS1
VT1

READWRITE
Input Format
ED-rr:[<TID>]:<AID>:[<CTAG>]::[:[<specific data block>][:<state block>]];
Example:
ED-T3:HTVLALEXD16:1-T1-MUX3-7::::DSXSTATE=ENABLE:OOS;
Input Parameters
AID The AID identifies the entity or the location of the entity within
the NE being targeted. For additional information, refer to
Section 3, ADTRAN AID Formats.
<specific data block> For parameters that apply to the ED-rr command, refer to the
Transmission Entity Data Parameter Tables on page 5-10.
<state block> The state parameters provide information about the entity's
ability to perform its service functions. Refer to Appendix A,
Input Commands Data Dictionary for additional information.
5-2 61186003L1-35D
Section 5, Provisioning TL1 Commands - ED-rr
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 9
<
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-05-30 16:48:47
M 9 COMPLD
;
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 5-3
RTRV-RR
The RTRV-rr (Retrieve-rr) command retrieves data parameters and state parameters for an NE
entity.
EQPT
T1
T3
STS1
VT1
NOTE
The AID parameter for the RTRV-rr command supports the ALL
value. ALL is the default value for the AID parameter.

READONLY
Input Format
RTRV-rr:[<TID>]:[<AID>]:[<CTAG>][:::<specific data block>];
Example:
RTRV-EQPT:HTVLALEXD16::30:::CRAFT-BAUD;
Input Parameters
AID The AID identifies the entity or the location of the entity within
the NE being targeted. For additional information, refer to
Section 3, ADTRAN AID Formats.
<specific data block> Refer to the Transmission Entity Data Parameter Tables on
page 5-10 for parameters that apply to the ED-rr command.
5-4 61186003L1-35D
Section 5, Provisioning TL1 Commands - RTRV-rr
Response Format
Acknowledgment
IP^ <CTAG> <cr> <lf>
<
Example:
IP 30
<
Normal Response
<cr> <lf> <lf>
<rspblk> + ;
The <rspblk> has the following format:

^^^"<AID>,<AIDTYPE>:[<CLEI>]:[<specific data block>]:<state block>" <cr> <lf>
Example:
HTVALEXD16 03-11-22 11:09:22
M 0 COMPLD
"1-T1-MUX4-3,T1:M3C3RG0AAA:DSXSTATE=AUTOENABLE:OOS-AU FLT,AINS"
"1-T1-MUX4-3,T1:M3C3RG0AAA:DSXLINECODING=DSXB8ZS:OOS-AU FLT,AINS"
"1-T1-MUX4-3,T1:M3C3RG0AAA:DSXLINELENGTH=DSX0TO133:OOS-AU FLT,AINS"
"1-T1-MUX4-3,T1:M3C3RG0AAA:DSXSWITCHPROT=ENABLE:OOS-AU FLT,AINS"
"1-T1-MUX4-3,T1:M3C3RG0AAA:DSXLPBKDETECTION=DISABLE:OOS-AU FLT,AINS"
"1-T1-MUX4-3,T1:M3C3RG0AAA:LOOPBACK=DATAMODE:OOS-AU FLT,AINS"
"1-T1-MUX4-3,T1:M3C3RG0AAA:CKTID=T1/E1 #3:OOS-AU FLT,AINS"
;
Error Response
<cr> <lf> <lf>
^^^<rsphdr> <cr><lf>
M^^<CTAG> DENY <cr> <lf>
;
61186003L1-35D 5-5
RTRV-TH-RR
The RTRV-TH-rr (Retrieve-Threshold) command instructs an NE to send the current threshold
level of one or more monitored parameters for which violation will trigger an automatic
message. These threshold levels can apply to one or more equipment units or facilities.
The MX2820 System supports the following rr modifiers:
T1
T3
STS1
VT1
Input Format
RTRV-TH-rr:[<tid>]:<aid>:[<ctag>][::[<montype>],[<locn>][,<tmper>]];
Example:
RTRV-TH-T1::1-T1-MUX6-1:::CVL-HT,NEND,1-DAY;
Input Parameters
TID The TID on page 2-3 identifies the target NE for the command.
The TID should match the Source Identifier (SID) value
assigned to the NE, or be NULL. A NULL value matches the NE
processing the command. If not specified, a NULL value is
assigned.
AID The AID indicates the entity or location of the entity within the
targeted NE. For applicable AIDs, refer to Section 3, ADTRAN
AID Formats.
MONTYPE The Monitoring Type (MONTYPE) parameter indicates the type
of PM threshold being retrieved.
The MONTYPE of a given threshold is the MONTYPE of the
associated performance monitoring value (refer to Appendix F,
Performance Monitoring Codes) with -HT appended to the
end. For example, the MONTYPE for the threshold for the T1
loss-of-signal is LOSS-L-HT.
LOCN For the Location (LOCN), refer to Appendix A, Input Commands
Data Dictionary for additional information.
TMPER For the Time Period (TMPER) parameter, refer to Appendix A,
5-6 61186003L1-35D
Section 5, Provisioning TL1 Commands - RTRV-TH-rr
Response Format
Normal Response
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
<rspblk> + ;
The <rspblk> has the following format:

^^^"<aid>[,<aidtype>]:<montype>,[<locn>],[<dirn>],<thlev>[,<tmper>]" <cr> <lf>
The normal response must contain at least one occurrence of <rspblk>. It is allowed to
contain multiple <rspblk>s if applicable.
Example:
HTVALEXD16 03-11-22 11:22:02
M 0 COMPLD
"1-T3-MUX4-1:CVL-HT,NEND,,387,15-MIN"
"1-T3-MUX4-1:UASCP-P-HT,NEND,,10,15-MIN"
"1-T3-MUX4-1:CVL-HT,NEND,,387,1-DAY"
"1-T3-MUX4-1:UASP-P-HT,NEND,,10,1-DAY"
;
Error Response
<cr> <lf> <lf>
M^^<ctag>^DENY <cr> <lf>
^^^<errcde> <cr> <lf>
(^^^"<error description>" <cr> <lf>) *
(^^^/*error text*/ <cr> <lf>) * ;
The (^^^"<error description>" <cr> <lf>) and (^^^/*error text*/ <cr> <lf>) error response
blocks are optional and, if desired, multiple repetitions are allowed.
Refer to Appendix A, Input Commands Data Dictionary for input parameter descriptions.
61186003L1-35D 5-7
SET-TH-RR
The SET-TH-rr (Set-Threshold) command instructs an NE to set the threshold level for a
monitored parameter that, when exceeded, can trigger an automatic message. The threshold
level can apply to one or more equipment units or facilities in the NE. Threshold setting for
multiple monitored parameters or time periods will require multiple commands from the OS.
The MX2820 System supports the following rr modifiers:
T1
T3
STS1
VT1
Input Format
SET-TH-rr:[<tid>]:<aid>:[<ctag>]::<montype>,<thlev>,<locn>,,<tmper>;
Example:
SET-TH-T1::1-T1-MUX6-1:::CVL-HT,5,NEND,,1-DAY;
Input Parameters
TID The TID on page 2-3 identifies the target NE for the command.
The TID should match the Source Identifier (SID) value
assigned to the NE, or be NULL. A NULL value matches the NE
processing the command. If not specified, a NULL value is
assigned.
AID The AID indicates the entity or location of the entity within the
targeted NE. For applicable AIDs, refer to Section 3, ADTRAN
AID Formats.
MONTYPE The MONTYPE parameter indicates the type of PM threshold
being retrieved.
The MONTYPE of a given threshold is the MONTYPE of the
associated performance monitoring value (refer to Appendix F,
Performance Monitoring Codes) with -HT appended to the
end. For example, the MONTYPE for the threshold for the T1
loss-of-signal is LOSS-L-HT.
THLEV The Threshold Level (THLEV) parameter indicates the threshold
value that applies to the PM (MONTYPE) parameter. For
applicable values, refer to the Transmission Entity Data
Parameter Tables on page 5-10.
LOCN For the LOCN, refer to Appendix A, Input Commands Data
TMPER For the TMPER parameter, refer to Appendix A, Input
5-8 61186003L1-35D
Section 5, Provisioning TL1 Commands - SET-TH-rr
Response Format
Normal Response
<cr> <lf> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Example:
HTVALEXD16 03-11-22 11:35:28
M 0 COMPLD
Error Response
<cr> <lf> <lf>
(^^^/*error text*/ <cr> <lf>) * ;
blocks are optional and, if desired, multiple repetitions are allowed.
61186003L1-35D 5-9
TRANSMISSION ENTITY DATA PARAMETER TABLES

Table 5-1 through Table 5-9 provide the data parameters (attributes) that apply to the
<specific data block> field for the ED-rr and RTRV-rr commands.
EQPT
STS1
T1
T3
VT1

AID: 1-EQPT-SCU
Parameter Options Description
Read Only
ETH_LINK_STAT DOWN This read only parameters indicates the state of

UP the Ethernet link.
ERROR
FAILURE_CNT 2-5 This read-only parameter is used to indicate how

many times a login has failed.
LOCKOUT_TIME 3 - 60 If a user is locked out, this read-only parameter

is used to indicate how many seconds the user
will remain locked out.
SSHKEYSIZE 512 - 2048 (1024) This parameter indicates the size of current SSH
keys.
SSHGENSTAT IDLE This parameter indicates the current status of

RSA SSH key generation.
DSS
Read/Write
ALARM_CHRON DESCENDING This parameter sets the order alarms are

ASCENDING displayed in the alarm log.
AUTO_LOGOFF DISABLE This parameter enables/disables the auto logoff

ENABLE functionality.
AUTO_LOGOFF_TIME 1 - 60 (30) This parameter sets how long it takes for autol-
ogoff to kick in if it is enabled.
AUX1_COND_CODE 11-character string This parameter is the TL1 condition code for
(AUX1) AUX1.
AUX1_DESC 16-character string This parameter is the condition description of

(AUX #1 INPUT) AUX1.
Note: Defaults are in bold type.
5-10 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables

AID: 1-EQPT-SCU (Continued)
AUX1AID 1 - 16 (1) This parameter sets the AID index for AUX1.
AUX1LOG NORMOPEN This parameter sets the logic sense of the AUXx
NORMCLOSED alarm.
AUX1LVL INFO This parameter sets the reported alarm level for
ALERT an AUX1 alarm.
MINOR
MAJOR
CRITICAL
AUX2_COND_CODE 11-character string This parameter is the TL1 condition code for
(AUX2) AUX2.
AUX2_DESC 16-character string This parameter is the condition description of

(AUX #2 INPUT) AUX2.
AUX2AID 1 - 16 (2) This parameter sets the AID index for AUX2.
NORMCLOSED alarm.
AUX2LVL INFO This parameters sets the reported alarm level for
ALERT an AUX2 alarm.
MINOR
MAJOR
CRITICAL
AUX3A_COND_CODE 11-character string This parameter is the TL1 condition code for
(AUX3A) AUX3A.
AUX3A_DESC 16-character string This parameter is the condition description of

(AUX #3A INPUT) AUX3A.
AUX3AAID 1 - 16 (3) This parameters sets the AID index for AUX3A.
NORMCLOSED alarm.
AUX3ALVL INFO This parameters sets the reported alarm level for
ALERT an AUX3A alarm.
MINOR
MAJOR
CRITICAL
AUX3B_COND_CODE 11-character string This parameter is the TL1 condition code for
(AUX3B) AUX3B.
AUX3B_DESC 16-character string This parameter is the condition description of

(AUX #3B INPUT) AUX3B.
AUX3BAID 1 - 16 (3) This parameters sets the AID index for AUX3B.
61186003L1-35D 5-11

AUX3BLVL INFO This parameters sets the reported alarm level for
ALERT an AUX3B alarm.
MINOR
MAJOR
CRITICAL
CRAFT_BAUD 9600 This parameter is used to set the craft port baud
19200 rate.
38400
57600
115200
ETH_ENABLE DISABLE This parameter allows the Ethernet port to be

ENABLE enabled/disabled.
ETH_RATE AUTO This parameter is used to set the data rate for
10HALF the Ethernet port.
10FULL
100HALF
100FULL
I-BANKMODE HOST This parameter selects whether the shelf will

CLIENT serve as a client or host in the interbank commu-
nication protocol.
NSA_REM_LVL INFO This parameters sets the reported alarm level for
ALERT a Non-Service Affecting card removal alarm.
MINOR
MAJOR
CRITICAL
PWRA_COND_CODE 11-character string This parameter is the TL1 condition code for
(PWRA) PWRA.
PWRAAID 1 - 16 (4) This parameters sets the AID index for PWRA.
PWRALVL INFO This parameters sets the reported alarm level for
ALERT a PWR A alarm.
MINOR
MAJOR
CRITICAL
PWRB_COND_CODE 11-character string This parameter is the TL1 condition code for
(PWRB) PWRB.
PWRBAID 1 - 16 (5) This parameters sets the AID index for PWRB.
PWRBLVL INFO This parameters sets the reported alarm level for
ALERT a PWR B alarm.
MINOR
MAJOR
CRITICAL
5-12 61186003L1-35D

REM_LVL INFO This parameters sets the reported alarm level for
ALERT a Service Affecting card removal alarm.
MINOR
MAJOR
CRITICAL
SS_ENABLE DISABLE This parameter allows Smart Start to be

SSHGENSIZE 512 - 2048 (1024) This parameter sets the size of SSH keys to
generate. The size must be a multiple of eight.
TRAP_ENABLE DISABLE This parameter allows SNMP traps to be

Write Only
SSHGENKEY GENERATE This parameter initiates the generation of SSH

keys.
AID:1-EQPT-(MUX1-MUX9)-(A or B)
Read Only
ALARMSEVERITY 0 - 31 Bit assignments are as follows (where logic 1

indicates the condition is present and logic 0
indicates that the condition is not present):
Info = Bit 0 (LSB)
Alert = Bit 1
Minor = Bit 2
Major = Bit 3
Critical = Bit 4 (MSB)
APPSWCHECKSUM 4-character string The application software checksum for the card.
APPSWVERSION 8-character string The application software version for the card.
BOOTSWCHECKSUM 4-character string The boot software checksum for the card.
BOOTSWVERSION 8-character string The boot software version for the card.
DIAGBERTCOUNT 0 - 0xFFFFFFFF This variable indicates the number of errors

accumulated during a BERT-type test.
DIAGBERTSYNC NOSYNC This variable indicates the synchronization

SYNC status during a BERT-type test.
61186003L1-35D 5-13
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
PRODCLEICODE 11-character string The ADTRAN product CLEI code for the card.
PRODSERIALNUMBER 25-character string The ADTRAN product serial number for the card.
PRODUCTNAME 12-character string The ADTRAN product name for the card.
PROTECTIONMODE NONE This variable indicates the protection mode of the

CIRCUIT card.
SELFTEST 21-character string The software self-test results for the card.
SLOTUPTIME 0 - 0xFFFFFFFF The time (in hundredths of a second) since the

card was powered up.
SWITCHCOUNT 0 - 255 This variable returns the current protection

switch count that is used as a basis for the Max
Switch Threshold alarm.
Read/Write
ACTIVECARD CARDA This variable sets/indicates the active module in

CARDB the module pair.
AUTOSAVE DISABLE This variable is used when configuring the Auto-

ENABLE save feature. When enabled, the provisioning is
automatically saved to non-volatile memory in
response to a change in provisioning.
CARDPAIRID 12-character string This variable is used to identify a particular

(MX2820 M13) module pair.
DIAGSELECTBERTPATT QRSS This variable indicates the number of errors

ALL1 accumulated during a BERT-type test.
ALL0
TWOINEIGHT
ONEINEIGHT
TWOTOFIFTEEN-
THINV
5-14 61186003L1-35D
DIAGSELECTBERTPATT ALL1 This variable indicates the number of errors

(1186002L3 Only) ALL0 accumulated during a BERT-type test.
TWOINEIGHT
ONEINEIGHT
QRSS
SIXTYTHREE
FIVEELEVEN
TWENTYFORTY-
SEVEN
TWOTOFIFTEEN-
THINV
TWOTOTWENTI-
ETH
TWOTOTWEN-
TYTHIRD
DIAGTIMEOUT DISABLE This variable indicates the amount of time that a

ONEMIN loopback will remain in effect before automatic
FIVEMIN release of the loopback occurs.
TENMIN
FIFTEENMIN
THIRTYMIN
FORTYFIVEMIN
ONEHOUR
DSXAUTOENABLEDELAY TWOSEC This variable sets the delay associated with any
ONEHR auto-enabled DS1/E1 interface.
TWOHRS
TWELVEHRS
ONEDAY
TWODAYS
SEVENDAYS
DSXCVTHRESHOLD DISABLE This variable sets the DS1/E1 code violation

ONEE3 threshold that, when exceeded, invokes a protec-
ONEE4 tion switch to the standby card.
ONEE5
ONEE6
DSXMULTCKTPROT DISABLE This variable is used when configuring the circuit

ENABLE protection setting of multiple DS1/E1 ports. This
variable is temporary storage for the desired
circuit protection setting. This setting is applied
to all DS1/E1 ports within the range with
APPLYMULTCKTPROT.
61186003L1-35D 5-15
DSXMULTFRMDETECT AUTO This variable is used when configuring the

(1186002L3 Only) SF framing detection setting of multiple DS1 ports.
ESF This variable is temporary storage for the
UNFRAMED framing detection setting. This setting is applied
to all DS1 ports within the range with APPLY-
MULTFRMDETECT.
DSXMULTLINECODING AMI This variable is used when configuring the line

B8ZSHDB3 coding setting of multiple DS1/E1 ports. This
variable is temporary storage for the desired line
coding setting. This setting is applied to all DS1/
E1 ports within the range with APPLYMULTLI-
NECODING.
DSXMULTLINELENGTH DSX0TO133 This variable is used when configuring the line

DSX133TO266 length setting of multiple DS1/E1 ports. This
DSX266TO399 variable is temporary storage for the desired line
DSX399TO533 length setting. This setting is applied to all DS1
DSX533TO655 ports within the range with APPLYMULTLINE-
LENGTH.
DSXMULTLPBK- DISABLE This variable is used when configuring the

DETECT CSU loopback detection setting of multiple DS1/E1
NIU ports. This variable is temporary storage for the
desired loopback detection setting. This setting is
applied to all DS1 ports within the range with
APPLYMULTLPBKDETECT.
DSXMULTPRVSVSTATE IS This variable is used when configuring the provi-

OOS sioned service state of multiple DS1/E1 facilities.
This variable is temporary storage for the desired
service state setting. This setting is applied to all
DS1 facilities within the range with APPLYMULT-
SERVSTATE.
DSXMULTSTATE DISABLE This variable is used when configuring the state

ENABLE setting of multiple DS1/E1 ports. This variable is
AUTOENABLE temporary storage for the desired state setting.
This setting is applied to all DS1/E1 ports within
the range with APPLYMULTSTATE.
DSXPROTTHRESHOLD 1 - 28 (1) This variable sets the minimum number of DS1/

E1 channels that must fail before an automatic
protection switch is invoked.
ENDRANGE 1 - 28 (28) This variable is used when configuring multiple

DS1/E1 ports. This variable is the end port of
the range, and must be greater than or equal to
the STARTRANGE value.
5-16 61186003L1-35D
EQPTPRVSERVSTATE IS This variable sets the provisioned service state of

OOS the Equipment entity.
IPFWDMTU MTU260 This variable controls the IP MTU used for the IP
MTU1500 forwarding channel. This should be set to the
default of 260 bytes in most cases.
IPFWDPROTO ADTRAN This variable controls the encapsulation protocol

PPP used to carry IP traffic over the DS3 when IP
forwarding is in use.
MAXNUMSWITCHES 1 - 24 (3) This variable sets the maximum number of

protection switches allowed within a 1 hour
period. If the threshold is met, then the unit
issues an alarm and suppresses automatic
protection switches for the next 24 hours.
MINSWITCHPERIOD 0 - 3600 (10) This variable sets the minimum number of

seconds allowed between automatic protection
switches.
STARTRANGE 1 - 28 (1) This variable is used when configuring multiple

DS1/E1 ports. This variable is the beginning
port of the range, and must be less than or equal
to the ENDRANGE value.
Write Only (Used to initiate an operation)
APPLYMULTCKTPROT 1 a variable to apply the setting of DSXMULTCKT-

PROT to all DS1/E1 ports within the range
indicated by STARTRANGE and ENDRANGE
APPLYMULTDSXSV- 1 This variable applies the setting of DSXMULT-

STATE PRVSERVSTATE to all DS1/E1 ports within the
range indicated by STARTRANGE and
ENDRANGE.
APPLYMULTFRMDETECT 1 This variable applies the setting of DSXMULTI-

(1186002L3 Only) FRMDETECT to all DS1 ports within the range
indicated by STARTRANGE AND ENDRANGE.
APPLYMULTLINECODING 1 This variable applies the setting of DSXMULTLI-

NECODING to all DS1/E1 ports within the range
indicated by STARTRANGE and ENDRANGE.
APPLYMULTLINELENGTH 1 This variable applies the setting of DSXMULT-

LINELENGTH to all DS1/E1 ports within the
ENDRANGE.
APPLYMULTLPBKDETECT 1 This variable applies the setting of DSXMULTLP-

BKDETECT to all DS1/E1 ports within the range
61186003L1-35D 5-17
APPLYMULTSTATE 1 This variable applies the setting of DSXMULT-

STATE to all DS1/E1 ports within the range
CARDRESET 1 Setting this variable forces the card to reboot.
CLEARALLSTATS 1 This variable clears all DS3 and DS1/E1 PM

statistics.
CLEARSWITCHCOUNT 1 Setting this variable will reset to zero the protec-

tion switch count that is used as a basis for the
Max Switch Threshold alarm. A read on this
variable always returns a One.
DEFAULTALLTHRESH 1 This variable restores all DS3 and DS1/E1 PM

thresholds to their default values.
DIAGCLEARBERTCOUNT 1 Setting this variable clears the error count

during a BERT-type test.
DIAGINSERTBERTERR 1 Setting this variable inserts one bit error into an

active BERT pattern.
DIAGRESETTESTS 1 Setting this variable releases all loopbacks

currently activated.
DISABLEALLTHRESH 1 This variable disables all DS3 and DS1/E1 PM

thresholds.
ENABLEALLTHRESH 1 This variable enables all DS3 and DS1/E1 PM

thresholds.
LOADFACTORYDEFAULT 1 The card's default provisioning data will be

loaded when this variable is set.
SAVEPROV 1 This setting saves the current provisioning data

to non-volatile memory.
5-18 61186003L1-35D

AID: 1-T3-(MUX1-MUX9)-1
Read Only
DS3RXFRAMING CBIT This variable indicates the framing mode

M13 detected on the received DS3 of the card.
DS3STATE NORMAL This variable indicates the alarm/test state of the

ALARM DS3 interface of the card.
TEST
ALARMANDTEST
FEFACILITYID 38-character string The far-end (remote) Facility ID Code received

(N/A) from the incoming DS3.
FELOCATIONID 11-character string The far-end (remote) Location ID Code received

FEFRAMEID 10-character string The far-end (remote) Frame ID Code received

FEUNITID 6-character string The far-end (remote) Unit ID Code received from
(N/A) the incoming DS3.
FEEQPTID 10-character string The far-end (remote) Equipment ID Code received

Read/Write
DS3FRAMING CBIT This variable sets the framing mode of the DS3 of
M13 the card. The choice of framing mode affects the
interpretation of the usage and error statistics.
DS3LPBKDETECTION DISABLE This variable sets the out-of-band loopback

FEACORCBIT command(s) to which the card will respond.
FEAC
CBIT
DS3CVTHRESHOLD DISABLE This variable sets the DS3 code violation thresh-
ONEE3 old that, when exceeded, sets an associated
ONEE4 alarm.
ONEE5
ONEE6
DS3TIMING LOOP This variable sets the transmit-timing mode of

LOCAL the DS3 interface.
LOOPBACK DATAMODE This variable indicates the test state of the DS3
LINE interface.
DIGITAL
FENDLINE
ALLT1
NETPRVSERVSTATE IS This variable sets the provisioned service state of

OOS the DS3 facility.
61186003L1-35D 5-19

AID: 1-T3-(MUX1-MUX9)-1 (Continued)
NEFACILITYID 38-character string The near-end (local) Facility ID Code transmitted

(N/A) from the DS3 when C-BIT framing is used.
NELOCATIONID 11-character string The near-end (local) Location ID Code transmit-

(N/A) ted from the DS3 when C-BIT framing is used.
NEFRAMEID 10-character string The near-end (local) Frame ID Code transmitted

NEUNITID 6-character string The near-end (local) Unit ID Code transmitted

NEEQPTID 10-character string The near-end (local) Equipment ID Code trans-

(N/A) mitted from the DS3 when C-BIT framing is
used.
CLEARNETSTATS 1 This variable clears all DS3 PM statistics.


AID: 1-T1-(MUX1-MUX9)-(1-28)
Read Only
DSXSTATUS OFF This variable indicates the status of a T1/E1

OK interface (consistent with what is indicated in the
LOS VT-100 Status menu).
BPV
TEST
HOT
XCV
CAIS
LAIS
AUTO
NA
DSXBERTSYNCMULT NOSYNC This variable indicates the synchronization

(1186002L3 Only) SYNC status during a BERT-type test.
UNAVAILABLE
DSXBERTCOUNTMULT 0-0xFFFFFFFF This variable indicates the number of errors

(1186002L3 Only) accumulated during a BERT-type test.
5-20 61186003L1-35D

AID: 1-T1-(MUX1-MUX9)-(1-28) (Continued)
Read/Write
DSXSTATE DISABLE This variable sets the state of a DS1/E1

ENABLE interface.
AUTOENABLE
UNAVAILABLE
DSXLINECODING DSXAMI This variable sets the line coding of a DS1/E1

DSXB8ZS interface.
E1AMI
E1HDB3
UNAVAILABLE
DSXLINELENGTH DSX0TO133 This variable sets the line length setting of the
DSX133TO266 DS1/E1 interface.
DSX266TO399
DSX399TO533
DSX533TO655
E10TO6DB
UNAVAILABLE
DSXSWITCHPROT DISABLE This variable enables or disables an automatic

ENABLE protection switch due to a failure of the DS1/E1
UNAVAILABLE interface.
DSXLPBKDETECTION DISABLE This variable enables or disables the detection

CSU and response to CSU/NIU loopback commands
NIU received from the network.
UNAVAILABLE
DSXFRMDETECTION AUTO This variable sets the framing detection of a DS1

(1186002L3 Only) SF interface.
ESF
UNFRAMED
UNAVAILABLE
61186003L1-35D 5-21

AID: 1-T1-(MUX1-MUX9)-(1-28) (Continued)
LOOPBACK DATAMODE This variable indicates the test state of a DS1/E1

NETWORK interface.
TERMINAL
DIGITAL
CODEC
DS1FEAC
CSULBK
CSUBERT
LINEBERT
UNAVAILABLE
NIULBK
NIUBERT
HSCSULBK
HSCSUBERT
HSLINEBERT
HSNIULBK
HSNIUBERT
T1PRVSERVSTATE IS This variable sets the provisioned service state of

OOS the T1 facility.
Write Only
CLEARPORTSTATS 1 This variable clears all DS1/E1 PM statistics.

AID:1-EQPT-(MUX1-MUX9)-(A or B)
Read Only
ALARMSEVERITY 0 - 31 This variable indicates the severity of current

active system alarms of the card. Bit assignments
are as follows (where logic 1 indicates the condi-
tion is present and logic 0 indicates that the
condition is not present):
Info = Bit 0 (LSB)
Alert = Bit 1
Minor = Bit 2
Major = Bit 3

CIRCUIT card.
5-22 61186003L1-35D
DIAGBERTSYNC NOSYNC This variable indicates the synchronization

SYNC status during a BERT-type test.
DIAGBERTCOUNT 0 - 0xFFFFFFFF This variable indicates the number of errors

accumulated during a BERT-type test.

PRODUCTNAME 12-character string The ADTRAN product name for the card.
EXTCLKSTATUS PRESENT This variable indicates whether this module

NOTPRESENT detects the external clock from the clock module.

Read/Write



switches.
DSXCVTHRESHOLD DISABLE This variable sets the DS1/E1 code violation

ONEE3 threshold that, when exceeded, invokes a protec-
ONEE4 tion switch to the standby card.
ONEE5
ONEE6
DSXPROTTHRESHOLD 1 - 28 (1) This variable sets the minimum number of DS1/

E1 channels that must fail before an automatic
protection switch is invoked.
61186003L1-35D 5-23
DSXAUTOENABLE-DELAY TWOSEC This variable sets the delay associated with any
ONEHR auto-enabled DS1/E1 interface.
TWOHRS
TWELVEHRS
ONEDAY
TWODAYS
SEVENDAYS
STARTRANGE 1 - 28 (1) This variable is used when configuring multiple

VT paths or DS1/E1 ports. This variable is the
beginning port of the range, and must be less
than or equal to the ENDRANGE value.
ENDRANGE 1 - 28 (28) This variable is used when configuring multiple

VT paths or DS1/E1 ports. This variable is the
end port of the range, and must be greater than
or equal to the STARTRANGE value.
DSXMULTSTATE DISABLE This variable is used when configuring the state

ENABLE setting of multiple DS1/E1 ports. This variable is
AUTOENABLE temporary storage for the desired state setting.
This setting is applied to all DS1/E1 ports within
the range with APPLYMULTSTATE.
DSXMULTLINE- AMI This variable is used when configuring the line

CODING B8ZSHDB3 coding setting of multiple DS1/E1 ports. This
variable is temporary storage for the desired line
coding setting. This setting is applied to all DS1/
E1 ports within the range with APPLYMULTLI-
NECODING.
DSXMULTLINELENGTH DSX0TO133 This variable is used when configuring the line

DSX133TO266 length setting of multiple DS1 ports. This
DSX266TO399 variable is temporary storage for the desired line
DSX399TO533 length setting. This setting is applied to all DS1
DSX533TO655 ports within the range with APPLYMULTLINE-
LENGTH.
DSXMULTCKTPROT DISABLE This variable is used when configuring the circuit

ENABLE protection setting of multiple DS1/E1 ports. This
variable is temporary storage for the desired
circuit protection setting. This setting is applied
to all DS1/E1 ports within the range with APPLY-
MULTCKTPROT.
DSXMULTLPBK-DETECT DISABLE This variable is used when configuring the

CSU loopback detection setting of multiple DS1 ports.
NIU This variable is temporary storage for the desired
loopback detection setting. This setting is applied
to all DS1 ports within the range with APPLY-
MULTLPBKDETECT.
5-24 61186003L1-35D
MULTVTHAIRPIN DISABLE This variable is used when configuring the VT

ENABLE hairpin loopback setting of multiple VT paths.
loopback setting. This setting is applied to all VT
paths within the range with APPLYMULTVTHAIR-
PIN.
DSXMULTPRVSVSTATE IS This variable is used when configuring the provi-

OOS sioned service state of multiple DS1 facilities.
DS1 facilities within the range with APPLY-
MULTDSXSVSTATE.
VTMULTPRVSVSTATE IS This variable is used when configuring the provi-

OOS sioned service state of multiple VT path entities.
VT paths within the range with APPLYMULTVTS-
VSTATE.
DIAGTIMEOUT DISABLE This variable indicates the amount of time that a

ONEMIN loopback will remain in effect before automatic
FIVEMIN release of the loopback occurs.
TENMIN
FIFTEENMIN
THIRTYMIN
FORTYFIVEMIN
ONEHOUR

automatically saved to non-volatile memory when
a change in provisioning occurs.

(MX2820 STS1) module pair.
EQPTPRVSERVSTATE IS This variable sets the provisioned service state of

VTAISTRANSMIT DISABLE This variable enables or disables transmission of

ENABLE VT AIS toward the network.
APPLYMULTSTATE 1 This variable applies the setting of DSXMULT-

STATE to all DS1/E1 ports within the range
61186003L1-35D 5-25

APPLYMULTLINE-CODING 1 This variable applies the setting of DSXMULTLI-
NECODING to all DS1/E1 ports within the range
APPLYMULTLINELENGTH 1 This variable applies the setting of DSXMULT-
LINELENGTH to all DS1/E1 ports within the
ENDRANGE.
APPLYMULTCKTPROT 1 This variable applies the setting of DSXMULTCK-
TPROT to all DS1/E1 ports within the range
APPLYMULTLPBK- 1 This variable applies the setting of DSXMULTLP-
DETECT BKDETECT to all DS1/E1 ports within the range
APPLYMULTVTHAIRPIN 1 This variable applies the setting of MULTVTHAIR-
PIN to all VT paths within the range indicated by
STARTRANGE and ENDRANGE.
APPLYMULTVTSV-STATE 1 This variable applies the setting of VTMULT-
PRVSVSTATE to all VT paths within the range
APPLYMULTDSXSV- 1 This variable applies the setting of DSXMULT-
STATE PRVSVSTATE to all DS1/E1 ports within the
ENDRANGE.
LOADFACTORYDEFAULT 1 The card's default provisioning data will be
Max Switch Threshold alarm. A read on this
variable always returns a One.
DIAGCLEARBERTCOUNT 1 Setting this variable clears the error count during
a BERT-type test.
DIAGRESETTESTS 1 Setting this variable releases all current active
loopbacks.
DIAGINSERTBERTERR 1 Setting this variable inserts one bit error into an
active BERT pattern.
DEFAULTALLTHRESH 1 This variable restores all STS-1, VT, and DS1/E1

PM thresholds to their default values.
5-26 61186003L1-35D
ENABLEALLTHRESH 1 This variable enables all STS-1, VT, and DS1/E1

PM thresholds.
DISABLEALLTHRESH 1 This variable disables all STS-1, VT, and DS1/E1

PM thresholds.
CLEARALLSTATS 1 This variable clears all STS-1, VT, and DS1/E1

PM
statistics.
AID: 1-STS1-(MUX1-MUX9)-1
Read Only
NETSTATE NORMAL This variable indicates the alarm/test state of the

ALARM EC-1/STS-1 interface of the card.
TEST
ALARMANDTEST
PATHTRACERX 64-character string The path trace string received from the incoming
STS-1.
CLKSOURCE LOOP The current timing source of the transmit timing

FREE-RUN mode of the EC-1/STS-1 interface. The value of
EXTERNAL this parameter can or can not be the same as
that of the NETTIMING parameter.
EXTCLKSYNCSTATUS STU This variable indicates the clock sync status

PRS message decoded from the incoming STS-1
TNC signal.
ST2
ST3
SMC
PNO
DUS
NOTAVAILABLE
Read/Write
PATHTRACETX 64-character string The path trace string transmitted from the outgo-
(ADTRAN MX2820 ing STS-1.
STS-1 MUX)
PATHTRACERXEXP 64-character string The path trace string expected to be detected in

(ADTRAN MX2820 the received STS-1.
STS-1 MUX)
61186003L1-35D 5-27
AID: 1-STS1-(MUX1-MUX9)-1 (Continued)
NETTIMING LOOP This variable sets the transmit-timing mode of

FREE-RUN the EC-1/STS-1 interface.
EXTERNAL
LOOPBACK DATAMODE This variable indicates the test state of the EC-1/
LINE STS-1 interface.
DIGITAL
VTMODE T1 This variable is used when configuring the VT

E1 mode of the module (T1 or E1).
NETPRVSERVSTATE IS This variable sets the provisioned service state of

OOS the EC1/STS-1 facility.
Write-Only
VTMAPPINGMULTSEQ 1 This setting configures the VT cross-connect for

sequential (TR-253) mapping.
VTMAPPINGMULTGRP 1 This setting configures the VT cross-connect for

group (M13) mapping.
PATHTRACEMATCH 1 This item sets the string value for PATHTRAC-

ERXEXP equal to the current value for
PATHTRACERX.
CLEARNETSTATS 1 This variable clears all STS-1 PM statistics.

Table 5-7. STS-1 MUX (P/N 1186005Lx) VT Data Provisioning Parameters

AID: 1-VT1-(MUX1-MUX9)-(1-28)
Read/Write
VTMAPPING 1 - 29 This setting maps the indicated VT to the

indicated DS1/E1 port. The value of this param-
eter indicates the DS1/E1 port mapped to the VT
path. The value can be 1-28, or 29 for
Unequipped.
VTHAIRPIN DISABLE This setting configures the VT hairpin loopback

ENABLE setting of a VT path.
UNAVAILABLE
VTPRVSERVSTATE IS This variable sets the provisioned service state of

OOS the VT path entity.
5-28 61186003L1-35D
Table 5-8. STS-1 MUX (P/N 1186005Lx) T1 Data Provisioning Parameters

AID: 1-T1-(MUX1-MUX9)-(1-28)
DSXSTATE DISABLE This variable sets the state of a DS1/E1

ENABLE interface.
AUTOENABLE
UNAVAILABLE
NOT MAPPED
DSXLINECODING DSXAMI This variable sets the line coding of a DS1/E1

DSXB8ZS interface.
E1AMI
E1HDB3
UNAVAILABLE
NOT MAPPED
DSXLINELENGTH DSX0TO133 This variable sets the line length setting of the
DSX133TO266 DS1/E1 interface.
DSX266TO399
DSX399TO533
DSX533TO655
E10TO6DB
UNAVAILABLE
NOT MAPPED
DSXSWITCHPROT DISABLE This variable enables or disables an automatic

ENABLE protection switch due to a failure of the DS1/E1
UNAVAILABLE interface.
NOT MAPPED
DSXLPBKDETECTION DISABLE This variable enables or disables the detection

CSU and response to CSU/NIU loopback commands
NIU received from the network.
UNAVAILABLE
NOT MAPPED
LOOPBACK DATAMODE This variable indicates the test state of a DS1/E1

NETWORK interface.
TERMINAL
DIGITAL
CODEC
CSULBK
CSUBERT
VTBERT
LINEBERT
UNAVAILABLE
T1PRVSERVSTATE IS This variable sets the provisioned service state of

OOS the T1 facility.
Write Only
CLEARPORTSTATS 1 This variable clears all PM statistics for this

DS1/E1 and for the attached VT.
61186003L1-35D 5-29
AID: 1-EQPT-CLK-(A or B)
Read Only
ALARMSEVERITY 0 - 31 This variable indicates the severity of current

active system alarms of the card. Bit assign-
ments are as follows (where logic 1 indicates the
condition is present and logic 0 indicates that the
condition is not present):
Info = Bit 0 (LSB)
Alert = Bit 1
Minor = Bit 2
Major = Bit 3

CIRCUIT card.

PRODUCTNAME 12-character string The ADTRAN product CLEI code for the card.
CLOCKSTATE FREEWALKFAST This request returns the current state of the

FREEWALK clock card phase lock loop.
EXITHOFAST
EXITHOLDOVER
HOLDOVER
NORMAL
FASTSTATE
RESETSTATE

Read/Write

5-30 61186003L1-35D
AID: 1-EQPT-CLK-(A or B) (Continued)

(MX2820 SMC) module pair.
PRVACTIVEREF PRIMARY This variable sets the active card in a redundant

SECONDARY system.


switches.

automatically saved to non-volatile memory
when a change in provisioning occurs.
PRVEQUIPSERVSTATE IS This variable sets the provisioned service state of

AUTOREFSWITCH ENABLE This variable is used to enable or disable

DISABLE automatic clock reference protection switching.
AUTOCARDSWITCH ENABLE This variable is used to enable or disable

DISABLE automatic card protection switching.
TIMINGMODE EXTERNAL This variable sets the clock card to synchronize

HOLDOVER to either of the external clock references or
operate in hold over.
TIMINGTYPE SFESF This variable enables and disabled AIS detection

ALLONES on the incoming clock references. It can be used
for debugging purposes.
TERMINATIONMODE ENABLE This variable specifies if the clock card pair will
DISABLE provide line termination for the incoming bits
clock inputs or if another timing destination will
be responsible for termination.
PRICLKALARM ENABLE This variable sets whether the Primary Clock

DISABLE reference
failure alarm is enabled or disabled (inhibited).
SECCLKALARM ENABLE This variable sets whether the Secondary Clock

DISABLE reference
failure alarm is enabled or disabled (inhibited).
61186003L1-35D 5-31
AID: 1-EQPT-CLK-(A or B) (Continued)
LOADFACTORY-DEFAULT 1 The card's default provisioning data will be



Max Switch Threshold alarm.
5-32 61186003L1-35D
Section 6
Security TL1 Commands
INTRODUCTION
The Security TL1 commands allow an administrator to delete, edit, enter (add), and retrieve
security information for a user account. The following Security TL1 commands apply to the
MX2820 System:
DLT-USER-SECU on page 6-2
ED-USER-SECU on page 6-4
ENT-USER-SECU on page 6-6
RTRV-USER-SECU on page 6-8
61186003L1-35D 6-1
DLT-USER-SECU
The DLT-USER-SECU (Delete-User-Security) command allows an administrator to delete the
security parameters associated with a user account.

ADMIN
Input Format
DLT-USER-SECU:[<TID>]:<UID>:[<CTAG>];
Example:
DLT-USER-SECU:HTVLALEXD16:USER1:8;
Input Parameters
UID takes the place of the AID for this TL1 command format.
Refer to Appendix A, Input Commands Data Dictionary for
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 8
<
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-06-04 09:03:52
M 8 COMPLD
;
6-2 61186003L1-35D
Section 6, Security TL1 Commands - DLT-USER-SECU
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 6-3
ED-USER-SECU
The ED-USER-SECU (Edit-User-Security) command allows an administrator to edit security
parameters associated with a user account.

ADMIN
Input Format
ED-USER-SECU:[<TID>]:<UID>:[<CTAG>]::,[<NEW PID>],,[<NEW UAP>]:;
Example:
ED-USER-SECU:HTVLALEXD16:USER1:10::,PASSWORD2,,4:;
Input Parameters
NEW PID For the new PID, refer to Appendix A, Input Commands Data
NEW UAP For the new User Access Privilege (UAP), refer to Appendix A,
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 10
<
6-4 61186003L1-35D
Section 6, Security TL1 Commands - ED-USER-SECU
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-06-04 15:53:41
M 10 COMPLD
;
Error Response
<cr> <lf> <lf>
M^<CTAG>^DENY <cr> <lf>
^^^<error_code>
;
61186003L1-35D 6-5
ENT-USER-SECU
The ENT-USER-SECU (Enter-User-Security) command allows an administrator to enter (add)
security parameters to a user account. The command assigns a user ID, a password, and a
user access privilege for a new user to the MX2820 System.

ADMIN
Input Format
ENT-USER-SECU:[<TID>]:<UID>:[<CTAG>]::<PID>,,<UAP>:;
Example:
ENT-USER-SECU:HTVLALEXD16:USER1:12::PASSWORD1,,3:;
Input Parameters
PID For the PID, refer to Appendix A, Input Commands Data Dictio-
nary for additional information.
UAP For the UAP, refer to Appendix A, Input Commands Data
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 12
<
6-6 61186003L1-35D
Section 6, Security TL1 Commands - ENT-USER-SECU
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-06-04 15:37:00
M 12 COMPLD
;
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 6-7
RTRV-USER-SECU
The RTRV-USER-SECU (Retrieve-User-Security) command allows an administrator to retrieve
security parameters, except for the user's password, associated with a user account.

ADMIN
Input Format
RTRV-USER-SECU:[<TID>]::[<CTAG>];
Example:
RTRV-USER-SECU:HTVLALEXD16::27;
Input Parameters
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 27
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> >lf>
[^^^"<UID>:<CID>,<UAP>" <cr> <lf>]...
^^^"<UID>:<CID>,<UAP>, <login failures>" <cr> <lf>
;
6-8 61186003L1-35D
Section 6, Security TL1 Commands - RTRV-USER-SECU
Example:
HTVLALEXD16 02-06-04 16:57:20
M 27 COMPLD
"ADTRAN:0, 0x4b, 0
"ADMIN:1, 0x4b, 0
"READONLY:2, 0x01, 0
"READWRITE:3, 0x03, 0
"TEST:4, 0x0b, 0
"USER1:5, 0x4b, 0
;
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 6-9
6-10 61186003L1-35D
Section 7
Surveillance TL1 Commands
INTRODUCTION
The following Surveillance TL1 commands apply to the MX2820 System:
ALW-MSG on page 7-2
INH-MSG on page 7-4
RTRV-ALM on page 7-6
RTRV-ALM-ENV on page 7-8
RTRV-COND on page 7-11
RTRV-HDR on page 7-13
RTRV-PM-rr on page 7-15
RTRV-PMSCHED-rr on page 7-17
RTRV-SYS on page 7-19
RTRV-VER on page 7-21
RTRV-VERSION on page 7-23
SCHED-PMREPT-rr on page 7-25
61186003L1-35D 7-1
ALW-MSG
The ALW-MSG (Allow-Message) command enables a NE to transmit autonomous messages to
an Operations System (OS).
This command has the following format for the command verb:
ALW-MSG-{EQPT|rr|ALL}
The valid values for rr as the second modifier are as follows:
T1
T3
STS1
VT1
The value entered for the <NTFCNCDE> parameter determines which autonomous message
alarms are sent by the NE.
The INH-MSG (Inhibit-Message) command inhibits the transmission of Autonomous messages
to an OS. Refer to the INH-MSG commands in this section for additional information.
Refer to Appendix E, Autonomous Messages for additional information.

READONLY
Input Format
ALW-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],;
Example:
ALW-MSG-EQPT:HTVLALEXD16::2::MJ,;
Input Parameters
NTFCNCDE For the Notification Code (NTFCNCDE), refer to Appendix A,
7-2 61186003L1-35D
Section 7, Surveillance TL1 Commands - ALW-MSG
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 3
<
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-05-30 15:43:02
M 3 COMPLD
;
Error Response
<cr> <lf> <lf>
^^^<SID> <YY-MM-DD>^<HH:MM:SS> <cr> <lf>
;
61186003L1-35D 7-3
INH-MSG
The INH-MSG (Inhibit-Message) commands instruct an NE to inhibit the sending of auton-
omous messages from an NE to OS/user.
INH-MSG-{EQPT|rr|ALL}
T1
T3
STS1
VT1
The value entered for the <NTFCNCDE> parameter determines which autonomous message
alarms are inhibited.
To resume the sending of autonomous messages, refer the ALW-MSG commands in this
section.

READONLY
Input Format
INH-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],;
Example:
INH-MSG-EQPT:HTVLALEXD16::13::MJ,;
Input Parameters
NTFCNCDE For the NTFCNCDE, refer to Appendix A, Input Commands
7-4 61186003L1-35D
Section 7, Surveillance TL1 Commands - INH-MSG
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 13
<
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-05-30 17:15:51
M 13 COMPLD
;
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 7-5
RTRV-ALM
The RTRV-ALM (Retrieve-Alarm) TL1 command instructs an NE to retrieve and send the
current status of its alarm conditions associated with one or more of its entities.
The command can be used to retrieve NE information, which in turn can be used to update an
OS database when it is suspected that autonomous alarm messages issued by the NE were
not received or properly processed. This command can also be used to evaluate the system
before or after NE maintenance operations.
The command has the following format for the command verb:
RTRV-ALM-{EQPT|rr|ALL}
T1
T3
STS1
VT1
Environmental alarms are not expected in response to the RTRV-ALM command. The RTRV-
ALM-ENV command retrieves environmental alarms.

READONLY
Input Format
RTRV-ALM-{EQPT|rr|ALL}:[<TID>]:[<AID>]:[<CTAG>]::[<NTFCNCDE>],[<CONDTYPE>], [<SRVEFF>],[<LOCN>],;
Example:
RTRV-ALM-EQPT:HTVLALEXD16:1-T3-MUX4-1:19::CR,LOS,SA,NEND,;
Input Parameters
AID The AID identifies the entity within the NE to which the desired
alarm conditions pertain. Refer to Section 3, ADTRAN AID
Formats for additional information.
CONDTYPE For the Condition Type (CONDTYPE), refer to Appendix A,
SRVEFF For the Service Effect (SRVEFF), refer to Appendix A, Input
7-6 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-ALM

Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 19
<
Normal Response
Format for no Alarm Conditions

<cr> <lf> <lf>
;
Format for Alarm Conditions

<cr> <lf> <lf>
<rspblk> + ;
<rspblk> has the format:

^^"[<AID>] [,<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],
[<OCRTM>],[<LOCN>],[<TMPER>],:[<CONDDESCR>]" <cr> <lf>
Example:
HTVLALEXD16 02-10-14 17:13:45
M 19 COMPLD
"1-T1-MUX3-1,T1:MJ,LOS,SA,10-09,12-11-01,NEND,,:\"LOS\""
"1-T3-MUX7-1,T3:CR,OOF,SA,10-11,11-00-22,NEND,,:\"DS3 OOF\""
"1-T3-MUX7-1,T3:CR,LOS,SA,10-11,11-00-22,NEND,,:\"DS3 LOS\""
;
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 7-7
RTRV-ALM-ENV
The RTRV-ALM-ENV (Retrieve Alarm Environment) command requests that an NE or office
environment monitor retrieve specified, outstanding environmental alarms. The command can
be used to retrieve NE information, which in turn can be used to update an OS environmental
alarm database.
The following environmental alarms apply to the MX2820 System:
PWRA (Power A)
PWRB (Power B)
AUX1 (Auxiliary Alarm Input #1)
AUX2 (Auxiliary Alarm Input #2)
AUX3A (Auxiliary Alarm Input #3A)
AUX3B (Auxiliary Alarm Input #3B)
Environmental Alarm Summary

Table 7-1 provides an environmental alarm summary for the MX2820 System.
Table 7-1. MX2820 Environmental Alarm Data
Alarm Default AID Default Default Description String

Index Condition Severity
Code Level
Auxiliary1 Input 1 AUX1 Major AUX #1 INPUT
Auxiliary2 Input 2 AUX2 Major AUX #2 INPUT
Auxiliary3A Input 3 AUX3A Major AUX #3A INPUT
Auxiliary3B Input 3 AUX3B Major AUX #3B INPUT
PWR Bus A Fail 4 PWRA Major Power Bus A Fail (No

provisionable description string)
PWR Bus B Fail 5 PWRB Major Power Bus B Fail (No

provisionable description string)

READONLY
Input Format
RTRV-ALM-ENV:[<TID>]:[<AID>]:[<CTAG>]::[<NTFCNCDE>][,<ALMTYPE>];
Example:
RTRV-ALM-ENV:HTVLALEXD16:1-ENV-1:20::MJ,AUX1;
7-8 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-ALM-ENV
Input Parameters
AID The AID identifies the entity within the NE or office from which
information is being retrieved. For this command, the AID
format is unit-group-slot or ALL. ALL is the default value for the
AID parameter. Refer to Section 3, ADTRAN AID Formats for
ALMTYPE For the Alarm Type (ALMTYPE), refer to Appendix A, Input
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 20
<
Normal Response
The following format applies if no outstanding alarms satisfy the request:
<cr> <lf> <lf>
;
The following format applies if one or more alarms satisfy the request (+ denotes one or more):
<cr> <lf> <lf>
<rspblk> + ;
The <rspblk> parameter has the following format:

^^^"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>,[<OCRTM>]" <cr> <lf>
Example:
HTVLALEXD16 02-05-31 10:36:16
M 20 COMPLD
"1-ENV-1:MJ,AUX1,05-31,10-35-18"
;
61186003L1-35D 7-9
Error Response
<cr> <lf> <lf>
^^^<error_code>
;
7-10 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-COND
RTRV-COND
The RTRV-COND (Retrieve Condition) command instructs an NE to return the current
standing condition or state associated with one or more equipment units, transmission types,
or test access within the NE. An alternate use for this command is to instruct an NE to
retrieve all the AIDs associated with a specified condition or state in the <TYPEREQ>
parameter.
RTRV-COND-{EQPT|rr|ALL}
T1
T3
STS1
VT1

READONLY
Input Format
RTRV-COND-{EQPT|rr|ALL}:[<TID>]:[<AID>]:[<CTAG>]::[<TYPEREQ>],[<LOCN>],;
Example:
RTRV-COND-EQPT:HTVLALEXD16:1-T3-MUX4-1:22::CR,FEND,;
Input Parameters
AID The AID identifies the entity within the NE or office from which
information is being retrieved. For this command, the AID
format is unit-group-slot or ALL. ALL is the default value for the
AID parameter. Refer to Section 3, ADTRAN AID Formats for
TYPEREQ For the TYPEREQ parameter, refer to Appendix A, Input
61186003L1-35D 7-11
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 22
<
Normal Response
If there are no conditions to report, the format is as follows:
<cr> <lf> <lf>
;
If there is at least one condition to report, the format is as follows (+ denotes one or more):
<cr> <lf> <lf>
<rspblk> + ;
<rspblk> has the following format:

^^^"<AID>[,<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],[<OCRTM>],
[<LOCN>],[,<TMPER>],[<CONDDESCR>]" <cr> <lf>
Example:
HTVLALEXD16 02-05-31 10:59:19
M 22 COMPLD
"1-T3-MUX4-1,T3:CR,LOS,SA,05-31,09-36-42,NEND,,\"DS3 LOS\""
;
Error Response
<cr> <lf> <lf>
^^^<error_code>
;
7-12 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-HDR
RTRV-HDR
The RTRV-HDR (Retrieve-Header) command instructs the NE to reply with a normal response
that indicates COMPLD. The information of interest is the reply itself along with information
the NE has about itself that includes the <SID>, the <DATE>, the <TIME>, and the SCU
software release.

READONLY
Input Format
RTRV-HDR:[<TID>]::[<CTAG>];
Example:
RTRV-HDR:HTVLALEXD16::23;
Input Parameters
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 23
<
Normal Response
<cr> <lf> <lf>
^^^/* <SW Rev.> */ <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 11:08:32
M 23 COMPLD
/*^COL^*/
;
61186003L1-35D 7-13
Error Response
<cr> <lf> <lf>
;
7-14 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-PM-rr
RTRV-PM-rr
The RTRV-PM-rr (Retrieve Performance Monitoring rr) command instructs an NE to send its
current set of Performance Monitoring (PM) data for the type specified by rr.
T1
T3
STS1
VT1
The data can be used to load an OS or audit an OS database when it is suspected that Auton-
omous PM messages were not received or properly processed. This command can also be used
to evaluate the system before or after NE maintenance operations.

READONLY
Input Format
RTRV-PM-rr:[<TID>]:<AID>:[<CTAG>]::[<MONTYPE>],[<MONLEV>],[<LOCN>],, [<TMPER>],[<MONDAT>][,<MONTM>];
Example:
RTRV-PM-T1:HTVLALEXD16:1-T1-MUX3-7:::ESL,1-UP,NEND,,1-DAY,05-31,12-00;
Input Parameters
AID The AID parameter identifies the slot location for the entity
within the NE where the data is being retrieved. Refer to
Section 3, ADTRAN AID Formats for additional information.
MONTYPE For the MONTYPE, refer to Appendix A, Input Commands Data
MONLEV For the Monitor Level (MONLEV), refer to Appendix A, Input
TMPER For the TMPER, refer to Appendix A, Input Commands Data
MONDAT For the Monitor Date (MONDAT), refer to Appendix A, Input
MONTM For the Monitor Time (MONTM), refer to Appendix A, Input
61186003L1-35D 7-15
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 24
<
Normal Response
If the NE does not have any PM values to report, the following format applies:
<cr> <lf> <lf>
^^^<SID>^YY-MM-DD>^<HH:MM:SS> <cr> <lf>
;
If the NE has one or more PM values to report, the following format applies (+ denotes one or
more):
<cr> <lf> <lf>
<rspblk> + ;

^^^"<AID>:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],,[<TMPER>],[<MONDAT>]
[,<MONTM>]" <cr> <lf>
Example:
HTVLALEXD16 02-05-31 12:02:08
M 24 COMPLD
"1-T1-MUX3-1:SESL,37117,PRTL,NEND,,1-DAY,05-31,00-00"
"1-T1-MUX3-1:ESL,37116,PRTL,NEND,,1-DAY,05-31,00-00"
;
Error Response
<cr> <lf> <lf>
;
7-16 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-PMSCHED-rr
RTRV-PMSCHED-RR
The RTRV-PMSCHED (Retrieve Performance Monitoring Schedule) command instructs an NE
to send the PM reporting schedule that was set with the SCHED-PMREPT-rr command.
This command has the following format the command verb:
RTRV-PMSCHED-{rr|ALL}
T1
T3
STS1
VT1

READONLY
Input Format
RTRV-PMSCHED-{rr|ALL}:[<TID>]:[<AID>]:[<CTAG>];
Example:
RTRV-PMSCHED-T3:HTVLALEXD16:1-T3-MUX3-1:25;
Input Parameters
AID The AID parameter identifies the entity within the NE from
which the information is being retrieved. Refer to Section 3,
ADTRAN AID Formats for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 25
<
61186003L1-35D 7-17
Normal Response
If a schedule does not exist, the following format applies:
<cr> <lf> <lf>
;
If there is at least one schedule to report, the following format applies (+ denotes one or more):
<cr> <lf> <lf>
<rspblk> + ;

^^^"<AID>[,<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMIVNL>],,[<MONLEV>],
<LOCN>,,[<TMPER>],[<TMOFST>],[<INHMODE>]" <cr> <lf>
Example:
HTVLALEXD16 02-05-31 17:05:30
M 25 COMPLD
"1-T1-MUX9-5,T1:15-MIN,05-31,20-00,3,,0-UP,NEND,,15-MIN,0-0-0,ALW"
;
Error Response
<cr> <lf> <lf>
;
7-18 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-SYS
RTRV-SYS
The RTRV-SYS (Retrieve System) command provides contact information, the location, and the
type of system.

READONLY
Input Format
RTRV-SYS:[<TID>]::[<CTAG>];
Example:
RTRV-SYS:HTVLALEXD16::26;
Input Parameters
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 26
<
Normal Response
<cr> <lf> <lf>
^^^"<CONTACT>" <cr> <lf>
^^^"<LOCATION>" <cr> <lf>
^^^"<TYPE>" <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 15:47:20
M 26 COMPLD
"::CONTACT=WWW.ADTRAN.COM"
"::LOCATION=HUNTSVILLECOUNIT1"
"::TYPE=MX2820 23-INCH
;
61186003L1-35D 7-19
Error Response
<cr> <lf> <lf>
;
7-20 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-VER
RTRV-VER
The RTRV-VER (Retrieve Version) command instructs an NE to return its software version.

READONLY
Input Format
RTRV-VER:[<TID>]::[<CTAG>];
Example:
RTRV-VER:HTVLALEXD16::28;
Input Parameters
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 28
<
Normal Response
<cr> <lf> <lf>
^^^"<SW Rev.>" <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 15:52:08
M 28 COMPLD
"::VERSION=C01"
;
61186003L1-35D 7-21
Error Response
<cr> <lf> <lf>
;
7-22 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-VERSION
RTRV-VERSION
The RTRV-VERSION (Retrieve Version) command instructs an NE to return its software
version.

READONLY
Input Format
RTRV-VER:[<TID>]::[<CTAG>];
Example:
RTRV-VER:HTVLALEXD16::28;
Input Parameters
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 28
<
Normal Response
<cr> <lf> <lf>
^^^"<SW Rev.>" <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 15:52:08
M 28 COMPLD
"::VERSION=C01"
;
61186003L1-35D 7-23
Error Response
<cr> <lf> <lf>
;
7-24 61186003L1-35D
Section 7, Surveillance TL1 Commands - SCHED-PMREPT-rr
SCHED-PMREPT-rr
The SCHED-PMREPT-rr (Schedule Performance Monitoring Report-rr) command instructs an
NE to start, reschedule, or remove the reporting of performance-monitoring data for the type
specified by rr.
T1
T3
STS1
VT1
When this command is used, it is expected that the NE will periodically return data to the OS/
user with the automatic Report Performance Monitoring message.

ADMIN
Input Format
SCHED-PMREPT-rr:[<TID>]:<AID>:[<CTAG>]::[<REPTINVL>],[<REPTSTATM],[<NUMREPT>],
[<MONTYPE>],[<MONLEV>],[<LOCN>],,[<TMPER>][,<TMOFST>];
Example:
SCHED-PMREPT-T1:HTVLALEXD16:1-T1-MUX8-9:31::15-MIN,20-0,3,ESL,0-UP,NEND,,
15-MIN,0-0-0;
Input Parameters
AID The AID identifies the entity within the NE from which data is
being retrieved. Refer to Section 3, ADTRAN AID Formats, for
REPTINVL For the Report Interval (REPTINVL), refer to Appendix A, Input
REPTSTATM For the Report Starting Time (REPTSTATM), refer to Appendix
A, Input Commands Data Dictionary for additional informa-
tion.
NUMREPT For the Number of Reports (NUMREPT), refer to Appendix A,
MONTYPE For the MONTYPE, refer to Appendix A, Input Commands Data
61186003L1-35D 7-25
MONLEV For the MONLEV, refer to Appendix A, Input Commands Data

TMPER For the TMPER, refer to Appendix A, Input Commands Data
TMOFST For the Time Offset (TMOFST), refer to Appendix A, Input
Commands Data Dictionary for additional information..
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 31
<
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-05-31 17:04:08
M 31 COMPLD
;
Error Response
<cr> <lf> <lf>
;
7-26 61186003L1-35D
Section 8
System Maintenance TL1 Commands
INTRODUCTION
The following System Maintenance TL1 commands apply to the MX2820 System:
SW-TOPROTN-rr on page 8-2
SW-TOWKG-rr on page 8-4
61186003L1-35D 8-1
SW-TOPROTN-rr
The SW-TOPROTN-rr (Switch-To Protection-rr) command instructs an NE to perform a
protection switch.

READWRITE
Input Format
SW-TOPROTN-EQPT:[<TID>]:<AID>:[<CTAG>]::,;
Example:
SW-TOPROTN-EQPT:HTVLALEXD16:1-EQPT-MUX3-A::,;
Input Parameters
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 33
<
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-06-03 11:37:02
M 33 COMPLD
;
8-2 61186003L1-35D
Section 8, System Maintenance TL1 Commands - SW-TOPROTN-rr
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 8-3
SW-TOWKG-rr
The SW-TOWKG-EQPT (Switch-To Working rr) command instructs an NE to switch a
protected working unit back to working or release from protection.

READWRITE
Input Format
SW-TOWKG-EQPT:[<TID>]:<AID>:[<CTAG>]::;
Example:
SW-TOWKG-EQPT:HTVLALEXD16:1-EQPT-MUX3-B:34::;
Input Parameters
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 34
<
Normal Response
<cr> <lf> <lf>
;
Example:
HTVLALEXD16 02-06-03 11:38:39
M 34 COMPLD
;
8-4 61186003L1-35D
Section 8, System Maintenance TL1 Commands - SW-TOWKG-rr
Error Response
<cr> <lf> <lf>
;
61186003L1-35D 8-5
8-6 61186003L1-35D
Section 9
System Test TL1 Commands
INTRODUCTION
The following System Maintenance TL1 commands apply to the MX2820 System:
OPR-LPBK-rr on page 9-2
RLS-LPBK-rr on page 9-4
61186003L1-35D 9-1
OPR-LPBK-RR
The OPR-LPBK-rr (Operate-Loopback) instructs an NE to operate a loopback on a specified
facility in the NE. The loop can be accomplished at either the near end, the far end, or on the
line. It is assumed that the specified entity is in a state that allows a loopback to occur. If not,
an error response should be issued by the NE.
Any NE that has a loopback in effect should include the appropriate condition type infor-
mation in response to a RTRV-COND request.
The supported values for rr are as follows:
T1
T3
STS1
VT1
Input Format
OPR-LPBK-rr:[<tid>]:<aid>:[<ctag>]::,,,<lpbktype>;
Example:
OPR-LPBK-T3:HTVLALEXD16:1-T3-MUX4-1:25::,,,LINE;
Input Parameters
LPBKTYPE For the Loopback Type (LPBKTYPE), refer to Appendix A, Input
Response Format
Acknowledgment
If a normal response or an error response cannot be sent within two seconds of receipt of an
input command, an appropriate acknowledgment should be sent.
Normal Response
<cr> <lf> <lf>
9-2 61186003L1-35D
Section 9, System Test TL1 Commands - OPR-LPBK-rr
Example:
HTVLALEXD16 03-01-17 09:39:59
M 25 COMPLD
;
Error Response
<cr> <lf> <lf>
(^^^/*error text*/ <cr> <lf>) * ;
Refer to Appendix B, Response Messages Data Dictionary for normal response and error
response parameter descriptions.
61186003L1-35D 9-3
RLS-LPBK-RR
The RLS-LPBK-rr (Release-Loopback) command instructs an NE to release loopback on a
specified facility. The loop can have been established at the near end, the far end, or on the
line. Refer to OPR-LPBK-rr for related information.
The supported values for rr are as follows:
T1
T3
STS1
VT1
Input Format
RLS-LPBK-{rr|ALL}:[<tid>]:<aid>:[<ctag>]::,,;
Example:
RLS-LPBK-T3:HTVLALEXD16:1-T3-MUX4-1:26::,,;
Input Parameters
Response Format
Acknowledgment
If a normal response or an error response cannot be sent within 2 seconds of receipt of an
input command, an appropriate acknowledgment should be sent.
Normal Response
<cr> <lf> <lf>
Example:
HTVLALEXD16 03-01-17 09:39:59
M 25 COMPLD
;
9-4 61186003L1-35D
Section 9, System Test TL1 Commands - RLS-LPBK-rr
Error Response
<cr> <lf> <lf>
(^^^/*error text*/ <cr> <lf>) * ;
blocks are OPTIONAL and, if desired, MULTIPLE repetitions are allowed.
Refer to Appendix B, Response Messages Data Dictionary for normal response and error
response parameter descriptions.
61186003L1-35D 9-5
9-6 61186003L1-35D
Appendix A
Input Commands Data Dictionary
INTRODUCTION
Table A-1 provides descriptions for the parameters that can be used in a TL1 input command
for the MX2820 System.
Table A-1. TL1 Input Commands Data Dictionary
Parameter Description
AID Access Identifier. Refer to the Section 3, ADTRAN AID Formats for
information.
ALMTYPE This parameter indicates the alarm type.
CTAG The Correlation Tag associates the input command with the response
message(s). The CTAG contains 16 alphanumeric characters. The
CTAG is echoed in the response message to the input command. For
example, an input command with a CTAG of 1 has a response message
with a CTAG of 1. The default for the CTAG is 0.
DIRN The Direction parameter indicates the transmission direction to which

switching is made. The direction is relative to the SONET line or path
identified by the AID parameter. The supported value is RCV, Receive
direction only.
HH-MM-SS This parameter is the input format for the SET-DAT command that sets
the hours, minutes, and seconds. Each component is specified by two
digits.
LOCN The Location parameter indicates the location from which an alarm
condition or PM threshold alarm value is being reported and also refers
to the entity identified by the AID parameter. Near end refers to alarm
conditions occurring at the identified entity, and far end refers to alarm
conditions occurring at a distant entity that is connected to the identi-
fied entity. Values are as follows:
NEND
FEND
61186003L1-35D A-1
Table A-1. TL1 Input Commands Data Dictionary (Continued)
LPBKTYPE The Loopback Type parameter indicates the type of loopback being set
for the transmission entity. Depending on the characteristics of the
transmission system, various parts of a signal can be looped back. For
example, the LINE loopback can very well be a full metallic loopback,
while a PAYLOAD loopback can result in a signal that has been recoded
with new and different header and/or CRC information. Other values
are provided for technologies such as SONET and testing.
The supported values are shown in Table 5-3 under the LOOPBACK
parameter and in Table 5-4 under the LOOPBACK parameter.
MONDAT The Monitoring Date parameter indicates the beginning date for the PM
data specified in the TMPER parameter.
The format for MONDAT is MOY-DOM.
MOY indicates month of year and ranges from 01 to 12
DOM indicates day of month and ranges from 01 to 31
A null value for this parameter defaults to the current date.
MONLEV The Monitoring Level parameter specifies the discriminating level for
the requested monitored parameters.
Values are as follows:
0-UP, show zeros
1-UP, suppress zeros
MONTM The Monitoring Time parameter indicates the beginning time of day for
the PM data storage register specified in the TMPER parameter.
The format for MONTM is HOD-MOH, and the supported values are as
follows:
HOD indicates hour of day and ranges from 00 to 23
MOH indicates minutes of hour and ranges from 00 to 59
A null value for this parameter defaults to the current time.
MONTYPE The Monitor Type parameter specifies the type of the monitored param-
eter for which a value is requested.
NTFCNCDE The Notification Code parameter provides a two-character code associ-

ated with a single alarm condition.
CR, (Critical alarm)
MJ, (Major alarm)
MN, (Minor alarm)
NA, (Not alarmed)
CL, (Cleared alarm)
TH, (Threshold)
A-2 61186003L1-35D
Appendix A, Input Commands Data Dictionary - Introduction
NUMREPT The Number of Reports parameter specifies the number of the reports
that the schedule is expected to produce. A value of 0 terminates any
performance-monitoring reporting schedule that was introduced by a
previous SCHED-PMREPT-rr command. If the NUMREPT parameter
is null, the NE initiates performance monitoring and remains in that
scheduled mode until the schedule is changed. A value of -1 will sched-
ule performance monitoring indefinitely.
ORGN The Originating Office parameter indicates the office that originates the
signal to be looped back.
The supported values are as follows:
NEND
FEND
BOTH
PID The Private Identifier parameter provides the password for the user.
The PID consists of a string of letters and digits with a maximum length
of 12 characters. The first character must be a letter.
Letter: A-Z
Digit: 0-9
REPTINVL The Report Interval parameter specifies how often a performance-moni-

toring report is to be generated and returned to the requesting OS/
user.
The REPTINVL format is VAL-UN.
Values for VAL (value) and UN (units of time) are as follows:
VALUN
1 to 31DAY
1 to 24HR
1 to 1440MIN
REPTSTATM The Report Starting Time parameter specifies the starting time for the
performance-monitoring reporting schedule.
The REPTSTATM format is HOD-MOH, and the supported values are as
follows:
rr The rr value is a command verb modifier that indicates the type of

transmission entity for an NE.
EQPT
T1
T3
STS1
VT1
61186003L1-35D A-3
SRVEFF This parameter indicates the effect on the service caused by an alarm
condition. Valid values for SRVEFF are:
SA - Service-affecting condition, immediate action required
NSA - Nonservice-affecting condition, action required
Refer to Appendix D, Alarms and Alarm Condition Codes in this docu-
ment for Service Affecting data.
<specific_data_ block> The <specific data block> field is used for data parameters (attributes)
that pertain to a transmission entity. The data parameters are used for
provisioning a transmission entity.
<state_block> The <state_block> field is used for state parameters. The state parame-
ters provide information about an object's ability to perform its service
function.
IS (In-Service)
OOS (Out-of-Service)
TID The Target Identifier indicates the end-target NE for a TL1 command.
The Common Language Location Identifier (CLLI) is often used and rec-
ommended as the TID in TL1 commands. The CLLI code consists of
one-to-twenty alphanumeric characters that are not case sensitive. The
CLLI code identifies physical locations and equipment such as build-
ings, central offices, antennae, channel banks, and shelves. CLLI codes
are also used as unique identifiers for a single NE.
The valid characters for a TID include alphanumeric with a dash (-) as
a delimiter. The TID must begin with a letter.
Refer to the TID on page 2-3 for additional information.
TMOFST The Time Offset parameter specifies the time offset from the end of the
last complete accumulation time period to the beginning of the accu-
mulation time period specified in the TMPER parameter. The TMOFST
parameter provides a way to specify the age of storage registers.
The format is DAY-HR-MIN, and the supported values are as follows:
DAY indicates day of month and ranges from 00 to 31
HR indicates hour of day and ranges from 0 to 23
MIN indicates minutes of hour and ranges from 00 to 59
A null value defaults to 0-0-0.
TMPER The Time Period parameter indicates the accumulation time period for
performance-monitoring data.
15-MIN (quarterly hourly)
1-DAY
TSN The Test Session Number, which the OS assigns for each circuit
access, identifies all message for each circuit access. The range of val-
ues is from 1 to 999.
A-4 61186003L1-35D
Appendix A, Input Commands Data Dictionary - Introduction
TYPEREQ The TYPEREQ parameter indicates the condition type or entity state
being retrieved from the entity within the NE. For the MX2820 System,
values for the NTFCNCDE parameter are used for this parameter.
UAP User Access Privilege. The UAP value specifies the operations that a
user is allowed to perform.
Valid values are as follows:
READONLY : 1
READWRITE : 2
TEST : 3
ADMIN : 4
UID User Identifier. The UID, logon name, consists of a string of letters and
digits with a maximum length of 12 characters. The first character
must be a letter.
Letter: A-Z
Digit: 0-9
YY-MM-DD This parameter is the input format for the SET-DAT command that
sets the year, month, and day. Each component is specified by exactly
two digits.
The format is YY-MM-DD, and the supported values are as follows:
YY indicates year and ranges from 00 to 67
MM indicates month of year and ranges from 01 to 12
DD indicates day of month and ranges from 01 to 31
61186003L1-35D A-5
A-6 61186003L1-35D
Appendix B
Response Messages Data Dictionary
INTRODUCTION
Table B-1 provides descriptions for the parameters that can be received in a response message
to a TL1 input command for the MX2820 System.
Table B-1. TL1 Response Messages Data Dictionary
^ The carot symbol indicates an ASCII space character.
+ The plus sign indicates information for the preceding field or parameter
can occur one or more times.
AID The AID parameter in a response message indicates the location within
the NE entity from which information is being retrieved.
AIDTYPE This parameter indicates the type of AID. Examples include T1 and T3.
ALMTYPE This parameter indicates the alarm type.
CID The Channel Identifier (CID) parameter indicates the user's interface
port/channel that initiates a session or a logical equivalent such as a
user's calling address. For ports, the CID can be up to ten alphanu-
meric characters. For the directory numbers, the CID can consists of
seven digits in the form NXX-XXXX or ten digits in the form
NPA-NXX-XXXX.
CLEI This parameter indicates the equipment CLEI code for a specific
vendor.
COMPLD This parameter indicates the successful execution for the input
command. The transaction was fully completed.
CONDDESCR For the RTRV-ALM commands, this parameter provides a text

description of the trouble.
For the RTRV-COND commands, this parameter provides a text
description of the condition or state.
CONDTYPE This parameter indicates a single type of alarm condition being

reported for an entity within the NE. Refer to Appendix D, Alarms and
Alarm Condition Codes for condition types that apply to the MX2820
System.
61186003L1-35D B-1
Table B-1. TL1 Response Messages Data Dictionary (Continued)
CONTACT This parameter consists of a user-specified character string that

indicates the personnel to contact for the MX2820 System. The
maximum length is 55 characters.
<cr> ASCII carriage return
CTAG The CTAG associates the input command with the response
message(s). The CTAG contains 1 to 6 alphanumeric characters. The
CTAG is echoed in the response message to the input command. For
example, an input command with a CTAG of 1 has a response message
with a CTAG of 1.
DENY This parameter indicates unsuccessful execution for the input

command. The transaction was fully denied or uncompleted.
<error_code> The error_code provides a four-character mnemonic abbreviation for

the error condition. Refer to Appendix C, MX2820 System Error
Codes in this document for additional information.
HH:MM:SS This parameter is part of the response message header format.

The two digits components are as follows:
HH indicates hour of day and ranges from 00 to 23
MM indicates minutes of hour and ranges from 00 to 59
SS indicates seconds of minute and ranges from 00 to 59
INHMODE The Inhibit Mode parameter indicates whether a particular function is

inhibited. Valid values for this parameter are as follows:
ALW : Function is allowed
INH : Function is inhibited
A null value for this parameter defaults to ALW.
IP This acknowledgment component indicates the action specified by the

input command is in progress.
<lf> ASCII line feed character
LOCATION This parameter consists of a user-specified character string that

indicates the location of the MX2820 System. The maximum length is
55 characters
LOCN The Location parameter indicates the location from which an alarm
condition or Performance Monitoring (PM) threshold value is being
reported and also refers to the entity identified by the AID parameter.
Near end refers to alarm conditions occurring at the identified entity,
and far end refers to alarm conditions occurring at a distance entity
that is connected to the identified entity.
NEND
FEND
<login failures> Number of login failures on the account.
B-2 61186003L1-35D
Appendix B, Response Messages Data Dictionary - Introduction
MONLEV The Monitor Level parameter indicates the discriminating level for the
requested monitored parameter. Supported values are as follows:
0-UP : show zeros
1-UP : suppress zeros
MONTYPE This parameter indicates the type of monitored parameter for which a
value is being retrieved.
MONVAL This parameter provides the measured value for the MONTYPE param-
eter.
NTFCNCDE The Notification Code parameter provides a two-character code associ-

ated with a single alarm condition.
CR, (Critical alarm)
MJ, (Major alarm)
MN, (Minor alarm)
NA, (Not alarmed)
CL, (Cleared alarm)
TH, (Threshold)
A value of NR indicates not reported when the event occurs. The NE
retains the information.
NUMINVL The Number Interval parameter indicates the remaining number of

intervals associated with a particular action. A value of zero (0) for this
parameter in a SCHEDULE command indicates the stopping of the
particular action. A null value for this parameter specifies that the
particular task runs indefinitely until either stopped or rescheduled by
another command.
OCRDAT The Occurrence Date parameter indicates the date for a triggering
event.
The OCRDAT format is MOY-DOM.
MOY indicates month of the year and ranges from 01 to 12
DOM indicates the day of the month and ranges from 01 to 31
OCRTM The Occurrence Time parameter indicates the time for a triggering
event.
The OCRTM format is HOD-MOH-SOM.
SOM indicates seconds of minutes and ranges from 00 to 59
A null value for this parameter means that the OCRTM and OCRDAT
parameters are not applicable.
61186003L1-35D B-3
REPTDAT The Report Date parameter specifies the date for the next PM report.
The REPTDAT format is MOY-DOM.
MOY indicates month and year and ranges from 01 to 12
DOM indicates day month and ranges from 01 to 31
REPTINVL The Report Interval parameter specifies how often a performance-

monitoring report is to be generated and returned to the requesting
OS/user. The REPTINVL format is VAL-UN.
Values for VAL (value) and UN (units of time) are as follows:
VALUN
1 to 31DAY
1 to 24HR
1 to 1440MIN
REPTTM The Report Time parameter specifies the time of day for the next PM
report.
The REPTTM format is HOD-MOH.
<rspblk> The Response Block contains the information that an NE entity sends
to the OS/user. Information in the Response Block depends on the NE
entity sending the data to the OS/user and also depends on the input
command parameters sent to the NE by the OS/user.
SID The Source Identifier (SID) identifies the Network Element generating
the response message. The SID is the shelf CLLI code.
<specific data block> The Specific Data Block field provides information about the provision
data parameters for the specified NE entity. Examples of an NE entity
are T1 and T3. Refer to the Transmission Entity Data Parameter
Tables on page 5-10 for additional information.
SRVEFF This parameter indicates the effect on the service caused by an alarm
condition. Valid values for SRVEFF are:
SA - Service-affecting condition, immediate action required
NSA - Nonservice-affecting condition, action required
Refer to Appendix D, Alarms and Alarm Condition Codes for Service
Affecting data.
<SW Rev.> This parameter indicates the software release for an NE.
B-4 61186003L1-35D
Appendix B, Response Messages Data Dictionary - Introduction
TMOFST The Time Offset parameter indicates the time offset from the end of the
last complete accumulation time period to the beginning of the
accumulation period specified in the TMPER parameter. The format for
TMOFST is DAY-HR-MIN.
The format is DAY-HR-MIN.
DAY indicates day of month and ranges from 00 to 31
HR indicates hour of day and ranges from 00 to 23
MIN indicates minutes of hour and ranges from 00 to 59
A null value for the TMOFST parameter in Input messages defaults to
0-0-0.
TMPER The Time Period parameter indicates the accumulation time period for
performance-monitoring data.
15-MIN (quarterly hourly)
1-DAY
TYPE This parameter consists of a user-specified character string that

indicates the system type. The maximum length is 55 characters.
TYPEREP The Type Report parameter identifies the condition type being reported
or the entity state that is being reported. The condition type corre-
sponds to the CONDTYPE parameter. The entity state corresponds to
the <state> parameter. Valid values for the TYPEREP parameter are the
values that can be included in the CONDTYPE parameter are values
that can be in the <state> parameter.
Refer to Appendix D, Alarms and Alarm Condition Codes for values
that apply to the CONDTYPE parameter.
Values for the <state> parameter are as follows:
IS (In Service)
OOS (Out-of-Service) OOS implies Out-of-Service, Maintenance
UAP User Access Privilege. The UAP value specifies the operations that a
user is allowed to perform.
READONLY : 1
READWRITE : 2
TEST : 3
ADMIN : 4
61186003L1-35D B-5
VLDTY The Validity parameter provides historical monitoring information. This

parameter indicates whether the information for the specified monitor-
ing period was accumulated over the entire monitoring period or some
portion of it.
COMPL : Data is accumulated over the entire monitoring period
PRTL : Data is accumulated over some portion of the monitoring
period
YY-MM-DD This is the response message date format where the two digits compo-
nents are as follows:
YY indicates year and ranges from 00 to 67
MM indicates month of year and ranges from 01 to 12
DD indicates day of month and ranges from 01 to 31
B-6 61186003L1-35D
Appendix C
Error Codes
INTRODUCTION
The response message to a TL1 input command contains an error code <errcode> parameter
when the addressed NE cannot complete the action for the input command. Table C-1
provides error code for the MX2820 System.
Table C-1. MX2820 System Error Codes
Error Code Category Description
EANS Equipment This error code indicates access is not supported.
EATN Equipage This error code indicates not valid for access type.
ENEQ Error This error code indicates the device is not equipped.
ENPM Error This error code indicates performance monitoring is not supported.
ICNV Input This error code indicates the command is not valid.
IDRG Input This error code indicates the date range is not valid.
IIAC Input This error code indicates an invalid access identifier.
IIDT Input This error code indicates an invalid data parameter.
IIPG Input This error code indicates invalid parameter grouping.
INAC Input This error code indicates an invalid test access point.
IPNV Input This error code indicates the parameter is not valid.
PIUI Privilege This error code indicates the input user is not valid.
PLNA Privilege This error code indicates the login is not active or insufficient
privileges.
RABY Resource This error code indicates all TAPs are busy.
RCBY Resource This error code indicates a circuit busy condition (access point is in
use).
RNAN Resource This error code indicates the requested NE access address does not
exist.
61186003L1-35D C-1
Table C-1. MX2820 System Error Codes (Continued)
Error Code Category Description
RNAU Resource This error code indicates the requested NE access address is
unassigned.
RNBY Resource This error code indicates the NE is busy.
RTBY Resource This error code indicates the TAP is busy.
RTEN Resource This error code indicates the requested TAP does not exist.
SADC Status This error code indicates the device is already disconnected.
SCAT Status This error code indicates the circuit is already connected to another
TAP.
SCBS Status This error code indicates the channel is busy.
SCSN Status This error code indicates an invalid command sequence.
SNDS Status This error code indicates the NTE is in a diagnostic state.
SNVS Status This error code indicates the device is not in a valid state.
SRAC Status This error code indicates the requested access configuration is not
valid.
SRAN Status This error code indicate the access system cannot be released.
SRCN Status This error code indicates the requested condition already exists.
SROF Status This error code indicates the requested operation failed.
SRTN Status This error code indicates the TAP cannot be released.
SSRE Status This error code indicates the system resource is not available.
STLC Status This error code indicates the TAP is unable to locate the channel.
C-2 61186003L1-35D
Appendix D
Alarms and Alarm Condition Codes
INTRODUCTION
Alarm information and condition codes for the MX2820 System are provided in this index. The
following modules are included:
SCU
M13 MUX
STS-1 MUX
MX2820 Clock Card
SCU ALARMS
Alarms for the SCU are described in Table D-1.
Table D-1. MX2820 SCU Alarm Data
Condition Code Alarm Level Service Description

<CONDTYPE> Affecting
(SRVEFF)
AUX1 Major NSA This alarm indicates External Alarm Input

number 1 on the rear of the shelf is active.
The default alarm level is Minor and is
provisionable in the SCU alarm menus.
Provisionable alarm levels include: Critical,
Major, Minor, Alert, and Info. The description
string is provisionable and defaults to Aux #1
Input.
AUX2 Major NSA This alarm indicates External Alarm Input

number 2 on the rear of the shelf is active.
The default level is Alert and is provisionable
in the SCU alarm menus. Provisionable
alarm levels include: Critical, Major, Minor,
Alert, and Info. The description string is
provisionable and defaults to Aux #2 Input.
61186003L1-35D D-1
Table D-1. MX2820 SCU Alarm Data (Continued)
Condition Code Alarm Level Service Description

<CONDTYPE> Affecting
(SRVEFF)
AUX3A Major NSA This alarm indicates External Alarm Input

number 3A on the rear of the shelf is active.
The default alarm level is Major and is
string is provisionable and defaults to Aux
#3A Input. Aux 3A is active with solid input.
AUX3B Major NSA This alarm indicates External Alarm Input

number 3B on the rear of the shelf is active.
The default alarm level is Major and is
string is provisionable and defaults to Aux
#3B Input. Aux 3B is active with cadenced
input (1 second on, 1 second off).
PWRA Major SA This alarm indicates a Power Bus A failure.

The default level is Major and is provisionable
Alert, and Info.
PWRB Major SA This alarm indicates a Power Bus B failure.

The default level is Major and is provisionable
Alert, and Info.
IMPROPRMVL Critical SA A linecard was removed leading to a service

outage.
IMPROPRMVL Major NSA A standby linecard was removed leaving

service unaffected.
D-2 61186003L1-35D
Appendix D, Alarms and Alarm Condition Codes - M13 MUX Card Alarms
M13 MUX CARD ALARMS

Table D-2 provides the alarms for the M13 MUX card. Table entries with the T-x format, (for
example, T-CVL), provide PM data for both quarterly and daily threshold violations that are
sent from the NE to the OS/user. The threshold alarms are Auto Clearing (AC). The alarms in
this table are for transmission type T3 (rr=T3). The applicable TL1 command is RTRV-ALM-T3.
Table D-2. MX2820 M13 MUX Alarm Data
Entity Name Message Second Notification Service Condition Type Location

And Type Modifier Code Affecting <CONDTYPE>
Description (SRVEFF)
DS3 REPT ALM T3 CR SA LOS Near end

OOF Near end
MN NSA EXT Far end

EXT-T3-NSA Far end
EXT-T3-SA Far end
EXT-T1-NSA Far end
EXT-T1-SA Far end
LOS Far end
OOF Far end
LOS-T1-MULT Far end
LOS-T1-SNG Far end
REPT EVT T3 SC SA TSA Near end
SC NSA AIS Far end

ISD Far end
AIS Near end
ISD Near end
RAI Near end
XCV Near end
TC NSA T-CVL Near end

T-ESL Near end
T-SESL Near end
T-LOSS-L Near end
T-CVP-P Near end
T-ESP-P Near end
T-SESP-P Near end
T-UASP-P Near end
T-CVCP-P Near end
T-ESCP-P Near end
T-SESCP-P Near end
T-UASCP-P Near end
T-SAS-P Near end
T-CVCP-PFE Far end
T-ESCP-PFE Far end
T-SESCP-PFE Far end
T-UASCP-PFE Far end
61186003L1-35D D-3
Table D-2. MX2820 M13 MUX Alarm Data (Continued)

DS1 REPT ALM T1 MJ SA LOS Near end
SC NSA XCV Near end

AIS Near end
AIS-NTWK Near end
TC NSA T-CVL Near end

T-ESL Near end
T-SESL Near end
T-LOSS-L Near end
T-AISS Near end
For P/N
1186002L3 Only:
T-CVL-LS Near end
T-ESL-LS Near end
T-SESL-LS Near end
T-LOSS-L-LS Near end
T-CVP-LS Near end
T-ESP-LS Near end
T-SESP-LS Near end
T-UASP-LS Near end
T-AISS-P-LS Near end
T-CVP-HS Near end
T-ESP-HS Near end
T-SESP-HS Near end
T-UASP-HS Near end
T-AISS-P-HS Near end
Equipment REPT ALM EQPT MN* NSA EQPT Near end

CR SA Near end
MN* NSA IMPROPRMVL Near end

CR SA Near end
MN NSA CONTCOM Near end
REPT EVT EQPT SC NSA WKSWPR Near end

ESW Near end
* This alarm will be reported as either Minor, Non-Service Affecting or Critical, Service Affecting depending on
whether protection is available.
D-4 61186003L1-35D
Appendix D, Alarms and Alarm Condition Codes - STS-1 MUX Card Alarms
STS-1 MUX CARD ALARMS

Table D-3 provides the alarms for the STS-1 MUX card. Table entries with the T-x format, (for
example, T-CVL), provide PM data for both quarterly and daily threshold violations that are
sent from the NE to the OS/user. The threshold alarms are AC. The alarms in this table are
for transmission type STS1 (rr=STS1). The applicable TL1 command is RTRV-ALM-STS1.
Table D-3. MX2820 STS-1 MUX Alarm Data

STS1 REPT ALM STS1 CR SA LOS Near end

LOP
LOF
LOMF
UEQP
SLMP
REPT EVT STS1 SC SA TSA Near end
NSA AIS-L Near end

AIS-P
RFI-L
RFI-P
TIM-P
TC NSA T-CVS Near end,

T-ESS Quarterly,
T-SESS Daily
T-SEFS-S
T-CVL
T-ESL
T-SESL
T-UASL
T-CVP
T-ESP
T-SESP
T-UASP
T-PPJC-PDET
T-NPJC-PDET
T-CV-LFE Far end,

T-ES-LFE Quarterly,
T-SES-LFE Daily
T-UAS-LFE
T-CV-PFE
T-ES-PFE
T-SES-PFE
T-UAS-PFE
61186003L1-35D D-5
Table D-3. MX2820 STS-1 MUX Alarm Data (Continued)

VT REPT ALM VT1 MJ SA LOP-V Near end

UNEQ-V
SLM-V
REPT EVT VT1 SC NSA AIS-V Near end

RFI-V
TC NSA T-CV-V Near end,

T-ES-V Quarterly,
T-SES-V Daily
T-UAS-V
T-CV-VFE Far end,

T-ES-VFE Quarterly,
T-SES-VFE Daily
T-UAS-VFE
DS1 REPT ALM T1 MJ SA LOS Near end

NSA XCV
NSA AIS
NSA AIS-NTWK
TC NSA T-CVL Near end,

T-ESL Quarterly,
T-SESL Daily
T-LOSS-L
T-AISS-P
Equipment REPT ALM EQPT MN* NSA EQPT Near end

CR SA

CR SA
MN NSA CONTCOM Near end

CLK-LOA

ESW
D-6 61186003L1-35D
Appendix D, Alarms and Alarm Condition Codes - MX2820 Clock Card Alarms
MX2820 CLOCK CARD ALARMS

Table D-4 provides the alarms for the MX2820 Clock Card. The alarms in this table are for
transmission type EQPT (rr=EQPT). The applicable TL1 command is RTRV-ALM-EQPT.
Table D-4. MX2820 Clock Card Alarm Data

Equipment REPT ALM EQPT MJ NSA HO Near end
MN NSA EQPT Near end

CONTCOM Near end

CR SA Near end
MN NSA PRIFAIL Near end

SECFAIL Near end

ESW Near end
61186003L1-35D D-7
D-8 61186003L1-35D
Appendix E
Autonomous Messages
INTRODUCTION
This appendix provides information about autonomous messages. Autonomous messages are
generated automatically by alarm conditions or events that occur at NEs. The ALW-MSG TL1
command allows the sending of autonomous messages to the OS/user. The INH-MSG TL1
command inhibits or prevents the sending of autonomous messages to the OS/user.
SYNTAX
An autonomous message for the MX2820 System has the following format:
<cr> <lf> <lf>
^^^<source identifier>^<date>^<time> <cr> <lf>
<almcde>^<atag>^<verb>[^<modifier> [^modifier>]] <cr> <lf>
^^^"<aid>:<message parameter>" <cr> <lf>
Table E-1 provides parameter (field) descriptions for autonomous messages.
Table E-1. Autonomous Messages Parameter Descriptions
<cr> Carriage return
<lf> Line feed
Caret (^) Represents one space character
<source identifier> The Shelf CLLI code
<date> Date in the form YY-MM-DD
<time> Time in the form HH-MM-SS
<almcde> Alarm code. The alarm code indicates the severity of the auton-
omous message.
Valid values for <almcde> in decreasing order of severity are as
follows:
*C Critical alarm
** Major alarm
*^ Minor alarm
A^ Non-alarm message
61186003L1-35D E-1
Table E-1. Autonomous Messages Parameter Descriptions (Continued)
<atag> Autonomously Generated Correlation Tag (ATAG). The ATAG is

a decimal number assigned by the NE. The ATAG must be
sequential and must be included in all autonomous messages.
The ATAG allows an OS/user to determine if the OS has failed
to receive any Autonomous outputs by checking for omissions
in the sequence of messages received.
<verb>[^modifier>[^modifier>]] Identifies the nature of the autonomous output and allows for
quick identification of the semantics of the information in the
text block. It consists of up to three valid TL1 identifiers sepa-
rated by the space character (^). The first identifier (<verb>) is
the autonomous message verb and is a required entry. In most
cases, the verb in an autonomous message will be REPT
(Report). The autonomous message verb can have up to two
optional modifiers. The valid forms are as follows:
<verb>
<verb>^<modifier>
<verb>^<modifier>^<modifier>
The first modifier following the verb modifies the verb. The sec-
ond modifier specifies the object generating the message. Cer-
tain modifiers (for example, EQPT) mean that the <AID>
parameter, if it exists, is addressing a particular type of entity in
the NE.
<message block> Detailed data related to the specific alarm or report.
ALARMS
Autonomous alarms are sent only when users are currently logged onto the system, and only
after the users have entered an ALW-MSG-xx command to enable sending the alarms. The
xx field can be ALL or a specific transmission level such as T1. Another field in the
command, the <specific data block> field, can select all alarm categories or a specific alarm
such as MAJOR. A companion command, INH-MSG-xx inhibits all or selected types of
messages. The effects are cumulative such that a user could allow all alarms, and then inhibit
only the MINOR alarms. Once a user logs off the system, the autonomous alarms cease.
There is no specified or provisionable TL1 session-timeout period. If a user is logged into a TL1
account, the account remains active until the user explicitly logs out or the session is termi-
nated (for example, TL1 over Telnet session closed, or X.25 connection lost).
E-2 61186003L1-35D
Appendix E, Autonomous Messages - SCU
SCU
In systems where INE mode CLIENT shelves are chained to a HOST SCU, and the user desires
autonomous alarms from the INE clients to be reported through the HOST, each INE CLIENT
shelf must be sent an ACT-USER, an ALW-MSG-xx by the user, and the user must remain
logged in to enable autonomous alarms from the CLIENT shelf. If the client shelves are in
EXPANSION mode, the client shelves are managed under the TID of the HOST SCU, and the
TL1 session and autonomous message activation is only required on the HOST SCU.
The SCU generates Card Removed alarm events when a card is inserted or removed. If the
card is removed while its service state is provisioned for Out-of-Service (OOS), the SCU
assigns an alarm level of INFO to the active alarm event. When a card is inserted, the SCU
assigns a level to the cleared event corresponding to the level of any previous active event if
present. Otherwise, the SCU assigns the alarm with the level that was provisioned for the
Card Removed alarm.
If a line card is removed with ACTIVE alarms, the SCU will automatically issue a CLEAR alarm
event for all active alarms.
EVENTS
Events are a variety of alarms which have a severity of MINOR. The format of the detailed data
is slightly different than that of the alarms in that the condition code and status fields are
reversed.
PERFORMANCE MONITORING REPORTS

Autonomous Performance Monitoring (PM) reports can be generated as a result of a
SCHED-PMREPT-rr command.
CONDITION CODES
Condition codes are assigned to identify specific reasons for the alarm or event. Refer to the
Alarms and Alarm Condition Codes Appendix in this document for information about the
condition codes generated by the circuit cards in a MX2820 shelf.
61186003L1-35D E-3
AUTONOMOUS MESSAGE EXAMPLES
M13 MUX Alarms

The following examples are autonomous messages for alarms that apply to a DS3 MUX card.
Command Response from Network Element

REPTÂLM
Alarm Response
Example:
03-11-19 11:28:03
*C 240 REPT ALM T3
"1-T3-MUX3-1:CR,OOF,SA,11-19,11-28-03,NEND,,,,:\"DS3 OOF\""
;
03-11-19 11:28:03
*C 241 REPT ALM T3
"1-T3-MUX3-1:CR,LOS,SA,11-19,11-28-03,NEND,,,,:\"DS3 LOS\""
;
Corresponding Clears
Example:
03-11-19 11:28:42
A 243 REPT ALM T3
"1-T3-MUX3-1:CL,OOF,SA,11-19,11-28-42,NEND,,,,:\"DS3 OOF\""
;
03-11-19 11:28:42
A 244 REPT ALM T3
"1-T3-MUX3-1:CL,LOS,SA,11-19,11-28-42,NEND,,,,:\"DS3 LOS\""
;
E-4 61186003L1-35D
Appendix E, Autonomous Messages - Autonomous Message Examples
Threshold Alarms
The following examples are autonomous messages for threshold alarms. The first two
examples are for a M13 MUX card. The third example is for a DSX-1 card. Threshold alarms
are sent out as ALERTs. Threshold alarms are AC.

REPTÊVT
M13 MUX Alarm Response

Example:
03-11-19 11:28:36
A 242 REPT EVT T3
"1-T3-MUX3-1:RAI,SC,11-19,11-28-36,NEND,,,,:\"DS3 RAI\""
;
03-11-19 11:28:52
A 245 REPT EVT T3
"1-T3-MUX3-1:RAI,CL,11-19,11-28-52,NEND,,,,:\"DS3 RAI\""
;
03-11-19 11:43:24
A 258 REPT EVT T1
"1-T1-MUX3-1:T-LOSS-L,TC,11-19,11-43-24,NEND,,,,:\"DAY LOSS-L\""
;
Environmental Alarms
The following examples are autonomous messages for environmental alarms.

REPTÂLMÊNV
Alarm Response
Example:
03-11-19 11:31:34
** 252 REPT ALM ENV
"1-ENV-1:MJ,AUX1,11-19,11-31-34,\"AUX #1 INPUT\""
;
03-11-19 11:32:27
** 254 REPT ALM ENV
"1-ENV-3:MJ,AUX3A,11-19,11-32-27,\"AUX #3A INPUT\""
;
61186003L1-35D E-5
03-11-19 11:31:34
A 253 REPT ALM ENV
"1-ENV-1:CL,AUX1,11-19,11-31-34,\"AUX #1 INPUT\""
;
03-11-19 11:32:29
A 255 REPT ALM ENV
"1-ENV-3:CL,AUX3A,11-19,11-32-29,\"AUX #3A INPUT\""
;
E-6 61186003L1-35D
Appendix F
Performance Monitoring Codes
This appendix provides performance monitoring information for the M13 and STS-1
Multiplexer modules.
MONTYPE values for the RTRV-PM-rr commands are listed in Figure F-1 and Figure F-2.
M13 MUX
Table F-1. M13 MUX Performance Monitoring MONTYPE Values
Interval MONTYPE Value
T3 Performance Monitoring rr Value = T3
Quarterly & Daily Near-End SESL
LOSS-L
ESP-P
SESP-P
SAS-P
UASP-P
UASCP-P
CVL
CVP-P
ESL
CVCP-P
ESCP-P
SESCP-P
Quarterly & Daily Far-End ESCP-PFE
SESCP-PFE
CVCP-PFE
UASCP-PFE
61186003L1-35D F-1
Table F-1. M13 MUX Performance Monitoring MONTYPE Values
T1 Performance Monitoring rr = T1
Quarterly & Daily Near-End CVL
ESL
SESL
LOSS-L
AISS-P
For P/N 1186002L3 Only:
CVL-LS
ESL-LS
SESL-LS
LOSS-L-LS
CVP-LS
ESP-LS
SESP-LS
UASP-LS
AISS-P-LS
CVP-HS
ESP-HS
SESP-HS
UASP-HS
AISS-P-HS
F-2 61186003L1-35D
Appendix F, Performance Monitoring Codes - STS-1 MUX
STS-1 MUX
Table F-2. STS-1 MUX Performance Monitoring MONTYPE Values
STS1 Performance Monitoring rr = STS1
Quarterly & Daily Near-End CVS
ESS
SESS
SEFS-S
CVL
ESL
SESL
UASL
CVP
ESP
SESP
UASP
PPJC-PDET
NPJC-PDET
Quarterly & Daily Far-End CV-LFE
ES-LFE
SES-LFE
UAS-LFE
CV-PFE
ES-PFE
SES-PFE
UAS-PFE
61186003L1-35D F-3
Table F-2. STS-1 MUX Performance Monitoring MONTYPE Values (Continued)
VT Performance Monitoring rr = VT1
Quarterly & Daily Near-End CV-V
ES-V
SES-V
UAS-V
Quarterly & Daily Far-End CV-VFE
ES-VFE
SES-VFE
UAS-VFE
T1 Performance Monitoring rr = T1
Quarterly & Daily Near-End CVL
ESL
SESL
LOSS-L
AISS-P
F-4 61186003L1-35D
Appendix G
MX2820 Service States
INTRODUCTION
The purpose of this section is to describe the functionality of the service states of the MX2820
System.
The service state entities defined for the MX2820 modules follow a hierarchy as illustrated in
Figure G-1. Each entity has a Provisioned Service State and an Operational (Functional)
Service State.
The Provisioned Service State for a given entity can be set to In-Service (IS) or OOS. As with
other provisioning items, the Provisioned Service State values for all entities are saved to non-
volatile memory and are transferred among mate cards in a redundant configuration.
In addition to the Provisioned Service State, each entity has an Operational Service State. The
value of an entity's Operational Service State can assume one of several defined values and is
influenced by both the entity's Provisioned Service State and current conditions. For DS1/E1
entities, the Traditional State of the channel (described later) also influences the Operational
Service State.
Limitations of Diagrams
The Service State diagrams are designed to show the main flow of events only. There is no way
to add all possible event transitions to these diagrams while keeping them readable. The
Service State tables are the only place to get a complete definition of all events that can occur
in a given state. Use the diagrams for conceptual reference only.
Event Priorities
The service state tables and diagrams indicate how the product will respond to various events.
For some cases, especially with the diagrams, it can not be obvious from the diagrams about
which conditions should be considered before others in determining an entity's next opera-
tional state. To help clarify such questions, all tables should generally be read from the top
down in an If-Else fashion.
Criteria Monitored for an Entity

In general, criteria that are monitored for a given state of a given entity are specific to that
entity. For example, when the diagram or service state table for the DS1 #3 facility OOS-MA
state indicates that it monitors for Fault - SA, it is implied that it refers only to service-
affecting faults specific to DS1 #3.
61186003L1-35D G-1
SCU and Clock Modules Entity Hierarchy
EQUIPMENT
M13 MUX Module Entity Hierarchy
EQUIPMENT Parent
DS3 FACILITY Child Parent
DS1/E1 DS1/E1 DS1/E1 Child

FACILITY #1 FACILITY #2 FACILITY #28
STS-1 MUX Module Entity Hierarchy
EQUIPMENT Parent
EC-1/STS-1 Child Parent

FACILITY
VT VT VT Child Parent
PATH #1 PATH #2 PATH #28
CROSS-CONNECT
DS1/E1 DS1/E1 DS1/E1

FACILITY #1 FACILITY #2 FACILITY #28 Child
Figure G-1. MX2820 System Service State Hierarchy
G-2 61186003L1-35D
Appendix G, MX2820 Service States - Introduction
Definition of AINS Criteria

The term AINS stands for Automatic In-Service and applies to any DS1/E1 facility whose
Traditional State is Auto-enabled. This term is used to describe the criteria that must be met
to bring the facility out of the OOS-AU FLT, AINS state.
The AINS criteria generally require that a DS1/E1 facility must be out of a LOS condition
continuously for a specified length of time. The user sets this length of time with the auto-
enable delay feature.
Definitions of Available and Unavailable

The terms available and unavailable apply to the M13 and STS-1 modules to distinguish
DS1/E1 facility and VT path entities that can and cannot be used when the product is provi-
sioned for E1 mode.
For the M13 module, each of the seven DS2 channels can be independently provisioned for
either T1 or E1 mode operation. For any DS2 channel operating in T1 mode, all four DS1 facil-
ities of that DS2 are available. For any DS2 channel operating in E1 mode, the first three E1
facility entities are available and the fourth entity is unavailable.
For the STS-1 module, all seven VT groups are provisioned together for either T1 or E1 mode
operation. When operating in T1 mode, all 28 VT path entities and all 28 DS1 facility entities
are available. When operating in E1 mode, VT path entities 22-28 and DSX facility entities
22-28 are unavailable and the remaining entities are available.
Recursive alarm suppression

When any parent entity is managed out of service, alarms are in turn suppressed for all of the
parent's child entities.
This behavior is implemented such that, in general, when a parent entity is in any operational
state that suppresses alarms, the operational states of all of the parent's child entities are set
to OOS-AUMA, SGEO, regardless of the provisioned service states of the child entities.
When the parent entity is managed in-service, the parent's child entities in turn transition to
the appropriate states and allow or suppress alarms normally per their own provisioning and
conditions.
An example of this behavior is that when the equipment provisioned service state of the M13
module is set to OOS, the DS3 operational state then transitions to OOS-AUMA, SGEO, which
in turn causes the DS1 operational states to follow suit. The provisioned service states of the
DS3 and DS1/E1 entities remain unchanged, and alarm reporting for all entities is
suppressed.
Traditional States
The term Traditional State applies to the M13 and STS-1 modules to refer to the T1/E1
State feature that has been and is presently supported in all multiplexer products of the
MX2800/MX2820 product family.
61186003L1-35D G-3
The Traditional State for each T1/E1 facility can be provisioned with one of the following three
settings:
Disabled: The channel is inhibited from carrying bi-directional traffic. The DS1/E1
transmitter is turned off and an unframed all-ones pattern is transmitted toward the
network. No alarms are reported for the facility (including the attached VT if applicable).
Enabled: The facility conducts bi-directional traffic and full alarm reporting is allowed for
the facility (as well as for the attached VT if applicable).
Auto-enabled: The facility conducts bi-directional traffic and all alarms for the channel (as
well as for the attached VT if applicable) are suppressed until a DS1/E1 signal is detected
continuously at the receiver for a time period specified by the product's auto-enable delay
setting. Upon detection of the incoming signal for the required length of time, the
Traditional State of the facility will automatically transition to Enabled.
Backward Compatibility with Traditional States

The service state features of the MX2820 M13 and STS-1 modules are designed both to coexist
with and to be backward compatible with the Traditional States.
Generally, the service state features of the MX2820 modules are designed to be transparent to
users who do not make use of service states. The default provisioned service state is in-service
(IS) for all entities. The user can leave the entities provisioned in-service at all times and
expect the product to function no differently than before service state support was imple-
mented.
A consequence of the backward compatibility with Traditional States is some degree of
departure from some traditional service state behaviors as they are described in GR-1093.
An example of such a departure involves provisioning and maintenance activities. The GR-
1093 standard generally states that updates of provisioning data and the performance of
maintenance activities should not be permitted for entities that have assumed certain service
states. The MX2820 M13 and STS-1 mux modules are designed to allow the user to perform
such activities independently of the provisioned and functional service states of any entity.
G-4 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Equipment
OPERATIONAL SERVICE STATE MODEL FOR EQUIPMENT
Independent Equipment Service States

Each module keeps a record of its own provisioned and operational equipment service states
as well as those of its mate module (if applicable) (refer to Figure G-2). The provisioned service
state of the equipment entity for each module can be set to IS or OOS independently of the
settings of its mate module. If operating non-redundantly, the provisioned service state for the
absent stand-by module can be provisioned as either IS or OOS. Its value will reside on the
active module and will automatically be applied to the mate module (if applicable) when and if
it is installed. This is a limited but necessary form of pre-provisioning due to the need for an
independent equipment service state for each module. The operational service state of an
absent stand-by module that resides on the active module is E6 (OOS-AUMA UAS, UEQ).
Indication of the Active Module

Due to the nature of the equipment service states, the operational service state of the
equipment entity alone cannot reliably indicate which module in a redundant pair is active
and which is stand-by.
ED:IS
State E6 State E3
OOS-AUMA OOS-MA
UAS, UEQ
Flt SA
No Flt SA;
Flt NSA
ED:OOS All Flt

All Flt
Recovered Recovered
State E1a Flt SA

State E4a State E4b
IS OOS-AUMA OOS-MA
ACT FLT FLT
No Flt SA;
Flt NSA
Protection ED:IS ED:IS
Switch
ED:OOS ED:OOS
State E1b Flt SA Flt SA

State E5a
IS State E5b
OOS-AU
STBYH IS-ANR
All Flt FLT
No Flt SA;
Recovered Flt NSA
No Flt SA; All Flt

Flt NSA Recovered
Figure G-2. Equipment Service States
61186003L1-35D G-5
State E1a: IS ACT

Description: The card is installed and is performing its intended functions.
Provisioned State: IS
On Entry to State: Allow alarms for this entity.
Table G-1 shows the state transitions.
Table G-1. State E1a: IS ACT
Event Action or Condition Next State
ENT,DLT TL1 DENY:SNVS ---
EDIT:IS None ---
EDIT:OOS None E3
SW-TOPROTN and card is A None E1b
SW-TOPROTN and card is B. TL1 DENY:SNVS ---
SW-TOWKG and card is A TL1 DENY:SNVS ---
SW-TOWKG and card is B None E1b
Fault SA None E5a
No Fault SA; Fault NSA None E5b
All faults clear None ---
NOTE
It is not possible for the protect card (card B) to be in state E1a
because the protection switch alarm should be active, which would
in turn cause the service state to transition to E5b.
G-6 61186003L1-35D
State E1b: IS STDBYH

Description: The card is installed and would be performing its intended
functions if it were not the standby card.
On Entry to State: Suppress alarms for this entity.
Table G-2. State E1b: IS STDBYH
EDIT:IS None ---
EDIT:OOS None E3
SW TL1 DENY:SNVS ---
Active Card None E1a
Fault SA None E5a
State E3: OOS-MA

Description: The card is manually provisioned out-of-service. No equipment-
level fault conditions are present.
Provisioned State: OOS
Table G-3. State E3: OOS-MA
EDIT:IS and active card None E1a
EDIT:IS and standby card None E1b
EDIT:OOS None ---
Fault SA None E4a
61186003L1-35D G-7
State E4a: OOS-AUMA FLT

Description: The card is manually provisioned out-of-service and presently
has one or more service affecting equipment-level fault
conditions present.
Table G-4. State E4a: OOS-AUMA FLT
EDIT:IS None E5a
EDIT:OOS None ---
Fault SA None
All faults clear None E3
State E4b: OOS-MA FLT

Description: The card is manually provisioned out-of-service and presently
has one or more non-service affecting and no service-affecting
equipment-level fault conditions present.
Table G-5. State E4b: OOS-MA FLT
EDIT:IS None E5b
EDIT:OOS None ---
Fault SA None E4a
No Fault SA; Fault NSA None
All faults clear None E3
G-8 61186003L1-35D
State E5a: OOS-AU FLT

Description: The card presently has one or more service affecting equipment-
level fault conditions present.
Table G-6. State E5a: OOS-AU FLT
EDIT:IS None
EDIT:OOS None E4a
Fault SA None
All faults clear If Active card E1a
Else If Standby card E1b
State E5b: IS-ANR

Description: The card has one or more non-service affecting and no service
affecting equipment-level fault conditions for this entity
present.
Table G-7. State E5b: IS-ANR
EDIT:IS None
EDIT:OOS None E4b
Fault SA None E5a
No Fault SA; Fault NSA None
All faults clear If Active card E1a
Else If Standby card E1b
61186003L1-35D G-9
State E6: OOS-AUMA UAS, UEQ

Description: This is the operational state that the active module assigns to
its stand-by module when it is not detected by the active
module.
Provisioned State: IS or OOS
On Entry to State: No action
Table G-8. State E5b: IS-ANR
Install module None E1b
G-10 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
OPERATIONAL SERVICE STATE MODEL FOR FACILITIES

This state applies to the following entities (refer to Figure G-3, Figure G-4, and Figure G-5):
EC-1/STS-1 facility (for the STS-1 module only)
DS3 facility (for the M13 module only)
DS1/E1 facilities (for both the M13 and STS-1 modules)
The Network Facility

The DS3 facility entity (for the M13 module) and the EC-1/STS-1 facility entity (for the STS-1
module) are herein described as the network facility.
Network Facility vs. DS1/E1 Facility Behavior

All of the facility service states apply for all DS1/E1 facility entities for both the M13 and STS-
1 mux modules. The network facility for both products follows the same state behavior as
DS1/E1 facilities, but are always considered to have a traditional state of Enabled (AINS
criteria are satisfied). Therefore some service state transitions will not apply for the network
facility entity.
Special Note about the EC-1/STS-1 Facility

For the STS-1 module, the EC-1 interface can never carry anything other than an STS-1 path
payload. For that reason, and also for simplicity of design, a single facility entity is defined for
the network interface instead of the definition of two separate entities for an EC-1 facility and
an STS-1 path entity.
61186003L1-35D G-11
No Flt SA;
ED:OOS Flt NSA ED:OOS
State F7a
State F7b
F3a OOS-AU Flt SA F3b
IS-ANR
(OOS-AUMA FLT) FLT (OOS-MA FLT)
Supporting
Supporting All Flt All Flt
Entity
Entity Outage Recovered Recovered
Outage
Flt SA No Flt SA;

Flt NSA
State F6
Supporting State F5
OOS-AU
Entity Outage IS-ACT
SGEO
Supporting
Entity Restored
and...
ED:OOS Flt SA ED:OOS
F7a F2
(OOS-AU FLT) (OOS-MA)

Supporting Entity
Suppresses Alarms No Flt SA;
Flt NSA
F8 F7b
(OOS-AUMA SGEO) (IS-ANR)

All Flt
Recovered
F5
(IS-ACT)
Figure G-3. Facility Service States, Provisioned Service State = IS
G-12 61186003L1-35D
No Flt SA;
Flt NSA
ED:IS
State F3a State F3b ED:IS
F7a OOS-AUMA OOS-MA F7b
(OOS-AU FLT) FLT FLT (IS-ANR)
Flt SA
Supporting All Flt
Supporting All Flt
Entity Recovered
Entity Outage Recovered
Outage
Flt SA No Flt SA;

Flt NSA
State F8
Supporting State F2
OOS-AUMA
Entity Outage OOS-MA
SGEO
Facility is Provisioned IS and Facility is Provisioned OOS and ED:IS

Supporting Entity Allows Alarms Supporting Entity Restored and...
and... and...
AINS Criteria AINS Criteria
Not Satisfied Flt SA Not Satisfied
F4 F3a F4
(OOS-AU FLT, AINS) (OOS-AUMA FLT) (OOS-AU FLT, AINS)

AINS Criteria No Flt SA; AINS Criteria
Satisfied Flt NSA Satisfied
F6 F3b F5
(OOS-AU SGEO) (OOS-MA FLT) (IS-ACT)

All Flt
Recovered
F2
(OOS-MA)
Figure G-4. Facility Service States, Provisioned Service State = OOS
61186003L1-35D G-13
State F1a
OOS-AUMA
UAS
Unavailable Available
Supporting Entity
Suppresses Alarms
F8
(OOS-AUMA SGEO)
From F1b Only: No Supporting
ENT:IS or ENT:OOS State F1b Enabled or Auto-enabled Entity Outage
Results in Changing OOS-MA F5
Tradtional State to
UAS (IS-ACT)
Enabled
Supporting Entity
Outage
F6
(OOS-AU SGEO)
AINS Criteria
Satisfied,
Disabled and...
Any Facility that is Facility is Provisioned IS and
Unavailable is Change of AINS Criteria is NOT Satisfied
State F4
Considered to be Facility Traditional OOS-AUED:IS
Disabled State FLT, AINS
and...
ED: OOS
and...
Supporting Entity
Outage
F8
(OOS-AUMA SGEO)
No Supporting
DLT (Sets to Disabled) Entity Outage
F2
(OOS-MA)
Any State
Figure G-5. Other Facility Service States, Traditional State
G-14 61186003L1-35D
Change of Facility Traditional State

Description: The following transitions apply whenever the Traditional State
of the facility is changed. Below is a description of how each
change should be handled.
Table G-9. Change of Facility Traditional State
Provisioned IS and AINS criteria NOT None F4

satisfied
Disabled None F1b
NOTE
The traditional states of the DS3 or EC-1/STS-1 facilities are con-
sidered to always be Enabled (AINS criteria satisfied).
NOTE
Note: For DS3 and EC-1/STS-1 facilities, a TL1 DENY:SNVS
response is returned due to a DLT command. The DLT command is
valid only for DS1/E1 facilities.
State F1a: OOS-AUMA UAS

Description: This facility is not available and does not pass data.
Table G-10. State F1a: OOS-AUMA UAS
Facility becomes available None F1b
ENT TL1 DENY:SNVS ---
DLT Set Traditional State to ---

Disabled
EDIT:IS TL1 DENY:SNVS ---
EDIT:OOS TL1 DENY:SNVS ---
61186003L1-35D G-15
State F1b: OOS-MA UAS

Description: This facility is available but its Traditional State is disabled. The
facility does not pass data.
Table G-11. State F1b: OOS-MA UAS
Facility becomes unavailable None F1a
DLT None ---
Enabled None F4
Auto-enabled None F4
Disabled None ---
G-16 61186003L1-35D
State F2: OOS-MA

Description: The facility has been manually provisioned out of service and no
fault conditions are present for the entity.
Table G-12. State F2: OOS-MA
DLT Set Traditional State to F1b

Disabled
EDIT:IS If AINS criteria not satis- F4

fied
Else If Enabled F5
Else ---
EDIT:OOS None ---
Supporting Entity Outage None F8
Fault SA None F3a
No Fault SA; Fault NSA None F3b
61186003L1-35D G-17
State F3a: OOS-AUMA FLT

Description: The facility is provisioned OOS and at least one service affecting
fault condition for this facility is present.
Table G-13. State F3a: OOS-AUMA FLT

Disabled
EDIT:IS None F7a
EDIT:OOS None ---
Fault SA None ---
All faults clear None F2
G-18 61186003L1-35D
State F3b: OOS-MA FLT

Description: The facility is provisioned OOS and at least one non-service
affecting and zero service affecting fault conditions for this
facility is present.
Table G-14. State F3b: OOS-MA FLT

Disabled
EDIT:IS None F7b
EDIT:OOS None ---
Fault SA None F3a
No Fault SA; Fault NSA None ---
61186003L1-35D G-19
State F4: OOS-AU FLT, AINS

Description: AINS criteria are not satisfied.
On Entry to State: Suppress alarms and reset the AINS timer for this entity.
Monitor conditions per AINS criteria.
Table G-15. State F3b: OOS-MA FLT

Disabled
EDIT:IS None ---
EDIT:OOS If SGEO Present F8
Else F2
Supporting Entity Suppresses Alarms None F8
AINS Criteria Satisfied If SGEO Present F6
Else F5
G-20 61186003L1-35D
State F5: IS-ACT

Description: The facility is provisioned IS and no fault conditions are present
for this facility.
Table G-16. State F5: IS-ACT

Disabled
EDIT:IS None ---
EDIT:OOS None F2
Fault SA None F7a
61186003L1-35D G-21
State F6: OOS-AU SGEO

Description: The facility's supporting entity is in an outage.
Table G-17. State F6: OOS-AU SGEO

Disabled
EDIT:IS None ---
EDIT:OOS None F8
Supporting Entity Suppresses Alarms None F8
Supporting Entity Restored from Outage If Fault SA F7a

Condition
Else if Fault NSA F7b
Else F5
Supporting Entity Outage None ---
G-22 61186003L1-35D
State F7a: OOS-AU FLT

Description: The facility is provisioned IS and at least one service affecting
fault condition for this facility is present.
Table G-18. State F7a: OOS-AU FLT

Disabled
EDIT:IS None ---
EDIT:OOS None F3a
Fault SA None ---
61186003L1-35D G-23
State F7b: IS-ANR

Description: The facility is provisioned IS and at least one non-service affect-
ing and zero service affecting fault conditions for this facility are
present.
Table G-19. State F7a: OOS-AU FLT

Disabled
EDIT:IS None ---
EDIT:OOS None F3b
Fault SA None F7a
G-24 61186003L1-35D
State F8: OOS-AUMA SGEO

Description: 1. The facility is provisioned OOS and the supporting entity is in
an outage.
or
2. The facility is provisioned IS and its supporting entity
suppresses alarms.
Table G-20. State OOS-AUMA SGEO

Disabled
Entity is provisioned IS and supporting If AINS Criteria NOT F4

entity allows alarms Satisfied
Else if Enabled F6
Else ---
Entity is provisioned OOS and If Fault SA F3a

Supporting Entity Restored from Outage
Condition Else If Fault NSA F3b
Else F2
61186003L1-35D G-25
OPERATIONAL SERVICE STATE MODEL FOR VT PATHS

This state applies to the following entities (refer to Figure G-6, Figure G-7, and Figure G-8):
VT1.5/VT2 entities (for the STS-1 module only)
Operation in T1 mode
When the product is provisioned for T1 mode, all seven VT groups in the STS-1 path are
configured to each carry four VT1.5 paths. All 28 VT path entities are available and all 28
DS1/E1 facility entities are available. Any available VT1.5 path can be uniquely cross-
connected to any available DS1/E1 facility.
Operation in E1 mode
When the product is provisioned for E1 mode, all seven VT groups in the STS-1 path are
configured to each carry three VT2 paths. VT path entities 1-21 are available and DS1/E1
facility entities 1-21 are available. Any available VT2 path can be uniquely cross-connected to
any available DS1/E1 facility. VT path entities 22-28 and DS1/E1 facility entities 22-28 are
not available for use.
No Flt SA;
ED:OOS Flt NSA ED:OOS
State P7a
State P7b
P3a OOS-AU P3b
IS-ANR
(OOS-AUMA FLT) FLT (OOS-MA FLT)
Flt SA
Supporting All Flt Supporting All Flt
Entity Outage Recovered Entity Recovered
Outage
Flt SA No Flt SA;

Flt NSA
State P6
Supporting State P5
OOS-AU
Entity Outage IS-ACT
SGEO
Supporting
Entity Restored
and...
ED:OOS Flt SA ED:OOS
P7a P2
(OOS-AU FLT) (OOS-MA)

Supporting Entity
Suppresses Alarms No Flt SA;
Flt NSA
P8 P7b
(OOS-AUMA SGEO) (IS-ANR)

All Flt
Recovered
P5
(IS-ACT)
Figure G-6. VT Service States, Provisioned Service State = IS
G-26 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for VT Paths
No Flt SA;
Flt NSA
ED:IS
State P3a State P3b ED:IS
P7a OOS-AUMA OOS-MA P7b
(OOS-AU FLT) FLT FLT (IS-ANR)
Flt SA
Supporting All Flt
Supporting All Flt
Entity Recovered
Entity Outage Recovered
Outage
Flt SA No Flt SA;

Flt NSA
State P8
Supporting State P2
OOS-AUMA
Entity Outage OOS-MA
SGEO
ED:IS and ED:OOS and Supporting ED:IS

Supporting Entity Entity Restored
Allows Alarms and...
Flt SA
P3a
(OOS-AUMA FLT)
No Flt SA;
Flt NSA
P6 P3b P5
(OOS-AU SGEO) (OOS-MA FLT) (IS-ACT)

All Flt
Recovered
P2
(OOS-MA)
Figure G-7. VT Service States, Provisioned Service State = OOS
State P1a
OOS-AUMA
UAS
Any VT that is
Unavailable Available
Unavailable is
Considered to be
Unequipped
Unequipped
State P4 Equipped
Any State
OOS-MA
(except P1a)
SDEA
Equipped and Attached DS1/E1 is

Attached DS1/E1 is Disabled State P1b Enabled or Auto-enabled
OOS-MA P2
UAS
(OOS-MA)
Figure G-8. Other VT Service States
61186003L1-35D G-27
Effects of the Traditional State for an Attached DS1/E1 Facility

The transitions shown in Table G-21 apply whenever the traditional state of the port is
changed. Below is a description of how each change should be handled.
Table G-21. Transition Conditions
Current Condition Action or Condition Next State
VT is equipped and the attached DS1/E1 VT is provisioned IS P1b

facility is Disabled
VT is provisioned OOS P1b
VT is equipped and AINS conditions are VT is provisioned IS P5

not satisfied for the attached DS1/E1
facility VT is provisioned OOS P2
A VT entity's provisioned service state does not change when it is either unequipped or is
equipped but the traditional state of its attached DS1/E1 is Disabled. The operational state of
the VT will, however, reflect the fact that the VT is managed OOS. Control of setting an entity's
provisioned service state is always left to the user.
When a DS1/E1 facility is unmapped from a VT, its traditional state is automatically set to
Disabled.
When the DS1/E1 facility is remapped to a VT, its traditional state is automatically set to
Auto-enabled (and so its AINS timer is reset). The operational service states for VT and DS1/
E1 facilities will then transition appropriately.
Whenever the traditional state of a DS1/E1 facility is Disabled and is mapped to a VT, the
operational service state of the VT transitions to P1b (OOS-MA, UAS) regardless of the VT
path's provisioned service state. The reasoning behind this behavior is that manually
disabling a DS1/E1 facility is a form of explicitly managing the entire channel (VT path and
DS1/E1) out of service. Therefore, it is considered appropriate to transition the VT to a state
that indicates that the VT is managed out of service (even if the provisioned service state is in-
service).
G-28 61186003L1-35D
State P1a: OOS-AUMA UAS

Description: This VT is not available, and therefore is not cross-connected to
a DS1/E1 facility. The VT does not pass data.
On Entry to State: Suppress alarms for this VT.
Table G-22. State P1a: OOS-AUMA UAS
VT becomes available None P4
DLT TL1 DENY:SNVS ---
ENT-CRS TL1 DENY:SNVS ---
61186003L1-35D G-29
State P1b: OOS-MA UAS

Description: This VT is available but is cross-connected to a DS1/E1 facility
whose traditional state is Disabled. The VT does not pass data.
Table G-23. State P1b: OOS-MA UAS
VT becomes unequipped None P4
VT is equipped with a DS1/E1 facility None P2

whose traditional state is not Disabled.
VT is equipped with a DS1/E1 facility None ---

whose traditional state is Disabled.
ENT-CRS TL1 DENY:SNVS ---
G-30 61186003L1-35D
State P2: OOS-MA

Description: This VT is available and cross-connected to a DS1/E1 facility.
The VT has been manually provisioned out of service and no
fault conditions are present for the VT.
Table G-24. State P2: OOS-MA
EDIT:IS None P5
EDIT:OOS None ---
Supporting Entity Outage None P8
Fault SA None P3a
No Fault SA; Fault NSA None P3b
61186003L1-35D G-31
State P3a: OOS-AUMA FLT

The VT is provisioned OOS and at least one service affecting
fault condition for this VT is present.
Table G-25. State P3a: OOS-AUMA FLT
EDIT:IS None P7a
EDIT:OOS None ---
Fault SA None ---
All faults clear None P2
G-32 61186003L1-35D
State P3b: OOS-MA FLT

The VT is provisioned OOS and at least one non-service affect-
ing and no service affecting fault conditions for this VT is
present.
Table G-26. State P3b: OOS-MA FLT
EDIT:IS None P7b
EDIT:OOS None ---
Fault SA None P3a
All faults Clear None P2
61186003L1-35D G-33
State P4: OOS-MA, SDEA

Description: The VT is available but is not cross-connected to a DS1/E1
facility.
Table G-27. State P4: OOS-MA, SDEA
VT becomes unavailable None P1a
VT becomes equipped None P2
EDIT:OOS None ---
G-34 61186003L1-35D
State P5: IS-ACT

The VT is provisioned IS and no fault conditions are present for
this VT.
On Entry to State: Allow alarms for this VT.
Table G-28. State P5: IS-ACT
EDIT:IS None ---
EDIT:OOS None P2
Fault SA None P7a
61186003L1-35D G-35
State P6: OOS-AU SGEO

The VT's supporting entity is in an outage.
Table G-29. State P6: OOS-AU SGEO
EDIT:IS None ---
EDIT:OOS None P8
Supporting entity suppresses alarms None P8
Supporting Entity Restored If Fault SA P7a
Else if Fault NSA P7b
Else P5
Supporting Entity Outage None ---
G-36 61186003L1-35D
State P7a: OOS-AU FLT

The VT is provisioned IS and at least one service affecting fault
condition for this VT is present.
Table G-30. State P7a: OOS-AU FLT
EDIT:IS None ---
EDIT:OOS None P3a
Fault SA None ---
61186003L1-35D G-37
State P7b: IS-ANR

The VT is provisioned IS and at least one non-service affecting
and no service affecting fault conditions for this VT are present.
Table G-31. State P7b: IS-ANR
EDIT:IS None ---
EDIT:OOS None P3b
Fault SA None P7a
G-38 61186003L1-35D
State P8: OOS-AUMA SGEO

In addition:
1. The VT is provisioned OOS and the supporting entity is in an
outage.
or
2. The VT is provisioned IS and its supporting entity suppresses
alarms.
Table G-32. State P8: OOS-AUMA SGE
Entity is provisioned IS and supporting None P6

entity allows alarms
Entity is provisioned OOS and Support- If Fault SA P3a

ing Entity Restored
Else If Fault NSA P3b
Else P2
61186003L1-35D G-39
G-40 61186003L1-35D
Appendix H
List of Abbreviations
A
AC........................................................ Automatic Clearing
AID ...................................................... Access Identifier
AIDTYPE .............................................. Access Identifier Type
AIS ....................................................... Alarm Indication Signal
APS ...................................................... Automatic Protection Switch
B
BER ..................................................... Bit Error Rate
C
CLEI..................................................... Common Language Equipment Identifier
CLLI ..................................................... Common Language Location Identifier
CO ....................................................... Central Office
CONDTYPE .......................................... Condition Type
CTAG ................................................... Correlation Tag
D
DIRN .................................................... Direction
H
HO ....................................................... Hold Over
HRE ..................................................... HDSL Range Extender
HTU-C.................................................. HDSL Transceiver Unit - Central Office
HTU-R.................................................. HDSL Transceiver Unit - Remote
61186003L1-35D H-1
I
INC ...................................................... Incoming Failure Condition
INE....................................................... Intelligent Network Element
INHMODE ............................................ Inhibit Mode
ISD....................................................... Idle Signal
L
LOCN ................................................... Location
LOF...................................................... Loss of Frame
LOP ...................................................... Loss of Pointer
LOS...................................................... Loss of Signal
M
MONDAT .............................................. Monitor Date
MONLEV .............................................. Monitor Level
MONTM................................................ Monitor Time
MONTYPE ............................................ Monitor Type
MONVAL .............................................. Monitor Value
MTA ..................................................... Metallic Test Access
MUX..................................................... Multiplexer
N
NE........................................................ Network Element
NSA...................................................... Non-Service Affecting
NTFCNCDE .......................................... Notification Code
NUMINVL ............................................. Number Interval
NUMREPT ............................................ Number of Reports
O
OCRDAT............................................... Occurrence Date
OCRTM ................................................ Occurrence Time
OOF ..................................................... Out of Frame
OS........................................................ Operations System
OSS...................................................... Operations Support System
H-2 61186003L1-35D
P
PID....................................................... Private ID
PM ....................................................... Performance Monitoring
R
RAI....................................................... Remote Alarm Indicator
REPTDAT ............................................. Report Date
REPTINVL ............................................ Report Interval
REPTSTATM ......................................... Report Starting Time
REPTTM ............................................... Report Time
RFI ....................................................... Remote Failure Indication
rspblk .................................................. Response Block
RTU...................................................... Remote Test Unit
S
SA ........................................................ Service Affecting
SC........................................................ Switch Command
SCU ..................................................... System Controller Unit
SD........................................................ Signal Degrade
SF ........................................................ Signal Failure
SID....................................................... Source Identifier
SLM ..................................................... Signal Label Mismatch
SRVEFF ............................................... Service Effecting
STS ...................................................... Synchronous Transport Signal
T
T1-OR .................................................. T1 Office Repeater
TAP ...................................................... Test Access Path
TCP/IP ................................................. Transmission Control Protocol/Internet Protocol
TID....................................................... Target Identifier
TL1 ...................................................... Transaction Language 1
TMOFST ............................................... Time Offset
TMPER ................................................. Time Period
TSC ...................................................... Test System Controller
TYPEREP.............................................. Type Report
61186003L1-35D H-3
U
UAP...................................................... User Access Privilege
UID ...................................................... User ID
V
VLDTY.................................................. Validity
VT ........................................................ Virtual Tributary
H-4 61186003L1-35D
61186003L1-35D H-5

Carrier Networks Division

901 Explorer Blvd.
Huntsville, AL 35806

61186003L1 35D

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

61186003L1 35D

Uploaded by

Copyright:

Available Formats

MX2820 System

TL1 Reference Guide

To the Holder of the Document

901 Explorer Boulevard

2007 ADTRAN, Inc.

Revision Date Description

A November 2003 Initial release

C March 2005 Add RADIUS documentation

Intelligent Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19

Condition Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3

State F2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-17

Figure G-1. MX2820 System Service State Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-2

Table 1-1. MX2820 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Table G-10. State F1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15

TL1 Message Types

OPERATIONS SUPPORT SYSTEM

SCU CLIENT MANAGEMENT MODES OF OPERATIONS

Table 1-1. MX2820 Network Elements

Network Element Part Number

System Controller Unit 1186003Lx

DS3 MUX 1186002Lx

Clock Card 1186004Lx

STS-1 MUX 1186005Lx

Note: Refer to www.adtran.com for a complete list of products.

MX2820 SYSTEM TL1 COMMAND CROSS-REFERENCE

Table 1-2. TL1 Commands

Common (SCU) Section-Page Command Type

ACT-USER 4-2 Common

ALW-MSG 7-2 Surveillance

CANC-USER 4-4 Common

DLT-USER-SECU 6-2 Security

ED-rr 5-2 Provisioning

ED-USER-SECU 6-4 Security

ENT-USER-SECU 6-6 Security

INH-MSG 7-4 Surveillance

MENUS 4-5 Common

OPR-LPBK-rr 9-2 System Test

RLS-LPBK-rr 9-4 System Test

RTRV-rr 5-4 Provisioning

RTRV-ALM 7-6 Surveillance

RTRV-ALM-ENV 7-8 Surveillance

RTRV-COND 7-11 Surveillance

RTRV-HDR 7-13 Surveillance

RTRV-PM-rr 7-15 Surveillance

SCHED-PMREPT-rr 7-25 Surveillance

RTRV-PMSCHED-rr 7-17 Surveillance

RTRV-SYS 7-19 Surveillance

RTRV-TH-rr 5-6 Provisioning

RTRV-USER-SECU 6-8 Security

RTRV-VER 7-21 Surveillance

RTRV-VERSION 7-23 Surveillance

SET-DAT 4-6 Common

SET-TH-rr 5-8 Provisioning

SW-TOPROTN-rr 8-2 System Maintenance

SW-TOWKG-rr 8-4 System Maintenance

NOTATIONS AND CONVENTIONS

Table 2-1. TL1 Input Command General Format Descriptions

Table 2-1. TL1 Input Command General Format Descriptions (Continued)

: The colon is used as a field separator.

; The semicolon is used as a TL1 command terminator. The command termina-