Professional Documents
Culture Documents
Trademarks
Front Matter
Any brand names and product names included in this document are trademarks, registered
trademarks, or trade names of their respective holders.
ii 61186003L1-35D
Revision History
B August 2004 Add STS-1 and Clock Modules and associated commands
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
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
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
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
MENUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
SET-DAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Section 6
Security TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1
DLT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3
ED-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
61186003L1-35D vii
MX2820 System TL1 Reference Guide
Section 7
Surveillance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
ALW-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3
INH-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5
RTRV-ALM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9
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
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
RTRV-PM-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16
RTRV-PMSCHED-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18
RTRV-SYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19
61186003L1-35D ix
MX2820 System TL1 Reference Guide
Section 8
System Maintenance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
SW-TOPROTN-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2
Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3
SW-TOWKG-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
MX2820 System TL1 Reference Guide
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
Appendix H
List of Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1
61186003L1-35D xiii
MX2820 System TL1 Reference Guide
Figures
xiv 61186003L1-35D
Tables
Tables
61186003L1-35D xv
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
1-2 61186003L1-35D
Section 1, Introduction - SCU Client Management Modes of Operations
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.
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 Reference Guide
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
MX2820 System TL1 Reference Guide
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.
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
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
this document for additional information.
<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
this document for additional information.
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.
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
MX2820 System TL1 Reference Guide
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.
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.
2-4 61186003L1-35D
Section 2, TL1 Commands - Normal Response Messages
Caret (^) The Caret represents one space character in the acknowledgment or response
message.
<source identifier> The Source Identifier (SID) identifies the shelf TID.
<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 Reference Guide
RTRV-COND
RTRV-HDR
RTRV-PM-rr
RTRV-PMSCHED-rr
RTRV-SYS
RTRV-VER
RTRV-VERSION
SCHED-PMREPT-rr
2-6 61186003L1-35D
Section 2, TL1 Commands - User Account Requirements (Access Privileges)
61186003L1-35D 2-7
MX2820 System TL1 Reference Guide
2-8 61186003L1-35D
Section 3
ADTRAN AID Formats
INTRODUCTION
This section provides information about ADTRAN AID formats for the MX2820 System.
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.
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
MX2820 System TL1 Reference Guide
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.
1 to 254 T3 MUX1 to 1
MUX7
STS1
EQPT MUX1 to A or B
MUX7 A = Working Unit
B = Protect Unit
CLK
SCU N/A
ENV 1 to 5 N/A
1 to 254 T3 MUX1 to 1
MUX9
STS1
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.
AID Description
The TL1 command sections and the data dictionaries in the appendices also contain infor-
mation about the AID parameter.
61186003L1-35D 3-3
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
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).
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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>;
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
MX2820 System TL1 Reference Guide
CANC-USER
The CANC-USER (Cancel-User) command terminates a TL1 session.
Input Format
CANC-USER:[<TID>]::[<CTAG>];
Example:
CANC-USER:HTVLALEXD16::5;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
Example:
HTVLALEXD16 02-05-30 16:36:54
M 5 COMPLD
;
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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.
Input Format
MENUS:[<TID>];
Example:
MENUS:HTVLALEXD16;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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>
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.
61186003L1-35D 4-5
MX2820 System TL1 Reference Guide
SET-DAT
The SET-DAT (Set-Date) command sets the date and time for the SCU.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary 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>
M^^<CTAG>^COMPLD <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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 4-7
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
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
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
<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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
Example:
HTVLALEXD16 02-05-30 16:48:47
M 9 COMPLD
;
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 5-3
MX2820 System TL1 Reference Guide
RTRV-RR
The RTRV-rr (Retrieve-rr) command retrieves data parameters and state parameters for an NE
entity.
For the MX2820 System, the supported rr modifiers are as follows:
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.
Input Format
RTRV-rr:[<TID>]:[<AID>]:[<CTAG>][:::<specific data block>];
Example:
RTRV-EQPT:HTVLALEXD16::30:::CRAFT-BAUD;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
<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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
<rspblk> + ;
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>
^^^<error_code> <cr> <lf>
;
Refer to Appendix B, Response Messages Data Dictionary for Normal Response and Error
Response parameter descriptions.
61186003L1-35D 5-5
MX2820 System TL1 Reference Guide
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
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,
Input Commands Data Dictionary for additional information.
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 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>
^^^<rsphdr> <cr> <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.
Refer to Appendix B, Response Messages Data Dictionary for Normal Response and Error
Response parameter descriptions.
61186003L1-35D 5-7
MX2820 System TL1 Reference Guide
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
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
Dictionary for additional information.
TMPER For the TMPER parameter, refer to Appendix A, Input
Commands Data Dictionary for additional information.
5-8 61186003L1-35D
Section 5, Provisioning TL1 Commands - SET-TH-rr
Response Format
Normal Response
<cr> <lf> <lf>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>;
Example:
HTVALEXD16 03-11-22 11:35:28
M 0 COMPLD
Error Response
<cr> <lf> <lf>
^^^<rsphdr> <cr> <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.
Refer to Appendix B, Response Messages Data Dictionary for Normal Response and Error
Response parameter descriptions.
61186003L1-35D 5-9
MX2820 System TL1 Reference Guide
Read Only
SSHKEYSIZE 512 - 2048 (1024) This parameter indicates the size of current SSH
keys.
Read/Write
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.
5-10 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
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.
AUX2AID 1 - 16 (2) This parameter sets the AID index for AUX2.
AUX2LOG NORMOPEN This parameter sets the logic sense of the AUXx
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.
AUX3AAID 1 - 16 (3) This parameters sets the AID index for AUX3A.
AUX3LOG NORMOPEN This parameter sets the logic sense of the AUXx
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.
AUX3BAID 1 - 16 (3) This parameters sets the AID index for AUX3B.
Note: Defaults are in bold type.
61186003L1-35D 5-11
MX2820 System TL1 Reference Guide
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_RATE AUTO This parameter is used to set the data rate for
10HALF the Ethernet port.
10FULL
100HALF
100FULL
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
Note: Defaults are in bold type.
5-12 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
REM_LVL INFO This parameters sets the reported alarm level for
ALERT a Service Affecting card removal alarm.
MINOR
MAJOR
CRITICAL
SSHGENSIZE 512 - 2048 (1024) This parameter sets the size of SSH keys to
generate. The size must be a multiple of eight.
Write Only
Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B)
Read Only
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.
61186003L1-35D 5-13
MX2820 System TL1 Reference Guide
Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters
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.
SELFTEST 21-character string The software self-test results for the card.
Read/Write
5-14 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
DSXAUTOENABLEDELAY TWOSEC This variable sets the delay associated with any
ONEHR auto-enabled DS1/E1 interface.
TWOHRS
TWELVEHRS
ONEDAY
TWODAYS
SEVENDAYS
61186003L1-35D 5-15
MX2820 System TL1 Reference Guide
Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
5-16 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
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.
61186003L1-35D 5-17
MX2820 System TL1 Reference Guide
Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
5-18 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Read Only
FEUNITID 6-character string The far-end (remote) Unit ID Code received from
(N/A) the incoming DS3.
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.
DS3CVTHRESHOLD DISABLE This variable sets the DS3 code violation thresh-
ONEE3 old that, when exceeded, sets an associated
ONEE4 alarm.
ONEE5
ONEE6
LOOPBACK DATAMODE This variable indicates the test state of the DS3
LINE interface.
DIGITAL
FENDLINE
ALLT1
61186003L1-35D 5-19
MX2820 System TL1 Reference Guide
Read Only
5-20 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Read/Write
DSXLINELENGTH DSX0TO133 This variable sets the line length setting of the
DSX133TO266 DS1/E1 interface.
DSX266TO399
DSX399TO533
DSX533TO655
E10TO6DB
UNAVAILABLE
61186003L1-35D 5-21
MX2820 System TL1 Reference Guide
Write Only
Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B)
Read Only
APPSWVERSION 8-character string The application software version for the card.
Note: Defaults are in bold type.
5-22 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
APPSWCHECKSUM 4-character string The application software checksum for the card.
BOOTSWVERSION 8-character string The boot software version for the card.
BOOTSWCHECKSUM 4-character string The boot software checksum for the card.
SELFTEST 21-character string The software self-test results for the card.
PRODUCTNAME 12-character string The ADTRAN product name for the card.
PRODCLEICODE 11-character string The ADTRAN product CLEI code for the card.
PRODSERIALNUMBER 25-character string The ADTRAN product serial number for the card.
Read/Write
61186003L1-35D 5-23
MX2820 System TL1 Reference Guide
Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
DSXAUTOENABLE-DELAY TWOSEC This variable sets the delay associated with any
ONEHR auto-enabled DS1/E1 interface.
TWOHRS
TWELVEHRS
ONEDAY
TWODAYS
SEVENDAYS
5-24 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
61186003L1-35D 5-25
MX2820 System TL1 Reference Guide
Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
5-26 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters
AID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)
Table 5-6. STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning Parameters
AID: 1-STS1-(MUX1-MUX9)-1
Read Only
PATHTRACERX 64-character string The path trace string received from the incoming
STS-1.
Read/Write
PATHTRACETX 64-character string The path trace string transmitted from the outgo-
(ADTRAN MX2820 ing STS-1.
STS-1 MUX)
61186003L1-35D 5-27
MX2820 System TL1 Reference Guide
Table 5-6. STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning Parameters
AID: 1-STS1-(MUX1-MUX9)-1 (Continued)
LOOPBACK DATAMODE This variable indicates the test state of the EC-1/
LINE STS-1 interface.
DIGITAL
Write-Only
Read/Write
5-28 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
DSXLINELENGTH DSX0TO133 This variable sets the line length setting of the
DSX133TO266 DS1/E1 interface.
DSX266TO399
DSX399TO533
DSX533TO655
E10TO6DB
UNAVAILABLE
NOT MAPPED
Write Only
61186003L1-35D 5-29
MX2820 System TL1 Reference Guide
Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning Parameters
AID: 1-EQPT-CLK-(A or B)
Read Only
APPSWVERSION 8-character string The application software version for the card.
APPSWCHECKSUM 4-character string The application software checksum for the card.
BOOTSWVERSION 8-character string The boot software version for the card.
BOOTSWCHECKSUM 4-character string The boot software checksum for the card.
SELFTEST 21-character string The software self-test results for the card.
PRODUCTNAME 12-character string The ADTRAN product CLEI code for the card.
PRODCLEICODE 11-character string The ADTRAN product CLEI code for the card.
PRODSERIALNUMBER 25-character string The ADTRAN product serial number for the card.
Read/Write
5-30 61186003L1-35D
Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables
Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning Parameters
AID: 1-EQPT-CLK-(A or B) (Continued)
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.
61186003L1-35D 5-31
MX2820 System TL1 Reference Guide
Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning Parameters
AID: 1-EQPT-CLK-(A or B) (Continued)
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
MX2820 System TL1 Reference Guide
DLT-USER-SECU
The DLT-USER-SECU (Delete-User-Security) command allows an administrator to delete the
security parameters associated with a user account.
Input Format
DLT-USER-SECU:[<TID>]:<UID>:[<CTAG>];
Example:
DLT-USER-SECU:HTVLALEXD16:USER1:8;
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 takes the place of the AID for this TL1 command format.
Refer to Appendix A, Input Commands Data Dictionary for
additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 8
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 6-3
MX2820 System TL1 Reference Guide
ED-USER-SECU
The ED-USER-SECU (Edit-User-Security) command allows an administrator to edit security
parameters associated with a user account.
Input Format
ED-USER-SECU:[<TID>]:<UID>:[<CTAG>]::,[<NEW PID>],,[<NEW UAP>]:;
Example:
ED-USER-SECU:HTVLALEXD16:USER1:10::,PASSWORD2,,4:;
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 takes the place of the AID for this TL1 command format.
Refer to Appendix A, Input Commands Data Dictionary for
additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
NEW PID For the new PID, refer to Appendix A, Input Commands Data
Dictionary for additional information.
NEW UAP For the new User Access Privilege (UAP), refer to Appendix A,
Input Commands Data Dictionary for additional information.
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
Example:
HTVLALEXD16 02-06-04 15:53:41
M 10 COMPLD
;
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^<CTAG>^DENY <cr> <lf>
^^^<error_code>
;
Refer to Appendix B, Response Messages Data Dictionary for Normal Response and Error
Response parameter descriptions.
61186003L1-35D 6-5
MX2820 System TL1 Reference Guide
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.
Input Format
ENT-USER-SECU:[<TID>]:<UID>:[<CTAG>]::<PID>,,<UAP>:;
Example:
ENT-USER-SECU:HTVLALEXD16:USER1:12::PASSWORD1,,3:;
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 takes the place of the AID for this TL1 command format.
Refer to Appendix A, Input Commands Data Dictionary for
additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
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
Dictionary for additional information.
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
Example:
HTVLALEXD16 02-06-04 15:37:00
M 12 COMPLD
;
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 6-7
MX2820 System TL1 Reference Guide
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.
Input Format
RTRV-USER-SECU:[<TID>]::[<CTAG>];
Example:
RTRV-USER-SECU:HTVLALEXD16::27;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 27
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> >lf>
M^^<CTAG>^COMPLD <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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 6-9
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
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.
Input Format
ALW-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],;
Example:
ALW-MSG-EQPT:HTVLALEXD16::2::MJ,;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
NTFCNCDE For the Notification Code (NTFCNCDE), refer to Appendix A,
Input Commands Data Dictionary for additional information.
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <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>
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.
61186003L1-35D 7-3
MX2820 System TL1 Reference Guide
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.
This command has the following format for the command verb:
INH-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 inhibited.
To resume the sending of autonomous messages, refer the ALW-MSG commands in this
section.
Input Format
INH-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],;
Example:
INH-MSG-EQPT:HTVLALEXD16::13::MJ,;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
NTFCNCDE For the NTFCNCDE, refer to Appendix A, Input Commands
Data Dictionary for additional information.
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
Example:
HTVLALEXD16 02-05-30 17:15:51
M 13 COMPLD
;
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 7-5
MX2820 System TL1 Reference Guide
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}
The valid values for rr as the second modifier are as follows:
T1
T3
STS1
VT1
Environmental alarms are not expected in response to the RTRV-ALM command. The RTRV-
ALM-ENV command retrieves environmental alarms.
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
NTFCNCDE For the NTFCNCDE, refer to Appendix A, Input Commands
Data Dictionary for additional information.
CONDTYPE For the Condition Type (CONDTYPE), refer to Appendix A,
Input Commands Data Dictionary for additional information.
SRVEFF For the Service Effect (SRVEFF), refer to Appendix A, Input
Commands Data Dictionary for additional information.
7-6 61186003L1-35D
Section 7, Surveillance TL1 Commands - RTRV-ALM
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 19
<
Normal Response
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 7-7
MX2820 System TL1 Reference Guide
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)
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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
additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
NTFCNCDE For the NTFCNCDE, refer to Appendix A, Input Commands
Data Dictionary for additional information.
ALMTYPE For the Alarm Type (ALMTYPE), refer to Appendix A, Input
Commands Data Dictionary for additional information.
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
The following format applies if one or more alarms satisfy the request (+ denotes one or more):
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
<rspblk> + ;
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
MX2820 System TL1 Reference Guide
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^DENY <cr> <lf>
^^^<error_code>
;
Refer to Appendix B, Response Messages Data Dictionary for Normal Response and Error
Response parameter descriptions.
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.
This command has the following format for the command verb:
RTRV-COND-{EQPT|rr|ALL}
The valid values for rr as the second modifier are as follows:
T1
T3
STS1
VT1
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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
additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
TYPEREQ For the TYPEREQ parameter, refer to Appendix A, Input
Commands Data Dictionary for additional information.
LOCN For the LOCN, refer to Appendix A, Input Commands Data
Dictionary for additional information.
61186003L1-35D 7-11
MX2820 System TL1 Reference Guide
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
If there is at least one condition to report, the format is as follows (+ denotes one or more):
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
<rspblk> + ;
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^DENY <cr> <lf>
^^^<error_code>
;
Refer to Appendix B, Response Messages Data Dictionary for Normal Response and Error
Response parameter descriptions.
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.
Input Format
RTRV-HDR:[<TID>]::[<CTAG>];
Example:
RTRV-HDR:HTVLALEXD16::23;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 23
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
^^^/* <SW Rev.> */ <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 11:08:32
M 23 COMPLD
/*^COL^*/
;
61186003L1-35D 7-13
MX2820 System TL1 Reference Guide
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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.
The valid values for rr as the second modifier are as follows:
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.
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
MONTYPE For the MONTYPE, refer to Appendix A, Input Commands Data
Dictionary for additional information.
MONLEV For the Monitor Level (MONLEV), refer to Appendix A, Input
Commands Data Dictionary for additional information.
LOCN For the LOCN, refer to Appendix A, Input Commands Data
Dictionary for additional information.
TMPER For the TMPER, refer to Appendix A, Input Commands Data
Dictionary for additional information.
MONDAT For the Monitor Date (MONDAT), refer to Appendix A, Input
Commands Data Dictionary for additional information.
MONTM For the Monitor Time (MONTM), refer to Appendix A, Input
Commands Data Dictionary for additional information.
61186003L1-35D 7-15
MX2820 System TL1 Reference Guide
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>
M^^<CTAG>^COMPLD <cr> <lf>
;
If the NE has one or more PM values to report, the following format applies (+ denotes one or
more):
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
<rspblk> + ;
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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}
The valid values for rr as the second modifier are as follows:
T1
T3
STS1
VT1
Input Format
RTRV-PMSCHED-{rr|ALL}:[<TID>]:[<AID>]:[<CTAG>];
Example:
RTRV-PMSCHED-T3:HTVLALEXD16:1-T3-MUX3-1:25;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 25
<
61186003L1-35D 7-17
MX2820 System TL1 Reference Guide
Normal Response
If a schedule does not exist, the following format applies:
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
If there is at least one schedule to report, the following format applies (+ denotes one or more):
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
<rspblk> + ;
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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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.
Input Format
RTRV-SYS:[<TID>]::[<CTAG>];
Example:
RTRV-SYS:HTVLALEXD16::26;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 26
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <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
MX2820 System TL1 Reference Guide
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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.
Input Format
RTRV-VER:[<TID>]::[<CTAG>];
Example:
RTRV-VER:HTVLALEXD16::28;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 28
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
^^^"<SW Rev.>" <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 15:52:08
M 28 COMPLD
"::VERSION=C01"
;
61186003L1-35D 7-21
MX2820 System TL1 Reference Guide
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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.
Input Format
RTRV-VER:[<TID>]::[<CTAG>];
Example:
RTRV-VER:HTVLALEXD16::28;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 28
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
^^^"<SW Rev.>" <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 15:52:08
M 28 COMPLD
"::VERSION=C01"
;
61186003L1-35D 7-23
MX2820 System TL1 Reference Guide
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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.
The valid values for rr as the second modifier are as follows:
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.
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
AID The AID identifies the entity within the NE from which data is
being retrieved. Refer to Section 3, ADTRAN AID Formats, for
additional information.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
REPTINVL For the Report Interval (REPTINVL), refer to Appendix A, Input
Commands Data Dictionary for additional information.
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,
Input Commands Data Dictionary for additional information.
MONTYPE For the MONTYPE, refer to Appendix A, Input Commands Data
Dictionary for additional information.
61186003L1-35D 7-25
MX2820 System TL1 Reference Guide
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 31
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <lf>
;
Example:
HTVLALEXD16 02-05-31 17:04:08
M 31 COMPLD
;
Error Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
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
MX2820 System TL1 Reference Guide
SW-TOPROTN-rr
The SW-TOPROTN-rr (Switch-To Protection-rr) command instructs an NE to perform a
protection switch.
Input Format
SW-TOPROTN-EQPT:[<TID>]:<AID>:[<CTAG>]::,;
Example:
SW-TOPROTN-EQPT:HTVLALEXD16:1-EQPT-MUX3-A::,;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 33
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 8-3
MX2820 System TL1 Reference Guide
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.
Input Format
SW-TOWKG-EQPT:[<TID>]:<AID>:[<CTAG>]::;
Example:
SW-TOWKG-EQPT:HTVLALEXD16:1-EQPT-MUX3-B:34::;
Input Parameters
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
Response Format
Acknowledgment
IP^<CTAG> <cr> <lf>
<
Example:
IP 34
<
Normal Response
<cr> <lf> <lf>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>
M^^<CTAG>^COMPLD <cr> <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>
^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <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.
61186003L1-35D 8-5
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
LPBKTYPE For the Loopback Type (LPBKTYPE), refer to Appendix A, Input
Commands Data Dictionary for additional information.
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>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <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>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^DENY <cr> <lf>
^^^<errcde> <cr> <lf>
(^^^"<error description>" <cr> <lf>) *
(^^^/*error text*/ <cr> <lf>) * ;
Refer to Appendix A, Input Commands Data Dictionary for input parameter descriptions.
Refer to Appendix B, Response Messages Data Dictionary for normal response and error
response parameter descriptions.
61186003L1-35D 9-3
MX2820 System TL1 Reference Guide
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
TID The TID identifies the target NE for the command. Refer to the
TID on page 2-3 for additional information.
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.
CTAG For the CTAG, refer to Appendix A, Input Commands Data
Dictionary for additional information.
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>
^^^<rsphdr> <cr> <lf>
M^^<ctag>^COMPLD <cr> <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>
^^^<rsphdr> <cr> <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.
Refer to Appendix B, Response Messages Data Dictionary for normal response and error
response parameter descriptions.
61186003L1-35D 9-5
MX2820 System TL1 Reference Guide
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.
Parameter Description
AID Access Identifier. Refer to the Section 3, ADTRAN AID Formats for
information.
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.
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
MX2820 System TL1 Reference Guide
Parameter Description
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.
A-2 61186003L1-35D
Appendix A, Input Commands Data Dictionary - Introduction
Parameter Description
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
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:
HOD indicates hour of day and ranges from 00 to 23
MOH indicates minutes of hour and ranges from 00 to 59
61186003L1-35D A-3
MX2820 System TL1 Reference Guide
Parameter Description
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.
Values are as follows:
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.
Values are as follows:
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
Parameter Description
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
MX2820 System TL1 Reference Guide
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.
Parameter Description
+ 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.
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.
61186003L1-35D B-1
MX2820 System TL1 Reference Guide
Parameter Description
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.
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.
Values are as follows:
NEND
FEND
B-2 61186003L1-35D
Appendix B, Response Messages Data Dictionary - Introduction
Parameter Description
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.
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.
HOD indicates hour of day and ranges from 00 to 23
MOH indicates minutes of hour and ranges from 00 to 59
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
MX2820 System TL1 Reference Guide
Parameter Description
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
REPTTM The Report Time parameter specifies the time of day for the next PM
report.
The REPTTM format is HOD-MOH.
HOD indicates hour of day and ranges from 00 to 23
MOH indicates minutes of hour and ranges from 00 to 59
<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
Parameter Description
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.
Values are as follows:
15-MIN (quarterly hourly)
1-DAY
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.
Valid values are as follows:
READONLY : 1
READWRITE : 2
TEST : 3
ADMIN : 4
61186003L1-35D B-5
MX2820 System TL1 Reference Guide
Parameter Description
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.
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.
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
MX2820 System TL1 Reference Guide
RNAU Resource This error code indicates the requested NE access address is
unassigned.
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.
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.
61186003L1-35D D-1
MX2820 System TL1 Reference Guide
D-2 61186003L1-35D
Appendix D, Alarms and Alarm Condition Codes - M13 MUX Card Alarms
61186003L1-35D D-3
MX2820 System TL1 Reference Guide
D-4 61186003L1-35D
Appendix D, Alarms and Alarm Condition Codes - STS-1 MUX Card Alarms
61186003L1-35D D-5
MX2820 System TL1 Reference Guide
D-6 61186003L1-35D
Appendix D, Alarms and Alarm Condition Codes - MX2820 Clock Card Alarms
61186003L1-35D D-7
MX2820 System TL1 Reference Guide
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>
Parameter Description
<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
MX2820 System TL1 Reference Guide
Parameter Description
<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.
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.
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
MX2820 System TL1 Reference Guide
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.
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.
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
MX2820 System TL1 Reference Guide
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
LOSS-L
ESP-P
SESP-P
SAS-P
UASP-P
UASCP-P
CVL
CVP-P
ESL
CVCP-P
ESCP-P
SESCP-P
SESCP-PFE
CVCP-PFE
UASCP-PFE
61186003L1-35D F-1
MX2820 System TL1 Reference Guide
T1 Performance Monitoring rr = T1
ESL
SESL
LOSS-L
AISS-P
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
ESS
SESS
SEFS-S
CVL
ESL
SESL
UASL
CVP
ESP
SESP
UASP
PPJC-PDET
NPJC-PDET
ES-LFE
SES-LFE
UAS-LFE
CV-PFE
ES-PFE
SES-PFE
UAS-PFE
61186003L1-35D F-3
MX2820 System TL1 Reference Guide
ES-V
SES-V
UAS-V
ES-VFE
SES-VFE
UAS-VFE
T1 Performance Monitoring rr = T1
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.
61186003L1-35D G-1
MX2820 System TL1 Reference Guide
EQUIPMENT
EQUIPMENT Parent
EQUIPMENT Parent
VT VT VT Child Parent
PATH #1 PATH #2 PATH #28
CROSS-CONNECT
G-2 61186003L1-35D
Appendix G, MX2820 Service States - Introduction
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
MX2820 System TL1 Reference Guide
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.
G-4 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Equipment
ED:IS
State E6 State E3
OOS-AUMA OOS-MA
UAS, UEQ
Flt SA
No Flt SA;
Flt NSA
ED:OOS ED:OOS
61186003L1-35D G-5
MX2820 System TL1 Reference Guide
EDIT:OOS None E3
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
Appendix G, MX2820 Service States - Operational Service State Model for Equipment
EDIT:OOS None E3
61186003L1-35D G-7
MX2820 System TL1 Reference Guide
Fault SA None
G-8 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Equipment
EDIT:IS None
Fault SA None
EDIT:IS None
61186003L1-35D G-9
MX2820 System TL1 Reference Guide
G-10 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
61186003L1-35D G-11
MX2820 System TL1 Reference Guide
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
State F6
Supporting State F5
OOS-AU
Entity Outage IS-ACT
SGEO
Supporting
Entity Restored
and...
ED:OOS Flt SA ED:OOS
F7a F2
(IS-ACT)
G-12 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
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
State F8
Supporting State F2
OOS-AUMA
Entity Outage OOS-MA
SGEO
(OOS-MA)
61186003L1-35D G-13
MX2820 System TL1 Reference Guide
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
G-14 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
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.
61186003L1-35D G-15
MX2820 System TL1 Reference Guide
Enabled None F4
Auto-enabled None F4
G-16 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
Else If Enabled F5
Else ---
61186003L1-35D G-17
MX2820 System TL1 Reference Guide
G-18 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
61186003L1-35D G-19
MX2820 System TL1 Reference Guide
Else F2
Else F5
G-20 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
EDIT:OOS None F2
61186003L1-35D G-21
MX2820 System TL1 Reference Guide
EDIT:OOS None F8
Else F5
G-22 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
61186003L1-35D G-23
MX2820 System TL1 Reference Guide
G-24 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for Facilities
Else if Enabled F6
Else ---
Else F2
61186003L1-35D G-25
MX2820 System TL1 Reference Guide
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
State P6
Supporting State P5
OOS-AU
Entity Outage IS-ACT
SGEO
Supporting
Entity Restored
and...
ED:OOS Flt SA ED:OOS
P7a P2
(IS-ACT)
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
State P8
Supporting State P2
OOS-AUMA
Entity Outage OOS-MA
SGEO
Flt SA
P3a
(OOS-AUMA FLT)
No Flt SA;
Flt NSA
P6 P3b P5
(OOS-MA)
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
61186003L1-35D G-27
MX2820 System TL1 Reference Guide
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
Appendix G, MX2820 Service States - Operational Service State Model for VT Paths
61186003L1-35D G-29
MX2820 System TL1 Reference Guide
G-30 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for VT Paths
EDIT:IS None P5
61186003L1-35D G-31
MX2820 System TL1 Reference Guide
G-32 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for VT Paths
61186003L1-35D G-33
MX2820 System TL1 Reference Guide
G-34 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for VT Paths
EDIT:OOS None P2
61186003L1-35D G-35
MX2820 System TL1 Reference Guide
EDIT:OOS None P8
Else P5
G-36 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for VT Paths
61186003L1-35D G-37
MX2820 System TL1 Reference Guide
G-38 61186003L1-35D
Appendix G, MX2820 Service States - Operational Service State Model for VT Paths
Else P2
61186003L1-35D G-39
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
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
MX2820 System TL1 Reference Guide
U
UAP...................................................... User Access Privilege
UID ...................................................... User ID
V
VLDTY.................................................. Validity
VT ........................................................ Virtual Tributary
H-4 61186003L1-35D
This page is intentionally blank.
61186003L1-35D H-5