adtranmx2820 tl1 reference manual 61186003l1-35c

204
MX2820 System TL1 Reference Guide Document Number - 61186003L1-35C ® 61186003L1-35C March 2005

Upload: cborn99

Post on 02-Jan-2016

126 views

Category:

Documents


3 download

DESCRIPTION

AdtranMX2820 TL1 Reference Manual 61186003L1-35C

TRANSCRIPT

Page 1: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 SystemTL1 Reference Guide

Document Number - 61186003L1-35C

®

61186003L1-35CMarch 2005

Page 2: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Reference Guide

TrademarksAny brand names and product names included in this manual are trademarks, registered trademarks, or trade names of their respective holders.

To the Holder of the ManualThe 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 BoulevardP.O. Box 140000

Huntsville, AL 35814-4000(256) 963-8000

©2004 ADTRAN, Inc.All Rights Reserved.

Printed in U.S.A.

®

ii 61186003L1-35C

Page 3: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Reference Guide

Revision History

ConventionsThe following typographical conventions are used in this document:

This font indicates a cross-reference link. First-time references to tables and figures are shown in this font.

THIS FONT indicates keyboard keys (i.e., ENTER, ESC, ALT). Keys that are to be pressed simultaneously are shown with a plus sign (i.e, 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 onscreen 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

NOTENotes inform the user of additional but essential information or features.

CAUTIONCautions inform the user of potential damage, malfunction, or disruptionto equipment, software, or environment.

WARNINGWarnings inform the user of potential bodily pain, injury, or death.

DocumentRevision Date Description of Changes

A November 2003 Initial release

B August 2004 Add STS-1 and Clock Modules and associated commands

C March 2005 Add RADIUS documentation

61186003L1-35C iii

Page 4: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Reference Guide

Federal Communications Commission (FCC) StatementThis equipment generates, uses, and can radiate radio frequency energy and if not installed and used in accordance with the instruction manual, may cause interference to radio communications. It has been tested and found to comply with limits for a Class A digital device pursuant to Subpart B of Part 15 of FCC Rules, which are designed to provide a reasonable protection against such interference when operated in a commercial environment.

This equipment does not exceed Class A limits for radio emission for digital apparatus, set out in the Radio Interference Regulation of the Canadian Department of Communications.

TrainingADTRAN offers training on our most popular products. These courses include overviews on product features and functions while covering applications of ADTRAN’s product lines. ADTRAN provides a variety of training options, including customized training and courses taught at our facilities or at customer sites. For more information about training, please contact us.

Training Phone: 800-615-1176, ext. 7500

Training Fax: 256-963-6700

Training Email: [email protected]

iv 61186003L1-35C

Page 5: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Reference Guide

About This ManualThis manual provides descriptions of TL1 commands for the MX2820 System. The purpose of this manual is to provide the technician and system administrator with general and specific information related to using TL1 commands with the MX2820 System. The following is an overview of the contents:

Section 1 IntroductionProvides an overview of TL1 software and the network equipment that uses TL1 software.

Section 2 TL1 CommandsProvides information about how to use a TL1 command which includes the syntax and the general format of a TL1 command. This section also provides a list of commands that apply to the MX2820 System and provides information about the response messages for TL1 commands.

Section 3 ADTRAN AID FormatsProvides information about ADTRAN-specific formats that are used within the structure of a TL1 command.

Section 4 Common (SCU) TL1 CommandsProvides information about TL1 commands that are used for logging on and logging off the MX2820 System and TL1 commands that apply to the SCU.

Section 5 Provisioning TL1 CommandsProvides information about TL1 commands that are used to provision the Network Elements (NE) for the MX2820 System.

Section 6 Security TL1 CommandsProvides information about TL1 commands that are used to add, delete, and edit security accounts for users that access the MX2820 System.

Section 7 Surveillance TL1 CommandsProvides information about TL1 commands that are used to obtain data from the NEs within the MX2820 System and NEs that interconnect to the MX2820 System.

Section 8 System Maintenance TL1 CommandsProvides information about TL1 commands that are used to perform maintenance tasks for the MX2820 System.

Section 9 System Test TL1 CommandsProvides information about TL1 commands that are used to perform test tasks for the MX2820 System.

Appendix A Input Commands Data DictionaryProvides information about the parameter data used with TL1 Input commands.

61186003L1-35C v

Page 6: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Reference Guide

Appendix B Response Messages Data DictionaryProvides information about parameters received in a response message sent to the Operations System (OS) from an Network Element (NE).

Appendix C Error CodesProvides information about the error codes that may be received in a response message.

Appendix D Alarms and Alarm Condition CodesProvides information about the alarms and alarm condition codes generated by the NEs.

Appendix E Autonomous MessagesProvides information about the Autonomous messages generated at an NE and sent to the OS/user.

Appendix F Performance Monitoring CodesProvides the MONTYPE values for the requested M13 and STS-1 MUX performance monitoring intervals.

Appendix G MX2820 Service StatesDescribes the functionality of the service states of the MX2820 System.

Appendix H List of AbbreviationsProvides a list of abbreviations used in this manual.

vi 61186003L1-35C

Page 7: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Reference Guide

MX2820 System TL1 Command Cross-Reference

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-6 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-9 Surveillance

RTRV-COND 7-12 Surveillance

RTRV-HDR 7-14 Surveillance

RTRV-PM-rr 7-16 Surveillance

SCHED-PMREPT-rr 7-27 Surveillance

RTRV-PMSCHED-rr 7-19 Surveillance

RTRV-SYS 7-21 Surveillance

RTRV-TH-rr 5-6 Provisioning

RTRV-USER-SECU 6-8 Security

RTRV-VER 7-23 Surveillance

RTRV-VERSION 7-25 Surveillance

SET-DAT 4-7 Common

SET-TH-rr 5-8 Provisioning

SW-TOPROTN-rr 8-2 System Maintenance

SW-TOWKG-rr 8-4 System Maintenance

61186003L1-35C vii

Page 8: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Reference Guide

This page is intentionally blank.

viii 61186003L1-35C

Page 9: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Contents

Section 1Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

1. Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12. TL1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Transport Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1TL1 Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1TL1 Message Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

3. Operations Support System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24. SCU Client Management Modes of Operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-35. Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Section 2TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12. Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13. Notations and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14. General Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Target Identifier (TID) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3SCU Client Management Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

INE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3Expansion Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

Common Language Location Identifier (CLLI) . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35. Acknowledgment Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

Acknowledgment Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46. Normal Response Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47. MX2820 System TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

ADTRAN TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68. User Account Requirements (Access Privileges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6

Section 3ADTRAN AID Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12. SCU Operation Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

SCU Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Intelligent Network Element (INE) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Expansion Shelf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

3. AID Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Section 4Common (SCU) TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12. ACT-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

61186003L1-35C ix

Page 10: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Contents MX2820 System

Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

RADIUS Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Challenge response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

3. CANC-USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

4. MENUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

5. SET-DAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Section 5Provisioning TL1 Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12. ED-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

3. RTRV-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

x 61186003L1-35C

Page 11: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Contents

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

4. RTRV-TH-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

5. SET-TH-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-8Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

6. Transmission Entity Data Parameter Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10

Section 6Security TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12. DLT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

3. ED-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

4. ENT-USER-SECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7

5. RTRV-USER-SECU. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8

61186003L1-35C xi

Page 12: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Contents MX2820 System

Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9

Section 7Surveillance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12. ALW-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2

Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

3. INH-MSG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

4. RTRV-ALM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

Format for no Alarm Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7Format for Alarm Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-7

Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-85. RTRV-ALM-ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9

Environmental Alarm Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-9Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-11

6. RTRV-COND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13

7. RTRV-HDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14

xii 61186003L1-35C

Page 13: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Contents

Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15

8. RTRV-PM-rr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-16Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18

9. RTRV-PMSCHED-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-19Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-20

10. RTRV-SYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-21Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-22

11. RTRV-VER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23

Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-23Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-24

12. RTRV-VERSION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-25Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-26

13. SCHED-PMREPT-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-27Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-28

61186003L1-35C xiii

Page 14: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Contents MX2820 System

Section 8System Maintenance TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12. SW-TOPROTN-rr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

3. SW-TOWKG-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Minimum User Access Privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4

Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5

Section 9System Test TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12. OPR-LPBK-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-3

3. RLS-LPBK-rr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4Input Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4Input Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4

Acknowledgment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4Normal Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4Error Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5

Appendix AInput Commands Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Appendix BResponse Messages Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Appendix CError Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

xiv 61186003L1-35C

Page 15: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Contents

Appendix DAlarms and Alarm Condition Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-12. SCU Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-13. M13 MUX Card Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-34. STS-1 MUX Card Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-55. MX2820 CLOCK Card Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-7

Appendix EAutonomous Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-12. Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-13. Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-24. SCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-35. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-36. Performance Monitoring Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-37. Condition Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-38. Autonomous Message Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4

M13 MUX Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4Command Response from Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4Corresponding Clears . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-4

Threshold Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5Command Response from Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5M13 MUX Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-5

Environmental Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-6Command Response from Network Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-6Alarm Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-6

Appendix FPerformance Monitoring Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-1

1. M13 Mux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-22. STS-1 MUX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . F-3

Appendix GMX2820 Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1Limitations of Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1Event Priorities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1Criteria Monitored for an Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-1Definition of AINS Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3Definitions of Available and Unavailable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3Recursive alarm suppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3Traditional States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-3

Backward Compatibility with Traditional States . . . . . . . . . . . . . . . . . . . . . . . . . . G-42. Operational Service State Model for Equipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5

Independent Equipment Service States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5Indication of the Active Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-5

State E1a: IS ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-6State E1b: IS STDBYH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7

61186003L1-35C xv

Page 16: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Contents MX2820 System

State E3: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8State E4a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9State E4b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-10State E5a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11State E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-12State E6: OOS-AUMA UAS, UEQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-13

3. Operational Service State Model for Facilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-14The Network Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-14

Network Facility vs. DS1/E1 Facility Behavior . . . . . . . . . . . . . . . . . . . . . . . . . . G-14Special Note about the EC-1/STS-1 Facility . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-14Change of Facility Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-18State F1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-19State F1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-20State F2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-21State F3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-22State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-23State F4: OOS-AU FLT, AINS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-24State F5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-25State F6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-26State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-27State F7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-28State F8: OOS-AUMA SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-29

4. Operational Service State Model for VT Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-30Operation in T1 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-30Operation in E1 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-30Effects of the Traditional State for an Attached DS1/E1 Facility . . . . . . . . . . . . . . . G-32

Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-32State P1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-33State P1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-34State P2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-35State P3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-36State P3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-37State P4: OOS-MA, SDEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-38State P5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-39State P6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-40State P7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-41State P7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-42State P8: OOS-AUMA SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-43

Appendix HList of Abbreviations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . H-1

xvi 61186003L1-35C

Page 17: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Tables

Tables

Table 1-1. MX2820 Network Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3Table 2-1. TL1 Input Command General Format Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-2Table 2-2. TL1 Response Message Format Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-4Table 2-3. MX2820 TL1 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-5Table 3-1. 19-Inch Chassis AID Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2Table 3-2. 23-Inch Chassis AID Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-2Table 3-3. MX2820 AID Parameter Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3-3Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning Parameters

AID: 1-EQPT-SCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-10Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning Parameters

AID:1-EQPT-(MUX1-MUX9)-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-13Table 5-3. DS3 MUX (P/N 1186002Lx) T3 Data Provisioning Parameters

AID: 1-T3-(MUX1-MUX9)-1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-18Table 5-4. DS3 MUX (P/N 1186002Lx) T1 Data Provisioning Parameters

AID: 1-T1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-20Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning Parameters

AID:1-EQPT-(MUX1-MUX9)-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-21Table 5-6. STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning Parameters

AID: 1-STS1-(MUX1-MUX9)-1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-26Table 5-7. STS-1 MUX (P/N 1186005Lx) VT Data Provisioning Parameters

AID: 1-VT1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-28Table 5-8. STS-1 MUX (P/N 1186005Lx) T1 Data Provisioning Parameters

AID: 1-T1-(MUX1-MUX9)-(1-28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-28Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning Parameters

AID: 1-EQPT-CLK-(A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5-30Table A-1. TL1 Input Commands Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Table B-1. TL1 Response Messages Data Dictionary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1Table C-1. MX2820 System Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1Table D-1. MX2820 SCU Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1Table D-2. MX2820 M13 MUX Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-3Table D-3. MX2820 STS-1 MUX Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-5Table D-4. MX2820 Clock Card Alarm Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-7Table E-1. Autonomous Messages Parameter Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-1Table F-1. M13 MUX Performance Monitoring MONTYPE Values . . . . . . . . . . . . . . . . . . . . . . . . . . F-2Table F-2. STS-1 MUX Performance Monitoring MONTYPE Values . . . . . . . . . . . . . . . . . . . . . . . . . F-3Table G-1. State E1a: IS ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-6Table G-2. State E1b: IS STDBYH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-7Table G-3. State E3: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-8Table G-4. State E4a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-9Table G-5. State E4b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-10Table G-6. State E5a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-11Table G-7. State E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-12Table G-8. State E5b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-13Table G-9. Change of Facility Traditional State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-18Table G-10. State F1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-19Table G-11. State F1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-20Table G-12. State F2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-21Table G-13. State F3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-22Table G-14. State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-23

61186003L1-35C xvii

Page 18: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Tables MX2820 System

Table G-15. State F3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-24Table G-16. State F5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-25Table G-17. State F6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-26Table G-18. State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-27Table G-19. State F7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-28Table G-20. State OOS-AUMA SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-29Table G-21. Transition Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-32Table G-22. State P1a: OOS-AUMA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-33Table G-23. State P1b: OOS-MA UAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-34Table G-24. State P2: OOS-MA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-35Table G-25. State P3a: OOS-AUMA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-36Table G-26. State P3b: OOS-MA FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-37Table G-27. State P4: OOS-MA, SDEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-38Table G-28. State P5: IS-ACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-39Table G-29. State P6: OOS-AU SGEO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-40Table G-30. State P7a: OOS-AU FLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-41Table G-31. State P7b: IS-ANR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-42Table G-32. State P8: OOS-AUMA SGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . G-43

xviii 61186003L1-35C

Page 19: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 1Introduction

1. PURPOSEThis 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).

2. TL1 OVERVIEWTL1 software provides an ASCII-based protocol that allows the exchange of messages between an Opera-tions 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 MethodsThe 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 will indicate that the connection was made and will describe the MENUS command. The second is a raw connection that will not send anything upon connection.

TL1 SessionsThe maximum number of TL1 logon sessions at one time depends on the physical and logical interfaces to the MX2820 System 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-35C 1-1

Page 20: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 1, Introduction MX2820 System

TL1 Message TypesThe 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.

3. OPERATIONS SUPPORT SYSTEMAn 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 Network Elements that exchange messages with the OS’s host computer.

1-2 61186003L1-35C

Page 21: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Introduction, Section 1

4. SCU CLIENT MANAGEMENT MODES OF OPERATIONSIf 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.

5. NETWORK ELEMENTSThe MX2820 System supports and/or provides the Network Elements shown in Table 1-1.

Note: Additional products may be available. Refer to www.adtran.com for a complete list.

6. REFERENCESFor more information, including details on each list series, refer to the MX2820 System Manual (Document Number 61186003L1-1).

Table 1-1. MX2820 Network Elements

Network Element Part Number

System Controller Unit 1186003Lx

DS3 MUX 1186002Lx

Clock Card 1186004Lx

STS-1 MUX 1186005Lx

61186003L1-35C 1-3

Page 22: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 1, Introduction MX2820 System

This page is intentionally blank.

1-4 61186003L1-35C

Page 23: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 2TL1 Commands

1. INTRODUCTIONThis Section provides information about the TL1 commands for the MX2820 System.

2. SYNTAXThe 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.

NOTEThe carriage return does not indicate the end of a TL1 command.

NOTEThe BACKSPACE and DELETE keys are nonfunctional when entering TL1commands. To abort a command, press CTRL+X.

3. NOTATIONS AND CONVENTIONSThe 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.

61186003L1-35C 2-1

Page 24: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 2, TL1 Commands MX2820 System

4. GENERAL FORMATA 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.

NOTEThe MX2820 System does not output an error message for data entries ina 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> Refer to the “Target Identifier (TID)” on page 2-3 subsection.

<aid> 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 com-mand 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 com-mand 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 com-mand sections and to applicable data dictionary appendices in this document for additional information.

: Field separator

; TL1 command terminator. The command terminator may be used after the last non-empty field without supplying the remaining colon separators.

2-2 61186003L1-35C

Page 25: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Commands, Section 2

Target Identifier (TID)The TID parameter indicates the end-target NE for a TL1 command. The client management mode of operation for the SCU may have an impact on the value for this field. The following subsection provides additional information.

NOTEIf the SCU functions as the host network management unit, the clientmanagement 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.

Expansion Shelf

Up to thirty-two SCUs can share a common TID for systems operating in the “Expansion Shelf” mode. TL1 commands route to the appropriate SCU based on the shelf number in the <aid> field.

Common Language Location Identifier (CLLI)The CLLI code is often used as the TID in TL1 commands. The CLLI code is one- to twenty-alphanumeric characters that are not case sensitive. The CLLI code identifies physical locations and equipment such as buildings, central offices, antennae, channel banks, and shelves. CLLI codes are also used as unique identi-fiers for a single NE. CLLI codes are assigned at the OS. The following example provides a CLLI code.

Example

HTVLALEXD16

Where:

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.

61186003L1-35C 2-3

Page 26: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 2, TL1 Commands MX2820 System

16 The last two numeric characters represent a unique identifier number for a specific central office. These characters identify which NE is being addressed.

5. ACKNOWLEDGMENT RESPONSESIf an NE cannot send a normal response or an error response to the OS/user within 2 seconds of receiving a TL1 command, the NE sends an acknowledgment response of IP.

Acknowledgment SyntaxThe syntax for the acknowledgment responses supported by the MX2820 System are as follows:

NOTEThis symbol (<) represents the TL1 ready indicator.

IP[^<CTAG>] <cr> <lf> <

6. NORMAL RESPONSE MESSAGESThe 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 mes-sage.

<source identifier> The Source Identifier (SID) identifies the shelf “Target Identifier (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

2-4 61186003L1-35C

Page 27: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System TL1 Commands, Section 2

7. MX2820 SYSTEM TL1 COMMANDSTable 2-3 provides TL1 command categories for the MX2820 System.

<time> The Time field is in the form HH-MM-SS.• HH indicates hour and ranges from 00 to 23• MM indicates minutes and ranges from 00 to 59• SS indicates seconds and ranges from 00 to 59

<ctag> The Correlation Tag (CTAG) corresponds to the CTAG from the TL1 input com-mand.

<code> The Code field indicates the transaction status for the TL1 input command.• COMPLD indicates normal completion.• DENY indicates an error condition.

<error_code> The Error Code appears after a DENY condition. Refer to “Appendix C, 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.

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 RLS-LPBK-rr

MENUS SET-TH-rr ENT-USER-SECU RTRV-ALM

SET-DAT RTRV-TH-rr RTRV-USER-SECU RTRV-ALM-ENV

RTRV-COND

RTRV-HDR

RTRV-PM-rr

RTRV-PMSCHED-rr

RTRV-SYS

RTRV-VER

RTRV-VERSION

SCHED-PMREPT-rr

Table 2-2. TL1 Response Message Format Descriptions (Continued)

Field or Symbol Description

61186003L1-35C 2-5

Page 28: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 2, TL1 Commands MX2820 System

ADTRAN TL1 CommandsThe following TL1 commands are ADTRAN-specific commands:

• “MENUS” on page 4-6

• “RTRV-VER” on page 7-23

• “RTRV-VERSION” on page 7-25

8. 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) may be disabled.

TL1 login accounts (TL1 sessions) require use of the ACT-USER command to access the system.

2-6 61186003L1-35C

Page 29: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 3ADTRAN AID Formats

1. INTRODUCTIONThis section provides information about ADTRAN AID formats for the MX2820 System.

2. SCU OPERATION MODEThe operation mode for the SCU may affect how and when the Access Identifier (AID) parameter is entered for the TL1 commands. In addition, a Network Element (NE) entity, such as the card type, being targeted by the TL1 command may affect the AID parameter.

SCU UnitHow the SCU functions in the network management configuration determines whether the client manage-ment 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 (INE)If the SCU operates in the INE mode, the shelf number for the AID parameter in a TL1 command is always one (1). 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 (1).

Expansion ShelfIf 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-35C 3-1

Page 30: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 3, ADTRAN AID Formats MX2820 System

3. AID STRUCTUREThe AID parameter for the MX2820 System consists of a hierarchy-based format that includes the follow-ing data separated by dashes: the shelf number, the category type, and one or two additional entries. The terms “unit” or “bank” may 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 (1). 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.

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-1. 19-Inch Chassis AID Inputs

Shelf Category Entity 1 Entity 2

1 to 254 T3 MUX1 to MUX7 1

STS1

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 UnitB = Protect UnitCLK

SCU N/A

ENV 1 to 5 N/A

Table 3-2. 23-Inch Chassis AID Inputs

Shelf Category Entity 1 Entity 2

1 to 254 T3 MUX1 to MUX9 1

STS1

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 CardB = Protect CardCLK

SCU N/A

ENV 1 to 5 N/A

3-2 61186003L1-35C

Page 31: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System ADTRAN AID Formats, Section 3

Table 3-3 provides some examples of AID parameters.

The TL1 command sections and the data dictionaries in the appendices also contain information about the AID parameter.

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

61186003L1-35C 3-3

Page 32: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 3, ADTRAN AID Formats MX2820 System

This page is intentionally blank.

3-4 61186003L1-35C

Page 33: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 4Common (SCU) TL1 Commands

1. INTRODUCTIONThe 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-6

• “SET-DAT” on page 4-7

61186003L1-35C 4-1

Page 34: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 4, Common (SCU) TL1 Commands MX2820 System

2. ACT-USERThe 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 PrivilegeNONE

Input FormatACT-USER:[<TID>]:<UID>:[<CTAG>]::<PID>;

Example:

ACT-USER:HTVLALEXD16:USER1:1::PASSWORD1;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (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 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

AcknowledgmentIP^<CTAG> <cr> <lf><

Example:

IP 1<

4-2 61186003L1-35C

Page 35: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Common (SCU) TL1 Commands, Section 4

Normal Response<cr> <lf> <lf>^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>M^^<ctag>^COMPLD <cr> <lf>;

Example:

HTVLALEXD16 02-05-30 13:28:03M 1 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

RADIUS AuthenticationLogin through TL1 occurs through the use of the ACT-USER command. When RADIUS authentication is enabled, this command works as with local authentication.

Input FormatACT-USER::<username>:::<password>;

If the username or password is enclosed in quotation marks it is treated as a case-sensitive string. Other-wise, all of the characters present are shifted to upper case. If the username or password contains a quota-tion mark, it must be doubled in the command string in order to prevent unwanted string termination.

Example:

Login: AdMiNPassword: PaSs”WoRd

The proper command to login with the above combination is as follows:

ACT-USER::”AdMiN”:::”PaSs””WoRd”;

Challenge responseIf 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-35C 4-3

Page 36: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 4, Common (SCU) TL1 Commands MX2820 System

3. CANC-USERThe CANC-USER (Cancel-User) command terminates a TL1 session.

Minimum User Access PrivilegeREADONLY

Input FormatCANC-USER:[<TID>]::[<CTAG>];

Example:

CANC-USER:HTVLALEXD16::5;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example:

IP 5<

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

Example:

HTVLALEXD16 02-05-30 16:36:54M 5 COMPLD ;

4-4 61186003L1-35C

Page 37: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Common (SCU) TL1 Commands, Section 4

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-35C 4-5

Page 38: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 4, Common (SCU) TL1 Commands MX2820 System

4. MENUSThe 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 PrivilegeREADONLY

Input FormatMENUS:[<TID>];

Example:

MENUS:HTVLALEXD16;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

Response Format

AcknowledgmentThe NE does not send an acknowledgment response for the MENUS command.

Normal ResponseThe 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.

4-6 61186003L1-35C

Page 39: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Common (SCU) TL1 Commands, Section 4

5. SET-DATThe SET-DAT (Set-Date) command sets the date and time for the SCU.

Minimum User Access PrivilegeADMIN

Input FormatSET-DAT:[<TID>]::[<CTAG>]::[YY-MM-DD][<,HH-MM-SS>];

Example:

SET-DAT:HTVLALEXD16::32::02-06-03,11-32-00;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (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

AcknowledgmentThe NE does not send an acknowledgment response for this TL1 command.

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

Example:

HTVLALEXD16 02-06-03,11-32-00M 32 COMPLD;

61186003L1-35C 4-7

Page 40: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 4, Common (SCU) TL1 Commands MX2820 System

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-8 61186003L1-35C

Page 41: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5Provisioning TL1 Commands

1. INTRODUCTIONThe Provisioning TL1 commands for the MX2820 System allow reconfiguration of a Network Element (NE). The Provisioning TL1 commands for the MX2820 System include:

• “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-35C 5-1

Page 42: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

2. ED-RRThe ED-rr command instructs the NE to change parameters associated with one or more facilities (trans-mission entities) for the specified AID type.

For the MX2820 System, the supported rr modifiers include the following:

• EQPT

• T1

• T3

• STS1

• VT1

Minimum User Access PrivilegeREADWRITE

Input FormatED-rr:[<TID>]:<AID>:[<CTAG>]::[:[<specific data block>][:<state block>]];

Example

ED-T3:HTVLALEXD16:1-T1-MUX3-7::::DSXSTATE=ENABLE:OOS;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

<specific data block> For parameters that apply to the ED-rr command, refer to the “Transmission Entity Data Parameter Tables” on page 5-10.

<state block> The state parameters provide information about the entity's ability to perform its service functions. Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

5-2 61186003L1-35C

Page 43: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf> <

Example

IP 9<

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

Example

HTVLALEXD16 02-05-30 16:48:47M 9 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 5-3

Page 44: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

3. RTRV-RRThe RTRV-rr (Retrieve-rr) command retrieves data parameters and state parameters for an NE entity.

For the MX2820 System, the supported rr modifiers include the following:

• EQPT

• T1

• T3

• STS1

• VT1

NOTEThe AID parameter for the RTRV-rr command supports the ALL value.ALL is the default value for the AID parameter.

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-rr:[<TID>]:[<AID>]:[<CTAG>][:::<specific data block>];

Example

RTRV-EQPT:HTVLALEXD16::30:::CRAFT-BAUD;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

<specific data block> Refer to the “Transmission Entity Data Parameter Tables” on page 5-10 for parameters that apply to the ED-rr command.

5-4 61186003L1-35C

Page 45: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

Response Format

AcknowledgmentIP^ <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

HTVALEXD16 03-11-22 11:09:22M 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-35C 5-5

Page 46: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

4. RTRV-TH-RRThe 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 may apply to one or more equipment units or facilities.

The MX2820 System supports the following rr modifiers:

• T1

• T3

• STS1

• VT1

Input FormatRTRV-TH-rr:[<tid>]:<aid>:[<ctag>][::[<montype>],[<locn>][,<tmper>]];

Example

RTRV-TH-T1::1-T1-MUX6-1:::CVL-HT,NEND,1-DAY;

Input ParametersTID The “Target Identifier (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 Access Identifier (AID) indicates the entity or location of the entity within the targeted NE. For applicable AIDs, refer to “Section 3, ADTRAN AID Formats”.

CTAG The Correlation Tag (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 associ-ated performance monitoring value (refer to “Appendix F, Perfor-mance Monitoring Codes”) with “-HT” appended to the end. For example, the MONTYPE for the threshold for the T1 loss-of-signal is “LOSS-L-HT”.

LOCN The Location (LOCN). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

TMPER The Time Period (TMPER) parameter. Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

5-6 61186003L1-35C

Page 47: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

Response Format

Normal Response<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>M^^<ctag>^COMPLD <cr> <lf><rspblk> + ;

The <rspblk> has the following format:

^^^"<aid>[,<aidtype>]:<montype>,[<locn>],[<dirn>],<thlev>[,<tmper>]" <cr> <lf>

The normal response must contain at least one occurrence of <rspblk>. It is allowed to contain multiple <rspblk>s if applicable.

Example

HTVALEXD16 03-11-22 11:22:02M 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-35C 5-7

Page 48: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

5. SET-TH-RRThe SET-TH-rr (Set-Threshold) command instructs an NE to set the threshold level for a monitored param-eter that, when exceeded, can trigger an automatic message. The threshold level may 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 FormatSET-TH-rr:[<tid>]:<aid>:[<ctag>]::<montype>,<thlev>,<locn>,,<tmper>;

Example

SET-TH-T1::1-T1-MUX6-1:::CVL-HT,5,NEND,,1-DAY;

Input ParametersTID The “Target Identifier (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 Access Identifier (AID) indicates the entity or location of the entity within the targeted NE. For applicable AIDs, refer to “Section 3, ADTRAN AID Formats”.

CTAG The Correlation Tag (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 associ-ated performance monitoring value (refer to “Appendix F, Perfor-mance Monitoring Codes”) with “-HT” appended to the end. For example, the MONTYPE for the threshold for the T1 loss-of-signal is “LOSS-L-HT”.

THLEV The Threshold Level (THLEV) parameter indicates the threshold value that applies to the PM (MONTYPE) parameter. For applicable values, refer to the “Transmission Entity Data Parameter Tables” on page 5-10.

5-8 61186003L1-35C

Page 49: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

LOCN The Location (LOCN). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

TMPER The Time Period (TMPER) parameter. Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

Normal Response<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>M^^<ctag>^COMPLD <cr> <lf>;

Example

HTVALEXD16 03-11-22 11:35:28M 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-35C 5-9

Page 50: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

6. TRANSMISSION ENTITY DATA PARAMETER TABLESTable 5-1 through Table 5-4 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 include the following:

• EQPT

• STS1

• T1

• T3

• VT1

Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning ParametersAID: 1-EQPT-SCU

Parameter Options Description

CRAFT_BAUD 9600192003840057600115200

This parameter is used to set the craft port baud rate.

ETH_RATE AUTO10 MBPS100 MBPS

This parameter is used to set the Ethernet port's data rate.

I-BANKMODE HOSTCLIENT

This parameter selects whether the shelf will serve as a cli-ent or host in the interbank communication protocol.

AUX1LVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for an AUX 1 alarm.

AUX2LVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for an AUX 2 alarm.

AUX3ALVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for an AUX 3A alarm.

Note: Defaults are in bold type.

5-10 61186003L1-35C

Page 51: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

AUX3BLVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for an AUX 3B alarm.

PWRALVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for a PWR A alarm.

PWRBLVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for a PWR B alarm.

REM_LVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for a Service Affecting card removal alarm.

NSA_REM_LVL INFOALERTMINORMAJORCRITICAL

This parameters sets the reported alarm level for a Non-Ser-vice Affecting card removal alarm.

AUX1AID 1 - 16 (1) This parameters sets the AID index for AUX1.

AUX2AID 1 - 16 (2) This parameters sets the AID index for AUX2.

AUX3AAID 1 - 16 (3) This parameters sets the AID index for AUX3A.

AUX3BAID 1 - 16 (3) This parameters sets the AID index for AUX3B.

PWRAAID 1 - 16 (4) This parameters sets the AID index for PWRA.

PWRBAID 1 - 16 (5) This parameters sets the AID index for PWRB.

AUTO_LOGOFF DISABLEENABLE

This parameter enables/disables the auto logoff functionality.

AUTO_LOGOFF_TIME 1 - 60 (30) This parameters set how long it takes for autologoff to kick in if it is enabled.

ALARM_CHRON DESCENDING ASCENDING

This parameter sets the order alarms are displayed in the alarm log.

Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning ParametersAID: 1-EQPT-SCU (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-11

Page 52: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

ETH_LINK_STAT DOWNUPERROR

This read only parameters indicates the state of the Ethernet link.

ETH_ENABLE DISABLEENABLE

This parameter allows the Ethernet port to be enabled/dis-abled.

SS_ENABLE DISABLEENABLE

This parameter allows Smart Start to be enabled/disabled.

TRAP_ENABLE DISABLEENABLE

This parameter allows SNMP traps to be enabled/disabled.

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.

AUX1_DESC 16-character string (AUX #1 INPUT)

This parameter is the condition description of AUX1.

AUX2_DESC 16-character string (AUX #2 INPUT)

This parameter is the condition description of AUX2.

AUX3A_DESC 16-character string (AUX #3A INPUT)

This parameter is the condition description of AUX3A.

AUX3B_DESC 16-character string (AUX #3B INPUT)

This parameter is the condition description of AUX3B.

AUX1_COND_CODE 11-character string (AUX1)

This parameter is the TL1 condition code for AUX1.

AUX2_COND_CODE 11-character string (AUX2)

This parameter is the TL1 condition code for AUX2.

AUX3A_COND_CODE 11-character string (AUX3A)

This parameter is the TL1 condition code for AUX3A.

AUX3B_COND_CODE 11-character string (AUX3B)

This parameter is the TL1 condition code for AUX3B.

PWRA_COND_CODE 11-character string (PWRA)

This parameter is the TL1 condition code for PWRA.

PWRB_COND_CODE 11-character string (PWRB)

This parameter is the TL1 condition code for PWRB.

Table 5-1. SCU (P/N 1186003Lx) EQPT Data Provisioning ParametersAID: 1-EQPT-SCU (Continued)

Parameter Options Description

Note: Defaults are in bold type.

5-12 61186003L1-35C

Page 53: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B)

Parameter Options Description

Read-only

ALARMSEVERITY 0 - 31 Bit assignments are as follows (where logic 1 indicates the condition is present and logic 0 indicates that the condition is not present):Info = Bit 0 (LSB)Alert = Bit 1Minor = Bit 2Major = Bit 3Critical = Bit 4 (MSB)

PROTECTIONMODE NONECIRCUIT

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.

DIAGBERTSYNC NOSYNCSYNC

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.

SWITCHCOUNT 0 - 255 This variable returns the current protection switch count that is used as a basis for the Max Switch Threshold alarm.

Read/Write

ACTIVECARD CARDACARDB

This variable sets/indicates the active module in the module pair.

Note: Defaults are in bold type.

61186003L1-35C 5-13

Page 54: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 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.

DSXCVTHRESHOLD DISABLEONEE3ONEE4ONEE5ONEE6

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.

DSXAUTOENABLE-DELAY

TWOSECONEHRTWOHRSTWELVEHRSONEDAYTWODAYSSEVENDAYS

This variable sets the delay associated with any auto-enabled DS1/E1 interface.

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.

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.

DSXMULTSTATE DISABLEENABLEAUTOENABLE

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.

DSXMULTLINE-CODING

AMIB8ZSHDB3

This variable is used when configuring the line coding set-ting 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 APPLY-MULTLINECODING.

Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

5-14 61186003L1-35C

Page 55: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

DSXMULTLINE-LENGTH

DSX0TO133DSX133TO266DSX266TO399DSX399TO533DSX533TO655

This variable is used when configuring the line length set-ting 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 APPLYMUL-TLINELENGTH.

DSXMULTCKTPROT DISABLEENABLE

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 APPLY-MULTCKTPROT.

DSXMULTLPBK-DETECT

DISABLECSUNIU

This variable is used when configuring the loopback detec-tion setting of multiple DS1/E1 ports. This variable is tem-porary storage for the desired loopback detection setting. This setting is applied to all DS1 ports within the range with APPLYMULTLPBKDETECT.

DSXMULTPRVS-VSTATE

ISOOS

This variable is used when configuring the provisioned ser-vice 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.

EQPTPRVSERVSTATE ISOOS

This variable sets the provisioned service state of the Equip-ment entity.

AUTOSAVE DISABLEENABLE

This variable is used when configuring the Auto-save fea-ture. When enabled, the provisioning is automatically saved to non-volatile memory in response to a change in provi-sioning.

CARDPAIRID 12-character string (MX2820 M13)

This variable is used to identify a particular module pair.

DIAGSELECTBERT-PATT

QRSSALL1ALL0TWOINEIGHTONEINEIGHTTWOTOFIFTEEN-THINV

This variable indicates the number of errors accumulated during a BERT-type test.

Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-15

Page 56: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

DIAGTIMEOUT DISABLEONEMINFIVEMINTENMINFIFTEENMINTHIRTYMINFORTYFIVEMINONEHOUR

This variable indicates the amount of time that a loopback will remain in effect before automatic release of the loop-back occurs.

IPFWDPROTO ADTRANPPP

This variable controls the encapsulation protocol used to carry IP traffic over the DS3 when IP forwarding is in use.

IPFWDMTU MTU260MTU1500

This variable controls the IP MTU used for the IP forward-ing channel. This should be set to the default of 260 bytes in most cases.

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.

APPLYMULT-LINECODING

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

APPLYMULTLINE-LENGTH

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

APPLYMULTCKTPROT 1 a variable to apply the setting of DSXMULTCKTPROT to all DS1/E1 ports within the range indicated by STAR-TRANGE and ENDRANGE

APPLYMULTLPBK-DETECT

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

APPLYMULTDSXSV-STATE

1 This variable applies the setting of DSXMULT-PRVSERVSTATE to all DS1/E1 ports within the range indi-cated by STARTRANGE and ENDRANGE.

CARDRESET 1 Setting this variable forces the card to reboot.

CLEARSWITCH-COUNT

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.

Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

5-16 61186003L1-35C

Page 57: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

LOADFACTORY-DEFAULT

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-vola-tile memory.

DIAGCLEARBERT-COUNT

1 Setting this variable clears the error count during a BERT-type test.

DIAGRESETTESTS 1 Setting this variable releases all loopbacks currently acti-vated.

DIAGINSERTBERTERR 1 Setting this variable inserts one bit error into an active BERT pattern.

DEFAULTALLTHRESH 1 This variable restores all DS3 and DS1/E1 PM thresholds to their default values.

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

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

CLEARALLSTATS 1 This variable clears all DS3 and DS1/E1 PM statistics.

Table 5-2. DS3 MUX (P/N 1186002Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-17

Page 58: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

Table 5-3. DS3 MUX (P/N 1186002Lx) T3 Data Provisioning ParametersAID: 1-T3-(MUX1-MUX9)-1

Parameter Options Description

Read-only

DS3RXFRAMING CBITM13

This variable indicates the framing mode detected on the received DS3 of the card.

DS3STATE NORMALALARMTESTALARMANDTEST

This variable indicates the alarm/test state of the DS3 inter-face 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.

Read/Write

DS3FRAMING CBITM13

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 DISABLEFEACORCBITFEACCBIT

This variable sets the out-of-band loopback command(s) to which the card will respond.

DS3CVTHRESHOLD DISABLEONEE3ONEE4ONEE5ONEE6

This variable sets the DS3 code violation threshold that, when exceeded, sets an associated alarm.

DS3TIMING LOOPLOCAL

This variable sets the transmit-timing mode of the DS3 interface.

LOOPBACK DATAMODELINEDIGITALFENDLINEALLT1

This variable indicates the test state of the DS3 interface.

Note: Defaults are in bold type.

5-18 61186003L1-35C

Page 59: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

NETPRVSERVSTATE ISOOS

This variable sets the provisioned service state of the DS3 facility.

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.

Table 5-3. DS3 MUX (P/N 1186002Lx) T3 Data Provisioning ParametersAID: 1-T3-(MUX1-MUX9)-1 (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-19

Page 60: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

Table 5-4. DS3 MUX (P/N 1186002Lx) T1 Data Provisioning ParametersAID: 1-T1-(MUX1-MUX9)-(1-28)

Parameter Options Description

Read-only

DSXSTATUS OFFOKLOSBPVTESTHOTXCVCAISLAISAUTONA

This variable indicates the status of a T1/E1 interface (con-sistent with what is indicated in the VT-100 Status menu).

Read/Write

DSXSTATE DISABLEENABLEAUTOENABLEUNAVAILABLE

This variable sets the state of a DS1/E1 interface.

DSXLINECODING DSXAMIDSXB8ZSE1AMIE1HDB3UNAVAILABLE

This variable sets the line coding of a DS1/E1 interface.

DSXLINELENGTH DSX0TO133DSX133TO266DSX266TO399DSX399TO533DSX533TO655E10TO6DBUNAVAILABLE

This variable sets the line length setting of the DS1/E1 interface.

DSXSWITCHPROT DISABLEENABLEUNAVAILABLE

This variable enables or disables an automatic protection switch due to a failure of the DS1/E1 interface.

DSXLPBKDETECTION DISABLECSUNIUUNAVAILABLE

This variable enables or disables the detection and response to CSU/NIU loopback commands received from the net-work.

Note: Defaults are in bold type.

5-20 61186003L1-35C

Page 61: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

LOOPBACK DATAMODENETWORKTERMINALDIGITALCODECDS1FEACCSULBKCSUBERTLINEBERTUNAVAILABLENIULBKNIUBERTHSCSULBKHSCSUBERTHSLINEBERTHSNIULBKHSNIUBERT

This variable indicates the test state of a DS1/E1 interface.

T1PRVSERVSTATE ISOOS

This variable sets the provisioned service state of the T1 facility.

Write Only

CLEARPORTSTATS 1 This variable clears all DS1/E1 PM statistics.

Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(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 indi-cates that the condition is not present):Info = Bit 0 (LSB)Alert = Bit 1Minor = Bit 2Major = Bit 3Critical = Bit 4 (MSB)

Note: Defaults are in bold type.

Table 5-4. DS3 MUX (P/N 1186002Lx) T1 Data Provisioning ParametersAID: 1-T1-(MUX1-MUX9)-(1-28) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-21

Page 62: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

PROTECTIONMODE NONECIRCUIT

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.

DIAGBERTSYNC NOSYNCSYNC

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.

PRODSERIALNUM-BER

25-character string The ADTRAN product serial number for the card.

EXTCLKSTATUS PRESENTNOTPRESENT

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.

Read/Write

ACTIVECARD CARDACARDB

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.

Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

5-22 61186003L1-35C

Page 63: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

DSXCVTHRESHOLD DISABLEONEE3ONEE4ONEE5ONEE6

This variable sets the DS1/E1 code violation threshold that, when exceeded, invokes a protection switch to the standby card.

DSXPROTTHRESH-OLD

1 - 28 (1) This variable sets the minimum number of DS1/E1 channels that must fail before an automatic protection switch is invoked.

DSXAUTOENABLE-DELAY

TWOSECONEHRTWOHRSTWELVEHRSONEDAYTWODAYSSEVENDAYS

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 DISABLEENABLEAUTOENABLE

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.

DSXMULTLINE-CODING

AMIB8ZSHDB3

This variable is used when configuring the line coding set-ting 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 APPLY-MULTLINECODING.

DSXMULTLINE-LENGTH

DSX0TO133DSX133TO266DSX266TO399DSX399TO533DSX533TO655

This variable is used when configuring the line length set-ting of multiple DS1 ports. This variable is temporary stor-age for the desired line length setting. This setting is applied to all DS1 ports within the range with APPLYMULTLINE-LENGTH.

Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-23

Page 64: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

DSXMULTCKTPROT DISABLEENABLE

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 APPLY-MULTCKTPROT.

DSXMULTLPBK-DETECT

DISABLECSUNIU

This variable is used when configuring the loopback detec-tion setting of multiple DS1 ports. This variable is tempo-rary storage for the desired loopback detection setting. This setting is applied to all DS1 ports within the range with APPLYMULTLPBKDETECT.

MULTVTHAIRPIN DISABLEENABLE

This variable is used when configuring the VT hairpin loop-back setting of multiple VT paths. This variable is tempo-rary storage for the desired loopback setting. This setting is applied to all VT paths within the range with APPLYMUL-TVTHAIRPIN.

DSXMULTPRVS-VSTATE

ISOOS

This variable is used when configuring the provisioned ser-vice state of multiple DS1 facilities. This variable is tempo-rary storage for the desired service state setting. This setting is applied to all DS1 facilities within the range with APPLY-MULTDSXSVSTATE.

VTMULTPRVSVSTATE ISOOS

This variable is used when configuring the provisioned ser-vice state of multiple VT path entities. This variable is tem-porary storage for the desired service state setting. This setting is applied to all VT paths within the range with APPLYMULTVTSVSTATE.

DIAGTIMEOUT DISABLEONEMINFIVEMINTENMINFIFTEENMINTHIRTYMINFORTYFIVEMINONEHOUR

This variable indicates the amount of time that a loopback will remain in effect before automatic release of the loop-back occurs.

AUTOSAVE DISABLEENABLE

This variable is used when configuring the Auto-save fea-ture. 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.

Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

5-24 61186003L1-35C

Page 65: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

EQPTPRVSERVSTATE ISOOS

This variable sets the provisioned service state of the Equip-ment entity.

VTAISTRANSMIT DISABLEENABLE

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.

APPLYMULTLINE-CODING

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

APPLYMULTLINE-LENGTH

1 This variable applies the setting of DSXMULTLINE-LENGTH 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 STAR-TRANGE and ENDRANGE.

APPLYMULTLPBK-DETECT

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

APPLYMULTVTHAIR-PIN

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 STAR-TRANGE and ENDRANGE.

APPLYMULTDSXSV-STATE

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

LOADFACTORYDE-FAULT

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-vola-tile memory.

CARDRESET 1 Setting this variable forces the card to reboot.

Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-25

Page 66: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

CLEARSWITCH-COUNT

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.

DIAGCLEARBERT-COUNT

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.

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.

Table 5-6. STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning ParametersAID: 1-STS1-(MUX1-MUX9)-1

Parameter Options Description

Read-only

NETSTATE NORMALALARMTESTALARMANDTEST

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 LOOPFREE-RUNEXTERNAL

The current timing source of the transmit timing mode of the EC-1/STS-1 interface. The value of this parameter may or may not be the same as that of the NETTIMING parame-ter.

Note: Defaults are in bold type.

Table 5-5. STS-1 MUX (P/N 1186005Lx) EQPT Data Provisioning ParametersAID:1-EQPT-(MUX1-MUX9)-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

5-26 61186003L1-35C

Page 67: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

EXTCLKSYNCSTATUS STUPRSTNCST2ST3SMCPNODUSNOTAVAILABLE

This variable indicates the clock sync status message decoded from the incoming STS-1 signal.

Read/Write

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.

NETTIMING LOOPFREE-RUNEXTERNAL

This variable sets the transmit-timing mode of the EC-1/STS-1 interface.

LOOPBACK DATAMODELINEDIGITAL

This variable indicates the test state of the EC-1/STS-1 interface.

VTMODE T1E1

This variable is used when configuring the VT mode of the module (T1 or E1).

NETPRVSERVSTATE ISOOS

This variable sets the provisioned service state of the EC1/STS-1 facility.

Write-Only

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

VTMAPPINGMULT-GRP

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.

Table 5-6. STS-1 MUX (P/N 1186005Lx) STS-1 Data Provisioning ParametersAID: 1-STS1-(MUX1-MUX9)-1 (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-27

Page 68: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

Table 5-7. STS-1 MUX (P/N 1186005Lx) VT Data Provisioning ParametersAID: 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 may be 1-28, or 29 for Unequipped.

VTHAIRPIN DISABLEENABLEUNAVAILABLE

This setting configures the VT hairpin loopback setting of a VT path.

VTPRVSERVSTATE ISOOS

This variable sets the provisioned service state of the VT path entity.

Note: Defaults are in bold type.

Table 5-8. STS-1 MUX (P/N 1186005Lx) T1 Data Provisioning ParametersAID: 1-T1-(MUX1-MUX9)-(1-28)

Parameter Options Description

Read/Write

DSXSTATE DISABLEENABLEAUTOENABLEUNAVAILABLENOT MAPPED

This variable sets the state of a DS1/E1 interface.

DSXLINECODING DSXAMIDSXB8ZSE1AMIE1HDB3UNAVAILABLENOT MAPPED

This variable sets the line coding of a DS1/E1 interface.

DSXLINELENGTH DSX0TO133DSX133TO266DSX266TO399DSX399TO533DSX533TO655E10TO6DBUNAVAILABLENOT MAPPED

This variable sets the line length setting of the DS1/E1 interface.

Note: Defaults are in bold type.

5-28 61186003L1-35C

Page 69: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

DSXSWITCHPROT DISABLEENABLEUNAVAILABLENOT MAPPED

This variable enables or disables an automatic protection switch due to a failure of the DS1/E1 interface.

DSXLPBKDETECTION DISABLECSUNIUUNAVAILABLENOT MAPPED

This variable enables or disables the detection and response to CSU/NIU loopback commands received from the net-work.

LOOPBACK DATAMODENETWORKTERMINALDIGITALCODECCSULBKCSUBERTVTBERTLINEBERTUNAVAILABLE

This variable indicates the test state of a DS1/E1 interface.

T1PRVSERVSTATE ISOOS

This variable sets the provisioned service state of the T1 facility.

Write Only

CLEARPORTSTATS 1 This variable clears all PM statistics for this DS1/E1 and for the attached VT.

Table 5-8. STS-1 MUX (P/N 1186005Lx) T1 Data Provisioning ParametersAID: 1-T1-(MUX1-MUX9)-(1-28) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-29

Page 70: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning ParametersAID: 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 indi-cates that the condition is not present):Info = Bit 0 (LSB)Alert = Bit 1Minor = Bit 2Major = Bit 3Critical = Bit 4 (MSB)

PROTECTIONMODE NONECIRCUIT

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 FREEWALKFASTFREEWALKEXITHOFASTEXITHOLDOVERHOLDOVERNORMALFASTSTATERESETSTATE

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.

Read/Write

Note: Defaults are in bold type.

5-30 61186003L1-35C

Page 71: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Provisioning TL1 Commands, Section 5

ACTIVECARD CARDACARDB

This variable sets/indicates the active module in the module pair.

CARDPAIRID 12-character string(MX2820 SMC)

This variable is used to identify a particular module pair.

PRVACTIVEREF PRIMARYSECONDARY

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 DISABLEENABLE

This variable is used when configuring the Auto-save fea-ture. When enabled, the provisioning is automatically saved to non-volatile memory when a change in provisioning occurs.

PRVEQUIPSERVSTATE ISOOS

This variable sets the provisioned service state of the Equip-ment entity.

AUTOREFSWITCH ENABLEDISABLE

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

AUTOCARDSWITCH ENABLEDISABLE

This variable is used to enable or disable automatic card protection switching.

TIMINGMODE EXTERNALHOLDOVER

This variable sets the clock card to synchronize to either of the external clock references or operate in hold over.

TIMINGTYPE SFESFALLONES

This variable enables and disabled AIS detection on the incoming clock references. It can be used for debugging purposes.

TERMINATIONMODE ENABLEDISABLE

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 termina-tion.

PRICLKALARM ENABLEDISABLE

This variable sets whether the Primary Clock reference failure alarm is enabled or disabled (inhibited).

SECCLKALARM ENABLEDISABLE

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

Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning ParametersAID: 1-EQPT-CLK-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

61186003L1-35C 5-31

Page 72: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 5, Provisioning TL1 Commands MX2820 System

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-vola-tile memory.

CLEARSWITCH-COUNT

1 Setting this variable will reset to zero the protection switch count that is used as a basis for the Max Switch Threshold alarm.

Table 5-9. Clock Card (P/N 1186004Lx) EQPT Data Provisioning ParametersAID: 1-EQPT-CLK-(A or B) (Continued)

Parameter Options Description

Note: Defaults are in bold type.

5-32 61186003L1-35C

Page 73: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 6Security TL1 Commands

1. INTRODUCTIONThe Security TL1 commands allow an administrator to delete, edit, enter (add), and retrieve security infor-mation 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-35C 6-1

Page 74: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 6, Security TL1 Commands MX2820 System

2. DLT-USER-SECUThe DLT-USER-SECU (Delete-User-Security) command allows an administrator to delete the security parameters associated with a user account.

Minimum User Access PrivilegeADMIN

Input FormatDLT-USER-SECU:[<TID>]:<UID>:[<CTAG>];

Example

DLT-USER-SECU:HTVLALEXD16:USER1:8;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

UID The User Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 8<

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

6-2 61186003L1-35C

Page 75: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Security TL1 Commands, Section 6

Example

HTVLALEXD16 02-06-04 09:03:52M 8 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 6-3

Page 76: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 6, Security TL1 Commands MX2820 System

3. ED-USER-SECUThe ED-USER-SECU (Edit-User-Security) command allows an administrator to edit security parameters associated with a user account.

Minimum User Access PrivilegeADMIN

Input FormatED-USER-SECU:[<TID>]:<UID>:[<CTAG>]::,[<NEW PID>],,[<NEW UAP>]:;

Example

ED-USER-SECU:HTVLALEXD16:USER1:10::,PASSWORD2,,4:;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

UID The User Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

NEW PID The new Private Identifier (PID). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

NEW UAP The new User Access Privilege (UAP). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 10<

6-4 61186003L1-35C

Page 77: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Security TL1 Commands, Section 6

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

Example

HTVLALEXD16 02-06-04 15:53:41M 10 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 6-5

Page 78: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 6, Security TL1 Commands MX2820 System

4. ENT-USER-SECUThe 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 PrivilegeADMIN

Input FormatENT-USER-SECU:[<TID>]:<UID>:[<CTAG>]::<PID>,,<UAP>:;

Example

ENT-USER-SECU:HTVLALEXD16:USER1:12::PASSWORD1,,3:;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

UID The User Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

PID The Private Identifier (PID). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

UAP The User Access Privilege (UAP). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 12<

6-6 61186003L1-35C

Page 79: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Security TL1 Commands, Section 6

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

Example

HTVLALEXD16 02-06-04 15:37:00M 12 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 6-7

Page 80: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 6, Security TL1 Commands MX2820 System

5. RTRV-USER-SECUThe 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 PrivilegeADMIN

Input FormatRTRV-USER-SECU:[<TID>]::[<CTAG>];

Example

RTRV-USER-SECU:HTVLALEXD16::27;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command. Refer to the

“Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictio-nary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 27<

Normal Response<cr> <lf> <lf>^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> >lf>M^^<CTAG>^COMPLD <cr> <lf>[^^^"<UID>:<CID>,<UAP>" <cr> <lf>]...^^^"<UID>:<CID>,<UAP>, <login failures>" <cr> <lf>;

6-8 61186003L1-35C

Page 81: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Security TL1 Commands, Section 6

Example

HTVLALEXD16 02-06-04 16:57:20M 27 COMPLD "ADTRAN:0, 0x4b, 0” "ADMIN:1, 0x4b, 0” "READONLY:2, 0x01, 0” "READWRITE:3, 0x03, 0” "TEST:4, 0x0b, 0” "USER1:5, 0x4b, 0”;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 6-9

Page 82: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 6, Security TL1 Commands MX2820 System

This page is intentionally blank.

6-10 61186003L1-35C

Page 83: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7Surveillance TL1 Commands

1. INTRODUCTIONThe 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-9

• “RTRV-COND” on page 7-12

• “RTRV-HDR” on page 7-14

• “RTRV-PM-rr” on page 7-16

• “RTRV-PMSCHED-rr” on page 7-19

• “RTRV-SYS” on page 7-21

• “RTRV-VER” on page 7-23

• “RTRV-VERSION” on page 7-25

• “SCHED-PMREPT-rr” on page 7-27

61186003L1-35C 7-1

Page 84: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

2. ALW-MSGThe ALW-MSG (Allow-Message) command enables a Network Element (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 include the following:

• 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 PrivilegeREADONLY

Input FormatALW-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],;

Example

ALW-MSG-EQPT:HTVLALEXD16::2::MJ,;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

NTFCNCDE The Notification Code (NTFCNCDE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

7-2 61186003L1-35C

Page 85: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf> <

Example

IP 3<

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

Example

HTVLALEXD16 02-05-30 15:43:02M 3 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary for Normal Response and Error Response parameter descriptions.

61186003L1-35C 7-3

Page 86: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

3. INH-MSGThe 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 include the following:

• 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 PrivilegeREADONLY

Input FormatINH-MSG-{EQPT|rr|ALL}:[<TID>]::[<CTAG>]::[<NTFCNCDE>],;

Example

INH-MSG-EQPT:HTVLALEXD16::13::MJ,;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

NTFCNCDE The Notification Code (NTFCNCDE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

7-4 61186003L1-35C

Page 87: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 13<

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

Example

HTVLALEXD16 02-05-30 17:15:51M 13 COMPLD ;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 7-5

Page 88: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

4. RTRV-ALMThe 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 may be used to retrieve NE information, which in turn may 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 may also be used to evaluate the system before or after NE mainte-nance 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 include the following:

• T1

• T3

• STS1

• VT1

Environmental alarms are not expected in response to the RTRV-ALM command. The RTRV-ALM-ENV command retrieves environmental alarms.

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-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 ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

7-6 61186003L1-35C

Page 89: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

NTFCNCDE The Notification Code (NTFCNCDE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

CONDTYPE The Condition Type (CONDTYPE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

SRVEFF The Service Effect (SRVEFF). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

LOCN The Location (LOCN). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 19<

Normal Response

Format for no Alarm Conditions<cr> <lf> <lf>^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>M^^<CTAG>^COMPLD <cr> <lf>;

Format for Alarm Conditions<cr> <lf> <lf>^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>M^^<CTAG>^COMPLD <cr> <lf><rspblk> + ;

<rspblk> has the format:

^^"[<AID>] [,<AIDTYPE>]:<NTFCNCDE>,<CONDTYPE>,<SRVEFF>,[<OCRDAT>],[<OCRTM>],[<LOCN>],[<TMPER>],:[<CONDDESCR>]" <cr> <lf>

Example

HTVLALEXD16 02-10-14 17:13:45M 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\"" ;

61186003L1-35C 7-7

Page 90: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

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-8 61186003L1-35C

Page 91: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

5. RTRV-ALM-ENVThe RTRV-ALM-ENV (Retrieve Alarm Environment) command requests that an NE or office environ-ment monitor retrieve specified, outstanding environmental alarms. The command can be used to retrieve NE information, which in turn may 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 SummaryTable provides an environmental alarm summary for the MX2820 System.

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-ALM-ENV:[<TID>]:[<AID>]:[<CTAG>]::[<NTFCNCDE>][,<ALMTYPE>];

Example

RTRV-ALM-ENV:HTVLALEXD16:1-ENV-1:20::MJ,AUX1;

Table 7-1. MX2820 Environmental Alarm Data

AlarmDefault

AID Index

Default Condition

Code

Default Severity

LevelDescription 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)

61186003L1-35C 7-9

Page 92: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

NTFCNCDE The Notification Code (NTFCNCDE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

ALMTYPE The Alarm Type (ALMTYPE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 20<

Normal ResponseThe 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>

7-10 61186003L1-35C

Page 93: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

Example

HTVLALEXD16 02-05-31 10:36:16M 20 COMPLD "1-ENV-1:MJ,AUX1,05-31,10-35-18";

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 7-11

Page 94: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

6. RTRV-CONDThe 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 include:

• T1

• T3

• STS1

• VT1

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-COND-{EQPT|rr|ALL}:[<TID>]:[<AID>]:[<CTAG>]::[<TYPEREQ>],[<LOCN>],;

Example

RTRV-COND-EQPT:HTVLALEXD16:1-T3-MUX4-1:22::CR,FEND,;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

TYPEREQ The TYPEREQ parameter. Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

LOCN The Location (LOCN). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

7-12 61186003L1-35C

Page 95: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf> <

Example

IP 22<

Normal ResponseIf 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

HTVLALEXD16 02-05-31 10:59:19M 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.

61186003L1-35C 7-13

Page 96: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

7. RTRV-HDRThe 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 PrivilegeREADONLY

Input FormatRTRV-HDR:[<TID>]::[<CTAG>];

Example

RTRV-HDR:HTVLALEXD16::23;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command. Refer to the

“Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictio-nary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 23<

Normal Response<cr> <lf> <lf>^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>M^^<CTAG>^COMPLD <cr> <lf>^^^/* <SW Rev.> */ <cr> <lf>;

7-14 61186003L1-35C

Page 97: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

Example

HTVLALEXD16 02-05-31 11:08:32M 23 COMPLD /*^COL^*/;

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-35C 7-15

Page 98: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

8. RTRV-PM-rrThe 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 MX2820 System supports the follow-ing values for rr:

• T1

• T3

• STS1

• VT1

The data may 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 may also be used to evaluate the system before or after NE maintenance operations.

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-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 ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

MONTYPE The Monitor Type (MONTYPE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

MONLEV The Monitor Level (MONLEV). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

LOCN The Location (LOCN). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

7-16 61186003L1-35C

Page 99: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

TMPER The Time Period (TMPER). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

MONDAT The Monitor Date (MONDAT). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

MONTM The Monitor Time (MONTM). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 24<

Normal ResponseIf 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

HTVLALEXD16 02-05-31 12:02:08M 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";

61186003L1-35C 7-17

Page 100: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

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-35C

Page 101: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

9. RTRV-PMSCHED-RRThe 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 include the following:

• T1

• T3

• STS1

• VT1

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-PMSCHED-{rr|ALL}:[<TID>]:[<AID>]:[<CTAG>];

Example

RTRV-PMSCHED-T3:HTVLALEXD16:1-T3-MUX3-1:25;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

61186003L1-35C 7-19

Page 102: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

Example

IP 25<

Normal ResponseIf 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

HTVLALEXD16 02-05-31 17:05:30M 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-20 61186003L1-35C

Page 103: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

10. RTRV-SYSThe RTRV-SYS (Retrieve System) command provides contact information, the location, and the type of system.

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-SYS:[<TID>]::[<CTAG>];

Example

RTRV-SYS:HTVLALEXD16::26;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<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>;

61186003L1-35C 7-21

Page 104: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

Example

HTVLALEXD16 02-05-31 15:47:20M 26 COMPLD "::CONTACT=WWW.ADTRAN.COM" "::LOCATION=HUNTSVILLECOUNIT1" "::TYPE=MX2820 23-INCH;

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-35C

Page 105: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

11. RTRV-VERThe RTRV-VER (Retrieve Version) command instructs an NE to return its software version.

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-VER:[<TID>]::[<CTAG>];

Example

RTRV-VER:HTVLALEXD16::28;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 28<

Normal Response<cr> <lf> <lf>^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>M^^<CTAG>^COMPLD <cr> <lf>^^^"<SW Rev.>" <cr> <lf>;

Example

HTVLALEXD16 02-05-31 15:52:08M 28 COMPLD "::VERSION=C01";

61186003L1-35C 7-23

Page 106: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

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-35C

Page 107: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

12. RTRV-VERSIONThe RTRV-VERSION (Retrieve Version) command instructs an NE to return its software version.

Minimum User Access PrivilegeREADONLY

Input FormatRTRV-VER:[<TID>]::[<CTAG>];

Example

RTRV-VER:HTVLALEXD16::28;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 28<

Normal Response<cr> <lf> <lf>^^^<SID>^<YY-MM-DD>^<HH:MM:SS> <cr> <lf>M^^<CTAG>^COMPLD <cr> <lf>^^^"<SW Rev.>" <cr> <lf>;

Example

HTVLALEXD16 02-05-31 15:52:08M 28 COMPLD "::VERSION=C01";

61186003L1-35C 7-25

Page 108: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

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-35C

Page 109: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Surveillance TL1 Commands, Section 7

13. SCHED-PMREPT-rrThe 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 MX2820 System supports the following rr values:

• 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 PrivilegeADMIN

Input FormatSCHED-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 ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (AID) identifies the entity within the NE from which data is being retrieved. Refer to “Section 3, ADTRAN AID Formats”, for additional information.

CTAG The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

REPTINVL The Report Interval (REPTINVL). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

REPTSTATM The Report Starting Time (REPTSTATM). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

NUMREPT The Number of Reports (NUMREPT). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

61186003L1-35C 7-27

Page 110: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 7, Surveillance TL1 Commands MX2820 System

MONTYPE The Monitor Type (MONTYPE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

MONLEV The Monitoring Level (MONLEV). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

LOCN The Location (LOCN). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

TMPER The Time Period (TMPER). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

TMOFST The Time Offset (TMOFST). Refer to “Appendix A, Input Commands Data Dictionary” for additional information..

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

Example

IP 31<

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

Example

HTVLALEXD16 02-05-31 17:04:08M 31 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

7-28 61186003L1-35C

Page 111: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 8System Maintenance TL1 Commands

1. INTRODUCTIONThe following System Maintenance TL1 commands apply to theMX2820 system:

• “SW-TOPROTN-rr” on page 8-2

• “SW-TOWKG-rr” on page 8-4

61186003L1-35C 8-1

Page 112: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 8, System Maintenance TL1 Commands MX2820 System

2. SW-TOPROTN-rrThe SW-TOPROTN-rr (Switch-To Protection-rr) command instructs an NE to perform a protection switch.

Minimum User Access PrivilegeREADWRITE

Input FormatSW-TOPROTN-EQPT:[<TID>]:<AID>:[<CTAG>]::,;

Example

SW-TOPROTN-EQPT:HTVLALEXD16:1-EQPT-MUX3-A::,;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<CTAG> <cr> <lf><

8-2 61186003L1-35C

Page 113: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System System Maintenance TL1 Commands, Section 8

Example

IP 33<

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

Example

HTVLALEXD16 02-06-03 11:37:02M 33 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 8-3

Page 114: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 8, System Maintenance TL1 Commands MX2820 System

3. SW-TOWKG-rrThe 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 PrivilegeREADWRITE

Input FormatSW-TOWKG-EQPT:[<TID>]:<AID>:[<CTAG>]::;

Example

SW-TOWKG-EQPT:HTVLALEXD16:1-EQPT-MUX3-B:34::;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIP^<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>;

8-4 61186003L1-35C

Page 115: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System System Maintenance TL1 Commands, Section 8

Example

HTVLALEXD16 02-06-03 11:38:39M 34 COMPLD;

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

Refer to “Appendix B, Response Messages Data Dictionary” for Normal Response and Error Response parameter descriptions.

61186003L1-35C 8-5

Page 116: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 8, System Maintenance TL1 Commands MX2820 System

This page is intentionally blank.

8-6 61186003L1-35C

Page 117: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 9System Test TL1 Commands

1. INTRODUCTIONThe 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-35C 9-1

Page 118: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 9, System Test TL1 Commands MX2820 System

2. OPR-LPBK-RRThe OPR-LPBK-rr (Operate-Loopback) instructs an NE to operate a loopback on a specified facility in the NE. The loop may 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 include the following:

• T1

• T3

• STS1

• VT1

Input FormatOPR-LPBK-rr:[<tid>]:<aid>:[<ctag>]::,,,<lpbktype>;

Example

OPR-LPBK-T3:HTVLALEXD16:1-T3-MUX4-1:25::,,,LINE;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

LPBKTYPE The Loopback Type (LPBKTYPE). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIf 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.

9-2 61186003L1-35C

Page 119: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System System Test TL1 Commands, Section 9

Normal Response<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>M^^<ctag>^COMPLD <cr> <lf>;

Example

HTVLALEXD16 03-01-17 09:39:59M 25 COMPLD;

Error Response<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>M^^<ctag>^DENY <cr> <lf>^^^<errcde> <cr> <lf>(^^^"<error description>" <cr> <lf>) *(^^^/*error text*/ <cr> <lf>) * ;

Refer to “Appendix A, Input Commands Data Dictionary” for input parameter descriptions. Refer to“Appendix B, Response Messages Data Dictionary” for normal response and error response parameterdescriptions.

61186003L1-35C 9-3

Page 120: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 9, System Test TL1 Commands MX2820 System

3. RLS-LPBK-RRThe RLS-LPBK-rr (Release-Loopback) command instructs an NE to release loopback on a specified facil-ity. The loop may 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 include the following:

• T1

• T3

• STS1

• VT1

Input FormatRLS-LPBK-{rr|ALL}:[<tid>]:<aid>:[<ctag>]::,,;

Example

RLS-LPBK-T3:HTVLALEXD16:1-T3-MUX4-1:26::,,;

Input ParametersTID The Target Identifier (TID) identifies the target NE for the command.

Refer to the “Target Identifier (TID)” on page 2-3 for additional information.

AID The Access Identifier (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 The Correlation Tag (CTAG). Refer to “Appendix A, Input Commands Data Dictionary” for additional information.

Response Format

AcknowledgmentIf 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>;

9-4 61186003L1-35C

Page 121: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System System Test TL1 Commands, Section 9

Example:

HTVLALEXD16 03-01-17 09:39:59M 25 COMPLD;

Error Response<cr> <lf> <lf>^^^<rsphdr> <cr> <lf>M^^<ctag>^DENY <cr> <lf>^^^<errcde> <cr> <lf>(^^^"<error description>" <cr> <lf>) *(^^^/*error text*/ <cr> <lf>) * ;

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 parameterdescriptions.

61186003L1-35C 9-5

Page 122: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Section 9, System Test TL1 Commands MX2820 System

This page is intentionally blank.

9-6 61186003L1-35C

Page 123: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix AInput Commands Data Dictionary

1. INTRODUCTIONTable A-1 provides descriptions for the parameters that may 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 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. 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 param-eter. 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, min-utes, and seconds. Each component is specified by two digits.

LOCN The Location parameter indicates the location from which an alarm condition or Perfor-mance Monitoring (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 include the following:

• NEND

• FEND

LPBKTYPE The Loopback Type parameter indicates the type of loopback being set for the transmis-sion entity. Depending on the characteristics of the transmission system, various parts of a signal may be looped back. For example, the LINE loopback may very well be a full metallic loopback, while a PAYLOAD loopback may result in a signal that has been recoded with new and different header and/or CRC information. Other values are pro-vided 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.

61186003L1-35C A-1

Page 124: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix A, Input Commands Data Dictionary MX2820 System

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 include the following:

• 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 include the following:

• CR, (Critical alarm)

• MJ, (Major alarm)

• MN, (Minor alarm)

• NA, (Not alarmed)

• CL, (Cleared alarm)

• TH, (Threshold)

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 perfor-mance monitoring indefinitely.

Table A-1. TL1 Input Commands Data Dictionary (Continued)

Parameter Description

A-2 61186003L1-35C

Page 125: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Input Commands Data Dictionary, Appendix A

ORGN The Originating Office parameter indicates the office that originates the signal to be looped back. The supported values include the following:

• 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) include the following:VAL UN1 to 31 DAY1 to 24 HR1 to 1440 MIN

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 include the following:

• EQPT

• T1

• T3

• STS1

• VT1

Table A-1. TL1 Input Commands Data Dictionary (Continued)

Parameter Description

61186003L1-35C A-3

Page 126: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix A, Input Commands Data Dictionary MX2820 System

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 include the following:

• 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 “Target Identifier (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 include the following:

• 15-MIN (quarterly hourly)

• 1-DAY

TSN The Test Session Number, which the OS assigns for each circuit access, identifies all message for each circuit access. The range of values is from 1 to 999.

Table A-1. TL1 Input Commands Data Dictionary (Continued)

Parameter Description

A-4 61186003L1-35C

Page 127: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Input Commands Data Dictionary, Appendix A

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

Table A-1. TL1 Input Commands Data Dictionary (Continued)

Parameter Description

61186003L1-35C A-5

Page 128: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix A, Input Commands Data Dictionary MX2820 System

This page is intentionally blank.

A-6 61186003L1-35C

Page 129: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix BResponse Messages Data Dictionary

1. INTRODUCTIONTable B-1 provides descriptions for the parameters that may 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

^ ASCII space character

+ The plus sign indicates information for the preceding field or parameter may occur one or more times.

AID The Access Identifier (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 may be up to ten alphanumeric characters. For the directory numbers, the CID may 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 transac-tion was fully completed.

CONDDESCR For the “RTRV-ALM” commands, this parameter provides a text description of the trou-ble.For the “RTRV-COND” commands, this parameter provides a text description of the con-dition or state.

CONDTYPE This parameter indicates a single type of alarm condition being reported for an entity within the NE. Refer to “Appendix D, Alarms and Alarm Condition Codes” for condition types that apply to the MX2820 System.

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

61186003L1-35C B-1

Page 130: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix B, Response Messages Data Dictionary MX2820 System

CTAG The Correlation Tag (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, 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 Perfor-mance 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 include the following:

• NEND

• FEND

<login failures> Number of login failures on the account.

MONLEV The Monitor Level parameter indicates the discriminating level for the requested monitored parameter. Supported values include the following:

• 0-UP : show zeros

• 1-UP : suppress zeros

Table B-1. TL1 Response Messages Data Dictionary (Continued)

Parameter Description

B-2 61186003L1-35C

Page 131: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Response Messages Data Dictionary, Appendix B

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 include the following:

• 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 theinformation.

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.

REPTDAT The Report Date parameter specifies the date for the next Performance Monitoring (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

Table B-1. TL1 Response Messages Data Dictionary (Continued)

Parameter Description

61186003L1-35C B-3

Page 132: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix B, Response Messages Data Dictionary MX2820 System

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) include the following:VAL UN1 to 31 DAY1 to 24 HR1 to 1440 MIN

REPTTM The Report Time parameter specifies the time of day for the next PM report. The REPTTM format is HOD-MOH.

• HOD indicates hour of day and ranges from 00 to 23

• MOH indicates minutes of hour and ranges from 00 to 59

<rspblk> The Response Block contains the information that an NE entity sends to the OS/user. Information in the Response Block depends on the NE entity sending the data to the OS/user and also depends on the input command parameters sent to the NE by the OS/user.

SID The Source Identifier (SID) identifies the Network Element generating the response message. The SID is the shelf CLLI code.

<specific data block> The Specific Data Block field provides information about the provision data parameters for the specified NE entity. Examples of an NE entity are T1 and T3. Refer to the “Transmission Entity Data Parameter Tables” on page 5-10 for additional information.

SRVEFF This parameter indicates the effect on the service caused by an alarm condition. Valid values for SRVEFF are:

• SA - Service-affecting condition, immediate action required

• NSA - Nonservice-affecting condition, action required

Refer to “Appendix D, Alarms and Alarm Condition Codes” for Service Affecting data.

<SW Rev.> This parameter indicates the software release for an NE.

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.

Table B-1. TL1 Response Messages Data Dictionary (Continued)

Parameter Description

B-4 61186003L1-35C

Page 133: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Response Messages Data Dictionary, Appendix B

TMPER The Time Period parameter indicates the accumulation time period for performance-monitoring data. Values include the following:

• 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 may be included in the CONDTYPE parameter are values that may 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 include the following:

• 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

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

Table B-1. TL1 Response Messages Data Dictionary (Continued)

Parameter Description

61186003L1-35C B-5

Page 134: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix B, Response Messages Data Dictionary MX2820 System

This page is intentionally blank.

B-6 61186003L1-35C

Page 135: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix CError Codes

1. INTRODUCTIONThe 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 privi-leges.

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.

RNAU Resource This error code indicates the requested NE access address is unas-signed.

61186003L1-35C C-1

Page 136: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix C, Error Codes MX2820 System

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.

Table C-1. MX2820 System Error Codes (Continued)

Error Code Category Description

C-2 61186003L1-35C

Page 137: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix DAlarms and Alarm Condition Codes

1. INTRODUCTIONAlarm information and condition codes for the MX2820 System are provided in this index. The following modules are included:

System Controller Unit (SCU)

• M13 MUX

• STS-1 MUX

• MX2820 Clock Card

2. SCU ALARMSAlarms for the SCU are described in Table D-1.

Table D-1. MX2820 SCU Alarm Data

Condition Code <CONDTYPE>

AlarmLevel

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-35C D-1

Page 138: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix D, Alarms and Alarm Condition Codes MX2820 System

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 out-age.

IMPROPRMVL Major NSA A standby linecard was removed leaving service unaffected.

Table D-1. MX2820 SCU Alarm Data (Continued)

Condition Code <CONDTYPE>

AlarmLevel

Service Affecting (SRVEFF) Description

D-2 61186003L1-35C

Page 139: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Alarms and Alarm Condition Codes, Appendix D

3. M13 MUX CARD ALARMSTable D-2 provides the alarms for the M13 MUX card. Table entries with the T-x format, (for example, T-CVL), provide Performance Monitoring (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

Message Type

Second Modifier

Notification Code

Service Affecting(SRVEFF)

Condition Type

<CONDTYPE>Location

DS3 REPT ALM T3 CR SA LOSOOF

Near endNear end

MN NSA EXTEXT-T3-NSAEXT-T3-SAEXT-T1-NSAEXT-T1-SALOSOOFLOS-T1-MULTLOS-T1-SNG

Far endFar endFar endFar endFar endFar endFar endFar endFar end

REPT EVT T3 SC SA TSA Near end

SC NSA AISISDAISISDRAIXCV

Far endFar endNear endNear endNear endNear end

TC NSA T-CVLT-ESLT-SESLT-LOSS-LT-CVP-PT-ESP-PT-SESP-PT-UASP-PT-CVCP-PT-ESCP-PT-SESCP-PT-UASCP-PT-SAS-PT-CVCP-PFET-ESCP-PFET-SESCP-PFET-UASCP-PFE

Near endNear endNear endNear endNear endNear endNear endNear endNear endNear endNear endNear endNear endFar endFar endFar endFar end

61186003L1-35C D-3

Page 140: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix D, Alarms and Alarm Condition Codes MX2820 System

* This alarm will be reported as either Minor, Non-Service Affecting or Critical, Service Affecting depending on whether protection is available.

DS1 REPT ALM T1 MJ SA LOS Near end

REPT EVT T1 SC SA TSA Near end

SC NSA XCVAISAIS-NTWK

Near endNear endNear end

TC NSA T-CVLT-ESLT-SESLT-LOSS-LT-AISS

Near endNear endNear endNear endNear end

Equipment REPT ALM EQPT MN*

CRNSASA

EQPT Near endNear end

MN*

CRNSASA

IMPROPRMVL Near endNear end

MN NSA CONTCOM Near end

REPT EVT EQPT SC NSA WKSWPRESW

Near endNear end

Table D-2. MX2820 M13 MUX Alarm Data (Continued)

Entity Name And

Description

Message Type

Second Modifier

Notification Code

Service Affecting(SRVEFF)

Condition Type

<CONDTYPE>Location

D-4 61186003L1-35C

Page 141: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Alarms and Alarm Condition Codes, Appendix D

4. STS-1 MUX CARD ALARMSTable D-3 provides the alarms for the STS-1 MUX card. Table entries with the T-x format, (for example, T-CVL), provide Performance Monitoring (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 STS1 (rr=STS1). The applicable TL1 command is RTRV-ALM-STS1.

Table D-3. MX2820 STS-1 MUX Alarm Data

Entity Name And

Description

Message Type

Second Modifier

Notification Code

Service Affecting(SRVEFF)

Condition Type

<CONDTYPE>Location

STS1 REPT ALM STS1 CR SA LOSLOPLOFLOMFUEQPSLMP

Near end

REPT EVT STS1 SC SA TSA Near end

NSA AIS-LAIS-PRFI-LRFI-PTIM-P

Near end

TC NSA T-CVST-ESST-SESST-SEFS-ST-CVLT-ESLT-SESLT-UASLT-CVPT-ESPT-SESPT-UASPT-PPJC-PDETT-NPJC-PDET

Near end, Quarterly, Daily

T-CV-LFET-ES-LFET-SES-LFET-UAS-LFET-CV-PFET-ES-PFET-SES-PFET-UAS-PFE

Far end, Quarterly, Daily

61186003L1-35C D-5

Page 142: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix D, Alarms and Alarm Condition Codes MX2820 System

* This alarm will be reported as either Minor, Non-Service Affecting or Critical, Service Affecting depending on whether protection is available.

VT REPT ALM VT1 MJ SA LOP-VUNEQ-VSLM-V

Near end

REPT EVT VT1 SC NSA AIS-VRFI-V

Near end

TC NSA T-CV-VT-ES-VT-SES-VT-UAS-V

Near end, Quarterly, Daily

T-CV-VFET-ES-VFET-SES-VFET-UAS-VFE

Far end, Quarterly, Daily

DS1 REPT ALM T1 MJ SA LOS Near end

REPT EVT T1 SC SANSANSANSA

TSAXCVAISAIS-NTWK

Near end

TC NSA T-CVLT-ESLT-SESLT-LOSS-LT-AISS-P

Near end, Quarterly, Daily

Equipment REPT ALM EQPT MN*

CRNSASA

EQPT Near end

MN*

CRNSASA

IMPROPRMVL Near end

MN NSA CONTCOMCLK-LOA

Near end

REPT EVT EQPT SC NSA WKSWPRESW

Near end

Table D-3. MX2820 STS-1 MUX Alarm Data (Continued)

Entity Name And

Description

Message Type

Second Modifier

Notification Code

Service Affecting(SRVEFF)

Condition Type

<CONDTYPE>Location

D-6 61186003L1-35C

Page 143: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Alarms and Alarm Condition Codes, Appendix D

5. MX2820 CLOCK CARD ALARMSTable 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.

* This alarm will be reported as either Minor, Non-Service Affecting or Critical, Service Affecting depending on whether protection is available.

Table D-4. MX2820 Clock Card Alarm Data

Entity Name And

Description

Message Type

Second Modifier

Notification Code

Service Affecting(SRVEFF)

Condition Type

<CONDTYPE>Location

Equipment REPT ALM EQPT MJ NSA HO Near end

MN NSA EQPTCONTCOM

Near endNear end

MN*

CRNSASA

IMPROPRMVL Near endNear end

MN NSA PRIFAILSECFAIL

Near endNear end

REPT EVT EQPT SC NSA WKSWPRESW

Near endNear end

61186003L1-35C D-7

Page 144: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix D, Alarms and Alarm Condition Codes MX2820 System

This page is intentionally blank.

D-8 61186003L1-35C

Page 145: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix EAutonomous Messages

1. INTRODUCTIONThis appendix provides information about autonomous messages. Autonomous messages are generated automatically by alarm conditions or events that occur at Network Elements (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.

2. SYNTAXAn 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 mes-sage.Valid values for <almcde> in decreasing order of severity are as follows:*C Critical alarm** Major alarm*^ Minor alarmA^ Non-alarm message

61186003L1-35C E-1

Page 146: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix E, Autonomous Messages MX2820 System

3. ALARMSAutonomous 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).

<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 deter-mine 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 identifica-tion 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.

Table E-1. Autonomous Messages Parameter Descriptions (Continued)

Parameter Description

E-2 61186003L1-35C

Page 147: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Autonomous Messages, Appendix E

4. SCUIn systems where Intelligent Network Element (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 Target Identifier (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 corre-sponding 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.

5. EVENTSEvents 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.

6. PERFORMANCE MONITORING REPORTSAutonomous Performance Monitoring (PM) reports may be generated as a result of a SCHED-PMREPT-rr command.

7. CONDITION CODESCondition codes are assigned to identify specific reasons for the alarm or event. Refer to the <Italic>Alarms and Alarm Condition Codes Appendix in this document for information about the condi-tion codes generated by the circuit cards in a MX2820 shelf.

61186003L1-35C E-3

Page 148: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix E, Autonomous Messages MX2820 System

8. AUTONOMOUS MESSAGE EXAMPLES

M13 MUX AlarmsThe following examples are autonomous messages for alarms that apply to a DS3 MUX card.

Command Response from Network ElementREPT^ALM

Alarm ResponseExample

03-11-19 11:28:03*C 240 REPT ALM T3 "1-T3-MUX3-1:CR,OOF,SA,11-19,11-28-03,NEND,,,,:\"DS3 OOF\"";

03-11-19 11:28:03*C 241 REPT ALM T3 "1-T3-MUX3-1:CR,LOS,SA,11-19,11-28-03,NEND,,,,:\"DS3 LOS\"";

Corresponding ClearsExample

03-11-19 11:28:42A 243 REPT ALM T3 "1-T3-MUX3-1:CL,OOF,SA,11-19,11-28-42,NEND,,,,:\"DS3 OOF\"";

03-11-19 11:28:42A 244 REPT ALM T3 "1-T3-MUX3-1:CL,LOS,SA,11-19,11-28-42,NEND,,,,:\"DS3 LOS\"";

E-4 61186003L1-35C

Page 149: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Autonomous Messages, Appendix E

Threshold AlarmsThe 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 Auto Clearing (AC).

Command Response from Network ElementREPT^EVT

M13 MUX Alarm ResponseExample

03-11-19 11:28:36A 242 REPT EVT T3 "1-T3-MUX3-1:RAI,SC,11-19,11-28-36,NEND,,,,:\"DS3 RAI\"";

03-11-19 11:28:52A 245 REPT EVT T3 "1-T3-MUX3-1:RAI,CL,11-19,11-28-52,NEND,,,,:\"DS3 RAI\"";

03-11-19 11:43:24A 258 REPT EVT T1 "1-T1-MUX3-1:T-LOSS-L,TC,11-19,11-43-24,NEND,,,,:\"DAY LOSS-L\"";

61186003L1-35C E-5

Page 150: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix E, Autonomous Messages MX2820 System

Environmental AlarmsThe following examples are autonomous messages for environmental alarms.

Command Response from Network ElementREPT^ALM^ENV

Alarm ResponseExample

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\"";

03-11-19 11:31:34A 253 REPT ALM ENV "1-ENV-1:CL,AUX1,11-19,11-31-34,\"AUX #1 INPUT\"";

03-11-19 11:32:29A 255 REPT ALM ENV "1-ENV-3:CL,AUX3A,11-19,11-32-29,\"AUX #3A INPUT\"";

E-6 61186003L1-35C

Page 151: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix FPerformance 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.

61186003L1-35C F-1

Page 152: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix F, Performance Monitoring Codes MX2820 System

1. M13 MUXTable F-1. M13 MUX Performance Monitoring MONTYPE Values

INTERVAL MONTYPE Value

T3 Performance Monitoringrr 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

T1 Performance Monitoringrr = T1

Quarterly & Daily Near-End CVL

ESL

SESL

LOSS-L

AISS-P

F-2 61186003L1-35C

Page 153: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System Performance Monitoring Codes, Appendix F

2. STS-1 MUXTable F-2. STS-1 MUX Performance Monitoring MONTYPE Values

Interval MONTYPE Value

STS1 Performance Monitoringrr = 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-35C F-3

Page 154: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix F, Performance Monitoring Codes MX2820 System

VT Performance Monitoringrr = 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 Monitoringrr = T1

Quarterly & Daily Near-End CVL

ESL

SESL

LOSS-L

AISS-P

Table F-2. STS-1 MUX Performance Monitoring MONTYPE Values (Continued)

Interval MONTYPE Value

F-4 61186003L1-35C

Page 155: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix GMX2820 Service States

1. INTRODUCTIONThe 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 on page G-2. Each entity has a Provisioned Service State and an Operational (Functional) Service State.

The Provisioned Service State for a given entity may be set to In-Service (IS) or Out-of-Service (OOS). As with other provisioning items, the Provisioned Service State values for all entities are saved to non-volatile memory and are transferred among mate cards in a redundant configuration.

In addition to the Provisioned Service State, each entity has an Operational Service State. The value of an entity's Operational Service State can assume one of several defined values and is influenced by both the entity's Provisioned Service State and current conditions. For DS1/E1 entities, the Traditional State of the channel (described later) also influences the Operational Service State.

Limitations of DiagramsThe 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 PrioritiesThe service state tables and diagrams indicate how the product will respond to various events. For some cases, especially with the diagrams, it may 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 EntityIn general, criteria that are monitored for a given state of a given entity are specific to that entity. For example, when the diagram or service state table for the DS1 #3 facility OOS-MA state indicates that it monitors for “Fault - SA”, it is implied that it refers only to service-affecting faults specific to DS1 #3.

61186003L1-35C G-1

Page 156: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

Figure G-1. MX2820 System Service State Hierarchy

��� ��� ��� ����� � ������ �� �����

���������

��� ��� ����� ������ �� �����

���������

� � ������

������

� ������ ��

������

� ������ ��

������

� ������ ���

��� ��

����� ��� ��

�����

����� ��� ����� ������ �� �����

���������

���������

� ������

���

� �� ��

���

� �� ��

���

� �� ���

��� ��

����� ��� ��

�����

������

� ������ ��

������

� ������ ��

������

� ������ ���

�����������

��� ��

�����

G-2 61186003L1-35C

Page 157: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

Definition of AINS CriteriaThe term AINS stands for “Automatic In-Service” and applies to any DS1/E1 facility whose Traditional State is Auto-enabled. This term is used to describe the criteria that must be met to bring the facility out of the OOS-AU FLT, AINS state.

The AINS criteria generally require that a DS1/E1 facility must be out of a LOS condition continuously for a specified length of time. The user sets this length of time with the “auto-enable delay” feature.

Definitions of Available and UnavailableThe terms “available” and “unavailable” apply to the M13 and STS-1 modules to distinguish DS1/E1 facil-ity 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 may 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 suppressionWhen 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 StatesThe 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.

The Traditional State for each T1/E1 facility may 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

61186003L1-35C G-3

Page 158: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

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 StatesThe 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 may leave the entities provisioned in-service at all times and expect the product to function no differ-ently 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 GR-1093 standard generally states that updates of provisioning data and the performance of maintenance activities should not be permitted for entities that have assumed certain service states. The MX2820 M13 and STS-1 mux modules are designed to allow the user to perform such activities independently of the provisioned and functional service states of any entity.

G-4 61186003L1-35C

Page 159: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

2. OPERATIONAL SERVICE STATE MODEL FOR EQUIPMENT

Independent Equipment Service StatesEach module keeps a record of its own provisioned and operational equipment service states as well as those of its mate module (if applicable). The provisioned service state of the equipment entity for each module may be set to IS or OOS independently of the settings of its mate module. If operating non-redun-dantly, 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 ModuleDue 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.

Figure G-2. Equipment Service States

����� ���

������

�� ���

����� ���

����

����� ����

������

���

����� ����

�����

���

����� ����

�����

���

����� ����

����

����� ����

���

��

����� ����

���

�����

�����

������

� �!� �"�

�!� ��

� �!� �"�

�!� ��

������

�����

�!� �

�!� �

� �!� �"�

�!� ��

�!� �

�����

!! �!��

��# $�%�&

!! �!��

��# $�%�&

!! �!��

��# $�%�&

!! �!��

��# $�%�&

������

�!� �

� �!� �"�

�!� ��

'% ��#�( )

�*(�#+

61186003L1-35C G-5

Page 160: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State E1a: IS ACTDescription: The card is installed and is performing its intended functions.

Provisioned State: IS

On Entry to State: Allow alarms for this entity.

NOTEIt is not possible for the protect card (card B) to be in state E1a becausethe protection switch alarm should be active, which would in turn causethe service state to transition to E5b.

Table G-1. State E1a: IS ACT

Event Action or Condition Next State

ENT,DLT TL1 DENY:SNVS ---

EDIT:IS None ---

EDIT:OOS None E3

SW-TOPROTN and card is A None E1b

SW-TOPROTN and card is B. TL1 DENY:SNVS ---

SW-TOWKG and card is A TL1 DENY:SNVS ---

SW-TOWKG and card is B None E1b

Fault SA None E5a

No Fault SA;Fault NSA

None E5b

All faults clear None ---

G-6 61186003L1-35C

Page 161: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State E1b: IS STDBYHDescription: 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. State E1b: IS STDBYH

Event Action or Condition Next State

ENT,DLT TL1 DENY:SNVS ---

EDIT:IS None ---

EDIT:OOS None E3

SW TL1 DENY:SNVS ---

Active Card None E1a

Fault SA None E5a

No Fault SA;Fault NSA

None E5b

All faults clear None ---

61186003L1-35C G-7

Page 162: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State E3: OOS-MADescription: The card is manually provisioned out-of-service. No equipment-level

fault conditions are present.

Provisioned State: OOS

On Entry to State: Suppress alarms for this entity.

Table G-3. State E3: OOS-MA

Event Action or Condition Next State

ENT,DLT 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 ---

G-8 61186003L1-35C

Page 163: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State E4a: OOS-AUMA FLTDescription: 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. State E4a: OOS-AUMA FLT

Event Action or Condition Next State

ENT,DLT 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

61186003L1-35C G-9

Page 164: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State E4b: OOS-MA FLTDescription: 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. State E4b: OOS-MA FLT

Event Action or Condition Next State

ENT,DLT 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

G-10 61186003L1-35C

Page 165: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State E5a: OOS-AU FLTDescription: The card presently has one or more service affecting equipment-level

fault conditions present.

Provisioned State: IS

On Entry to State: Allow alarms for this entity.

Table G-6. State E5a: OOS-AU FLT

Event Action or Condition Next State

ENT,DLT TL1 DENY:SNVS ---

EDIT:IS None –

EDIT:OOS None E4a

Fault SA None –

No Fault SA; Fault NSA None E5b

All faults clear If Active card E1a

Else If Standby card E1b

61186003L1-35C G-11

Page 166: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State E5b: IS-ANRDescription: The card has one or more non-service affecting and no service affect-

ing equipment-level fault conditions for this entity present.

Provisioned State: IS

On Entry to State: Allow alarms for this entity.

Table G-7. State E5b: IS-ANR

Event Action or Condition Next State

ENT,DLT TL1 DENY:SNVS ---

EDIT:IS None –

EDIT:OOS None E4b

Fault SA None E5a

No Fault SA; Fault NSA None –

All faults clear If Active card E1a

Else If Standby card E1b

G-12 61186003L1-35C

Page 167: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State E6: OOS-AUMA UAS, UEQDescription: This is the operational state that the active module assigns to its

stand-by module when it is not detected by the active module.

Provisioned State: IS or OOS

On Entry to State: No action.

Table G-8. State E5b: IS-ANR

Event Action or Condition Next State

Install module None E1b

61186003L1-35C G-13

Page 168: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

3. OPERATIONAL SERVICE STATE MODEL FOR FACILITIESApplies to the following entities:

• 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 FacilityThe 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 BehaviorAll of the facility service states apply for all DS1/E1 facility entities for both the M13 and STS-1 mux modules. The network facility for both products follows the same state behavior as DS1/E1 facilities, but are always considered to have a traditional state of Enabled (AINS criteria are satisfied). Therefore some service state transitions will not apply for the network facility entity.

Special Note about the EC-1/STS-1 FacilityFor 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.

G-14 61186003L1-35C

Page 169: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

Figure G-3. Facility Service States, Provisioned Service State = IS

����� ����

�����

��

����� ����

����

����� ���

�����

����

����� ���

���

���

�� ��� ���

��� ����� �

���������

�����! ���� �

��� �

�� ��� ���

��� ��

�� ����

��"�#���$

�%&��� �%&���

���������

�����! ���� �

�� ����

��"�#���$

���

'����( �� ) '���( �� )

�*

'����( ����)

���

'���� �� )

�+

'���()

���

'����)

��

'��� )

���������

�����! ��,����$

��$---

��� �

�� ��� ���

��� ��

�� ����

��"�#���$

�%&���

��������� �����!

������,,�, ���.,

�%&���

���������

�����!

���� �

61186003L1-35C G-15

Page 170: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

Figure G-4. Facility Service States, Provisioned Service State = OOS

����� ����

������

� �

����� ����

����

� �

����� ��

������

����

����� ���

����

���

�� ��� ���

��� ����� �

����������

������ ������

��� �

�� ��� ���

��� ��

�� ����

�!�"���#

�$%&� �$%&�

����������

������ ������

�� ����

�!�"���#

���

'���� � �( '&�� (

�)

'���� ����(

���

'����� � �(

���

'���� � �(

��

'����(

��!����� �* +��"�*����# ��� ��#

���������� ������ �*����#

��#,,,

��� �

�� ��� ���

��� ��

�� ����

�!�"���#

&�� -�������

����*.��#

����������

������

������

�/

'���� � �0 &��(

&�� -�������

��� ����*.��#

�1

'&�-�(

&�� -�������

����*.��#

�/

'���� � �0 &��(

&�� -�������

��� ����*.��#

�$%&�

��#,,,

��!����� �* +��"�*����# &� ��#

���������� ������ ���2* ���3*

��#,,,

G-16 61186003L1-35C

Page 171: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

Figure G-5. Other Facility Service States, Traditional State

����� ����

������

��

����� ��

�����

��

�������� �� ����� ��

��

������ �����

��

������

��

����� �����

��������� �����!

������""�" ���#"

$� ���������

�����! ���� �

��������� �����!

���� �

�$� ��������

����"%��&'

��&(((

�)

������

��

������ �����

�*+��

��&(((

��,����! �" -����"����& �� ��&

�$� �������� �" $�� ����"%��&����� �.

�����

�/�' �$�

�0�� � �%

��,����! ���&�������

�����

$� ���������

�����! ���� �

��������� �����!

���� �

��� ��& �� ������ ��&

�! �����

*/� ����" �� *�"� ��&�

*�"� ��&

���# �� ���!+

�$�+�� �� �$�+���

1�"���" �� �0�� ��

���&������ ����� ��

��� ��&

�! ��,����! �0�� �"

�������� �� �"

���"�&���& �� �

*�"� ��&

�*+ ���

��&(((

61186003L1-35C G-17

Page 172: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

Change of Facility Traditional StateDescription: The following transitions apply whenever the Traditional State of the

facility is changed. Below is a description of how each change should be handled.

NOTEThe traditional states of the DS3 or EC-1/STS-1 facilities are consideredto always be Enabled (AINS criteria satisfied).

NOTENote: For DS3 and EC-1/STS-1 facilities, a TL1 DENY:SNVS responseis returned due to a DLT command. The DLT command is valid only forDS1/E1 facilities.

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

G-18 61186003L1-35C

Page 173: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State F1a: OOS-AUMA UASDescription: 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. State F1a: OOS-AUMA UAS

Event Action or Condition Next State

Facility becomes available None F1b

ENT TL1 DENY:SNVS ---

DLT Set Traditional State to Disabled

---

EDIT:IS TL1 DENY:SNVS ---

EDIT:OOS TL1 DENY:SNVS ---

61186003L1-35C G-19

Page 174: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State F1b: OOS-MA UASDescription: 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. State F1b: OOS-MA UAS

Event Action or Condition Next State

Facility becomes unavailable 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 ---

G-20 61186003L1-35C

Page 175: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State F2: OOS-MADescription: 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. State F2: OOS-MA

Event Action or Condition Next State

ENT TL1 DENY:SNVS ---

DLT Set Traditional State to Disabled

F1b

EDIT:IS 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 ---

61186003L1-35C G-21

Page 176: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State F3a: OOS-AUMA FLTDescription: 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. 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-22 61186003L1-35C

Page 177: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State F3b: OOS-MA FLTDescription: 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. 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-35C G-23

Page 178: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State F4: OOS-AU FLT, AINSDescription: 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. 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 ---

EDIT:OOS If SGEO Present F8

Else F2

Supporting Entity Suppresses Alarms None F8

AINS Criteria Satisfied If SGEO Present F6

Else F5

G-24 61186003L1-35C

Page 179: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State F5: IS-ACTDescription: 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. 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-35C G-25

Page 180: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State F6: OOS-AU SGEODescription: The facility's supporting entity is in an outage.

Provisioned State: IS

On Entry to State: Allow alarms for this entity.

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

Supporting Entity Restored from Outage Condition

If Fault SA F7a

Else if Fault NSA F7b

Else F5

Supporting Entity Outage None ---

G-26 61186003L1-35C

Page 181: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State F7a: OOS-AU FLTDescription: 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. 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-35C G-27

Page 182: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State F7b: IS-ANRDescription: 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. 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-28 61186003L1-35C

Page 183: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State F8: OOS-AUMA SGEODescription: 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. State OOS-AUMA SGEO

Event Action or Condition Next State

ENT TL1 DENY:SNVS ---

DLT Set Traditional State to Disabled

F1b

Entity is provisioned IS and supporting entity allows alarms

If AINS Criteria NOT Satisfied F4

Else if Enabled F6

Else ---

Entity is provisioned OOS and Supporting Entity Restored from Outage Condition

If Fault SA F3a

Else If Fault NSA F3b

Else F2

61186003L1-35C G-29

Page 184: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

4. OPERATIONAL SERVICE STATE MODEL FOR VT PATHSApplies to the following entities:

• VT1.5/VT2 entities (for the STS-1 module only)

Operation in T1 modeWhen the product is provisioned for T1 mode, all seven VT groups in the STS-1 path are configured to each carry four VT1.5 paths. All 28 VT path entities are available and all 28 DS1/E1 facility entities are available. Any available VT1.5 path can be uniquely cross-connected to any available DS1/E1 facility.

Operation in E1 modeWhen 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 avail-able. 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.

Figure G-6. VT Service States, Provisioned Service State = IS

����� ����

�����

� �

����� ����

����

����� ���

�����

����

����� ���

����

���

�� ��� ���

��� ����� �

�������� !

� ���" ����!�

��� �

�� ��� ���

��� ��

�� ����

��#�$���%

�&'��� �&'���

�������� !

� ���" ����!�

�� ����

��#�$���%

���

(����) � �* (���) � �*

�+

(����) ����*

���

(���� � �*

�,

(���)*

���

(����*

��

(����*

�������� !

� ���" ��-����%

� %...

��� �

�� ��� ���

��� ��

�� ����

��#�$���%

�&'���

�������� ! � ���"

������--�- ���/-

�&'���

�������� !

� ���"

����!�

G-30 61186003L1-35C

Page 185: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

Figure G-7. VT Service States, Provisioned Service State = OOS

Figure G-8. Other VT Service States

����� ����

������

��

����� ����

����

��

����� ��

������

����

����� ���

����

���

�� �� ���

�� �� �� �

����������

����� ������

�� �

�� �� ���

�� ��

�� ���

!�"�#���$

�%&'� �%&'�

����������

����� ������

�� ���

!�"�#���$

���

(���� ��) ('��!)

�*

(���� ����)

���

(����� ��)

���

(���� ��)

��

(����)

�%&��� ��$ ����������

����� !�+����$

��$,,,

�� �

�� �� ���

�� ��

�� ���

!�"�#���$

����������

�����

������

�-

('�.�)

�%&'��%&'� ��$

���������� �����

���/+ ���0+

����� ����

������

��

����� �

�����

���

����������� ��������

��

������

������� ������ ��

������� �� ��������������� ���

�����

��

� ��!!��

�" #$ ���� ��

����������� ��

%��������� �� ��

��� ��!!��

��� ��!!���" �����

��&��!� ����

� ��!!�� ���

������� ������ �� ��������

61186003L1-35C G-31

Page 186: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

Effects of the Traditional State for an Attached DS1/E1 Facility

DescriptionThe following transitions apply whenever the traditional state of the port is changed. Below is a description of how each change should be handled.

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 explic-itly managing the entire channel (VT path and DS1/E1) out of service. Therefore, it is considered appropri-ate to transition the VT to a state that indicates that the VT is managed out of service (even if the provisioned service state is in-service).

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 equipped and AINS conditions are not satisfied for the attached DS1/E1 facility

VT is provisioned IS P5

VT is provisioned OOS P2

G-32 61186003L1-35C

Page 187: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State P1a: OOS-AUMA UASDescription: 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. State P1a: OOS-AUMA UAS

Event Action or Condition Next State

VT becomes available 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 ---

61186003L1-35C G-33

Page 188: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State P1b: OOS-MA UASDescription: 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. 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-34 61186003L1-35C

Page 189: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State P2: OOS-MADescription: 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. 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-35C G-35

Page 190: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State P3a: OOS-AUMA FLTDescription: 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. 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-36 61186003L1-35C

Page 191: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State P3b: OOS-MA FLTDescription: 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. 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-35C G-37

Page 192: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State P4: OOS-MA, SDEADescription: 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. State P4: OOS-MA, SDEA

Event Action or Condition Next State

VT becomes unavailable None P1a

ENT TL1 DENY:SNVS ---

DLT TL1 DENY:SNVS ---

VT becomes equipped None P2

EDIT:IS TL1 DENY:SNVS ---

EDIT:OOS None ---

G-38 61186003L1-35C

Page 193: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State P5: IS-ACTDescription: 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. 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-35C G-39

Page 194: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State P6: OOS-AU SGEODescription: 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. 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

Supporting Entity Restored If Fault SA P7a

Else if Fault NSA P7b

Else P5

Supporting Entity Outage None ---

G-40 61186003L1-35C

Page 195: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State P7a: OOS-AU FLTDescription: 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. 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-35C G-41

Page 196: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

State P7b: IS-ANRDescription: 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. 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-42 61186003L1-35C

Page 197: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System MX2820 Service States, Appendix G

State P8: OOS-AUMA SGEODescription: 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. 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-35C G-43

Page 198: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix G, MX2820 Service States MX2820 System

This page is intentionally blank.

G-44 61186003L1-35C

Page 199: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix HList of Abbreviations

AAC. . . . . . . . . . . . . . . . . . . . . . . . . . .Automatic Clearing

AID . . . . . . . . . . . . . . . . . . . . . . . . . .Access Identifier

AIDTYPE . . . . . . . . . . . . . . . . . . . . .Access Identifier Type

AIS . . . . . . . . . . . . . . . . . . . . . . . . . .Alarm Indication Signal

APS. . . . . . . . . . . . . . . . . . . . . . . . . .Automatic Protection Switch

BBER. . . . . . . . . . . . . . . . . . . . . . . . . .Bit Error Rate

CCLEI . . . . . . . . . . . . . . . . . . . . . . . . .Common Language Equipment Identifier

CLLI . . . . . . . . . . . . . . . . . . . . . . . . .Common Language Location Identifier

CO. . . . . . . . . . . . . . . . . . . . . . . . . . .Central Office

CONDTYPE. . . . . . . . . . . . . . . . . . .Condition Type

CTAG . . . . . . . . . . . . . . . . . . . . . . . .Correlation Tag

DDIRN. . . . . . . . . . . . . . . . . . . . . . . . .Direction

HHO. . . . . . . . . . . . . . . . . . . . . . . . . . .Hold Over

HRE . . . . . . . . . . . . . . . . . . . . . . . . .HDSL Range Extender

HTU-C . . . . . . . . . . . . . . . . . . . . . . .HDSL Transceiver Unit - Central Office

HTU-R . . . . . . . . . . . . . . . . . . . . . . .HDSL Transceiver Unit - Remote

61186003L1-35C H-1

Page 200: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix H, List of Abbreviations MX2820 System

IINC . . . . . . . . . . . . . . . . . . . . . . . . . .Incoming Failure Condition

INE . . . . . . . . . . . . . . . . . . . . . . . . . .Intelligent Network Element

INHMODE . . . . . . . . . . . . . . . . . . . .Inhibit Mode

ISD . . . . . . . . . . . . . . . . . . . . . . . . . .Idle Signal

LLOCN . . . . . . . . . . . . . . . . . . . . . . . .Location

LOF. . . . . . . . . . . . . . . . . . . . . . . . . .Loss of Frame

LOP. . . . . . . . . . . . . . . . . . . . . . . . . .Loss of Pointer

LOS. . . . . . . . . . . . . . . . . . . . . . . . . .Loss of Signal

MMONDAT . . . . . . . . . . . . . . . . . . . . .Monitor Date

MONLEV . . . . . . . . . . . . . . . . . . . . .Monitor Level

MONTM. . . . . . . . . . . . . . . . . . . . . .Monitor Time

MONTYPE. . . . . . . . . . . . . . . . . . . .Monitor Type

MONVAL . . . . . . . . . . . . . . . . . . . . .Monitor Value

MTA . . . . . . . . . . . . . . . . . . . . . . . . .Metallic Test Access

MUX. . . . . . . . . . . . . . . . . . . . . . . . .Multiplexer

NNE. . . . . . . . . . . . . . . . . . . . . . . . . . .Network Element

NSA . . . . . . . . . . . . . . . . . . . . . . . . .Non-Service Affecting

NTFCNCDE . . . . . . . . . . . . . . . . . . .Notification Code

NUMINVL . . . . . . . . . . . . . . . . . . . .Number Interval

NUMREPT . . . . . . . . . . . . . . . . . . . .Number of Reports

OOCRDAT . . . . . . . . . . . . . . . . . . . . .Occurrence Date

OCRTM . . . . . . . . . . . . . . . . . . . . . .Occurrence Time

OOF . . . . . . . . . . . . . . . . . . . . . . . . .Out of Frame

OS . . . . . . . . . . . . . . . . . . . . . . . . . . .Operations System

OSS. . . . . . . . . . . . . . . . . . . . . . . . . .Operations Support System

H-2 61186003L1-35C

Page 201: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

MX2820 System List of Abbreviations, Appendix H

PPID . . . . . . . . . . . . . . . . . . . . . . . . . .Private ID

PM. . . . . . . . . . . . . . . . . . . . . . . . . . .Performance Monitoring

RRAI . . . . . . . . . . . . . . . . . . . . . . . . . .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

SSA . . . . . . . . . . . . . . . . . . . . . . . . . . .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

TT1-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

61186003L1-35C H-3

Page 202: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Appendix H, List of Abbreviations MX2820 System

TSC. . . . . . . . . . . . . . . . . . . . . . . . . .Test System Controller

TYPEREP. . . . . . . . . . . . . . . . . . . . .Type Report

UUAP . . . . . . . . . . . . . . . . . . . . . . . . .User Access Privilege

UID . . . . . . . . . . . . . . . . . . . . . . . . . .User ID

VVLDTY. . . . . . . . . . . . . . . . . . . . . . .Validity

VT. . . . . . . . . . . . . . . . . . . . . . . . . . .Virtual Tributary

H-4 61186003L1-35C

Page 203: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

Notes

Page 204: AdtranMX2820 TL1 Reference Manual 61186003L1-35C

®