MX2820 System TL1 Reference Guide
Transcription
MX2820 System TL1 Reference Guide
® MX2820 System TL1 Reference Guide Document Number: 61186003L1-35D October 2007 MX2820 System TL1 Reference Guide Trademarks Front Matter Any brand names and product names included in this document are trademarks, registered trademarks, or trade names of their respective holders. To the Holder of the Document The contents of this document are current as of the date of publication. ADTRAN® reserves the right to change the contents without prior notice. In no event will ADTRAN be liable for any special, incidental, or consequential damages or for commercial losses even if ADTRAN has been advised thereof as a result of issue of this publication. ® 901 Explorer Boulevard P.O. Box 140000 Huntsville, AL 35814-4000 (256) 963-8000 ©2007 ADTRAN, Inc. All Rights Reserved. ii 61186003L1-35D Revision History Revision Date Description A November 2003 B August 2004 Add STS-1 and Clock Modules and associated commands C March 2005 Add RADIUS documentation D October 2007 Initial release 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TL1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transport Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TL1 Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TL1 Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Operations Support System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SCU Client Management Modes of Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MX2820 System TL1 Command Cross-Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 1-1 1-1 1-1 1-2 1-2 1-3 1-3 1-3 1-4 Section 2 TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notations and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SCU Client Management Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . INE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Expansion Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Language Location Identifier (CLLI) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MX2820 System TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ADTRAN TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Account Requirements (Access Privileges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 2-1 2-2 2-2 2-3 2-3 2-3 2-4 2-4 2-4 2-4 2-5 2-6 2-6 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 Intelligent Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 Expansion Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1 AID Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 Section 4 Common (SCU) TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ACT-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RADIUS Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Challenge response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CANC-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MENUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SET-DAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1 4-2 4-2 4-2 4-2 4-2 4-2 4-2 4-3 4-3 4-3 4-3 4-4 4-4 4-4 4-4 4-4 4-4 4-4 4-4 4-5 4-5 4-5 4-5 4-5 4-5 4-5 4-5 4-6 4-6 4-6 4-6 4-6 4-6 4-6 4-7 Section 5 Provisioning TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1 ED-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 vi 61186003L1-35D Contents Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2 Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3 RTRV-rr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4 Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5 RTRV-TH-rr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6 Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6 Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6 Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7 SET-TH-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8 Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8 Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8 Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9 Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9 Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9 Transmission Entity Data Parameter Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10 Section 6 Security TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DLT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ED-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61186003L1-35D 6-1 6-2 6-2 6-2 6-2 6-2 6-2 6-2 6-3 6-4 6-4 6-4 6-4 6-4 6-4 6-5 vii MX2820 System TL1 Reference Guide Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ENT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5 6-6 6-6 6-6 6-6 6-6 6-6 6-7 6-7 6-8 6-8 6-8 6-8 6-8 6-8 6-8 6-9 Section 7 Surveillance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ALW-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . INH-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV-ALM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Format for no Alarm Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Format for Alarm Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii 7-1 7-2 7-2 7-2 7-2 7-3 7-3 7-3 7-3 7-4 7-4 7-4 7-4 7-5 7-5 7-5 7-5 7-6 7-6 7-6 7-6 7-7 7-7 7-7 7-7 7-7 7-7 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 Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV-VER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RTRV-VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SCHED-PMREPT-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19 7-20 7-21 7-21 7-21 7-21 7-21 7-21 7-21 7-22 7-23 7-23 7-23 7-23 7-23 7-23 7-23 7-24 7-25 7-25 7-25 7-25 7-26 7-26 7-26 7-26 Section 8 System Maintenance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SW-TOPROTN-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SW-TOWKG-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x 8-1 8-2 8-2 8-2 8-2 8-2 8-2 8-2 8-3 8-4 8-4 8-4 8-4 8-4 8-4 8-4 8-5 61186003L1-35D Contents Section 9 System Test TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . OPR-LPBK-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RLS-LPBK-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Input Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1 9-2 9-2 9-2 9-2 9-2 9-2 9-3 9-4 9-4 9-4 9-4 9-4 9-4 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SCU Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M13 MUX Card Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . STS-1 MUX Card Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MX2820 Clock Card Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1 D-1 D-3 D-5 D-7 Appendix E Autonomous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Performance Monitoring Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61186003L1-35D E-1 E-1 E-2 E-3 E-3 E-3 xi MX2820 System TL1 Reference Guide Condition Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Autonomous Message Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M13 MUX Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Response from Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Corresponding Clears. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Threshold Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Response from Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . M13 MUX Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Environmental Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Response from Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-3 E-4 E-4 E-4 E-4 E-4 E-5 E-5 E-5 E-5 E-5 E-5 Appendix F Performance Monitoring Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1 M13 Mux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1 STS-1 MUX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-3 Appendix G MX2820 Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1 Limitations of Diagrams. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1 Event Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1 Criteria Monitored for an Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1 Definition of AINS Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3 Definitions of Available and Unavailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3 Recursive alarm suppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3 Traditional States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3 Backward Compatibility with Traditional States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-4 Operational Service State Model for Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5 Independent Equipment Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5 Indication of the Active Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5 State E1a: IS ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-6 State E1b: IS STDBYH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7 State E3: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7 State E4a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8 State E4b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8 State E5a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9 State E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9 State E6: OOS-AUMA UAS, UEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-10 Operational Service State Model for Facilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11 The Network Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11 Network Facility vs. DS1/E1 Facility Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11 Special Note about the EC-1/STS-1 Facility. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11 Change of Facility Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15 State F1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15 State F1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-16 xii 61186003L1-35D Contents State F2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F4: OOS-AU FLT, AINS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F8: OOS-AUMA SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Operational Service State Model for VT Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Operation in T1 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Operation in E1 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Effects of the Traditional State for an Attached DS1/E1 Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P4: OOS-MA, SDEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P8: OOS-AUMA SGEO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-17 G-18 G-19 G-20 G-21 G-22 G-23 G-24 G-25 G-26 G-26 G-26 G-28 G-29 G-30 G-31 G-32 G-33 G-34 G-35 G-36 G-37 G-38 G-39 Appendix H List of Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1 61186003L1-35D xiii MX2820 System TL1 Reference Guide Figures Figure G-1. Figure G-2. Figure G-3. Figure G-4. Figure G-5. Figure G-6. Figure G-7. Figure G-8. xiv MX2820 System Service State Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-2 Equipment Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5 Facility Service States, Provisioned Service State = IS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-12 Facility Service States, Provisioned Service State = OOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-13 Other Facility Service States, Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-14 VT Service States, Provisioned Service State = IS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-26 VT Service States, Provisioned Service State = OOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-27 Other VT Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-27 61186003L1-35D Tables Tables Table 1-1. Table 1-2. Table 2-1. Table 2-2. Table 2-3. Table 3-1. Table 3-2. Table 3-3. Table 5-1. Table 5-2. Table 5-3. Table 5-4. Table 5-5. Table 5-6. Table 5-7. Table 5-8. Table 5-9. Table 7-1. Table A-1. Table B-1. Table C-1. Table D-1. Table D-2. Table D-3. Table D-4. Table E-1. Table F-1. Table F-2. Table G-1. Table G-2. Table G-3. Table G-4. Table G-5. Table G-6. Table G-7. Table G-8. Table G-9. MX2820 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 TL1 Input Command General Format Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 TL1 Response Message Format Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5 MX2820 TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6 19-Inch Chassis AID Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 23-Inch Chassis AID Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2 MX2820 AID Parameter Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3 SCU (P/N 1186003Lx) EQPT Data Provisioning Parameters AID: 1-EQPT-SCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10 DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters AID:1-EQPT-(MUX1-MUX9)-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13 DS3 MUX (P/N 1186002Lx) T3 Data Provisioning Parameters AID: 1-T3-(MUX1-MUX9)-1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19 DS3 MUX (P/N 1186002Lx) T1 Data Provisioning Parameters AID: 1-T1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20 STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters AID:1-EQPT-(MUX1-MUX9)-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-22 STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning Parameters AID: 1-STS1-(MUX1-MUX9)-1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-27 STS-1 MUX (P/N 1186005Lx) VT Data Provisioning Parameters AID: 1-VT1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28 STS-1 MUX (P/N 1186005Lx) T1 Data Provisioning Parameters AID: 1-T1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-29 Clock Card (P/N 1186004Lx) EQPT Data Provisioning Parameters AID: 1-EQPT-CLK-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30 MX2820 Environmental Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8 TL1 Input Commands Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-1 TL1 Response Messages Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-1 MX2820 System Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .C-1 MX2820 SCU Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-1 MX2820 M13 MUX Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-3 MX2820 STS-1 MUX Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-5 MX2820 Clock Card Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .D-7 Autonomous Messages Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .E-1 M13 MUX Performance Monitoring MONTYPE Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1 STS-1 MUX Performance Monitoring MONTYPE Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-3 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 E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-10 Change of Facility Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15 61186003L1-35D xv MX2820 System TL1 Reference Guide Table G-10. Table G-11. Table G-12. Table G-13. Table G-14. Table G-15. Table G-16. Table G-17. Table G-18. Table G-19. Table G-20. Table G-21. Table G-22. Table G-23. Table G-24. Table G-25. Table G-26. Table G-27. Table G-28. Table G-29. Table G-30. Table G-31. Table G-32. xvi State F1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State OOS-AUMA SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transition Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P4: OOS-MA, SDEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . State P8: OOS-AUMA SGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-15 G-16 G-17 G-18 G-19 G-20 G-21 G-22 G-23 G-24 G-25 G-28 G-29 G-30 G-31 G-32 G-33 G-34 G-35 G-36 G-37 G-38 G-39 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 TL1 Message Types The TL1 software provides four types of operation messages: • Input command An input command is a message from an OS or other source to a Network Element (NE). The message instructs or requests the NE to perform a management-related function. • Acknowledgment An acknowledgment is a reply from the NE that indicates an input command is being acted upon. An NE sends an acknowledgment response if a normal response or error response cannot be sent within two seconds. The MX2820 System supports the In Progress (IP) acknowledgment response. The IP acknowledgment response indicates the request has been initiated and produces subsequent output messages which provide a termination report or a termination report with command results. • Output response (Response message or Error message) An output response is a detailed reply or set of replies to an input command. It contains information that indicates whether the command was successfully executed. The output response also contains any data that needs to be returned to the OS/user. • Autonomous An autonomous message is generated by an NE either on a periodic basis or is generated by an NE to report an alarm or an event that occurs at the NE. These messages are normally triggered by alarm conditions and are not in response to any input command. OPERATIONS SUPPORT SYSTEM An OSS consists of application software that runs on a host computer and allows the host computer to provide network management functions. The SCU provides the network management interface for the MX2820 System and the network equipment that interconnects to and interworks with the MX2820 System. The SCU and the MX2820 System supports the following network management functions: • Configuration • Fault • Performance Monitoring • Security • Test From a network management standpoint, the MX2820 System and the network equipment are referred to as NEs that exchange messages with the host computer of the OS. 1-2 61186003L1-35D Section 1, Introduction - SCU Client Management Modes of Operations SCU CLIENT MANAGEMENT MODES OF OPERATIONS If an SCU is a client unit, the SCU can operate in two modes: Intelligent Network Element (INE) and Expansion Shelf. The mode of operation has an impact on the Target Identifier (TID) and the Access Identifier (AID) fields in a TL1 command. Refer to the “TL1 Commands” section in this document for additional information about these fields. If an SCU is a host unit, the client management mode is not available. NETWORK ELEMENTS The MX2820 System supports and/or provides the NEs shown in Table 1-1. NOTE This reference guide is also used for the coinciding RoHS products not specifically mentioned. The RoHS part number uses an “E” or “G” instead of an “L” in the part number. Table 1-1. MX2820 Network Elements Network Element Part Number System Controller Unit 1186003Lx DS3 MUX 1186002Lx Clock Card 1186004Lx STS-1 MUX 1186005Lx Note: Refer to www.adtran.com for a complete list of products. REFERENCES For more information, including details on each list series, refer to the MX2820 System Manual (P/N 61186003L1-1). 61186003L1-35D 1-3 MX2820 System TL1 Reference Guide MX2820 SYSTEM TL1 COMMAND CROSS-REFERENCE Table 1-2 lists the available TL1 commands for the MX2820 System. Table 1-2. TL1 Commands Common (SCU) Section-Page Command Type ACT-USER 4-2 Common ALW-MSG 7-2 Surveillance CANC-USER 4-4 Common DLT-USER-SECU 6-2 Security ED-rr 5-2 Provisioning ED-USER-SECU 6-4 Security ENT-USER-SECU 6-6 Security INH-MSG 7-4 Surveillance MENUS 4-5 Common OPR-LPBK-rr 9-2 System Test RLS-LPBK-rr 9-4 System Test RTRV-rr 5-4 Provisioning RTRV-ALM 7-6 Surveillance RTRV-ALM-ENV 7-8 Surveillance RTRV-COND 7-11 Surveillance RTRV-HDR 7-13 Surveillance RTRV-PM-rr 7-15 Surveillance SCHED-PMREPT-rr 7-25 Surveillance RTRV-PMSCHED-rr 7-17 Surveillance RTRV-SYS 7-19 Surveillance RTRV-TH-rr 5-6 Provisioning RTRV-USER-SECU 6-8 Security RTRV-VER 7-21 Surveillance RTRV-VERSION 7-23 Surveillance SET-DAT 4-6 Common SET-TH-rr 5-8 Provisioning SW-TOPROTN-rr 8-2 System Maintenance SW-TOWKG-rr 8-4 System Maintenance 1-4 61186003L1-35D Section 2 TL1 Commands INTRODUCTION This section provides information about the TL1 commands for the MX2820 System. SYNTAX The following syntax is used with TL1 commands. • A colon (:) separates the fields of a TL1 command. • The colon also separates unused or empty fields from required fields in a TL1 command. • A comma (,) separates data entry items within a common data block, a specific data block, and a state block. • A semicolon (;) indicates the end of a TL1 command. NOTE The carriage return does not indicate the end of a TL1 command. NOTE The BACKSPACE and DELETE keys are nonfunctional when entering TL1 commands. To abort a command, press CTRL+X. 61186003L1-35D 2-1 MX2820 System TL1 Reference Guide NOTATIONS AND CONVENTIONS The following notations and conventions are used for TL1 input commands: <> Information inside of the less than and greater than symbols indicates a data entry item for a command. The symbols are not transmitted as part of the command. [] Information inside of brackets indicates the parameter is optional for an input command. The brackets are not transmitted as part of the command. {|} Information inside of braces and separated by a pipe indicates that one of the parameters must be selected from the list. The braces and the pipes are not transmitted as part of the command. Unless noted otherwise, the TL1 input commands are not case sensitive. This manual presents the commands in all uppercase as a documentation standard/convention. GENERAL FORMAT A TL1 input command for the MX2820 System has the following general format: <verb>:<tid>:<aid>:<ctag>:<general block>:<common data block>: <specific data block>:<state block>; Table 2-1 provides a description for each field. “Appendix A, Input Commands Data Dictionary” and “Appendix B, Response Messages Data Dictionary” contains additional information about the parameters used with TL1 commands and response messages to the TL1 commands. NOTE The MX2820 System does not output an error message for data entries in a non-supported field of a TL1 command. Table 2-1. TL1 Input Command General Format Descriptions Field Description <verb> This field contains the TL1 command verb. The command verb indicates the action that is to be performed at the MX2820 System shelf, or another NE. The command verb can have up to two optional modifiers. The valid forms are as follows: • VERB • VERB-MODIFIER • VERB-MODIFIER-MODIFIER. <tid> 2-2 This field is the Target Identifier (TID). For more information, refer to the “TID” on page 2-3 subsection. 61186003L1-35D Section 2, TL1 Commands - General Format Table 2-1. TL1 Input Command General Format Descriptions (Continued) Field Description <aid> This field is the Access Identifier (AID). For more information, refer to “Section 3, ADTRAN AID Formats”. <ctag> The Correlation Tag (CTAG) is a one-to-six alphanumeric identifier that is echoed 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 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. <specific data 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. <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. : The colon is used as a field separator. ; The semicolon is used as a TL1 command terminator. The command terminator can be used after the last non-empty field without supplying the remaining colon separators. TID The TID parameter indicates the end-target NE for a TL1 command. The client management mode of operation for the SCU can have an impact on the value for this field. The following subsection provides additional information. NOTE If the SCU functions as the host network management unit, the client management mode of operation is not available. SCU Client Management Operation Mode INE When operating in the INE mode, the SCU has a unique TID and operates as an independent intelligent network element. TL1 commands route to this SCU if the TIDs in the commands match the TID of this SCU. INE is the default client management mode for the SCU. With this operation mode, the shelf number for the <aid> field is always a 1. 61186003L1-35D 2-3 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. Common Language Location Identifier (CLLI) The CLLI code is often used as the TID in TL1 commands. The CLLI code is one- to twentyalphanumeric characters that are not case sensitive. The CLLI code identifies physical locations and equipment such as buildings, central offices, antennae, channel banks, and shelves. CLLI codes are also used as unique identifiers for a single NE. CLLI codes are assigned at the OS. The following example provides a CLLI code. Example: HTVLALEXD16 Input Parameters: HTVL The first four character identify the place name (Huntsville). AL The next two characters identify the state, region, or territory (Alabama). EX The next two characters identify the central office location code. These characters typically identify the street location of the specific central office. In this example, EX represents Explorer Blvd. D The next single alpha character is the equipment type code. The equipment type code of D identifies general administrative equipment. 16 The last two numeric characters represent a unique identifier number for a specific central office. These characters identify which NE is being addressed. ACKNOWLEDGMENT RESPONSES If an NE cannot send a normal response or an error response to the OS/user within two seconds of receiving a TL1 command, the NE sends an acknowledgment response of IP. Acknowledgment Syntax The syntax for the acknowledgment responses supported by the MX2820 System are as follows: NOTE This symbol (<) represents the TL1 ready indicator. IP[^<CTAG>] < 2-4 <cr> <lf> 61186003L1-35D Section 2, TL1 Commands - Normal Response Messages NORMAL RESPONSE MESSAGES The standard TL1 response message for the MX2820 System has the following format: <cr> <lf> <lf> ^^^<source identifier>^<date>^<time> <cr> <lf> M^^<ctag>^<code> <cr> <lf> ^^^<error_code> <cr> <lf>; Table 2-2 provides a description for each field. Table 2-2. TL1 Response Message Format Descriptions Field or Symbol Description <cr> Carriage Return <lf> Line Feed Caret (^) The Caret represents one space character in the acknowledgment or response message. <source identifier> The Source Identifier (SID) identifies the shelf “TID”. <date> The Date field is in the form YY-MM-DD. • YY indicates year and ranges from 00 to 99. • MM indicates month and ranges from 01 to 12. • DD indicates day and ranges from 01 to 31. <time> The Time field is in the form HH-MM-SS. • HH indicates hour and ranges from 00 to 23. • MM indicates minutes and ranges from 00 to 59. • SS indicates seconds and ranges from 00 to 59. <ctag> The Correlation Tag (CTAG) corresponds to the CTAG from the TL1 input command. <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 MX2820 SYSTEM TL1 COMMANDS Table 2-3 provides TL1 command categories for the MX2820 System. Table 2-3. MX2820 TL1 Commands Common (SCU) Provisioning Security Surveillance System Maintenance System Test ACT-USER ED-rr DLT-USER-SECU ALW-MSG SW-TOPROTN-rr OPR-LPBK-rr CANC-USER RTRV-rr ED-USER-SECU INH-MSG SW-TOWKG-rr MENUS SET-TH-rr ENT-USER-SECU RTRV-ALM SET-DAT RTRV-TH-rr RTRV-USER-SECU RTRV-ALM-ENV RLS-LPBK-rr RTRV-COND RTRV-HDR RTRV-PM-rr RTRV-PMSCHED-rr RTRV-SYS RTRV-VER RTRV-VERSION SCHED-PMREPT-rr ADTRAN TL1 Commands The following TL1 commands are ADTRAN-specific commands: • “MENUS” on page 4-5 • “RTRV-VER” on page 7-21 • “RTRV-VERSION” on page 7-23 2-6 61186003L1-35D Section 2, TL1 Commands - User Account Requirements (Access Privileges) USER ACCOUNT REQUIREMENTS (ACCESS PRIVILEGES) The SCU provides the ability to control access to the MX2820 System with user security accounts that require users to enter a username and password. The SCU can also control access to the system which involves assigning command access privileges and operation privileges to user security accounts. Command access privileges determine which commands a user is allowed to enter. Operation privileges determine which operations a user is allowed to perform. User accounts are created at the ADMIN level of the SCU. The pre-defined user accounts are as follows: ADMIN, ADTRAN These user accounts include all allowances of the READWRITE account, add write access to all SCU and line card provision items, and add access to provision passwords for each user account through the General Provisioning menu. Creating user accounts requires assigning username, password, and command privilege level. READONLY This user account allows read access to any parameter in the SCU and line cards. READONLY user accounts have no security access. READWRITE, TEST These user accounts includes all allowances of the READONLY account and adds write access to a limited number of SCU items and all line card provision items. Changes to network management items, such as Internet Protocol (IP) address and TID are not allowed. A READWRITE or TEST user account can change its own password, but has no other security access. All accounts can be deleted and replaced with user-defined accounts. Any inactive account (not currently logged on) can be disabled. TL1 login accounts (TL1 sessions) require use of the ACT-USER command to access the system. 61186003L1-35D 2-7 MX2820 System TL1 Reference Guide This page is intentionally blank. 2-8 61186003L1-35D Section 3 ADTRAN AID Formats INTRODUCTION This section provides information about ADTRAN AID formats for the MX2820 System. SCU OPERATION MODE The operation mode for the SCU can affect how and when the AID parameter is entered for the TL1 commands. In addition, a NE entity, such as the card type, being targeted by the TL1 command can affect the AID parameter. SCU Unit How the SCU functions in the network management configuration determines whether the client management mode is available. If the SCU functions as a host unit, the client management mode is not available and the AID parameter is determined by the NE entity being targeted by the TL1 command. If the SCU functions as a client, the client management mode is available and defaults to INE. Intelligent Network Element If the SCU operates in the INE mode, the shelf number for the AID parameter in a TL1 command is always one. The SCU has a unique TID when operating in the INE mode. TL1 commands route to this SCU if the TID in the command matches the TID of the SCU. INE shelves are provisioned with a unique TID during system turnup, and the shelf number is forced to one. Expansion Shelf If the SCU operates in the Expansion Shelf mode, a common TID can be shared by up to 32 SCUs. TL1 commands route to the appropriate SCU based on the shelf number in the AID. The shelf number ranges from 1–32. 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. Table 3-1. 19-Inch Chassis AID Inputs Shelf Category Entity 1 Entity 2 1 to 254 T3 MUX1 to MUX7 1 T1 MUX1 to MUX7 1 to 28 (corresponding to individual DS1s within DS3) VT1 MUX1 to MUX7 1 to 28 (corresponding to individual VTs within the STS-1) EQPT MUX1 to MUX7 A or B A = Working Unit B = Protect Unit STS1 CLK ENV SCU N/A 1 to 5 N/A Table 3-2. 23-Inch Chassis AID Inputs Shelf Category Entity 1 Entity 2 1 to 254 T3 MUX1 to MUX9 1 T1 MUX1 to MUX9 1 to 28 (corresponding to individual DS1s within DS3) VT1 MUX1 to MUX9 1 to 28 (corresponding to individual VTs within the STS-1) EQPT MUX1 to MUX9 A or B A = Working Card B = Protect Card STS1 CLK ENV 3-2 SCU N/A 1 to 5 N/A 61186003L1-35D Section 3, ADTRAN AID Formats - AID Structure There are no spaces between the parts of the AID parameter. Leading zeros are not significant. They are ignored on input and suppressed on output. Table 3-3 provides some examples of AID parameters. Table 3-3. MX2820 AID Parameter Examples AID Description 6-T3-MUX4-1 Shelf 6, Category T3, MUX Pair, Facility Input 1 6-T1-MUX4-26 Shelf 6, Category T1, MUX Pair, DS1 26 of 28 6-EQPT-MUX4-A Shelf 6, Category Eqpt, MUX Pair, Working Card 6-ENV-2 Shelf 6, Category Env, Auxiliary Alarm Input #2 6-EQPT-SCU Shelf 6, Category Eqpt, SCU 6-EQPT-CLK-B Shelf 6, Category Eqpt, CLK Pair, Protect Card The TL1 command sections and the data dictionaries in the appendices also contain information about the AID parameter. 61186003L1-35D 3-3 MX2820 System TL1 Reference Guide This page is intentionally blank. 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). Minimum User Access Privilege NONE Input Format ACT-USER:[<TID>]:<UID>:[<CTAG>]::<PID>; Example: ACT-USER:HTVLALEXD16:USER1:1::PASSWORD1; Input Parameters TID The TID identifies the target NE for the command. Refer to the “TID” on page 2-3 for additional information. UID The UID indicates the User ID or logon name for the user. The UID can have up to 10 alphanumeric characters. CTAG For the Correlation Tag (CTAG), refer to “Appendix A, Input Commands Data Dictionary” for additional information. PID The PID contains the password for the user. The password consists of an alphanumeric character string with a maximum length of 12 characters. The first character must be a letter. Valid characters are as follows: • Letters A–Z • Digits 0–9 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: M ; HTVLALEXD16 1 COMPLD 02-05-30 13:28:03 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>; If the username or password is enclosed in quotation marks it is treated as a case-sensitive string. Otherwise, all of the characters present are shifted to upper case. If the username or password contains a quotation mark, it must be doubled in the command string in order to prevent unwanted string termination. Example: Login: Password: AdMiN PaSs”WoRd The proper command to login with the above combination is as follows: ACT-USER::”AdMiN”:::”PaSs””WoRd”; 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. Minimum User Access Privilege READONLY 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> M^^<CTAG>^COMPLD <cr> <lf> ; <cr> <lf> Example: M ; HTVLALEXD16 5 COMPLD 02-05-30 16:36:54 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. Minimum User Access Privilege READONLY 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. Minimum User Access Privilege ADMIN Input Format SET-DAT:[<TID>]::[<CTAG>]::[YY-MM-DD][<,HH-MM-SS>]; Example: SET-DAT:HTVLALEXD16::32::02-06-03,11-32-00; Input Parameters TID The Target Identifier TID identifies the target NE for the command. Refer to the “TID” on page 2-3 for additional information. 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 > M^^<CTAG>^COMPLD <cr> <lf> ; <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> M^^<CTAG>^DENY <cr> <lf> ^^^<error_code> <cr> <lf> ; <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 This page is intentionally blank. 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 facilities (transmission entities) for the specified AID type. For the MX2820 System, the supported rr modifiers are as follows: • EQPT • T1 • T3 • STS1 • VT1 Minimum User Access Privilege READWRITE Input Format ED-rr:[<TID>]:<AID>:[<CTAG>]::[:[<specific data block>][:<state block>]]; Example: ED-T3:HTVLALEXD16:1-T1-MUX3-7::::DSXSTATE=ENABLE:OOS; Input Parameters 5-2 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. 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: M ; HTVLALEXD16 9 COMPLD 02-05-30 16:48:47 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. Minimum User Access Privilege READONLY Input Format RTRV-rr:[<TID>]:[<AID>]:[<CTAG>][:::<specific data block>]; Example: RTRV-EQPT:HTVLALEXD16::30:::CRAFT-BAUD; Input Parameters 5-4 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. 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> + ; The <rspblk> has the following format: ^^^"<AID>,<AIDTYPE>:[<CLEI>]:[<specific data block>]:<state block>" <cr> <lf> Example: M HTVALEXD16 03-11-22 11:09:22 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”. 5-6 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. 61186003L1-35D Section 5, Provisioning TL1 Commands - RTRV-TH-rr Response Format Normal Response <cr> <lf> <lf> ^^^<rsphdr> <cr> <lf> M^^<ctag>^COMPLD <cr> <lf> <rspblk> + ; The <rspblk> has the following format: ^^^"<aid>[,<aidtype>]:<montype>,[<locn>],[<dirn>],<thlev>[,<tmper>]" <cr> <lf> The normal response must contain at least one occurrence of <rspblk>. It is allowed to contain multiple <rspblk>s if applicable. Example: M HTVALEXD16 03-11-22 11:22:02 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”. 5-8 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. 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: M HTVALEXD16 03-11-22 11:35:28 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 TRANSMISSION ENTITY DATA PARAMETER TABLES Table 5-1 through Table 5-9 provide the data parameters (attributes) that apply to the <specific data block> field for the ED-rr and RTRV-rr commands. For the MX2820 System, the supported rr modifiers are as follows: • EQPT • STS1 • T1 • T3 • VT1 Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning Parameters AID: 1-EQPT-SCU Parameter Options Description ETH_LINK_STAT DOWN UP ERROR This read only parameters indicates the state of the Ethernet link. FAILURE_CNT 2-5 This read-only parameter is used to indicate how many times a login has failed. LOCKOUT_TIME 3 - 60 If a user is locked out, this read-only parameter is used to indicate how many seconds the user will remain locked out. SSHKEYSIZE 512 - 2048 (1024) This parameter indicates the size of current SSH keys. SSHGENSTAT IDLE RSA DSS This parameter indicates the current status of SSH key generation. ALARM_CHRON DESCENDING ASCENDING This parameter sets the order alarms are displayed in the alarm log. AUTO_LOGOFF DISABLE ENABLE This parameter enables/disables the auto logoff functionality. AUTO_LOGOFF_TIME 1 - 60 (30) This parameter sets how long it takes for autologoff to kick in if it is enabled. AUX1_COND_CODE 11-character string (AUX1) This parameter is the TL1 condition code for AUX1. AUX1_DESC 16-character string (AUX #1 INPUT) This parameter is the condition description of AUX1. Read Only Read/Write Note: Defaults are in bold type. 5-10 61186003L1-35D Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning Parameters AID: 1-EQPT-SCU (Continued) Parameter Options Description AUX1AID 1 - 16 (1) This parameter sets the AID index for AUX1. AUX1LOG NORMOPEN NORMCLOSED This parameter sets the logic sense of the AUXx alarm. AUX1LVL INFO ALERT MINOR MAJOR CRITICAL This parameter sets the reported alarm level for an AUX1 alarm. AUX2_COND_CODE 11-character string (AUX2) This parameter is the TL1 condition code for AUX2. AUX2_DESC 16-character string (AUX #2 INPUT) This parameter is the condition description of AUX2. AUX2AID 1 - 16 (2) This parameter sets the AID index for AUX2. AUX2LOG NORMOPEN NORMCLOSED This parameter sets the logic sense of the AUXx alarm. AUX2LVL INFO ALERT MINOR MAJOR CRITICAL This parameters sets the reported alarm level for an AUX2 alarm. AUX3A_COND_CODE 11-character string (AUX3A) This parameter is the TL1 condition code for AUX3A. AUX3A_DESC 16-character string (AUX #3A INPUT) This parameter is the condition description of AUX3A. AUX3AAID 1 - 16 (3) This parameters sets the AID index for AUX3A. AUX3LOG NORMOPEN NORMCLOSED This parameter sets the logic sense of the AUXx alarm. AUX3ALVL INFO ALERT MINOR MAJOR CRITICAL This parameters sets the reported alarm level for an AUX3A alarm. AUX3B_COND_CODE 11-character string (AUX3B) This parameter is the TL1 condition code for AUX3B. AUX3B_DESC 16-character string (AUX #3B INPUT) This parameter is the condition description of 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 Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning Parameters AID: 1-EQPT-SCU (Continued) Parameter Options Description AUX3BLVL INFO ALERT MINOR MAJOR CRITICAL This parameters sets the reported alarm level for an AUX3B alarm. CRAFT_BAUD 9600 19200 38400 57600 115200 This parameter is used to set the craft port baud rate. ETH_ENABLE DISABLE ENABLE This parameter allows the Ethernet port to be enabled/disabled. ETH_RATE AUTO 10HALF 10FULL 100HALF 100FULL This parameter is used to set the data rate for the Ethernet port. I-BANKMODE HOST CLIENT This parameter selects whether the shelf will serve as a client or host in the interbank communication protocol. NSA_REM_LVL INFO ALERT MINOR MAJOR CRITICAL This parameters sets the reported alarm level for a Non-Service Affecting card removal alarm. PWRA_COND_CODE 11-character string (PWRA) This parameter is the TL1 condition code for PWRA. PWRAAID 1 - 16 (4) This parameters sets the AID index for PWRA. PWRALVL INFO ALERT MINOR MAJOR CRITICAL This parameters sets the reported alarm level for a PWR A alarm. PWRB_COND_CODE 11-character string (PWRB) This parameter is the TL1 condition code for PWRB. PWRBAID 1 - 16 (5) This parameters sets the AID index for PWRB. PWRBLVL INFO ALERT MINOR MAJOR CRITICAL This parameters sets the reported alarm level for a PWR B alarm. Note: Defaults are in bold type. 5-12 61186003L1-35D Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning Parameters AID: 1-EQPT-SCU (Continued) Parameter Options Description REM_LVL INFO ALERT MINOR MAJOR CRITICAL This parameters sets the reported alarm level for a Service Affecting card removal alarm. SS_ENABLE DISABLE ENABLE This parameter allows Smart Start to be enabled/disabled. SSHGENSIZE 512 - 2048 (1024) This parameter sets the size of SSH keys to generate. The size must be a multiple of eight. TRAP_ENABLE DISABLE ENABLE This parameter allows SNMP traps to be enabled/disabled. GENERATE This parameter initiates the generation of SSH keys. Write Only SSHGENKEY Note: Defaults are in bold type. Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters AID:1-EQPT-(MUX1-MUX9)-(A or B) Parameter Options Description 0 - 31 Bit assignments are as follows (where logic 1 indicates the condition is present and logic 0 indicates that the condition is not present): Read Only ALARMSEVERITY Info = Bit 0 (LSB) Alert = Bit 1 Minor = Bit 2 Major = Bit 3 Critical = Bit 4 (MSB) APPSWCHECKSUM 4-character string The application software checksum for the card. APPSWVERSION 8-character string The application software version for the card. BOOTSWCHECKSUM 4-character string The boot software checksum for the card. BOOTSWVERSION 8-character string The boot software version for the card. DIAGBERTCOUNT 0 - 0xFFFFFFFF This variable indicates the number of errors accumulated during a BERT-type test. DIAGBERTSYNC NOSYNC SYNC This variable indicates the synchronization status during a BERT-type test. Note: Defaults are in bold type. 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) Parameter Options Description PRODCLEICODE 11-character string The ADTRAN product CLEI code for the card. PRODSERIALNUMBER 25-character string The ADTRAN product serial number for the card. PRODUCTNAME 12-character string The ADTRAN product name for the card. PROTECTIONMODE NONE CIRCUIT This variable indicates the protection mode of the card. SELFTEST 21-character string The software self-test results for the card. SLOTUPTIME 0 - 0xFFFFFFFF The time (in hundredths of a second) since the card was powered up. SWITCHCOUNT 0 - 255 This variable returns the current protection switch count that is used as a basis for the Max Switch Threshold alarm. ACTIVECARD CARDA CARDB This variable sets/indicates the active module in the module pair. AUTOSAVE DISABLE ENABLE This variable is used when configuring the Autosave feature. When enabled, the provisioning is automatically saved to non-volatile memory in response to a change in provisioning. CARDPAIRID 12-character string (MX2820 M13) This variable is used to identify a particular module pair. DIAGSELECTBERTPATT QRSS ALL1 ALL0 TWOINEIGHT ONEINEIGHT TWOTOFIFTEENTHINV This variable indicates the number of errors accumulated during a BERT-type test. Read/Write Note: Defaults are in bold type. 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) Parameter Options Description DIAGSELECTBERTPATT (1186002L3 Only) ALL1 ALL0 TWOINEIGHT ONEINEIGHT QRSS SIXTYTHREE FIVEELEVEN TWENTYFORTYSEVEN TWOTOFIFTEENTHINV TWOTOTWENTIETH TWOTOTWENTYTHIRD This variable indicates the number of errors accumulated during a BERT-type test. DIAGTIMEOUT DISABLE ONEMIN FIVEMIN TENMIN FIFTEENMIN THIRTYMIN FORTYFIVEMIN ONEHOUR This variable indicates the amount of time that a loopback will remain in effect before automatic release of the loopback occurs. DSXAUTOENABLEDELAY TWOSEC ONEHR TWOHRS TWELVEHRS ONEDAY TWODAYS SEVENDAYS This variable sets the delay associated with any auto-enabled DS1/E1 interface. DSXCVTHRESHOLD DISABLE ONEE3 ONEE4 ONEE5 ONEE6 This variable sets the DS1/E1 code violation threshold that, when exceeded, invokes a protection switch to the standby card. DSXMULTCKTPROT DISABLE ENABLE This variable is used when configuring the circuit protection setting of multiple DS1/E1 ports. This variable is temporary storage for the desired circuit protection setting. This setting is applied to all DS1/E1 ports within the range with APPLYMULTCKTPROT. Note: Defaults are in bold type. 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) Parameter Options Description DSXMULTFRMDETECT (1186002L3 Only) AUTO SF ESF UNFRAMED This variable is used when configuring the framing detection setting of multiple DS1 ports. This variable is temporary storage for the framing detection setting. This setting is applied to all DS1 ports within the range with APPLYMULTFRMDETECT. DSXMULTLINECODING AMI B8ZSHDB3 This variable is used when configuring the line coding setting of multiple DS1/E1 ports. This variable is temporary storage for the desired line coding setting. This setting is applied to all DS1/ E1 ports within the range with APPLYMULTLINECODING. DSXMULTLINELENGTH DSX0TO133 DSX133TO266 DSX266TO399 DSX399TO533 DSX533TO655 This variable is used when configuring the line length setting of multiple DS1/E1 ports. This variable is temporary storage for the desired line length setting. This setting is applied to all DS1 ports within the range with APPLYMULTLINELENGTH. DSXMULTLPBKDETECT DISABLE CSU NIU This variable is used when configuring the loopback detection setting of multiple DS1/E1 ports. This variable is temporary storage for the desired loopback detection setting. This setting is applied to all DS1 ports within the range with APPLYMULTLPBKDETECT. DSXMULTPRVSVSTATE IS OOS This variable is used when configuring the provisioned service state of multiple DS1/E1 facilities. This variable is temporary storage for the desired service state setting. This setting is applied to all DS1 facilities within the range with APPLYMULTSERVSTATE. DSXMULTSTATE DISABLE ENABLE AUTOENABLE This variable is used when configuring the state setting of multiple DS1/E1 ports. This variable is temporary storage for the desired state setting. This setting is applied to all DS1/E1 ports within the range with APPLYMULTSTATE. DSXPROTTHRESHOLD 1 - 28 (1) This variable sets the minimum number of DS1/ E1 channels that must fail before an automatic protection switch is invoked. ENDRANGE 1 - 28 (28) This variable is used when configuring multiple DS1/E1 ports. This variable is the end port of the range, and must be greater than or equal to the STARTRANGE value. Note: Defaults are in bold type. 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) Parameter Options Description EQPTPRVSERVSTATE IS OOS This variable sets the provisioned service state of the Equipment entity. IPFWDMTU MTU260 MTU1500 This variable controls the IP MTU used for the IP forwarding channel. This should be set to the default of 260 bytes in most cases. IPFWDPROTO ADTRAN PPP This variable controls the encapsulation protocol used to carry IP traffic over the DS3 when IP forwarding is in use. MAXNUMSWITCHES 1 - 24 (3) This variable sets the maximum number of protection switches allowed within a 1 hour period. If the threshold is met, then the unit issues an alarm and suppresses automatic protection switches for the next 24 hours. MINSWITCHPERIOD 0 - 3600 (10) This variable sets the minimum number of seconds allowed between automatic protection switches. STARTRANGE 1 - 28 (1) This variable is used when configuring multiple DS1/E1 ports. This variable is the beginning port of the range, and must be less than or equal to the ENDRANGE value. Write Only (Used to initiate an operation) APPLYMULTCKTPROT 1 a variable to apply the setting of DSXMULTCKTPROT to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE APPLYMULTDSXSVSTATE 1 This variable applies the setting of DSXMULTPRVSERVSTATE to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTFRMDETECT 1 This variable applies the setting of DSXMULTIFRMDETECT to all DS1 ports within the range indicated by STARTRANGE AND ENDRANGE. APPLYMULTLINECODING 1 This variable applies the setting of DSXMULTLINECODING to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTLINELENGTH 1 This variable applies the setting of DSXMULTLINELENGTH to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTLPBKDETECT 1 This variable applies the setting of DSXMULTLPBKDETECT to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. (1186002L3 Only) Note: Defaults are in bold type. 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) Parameter Options Description APPLYMULTSTATE 1 This variable applies the setting of DSXMULTSTATE to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. CARDRESET 1 Setting this variable forces the card to reboot. CLEARALLSTATS 1 This variable clears all DS3 and DS1/E1 PM statistics. CLEARSWITCHCOUNT 1 Setting this variable will reset to zero the protection switch count that is used as a basis for the Max Switch Threshold alarm. A read on this variable always returns a One. DEFAULTALLTHRESH 1 This variable restores all DS3 and DS1/E1 PM thresholds to their default values. DIAGCLEARBERTCOUNT 1 Setting this variable clears the error count during a BERT-type test. DIAGINSERTBERTERR 1 Setting this variable inserts one bit error into an active BERT pattern. DIAGRESETTESTS 1 Setting this variable releases all loopbacks currently activated. DISABLEALLTHRESH 1 This variable disables all DS3 and DS1/E1 PM thresholds. ENABLEALLTHRESH 1 This variable enables all DS3 and DS1/E1 PM thresholds. LOADFACTORYDEFAULT 1 The card's default provisioning data will be loaded when this variable is set. SAVEPROV 1 This setting saves the current provisioning data to non-volatile memory. Note: Defaults are in bold type. 5-18 61186003L1-35D Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables Table 5-3. DS3 MUX (P/N 1186002Lx) T3 Data Provisioning Parameters AID: 1-T3-(MUX1-MUX9)-1 Parameter Options Description DS3RXFRAMING CBIT M13 This variable indicates the framing mode detected on the received DS3 of the card. DS3STATE NORMAL ALARM TEST ALARMANDTEST This variable indicates the alarm/test state of the DS3 interface of the card. FEFACILITYID 38-character string (N/A) The far-end (remote) Facility ID Code received from the incoming DS3. FELOCATIONID 11-character string (N/A) The far-end (remote) Location ID Code received from the incoming DS3. FEFRAMEID 10-character string (N/A) The far-end (remote) Frame ID Code received from the incoming DS3. FEUNITID 6-character string (N/A) The far-end (remote) Unit ID Code received from the incoming DS3. FEEQPTID 10-character string (N/A) The far-end (remote) Equipment ID Code received from the incoming DS3. DS3FRAMING CBIT M13 This variable sets the framing mode of the DS3 of the card. The choice of framing mode affects the interpretation of the usage and error statistics. DS3LPBKDETECTION DISABLE FEACORCBIT FEAC CBIT This variable sets the out-of-band loopback command(s) to which the card will respond. DS3CVTHRESHOLD DISABLE ONEE3 ONEE4 ONEE5 ONEE6 This variable sets the DS3 code violation threshold that, when exceeded, sets an associated alarm. DS3TIMING LOOP LOCAL This variable sets the transmit-timing mode of the DS3 interface. LOOPBACK DATAMODE LINE DIGITAL FENDLINE ALLT1 This variable indicates the test state of the DS3 interface. NETPRVSERVSTATE IS OOS This variable sets the provisioned service state of the DS3 facility. Read Only Read/Write Note: Defaults are in bold type. 61186003L1-35D 5-19 MX2820 System TL1 Reference Guide Table 5-3. DS3 MUX (P/N 1186002Lx) T3 Data Provisioning Parameters AID: 1-T3-(MUX1-MUX9)-1 (Continued) Parameter Options Description NEFACILITYID 38-character string (N/A) The near-end (local) Facility ID Code transmitted from the DS3 when C-BIT framing is used. NELOCATIONID 11-character string (N/A) The near-end (local) Location ID Code transmitted from the DS3 when C-BIT framing is used. NEFRAMEID 10-character string (N/A) The near-end (local) Frame ID Code transmitted from the DS3 when C-BIT framing is used. NEUNITID 6-character string (N/A) The near-end (local) Unit ID Code transmitted from the DS3 when C-BIT framing is used. NEEQPTID 10-character string (N/A) The near-end (local) Equipment ID Code transmitted from the DS3 when C-BIT framing is used. Write Only (Used to initiate an operation) CLEARNETSTATS 1 This variable clears all DS3 PM statistics. Note: Defaults are in bold type. Table 5-4. DS3 MUX (P/N 1186002Lx) T1 Data Provisioning Parameters AID: 1-T1-(MUX1-MUX9)-(1-28) Parameter Options Description DSXSTATUS OFF OK LOS BPV TEST HOT XCV CAIS LAIS AUTO NA This variable indicates the status of a T1/E1 interface (consistent with what is indicated in the VT-100 Status menu). DSXBERTSYNCMULT (1186002L3 Only) NOSYNC SYNC UNAVAILABLE This variable indicates the synchronization status during a BERT-type test. DSXBERTCOUNTMULT 0-0xFFFFFFFF This variable indicates the number of errors accumulated during a BERT-type test. Read Only (1186002L3 Only) Note: Defaults are in bold type. 5-20 61186003L1-35D Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables Table 5-4. DS3 MUX (P/N 1186002Lx) T1 Data Provisioning Parameters AID: 1-T1-(MUX1-MUX9)-(1-28) (Continued) Parameter Options Description DSXSTATE DISABLE ENABLE AUTOENABLE UNAVAILABLE This variable sets the state of a DS1/E1 interface. DSXLINECODING DSXAMI DSXB8ZS E1AMI E1HDB3 UNAVAILABLE This variable sets the line coding of a DS1/E1 interface. DSXLINELENGTH DSX0TO133 DSX133TO266 DSX266TO399 DSX399TO533 DSX533TO655 E10TO6DB UNAVAILABLE This variable sets the line length setting of the DS1/E1 interface. DSXSWITCHPROT DISABLE ENABLE UNAVAILABLE This variable enables or disables an automatic protection switch due to a failure of the DS1/E1 interface. DSXLPBKDETECTION DISABLE CSU NIU UNAVAILABLE This variable enables or disables the detection and response to CSU/NIU loopback commands received from the network. DSXFRMDETECTION AUTO SF ESF UNFRAMED UNAVAILABLE This variable sets the framing detection of a DS1 interface. Read/Write (1186002L3 Only) Note: Defaults are in bold type. 61186003L1-35D 5-21 MX2820 System TL1 Reference Guide Table 5-4. DS3 MUX (P/N 1186002Lx) T1 Data Provisioning Parameters AID: 1-T1-(MUX1-MUX9)-(1-28) (Continued) Parameter Options Description LOOPBACK DATAMODE NETWORK TERMINAL DIGITAL CODEC DS1FEAC CSULBK CSUBERT LINEBERT UNAVAILABLE NIULBK NIUBERT HSCSULBK HSCSUBERT HSLINEBERT HSNIULBK HSNIUBERT This variable indicates the test state of a DS1/E1 interface. T1PRVSERVSTATE IS OOS This variable sets the provisioned service state of the T1 facility. 1 This variable clears all DS1/E1 PM statistics. Write Only CLEARPORTSTATS Note: Defaults are in bold type. Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters AID:1-EQPT-(MUX1-MUX9)-(A or B) Parameter Options Description 0 - 31 This variable indicates the severity of current active system alarms of the card. Bit assignments are as follows (where logic 1 indicates the condition is present and logic 0 indicates that the condition is not present): Read Only ALARMSEVERITY Info = Bit 0 (LSB) Alert = Bit 1 Minor = Bit 2 Major = Bit 3 Critical = Bit 4 (MSB) PROTECTIONMODE NONE CIRCUIT This variable indicates the protection mode of the card. 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) Parameter Options Description 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. DIAGBERTSYNC NOSYNC SYNC This variable indicates the synchronization status during a BERT-type test. DIAGBERTCOUNT 0 - 0xFFFFFFFF This variable indicates the number of errors accumulated during a BERT-type test. SLOTUPTIME 0 - 0xFFFFFFFF The time (in hundredths of a second) since the card was powered up. 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. EXTCLKSTATUS PRESENT NOTPRESENT This variable indicates whether this module detects the external clock from the clock module. SWITCHCOUNT 0 - 255 This variable returns the current protection switch count that is used as a basis for the Max Switch Threshold alarm. ACTIVECARD CARDA CARDB This variable sets/indicates the active module in the module pair. MAXNUMSWITCHES 1 - 24 (3) This variable sets the maximum number of protection switches allowed within a 1 hour period. If the threshold is met, then the unit issues an alarm and suppresses automatic protection switches for the next 24 hours. MINSWITCHPERIOD 0 - 3600 (10) This variable sets the minimum number of seconds allowed between automatic protection switches. DSXCVTHRESHOLD DISABLE ONEE3 ONEE4 ONEE5 ONEE6 This variable sets the DS1/E1 code violation threshold that, when exceeded, invokes a protection switch to the standby card. DSXPROTTHRESHOLD 1 - 28 (1) This variable sets the minimum number of DS1/ E1 channels that must fail before an automatic protection switch is invoked. Read/Write Note: Defaults are in bold type. 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) Parameter Options Description DSXAUTOENABLE-DELAY TWOSEC ONEHR TWOHRS TWELVEHRS ONEDAY TWODAYS SEVENDAYS This variable sets the delay associated with any auto-enabled DS1/E1 interface. STARTRANGE 1 - 28 (1) This variable is used when configuring multiple VT paths or DS1/E1 ports. This variable is the beginning port of the range, and must be less than or equal to the ENDRANGE value. ENDRANGE 1 - 28 (28) This variable is used when configuring multiple VT paths or DS1/E1 ports. This variable is the end port of the range, and must be greater than or equal to the STARTRANGE value. DSXMULTSTATE DISABLE ENABLE AUTOENABLE This variable is used when configuring the state setting of multiple DS1/E1 ports. This variable is temporary storage for the desired state setting. This setting is applied to all DS1/E1 ports within the range with APPLYMULTSTATE. DSXMULTLINECODING AMI B8ZSHDB3 This variable is used when configuring the line coding setting of multiple DS1/E1 ports. This variable is temporary storage for the desired line coding setting. This setting is applied to all DS1/ E1 ports within the range with APPLYMULTLINECODING. DSXMULTLINELENGTH DSX0TO133 DSX133TO266 DSX266TO399 DSX399TO533 DSX533TO655 This variable is used when configuring the line length setting of multiple DS1 ports. This variable is temporary storage for the desired line length setting. This setting is applied to all DS1 ports within the range with APPLYMULTLINELENGTH. DSXMULTCKTPROT DISABLE ENABLE This variable is used when configuring the circuit protection setting of multiple DS1/E1 ports. This variable is temporary storage for the desired circuit protection setting. This setting is applied to all DS1/E1 ports within the range with APPLYMULTCKTPROT. DSXMULTLPBK-DETECT DISABLE CSU NIU This variable is used when configuring the loopback detection setting of multiple DS1 ports. This variable is temporary storage for the desired loopback detection setting. This setting is applied to all DS1 ports within the range with APPLYMULTLPBKDETECT. Note: Defaults are in bold type. 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) Parameter Options Description MULTVTHAIRPIN DISABLE ENABLE This variable is used when configuring the VT hairpin loopback setting of multiple VT paths. This variable is temporary storage for the desired loopback setting. This setting is applied to all VT paths within the range with APPLYMULTVTHAIRPIN. DSXMULTPRVSVSTATE IS OOS This variable is used when configuring the provisioned service state of multiple DS1 facilities. This variable is temporary storage for the desired service state setting. This setting is applied to all DS1 facilities within the range with APPLYMULTDSXSVSTATE. VTMULTPRVSVSTATE IS OOS This variable is used when configuring the provisioned service state of multiple VT path entities. This variable is temporary storage for the desired service state setting. This setting is applied to all VT paths within the range with APPLYMULTVTSVSTATE. DIAGTIMEOUT DISABLE ONEMIN FIVEMIN TENMIN FIFTEENMIN THIRTYMIN FORTYFIVEMIN ONEHOUR This variable indicates the amount of time that a loopback will remain in effect before automatic release of the loopback occurs. AUTOSAVE DISABLE ENABLE This variable is used when configuring the Autosave feature. When enabled, the provisioning is automatically saved to non-volatile memory when a change in provisioning occurs. CARDPAIRID 12-character string (MX2820 STS1) This variable is used to identify a particular module pair. EQPTPRVSERVSTATE IS OOS This variable sets the provisioned service state of the Equipment entity. VTAISTRANSMIT DISABLE ENABLE This variable enables or disables transmission of VT AIS toward the network. Write Only (Used to initiate an operation) APPLYMULTSTATE 1 This variable applies the setting of DSXMULTSTATE to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. Note: Defaults are in bold type. 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) Parameter Options Description APPLYMULTLINE-CODING 1 This variable applies the setting of DSXMULTLINECODING to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTLINELENGTH 1 This variable applies the setting of DSXMULTLINELENGTH to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTCKTPROT 1 This variable applies the setting of DSXMULTCKTPROT to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTLPBKDETECT 1 This variable applies the setting of DSXMULTLPBKDETECT to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTVTHAIRPIN 1 This variable applies the setting of MULTVTHAIRPIN to all VT paths within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTVTSV-STATE 1 This variable applies the setting of VTMULTPRVSVSTATE to all VT paths within the range indicated by STARTRANGE and ENDRANGE. APPLYMULTDSXSVSTATE 1 This variable applies the setting of DSXMULTPRVSVSTATE to all DS1/E1 ports within the range indicated by STARTRANGE and ENDRANGE. LOADFACTORYDEFAULT 1 The card's default provisioning data will be loaded when this variable is set. SAVEPROV 1 This setting saves the current provisioning data to non-volatile memory. CARDRESET 1 Setting this variable forces the card to reboot. CLEARSWITCHCOUNT 1 Setting this variable will reset to zero the protection switch count that is used as a basis for the Max Switch Threshold alarm. A read on this variable always returns a One. DIAGCLEARBERTCOUNT 1 Setting this variable clears the error count during a BERT-type test. DIAGRESETTESTS 1 Setting this variable releases all current active loopbacks. DIAGINSERTBERTERR 1 Setting this variable inserts one bit error into an active BERT pattern. DEFAULTALLTHRESH 1 This variable restores all STS-1, VT, and DS1/E1 PM thresholds to their default values. Note: Defaults are in bold type. 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) Parameter Options Description ENABLEALLTHRESH 1 This variable enables all STS-1, VT, and DS1/E1 PM thresholds. DISABLEALLTHRESH 1 This variable disables all STS-1, VT, and DS1/E1 PM thresholds. CLEARALLSTATS 1 This variable clears all STS-1, VT, and DS1/E1 PM statistics. Note: Defaults are in bold type. Table 5-6. STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning Parameters AID: 1-STS1-(MUX1-MUX9)-1 Parameter Options Description NETSTATE NORMAL ALARM TEST ALARMANDTEST This variable indicates the alarm/test state of the EC-1/STS-1 interface of the card. PATHTRACERX 64-character string The path trace string received from the incoming STS-1. CLKSOURCE LOOP FREE-RUN EXTERNAL The current timing source of the transmit timing mode of the EC-1/STS-1 interface. The value of this parameter can or can not be the same as that of the NETTIMING parameter. EXTCLKSYNCSTATUS STU PRS TNC ST2 ST3 SMC PNO DUS NOTAVAILABLE This variable indicates the clock sync status message decoded from the incoming STS-1 signal. PATHTRACETX 64-character string (ADTRAN MX2820 STS-1 MUX) The path trace string transmitted from the outgoing STS-1. PATHTRACERXEXP 64-character string (ADTRAN MX2820 STS-1 MUX) The path trace string expected to be detected in the received STS-1. Read Only Read/Write Note: Defaults are in bold type. 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) Parameter Options Description NETTIMING LOOP FREE-RUN EXTERNAL This variable sets the transmit-timing mode of the EC-1/STS-1 interface. LOOPBACK DATAMODE LINE DIGITAL This variable indicates the test state of the EC-1/ STS-1 interface. VTMODE T1 E1 This variable is used when configuring the VT mode of the module (T1 or E1). NETPRVSERVSTATE IS OOS This variable sets the provisioned service state of the EC1/STS-1 facility. VTMAPPINGMULTSEQ 1 This setting configures the VT cross-connect for sequential (TR-253) mapping. VTMAPPINGMULTGRP 1 This setting configures the VT cross-connect for group (M13) mapping. PATHTRACEMATCH 1 This item sets the string value for PATHTRACERXEXP equal to the current value for PATHTRACERX. CLEARNETSTATS 1 This variable clears all STS-1 PM statistics. Write-Only Note: Defaults are in bold type. Table 5-7. STS-1 MUX (P/N 1186005Lx) VT Data Provisioning Parameters AID: 1-VT1-(MUX1-MUX9)-(1-28) Parameter Options Description Read/Write VTMAPPING 1 - 29 This setting maps the indicated VT to the indicated DS1/E1 port. The value of this parameter indicates the DS1/E1 port mapped to the VT path. The value can be 1-28, or 29 for Unequipped. VTHAIRPIN DISABLE ENABLE UNAVAILABLE This setting configures the VT hairpin loopback setting of a VT path. VTPRVSERVSTATE IS OOS This variable sets the provisioned service state of the VT path entity. Note: Defaults are in bold type. 5-28 61186003L1-35D Section 5, Provisioning TL1 Commands - Transmission Entity Data Parameter Tables Table 5-8. STS-1 MUX (P/N 1186005Lx) T1 Data Provisioning Parameters AID: 1-T1-(MUX1-MUX9)-(1-28) Parameter Options Description DSXSTATE DISABLE ENABLE AUTOENABLE UNAVAILABLE NOT MAPPED This variable sets the state of a DS1/E1 interface. DSXLINECODING DSXAMI DSXB8ZS E1AMI E1HDB3 UNAVAILABLE NOT MAPPED This variable sets the line coding of a DS1/E1 interface. DSXLINELENGTH DSX0TO133 DSX133TO266 DSX266TO399 DSX399TO533 DSX533TO655 E10TO6DB UNAVAILABLE NOT MAPPED This variable sets the line length setting of the DS1/E1 interface. DSXSWITCHPROT DISABLE ENABLE UNAVAILABLE NOT MAPPED This variable enables or disables an automatic protection switch due to a failure of the DS1/E1 interface. DSXLPBKDETECTION DISABLE CSU NIU UNAVAILABLE NOT MAPPED This variable enables or disables the detection and response to CSU/NIU loopback commands received from the network. LOOPBACK DATAMODE NETWORK TERMINAL DIGITAL CODEC CSULBK CSUBERT VTBERT LINEBERT UNAVAILABLE This variable indicates the test state of a DS1/E1 interface. T1PRVSERVSTATE IS OOS This variable sets the provisioned service state of the T1 facility. 1 This variable clears all PM statistics for this DS1/E1 and for the attached VT. Write Only CLEARPORTSTATS Note: Defaults are in bold type. 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) Parameter Options Description Read Only ALARMSEVERITY 0 - 31 This variable indicates the severity of current active system alarms of the card. Bit assignments are as follows (where logic 1 indicates the condition is present and logic 0 indicates that the condition is not present): Info = Bit 0 (LSB) Alert = Bit 1 Minor = Bit 2 Major = Bit 3 Critical = Bit 4 (MSB) PROTECTIONMODE NONE CIRCUIT This variable indicates the protection mode of the card. 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. SLOTUPTIME 0 - 0xFFFFFFFF The time (in hundredths of a second) since the card was powered up. 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. CLOCKSTATE FREEWALKFAST FREEWALK EXITHOFAST EXITHOLDOVER HOLDOVER NORMAL FASTSTATE RESETSTATE This request returns the current state of the clock card phase lock loop. SWITCHCOUNT 0 - 255 This variable returns the current protection switch count that is used as a basis for the Max Switch Threshold alarm. CARDA CARDB This variable sets/indicates the active module in the module pair. Read/Write ACTIVECARD Note: Defaults are in bold type. 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) Parameter Options Description CARDPAIRID 12-character string (MX2820 SMC) This variable is used to identify a particular module pair. PRVACTIVEREF PRIMARY SECONDARY This variable sets the active card in a redundant system. MAXNUMSWITCHES 1 - 24 (3) This variable sets the maximum number of protection switches allowed within a 1 hour period. If the threshold is met, then the unit issues an alarm and suppresses automatic protection switches for the next 24 hours. MINSWITCHPERIOD 0 - 3600 (10) This variable sets the minimum number of seconds allowed between automatic protection switches. AUTOSAVE DISABLE ENABLE This variable is used when configuring the Autosave feature. When enabled, the provisioning is automatically saved to non-volatile memory when a change in provisioning occurs. PRVEQUIPSERVSTATE IS OOS This variable sets the provisioned service state of the Equipment entity. AUTOREFSWITCH ENABLE DISABLE This variable is used to enable or disable automatic clock reference protection switching. AUTOCARDSWITCH ENABLE DISABLE This variable is used to enable or disable automatic card protection switching. TIMINGMODE EXTERNAL HOLDOVER This variable sets the clock card to synchronize to either of the external clock references or operate in hold over. TIMINGTYPE SFESF ALLONES This variable enables and disabled AIS detection on the incoming clock references. It can be used for debugging purposes. TERMINATIONMODE ENABLE DISABLE This variable specifies if the clock card pair will provide line termination for the incoming bits clock inputs or if another timing destination will be responsible for termination. PRICLKALARM ENABLE DISABLE This variable sets whether the Primary Clock reference failure alarm is enabled or disabled (inhibited). SECCLKALARM ENABLE DISABLE This variable sets whether the Secondary Clock reference failure alarm is enabled or disabled (inhibited). Note: Defaults are in bold type. 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) Parameter Options Description Write Only (Used to initiate an operation) LOADFACTORY-DEFAULT 1 The card's default provisioning data will be loaded when this variable is set. CARDRESET 1 Setting this variable forces the card to reboot. SAVEPROV 1 This setting saves the current provisioning data to non-volatile memory. CLEARSWITCHCOUNT 1 Setting this variable will reset to zero the protection switch count that is used as a basis for the Max Switch Threshold alarm. Note: Defaults are in bold type. 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. Minimum User Access Privilege ADMIN 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> M^^<CTAG>^COMPLD <cr> <lf> ; <cr> <lf> Example: M ; 6-2 HTVLALEXD16 8 COMPLD 02-06-04 09:03:52 61186003L1-35D Section 6, Security TL1 Commands - DLT-USER-SECU Error Response <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> M^^<CTAG>^DENY <cr> <lf> ^^^<error_code> <cr> <lf> ; <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. Minimum User Access Privilege ADMIN 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> M^^<CTAG>^COMPLD <cr> <lf> ; <cr> <lf> Example: M ; HTVLALEXD16 10 COMPLD 02-06-04 15:53:41 Error Response <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> 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-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. Minimum User Access Privilege ADMIN 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 Dictionary” 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> M^^<CTAG>^COMPLD <cr> <lf> ; <cr> <lf> Example: M ; HTVLALEXD16 12 COMPLD 02-06-04 15:37:00 Error Response <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> M^^<CTAG>^DENY <cr> <lf> ^^^<error_code> <cr> <lf> ; <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. Minimum User Access Privilege ADMIN 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> ; 6-8 <lf> 61186003L1-35D Section 6, Security TL1 Commands - RTRV-USER-SECU Example: M HTVLALEXD16 02-06-04 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” 16:57:20 ; Error Response <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> M^^<CTAG>^DENY <cr> <lf> ^^^<error_code> <cr> <lf> ; <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 This page is intentionally blank. 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. Minimum User Access Privilege READONLY Input Format ALW-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],; Example: ALW-MSG-EQPT:HTVLALEXD16::2::MJ,; Input Parameters 7-2 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. 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: M ; HTVLALEXD16 3 COMPLD 02-05-30 15:43:02 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 autonomous 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. Minimum User Access Privilege READONLY Input Format INH-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],; Example: INH-MSG-EQPT:HTVLALEXD16::13::MJ,; Input Parameters 7-4 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. 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: M ; HTVLALEXD16 13 COMPLD 02-05-30 17:15:51 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 RTRVALM-ENV command retrieves environmental alarms. Minimum User Access Privilege READONLY Input Format RTRV-ALM-{EQPT|rr|ALL}:[<TID>]:[<AID>]:[<CTAG>]::[<NTFCNCDE>],[<CONDTYPE>], [<SRVEFF>],[<LOCN>],; Example: RTRV-ALM-EQPT:HTVLALEXD16:1-T3-MUX4-1:19::CR,LOS,SA,NEND,; Input Parameters 7-6 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. 61186003L1-35D Section 7, Surveillance TL1 Commands - RTRV-ALM LOCN For the LOCN, refer to “Appendix A, Input Commands Data Dictionary” for additional information. Response Format Acknowledgment IP^<CTAG> < <cr> <lf> Example: IP 19 < Normal Response Format for no Alarm Conditions <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> M^^<CTAG>^COMPLD <cr> <lf> ; <cr> <lf> Format for Alarm Conditions <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> M^^<CTAG>^COMPLD <cr> <lf> <rspblk> + ; <cr> <lf> <rspblk> has the format: ^^"[<AID>] [,<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>], [<OCRTM>],[<LOCN>],[<TMPER>],:[<CONDDESCR>]" <cr> <lf> Example: HTVLALEXD16 02-10-14 17:13:45 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\"" M ; Error Response <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> M^^<CTAG>^DENY <cr> <lf> ^^^<error_code> <cr> <lf> ; <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) Environmental Alarm Summary Table 7-1 provides an environmental alarm summary for the MX2820 System. Table 7-1. MX2820 Environmental Alarm Data Alarm Default AID Index Default Condition Code Default Severity Level Description String Auxiliary1 Input 1 AUX1 Major AUX #1 INPUT Auxiliary2 Input 2 AUX2 Major AUX #2 INPUT Auxiliary3A Input 3 AUX3A Major AUX #3A INPUT Auxiliary3B Input 3 AUX3B Major AUX #3B INPUT PWR Bus A Fail 4 PWRA Major Power Bus A Fail (No provisionable description string) PWR Bus B Fail 5 PWRB Major Power Bus B Fail (No provisionable description string) Minimum User Access Privilege READONLY Input Format RTRV-ALM-ENV:[<TID>]:[<AID>]:[<CTAG>]::[<NTFCNCDE>][,<ALMTYPE>]; Example: RTRV-ALM-ENV:HTVLALEXD16:1-ENV-1:20::MJ,AUX1; 7-8 61186003L1-35D Section 7, Surveillance TL1 Commands - RTRV-ALM-ENV Input Parameters 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> + ; The <rspblk> parameter has the following format: ^^^"<AID>:<NTFCNCDE>,<ALMTYPE>,[<OCRDAT>,[<OCRTM>]" <cr> <lf> Example: M HTVLALEXD16 02-05-31 10:36:16 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 Minimum User Access Privilege READONLY Input Format RTRV-COND-{EQPT|rr|ALL}:[<TID>]:[<AID>]:[<CTAG>]::[<TYPEREQ>],[<LOCN>],; Example: RTRV-COND-EQPT:HTVLALEXD16:1-T3-MUX4-1:22::CR,FEND,; Input Parameters 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> + ; <rspblk> has the following format: ^^^"<AID>[,<AIDTYPE>]:[<NTFCNCDE>],<TYPEREP>,[<SRVEFF>],[<OCRDAT>],[<OCRTM>], [<LOCN>],[,<TMPER>],[<CONDDESCR>]" <cr> <lf> Example: M HTVLALEXD16 02-05-31 10:59:19 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. Minimum User Access Privilege READONLY 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> M^^<CTAG>^COMPLD <cr> <lf> ^^^/* <SW Rev.> */ <cr> <lf> ; <lf> Example: M HTVLALEXD16 23 COMPLD /*^COL^*/ 02-05-31 11:08:32 ; 61186003L1-35D 7-13 MX2820 System TL1 Reference Guide Error Response <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> M^^<CTAG>^DENY <cr> <lf> ^^^<error_code> <cr> <lf> ; <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 Autonomous PM messages were not received or properly processed. This command can also be used to evaluate the system before or after NE maintenance operations. Minimum User Access Privilege READONLY Input Format RTRV-PM-rr:[<TID>]:<AID>:[<CTAG>]::[<MONTYPE>],[<MONLEV>],[<LOCN>],, [<TMPER>],[<MONDAT>][,<MONTM>]; Example: RTRV-PM-T1:HTVLALEXD16:1-T1-MUX3-7:::ESL,1-UP,NEND,,1-DAY,05-31,12-00; Input Parameters 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> + ; <rspblk> has the following format: ^^^"<AID>:<MONTYPE>,<MONVAL>,[<VLDTY>],[<LOCN>],,[<TMPER>],[<MONDAT>] [,<MONTM>]" <cr> <lf> Example: M HTVLALEXD16 02-05-31 12:02:08 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 Minimum User Access Privilege READONLY 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> + ; <rspblk> has the following format: ^^^"<AID>[,<AIDTYPE>]:<REPTINVL>,<REPTDAT>,<REPTTM>,[<NUMIVNL>],,[<MONLEV>], <LOCN>,,[<TMPER>],[<TMOFST>],[<INHMODE>]" <cr> <lf> Example: M HTVLALEXD16 02-05-31 17:05:30 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. Minimum User Access Privilege READONLY 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: M HTVLALEXD16 02-05-31 15:47:20 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. Minimum User Access Privilege READONLY 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: M 28 HTVLALEXD16 02-05-31 COMPLD "::VERSION=C01" 15:52:08 ; 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. Minimum User Access Privilege READONLY 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: M HTVLALEXD16 02-05-31 28 COMPLD "::VERSION=C01" 15:52:08 ; 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. Minimum User Access Privilege ADMIN Input Format SCHED-PMREPT-rr:[<TID>]:<AID>:[<CTAG>]::[<REPTINVL>],[<REPTSTATM],[<NUMREPT>], [<MONTYPE>],[<MONLEV>],[<LOCN>],,[<TMPER>][,<TMOFST>]; Example: SCHED-PMREPT-T1:HTVLALEXD16:1-T1-MUX8-9:31::15-MIN,20-0,3,ESL,0-UP,NEND,, 15-MIN,0-0-0; Input Parameters 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 information. 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 MONLEV For the 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. TMOFST For the Time Offset (TMOFST), refer to “Appendix A, Input Commands Data Dictionary” for additional information.. Response Format Acknowledgment IP^<CTAG> <cr> <lf> < Example: IP 31 < Normal Response <cr> <lf> <lf> ^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf> M^^<CTAG>^COMPLD <cr> <lf> ; Example: M ; HTVLALEXD16 31 COMPLD 02-05-31 17:04:08 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. Minimum User Access Privilege READWRITE 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: M ; 8-2 HTVLALEXD16 33 COMPLD 02-06-03 11:37:02 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. Minimum User Access Privilege READWRITE 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: M ; 8-4 HTVLALEXD16 34 COMPLD 02-06-03 11:38:39 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 This page is intentionally blank. 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 information 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: M ; HTVLALEXD16 25 COMPLD 03-01-17 09:39:59 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: M ; 9-4 HTVLALEXD16 25 COMPLD 03-01-17 09:39:59 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 This page is intentionally blank. 9-6 61186003L1-35D Appendix A Input Commands Data Dictionary INTRODUCTION Table A-1 provides descriptions for the parameters that can be used in a TL1 input command for the MX2820 System. Table A-1. TL1 Input Commands Data Dictionary Parameter Description AID Access Identifier. Refer to the “Section 3, ADTRAN AID Formats” for information. ALMTYPE This parameter indicates the alarm type. CTAG The Correlation Tag associates the input command with the response message(s). The CTAG contains 1–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. The default for the CTAG is 0. DIRN The Direction parameter indicates the transmission direction to which switching is made. The direction is relative to the SONET line or path identified by the AID parameter. The supported value is RCV, Receive direction only. HH-MM-SS This parameter is the input format for the SET-DAT command that sets the hours, minutes, and seconds. Each component is specified by two digits. LOCN The Location parameter indicates the location from which an alarm condition or PM threshold alarm value is being reported and also refers to the entity identified by the AID parameter. Near end refers to alarm conditions occurring at the identified entity, and far end refers to alarm conditions occurring at a distant entity that is connected to the identified entity. Values are as follows: • NEND • FEND 61186003L1-35D A-1 MX2820 System TL1 Reference Guide Table A-1. TL1 Input Commands Data Dictionary (Continued) 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 parameter for which a value is requested. NTFCNCDE The Notification Code parameter provides a two-character code associated with a single alarm condition. Values are as follows: • CR, (Critical alarm) • MJ, (Major alarm) • MN, (Minor alarm) • NA, (Not alarmed) • CL, (Cleared alarm) • TH, (Threshold) A-2 61186003L1-35D Appendix A, Input Commands Data Dictionary - Introduction Table A-1. TL1 Input Commands Data Dictionary (Continued) 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 schedule performance monitoring indefinitely. ORGN The Originating Office parameter indicates the office that originates the signal to be looped back. The supported values are as follows: • NEND • FEND • BOTH PID The Private Identifier parameter provides the password for the user. The PID consists of a string of letters and digits with a maximum length of 12 characters. The first character must be a letter. • Letter: A-Z • Digit: 0-9 REPTINVL The Report Interval parameter specifies how often a performance-monitoring report is to be generated and returned to the requesting OS/ user. The REPTINVL format is VAL-UN. Values for VAL (value) and UN (units of time) are as follows: VALUN 1 to 31DAY 1 to 24HR 1 to 1440MIN 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 rr The rr value is a command verb modifier that indicates the type of transmission entity for an NE. Values are as follows: • EQPT • T1 • T3 • STS1 • VT1 61186003L1-35D A-3 MX2820 System TL1 Reference Guide Table A-1. TL1 Input Commands Data Dictionary (Continued) 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 document 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 parameters 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 recommended 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 buildings, 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 accumulation 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 A-4 The Test Session Number, which the OS assigns for each circuit access, identifies all message for each circuit access. The range of values is from 1 to 999. 61186003L1-35D Appendix A, Input Commands Data Dictionary - Introduction Table A-1. TL1 Input Commands Data Dictionary (Continued) 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 This page is intentionally blank. A-6 61186003L1-35D Appendix B Response Messages Data Dictionary INTRODUCTION Table B-1 provides descriptions for the parameters that can be received in a response message to a TL1 input command for the MX2820 System. Table B-1. TL1 Response Messages Data Dictionary Parameter Description ^ The carot symbol indicates an ASCII space character. + The plus sign indicates information for the preceding field or parameter can occur one or more times. AID The AID parameter in a response message indicates the location within the NE entity from which information is being retrieved. AIDTYPE This parameter indicates the type of AID. Examples include T1 and T3. ALMTYPE This parameter indicates the alarm type. CID The Channel Identifier (CID) parameter indicates the user's interface port/channel that initiates a session or a logical equivalent such as a user's calling address. For ports, the CID can be up to ten alphanumeric characters. For the directory numbers, the CID can consists of seven digits in the form NXX-XXXX or ten digits in the form NPA-NXX-XXXX. CLEI This parameter indicates the equipment CLEI code for a specific vendor. COMPLD This parameter indicates the successful execution for the input command. The transaction was fully completed. CONDDESCR For the “RTRV-ALM” commands, this parameter provides a text description of the trouble. For the “RTRV-COND” commands, this parameter provides a text description of the condition or state. CONDTYPE 61186003L1-35D This parameter indicates a single type of alarm condition being reported for an entity within the NE. Refer to “Appendix D, Alarms and Alarm Condition Codes” for condition types that apply to the MX2820 System. B-1 MX2820 System TL1 Reference Guide Table B-1. TL1 Response Messages Data Dictionary (Continued) Parameter Description CONTACT This parameter consists of a user-specified character string that indicates the personnel to contact for the MX2820 System. The maximum length is 55 characters. <cr> ASCII carriage return CTAG The CTAG associates the input command with the response message(s). The CTAG contains 1 to 6 alphanumeric characters. The CTAG is echoed in the response message to the input command. For example, an input command with a CTAG of 1 has a response message with a CTAG of 1. DENY This parameter indicates unsuccessful execution for the input command. The transaction was fully denied or uncompleted. <error_code> The error_code provides a four-character mnemonic abbreviation for the error condition. Refer to “Appendix C, MX2820 System Error Codes” in this document for additional information. HH:MM:SS This parameter is part of the response message header format. The two digits components are as follows: • HH indicates hour of day and ranges from 00 to 23 • MM indicates minutes of hour and ranges from 00 to 59 • SS indicates seconds of minute and ranges from 00 to 59 INHMODE The Inhibit Mode parameter indicates whether a particular function is inhibited. Valid values for this parameter are as follows: • ALW : Function is allowed • INH : Function is inhibited A null value for this parameter defaults to ALW. IP This acknowledgment component indicates the action specified by the input command is in progress. <lf> ASCII line feed character LOCATION This parameter consists of a user-specified character string that indicates the location of the MX2820 System. The maximum length is 55 characters LOCN The Location parameter indicates the location from which an alarm condition or Performance Monitoring (PM) threshold value is being reported and also refers to the entity identified by the AID parameter. Near end refers to alarm conditions occurring at the identified entity, and far end refers to alarm conditions occurring at a distance entity that is connected to the identified entity. Values are as follows: • NEND • FEND <login failures> B-2 Number of login failures on the account. 61186003L1-35D Appendix B, Response Messages Data Dictionary - Introduction Table B-1. TL1 Response Messages Data Dictionary (Continued) 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 parameter. NTFCNCDE The Notification Code parameter provides a two-character code associated with a single alarm condition. Values are as follows: • CR, (Critical alarm) • MJ, (Major alarm) • MN, (Minor alarm) • NA, (Not alarmed) • CL, (Cleared alarm) • TH, (Threshold) A value of NR indicates not reported when the event occurs. The NE retains the information. NUMINVL The Number Interval parameter indicates the remaining number of intervals associated with a particular action. A value of zero (0) for this parameter in a SCHEDULE command indicates the stopping of the particular action. A null value for this parameter specifies that the particular task runs indefinitely until either stopped or rescheduled by another command. OCRDAT The Occurrence Date parameter indicates the date for a triggering event. The OCRDAT format is MOY-DOM. • MOY indicates month of the year and ranges from 01 to 12 • DOM indicates the day of the month and ranges from 01 to 31 OCRTM The Occurrence Time parameter indicates the time for a triggering event. The OCRTM format is HOD-MOH-SOM. • 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 Table B-1. TL1 Response Messages Data Dictionary (Continued) 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 REPTINVL The Report Interval parameter specifies how often a performancemonitoring report is to be generated and returned to the requesting OS/user. The REPTINVL format is VAL-UN. Values for VAL (value) and UN (units of time) are as follows: VALUN 1 to 31DAY 1 to 24HR 1 to 1440MIN REPTTM The Report Time parameter specifies the time of day for the next PM report. The REPTTM format is HOD-MOH. • 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.> B-4 This parameter indicates the software release for an NE. 61186003L1-35D Appendix B, Response Messages Data Dictionary - Introduction Table B-1. TL1 Response Messages Data Dictionary (Continued) 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 TYPE This parameter consists of a user-specified character string that indicates the system type. The maximum length is 55 characters. TYPEREP The Type Report parameter identifies the condition type being reported or the entity state that is being reported. The condition type corresponds 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 Table B-1. TL1 Response Messages Data Dictionary (Continued) Parameter Description VLDTY The Validity parameter provides historical monitoring information. This parameter indicates whether the information for the specified monitoring period was accumulated over the entire monitoring period or some portion of it. Valid values are as follows: • COMPL : Data is accumulated over the entire monitoring period • PRTL : Data is accumulated over some portion of the monitoring period YY-MM-DD This is the response message date format where the two digits components are as follows: • YY indicates year and ranges from 00 to 67 • MM indicates month of year and ranges from 01 to 12 • DD indicates day of month and ranges from 01 to 31 B-6 61186003L1-35D Appendix C Error Codes INTRODUCTION The response message to a TL1 input command contains an error code <errcode> parameter when the addressed NE cannot complete the action for the input command. Table C-1 provides error code for the MX2820 System. Table C-1. MX2820 System Error Codes Error Code Category Description EANS Equipment This error code indicates access is not supported. EATN Equipage This error code indicates not valid for access type. ENEQ Error This error code indicates the device is not equipped. ENPM Error This error code indicates performance monitoring is not supported. ICNV Input This error code indicates the command is not valid. IDRG Input This error code indicates the date range is not valid. IIAC Input This error code indicates an invalid access identifier. IIDT Input This error code indicates an invalid data parameter. IIPG Input This error code indicates invalid parameter grouping. INAC Input This error code indicates an invalid test access point. IPNV Input This error code indicates the parameter is not valid. PIUI Privilege This error code indicates the input user is not valid. PLNA Privilege This error code indicates the login is not active or insufficient privileges. RABY Resource This error code indicates all TAPs are busy. RCBY Resource This error code indicates a circuit busy condition (access point is in use). RNAN Resource This error code indicates the requested NE access address does not exist. 61186003L1-35D C-1 MX2820 System TL1 Reference Guide Table C-1. MX2820 System Error Codes (Continued) Error Code Category Description RNAU Resource This error code indicates the requested NE access address is unassigned. RNBY Resource This error code indicates the NE is busy. RTBY Resource This error code indicates the TAP is busy. RTEN Resource This error code indicates the requested TAP does not exist. SADC Status This error code indicates the device is already disconnected. SCAT Status This error code indicates the circuit is already connected to another TAP. SCBS Status This error code indicates the channel is busy. SCSN Status This error code indicates an invalid command sequence. SNDS Status This error code indicates the NTE is in a diagnostic state. SNVS Status This error code indicates the device is not in a valid state. SRAC Status This error code indicates the requested access configuration is not valid. SRAN Status This error code indicate the access system cannot be released. SRCN Status This error code indicates the requested condition already exists. SROF Status This error code indicates the requested operation failed. SRTN Status This error code indicates the TAP cannot be released. SSRE Status This error code indicates the system resource is not available. STLC Status This error code indicates the TAP is unable to locate the channel. C-2 61186003L1-35D Appendix D Alarms and Alarm Condition Codes INTRODUCTION Alarm information and condition codes for the MX2820 System are provided in this index. The following modules are included: • SCU • M13 MUX • STS-1 MUX • MX2820 Clock Card SCU ALARMS Alarms for the SCU are described in Table D-1. Table D-1. MX2820 SCU Alarm Data Condition Code <CONDTYPE> Alarm Level Service Affecting (SRVEFF) Description AUX1 Major NSA This alarm indicates External Alarm Input number 1 on the rear of the shelf is active. The default alarm level is Minor and is provisionable in the SCU alarm menus. Provisionable alarm levels include: Critical, Major, Minor, Alert, and Info. The description string is provisionable and defaults to Aux #1 Input. AUX2 Major NSA This alarm indicates External Alarm Input number 2 on the rear of the shelf is active. The default level is Alert and is provisionable in the SCU alarm menus. Provisionable alarm levels include: Critical, Major, Minor, Alert, and Info. The description string is provisionable and defaults to Aux #2 Input. 61186003L1-35D D-1 MX2820 System TL1 Reference Guide Table D-1. MX2820 SCU Alarm Data (Continued) Condition Code <CONDTYPE> Alarm Level Service Affecting (SRVEFF) Description AUX3A Major NSA This alarm indicates External Alarm Input number 3A on the rear of the shelf is active. The default alarm level is Major and is provisionable in the SCU alarm menus. Provisionable alarm levels include: Critical, Major, Minor, Alert, and Info. The description string is provisionable and defaults to Aux #3A Input. Aux 3A is active with solid input. AUX3B Major NSA This alarm indicates External Alarm Input number 3B on the rear of the shelf is active. The default alarm level is Major and is provisionable in the SCU alarm menus. Provisionable alarm levels include: Critical, Major, Minor, Alert, and Info. The description string is provisionable and defaults to Aux #3B Input. Aux 3B is active with cadenced input (1 second on, 1 second off). PWRA Major SA This alarm indicates a Power Bus A failure. The default level is Major and is provisionable in the SCU alarm menus. Provisionable alarm levels include: Critical, Major, Minor, Alert, and Info. PWRB Major SA This alarm indicates a Power Bus B failure. The default level is Major and is provisionable in the SCU alarm menus. Provisionable alarm levels include: Critical, Major, Minor, Alert, and Info. IMPROPRMVL Critical SA A linecard was removed leading to a service outage. IMPROPRMVL Major NSA A standby linecard was removed leaving service unaffected. D-2 61186003L1-35D Appendix D, Alarms and Alarm Condition Codes - M13 MUX Card Alarms M13 MUX CARD ALARMS Table D-2 provides the alarms for the M13 MUX card. Table entries with the T-x format, (for example, T-CVL), provide PM data for both quarterly and daily threshold violations that are sent from the NE to the OS/user. The threshold alarms are Auto Clearing (AC). The alarms in this table are for transmission type T3 (rr=T3). The applicable TL1 command is RTRV-ALM-T3. Table D-2. MX2820 M13 MUX Alarm Data Entity Name And Description DS3 Message Type REPT ALM REPT EVT 61186003L1-35D Second Modifier Notification Code Service Affecting (SRVEFF) T3 CR SA LOS OOF Near end Near end MN NSA EXT EXT-T3-NSA EXT-T3-SA EXT-T1-NSA EXT-T1-SA LOS OOF LOS-T1-MULT LOS-T1-SNG Far Far Far Far Far Far Far Far Far SC SA TSA Near end SC NSA AIS ISD AIS ISD RAI XCV Far end Far end Near end Near end Near end Near end TC NSA T-CVL T-ESL T-SESL T-LOSS-L T-CVP-P T-ESP-P T-SESP-P T-UASP-P T-CVCP-P T-ESCP-P T-SESCP-P T-UASCP-P T-SAS-P T-CVCP-PFE T-ESCP-PFE T-SESCP-PFE T-UASCP-PFE Near end Near end Near end Near end Near end Near end Near end Near end Near end Near end Near end Near end Near end Far end Far end Far end Far end T3 Condition Type <CONDTYPE> Location end end end end end end end end end D-3 MX2820 System TL1 Reference Guide Table D-2. MX2820 M13 MUX Alarm Data (Continued) Entity Name And Description DS1 Equipment Message Type Second Modifier Notification Code Service Affecting (SRVEFF) REPT ALM T1 MJ SA LOS Near end REPT EVT T1 SC SA TSA Near end SC NSA XCV AIS AIS-NTWK Near end Near end Near end TC NSA T-CVL T-ESL T-SESL T-LOSS-L T-AISS Near Near Near Near Near end end end end end For P/N 1186002L3 Only: T-CVL-LS T-ESL-LS T-SESL-LS T-LOSS-L-LS T-CVP-LS T-ESP-LS T-SESP-LS T-UASP-LS T-AISS-P-LS T-CVP-HS T-ESP-HS T-SESP-HS T-UASP-HS T-AISS-P-HS Near Near Near Near Near Near Near Near Near Near Near Near Near Near end end end end end end end end end end end end end end REPT ALM REPT EVT EQPT EQPT Condition Type <CONDTYPE> Location MN* CR NSA SA EQPT Near end Near end MN* CR NSA SA IMPROPRMVL Near end Near end MN NSA CONTCOM Near end SC NSA WKSWPR ESW Near end Near end * This alarm will be reported as either Minor, Non-Service Affecting or Critical, Service Affecting depending on whether protection is available. D-4 61186003L1-35D Appendix D, Alarms and Alarm Condition Codes - STS-1 MUX Card Alarms STS-1 MUX CARD ALARMS Table D-3 provides the alarms for the STS-1 MUX card. Table entries with the T-x format, (for example, T-CVL), provide PM data for both quarterly and daily threshold violations that are sent from the NE to the OS/user. The threshold alarms are AC. The alarms in this table are for transmission type STS1 (rr=STS1). The applicable TL1 command is RTRV-ALM-STS1. Table D-3. MX2820 STS-1 MUX Alarm Data Entity Name And Description STS1 Message Type Second Modifier Notification Code Service Affecting (SRVEFF) REPT ALM STS1 CR SA LOS LOP LOF LOMF UEQP SLMP Near end REPT EVT STS1 SC SA TSA Near end NSA AIS-L AIS-P RFI-L RFI-P TIM-P Near end NSA T-CVS T-ESS T-SESS T-SEFS-S T-CVL T-ESL T-SESL T-UASL T-CVP T-ESP T-SESP T-UASP T-PPJC-PDET T-NPJC-PDET Near end, Quarterly, Daily T-CV-LFE T-ES-LFE T-SES-LFE T-UAS-LFE T-CV-PFE T-ES-PFE T-SES-PFE T-UAS-PFE Far end, Quarterly, Daily TC 61186003L1-35D Condition Type <CONDTYPE> Location D-5 MX2820 System TL1 Reference Guide Table D-3. MX2820 STS-1 MUX Alarm Data (Continued) Entity Name And Description VT DS1 Equipment Message Type Second Modifier Notification Code Service Affecting (SRVEFF) Condition Type <CONDTYPE> Location REPT ALM VT1 MJ SA LOP-V UNEQ-V SLM-V Near end REPT EVT VT1 SC NSA AIS-V RFI-V Near end TC NSA T-CV-V T-ES-V T-SES-V T-UAS-V Near end, Quarterly, Daily T-CV-VFE T-ES-VFE T-SES-VFE T-UAS-VFE Far end, Quarterly, Daily REPT ALM T1 MJ SA LOS Near end REPT EVT T1 SC SA NSA NSA NSA TSA XCV AIS AIS-NTWK Near end TC NSA T-CVL T-ESL T-SESL T-LOSS-L T-AISS-P Near end, Quarterly, Daily MN* CR NSA SA EQPT Near end MN* CR NSA SA IMPROPRMVL Near end MN NSA CONTCOM CLK-LOA Near end SC NSA WKSWPR ESW Near end REPT ALM REPT EVT EQPT EQPT * This alarm will be reported as either Minor, Non-Service Affecting or Critical, Service Affecting depending on whether protection is available. D-6 61186003L1-35D Appendix D, Alarms and Alarm Condition Codes - MX2820 Clock Card Alarms MX2820 CLOCK CARD ALARMS Table D-4 provides the alarms for the MX2820 Clock Card. The alarms in this table are for transmission type EQPT (rr=EQPT). The applicable TL1 command is RTRV-ALM-EQPT. Table D-4. MX2820 Clock Card Alarm Data Entity Name And Description Equipment Message Type REPT ALM REPT EVT Second Modifier Notification Code Service Affecting (SRVEFF) EQPT MJ NSA HO Near end MN NSA EQPT CONTCOM Near end Near end MN* CR NSA SA IMPROPRMVL Near end Near end MN NSA PRIFAIL SECFAIL Near end Near end SC NSA WKSWPR ESW Near end Near end EQPT Condition Type <CONDTYPE> Location * This alarm will be reported as either Minor, Non-Service Affecting or Critical, Service Affecting depending on whether protection is available. 61186003L1-35D D-7 MX2820 System TL1 Reference Guide This page is intentionally blank. D-8 61186003L1-35D Appendix E Autonomous Messages INTRODUCTION This appendix provides information about autonomous messages. Autonomous messages are generated automatically by alarm conditions or events that occur at NEs. The ALW-MSG TL1 command allows the sending of autonomous messages to the OS/user. The INH-MSG TL1 command inhibits or prevents the sending of autonomous messages to the OS/user. SYNTAX An autonomous message for the MX2820 System has the following format: <cr> <lf> <lf> ^^^<source identifier>^<date>^<time> <cr> <lf> <almcde>^<atag>^<verb>[^<modifier> [^modifier>]] <cr> <lf> ^^^"<aid>:<message parameter>" <cr> <lf> Table E-1 provides parameter (field) descriptions for autonomous messages. Table E-1. Autonomous Messages Parameter Descriptions Parameter Description <cr> Carriage return <lf> Line feed Caret (^) Represents one space character <source identifier> The Shelf CLLI code <date> Date in the form YY-MM-DD <time> Time in the form HH-MM-SS <almcde> Alarm code. The alarm code indicates the severity of the autonomous 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 Table E-1. Autonomous Messages Parameter Descriptions (Continued) Parameter Description <atag> Autonomously Generated Correlation Tag (ATAG). The ATAG is a decimal number assigned by the NE. The ATAG must be sequential and must be included in all autonomous messages. The ATAG allows an OS/user to determine if the OS has failed to receive any Autonomous outputs by checking for omissions in the sequence of messages received. <verb>[^modifier>[^modifier>]] Identifies the nature of the autonomous output and allows for quick identification of the semantics of the information in the text block. It consists of up to three valid TL1 identifiers separated 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 second modifier specifies the object generating the message. Certain modifiers (for example, EQPT) mean that the <AID> parameter, if it exists, is addressing a particular type of entity in the NE. <message block> Detailed data related to the specific alarm or report. ALARMS Autonomous alarms are sent only when users are currently logged onto the system, and only after the users have entered an “ALW-MSG-xx” command to enable sending the alarms. The xx field can be “ALL” or a specific transmission level such as T1. Another field in the command, the <specific data block> field, can select all alarm categories or a specific alarm such as MAJOR. A companion command, “INH-MSG-xx” inhibits all or selected types of messages. The effects are cumulative such that a user could allow all alarms, and then inhibit only the MINOR alarms. Once a user logs off the system, the autonomous alarms cease. There is no specified or provisionable TL1 session-timeout period. If a user is logged into a TL1 account, the account remains active until the user explicitly logs out or the session is terminated (for example, TL1 over Telnet session closed, or X.25 connection lost). E-2 61186003L1-35D Appendix E, Autonomous Messages - SCU SCU In systems where INE mode CLIENT shelves are chained to a HOST SCU, and the user desires autonomous alarms from the INE clients to be reported through the HOST, each INE CLIENT shelf must be sent an ACT-USER, an ALW-MSG-xx by the user, and the user must remain logged in to enable autonomous alarms from the CLIENT shelf. If the client shelves are in EXPANSION mode, the client shelves are managed under the TID of the HOST SCU, and the TL1 session and autonomous message activation is only required on the HOST SCU. The SCU generates “Card Removed” alarm events when a card is inserted or removed. If the card is removed while its service state is provisioned for Out-of-Service (OOS), the SCU assigns an alarm level of INFO to the active alarm event. When a card is inserted, the SCU assigns a level to the cleared event corresponding to the level of any previous active event if present. Otherwise, the SCU assigns the alarm with the level that was provisioned for the “Card Removed” alarm. If a line card is removed with ACTIVE alarms, the SCU will automatically issue a CLEAR alarm event for all active alarms. EVENTS Events are a variety of alarms which have a severity of MINOR. The format of the detailed data is slightly different than that of the alarms in that the condition code and status fields are reversed. PERFORMANCE MONITORING REPORTS Autonomous Performance Monitoring (PM) reports can be generated as a result of a SCHED-PMREPT-rr command. CONDITION CODES Condition codes are assigned to identify specific reasons for the alarm or event. Refer to the Alarms and Alarm Condition Codes” Appendix in this document for information about the condition codes generated by the circuit cards in a MX2820 shelf. 61186003L1-35D E-3 MX2820 System TL1 Reference Guide AUTONOMOUS MESSAGE EXAMPLES M13 MUX Alarms The following examples are autonomous messages for alarms that apply to a DS3 MUX card. Command Response from Network Element REPT^ALM 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\"" ; *C 03-11-19 11:28:03 241 REPT ALM T3 "1-T3-MUX3-1:CR,LOS,SA,11-19,11-28-03,NEND,,,,:\"DS3 LOS\"" ; Corresponding Clears Example: A 03-11-19 11:28:42 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. Command Response from Network Element REPT^EVT M13 MUX Alarm Response Example: 03-11-19 11:28:36 A 242 REPT EVT T3 "1-T3-MUX3-1:RAI,SC,11-19,11-28-36,NEND,,,,:\"DS3 RAI\"" ; A 03-11-19 11:28:52 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. Command Response from Network Element REPT^ALM^ENV 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 A 03-11-19 11:31:34 253 REPT ALM ENV "1-ENV-1:CL,AUX1,11-19,11-31-34,\"AUX #1 INPUT\"" ; 03-11-19 11:32:29 A 255 REPT ALM ENV "1-ENV-3:CL,AUX3A,11-19,11-32-29,\"AUX #3A INPUT\"" ; E-6 61186003L1-35D Appendix F Performance Monitoring Codes This appendix provides performance monitoring information for the M13 and STS-1 Multiplexer modules. MONTYPE values for the RTRV-PM-rr commands are listed in Figure F-1 and Figure F-2. M13 MUX Table F-1. M13 MUX Performance Monitoring MONTYPE Values Interval MONTYPE Value T3 Performance Monitoring rr Value = T3 Quarterly & Daily Near-End SESL LOSS-L ESP-P SESP-P SAS-P UASP-P UASCP-P CVL CVP-P ESL CVCP-P ESCP-P SESCP-P Quarterly & Daily Far-End ESCP-PFE SESCP-PFE CVCP-PFE UASCP-PFE 61186003L1-35D F-1 MX2820 System TL1 Reference Guide Table F-1. M13 MUX Performance Monitoring MONTYPE Values Interval MONTYPE Value T1 Performance Monitoring rr = T1 Quarterly & Daily Near-End CVL ESL SESL LOSS-L AISS-P For P/N 1186002L3 Only: CVL-LS ESL-LS SESL-LS LOSS-L-LS CVP-LS ESP-LS SESP-LS UASP-LS AISS-P-LS CVP-HS ESP-HS SESP-HS UASP-HS AISS-P-HS F-2 61186003L1-35D Appendix F, Performance Monitoring Codes - STS-1 MUX STS-1 MUX Table F-2. STS-1 MUX Performance Monitoring MONTYPE Values Interval MONTYPE Value STS1 Performance Monitoring rr = STS1 Quarterly & Daily Near-End CVS ESS SESS SEFS-S CVL ESL SESL UASL CVP ESP SESP UASP PPJC-PDET NPJC-PDET Quarterly & Daily Far-End CV-LFE ES-LFE SES-LFE UAS-LFE CV-PFE ES-PFE SES-PFE UAS-PFE 61186003L1-35D F-3 MX2820 System TL1 Reference Guide Table F-2. STS-1 MUX Performance Monitoring MONTYPE Values (Continued) Interval MONTYPE Value VT Performance Monitoring rr = VT1 Quarterly & Daily Near-End CV-V ES-V SES-V UAS-V Quarterly & Daily Far-End CV-VFE ES-VFE SES-VFE UAS-VFE T1 Performance Monitoring rr = T1 Quarterly & Daily Near-End CVL ESL SESL LOSS-L AISS-P F-4 61186003L1-35D Appendix G MX2820 Service States INTRODUCTION The purpose of this section is to describe the functionality of the service states of the MX2820 System. The service state entities defined for the MX2820 modules follow a hierarchy as illustrated in Figure G-1. Each entity has a Provisioned Service State and an Operational (Functional) Service State. The Provisioned Service State for a given entity can be set to In-Service (IS) or OOS. As with other provisioning items, the Provisioned Service State values for all entities are saved to nonvolatile 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 operational state. To help clarify such questions, all tables should generally be read from the top down in an “If-Else” fashion. Criteria Monitored for an Entity In general, criteria that are monitored for a given state of a given entity are specific to that entity. For example, when the diagram or service state table for the DS1 #3 facility OOS-MA state indicates that it monitors for “Fault - SA”, it is implied that it refers only to serviceaffecting faults specific to DS1 #3. 61186003L1-35D G-1 MX2820 System TL1 Reference Guide SCU and Clock Modules Entity Hierarchy EQUIPMENT M13 MUX Module Entity Hierarchy DS1/E1 FACILITY #1 EQUIPMENT Parent DS3 FACILITY Child DS1/E1 FACILITY #2 Parent DS1/E1 FACILITY #28 Child STS-1 MUX Module Entity Hierarchy VT PATH #1 EQUIPMENT Parent EC-1/STS-1 FACILITY Child VT PATH #2 Parent VT PATH #28 Child Parent CROSS-CONNECT DS1/E1 FACILITY #1 DS1/E1 FACILITY #2 DS1/E1 FACILITY #28 Child Figure G-1. MX2820 System Service State Hierarchy G-2 61186003L1-35D Appendix G, MX2820 Service States - Introduction Definition of AINS Criteria The term AINS stands for “Automatic In-Service” and applies to any DS1/E1 facility whose Traditional State is Auto-enabled. This term is used to describe the criteria that must be met to bring the facility out of the OOS-AU FLT, AINS state. The AINS criteria generally require that a DS1/E1 facility must be out of a LOS condition continuously for a specified length of time. The user sets this length of time with the “autoenable delay” feature. Definitions of Available and Unavailable The terms “available” and “unavailable” apply to the M13 and STS-1 modules to distinguish DS1/E1 facility and VT path entities that can and cannot be used when the product is provisioned for E1 mode. For the M13 module, each of the seven DS2 channels can be independently provisioned for either T1 or E1 mode operation. For any DS2 channel operating in T1 mode, all four DS1 facilities of that DS2 are “available”. For any DS2 channel operating in E1 mode, the first three E1 facility entities are “available” and the fourth entity is “unavailable”. For the STS-1 module, all seven VT groups are provisioned together for either T1 or E1 mode operation. When operating in T1 mode, all 28 VT path entities and all 28 DS1 facility entities are “available”. When operating in E1 mode, VT path entities 22-28 and DSX facility entities 22-28 are “unavailable” and the remaining entities are “available”. Recursive alarm suppression When any parent entity is managed out of service, alarms are in turn suppressed for all of the parent's child entities. This behavior is implemented such that, in general, when a parent entity is in any operational state that suppresses alarms, the operational states of all of the parent's child entities are set to OOS-AUMA, SGEO, regardless of the provisioned service states of the child entities. When the parent entity is managed in-service, the parent's child entities in turn transition to the appropriate states and allow or suppress alarms normally per their own provisioning and conditions. An example of this behavior is that when the equipment provisioned service state of the M13 module is set to OOS, the DS3 operational state then transitions to OOS-AUMA, SGEO, which in turn causes the DS1 operational states to follow suit. The provisioned service states of the DS3 and DS1/E1 entities remain unchanged, and alarm reporting for all entities is suppressed. Traditional States The term “Traditional State” applies to the M13 and STS-1 modules to refer to the “T1/E1 State” feature that has been and is presently supported in all multiplexer products of the MX2800/MX2820 product family. 61186003L1-35D G-3 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. Backward Compatibility with Traditional States The service state features of the MX2820 M13 and STS-1 modules are designed both to coexist with and to be backward compatible with the Traditional States. Generally, the service state features of the MX2820 modules are designed to be transparent to users who do not make use of service states. The default provisioned service state is in-service (IS) for all entities. The user can leave the entities provisioned in-service at all times and expect the product to function no differently than before service state support was implemented. A consequence of the backward compatibility with Traditional States is some degree of departure from some traditional service state behaviors as they are described in GR-1093. An example of such a departure involves provisioning and maintenance activities. The GR1093 standard generally states that updates of provisioning data and the performance of maintenance activities should not be permitted for entities that have assumed certain service states. The MX2820 M13 and STS-1 mux modules are designed to allow the user to perform such activities independently of the provisioned and functional service states of any entity. G-4 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Equipment OPERATIONAL SERVICE STATE MODEL FOR EQUIPMENT Independent Equipment Service States Each module keeps a record of its own provisioned and operational equipment service states as well as those of its mate module (if applicable) (refer to Figure G-2). The provisioned service state of the equipment entity for each module can be set to IS or OOS independently of the settings of its mate module. If operating non-redundantly, the provisioned service state for the absent stand-by module can be provisioned as either IS or OOS. Its value will reside on the active module and will automatically be applied to the mate module (if applicable) when and if it is installed. This is a limited but necessary form of pre-provisioning due to the need for an independent equipment service state for each module. The operational service state of an absent stand-by module that resides on the active module is E6 (OOS-AUMA UAS, UEQ). Indication of the Active Module Due to the nature of the equipment service states, the operational service state of the equipment entity alone cannot reliably indicate which module in a redundant pair is active and which is stand-by. ED:IS State E3 OOS-MA State E6 OOS-AUMA UAS, UEQ Flt SA No Flt SA; Flt NSA ED:OOS All Flt Recovered All Flt Recovered State E1a IS ACT State E4a OOS-AUMA FLT Protection Switch Flt SA No Flt SA; Flt NSA ED:IS ED:IS ED:OOS State E1b IS STBYH State E4b OOS-MA FLT Flt SA All Flt Recovered State E5a OOS-AU FLT ED:OOS Flt SA State E5b IS-ANR No Flt SA; Flt NSA All Flt Recovered No Flt SA; Flt NSA Figure G-2. Equipment Service States 61186003L1-35D G-5 MX2820 System TL1 Reference Guide State E1a: IS ACT Description: The card is installed and is performing its intended functions. Provisioned State: IS On Entry to State: Allow alarms for this entity. Table G-1 shows the state transitions. Table G-1. State E1a: IS ACT Event Action or Condition Next State TL1 DENY:SNVS --- EDIT:IS None --- EDIT:OOS None E3 SW-TOPROTN and card is A None E1b SW-TOPROTN and card is B. TL1 DENY:SNVS --- SW-TOWKG and card is A TL1 DENY:SNVS --- SW-TOWKG and card is B None E1b Fault SA None E5a No Fault SA; Fault NSA None E5b All faults clear None --- ENT,DLT 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 State E1b: IS STDBYH Description: The card is installed and would be performing its intended functions if it were not the standby card. Provisioned State: IS On Entry to State: Suppress alarms for this entity. Table G-2 shows the state transitions. Table G-2. State E1b: IS STDBYH Event Action or Condition Next State TL1 DENY:SNVS --- EDIT:IS None --- EDIT:OOS None E3 TL1 DENY:SNVS --- Active Card None E1a Fault SA None E5a No Fault SA; Fault NSA None E5b All faults clear None --- ENT,DLT SW State E3: OOS-MA Description: The card is manually provisioned out-of-service. No equipmentlevel fault conditions are present. Provisioned State: OOS On Entry to State: Suppress alarms for this entity. Table G-3 shows the state transitions. Table G-3. State E3: OOS-MA Event Action or Condition Next State TL1 DENY:SNVS --- EDIT:IS and active card None E1a EDIT:IS and standby card None E1b EDIT:OOS None --- Fault SA None E4a No Fault SA; Fault NSA None E4b All faults clear None --- ENT,DLT 61186003L1-35D G-7 MX2820 System TL1 Reference Guide State E4a: OOS-AUMA FLT Description: The card is manually provisioned out-of-service and presently has one or more service affecting equipment-level fault conditions present. Provisioned State: OOS On Entry to State: Suppress alarms for this entity. Table G-4 shows the state transitions. Table G-4. State E4a: OOS-AUMA FLT Event Action or Condition Next State TL1 DENY:SNVS --- EDIT:IS None E5a EDIT:OOS None --- Fault SA None – No Fault SA; Fault NSA None E4b All faults clear None E3 ENT,DLT State E4b: OOS-MA FLT Description: The card is manually provisioned out-of-service and presently has one or more non-service affecting and no service-affecting equipment-level fault conditions present. Provisioned State: OOS On Entry to State: Suppress alarms for this entity. Table G-5 shows the state transitions. Table G-5. State E4b: OOS-MA FLT Event Action or Condition Next State TL1 DENY:SNVS --- EDIT:IS None E5b EDIT:OOS None --- Fault SA None E4a No Fault SA; Fault NSA None – All faults clear None E3 ENT,DLT G-8 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Equipment State E5a: OOS-AU FLT Description: The card presently has one or more service affecting equipmentlevel fault conditions present. Provisioned State: IS On Entry to State: Allow alarms for this entity. Table G-6 shows the state transitions. Table G-6. State E5a: OOS-AU FLT Event Action or Condition Next State TL1 DENY:SNVS --- EDIT:IS None – EDIT:OOS None E4a Fault SA None – No Fault SA; Fault NSA None E5b If Active card E1a Else If Standby card E1b ENT,DLT All faults clear State E5b: IS-ANR Description: The card has one or more non-service affecting and no service affecting equipment-level fault conditions for this entity present. Provisioned State: IS On Entry to State: Allow alarms for this entity. Table G-7 shows the state transitions. Table G-7. State E5b: IS-ANR Event Action or Condition Next State TL1 DENY:SNVS --- EDIT:IS None – EDIT:OOS None E4b Fault SA None E5a No Fault SA; Fault NSA None – If Active card E1a Else If Standby card E1b ENT,DLT All faults clear 61186003L1-35D G-9 MX2820 System TL1 Reference Guide State E6: OOS-AUMA UAS, UEQ Description: This is the operational state that the active module assigns to its stand-by module when it is not detected by the active module. Provisioned State: IS or OOS On Entry to State: No action Table G-8 shows the state transitions. Table G-8. State E5b: IS-ANR Event Install module G-10 Action or Condition Next State None E1b 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities OPERATIONAL SERVICE STATE MODEL FOR FACILITIES This state applies to the following entities (refer to Figure G-3, Figure G-4, and Figure G-5): • EC-1/STS-1 facility (for the STS-1 module only) • DS3 facility (for the M13 module only) • DS1/E1 facilities (for both the M13 and STS-1 modules) The Network Facility The DS3 facility entity (for the M13 module) and the EC-1/STS-1 facility entity (for the STS-1 module) are herein described as the “network facility”. Network Facility vs. DS1/E1 Facility Behavior All of the facility service states apply for all DS1/E1 facility entities for both the M13 and STS1 mux modules. The network facility for both products follows the same state behavior as DS1/E1 facilities, but are always considered to have a traditional state of Enabled (AINS criteria are satisfied). Therefore some service state transitions will not apply for the network facility entity. Special Note about the EC-1/STS-1 Facility For the STS-1 module, the EC-1 interface can never carry anything other than an STS-1 path payload. For that reason, and also for simplicity of design, a single facility entity is defined for the network interface instead of the definition of two separate entities for an EC-1 facility and an STS-1 path entity. 61186003L1-35D G-11 MX2820 System TL1 Reference Guide ED:OOS F3a (OOS-AUMA FLT) State F7a OOS-AU FLT Supporting Entity Outage No Flt SA; Flt NSA All Flt Recovered ED:OOS State F7b IS-ANR Flt SA (OOS-MA FLT) Supporting Entity Outage All Flt Recovered Flt SA State F6 OOS-AU SGEO ED:OOS Supporting Entity Suppresses Alarms F8 Supporting Entity Restored and... Flt SA No Flt SA; Flt NSA F3b Supporting Entity Outage No Flt SA; Flt NSA State F5 IS-ACT ED:OOS F7a F2 (OOS-AU FLT) (OOS-MA) F7b (IS-ANR) (OOS-AUMA SGEO) All Flt Recovered F5 (IS-ACT) Figure G-3. Facility Service States, Provisioned Service State = IS G-12 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities F7a (OOS-AU FLT) ED:IS State F3a OOS-AUMA FLT Supporting Entity Outage All Flt Recovered No Flt SA; Flt NSA State F3b OOS-MA FLT Flt SA Supporting All Flt Entity Recovered Outage Flt SA State F8 OOS-AUMA SGEO Facility is Provisioned IS and Supporting Entity Allows Alarms and... F4 AINS Criteria Not Satisfied Facility is Provisioned OOS and Supporting Entity Restored and... Flt SA (OOS-AU FLT, AINS) F6 Supporting Entity Outage No Flt SA; Flt NSA (OOS-AU SGEO) All Flt Recovered F7b (IS-ANR) No Flt SA; Flt NSA State F2 OOS-MA ED:IS and... AINS Criteria Not Satisfied F3a F4 (OOS-AU FLT, AINS) (OOS-AUMA FLT) AINS Criteria Satisfied ED:IS AINS Criteria Satisfied F3b F5 (OOS-MA FLT) (IS-ACT) F2 (OOS-MA) Figure G-4. Facility Service States, Provisioned Service State = OOS 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: ENT:IS or ENT:OOS Results in Changing Tradtional State to Enabled State F1b OOS-MA UAS No Supporting Entity Outage Enabled or Auto-enabled F5 (IS-ACT) Supporting Entity Outage F6 (OOS-AU SGEO) AINS Criteria Satisfied, and... Disabled Any Facility that is Unavailable is Considered to be Disabled Change of Facility Traditional State Facility is Provisioned IS and AINS Criteria is NOT Satisfied State F4 OOS-AU ED:IS FLT, AINS and... ED: OOS and... Supporting Entity Outage F8 (OOS-AUMA SGEO) DLT (Sets to Disabled) No Supporting Entity Outage F2 (OOS-MA) Any State Figure G-5. Other Facility Service States, Traditional State G-14 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities Change of Facility Traditional State Description: The following transitions apply whenever the Traditional State of the facility is changed. Below is a description of how each change should be handled. Table G-9 shows the state transitions. Table G-9. Change of Facility Traditional State Event Action or Condition Next State Provisioned IS and AINS criteria NOT satisfied None F4 Disabled None F1b NOTE The traditional states of the DS3 or EC-1/STS-1 facilities are considered to always be Enabled (AINS criteria satisfied). NOTE Note: For DS3 and EC-1/STS-1 facilities, a TL1 DENY:SNVS response is returned due to a DLT command. The DLT command is valid only for DS1/E1 facilities. State F1a: OOS-AUMA UAS Description: This facility is not available and does not pass data. Provisioned State: IS or OOS On Entry to State: Suppress alarms for this entity. Table G-10 shows the state transitions. Table G-10. State F1a: OOS-AUMA UAS Event Action or Condition Next State None F1b ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled --- EDIT:IS TL1 DENY:SNVS --- EDIT:OOS TL1 DENY:SNVS --- Facility becomes available 61186003L1-35D G-15 MX2820 System TL1 Reference Guide State F1b: OOS-MA UAS Description: This facility is available but its Traditional State is disabled. The facility does not pass data. Provisioned State: IS or OOS On Entry to State: Suppress alarms for this entity. Table G-11 shows the state transitions. Table G-11. State F1b: OOS-MA UAS Event Action or Condition Next State None F1a ENT TL1 DENY:SNVS --- DLT None --- EDIT:IS TL1 DENY:SNVS --- EDIT:OOS TL1 DENY:SNVS --- Enabled None F4 Auto-enabled None F4 Disabled None --- Facility becomes unavailable G-16 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities State F2: OOS-MA Description: The facility has been manually provisioned out of service and no fault conditions are present for the entity. Provisioned State: OOS On Entry to State: Suppress alarms for this entity. Table G-12 shows the state transitions. Table G-12. State F2: OOS-MA Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b If AINS criteria not satisfied F4 Else If Enabled F5 Else --- EDIT:OOS None --- Supporting Entity Outage None F8 Fault SA None F3a No Fault SA; Fault NSA None F3b All faults clear None --- EDIT:IS 61186003L1-35D G-17 MX2820 System TL1 Reference Guide State F3a: OOS-AUMA FLT Description: The facility is provisioned OOS and at least one service affecting fault condition for this facility is present. Provisioned State: OOS On Entry to State: Suppress alarms for this entity. Table G-13 shows the state transitions. Table G-13. State F3a: OOS-AUMA FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b EDIT:IS None F7a EDIT:OOS None --- Supporting Entity Outage None F8 Fault SA None --- No Fault SA; Fault NSA None F3b All faults clear None F2 G-18 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities State F3b: OOS-MA FLT Description: The facility is provisioned OOS and at least one non-service affecting and zero service affecting fault conditions for this facility is present. Provisioned State: OOS On Entry to State: Suppress alarms for this entity. Table G-14 shows the state transitions. Table G-14. State F3b: OOS-MA FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b EDIT:IS None F7b EDIT:OOS None --- Supporting Entity Outage None F8 Fault SA None F3a No Fault SA; Fault NSA None --- All faults clear None F2 61186003L1-35D G-19 MX2820 System TL1 Reference Guide State F4: OOS-AU FLT, AINS Description: AINS criteria are not satisfied. Provisioned State: IS On Entry to State: Suppress alarms and reset the AINS timer for this entity. Monitor conditions per AINS criteria. Table G-15 shows the state transitions. Table G-15. State F3b: OOS-MA FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b None --- If SGEO Present F8 Else F2 None F8 If SGEO Present F6 Else F5 EDIT:IS EDIT:OOS Supporting Entity Suppresses Alarms AINS Criteria Satisfied G-20 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities State F5: IS-ACT Description: The facility is provisioned IS and no fault conditions are present for this facility. Provisioned State: IS On Entry to State: Allow alarms for this entity. Table G-16 shows the state transitions. Table G-16. State F5: IS-ACT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b EDIT:IS None --- EDIT:OOS None F2 Supporting Entity Outage None F6 Fault SA None F7a No Fault SA; Fault NSA None F7b All faults clear None --- 61186003L1-35D G-21 MX2820 System TL1 Reference Guide State F6: OOS-AU SGEO Description: The facility's supporting entity is in an outage. Provisioned State: IS On Entry to State: Allow alarms for this entity. Table G-17 shows the state transitions. Table G-17. State F6: OOS-AU SGEO Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b EDIT:IS None --- EDIT:OOS None F8 Supporting Entity Suppresses Alarms None F8 If Fault SA F7a Else if Fault NSA F7b Else F5 None --- Supporting Entity Restored from Outage Condition Supporting Entity Outage G-22 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities State F7a: OOS-AU FLT Description: The facility is provisioned IS and at least one service affecting fault condition for this facility is present. Provisioned State: IS On Entry to State: Allow alarms for this entity. Table G-18 shows the state transitions. Table G-18. State F7a: OOS-AU FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b EDIT:IS None --- EDIT:OOS None F3a Supporting Entity Outage None F6 Fault SA None --- No Fault SA; Fault NSA None F7b All faults clear None F5 61186003L1-35D G-23 MX2820 System TL1 Reference Guide State F7b: IS-ANR Description: The facility is provisioned IS and at least one non-service affecting and zero service affecting fault conditions for this facility are present. Provisioned State: IS On Entry to State: Allow alarms for this entity. Table G-19 shows the state transitions. Table G-19. State F7a: OOS-AU FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b EDIT:IS None --- EDIT:OOS None F3b Supporting Entity Outage None F6 Fault SA None F7a No Fault SA; Fault NSA None --- All faults clear None F5 G-24 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for Facilities State F8: OOS-AUMA SGEO Description: 1. The facility is provisioned OOS and the supporting entity is in an outage. or 2. The facility is provisioned IS and its supporting entity suppresses alarms. Provisioned State: IS or OOS On Entry to State: Suppress alarms for this entity. Table G-20 shows the state transitions. Table G-20. State OOS-AUMA SGEO Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT Set Traditional State to Disabled F1b If AINS Criteria NOT Satisfied F4 Else if Enabled F6 Else --- If Fault SA F3a Else If Fault NSA F3b Else F2 Entity is provisioned IS and supporting entity allows alarms Entity is provisioned OOS and Supporting Entity Restored from Outage Condition 61186003L1-35D G-25 MX2820 System TL1 Reference Guide OPERATIONAL SERVICE STATE MODEL FOR VT PATHS This state applies to the following entities (refer to Figure G-6, Figure G-7, and Figure G-8): • VT1.5/VT2 entities (for the STS-1 module only) Operation in T1 mode When the product is provisioned for T1 mode, all seven VT groups in the STS-1 path are configured to each carry four VT1.5 paths. All 28 VT path entities are available and all 28 DS1/E1 facility entities are available. Any available VT1.5 path can be uniquely crossconnected 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. ED:OOS P3a (OOS-AUMA FLT) State P7a OOS-AU FLT Supporting Entity Outage No Flt SA; Flt NSA All Flt Recovered ED:OOS State P7b IS-ANR State P6 OOS-AU SGEO ED:OOS Supporting Entity Suppresses Alarms P8 Supporting Entity Restored and... Flt SA No Flt SA; Flt NSA (OOS-MA FLT) Flt SA Supporting All Flt Entity Recovered Outage Flt SA Supporting Entity Outage P3b No Flt SA; Flt NSA State P5 IS-ACT ED:OOS P7a P2 (OOS-AU FLT) (OOS-MA) P7b (IS-ANR) (OOS-AUMA SGEO) All Flt Recovered P5 (IS-ACT) Figure G-6. VT Service States, Provisioned Service State = IS G-26 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for VT Paths ED:IS P7a (OOS-AU FLT) State P3a OOS-AUMA FLT Supporting Entity Outage All Flt Recovered No Flt SA; Flt NSA State P3b OOS-MA FLT Flt SA Supporting All Flt Entity Recovered Outage ED:IS and Supporting Entity Allows Alarms State P2 OOS-MA Supporting Entity Outage ED:IS ED:OOS and Supporting Entity Restored and... Flt SA P7b (IS-ANR) No Flt SA; Flt NSA Flt SA State P8 OOS-AUMA SGEO ED:IS P3a (OOS-AUMA FLT) No Flt SA; Flt NSA P6 (OOS-AU SGEO) P3b P5 (OOS-MA FLT) (IS-ACT) All Flt Recovered P2 (OOS-MA) Figure G-7. VT Service States, Provisioned Service State = OOS State P1a OOS-AUMA UAS Any VT that is Unavailable is Considered to be Unequipped Any State (except P1a) Unavailable Unequipped Equipped and Attached DS1/E1 is Disabled Available State P4 OOS-MA SDEA State P1b OOS-MA UAS Equipped Attached DS1/E1 is Enabled or Auto-enabled P2 (OOS-MA) Figure G-8. Other VT Service States 61186003L1-35D G-27 MX2820 System TL1 Reference Guide Effects of the Traditional State for an Attached DS1/E1 Facility The transitions shown in Table G-21 apply whenever the traditional state of the port is changed. Below is a description of how each change should be handled. Table G-21. Transition Conditions Current Condition Action or Condition Next State VT is equipped and the attached DS1/E1 facility is Disabled VT is provisioned IS P1b VT is provisioned OOS P1b VT is provisioned IS P5 VT is provisioned OOS P2 VT is equipped and AINS conditions are not satisfied for the attached DS1/E1 facility 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 inservice). G-28 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for VT Paths State P1a: OOS-AUMA UAS Description: This VT is not available, and therefore is not cross-connected to a DS1/E1 facility. The VT does not pass data. Provisioned State: IS or OOS On Entry to State: Suppress alarms for this VT. Table G-22 shows the state transitions. Table G-22. State P1a: OOS-AUMA UAS Event Action or Condition Next State None P4 ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- ENT-CRS TL1 DENY:SNVS --- EDIT:IS TL1 DENY:SNVS --- EDIT:OOS TL1 DENY:SNVS --- VT becomes available 61186003L1-35D G-29 MX2820 System TL1 Reference Guide State P1b: OOS-MA UAS Description: This VT is available but is cross-connected to a DS1/E1 facility whose traditional state is Disabled. The VT does not pass data. Provisioned State: IS or OOS On Entry to State: Suppress alarms for this VT. Table G-23 shows the state transitions. Table G-23. State P1b: OOS-MA UAS Event Action or Condition Next State VT becomes unequipped None P4 VT is equipped with a DS1/E1 facility whose traditional state is not Disabled. None P2 VT is equipped with a DS1/E1 facility whose traditional state is Disabled. None --- ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- ENT-CRS TL1 DENY:SNVS --- EDIT:IS TL1 DENY:SNVS --- EDIT:OOS TL1 DENY:SNVS --- G-30 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for VT Paths State P2: OOS-MA Description: This VT is available and cross-connected to a DS1/E1 facility. The VT has been manually provisioned out of service and no fault conditions are present for the VT. Provisioned State: OOS On Entry to State: Suppress alarms for this VT. Table G-24 shows the state transitions. Table G-24. State P2: OOS-MA Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 EDIT:IS None P5 EDIT:OOS None --- Supporting Entity Outage None P8 Fault SA None P3a No Fault SA; Fault NSA None P3b All faults clear None --- 61186003L1-35D G-31 MX2820 System TL1 Reference Guide State P3a: OOS-AUMA FLT Description: This VT is available and cross-connected to a DS1/E1 facility. The VT is provisioned OOS and at least one service affecting fault condition for this VT is present. Provisioned State: OOS On Entry to State: Suppress alarms for this VT. Table G-25 shows the state transitions. Table G-25. State P3a: OOS-AUMA FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 EDIT:IS None P7a EDIT:OOS None --- Supporting Entity Outage None P8 Fault SA None --- No Fault SA; Fault NSA None P3b All faults clear None P2 G-32 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for VT Paths State P3b: OOS-MA FLT Description: This VT is available and cross-connected to a DS1/E1 facility. The VT is provisioned OOS and at least one non-service affecting and no service affecting fault conditions for this VT is present. Provisioned State: OOS On Entry to State: Suppress alarms for this VT. Table G-26 shows the state transitions. Table G-26. State P3b: OOS-MA FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 EDIT:IS None P7b EDIT:OOS None --- Supporting Entity Outage None P8 Fault SA None P3a No Fault SA; Fault NSA None --- All faults Clear None P2 61186003L1-35D G-33 MX2820 System TL1 Reference Guide State P4: OOS-MA, SDEA Description: The VT is available but is not cross-connected to a DS1/E1 facility. Provisioned State: IS or OOS On Entry to State: Suppress alarms for this VT. Table G-27 shows the state transitions. Table G-27. State P4: OOS-MA, SDEA Event Action or Condition Next State None P1a ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- None P2 TL1 DENY:SNVS --- None --- VT becomes unavailable VT becomes equipped EDIT:IS EDIT:OOS G-34 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for VT Paths State P5: IS-ACT Description: This VT is available and cross-connected to a DS1/E1 facility. The VT is provisioned IS and no fault conditions are present for this VT. Provisioned State: IS On Entry to State: Allow alarms for this VT. Table G-28 shows the state transitions. Table G-28. State P5: IS-ACT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 EDIT:IS None --- EDIT:OOS None P2 Supporting Entity Outage None P6 Fault SA None P7a No Fault SA; Fault NSA None P7b All faults clear None --- 61186003L1-35D G-35 MX2820 System TL1 Reference Guide State P6: OOS-AU SGEO Description: This VT is available and cross-connected to a DS1/E1 facility. The VT's supporting entity is in an outage. Provisioned State: IS On Entry to State: Allow alarms for this VT. Table G-29 shows the state transitions. Table G-29. State P6: OOS-AU SGEO Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 EDIT:IS None --- EDIT:OOS None P8 Supporting entity suppresses alarms None P8 If Fault SA P7a Else if Fault NSA P7b Else P5 None --- Supporting Entity Restored Supporting Entity Outage G-36 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for VT Paths State P7a: OOS-AU FLT Description: This VT is available and cross-connected to a DS1/E1 facility. The VT is provisioned IS and at least one service affecting fault condition for this VT is present. Provisioned State: IS On Entry to State: Allow alarms for this VT. Table G-30 shows the state transitions. Table G-30. State P7a: OOS-AU FLT Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 EDIT:IS None --- EDIT:OOS None P3a Supporting Entity Outage None P6 Fault SA None --- No Fault SA; Fault NSA None P7b All faults clear None P5 61186003L1-35D G-37 MX2820 System TL1 Reference Guide State P7b: IS-ANR Description: This VT is available and cross-connected to a DS1/E1 facility. The VT is provisioned IS and at least one non-service affecting and no service affecting fault conditions for this VT are present. Provisioned State: IS On Entry to State: Allow alarms for this VT. Table G-31 shows the state transitions. Table G-31. State P7b: IS-ANR Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 EDIT:IS None --- EDIT:OOS None P3b Supporting Entity Outage None P6 Fault SA None P7a No Fault SA; Fault NSA None --- All faults clear None P5 G-38 61186003L1-35D Appendix G, MX2820 Service States - Operational Service State Model for VT Paths State P8: OOS-AUMA SGEO Description: This VT is available and cross-connected to a DS1/E1 facility. In addition: 1. The VT is provisioned OOS and the supporting entity is in an outage. or 2. The VT is provisioned IS and its supporting entity suppresses alarms. Provisioned State: IS or OOS On Entry to State: Suppress alarms for this VT. Table G-32 shows the state transitions. Table G-32. State P8: OOS-AUMA SGE Event Action or Condition Next State ENT TL1 DENY:SNVS --- DLT TL1 DENY:SNVS --- VT becomes unequipped None P4 Entity is provisioned IS and supporting entity allows alarms None P6 Entity is provisioned OOS and Supporting Entity Restored If Fault SA P3a Else If Fault NSA P3b Else P2 61186003L1-35D G-39 MX2820 System TL1 Reference Guide This page is intentionally blank. 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 ® Carrier Networks Division 901 Explorer Blvd. Huntsville, AL 35806